blob: c3b7497946c79fd07f10e657463bc49acd1f45ac [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 Berry9722fd12024-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
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100428#if defined(MBEDTLS_MD_CAN_SHA256)
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
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100437#endif /* MBEDTLS_MD_CAN_SHA256*/
Gilles Peskine449bd832023-01-11 14:50:10 +0100438
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100439#if defined(MBEDTLS_MD_CAN_SHA384)
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);
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100448#endif /* MBEDTLS_MD_CAN_SHA384*/
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
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100458#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100459static int ssl_update_checksum_sha256(mbedtls_ssl_context *, const unsigned char *, size_t);
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100460#endif /* MBEDTLS_MD_CAN_SHA256*/
Gilles Peskine449bd832023-01-11 14:50:10 +0100461
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100462#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100463static int ssl_update_checksum_sha384(mbedtls_ssl_context *, const unsigned char *, size_t);
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100464#endif /* MBEDTLS_MD_CAN_SHA384*/
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)
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100476#if defined(MBEDTLS_MD_CAN_SHA384)
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;
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100480#endif /* MBEDTLS_MD_CAN_SHA384*/
481#if defined(MBEDTLS_MD_CAN_SHA256)
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;
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100485#endif /* MBEDTLS_MD_CAN_SHA256*/
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
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100787#if defined(MBEDTLS_MD_CAN_SHA384)
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
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100792#if defined(MBEDTLS_MD_CAN_SHA256)
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{
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100833#if defined(MBEDTLS_MD_CAN_SHA256) || \
834 defined(MBEDTLS_MD_CAN_SHA384)
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 */
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100843#if defined(MBEDTLS_MD_CAN_SHA256)
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
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100868#if defined(MBEDTLS_MD_CAN_SHA384)
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{
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100898#if defined(MBEDTLS_MD_CAN_SHA256) || \
899 defined(MBEDTLS_MD_CAN_SHA384)
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 */
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100910#if defined(MBEDTLS_MD_CAN_SHA256)
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
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100923#if defined(MBEDTLS_MD_CAN_SHA384)
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
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100939#if defined(MBEDTLS_MD_CAN_SHA256)
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
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100952#if defined(MBEDTLS_MD_CAN_SHA384)
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
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100969#if defined(MBEDTLS_MD_CAN_SHA256)
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
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100976#if defined(MBEDTLS_MD_CAN_SHA384)
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
Yanray Wangb422cab2023-12-01 16:18:10 +08001357 if (ssl->conf->f_rng == NULL) {
1358 MBEDTLS_SSL_DEBUG_MSG(1, ("no RNG provided"));
1359 return MBEDTLS_ERR_SSL_NO_RNG;
1360 }
1361
Jerry Yu60835a82021-08-04 10:13:52 +08001362 /* Space for further checks */
1363
Gilles Peskine449bd832023-01-11 14:50:10 +01001364 return 0;
Jerry Yu60835a82021-08-04 10:13:52 +08001365}
1366
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +02001367/*
1368 * Setup an SSL context
1369 */
Hanno Becker2a43f6f2018-08-10 11:12:52 +01001370
Gilles Peskine449bd832023-01-11 14:50:10 +01001371int mbedtls_ssl_setup(mbedtls_ssl_context *ssl,
1372 const mbedtls_ssl_config *conf)
Paul Bakker5121ce52009-01-03 21:22:43 +00001373{
Janos Follath865b3eb2019-12-16 11:46:15 +00001374 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Darryl Greenb33cc762019-11-28 14:29:44 +00001375 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
1376 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
Paul Bakker5121ce52009-01-03 21:22:43 +00001377
Manuel Pégourié-Gonnarddef0bbe2015-05-04 14:56:36 +02001378 ssl->conf = conf;
Paul Bakker62f2dee2012-09-28 07:31:51 +00001379
Gilles Peskine449bd832023-01-11 14:50:10 +01001380 if ((ret = ssl_conf_check(ssl)) != 0) {
1381 return ret;
1382 }
Ronald Cron8a12aee2023-03-08 15:30:43 +01001383 ssl->tls_version = ssl->conf->max_tls_version;
Jerry Yu60835a82021-08-04 10:13:52 +08001384
Paul Bakker62f2dee2012-09-28 07:31:51 +00001385 /*
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01001386 * Prepare base structures
Paul Bakker62f2dee2012-09-28 07:31:51 +00001387 */
k-stachowiakc9a5f022018-07-24 13:53:31 +02001388
1389 /* Set to NULL in case of an error condition */
1390 ssl->out_buf = NULL;
k-stachowiaka47911c2018-07-04 17:41:58 +02001391
Darryl Greenb33cc762019-11-28 14:29:44 +00001392#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1393 ssl->in_buf_len = in_buf_len;
1394#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001395 ssl->in_buf = mbedtls_calloc(1, in_buf_len);
1396 if (ssl->in_buf == NULL) {
1397 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc(%" MBEDTLS_PRINTF_SIZET " bytes) failed", in_buf_len));
k-stachowiak9f7798e2018-07-31 16:52:32 +02001398 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
k-stachowiaka47911c2018-07-04 17:41:58 +02001399 goto error;
Angus Grattond8213d02016-05-25 20:56:48 +10001400 }
1401
Darryl Greenb33cc762019-11-28 14:29:44 +00001402#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1403 ssl->out_buf_len = out_buf_len;
1404#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001405 ssl->out_buf = mbedtls_calloc(1, out_buf_len);
1406 if (ssl->out_buf == NULL) {
1407 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc(%" MBEDTLS_PRINTF_SIZET " bytes) failed", out_buf_len));
k-stachowiak9f7798e2018-07-31 16:52:32 +02001408 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
k-stachowiaka47911c2018-07-04 17:41:58 +02001409 goto error;
Paul Bakker5121ce52009-01-03 21:22:43 +00001410 }
1411
Gilles Peskine449bd832023-01-11 14:50:10 +01001412 mbedtls_ssl_reset_in_out_pointers(ssl);
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02001413
Johan Pascalb62bb512015-12-03 21:56:45 +01001414#if defined(MBEDTLS_SSL_DTLS_SRTP)
Gilles Peskine449bd832023-01-11 14:50:10 +01001415 memset(&ssl->dtls_srtp_info, 0, sizeof(ssl->dtls_srtp_info));
Johan Pascalb62bb512015-12-03 21:56:45 +01001416#endif
1417
Gilles Peskine449bd832023-01-11 14:50:10 +01001418 if ((ret = ssl_handshake_init(ssl)) != 0) {
k-stachowiaka47911c2018-07-04 17:41:58 +02001419 goto error;
Gilles Peskine449bd832023-01-11 14:50:10 +01001420 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001421
Gilles Peskine449bd832023-01-11 14:50:10 +01001422 return 0;
k-stachowiaka47911c2018-07-04 17:41:58 +02001423
1424error:
Gilles Peskine449bd832023-01-11 14:50:10 +01001425 mbedtls_free(ssl->in_buf);
1426 mbedtls_free(ssl->out_buf);
k-stachowiaka47911c2018-07-04 17:41:58 +02001427
1428 ssl->conf = NULL;
1429
Darryl Greenb33cc762019-11-28 14:29:44 +00001430#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1431 ssl->in_buf_len = 0;
1432 ssl->out_buf_len = 0;
1433#endif
k-stachowiaka47911c2018-07-04 17:41:58 +02001434 ssl->in_buf = NULL;
1435 ssl->out_buf = NULL;
1436
1437 ssl->in_hdr = NULL;
1438 ssl->in_ctr = NULL;
1439 ssl->in_len = NULL;
1440 ssl->in_iv = NULL;
1441 ssl->in_msg = NULL;
1442
1443 ssl->out_hdr = NULL;
1444 ssl->out_ctr = NULL;
1445 ssl->out_len = NULL;
1446 ssl->out_iv = NULL;
1447 ssl->out_msg = NULL;
1448
Gilles Peskine449bd832023-01-11 14:50:10 +01001449 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00001450}
1451
1452/*
Paul Bakker7eb013f2011-10-06 12:37:39 +00001453 * Reset an initialized and used SSL context for re-use while retaining
1454 * all application-set variables, function pointers and data.
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001455 *
1456 * If partial is non-zero, keep data in the input buffer and client ID.
1457 * (Use when a DTLS client reconnects from the same port.)
Paul Bakker7eb013f2011-10-06 12:37:39 +00001458 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001459void mbedtls_ssl_session_reset_msg_layer(mbedtls_ssl_context *ssl,
1460 int partial)
Paul Bakker7eb013f2011-10-06 12:37:39 +00001461{
Darryl Greenb33cc762019-11-28 14:29:44 +00001462#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1463 size_t in_buf_len = ssl->in_buf_len;
1464 size_t out_buf_len = ssl->out_buf_len;
1465#else
1466 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
1467 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
1468#endif
Paul Bakker48916f92012-09-16 19:57:18 +00001469
Hanno Beckerb0302c42021-08-03 09:39:42 +01001470#if !defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE) || !defined(MBEDTLS_SSL_SRV_C)
1471 partial = 0;
Hanno Becker7e772132018-08-10 12:38:21 +01001472#endif
1473
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001474 /* Cancel any possibly running timer */
Gilles Peskine449bd832023-01-11 14:50:10 +01001475 mbedtls_ssl_set_timer(ssl, 0);
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001476
Gilles Peskine449bd832023-01-11 14:50:10 +01001477 mbedtls_ssl_reset_in_out_pointers(ssl);
Hanno Beckerb0302c42021-08-03 09:39:42 +01001478
1479 /* Reset incoming message parsing */
1480 ssl->in_offt = NULL;
1481 ssl->nb_zero = 0;
1482 ssl->in_msgtype = 0;
1483 ssl->in_msglen = 0;
1484 ssl->in_hslen = 0;
1485 ssl->keep_current_message = 0;
1486 ssl->transform_in = NULL;
1487
1488#if defined(MBEDTLS_SSL_PROTO_DTLS)
1489 ssl->next_record_offset = 0;
1490 ssl->in_epoch = 0;
1491#endif
1492
1493 /* Keep current datagram if partial == 1 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001494 if (partial == 0) {
Hanno Beckerb0302c42021-08-03 09:39:42 +01001495 ssl->in_left = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01001496 memset(ssl->in_buf, 0, in_buf_len);
Hanno Beckerb0302c42021-08-03 09:39:42 +01001497 }
1498
Ronald Cronad8c17b2022-06-10 17:18:09 +02001499 ssl->send_alert = 0;
1500
Hanno Beckerb0302c42021-08-03 09:39:42 +01001501 /* Reset outgoing message writing */
1502 ssl->out_msgtype = 0;
1503 ssl->out_msglen = 0;
1504 ssl->out_left = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01001505 memset(ssl->out_buf, 0, out_buf_len);
1506 memset(ssl->cur_out_ctr, 0, sizeof(ssl->cur_out_ctr));
Hanno Beckerb0302c42021-08-03 09:39:42 +01001507 ssl->transform_out = NULL;
1508
1509#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Gilles Peskine449bd832023-01-11 14:50:10 +01001510 mbedtls_ssl_dtls_replay_reset(ssl);
Hanno Beckerb0302c42021-08-03 09:39:42 +01001511#endif
1512
XiaokangQian2b01dc32022-01-21 02:53:13 +00001513#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01001514 if (ssl->transform) {
1515 mbedtls_ssl_transform_free(ssl->transform);
1516 mbedtls_free(ssl->transform);
Hanno Beckerb0302c42021-08-03 09:39:42 +01001517 ssl->transform = NULL;
1518 }
XiaokangQian2b01dc32022-01-21 02:53:13 +00001519#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
1520
XiaokangQian2b01dc32022-01-21 02:53:13 +00001521#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01001522 mbedtls_ssl_transform_free(ssl->transform_application);
1523 mbedtls_free(ssl->transform_application);
XiaokangQian2b01dc32022-01-21 02:53:13 +00001524 ssl->transform_application = NULL;
1525
Gilles Peskine449bd832023-01-11 14:50:10 +01001526 if (ssl->handshake != NULL) {
Jerry Yu3d9b5902022-11-04 14:07:25 +08001527#if defined(MBEDTLS_SSL_EARLY_DATA)
Gilles Peskine449bd832023-01-11 14:50:10 +01001528 mbedtls_ssl_transform_free(ssl->handshake->transform_earlydata);
1529 mbedtls_free(ssl->handshake->transform_earlydata);
XiaokangQian2b01dc32022-01-21 02:53:13 +00001530 ssl->handshake->transform_earlydata = NULL;
Jerry Yu3d9b5902022-11-04 14:07:25 +08001531#endif
XiaokangQian2b01dc32022-01-21 02:53:13 +00001532
Gilles Peskine449bd832023-01-11 14:50:10 +01001533 mbedtls_ssl_transform_free(ssl->handshake->transform_handshake);
1534 mbedtls_free(ssl->handshake->transform_handshake);
XiaokangQian2b01dc32022-01-21 02:53:13 +00001535 ssl->handshake->transform_handshake = NULL;
1536 }
1537
XiaokangQian2b01dc32022-01-21 02:53:13 +00001538#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Beckerb0302c42021-08-03 09:39:42 +01001539}
1540
Gilles Peskine449bd832023-01-11 14:50:10 +01001541int mbedtls_ssl_session_reset_int(mbedtls_ssl_context *ssl, int partial)
Hanno Beckerb0302c42021-08-03 09:39:42 +01001542{
1543 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1544
1545 ssl->state = MBEDTLS_SSL_HELLO_REQUEST;
Ronald Cron195c0bc2024-02-08 08:51:20 +01001546 ssl->tls_version = ssl->conf->max_tls_version;
Hanno Beckerb0302c42021-08-03 09:39:42 +01001547
Gilles Peskine449bd832023-01-11 14:50:10 +01001548 mbedtls_ssl_session_reset_msg_layer(ssl, partial);
Hanno Beckerb0302c42021-08-03 09:39:42 +01001549
1550 /* Reset renegotiation state */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001551#if defined(MBEDTLS_SSL_RENEGOTIATION)
1552 ssl->renego_status = MBEDTLS_SSL_INITIAL_HANDSHAKE;
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001553 ssl->renego_records_seen = 0;
Paul Bakker48916f92012-09-16 19:57:18 +00001554
1555 ssl->verify_data_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01001556 memset(ssl->own_verify_data, 0, MBEDTLS_SSL_VERIFY_DATA_MAX_LEN);
1557 memset(ssl->peer_verify_data, 0, MBEDTLS_SSL_VERIFY_DATA_MAX_LEN);
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001558#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001559 ssl->secure_renegotiation = MBEDTLS_SSL_LEGACY_RENEGOTIATION;
Paul Bakker48916f92012-09-16 19:57:18 +00001560
Hanno Beckerb0302c42021-08-03 09:39:42 +01001561 ssl->session_in = NULL;
Hanno Becker78640902018-08-13 16:35:15 +01001562 ssl->session_out = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01001563 if (ssl->session) {
1564 mbedtls_ssl_session_free(ssl->session);
1565 mbedtls_free(ssl->session);
Paul Bakkerc0463502013-02-14 11:19:38 +01001566 ssl->session = NULL;
1567 }
1568
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001569#if defined(MBEDTLS_SSL_ALPN)
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001570 ssl->alpn_chosen = NULL;
1571#endif
1572
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001573#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
David Horstmann3b2276a2022-10-06 14:49:08 +01001574 int free_cli_id = 1;
Hanno Becker4ccbf062018-08-10 11:20:38 +01001575#if defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE)
Gilles Peskine449bd832023-01-11 14:50:10 +01001576 free_cli_id = (partial == 0);
Hanno Becker4ccbf062018-08-10 11:20:38 +01001577#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001578 if (free_cli_id) {
1579 mbedtls_free(ssl->cli_id);
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001580 ssl->cli_id = NULL;
1581 ssl->cli_id_len = 0;
1582 }
Manuel Pégourié-Gonnard43c02182014-07-22 17:32:01 +02001583#endif
1584
Gilles Peskine449bd832023-01-11 14:50:10 +01001585 if ((ret = ssl_handshake_init(ssl)) != 0) {
1586 return ret;
1587 }
Paul Bakker2770fbd2012-07-03 13:30:23 +00001588
Gilles Peskine449bd832023-01-11 14:50:10 +01001589 return 0;
Paul Bakker7eb013f2011-10-06 12:37:39 +00001590}
1591
Manuel Pégourié-Gonnard779e4292013-08-03 13:50:48 +02001592/*
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001593 * Reset an initialized and used SSL context for re-use while retaining
1594 * all application-set variables, function pointers and data.
1595 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001596int mbedtls_ssl_session_reset(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001597{
Gilles Peskine449bd832023-01-11 14:50:10 +01001598 return mbedtls_ssl_session_reset_int(ssl, 0);
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001599}
1600
1601/*
Paul Bakker5121ce52009-01-03 21:22:43 +00001602 * SSL set accessors
1603 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001604void mbedtls_ssl_conf_endpoint(mbedtls_ssl_config *conf, int endpoint)
Paul Bakker5121ce52009-01-03 21:22:43 +00001605{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001606 conf->endpoint = endpoint;
Paul Bakker5121ce52009-01-03 21:22:43 +00001607}
1608
Gilles Peskine449bd832023-01-11 14:50:10 +01001609void mbedtls_ssl_conf_transport(mbedtls_ssl_config *conf, int transport)
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001610{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001611 conf->transport = transport;
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001612}
1613
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001614#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Gilles Peskine449bd832023-01-11 14:50:10 +01001615void mbedtls_ssl_conf_dtls_anti_replay(mbedtls_ssl_config *conf, char mode)
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02001616{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001617 conf->anti_replay = mode;
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02001618}
1619#endif
1620
Gilles Peskine449bd832023-01-11 14:50:10 +01001621void mbedtls_ssl_conf_dtls_badmac_limit(mbedtls_ssl_config *conf, unsigned limit)
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001622{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001623 conf->badmac_limit = limit;
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001624}
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001625
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001626#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker04da1892018-08-14 13:22:10 +01001627
Gilles Peskine449bd832023-01-11 14:50:10 +01001628void mbedtls_ssl_set_datagram_packing(mbedtls_ssl_context *ssl,
1629 unsigned allow_packing)
Hanno Becker04da1892018-08-14 13:22:10 +01001630{
1631 ssl->disable_datagram_packing = !allow_packing;
1632}
1633
Gilles Peskine449bd832023-01-11 14:50:10 +01001634void mbedtls_ssl_conf_handshake_timeout(mbedtls_ssl_config *conf,
1635 uint32_t min, uint32_t max)
Manuel Pégourié-Gonnard905dd242014-10-01 12:03:55 +02001636{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001637 conf->hs_timeout_min = min;
1638 conf->hs_timeout_max = max;
Manuel Pégourié-Gonnard905dd242014-10-01 12:03:55 +02001639}
1640#endif
1641
Gilles Peskine449bd832023-01-11 14:50:10 +01001642void mbedtls_ssl_conf_authmode(mbedtls_ssl_config *conf, int authmode)
Paul Bakker5121ce52009-01-03 21:22:43 +00001643{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001644 conf->authmode = authmode;
Paul Bakker5121ce52009-01-03 21:22:43 +00001645}
1646
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001647#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001648void mbedtls_ssl_conf_verify(mbedtls_ssl_config *conf,
1649 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *),
1650 void *p_vrfy)
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001651{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001652 conf->f_vrfy = f_vrfy;
1653 conf->p_vrfy = p_vrfy;
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001654}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001655#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001656
Gilles Peskine449bd832023-01-11 14:50:10 +01001657void mbedtls_ssl_conf_rng(mbedtls_ssl_config *conf,
1658 int (*f_rng)(void *, unsigned char *, size_t),
1659 void *p_rng)
Paul Bakker5121ce52009-01-03 21:22:43 +00001660{
Manuel Pégourié-Gonnard750e4d72015-05-07 12:35:38 +01001661 conf->f_rng = f_rng;
1662 conf->p_rng = p_rng;
Paul Bakker5121ce52009-01-03 21:22:43 +00001663}
1664
Gilles Peskine449bd832023-01-11 14:50:10 +01001665void mbedtls_ssl_conf_dbg(mbedtls_ssl_config *conf,
1666 void (*f_dbg)(void *, int, const char *, int, const char *),
1667 void *p_dbg)
Paul Bakker5121ce52009-01-03 21:22:43 +00001668{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001669 conf->f_dbg = f_dbg;
1670 conf->p_dbg = p_dbg;
Paul Bakker5121ce52009-01-03 21:22:43 +00001671}
1672
Gilles Peskine449bd832023-01-11 14:50:10 +01001673void mbedtls_ssl_set_bio(mbedtls_ssl_context *ssl,
1674 void *p_bio,
1675 mbedtls_ssl_send_t *f_send,
1676 mbedtls_ssl_recv_t *f_recv,
1677 mbedtls_ssl_recv_timeout_t *f_recv_timeout)
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02001678{
1679 ssl->p_bio = p_bio;
1680 ssl->f_send = f_send;
1681 ssl->f_recv = f_recv;
1682 ssl->f_recv_timeout = f_recv_timeout;
Manuel Pégourié-Gonnard97fd52c2015-05-06 15:38:52 +01001683}
1684
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02001685#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01001686void mbedtls_ssl_set_mtu(mbedtls_ssl_context *ssl, uint16_t mtu)
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02001687{
1688 ssl->mtu = mtu;
1689}
1690#endif
1691
Gilles Peskine449bd832023-01-11 14:50:10 +01001692void mbedtls_ssl_conf_read_timeout(mbedtls_ssl_config *conf, uint32_t timeout)
Manuel Pégourié-Gonnard97fd52c2015-05-06 15:38:52 +01001693{
1694 conf->read_timeout = timeout;
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02001695}
1696
Gilles Peskine449bd832023-01-11 14:50:10 +01001697void mbedtls_ssl_set_timer_cb(mbedtls_ssl_context *ssl,
1698 void *p_timer,
1699 mbedtls_ssl_set_timer_t *f_set_timer,
1700 mbedtls_ssl_get_timer_t *f_get_timer)
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02001701{
1702 ssl->p_timer = p_timer;
1703 ssl->f_set_timer = f_set_timer;
1704 ssl->f_get_timer = f_get_timer;
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001705
1706 /* Make sure we start with no timer running */
Gilles Peskine449bd832023-01-11 14:50:10 +01001707 mbedtls_ssl_set_timer(ssl, 0);
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02001708}
1709
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001710#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001711void mbedtls_ssl_conf_session_cache(mbedtls_ssl_config *conf,
1712 void *p_cache,
1713 mbedtls_ssl_cache_get_t *f_get_cache,
1714 mbedtls_ssl_cache_set_t *f_set_cache)
Paul Bakker5121ce52009-01-03 21:22:43 +00001715{
Manuel Pégourié-Gonnard5cb33082015-05-06 18:06:26 +01001716 conf->p_cache = p_cache;
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001717 conf->f_get_cache = f_get_cache;
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001718 conf->f_set_cache = f_set_cache;
Paul Bakker5121ce52009-01-03 21:22:43 +00001719}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001720#endif /* MBEDTLS_SSL_SRV_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00001721
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001722#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001723int mbedtls_ssl_set_session(mbedtls_ssl_context *ssl, const mbedtls_ssl_session *session)
Paul Bakker5121ce52009-01-03 21:22:43 +00001724{
Janos Follath865b3eb2019-12-16 11:46:15 +00001725 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001726
Gilles Peskine449bd832023-01-11 14:50:10 +01001727 if (ssl == NULL ||
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001728 session == NULL ||
1729 ssl->session_negotiate == NULL ||
Gilles Peskine449bd832023-01-11 14:50:10 +01001730 ssl->conf->endpoint != MBEDTLS_SSL_IS_CLIENT) {
1731 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001732 }
1733
Gilles Peskine449bd832023-01-11 14:50:10 +01001734 if (ssl->handshake->resume == 1) {
1735 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
1736 }
Hanno Beckere810bbc2021-05-14 16:01:05 +01001737
Jerry Yu21092062022-10-10 21:21:31 +08001738#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01001739 if (session->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Ronald Cron8d630842024-04-04 14:05:21 +02001740#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Jerry Yu21092062022-10-10 21:21:31 +08001741 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
Gilles Peskine449bd832023-01-11 14:50:10 +01001742 mbedtls_ssl_ciphersuite_from_id(session->ciphersuite);
Jerry Yu21092062022-10-10 21:21:31 +08001743
Gilles Peskine449bd832023-01-11 14:50:10 +01001744 if (mbedtls_ssl_validate_ciphersuite(
Jerry Yu21092062022-10-10 21:21:31 +08001745 ssl, ciphersuite_info, MBEDTLS_SSL_VERSION_TLS1_3,
Gilles Peskine449bd832023-01-11 14:50:10 +01001746 MBEDTLS_SSL_VERSION_TLS1_3) != 0) {
1747 MBEDTLS_SSL_DEBUG_MSG(4, ("%d is not a valid TLS 1.3 ciphersuite.",
1748 session->ciphersuite));
1749 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jerry Yu21092062022-10-10 21:21:31 +08001750 }
Ronald Cron8d630842024-04-04 14:05:21 +02001751#else
1752 /*
1753 * If session tickets are not enabled, it is not possible to resume a
1754 * TLS 1.3 session, thus do not make any change to the SSL context in
1755 * the first place.
1756 */
1757 return 0;
1758#endif
Jerry Yu40afab62022-10-08 10:42:13 +08001759 }
Jerry Yu21092062022-10-10 21:21:31 +08001760#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yu40afab62022-10-08 10:42:13 +08001761
Gilles Peskine449bd832023-01-11 14:50:10 +01001762 if ((ret = mbedtls_ssl_session_copy(ssl->session_negotiate,
1763 session)) != 0) {
1764 return ret;
1765 }
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001766
Paul Bakker0a597072012-09-25 21:55:46 +00001767 ssl->handshake->resume = 1;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001768
Gilles Peskine449bd832023-01-11 14:50:10 +01001769 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00001770}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001771#endif /* MBEDTLS_SSL_CLI_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00001772
Gilles Peskine449bd832023-01-11 14:50:10 +01001773void mbedtls_ssl_conf_ciphersuites(mbedtls_ssl_config *conf,
1774 const int *ciphersuites)
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001775{
Hanno Beckerd60b6c62021-04-29 12:04:11 +01001776 conf->ciphersuite_list = ciphersuites;
Paul Bakker5121ce52009-01-03 21:22:43 +00001777}
1778
Ronald Cron6f135e12021-12-08 16:57:54 +01001779#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01001780void mbedtls_ssl_conf_tls13_key_exchange_modes(mbedtls_ssl_config *conf,
1781 const int kex_modes)
Hanno Becker71f1ed62021-07-24 06:01:47 +01001782{
Xiaofei Bai746f9482021-11-12 08:53:56 +00001783 conf->tls13_kex_modes = kex_modes & MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_ALL;
Hanno Becker71f1ed62021-07-24 06:01:47 +01001784}
Xiaokang Qian72de95d2022-10-25 02:54:33 +00001785
1786#if defined(MBEDTLS_SSL_EARLY_DATA)
Yanray Wangd5ed36f2023-11-07 11:40:43 +08001787void mbedtls_ssl_conf_early_data(mbedtls_ssl_config *conf,
1788 int early_data_enabled)
Xiaokang Qian72de95d2022-10-25 02:54:33 +00001789{
1790 conf->early_data_enabled = early_data_enabled;
1791}
Jerry Yucc4e0072022-11-22 17:22:22 +08001792
1793#if defined(MBEDTLS_SSL_SRV_C)
Yanray Wang07517612023-11-07 11:47:36 +08001794void mbedtls_ssl_conf_max_early_data_size(
Gilles Peskine449bd832023-01-11 14:50:10 +01001795 mbedtls_ssl_config *conf, uint32_t max_early_data_size)
Jerry Yucc4e0072022-11-22 17:22:22 +08001796{
Jerry Yu39da9852022-12-06 16:58:36 +08001797 conf->max_early_data_size = max_early_data_size;
Jerry Yucc4e0072022-11-22 17:22:22 +08001798}
1799#endif /* MBEDTLS_SSL_SRV_C */
1800
Xiaokang Qian72de95d2022-10-25 02:54:33 +00001801#endif /* MBEDTLS_SSL_EARLY_DATA */
Ronald Cron6f135e12021-12-08 16:57:54 +01001802#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker71f1ed62021-07-24 06:01:47 +01001803
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001804#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001805void mbedtls_ssl_conf_cert_profile(mbedtls_ssl_config *conf,
1806 const mbedtls_x509_crt_profile *profile)
Manuel Pégourié-Gonnard6e3ee3a2015-06-17 10:58:20 +02001807{
1808 conf->cert_profile = profile;
1809}
1810
Gilles Peskine449bd832023-01-11 14:50:10 +01001811static void ssl_key_cert_free(mbedtls_ssl_key_cert *key_cert)
Glenn Strauss36872db2022-01-22 05:06:31 -05001812{
1813 mbedtls_ssl_key_cert *cur = key_cert, *next;
1814
Gilles Peskine449bd832023-01-11 14:50:10 +01001815 while (cur != NULL) {
Glenn Strauss36872db2022-01-22 05:06:31 -05001816 next = cur->next;
Gilles Peskine449bd832023-01-11 14:50:10 +01001817 mbedtls_free(cur);
Glenn Strauss36872db2022-01-22 05:06:31 -05001818 cur = next;
1819 }
1820}
1821
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001822/* Append a new keycert entry to a (possibly empty) list */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001823MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001824static int ssl_append_key_cert(mbedtls_ssl_key_cert **head,
1825 mbedtls_x509_crt *cert,
1826 mbedtls_pk_context *key)
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001827{
niisato8ee24222018-06-25 19:05:48 +09001828 mbedtls_ssl_key_cert *new_cert;
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001829
Gilles Peskine449bd832023-01-11 14:50:10 +01001830 if (cert == NULL) {
Glenn Strauss36872db2022-01-22 05:06:31 -05001831 /* Free list if cert is null */
Gilles Peskine449bd832023-01-11 14:50:10 +01001832 ssl_key_cert_free(*head);
Glenn Strauss36872db2022-01-22 05:06:31 -05001833 *head = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01001834 return 0;
Glenn Strauss36872db2022-01-22 05:06:31 -05001835 }
1836
Gilles Peskine449bd832023-01-11 14:50:10 +01001837 new_cert = mbedtls_calloc(1, sizeof(mbedtls_ssl_key_cert));
1838 if (new_cert == NULL) {
1839 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
1840 }
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001841
niisato8ee24222018-06-25 19:05:48 +09001842 new_cert->cert = cert;
1843 new_cert->key = key;
1844 new_cert->next = NULL;
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001845
Glenn Strauss36872db2022-01-22 05:06:31 -05001846 /* Update head if the list was null, else add to the end */
Gilles Peskine449bd832023-01-11 14:50:10 +01001847 if (*head == NULL) {
niisato8ee24222018-06-25 19:05:48 +09001848 *head = new_cert;
Gilles Peskine449bd832023-01-11 14:50:10 +01001849 } else {
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001850 mbedtls_ssl_key_cert *cur = *head;
Gilles Peskine449bd832023-01-11 14:50:10 +01001851 while (cur->next != NULL) {
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001852 cur = cur->next;
Gilles Peskine449bd832023-01-11 14:50:10 +01001853 }
niisato8ee24222018-06-25 19:05:48 +09001854 cur->next = new_cert;
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001855 }
1856
Gilles Peskine449bd832023-01-11 14:50:10 +01001857 return 0;
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001858}
1859
Gilles Peskine449bd832023-01-11 14:50:10 +01001860int mbedtls_ssl_conf_own_cert(mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001861 mbedtls_x509_crt *own_cert,
Gilles Peskine449bd832023-01-11 14:50:10 +01001862 mbedtls_pk_context *pk_key)
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001863{
Gilles Peskine449bd832023-01-11 14:50:10 +01001864 return ssl_append_key_cert(&conf->key_cert, own_cert, pk_key);
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001865}
1866
Gilles Peskine449bd832023-01-11 14:50:10 +01001867void mbedtls_ssl_conf_ca_chain(mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01001868 mbedtls_x509_crt *ca_chain,
Gilles Peskine449bd832023-01-11 14:50:10 +01001869 mbedtls_x509_crl *ca_crl)
Paul Bakker5121ce52009-01-03 21:22:43 +00001870{
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01001871 conf->ca_chain = ca_chain;
1872 conf->ca_crl = ca_crl;
Hanno Becker5adaad92019-03-27 16:54:37 +00001873
1874#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
1875 /* mbedtls_ssl_conf_ca_chain() and mbedtls_ssl_conf_ca_cb()
1876 * cannot be used together. */
1877 conf->f_ca_cb = NULL;
1878 conf->p_ca_cb = NULL;
1879#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
Paul Bakker5121ce52009-01-03 21:22:43 +00001880}
Hanno Becker5adaad92019-03-27 16:54:37 +00001881
1882#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
Gilles Peskine449bd832023-01-11 14:50:10 +01001883void mbedtls_ssl_conf_ca_cb(mbedtls_ssl_config *conf,
1884 mbedtls_x509_crt_ca_cb_t f_ca_cb,
1885 void *p_ca_cb)
Hanno Becker5adaad92019-03-27 16:54:37 +00001886{
1887 conf->f_ca_cb = f_ca_cb;
1888 conf->p_ca_cb = p_ca_cb;
1889
1890 /* mbedtls_ssl_conf_ca_chain() and mbedtls_ssl_conf_ca_cb()
1891 * cannot be used together. */
1892 conf->ca_chain = NULL;
1893 conf->ca_crl = NULL;
1894}
1895#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001896#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkereb2c6582012-09-27 19:15:01 +00001897
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001898#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01001899const unsigned char *mbedtls_ssl_get_hs_sni(mbedtls_ssl_context *ssl,
1900 size_t *name_len)
Glenn Strauss69894072022-01-24 12:58:00 -05001901{
1902 *name_len = ssl->handshake->sni_name_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01001903 return ssl->handshake->sni_name;
Glenn Strauss69894072022-01-24 12:58:00 -05001904}
1905
Gilles Peskine449bd832023-01-11 14:50:10 +01001906int mbedtls_ssl_set_hs_own_cert(mbedtls_ssl_context *ssl,
1907 mbedtls_x509_crt *own_cert,
1908 mbedtls_pk_context *pk_key)
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001909{
Gilles Peskine449bd832023-01-11 14:50:10 +01001910 return ssl_append_key_cert(&ssl->handshake->sni_key_cert,
1911 own_cert, pk_key);
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001912}
Manuel Pégourié-Gonnard22bfa4b2015-05-11 08:46:37 +02001913
Gilles Peskine449bd832023-01-11 14:50:10 +01001914void mbedtls_ssl_set_hs_ca_chain(mbedtls_ssl_context *ssl,
1915 mbedtls_x509_crt *ca_chain,
1916 mbedtls_x509_crl *ca_crl)
Manuel Pégourié-Gonnard22bfa4b2015-05-11 08:46:37 +02001917{
1918 ssl->handshake->sni_ca_chain = ca_chain;
1919 ssl->handshake->sni_ca_crl = ca_crl;
1920}
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +02001921
Glenn Strauss999ef702022-03-11 01:37:23 -05001922#if defined(MBEDTLS_KEY_EXCHANGE_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01001923void mbedtls_ssl_set_hs_dn_hints(mbedtls_ssl_context *ssl,
1924 const mbedtls_x509_crt *crt)
Glenn Strauss999ef702022-03-11 01:37:23 -05001925{
1926 ssl->handshake->dn_hints = crt;
1927}
1928#endif /* MBEDTLS_KEY_EXCHANGE_CERT_REQ_ALLOWED_ENABLED */
1929
Gilles Peskine449bd832023-01-11 14:50:10 +01001930void mbedtls_ssl_set_hs_authmode(mbedtls_ssl_context *ssl,
1931 int authmode)
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +02001932{
1933 ssl->handshake->sni_authmode = authmode;
1934}
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001935#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
1936
Hanno Becker8927c832019-04-03 12:52:50 +01001937#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001938void mbedtls_ssl_set_verify(mbedtls_ssl_context *ssl,
1939 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *),
1940 void *p_vrfy)
Hanno Becker8927c832019-04-03 12:52:50 +01001941{
1942 ssl->f_vrfy = f_vrfy;
1943 ssl->p_vrfy = p_vrfy;
1944}
1945#endif
1946
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02001947#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02001948
Valerio Setti016f6822022-12-09 14:17:50 +01001949#if defined(MBEDTLS_USE_PSA_CRYPTO)
Przemek Stekielfde11282023-03-13 16:06:09 +01001950static const uint8_t jpake_server_id[] = { 's', 'e', 'r', 'v', 'e', 'r' };
1951static const uint8_t jpake_client_id[] = { 'c', 'l', 'i', 'e', 'n', 't' };
1952
Valerio Setti016f6822022-12-09 14:17:50 +01001953static psa_status_t mbedtls_ssl_set_hs_ecjpake_password_common(
Gilles Peskine449bd832023-01-11 14:50:10 +01001954 mbedtls_ssl_context *ssl,
1955 mbedtls_svc_key_id_t pwd)
Valerio Setti016f6822022-12-09 14:17:50 +01001956{
1957 psa_status_t status;
Valerio Setti016f6822022-12-09 14:17:50 +01001958 psa_pake_cipher_suite_t cipher_suite = psa_pake_cipher_suite_init();
Przemek Stekielfde11282023-03-13 16:06:09 +01001959 const uint8_t *user = NULL;
Przemek Stekiel4cd20312023-03-01 11:11:28 +01001960 size_t user_len = 0;
Przemek Stekielfde11282023-03-13 16:06:09 +01001961 const uint8_t *peer = NULL;
Przemek Stekiel4cd20312023-03-01 11:11:28 +01001962 size_t peer_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01001963 psa_pake_cs_set_algorithm(&cipher_suite, PSA_ALG_JPAKE);
1964 psa_pake_cs_set_primitive(&cipher_suite,
1965 PSA_PAKE_PRIMITIVE(PSA_PAKE_PRIMITIVE_TYPE_ECC,
1966 PSA_ECC_FAMILY_SECP_R1,
1967 256));
1968 psa_pake_cs_set_hash(&cipher_suite, PSA_ALG_SHA_256);
Valerio Setti016f6822022-12-09 14:17:50 +01001969
Gilles Peskine449bd832023-01-11 14:50:10 +01001970 status = psa_pake_setup(&ssl->handshake->psa_pake_ctx, &cipher_suite);
1971 if (status != PSA_SUCCESS) {
Valerio Setti016f6822022-12-09 14:17:50 +01001972 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001973 }
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02001974
Gilles Peskine449bd832023-01-11 14:50:10 +01001975 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Przemek Stekielfde11282023-03-13 16:06:09 +01001976 user = jpake_server_id;
1977 user_len = sizeof(jpake_server_id);
1978 peer = jpake_client_id;
1979 peer_len = sizeof(jpake_client_id);
Gilles Peskine449bd832023-01-11 14:50:10 +01001980 } else {
Przemek Stekielfde11282023-03-13 16:06:09 +01001981 user = jpake_client_id;
1982 user_len = sizeof(jpake_client_id);
1983 peer = jpake_server_id;
1984 peer_len = sizeof(jpake_server_id);
Gilles Peskine449bd832023-01-11 14:50:10 +01001985 }
Neil Armstrongca7d5062022-05-31 14:43:23 +02001986
Przemek Stekiel4cd20312023-03-01 11:11:28 +01001987 status = psa_pake_set_user(&ssl->handshake->psa_pake_ctx, user, user_len);
1988 if (status != PSA_SUCCESS) {
1989 return status;
1990 }
1991
1992 status = psa_pake_set_peer(&ssl->handshake->psa_pake_ctx, peer, peer_len);
Gilles Peskine449bd832023-01-11 14:50:10 +01001993 if (status != PSA_SUCCESS) {
Valerio Setti016f6822022-12-09 14:17:50 +01001994 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001995 }
Valerio Setti016f6822022-12-09 14:17:50 +01001996
Gilles Peskine449bd832023-01-11 14:50:10 +01001997 status = psa_pake_set_password_key(&ssl->handshake->psa_pake_ctx, pwd);
1998 if (status != PSA_SUCCESS) {
Valerio Setti016f6822022-12-09 14:17:50 +01001999 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01002000 }
Valerio Setti016f6822022-12-09 14:17:50 +01002001
2002 ssl->handshake->psa_pake_ctx_is_ok = 1;
2003
Gilles Peskine449bd832023-01-11 14:50:10 +01002004 return PSA_SUCCESS;
Valerio Setti016f6822022-12-09 14:17:50 +01002005}
2006
Gilles Peskine449bd832023-01-11 14:50:10 +01002007int mbedtls_ssl_set_hs_ecjpake_password(mbedtls_ssl_context *ssl,
2008 const unsigned char *pw,
2009 size_t pw_len)
Valerio Setti016f6822022-12-09 14:17:50 +01002010{
2011 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
2012 psa_status_t status;
2013
Gilles Peskine449bd832023-01-11 14:50:10 +01002014 if (ssl->handshake == NULL || ssl->conf == NULL) {
2015 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Neil Armstrongca7d5062022-05-31 14:43:23 +02002016 }
2017
Gilles Peskine449bd832023-01-11 14:50:10 +01002018 /* Empty password is not valid */
2019 if ((pw == NULL) || (pw_len == 0)) {
2020 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2021 }
2022
2023 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_DERIVE);
2024 psa_set_key_algorithm(&attributes, PSA_ALG_JPAKE);
2025 psa_set_key_type(&attributes, PSA_KEY_TYPE_PASSWORD);
2026
2027 status = psa_import_key(&attributes, pw, pw_len,
2028 &ssl->handshake->psa_pake_password);
2029 if (status != PSA_SUCCESS) {
2030 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
2031 }
2032
2033 status = mbedtls_ssl_set_hs_ecjpake_password_common(ssl,
2034 ssl->handshake->psa_pake_password);
2035 if (status != PSA_SUCCESS) {
2036 psa_destroy_key(ssl->handshake->psa_pake_password);
2037 psa_pake_abort(&ssl->handshake->psa_pake_ctx);
2038 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
2039 }
2040
2041 return 0;
Valerio Setti02c25b52022-11-15 14:08:42 +01002042}
Valerio Settia9a97dc2022-11-28 18:26:16 +01002043
Gilles Peskine449bd832023-01-11 14:50:10 +01002044int mbedtls_ssl_set_hs_ecjpake_password_opaque(mbedtls_ssl_context *ssl,
2045 mbedtls_svc_key_id_t pwd)
Valerio Settia9a97dc2022-11-28 18:26:16 +01002046{
Valerio Settia9a97dc2022-11-28 18:26:16 +01002047 psa_status_t status;
2048
Gilles Peskine449bd832023-01-11 14:50:10 +01002049 if (ssl->handshake == NULL || ssl->conf == NULL) {
2050 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Neil Armstrongca7d5062022-05-31 14:43:23 +02002051 }
2052
Gilles Peskine449bd832023-01-11 14:50:10 +01002053 if (mbedtls_svc_key_id_is_null(pwd)) {
2054 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2055 }
2056
2057 status = mbedtls_ssl_set_hs_ecjpake_password_common(ssl, pwd);
2058 if (status != PSA_SUCCESS) {
2059 psa_pake_abort(&ssl->handshake->psa_pake_ctx);
2060 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
2061 }
2062
2063 return 0;
Valerio Setti02c25b52022-11-15 14:08:42 +01002064}
2065#else /* MBEDTLS_USE_PSA_CRYPTO */
Gilles Peskine449bd832023-01-11 14:50:10 +01002066int mbedtls_ssl_set_hs_ecjpake_password(mbedtls_ssl_context *ssl,
2067 const unsigned char *pw,
2068 size_t pw_len)
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002069{
2070 mbedtls_ecjpake_role role;
2071
Gilles Peskine449bd832023-01-11 14:50:10 +01002072 if (ssl->handshake == NULL || ssl->conf == NULL) {
2073 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2074 }
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002075
Valerio Settic689ed82022-12-07 14:40:38 +01002076 /* Empty password is not valid */
Gilles Peskine449bd832023-01-11 14:50:10 +01002077 if ((pw == NULL) || (pw_len == 0)) {
2078 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2079 }
Valerio Settic689ed82022-12-07 14:40:38 +01002080
Gilles Peskine449bd832023-01-11 14:50:10 +01002081 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002082 role = MBEDTLS_ECJPAKE_SERVER;
Gilles Peskine449bd832023-01-11 14:50:10 +01002083 } else {
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002084 role = MBEDTLS_ECJPAKE_CLIENT;
Gilles Peskine449bd832023-01-11 14:50:10 +01002085 }
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002086
Gilles Peskine449bd832023-01-11 14:50:10 +01002087 return mbedtls_ecjpake_setup(&ssl->handshake->ecjpake_ctx,
2088 role,
2089 MBEDTLS_MD_SHA256,
2090 MBEDTLS_ECP_DP_SECP256R1,
2091 pw, pw_len);
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002092}
Valerio Setti02c25b52022-11-15 14:08:42 +01002093#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02002094#endif /* MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED */
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002095
Ronald Cron73fe8df2022-10-05 14:31:43 +02002096#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01002097int mbedtls_ssl_conf_has_static_psk(mbedtls_ssl_config const *conf)
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002098{
Gilles Peskine449bd832023-01-11 14:50:10 +01002099 if (conf->psk_identity == NULL ||
2100 conf->psk_identity_len == 0) {
2101 return 0;
Ronald Crond29e13e2022-10-19 10:33:48 +02002102 }
2103
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002104#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01002105 if (!mbedtls_svc_key_id_is_null(conf->psk_opaque)) {
2106 return 1;
2107 }
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002108#endif /* MBEDTLS_USE_PSA_CRYPTO */
Ronald Crond29e13e2022-10-19 10:33:48 +02002109
Gilles Peskine449bd832023-01-11 14:50:10 +01002110 if (conf->psk != NULL && conf->psk_len != 0) {
2111 return 1;
2112 }
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002113
Gilles Peskine449bd832023-01-11 14:50:10 +01002114 return 0;
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002115}
2116
Gilles Peskine449bd832023-01-11 14:50:10 +01002117static void ssl_conf_remove_psk(mbedtls_ssl_config *conf)
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002118{
2119 /* Remove reference to existing PSK, if any. */
2120#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01002121 if (!mbedtls_svc_key_id_is_null(conf->psk_opaque)) {
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002122 /* The maintenance of the PSK key slot is the
2123 * user's responsibility. */
Ronald Croncf56a0a2020-08-04 09:51:30 +02002124 conf->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002125 }
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002126#endif /* MBEDTLS_USE_PSA_CRYPTO */
Gilles Peskine449bd832023-01-11 14:50:10 +01002127 if (conf->psk != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01002128 mbedtls_zeroize_and_free(conf->psk, conf->psk_len);
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002129 conf->psk = NULL;
2130 conf->psk_len = 0;
2131 }
2132
2133 /* Remove reference to PSK identity, if any. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002134 if (conf->psk_identity != NULL) {
2135 mbedtls_free(conf->psk_identity);
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002136 conf->psk_identity = NULL;
2137 conf->psk_identity_len = 0;
2138 }
2139}
2140
Hanno Becker7390c712018-11-15 13:33:04 +00002141/* This function assumes that PSK identity in the SSL config is unset.
2142 * It checks that the provided identity is well-formed and attempts
2143 * to make a copy of it in the SSL config.
2144 * On failure, the PSK identity in the config remains unset. */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002145MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002146static int ssl_conf_set_psk_identity(mbedtls_ssl_config *conf,
2147 unsigned char const *psk_identity,
2148 size_t psk_identity_len)
Paul Bakkerd4a56ec2013-04-16 18:05:29 +02002149{
Manuel Pégourié-Gonnardc6b5d832015-08-27 16:37:35 +02002150 /* Identity len will be encoded on two bytes */
Gilles Peskine449bd832023-01-11 14:50:10 +01002151 if (psk_identity == NULL ||
Ronald Cron2a87e9b2022-10-19 10:55:26 +02002152 psk_identity_len == 0 ||
Gilles Peskine449bd832023-01-11 14:50:10 +01002153 (psk_identity_len >> 16) != 0 ||
2154 psk_identity_len > MBEDTLS_SSL_OUT_CONTENT_LEN) {
2155 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnardc6b5d832015-08-27 16:37:35 +02002156 }
2157
Gilles Peskine449bd832023-01-11 14:50:10 +01002158 conf->psk_identity = mbedtls_calloc(1, psk_identity_len);
2159 if (conf->psk_identity == NULL) {
2160 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
2161 }
Paul Bakker6db455e2013-09-18 17:29:31 +02002162
Manuel Pégourié-Gonnard120fdbd2015-05-07 17:07:50 +01002163 conf->psk_identity_len = psk_identity_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01002164 memcpy(conf->psk_identity, psk_identity, conf->psk_identity_len);
Paul Bakker5ad403f2013-09-18 21:21:30 +02002165
Gilles Peskine449bd832023-01-11 14:50:10 +01002166 return 0;
Paul Bakker6db455e2013-09-18 17:29:31 +02002167}
2168
Gilles Peskine449bd832023-01-11 14:50:10 +01002169int mbedtls_ssl_conf_psk(mbedtls_ssl_config *conf,
2170 const unsigned char *psk, size_t psk_len,
2171 const unsigned char *psk_identity, size_t psk_identity_len)
Hanno Becker7390c712018-11-15 13:33:04 +00002172{
Janos Follath865b3eb2019-12-16 11:46:15 +00002173 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002174
2175 /* We currently only support one PSK, raw or opaque. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002176 if (mbedtls_ssl_conf_has_static_psk(conf)) {
2177 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
2178 }
Hanno Becker7390c712018-11-15 13:33:04 +00002179
2180 /* Check and set raw PSK */
Gilles Peskine449bd832023-01-11 14:50:10 +01002181 if (psk == NULL) {
2182 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2183 }
2184 if (psk_len == 0) {
2185 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2186 }
2187 if (psk_len > MBEDTLS_PSK_MAX_LEN) {
2188 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2189 }
Piotr Nowicki9926eaf2019-11-20 14:54:36 +01002190
Gilles Peskine449bd832023-01-11 14:50:10 +01002191 if ((conf->psk = mbedtls_calloc(1, psk_len)) == NULL) {
2192 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
2193 }
Hanno Becker7390c712018-11-15 13:33:04 +00002194 conf->psk_len = psk_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01002195 memcpy(conf->psk, psk, conf->psk_len);
Hanno Becker7390c712018-11-15 13:33:04 +00002196
2197 /* Check and set PSK Identity */
Gilles Peskine449bd832023-01-11 14:50:10 +01002198 ret = ssl_conf_set_psk_identity(conf, psk_identity, psk_identity_len);
2199 if (ret != 0) {
2200 ssl_conf_remove_psk(conf);
2201 }
Hanno Becker7390c712018-11-15 13:33:04 +00002202
Gilles Peskine449bd832023-01-11 14:50:10 +01002203 return ret;
Hanno Becker7390c712018-11-15 13:33:04 +00002204}
2205
Gilles Peskine449bd832023-01-11 14:50:10 +01002206static void ssl_remove_psk(mbedtls_ssl_context *ssl)
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002207{
2208#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01002209 if (!mbedtls_svc_key_id_is_null(ssl->handshake->psk_opaque)) {
Neil Armstrong501c9322022-05-03 09:35:09 +02002210 /* The maintenance of the external PSK key slot is the
2211 * user's responsibility. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002212 if (ssl->handshake->psk_opaque_is_internal) {
2213 psa_destroy_key(ssl->handshake->psk_opaque);
Neil Armstrong501c9322022-05-03 09:35:09 +02002214 ssl->handshake->psk_opaque_is_internal = 0;
2215 }
Ronald Croncf56a0a2020-08-04 09:51:30 +02002216 ssl->handshake->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002217 }
Neil Armstronge952a302022-05-03 10:22:14 +02002218#else
Gilles Peskine449bd832023-01-11 14:50:10 +01002219 if (ssl->handshake->psk != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01002220 mbedtls_zeroize_and_free(ssl->handshake->psk,
Gilles Peskine449bd832023-01-11 14:50:10 +01002221 ssl->handshake->psk_len);
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002222 ssl->handshake->psk_len = 0;
lhuang046d4d94f2024-06-11 12:37:02 -07002223 ssl->handshake->psk = NULL;
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002224 }
Neil Armstronge952a302022-05-03 10:22:14 +02002225#endif /* MBEDTLS_USE_PSA_CRYPTO */
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002226}
2227
Gilles Peskine449bd832023-01-11 14:50:10 +01002228int mbedtls_ssl_set_hs_psk(mbedtls_ssl_context *ssl,
2229 const unsigned char *psk, size_t psk_len)
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002230{
Neil Armstrong501c9322022-05-03 09:35:09 +02002231#if defined(MBEDTLS_USE_PSA_CRYPTO)
2232 psa_key_attributes_t key_attributes = psa_key_attributes_init();
Jerry Yu5d01c052022-08-17 10:18:10 +08002233 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Jerry Yu24b8c812022-08-20 19:06:56 +08002234 psa_algorithm_t alg = PSA_ALG_NONE;
Jerry Yu5d01c052022-08-17 10:18:10 +08002235 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Neil Armstrong501c9322022-05-03 09:35:09 +02002236#endif /* MBEDTLS_USE_PSA_CRYPTO */
2237
Gilles Peskine449bd832023-01-11 14:50:10 +01002238 if (psk == NULL || ssl->handshake == NULL) {
2239 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2240 }
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002241
Gilles Peskine449bd832023-01-11 14:50:10 +01002242 if (psk_len > MBEDTLS_PSK_MAX_LEN) {
2243 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2244 }
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002245
Gilles Peskine449bd832023-01-11 14:50:10 +01002246 ssl_remove_psk(ssl);
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002247
Neil Armstrong501c9322022-05-03 09:35:09 +02002248#if defined(MBEDTLS_USE_PSA_CRYPTO)
Jerry Yuccc68a42022-07-26 16:39:20 +08002249#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01002250 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_2) {
2251 if (ssl->handshake->ciphersuite_info->mac == MBEDTLS_MD_SHA384) {
2252 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_384);
2253 } else {
2254 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_256);
2255 }
2256 psa_set_key_usage_flags(&key_attributes, PSA_KEY_USAGE_DERIVE);
Jerry Yuccc68a42022-07-26 16:39:20 +08002257 }
2258#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Neil Armstrong501c9322022-05-03 09:35:09 +02002259
Jerry Yu568ec252022-07-22 21:27:34 +08002260#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01002261 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
2262 alg = PSA_ALG_HKDF_EXTRACT(PSA_ALG_ANY_HASH);
2263 psa_set_key_usage_flags(&key_attributes,
2264 PSA_KEY_USAGE_DERIVE | PSA_KEY_USAGE_EXPORT);
Jerry Yuccc68a42022-07-26 16:39:20 +08002265 }
2266#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
2267
Gilles Peskine449bd832023-01-11 14:50:10 +01002268 psa_set_key_algorithm(&key_attributes, alg);
2269 psa_set_key_type(&key_attributes, PSA_KEY_TYPE_DERIVE);
Neil Armstrong501c9322022-05-03 09:35:09 +02002270
Gilles Peskine449bd832023-01-11 14:50:10 +01002271 status = psa_import_key(&key_attributes, psk, psk_len, &key);
2272 if (status != PSA_SUCCESS) {
2273 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
2274 }
Neil Armstrong501c9322022-05-03 09:35:09 +02002275
2276 /* Allow calling psa_destroy_key() on psk remove */
2277 ssl->handshake->psk_opaque_is_internal = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01002278 return mbedtls_ssl_set_hs_psk_opaque(ssl, key);
Neil Armstrong501c9322022-05-03 09:35:09 +02002279#else
Gilles Peskine449bd832023-01-11 14:50:10 +01002280 if ((ssl->handshake->psk = mbedtls_calloc(1, psk_len)) == NULL) {
2281 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
2282 }
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002283
2284 ssl->handshake->psk_len = psk_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01002285 memcpy(ssl->handshake->psk, psk, ssl->handshake->psk_len);
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002286
Gilles Peskine449bd832023-01-11 14:50:10 +01002287 return 0;
Neil Armstrong501c9322022-05-03 09:35:09 +02002288#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002289}
2290
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002291#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01002292int mbedtls_ssl_conf_psk_opaque(mbedtls_ssl_config *conf,
2293 mbedtls_svc_key_id_t psk,
2294 const unsigned char *psk_identity,
2295 size_t psk_identity_len)
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002296{
Janos Follath865b3eb2019-12-16 11:46:15 +00002297 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002298
2299 /* We currently only support one PSK, raw or opaque. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002300 if (mbedtls_ssl_conf_has_static_psk(conf)) {
2301 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
2302 }
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002303
Hanno Becker7390c712018-11-15 13:33:04 +00002304 /* Check and set opaque PSK */
Gilles Peskine449bd832023-01-11 14:50:10 +01002305 if (mbedtls_svc_key_id_is_null(psk)) {
2306 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2307 }
Ronald Croncf56a0a2020-08-04 09:51:30 +02002308 conf->psk_opaque = psk;
Hanno Becker7390c712018-11-15 13:33:04 +00002309
2310 /* Check and set PSK Identity */
Gilles Peskine449bd832023-01-11 14:50:10 +01002311 ret = ssl_conf_set_psk_identity(conf, psk_identity,
2312 psk_identity_len);
2313 if (ret != 0) {
2314 ssl_conf_remove_psk(conf);
2315 }
Hanno Becker7390c712018-11-15 13:33:04 +00002316
Gilles Peskine449bd832023-01-11 14:50:10 +01002317 return ret;
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002318}
2319
Gilles Peskine449bd832023-01-11 14:50:10 +01002320int mbedtls_ssl_set_hs_psk_opaque(mbedtls_ssl_context *ssl,
2321 mbedtls_svc_key_id_t psk)
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002322{
Gilles Peskine449bd832023-01-11 14:50:10 +01002323 if ((mbedtls_svc_key_id_is_null(psk)) ||
2324 (ssl->handshake == NULL)) {
2325 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2326 }
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002327
Gilles Peskine449bd832023-01-11 14:50:10 +01002328 ssl_remove_psk(ssl);
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002329 ssl->handshake->psk_opaque = psk;
Gilles Peskine449bd832023-01-11 14:50:10 +01002330 return 0;
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002331}
2332#endif /* MBEDTLS_USE_PSA_CRYPTO */
2333
Jerry Yu8897c072022-08-12 13:56:53 +08002334#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002335void mbedtls_ssl_conf_psk_cb(mbedtls_ssl_config *conf,
2336 int (*f_psk)(void *, mbedtls_ssl_context *, const unsigned char *,
2337 size_t),
2338 void *p_psk)
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002339{
2340 conf->f_psk = f_psk;
2341 conf->p_psk = p_psk;
2342}
Jerry Yu8897c072022-08-12 13:56:53 +08002343#endif /* MBEDTLS_SSL_SRV_C */
2344
Ronald Cron73fe8df2022-10-05 14:31:43 +02002345#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED */
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002346
2347#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine301711e2022-04-26 16:57:05 +02002348static mbedtls_ssl_mode_t mbedtls_ssl_get_base_mode(
Gilles Peskine449bd832023-01-11 14:50:10 +01002349 psa_algorithm_t alg)
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002350{
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002351#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01002352 if (alg == PSA_ALG_CBC_NO_PADDING) {
2353 return MBEDTLS_SSL_MODE_CBC;
2354 }
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002355#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
Gilles Peskine449bd832023-01-11 14:50:10 +01002356 if (PSA_ALG_IS_AEAD(alg)) {
2357 return MBEDTLS_SSL_MODE_AEAD;
2358 }
2359 return MBEDTLS_SSL_MODE_STREAM;
Gilles Peskine301711e2022-04-26 16:57:05 +02002360}
2361
2362#else /* MBEDTLS_USE_PSA_CRYPTO */
2363
2364static mbedtls_ssl_mode_t mbedtls_ssl_get_base_mode(
Gilles Peskine449bd832023-01-11 14:50:10 +01002365 mbedtls_cipher_mode_t mode)
Gilles Peskine301711e2022-04-26 16:57:05 +02002366{
2367#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01002368 if (mode == MBEDTLS_MODE_CBC) {
2369 return MBEDTLS_SSL_MODE_CBC;
2370 }
Gilles Peskine301711e2022-04-26 16:57:05 +02002371#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
2372
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002373#if defined(MBEDTLS_GCM_C) || \
2374 defined(MBEDTLS_CCM_C) || \
2375 defined(MBEDTLS_CHACHAPOLY_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002376 if (mode == MBEDTLS_MODE_GCM ||
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002377 mode == MBEDTLS_MODE_CCM ||
Gilles Peskine449bd832023-01-11 14:50:10 +01002378 mode == MBEDTLS_MODE_CHACHAPOLY) {
2379 return MBEDTLS_SSL_MODE_AEAD;
2380 }
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002381#endif /* MBEDTLS_GCM_C || MBEDTLS_CCM_C || MBEDTLS_CHACHAPOLY_C */
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002382
Gilles Peskine449bd832023-01-11 14:50:10 +01002383 return MBEDTLS_SSL_MODE_STREAM;
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002384}
Gilles Peskine301711e2022-04-26 16:57:05 +02002385#endif /* MBEDTLS_USE_PSA_CRYPTO */
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002386
Gilles Peskinee108d982022-04-26 16:50:40 +02002387static mbedtls_ssl_mode_t mbedtls_ssl_get_actual_mode(
2388 mbedtls_ssl_mode_t base_mode,
Gilles Peskine449bd832023-01-11 14:50:10 +01002389 int encrypt_then_mac)
Gilles Peskinee108d982022-04-26 16:50:40 +02002390{
2391#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01002392 if (encrypt_then_mac == MBEDTLS_SSL_ETM_ENABLED &&
2393 base_mode == MBEDTLS_SSL_MODE_CBC) {
2394 return MBEDTLS_SSL_MODE_CBC_ETM;
Gilles Peskinee108d982022-04-26 16:50:40 +02002395 }
2396#else
2397 (void) encrypt_then_mac;
2398#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002399 return base_mode;
Gilles Peskinee108d982022-04-26 16:50:40 +02002400}
2401
Neil Armstrongab555e02022-04-04 11:07:59 +02002402mbedtls_ssl_mode_t mbedtls_ssl_get_mode_from_transform(
Gilles Peskine449bd832023-01-11 14:50:10 +01002403 const mbedtls_ssl_transform *transform)
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002404{
Gilles Peskinee108d982022-04-26 16:50:40 +02002405 mbedtls_ssl_mode_t base_mode = mbedtls_ssl_get_base_mode(
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002406#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01002407 transform->psa_alg
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002408#else
Gilles Peskine449bd832023-01-11 14:50:10 +01002409 mbedtls_cipher_get_cipher_mode(&transform->cipher_ctx_enc)
Gilles Peskinee108d982022-04-26 16:50:40 +02002410#endif
2411 );
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002412
Gilles Peskinee108d982022-04-26 16:50:40 +02002413 int encrypt_then_mac = 0;
Neil Armstrongf2c82f02022-04-05 11:16:53 +02002414#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskinee108d982022-04-26 16:50:40 +02002415 encrypt_then_mac = transform->encrypt_then_mac;
2416#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002417 return mbedtls_ssl_get_actual_mode(base_mode, encrypt_then_mac);
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002418}
2419
Neil Armstrongab555e02022-04-04 11:07:59 +02002420mbedtls_ssl_mode_t mbedtls_ssl_get_mode_from_ciphersuite(
Neil Armstrongf2c82f02022-04-05 11:16:53 +02002421#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01002422 int encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02002423#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01002424 const mbedtls_ssl_ciphersuite_t *suite)
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002425{
Gilles Peskinee108d982022-04-26 16:50:40 +02002426 mbedtls_ssl_mode_t base_mode = MBEDTLS_SSL_MODE_STREAM;
2427
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002428#if defined(MBEDTLS_USE_PSA_CRYPTO)
2429 psa_status_t status;
2430 psa_algorithm_t alg;
2431 psa_key_type_t type;
2432 size_t size;
Dave Rodgman2eab4622023-10-05 13:30:37 +01002433 status = mbedtls_ssl_cipher_to_psa((mbedtls_cipher_type_t) suite->cipher,
2434 0, &alg, &type, &size);
Gilles Peskine449bd832023-01-11 14:50:10 +01002435 if (status == PSA_SUCCESS) {
2436 base_mode = mbedtls_ssl_get_base_mode(alg);
2437 }
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002438#else
2439 const mbedtls_cipher_info_t *cipher =
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01002440 mbedtls_cipher_info_from_type((mbedtls_cipher_type_t) suite->cipher);
Gilles Peskine449bd832023-01-11 14:50:10 +01002441 if (cipher != NULL) {
Gilles Peskinee108d982022-04-26 16:50:40 +02002442 base_mode =
2443 mbedtls_ssl_get_base_mode(
Gilles Peskine449bd832023-01-11 14:50:10 +01002444 mbedtls_cipher_info_get_mode(cipher));
Gilles Peskinee108d982022-04-26 16:50:40 +02002445 }
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002446#endif /* MBEDTLS_USE_PSA_CRYPTO */
2447
Gilles Peskinee108d982022-04-26 16:50:40 +02002448#if !defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
2449 int encrypt_then_mac = 0;
2450#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002451 return mbedtls_ssl_get_actual_mode(base_mode, encrypt_then_mac);
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002452}
2453
Neil Armstrong8395d7a2022-05-18 11:44:56 +02002454#if defined(MBEDTLS_USE_PSA_CRYPTO) || defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yu251a12e2022-07-13 15:15:48 +08002455
Gilles Peskine449bd832023-01-11 14:50:10 +01002456psa_status_t mbedtls_ssl_cipher_to_psa(mbedtls_cipher_type_t mbedtls_cipher_type,
2457 size_t taglen,
2458 psa_algorithm_t *alg,
2459 psa_key_type_t *key_type,
2460 size_t *key_size)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002461{
Yanray Wang19e4dc82023-11-16 18:02:05 +08002462#if !defined(MBEDTLS_SSL_HAVE_CCM)
2463 (void) taglen;
2464#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002465 switch (mbedtls_cipher_type) {
Yanray Wang1a369d62023-11-16 15:17:31 +08002466#if defined(MBEDTLS_SSL_HAVE_AES) && defined(MBEDTLS_SSL_HAVE_CBC)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002467 case MBEDTLS_CIPHER_AES_128_CBC:
2468 *alg = PSA_ALG_CBC_NO_PADDING;
2469 *key_type = PSA_KEY_TYPE_AES;
2470 *key_size = 128;
2471 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002472#endif
2473#if defined(MBEDTLS_SSL_HAVE_AES) && defined(MBEDTLS_SSL_HAVE_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002474 case MBEDTLS_CIPHER_AES_128_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002475 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002476 *key_type = PSA_KEY_TYPE_AES;
2477 *key_size = 128;
2478 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002479#endif
2480#if defined(MBEDTLS_SSL_HAVE_AES) && defined(MBEDTLS_SSL_HAVE_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002481 case MBEDTLS_CIPHER_AES_128_GCM:
2482 *alg = PSA_ALG_GCM;
2483 *key_type = PSA_KEY_TYPE_AES;
2484 *key_size = 128;
2485 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002486#endif
2487#if defined(MBEDTLS_SSL_HAVE_AES) && defined(MBEDTLS_SSL_HAVE_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002488 case MBEDTLS_CIPHER_AES_192_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002489 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002490 *key_type = PSA_KEY_TYPE_AES;
2491 *key_size = 192;
2492 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002493#endif
2494#if defined(MBEDTLS_SSL_HAVE_AES) && defined(MBEDTLS_SSL_HAVE_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002495 case MBEDTLS_CIPHER_AES_192_GCM:
2496 *alg = PSA_ALG_GCM;
2497 *key_type = PSA_KEY_TYPE_AES;
2498 *key_size = 192;
2499 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002500#endif
2501#if defined(MBEDTLS_SSL_HAVE_AES) && defined(MBEDTLS_SSL_HAVE_CBC)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002502 case MBEDTLS_CIPHER_AES_256_CBC:
2503 *alg = PSA_ALG_CBC_NO_PADDING;
2504 *key_type = PSA_KEY_TYPE_AES;
2505 *key_size = 256;
2506 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002507#endif
2508#if defined(MBEDTLS_SSL_HAVE_AES) && defined(MBEDTLS_SSL_HAVE_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002509 case MBEDTLS_CIPHER_AES_256_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002510 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002511 *key_type = PSA_KEY_TYPE_AES;
2512 *key_size = 256;
2513 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002514#endif
2515#if defined(MBEDTLS_SSL_HAVE_AES) && defined(MBEDTLS_SSL_HAVE_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002516 case MBEDTLS_CIPHER_AES_256_GCM:
2517 *alg = PSA_ALG_GCM;
2518 *key_type = PSA_KEY_TYPE_AES;
2519 *key_size = 256;
2520 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002521#endif
2522#if defined(MBEDTLS_SSL_HAVE_ARIA) && defined(MBEDTLS_SSL_HAVE_CBC)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002523 case MBEDTLS_CIPHER_ARIA_128_CBC:
2524 *alg = PSA_ALG_CBC_NO_PADDING;
2525 *key_type = PSA_KEY_TYPE_ARIA;
2526 *key_size = 128;
2527 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002528#endif
2529#if defined(MBEDTLS_SSL_HAVE_ARIA) && defined(MBEDTLS_SSL_HAVE_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002530 case MBEDTLS_CIPHER_ARIA_128_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002531 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002532 *key_type = PSA_KEY_TYPE_ARIA;
2533 *key_size = 128;
2534 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002535#endif
2536#if defined(MBEDTLS_SSL_HAVE_ARIA) && defined(MBEDTLS_SSL_HAVE_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002537 case MBEDTLS_CIPHER_ARIA_128_GCM:
2538 *alg = PSA_ALG_GCM;
2539 *key_type = PSA_KEY_TYPE_ARIA;
2540 *key_size = 128;
2541 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002542#endif
2543#if defined(MBEDTLS_SSL_HAVE_ARIA) && defined(MBEDTLS_SSL_HAVE_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002544 case MBEDTLS_CIPHER_ARIA_192_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002545 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002546 *key_type = PSA_KEY_TYPE_ARIA;
2547 *key_size = 192;
2548 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002549#endif
2550#if defined(MBEDTLS_SSL_HAVE_ARIA) && defined(MBEDTLS_SSL_HAVE_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002551 case MBEDTLS_CIPHER_ARIA_192_GCM:
2552 *alg = PSA_ALG_GCM;
2553 *key_type = PSA_KEY_TYPE_ARIA;
2554 *key_size = 192;
2555 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002556#endif
2557#if defined(MBEDTLS_SSL_HAVE_ARIA) && defined(MBEDTLS_SSL_HAVE_CBC)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002558 case MBEDTLS_CIPHER_ARIA_256_CBC:
2559 *alg = PSA_ALG_CBC_NO_PADDING;
2560 *key_type = PSA_KEY_TYPE_ARIA;
2561 *key_size = 256;
2562 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002563#endif
2564#if defined(MBEDTLS_SSL_HAVE_ARIA) && defined(MBEDTLS_SSL_HAVE_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002565 case MBEDTLS_CIPHER_ARIA_256_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002566 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002567 *key_type = PSA_KEY_TYPE_ARIA;
2568 *key_size = 256;
2569 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002570#endif
2571#if defined(MBEDTLS_SSL_HAVE_ARIA) && defined(MBEDTLS_SSL_HAVE_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002572 case MBEDTLS_CIPHER_ARIA_256_GCM:
2573 *alg = PSA_ALG_GCM;
2574 *key_type = PSA_KEY_TYPE_ARIA;
2575 *key_size = 256;
2576 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002577#endif
2578#if defined(MBEDTLS_SSL_HAVE_CAMELLIA) && defined(MBEDTLS_SSL_HAVE_CBC)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002579 case MBEDTLS_CIPHER_CAMELLIA_128_CBC:
2580 *alg = PSA_ALG_CBC_NO_PADDING;
2581 *key_type = PSA_KEY_TYPE_CAMELLIA;
2582 *key_size = 128;
2583 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002584#endif
2585#if defined(MBEDTLS_SSL_HAVE_CAMELLIA) && defined(MBEDTLS_SSL_HAVE_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002586 case MBEDTLS_CIPHER_CAMELLIA_128_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002587 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002588 *key_type = PSA_KEY_TYPE_CAMELLIA;
2589 *key_size = 128;
2590 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002591#endif
2592#if defined(MBEDTLS_SSL_HAVE_CAMELLIA) && defined(MBEDTLS_SSL_HAVE_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002593 case MBEDTLS_CIPHER_CAMELLIA_128_GCM:
2594 *alg = PSA_ALG_GCM;
2595 *key_type = PSA_KEY_TYPE_CAMELLIA;
2596 *key_size = 128;
2597 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002598#endif
2599#if defined(MBEDTLS_SSL_HAVE_CAMELLIA) && defined(MBEDTLS_SSL_HAVE_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002600 case MBEDTLS_CIPHER_CAMELLIA_192_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002601 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002602 *key_type = PSA_KEY_TYPE_CAMELLIA;
2603 *key_size = 192;
2604 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002605#endif
2606#if defined(MBEDTLS_SSL_HAVE_CAMELLIA) && defined(MBEDTLS_SSL_HAVE_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002607 case MBEDTLS_CIPHER_CAMELLIA_192_GCM:
2608 *alg = PSA_ALG_GCM;
2609 *key_type = PSA_KEY_TYPE_CAMELLIA;
2610 *key_size = 192;
2611 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002612#endif
2613#if defined(MBEDTLS_SSL_HAVE_CAMELLIA) && defined(MBEDTLS_SSL_HAVE_CBC)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002614 case MBEDTLS_CIPHER_CAMELLIA_256_CBC:
2615 *alg = PSA_ALG_CBC_NO_PADDING;
2616 *key_type = PSA_KEY_TYPE_CAMELLIA;
2617 *key_size = 256;
2618 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002619#endif
2620#if defined(MBEDTLS_SSL_HAVE_CAMELLIA) && defined(MBEDTLS_SSL_HAVE_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002621 case MBEDTLS_CIPHER_CAMELLIA_256_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002622 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002623 *key_type = PSA_KEY_TYPE_CAMELLIA;
2624 *key_size = 256;
2625 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002626#endif
2627#if defined(MBEDTLS_SSL_HAVE_CAMELLIA) && defined(MBEDTLS_SSL_HAVE_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002628 case MBEDTLS_CIPHER_CAMELLIA_256_GCM:
2629 *alg = PSA_ALG_GCM;
2630 *key_type = PSA_KEY_TYPE_CAMELLIA;
2631 *key_size = 256;
2632 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002633#endif
2634#if defined(MBEDTLS_SSL_HAVE_CHACHAPOLY)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002635 case MBEDTLS_CIPHER_CHACHA20_POLY1305:
2636 *alg = PSA_ALG_CHACHA20_POLY1305;
2637 *key_type = PSA_KEY_TYPE_CHACHA20;
2638 *key_size = 256;
2639 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002640#endif
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002641 case MBEDTLS_CIPHER_NULL:
2642 *alg = MBEDTLS_SSL_NULL_CIPHER;
2643 *key_type = 0;
2644 *key_size = 0;
2645 break;
2646 default:
2647 return PSA_ERROR_NOT_SUPPORTED;
2648 }
2649
2650 return PSA_SUCCESS;
2651}
Neil Armstrong8395d7a2022-05-18 11:44:56 +02002652#endif /* MBEDTLS_USE_PSA_CRYPTO || MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002653
Manuel Pégourié-Gonnardcf141ca2015-05-20 10:35:51 +02002654#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002655int mbedtls_ssl_conf_dh_param_bin(mbedtls_ssl_config *conf,
2656 const unsigned char *dhm_P, size_t P_len,
2657 const unsigned char *dhm_G, size_t G_len)
Hanno Beckera90658f2017-10-04 15:29:08 +01002658{
Janos Follath865b3eb2019-12-16 11:46:15 +00002659 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Beckera90658f2017-10-04 15:29:08 +01002660
Gilles Peskine449bd832023-01-11 14:50:10 +01002661 mbedtls_mpi_free(&conf->dhm_P);
2662 mbedtls_mpi_free(&conf->dhm_G);
Glenn Strausscee11292021-12-20 01:43:17 -05002663
Gilles Peskine449bd832023-01-11 14:50:10 +01002664 if ((ret = mbedtls_mpi_read_binary(&conf->dhm_P, dhm_P, P_len)) != 0 ||
2665 (ret = mbedtls_mpi_read_binary(&conf->dhm_G, dhm_G, G_len)) != 0) {
2666 mbedtls_mpi_free(&conf->dhm_P);
2667 mbedtls_mpi_free(&conf->dhm_G);
2668 return ret;
Hanno Beckera90658f2017-10-04 15:29:08 +01002669 }
2670
Gilles Peskine449bd832023-01-11 14:50:10 +01002671 return 0;
Hanno Beckera90658f2017-10-04 15:29:08 +01002672}
Paul Bakker5121ce52009-01-03 21:22:43 +00002673
Gilles Peskine449bd832023-01-11 14:50:10 +01002674int mbedtls_ssl_conf_dh_param_ctx(mbedtls_ssl_config *conf, mbedtls_dhm_context *dhm_ctx)
Paul Bakker1b57b062011-01-06 15:48:19 +00002675{
Janos Follath865b3eb2019-12-16 11:46:15 +00002676 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker1b57b062011-01-06 15:48:19 +00002677
Gilles Peskine449bd832023-01-11 14:50:10 +01002678 mbedtls_mpi_free(&conf->dhm_P);
2679 mbedtls_mpi_free(&conf->dhm_G);
Glenn Strausscee11292021-12-20 01:43:17 -05002680
Gilles Peskine449bd832023-01-11 14:50:10 +01002681 if ((ret = mbedtls_dhm_get_value(dhm_ctx, MBEDTLS_DHM_PARAM_P,
2682 &conf->dhm_P)) != 0 ||
2683 (ret = mbedtls_dhm_get_value(dhm_ctx, MBEDTLS_DHM_PARAM_G,
2684 &conf->dhm_G)) != 0) {
2685 mbedtls_mpi_free(&conf->dhm_P);
2686 mbedtls_mpi_free(&conf->dhm_G);
2687 return ret;
Manuel Pégourié-Gonnard1028b742015-05-06 17:33:07 +01002688 }
Paul Bakker1b57b062011-01-06 15:48:19 +00002689
Gilles Peskine449bd832023-01-11 14:50:10 +01002690 return 0;
Paul Bakker1b57b062011-01-06 15:48:19 +00002691}
Manuel Pégourié-Gonnardcf141ca2015-05-20 10:35:51 +02002692#endif /* MBEDTLS_DHM_C && MBEDTLS_SSL_SRV_C */
Paul Bakker1b57b062011-01-06 15:48:19 +00002693
Manuel Pégourié-Gonnardbd990d62015-06-11 14:49:42 +02002694#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_CLI_C)
2695/*
2696 * Set the minimum length for Diffie-Hellman parameters
2697 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002698void mbedtls_ssl_conf_dhm_min_bitlen(mbedtls_ssl_config *conf,
2699 unsigned int bitlen)
Manuel Pégourié-Gonnardbd990d62015-06-11 14:49:42 +02002700{
2701 conf->dhm_min_bitlen = bitlen;
2702}
2703#endif /* MBEDTLS_DHM_C && MBEDTLS_SSL_CLI_C */
2704
Ronald Crone68ab4f2022-10-05 12:46:29 +02002705#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu7ddc38c2022-01-19 11:08:05 +08002706#if !defined(MBEDTLS_DEPRECATED_REMOVED) && defined(MBEDTLS_SSL_PROTO_TLS1_2)
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02002707/*
2708 * Set allowed/preferred hashes for handshake signatures
2709 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002710void mbedtls_ssl_conf_sig_hashes(mbedtls_ssl_config *conf,
2711 const int *hashes)
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02002712{
2713 conf->sig_hashes = hashes;
2714}
Jerry Yu7ddc38c2022-01-19 11:08:05 +08002715#endif /* !MBEDTLS_DEPRECATED_REMOVED && MBEDTLS_SSL_PROTO_TLS1_2 */
Hanno Becker1cd6e002021-08-10 13:27:10 +01002716
Jerry Yuf017ee42022-01-12 15:49:48 +08002717/* Configure allowed signature algorithms for handshake */
Gilles Peskine449bd832023-01-11 14:50:10 +01002718void mbedtls_ssl_conf_sig_algs(mbedtls_ssl_config *conf,
2719 const uint16_t *sig_algs)
Hanno Becker1cd6e002021-08-10 13:27:10 +01002720{
Jerry Yuf017ee42022-01-12 15:49:48 +08002721#if !defined(MBEDTLS_DEPRECATED_REMOVED)
2722 conf->sig_hashes = NULL;
2723#endif /* !MBEDTLS_DEPRECATED_REMOVED */
2724 conf->sig_algs = sig_algs;
Hanno Becker1cd6e002021-08-10 13:27:10 +01002725}
Ronald Crone68ab4f2022-10-05 12:46:29 +02002726#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02002727
Manuel Pégourié-Gonnardf07ce3b2023-09-22 11:53:41 +02002728#if defined(MBEDTLS_ECP_C)
Brett Warrene0edc842021-08-17 09:53:13 +01002729#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002730/*
2731 * Set the allowed elliptic curves
Brett Warrene0edc842021-08-17 09:53:13 +01002732 *
2733 * mbedtls_ssl_setup() takes the provided list
2734 * and translates it to a list of IANA TLS group identifiers,
2735 * stored in ssl->handshake->group_list.
2736 *
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002737 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002738void mbedtls_ssl_conf_curves(mbedtls_ssl_config *conf,
2739 const mbedtls_ecp_group_id *curve_list)
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002740{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002741 conf->curve_list = curve_list;
Brett Warrene0edc842021-08-17 09:53:13 +01002742 conf->group_list = NULL;
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002743}
Brett Warrene0edc842021-08-17 09:53:13 +01002744#endif /* MBEDTLS_DEPRECATED_REMOVED */
Manuel Pégourié-Gonnardf07ce3b2023-09-22 11:53:41 +02002745#endif /* MBEDTLS_ECP_C */
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002746
Brett Warrene0edc842021-08-17 09:53:13 +01002747/*
2748 * Set the allowed groups
2749 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002750void mbedtls_ssl_conf_groups(mbedtls_ssl_config *conf,
2751 const uint16_t *group_list)
Brett Warrene0edc842021-08-17 09:53:13 +01002752{
Manuel Pégourié-Gonnardf07ce3b2023-09-22 11:53:41 +02002753#if defined(MBEDTLS_ECP_C) && !defined(MBEDTLS_DEPRECATED_REMOVED)
Brett Warrene0edc842021-08-17 09:53:13 +01002754 conf->curve_list = NULL;
2755#endif
2756 conf->group_list = group_list;
2757}
2758
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01002759#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskinee61852e2025-02-12 23:28:48 +01002760
2761#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
2762/** Whether mbedtls_ssl_set_hostname() has been called.
2763 *
2764 * \param[in] ssl SSL context
2765 *
2766 * \return \c 1 if mbedtls_ssl_set_hostname() has been called on \p ssl
2767 * (including `mbedtls_ssl_set_hostname(ssl, NULL)`),
2768 * otherwise \c 0.
2769 */
2770static int mbedtls_ssl_has_set_hostname_been_called(
2771 const mbedtls_ssl_context *ssl)
2772{
2773 /* We can't tell the difference between the case where
2774 * mbedtls_ssl_set_hostname() has not been called at all, and
2775 * the case where it was last called with NULL. For the time
2776 * being, we assume the latter, i.e. we behave as if there had
2777 * been an implicit call to mbedtls_ssl_set_hostname(ssl, NULL). */
2778 return ssl->hostname != NULL;
2779}
2780#endif
2781
2782/* Micro-optimization: don't export this function if it isn't needed outside
2783 * of this source file. */
2784#if !defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
2785static
2786#endif
2787const char *mbedtls_ssl_get_hostname_pointer(const mbedtls_ssl_context *ssl)
2788{
2789 return ssl->hostname;
2790}
2791
2792static void mbedtls_ssl_free_hostname(mbedtls_ssl_context *ssl)
2793{
2794 if (ssl->hostname != NULL) {
2795 mbedtls_zeroize_and_free(ssl->hostname, strlen(ssl->hostname));
2796 }
2797 ssl->hostname = NULL;
2798}
2799
Gilles Peskine449bd832023-01-11 14:50:10 +01002800int mbedtls_ssl_set_hostname(mbedtls_ssl_context *ssl, const char *hostname)
Paul Bakker5121ce52009-01-03 21:22:43 +00002801{
Hanno Becker947194e2017-04-07 13:25:49 +01002802 /* Initialize to suppress unnecessary compiler warning */
2803 size_t hostname_len = 0;
2804
2805 /* Check if new hostname is valid before
2806 * making any change to current one */
Gilles Peskine449bd832023-01-11 14:50:10 +01002807 if (hostname != NULL) {
2808 hostname_len = strlen(hostname);
Hanno Becker947194e2017-04-07 13:25:49 +01002809
Gilles Peskine449bd832023-01-11 14:50:10 +01002810 if (hostname_len > MBEDTLS_SSL_MAX_HOST_NAME_LEN) {
2811 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2812 }
Hanno Becker947194e2017-04-07 13:25:49 +01002813 }
2814
2815 /* Now it's clear that we will overwrite the old hostname,
2816 * so we can free it safely */
Gilles Peskinee61852e2025-02-12 23:28:48 +01002817 mbedtls_ssl_free_hostname(ssl);
Hanno Becker947194e2017-04-07 13:25:49 +01002818
2819 /* Passing NULL as hostname shall clear the old one */
Manuel Pégourié-Gonnardba26c242015-05-06 10:47:06 +01002820
Gilles Peskine449bd832023-01-11 14:50:10 +01002821 if (hostname == NULL) {
Hanno Becker947194e2017-04-07 13:25:49 +01002822 ssl->hostname = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01002823 } else {
2824 ssl->hostname = mbedtls_calloc(1, hostname_len + 1);
2825 if (ssl->hostname == NULL) {
2826 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
2827 }
Paul Bakker75c1a6f2013-08-19 14:25:29 +02002828
Gilles Peskine449bd832023-01-11 14:50:10 +01002829 memcpy(ssl->hostname, hostname, hostname_len);
Paul Bakker75c1a6f2013-08-19 14:25:29 +02002830
Hanno Becker947194e2017-04-07 13:25:49 +01002831 ssl->hostname[hostname_len] = '\0';
2832 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002833
Gilles Peskine449bd832023-01-11 14:50:10 +01002834 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00002835}
Hanno Becker1a9a51c2017-04-07 13:02:16 +01002836#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00002837
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01002838#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01002839void mbedtls_ssl_conf_sni(mbedtls_ssl_config *conf,
2840 int (*f_sni)(void *, mbedtls_ssl_context *,
2841 const unsigned char *, size_t),
2842 void *p_sni)
Paul Bakker5701cdc2012-09-27 21:49:42 +00002843{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002844 conf->f_sni = f_sni;
2845 conf->p_sni = p_sni;
Paul Bakker5701cdc2012-09-27 21:49:42 +00002846}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002847#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
Paul Bakker5701cdc2012-09-27 21:49:42 +00002848
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002849#if defined(MBEDTLS_SSL_ALPN)
Gilles Peskine449bd832023-01-11 14:50:10 +01002850int mbedtls_ssl_conf_alpn_protocols(mbedtls_ssl_config *conf, const char **protos)
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002851{
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002852 size_t cur_len, tot_len;
2853 const char **p;
2854
2855 /*
Brian J Murray1903fb32016-11-06 04:45:15 -08002856 * RFC 7301 3.1: "Empty strings MUST NOT be included and byte strings
2857 * MUST NOT be truncated."
2858 * We check lengths now rather than later.
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002859 */
2860 tot_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01002861 for (p = protos; *p != NULL; p++) {
2862 cur_len = strlen(*p);
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002863 tot_len += cur_len;
2864
Gilles Peskine449bd832023-01-11 14:50:10 +01002865 if ((cur_len == 0) ||
2866 (cur_len > MBEDTLS_SSL_MAX_ALPN_NAME_LEN) ||
2867 (tot_len > MBEDTLS_SSL_MAX_ALPN_LIST_LEN)) {
2868 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2869 }
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002870 }
2871
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002872 conf->alpn_list = protos;
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002873
Gilles Peskine449bd832023-01-11 14:50:10 +01002874 return 0;
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002875}
2876
Gilles Peskine449bd832023-01-11 14:50:10 +01002877const char *mbedtls_ssl_get_alpn_protocol(const mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002878{
Gilles Peskine449bd832023-01-11 14:50:10 +01002879 return ssl->alpn_chosen;
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002880}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002881#endif /* MBEDTLS_SSL_ALPN */
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002882
Johan Pascalb62bb512015-12-03 21:56:45 +01002883#if defined(MBEDTLS_SSL_DTLS_SRTP)
Gilles Peskine449bd832023-01-11 14:50:10 +01002884void mbedtls_ssl_conf_srtp_mki_value_supported(mbedtls_ssl_config *conf,
2885 int support_mki_value)
Ron Eldor591f1622018-01-22 12:30:04 +02002886{
2887 conf->dtls_srtp_mki_support = support_mki_value;
2888}
2889
Gilles Peskine449bd832023-01-11 14:50:10 +01002890int mbedtls_ssl_dtls_srtp_set_mki_value(mbedtls_ssl_context *ssl,
2891 unsigned char *mki_value,
2892 uint16_t mki_len)
Ron Eldor591f1622018-01-22 12:30:04 +02002893{
Gilles Peskine449bd832023-01-11 14:50:10 +01002894 if (mki_len > MBEDTLS_TLS_SRTP_MAX_MKI_LENGTH) {
2895 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Ron Eldora9788042018-12-05 11:04:31 +02002896 }
Ron Eldor591f1622018-01-22 12:30:04 +02002897
Gilles Peskine449bd832023-01-11 14:50:10 +01002898 if (ssl->conf->dtls_srtp_mki_support == MBEDTLS_SSL_DTLS_SRTP_MKI_UNSUPPORTED) {
2899 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Ron Eldora9788042018-12-05 11:04:31 +02002900 }
Ron Eldor591f1622018-01-22 12:30:04 +02002901
Gilles Peskine449bd832023-01-11 14:50:10 +01002902 memcpy(ssl->dtls_srtp_info.mki_value, mki_value, mki_len);
Ron Eldor591f1622018-01-22 12:30:04 +02002903 ssl->dtls_srtp_info.mki_len = mki_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01002904 return 0;
Ron Eldor591f1622018-01-22 12:30:04 +02002905}
2906
Gilles Peskine449bd832023-01-11 14:50:10 +01002907int mbedtls_ssl_conf_dtls_srtp_protection_profiles(mbedtls_ssl_config *conf,
2908 const mbedtls_ssl_srtp_profile *profiles)
Johan Pascalb62bb512015-12-03 21:56:45 +01002909{
Johan Pascal253d0262020-09-22 13:04:45 +02002910 const mbedtls_ssl_srtp_profile *p;
2911 size_t list_size = 0;
Johan Pascalb62bb512015-12-03 21:56:45 +01002912
Johan Pascal253d0262020-09-22 13:04:45 +02002913 /* check the profiles list: all entry must be valid,
2914 * its size cannot be more than the total number of supported profiles, currently 4 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002915 for (p = profiles; *p != MBEDTLS_TLS_SRTP_UNSET &&
2916 list_size <= MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH;
2917 p++) {
2918 if (mbedtls_ssl_check_srtp_profile_value(*p) != MBEDTLS_TLS_SRTP_UNSET) {
Johan Pascal76fdf1d2020-10-22 23:31:00 +02002919 list_size++;
Gilles Peskine449bd832023-01-11 14:50:10 +01002920 } else {
Johan Pascal76fdf1d2020-10-22 23:31:00 +02002921 /* unsupported value, stop parsing and set the size to an error value */
2922 list_size = MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH + 1;
Johan Pascalb62bb512015-12-03 21:56:45 +01002923 }
2924 }
2925
Gilles Peskine449bd832023-01-11 14:50:10 +01002926 if (list_size > MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH) {
2927 conf->dtls_srtp_profile_list = NULL;
2928 conf->dtls_srtp_profile_list_len = 0;
2929 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Johan Pascal253d0262020-09-22 13:04:45 +02002930 }
2931
Johan Pascal9bc97ca2020-09-21 23:44:45 +02002932 conf->dtls_srtp_profile_list = profiles;
Johan Pascal253d0262020-09-22 13:04:45 +02002933 conf->dtls_srtp_profile_list_len = list_size;
Johan Pascalb62bb512015-12-03 21:56:45 +01002934
Gilles Peskine449bd832023-01-11 14:50:10 +01002935 return 0;
Johan Pascalb62bb512015-12-03 21:56:45 +01002936}
2937
Gilles Peskine449bd832023-01-11 14:50:10 +01002938void mbedtls_ssl_get_dtls_srtp_negotiation_result(const mbedtls_ssl_context *ssl,
2939 mbedtls_dtls_srtp_info *dtls_srtp_info)
Johan Pascalb62bb512015-12-03 21:56:45 +01002940{
Johan Pascal2258a4f2020-10-28 13:53:09 +01002941 dtls_srtp_info->chosen_dtls_srtp_profile = ssl->dtls_srtp_info.chosen_dtls_srtp_profile;
2942 /* do not copy the mki value if there is no chosen profile */
Gilles Peskine449bd832023-01-11 14:50:10 +01002943 if (dtls_srtp_info->chosen_dtls_srtp_profile == MBEDTLS_TLS_SRTP_UNSET) {
Johan Pascal2258a4f2020-10-28 13:53:09 +01002944 dtls_srtp_info->mki_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01002945 } else {
Johan Pascal2258a4f2020-10-28 13:53:09 +01002946 dtls_srtp_info->mki_len = ssl->dtls_srtp_info.mki_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01002947 memcpy(dtls_srtp_info->mki_value, ssl->dtls_srtp_info.mki_value,
2948 ssl->dtls_srtp_info.mki_len);
Johan Pascal2258a4f2020-10-28 13:53:09 +01002949 }
Johan Pascalb62bb512015-12-03 21:56:45 +01002950}
Johan Pascalb62bb512015-12-03 21:56:45 +01002951#endif /* MBEDTLS_SSL_DTLS_SRTP */
2952
Aditya Patwardhan3096f332022-07-26 14:31:46 +05302953#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Gilles Peskine449bd832023-01-11 14:50:10 +01002954void mbedtls_ssl_conf_max_version(mbedtls_ssl_config *conf, int major, int minor)
Paul Bakker490ecc82011-10-06 13:04:09 +00002955{
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01002956 conf->max_tls_version = (mbedtls_ssl_protocol_version) ((major << 8) | minor);
Paul Bakker490ecc82011-10-06 13:04:09 +00002957}
2958
Gilles Peskine449bd832023-01-11 14:50:10 +01002959void mbedtls_ssl_conf_min_version(mbedtls_ssl_config *conf, int major, int minor)
Paul Bakker1d29fb52012-09-28 13:28:45 +00002960{
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01002961 conf->min_tls_version = (mbedtls_ssl_protocol_version) ((major << 8) | minor);
Paul Bakker1d29fb52012-09-28 13:28:45 +00002962}
Aditya Patwardhan3096f332022-07-26 14:31:46 +05302963#endif /* MBEDTLS_DEPRECATED_REMOVED */
Paul Bakker1d29fb52012-09-28 13:28:45 +00002964
Janos Follath088ce432017-04-10 12:42:31 +01002965#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002966void mbedtls_ssl_conf_cert_req_ca_list(mbedtls_ssl_config *conf,
2967 char cert_req_ca_list)
Janos Follath088ce432017-04-10 12:42:31 +01002968{
2969 conf->cert_req_ca_list = cert_req_ca_list;
2970}
2971#endif
2972
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002973#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01002974void mbedtls_ssl_conf_encrypt_then_mac(mbedtls_ssl_config *conf, char etm)
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01002975{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002976 conf->encrypt_then_mac = etm;
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01002977}
2978#endif
2979
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002980#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
Gilles Peskine449bd832023-01-11 14:50:10 +01002981void mbedtls_ssl_conf_extended_master_secret(mbedtls_ssl_config *conf, char ems)
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02002982{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002983 conf->extended_ms = ems;
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02002984}
2985#endif
2986
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002987#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01002988int mbedtls_ssl_conf_max_frag_len(mbedtls_ssl_config *conf, unsigned char mfl_code)
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002989{
Gilles Peskine449bd832023-01-11 14:50:10 +01002990 if (mfl_code >= MBEDTLS_SSL_MAX_FRAG_LEN_INVALID ||
2991 ssl_mfl_code_to_length(mfl_code) > MBEDTLS_TLS_EXT_ADV_CONTENT_LEN) {
2992 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002993 }
2994
Manuel Pégourié-Gonnard6bf89d62015-05-05 17:01:57 +01002995 conf->mfl_code = mfl_code;
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002996
Gilles Peskine449bd832023-01-11 14:50:10 +01002997 return 0;
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002998}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002999#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02003000
Gilles Peskine449bd832023-01-11 14:50:10 +01003001void mbedtls_ssl_conf_legacy_renegotiation(mbedtls_ssl_config *conf, int allow_legacy)
Paul Bakker48916f92012-09-16 19:57:18 +00003002{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003003 conf->allow_legacy_renegotiation = allow_legacy;
Paul Bakker48916f92012-09-16 19:57:18 +00003004}
3005
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003006#if defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01003007void mbedtls_ssl_conf_renegotiation(mbedtls_ssl_config *conf, int renegotiation)
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01003008{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003009 conf->disable_renegotiation = renegotiation;
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01003010}
3011
Gilles Peskine449bd832023-01-11 14:50:10 +01003012void mbedtls_ssl_conf_renegotiation_enforced(mbedtls_ssl_config *conf, int max_records)
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02003013{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003014 conf->renego_max_records = max_records;
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02003015}
3016
Gilles Peskine449bd832023-01-11 14:50:10 +01003017void mbedtls_ssl_conf_renegotiation_period(mbedtls_ssl_config *conf,
3018 const unsigned char period[8])
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01003019{
Gilles Peskine449bd832023-01-11 14:50:10 +01003020 memcpy(conf->renego_period, period, 8);
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01003021}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003022#endif /* MBEDTLS_SSL_RENEGOTIATION */
Paul Bakker5121ce52009-01-03 21:22:43 +00003023
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003024#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02003025#if defined(MBEDTLS_SSL_CLI_C)
Ronald Crond67f8012024-08-28 07:45:57 +02003026
Gilles Peskine449bd832023-01-11 14:50:10 +01003027void mbedtls_ssl_conf_session_tickets(mbedtls_ssl_config *conf, int use_tickets)
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02003028{
Ronald Crond67f8012024-08-28 07:45:57 +02003029 conf->session_tickets &= ~MBEDTLS_SSL_SESSION_TICKETS_TLS1_2_MASK;
3030 conf->session_tickets |= (use_tickets != 0) <<
3031 MBEDTLS_SSL_SESSION_TICKETS_TLS1_2_BIT;
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02003032}
Ronald Crond67f8012024-08-28 07:45:57 +02003033
Ronald Cronbedddd72024-08-27 14:18:50 +02003034#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Ronald Cron9f44c882024-08-28 16:44:10 +02003035void mbedtls_ssl_conf_tls13_enable_signal_new_session_tickets(
3036 mbedtls_ssl_config *conf, int signal_new_session_tickets)
Ronald Cronbedddd72024-08-27 14:18:50 +02003037{
Ronald Crond67f8012024-08-28 07:45:57 +02003038 conf->session_tickets &= ~MBEDTLS_SSL_SESSION_TICKETS_TLS1_3_MASK;
Ronald Cron9f44c882024-08-28 16:44:10 +02003039 conf->session_tickets |= (signal_new_session_tickets != 0) <<
Ronald Crond67f8012024-08-28 07:45:57 +02003040 MBEDTLS_SSL_SESSION_TICKETS_TLS1_3_BIT;
3041}
Ronald Cronbedddd72024-08-27 14:18:50 +02003042#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
3043#endif /* MBEDTLS_SSL_CLI_C */
Paul Bakker606b4ba2013-08-14 16:52:14 +02003044
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02003045#if defined(MBEDTLS_SSL_SRV_C)
Jerry Yu1ad7ace2022-08-09 13:28:39 +08003046
Jerry Yud0766ec2022-09-22 10:46:57 +08003047#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003048void mbedtls_ssl_conf_new_session_tickets(mbedtls_ssl_config *conf,
3049 uint16_t num_tickets)
Jerry Yu1ad7ace2022-08-09 13:28:39 +08003050{
Jerry Yud0766ec2022-09-22 10:46:57 +08003051 conf->new_session_tickets_count = num_tickets;
Jerry Yu1ad7ace2022-08-09 13:28:39 +08003052}
3053#endif
3054
Gilles Peskine449bd832023-01-11 14:50:10 +01003055void mbedtls_ssl_conf_session_tickets_cb(mbedtls_ssl_config *conf,
3056 mbedtls_ssl_ticket_write_t *f_ticket_write,
3057 mbedtls_ssl_ticket_parse_t *f_ticket_parse,
3058 void *p_ticket)
Paul Bakker606b4ba2013-08-14 16:52:14 +02003059{
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02003060 conf->f_ticket_write = f_ticket_write;
3061 conf->f_ticket_parse = f_ticket_parse;
3062 conf->p_ticket = p_ticket;
Paul Bakker606b4ba2013-08-14 16:52:14 +02003063}
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02003064#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003065#endif /* MBEDTLS_SSL_SESSION_TICKETS */
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02003066
Gilles Peskine449bd832023-01-11 14:50:10 +01003067void mbedtls_ssl_set_export_keys_cb(mbedtls_ssl_context *ssl,
3068 mbedtls_ssl_export_keys_t *f_export_keys,
3069 void *p_export_keys)
Robert Cragie4feb7ae2015-10-02 13:33:37 +01003070{
Hanno Becker7e6c1782021-06-08 09:24:55 +01003071 ssl->f_export_keys = f_export_keys;
3072 ssl->p_export_keys = p_export_keys;
Ron Eldorf5cc10d2019-05-07 18:33:40 +03003073}
Robert Cragie4feb7ae2015-10-02 13:33:37 +01003074
Gilles Peskineb74a1c72018-04-24 13:09:22 +02003075#if defined(MBEDTLS_SSL_ASYNC_PRIVATE)
Gilles Peskine8bf79f62018-01-05 21:11:53 +01003076void mbedtls_ssl_conf_async_private_cb(
3077 mbedtls_ssl_config *conf,
3078 mbedtls_ssl_async_sign_t *f_async_sign,
3079 mbedtls_ssl_async_decrypt_t *f_async_decrypt,
3080 mbedtls_ssl_async_resume_t *f_async_resume,
3081 mbedtls_ssl_async_cancel_t *f_async_cancel,
Gilles Peskine449bd832023-01-11 14:50:10 +01003082 void *async_config_data)
Gilles Peskine8bf79f62018-01-05 21:11:53 +01003083{
3084 conf->f_async_sign_start = f_async_sign;
3085 conf->f_async_decrypt_start = f_async_decrypt;
3086 conf->f_async_resume = f_async_resume;
3087 conf->f_async_cancel = f_async_cancel;
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003088 conf->p_async_config_data = async_config_data;
3089}
3090
Gilles Peskine449bd832023-01-11 14:50:10 +01003091void *mbedtls_ssl_conf_get_async_config_data(const mbedtls_ssl_config *conf)
Gilles Peskine8f97af72018-04-26 11:46:10 +02003092{
Gilles Peskine449bd832023-01-11 14:50:10 +01003093 return conf->p_async_config_data;
Gilles Peskine8f97af72018-04-26 11:46:10 +02003094}
3095
Gilles Peskine449bd832023-01-11 14:50:10 +01003096void *mbedtls_ssl_get_async_operation_data(const mbedtls_ssl_context *ssl)
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003097{
Gilles Peskine449bd832023-01-11 14:50:10 +01003098 if (ssl->handshake == NULL) {
3099 return NULL;
3100 } else {
3101 return ssl->handshake->user_async_ctx;
3102 }
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003103}
3104
Gilles Peskine449bd832023-01-11 14:50:10 +01003105void mbedtls_ssl_set_async_operation_data(mbedtls_ssl_context *ssl,
3106 void *ctx)
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003107{
Gilles Peskine449bd832023-01-11 14:50:10 +01003108 if (ssl->handshake != NULL) {
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003109 ssl->handshake->user_async_ctx = ctx;
Gilles Peskine449bd832023-01-11 14:50:10 +01003110 }
Gilles Peskine8bf79f62018-01-05 21:11:53 +01003111}
Gilles Peskineb74a1c72018-04-24 13:09:22 +02003112#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
Gilles Peskine8bf79f62018-01-05 21:11:53 +01003113
Paul Bakker5121ce52009-01-03 21:22:43 +00003114/*
3115 * SSL get accessors
3116 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003117uint32_t mbedtls_ssl_get_verify_result(const mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00003118{
Gilles Peskine449bd832023-01-11 14:50:10 +01003119 if (ssl->session != NULL) {
3120 return ssl->session->verify_result;
3121 }
Manuel Pégourié-Gonnarde89163c2015-01-23 14:30:57 +00003122
Gilles Peskine449bd832023-01-11 14:50:10 +01003123 if (ssl->session_negotiate != NULL) {
3124 return ssl->session_negotiate->verify_result;
3125 }
Manuel Pégourié-Gonnarde89163c2015-01-23 14:30:57 +00003126
Gilles Peskine449bd832023-01-11 14:50:10 +01003127 return 0xFFFFFFFF;
Paul Bakker5121ce52009-01-03 21:22:43 +00003128}
3129
Gilles Peskine449bd832023-01-11 14:50:10 +01003130int mbedtls_ssl_get_ciphersuite_id_from_ssl(const mbedtls_ssl_context *ssl)
Glenn Strauss8f526902022-01-13 00:04:49 -05003131{
Gilles Peskine449bd832023-01-11 14:50:10 +01003132 if (ssl == NULL || ssl->session == NULL) {
3133 return 0;
3134 }
Glenn Strauss8f526902022-01-13 00:04:49 -05003135
Gilles Peskine449bd832023-01-11 14:50:10 +01003136 return ssl->session->ciphersuite;
Glenn Strauss8f526902022-01-13 00:04:49 -05003137}
3138
Gilles Peskine449bd832023-01-11 14:50:10 +01003139const char *mbedtls_ssl_get_ciphersuite(const mbedtls_ssl_context *ssl)
Paul Bakker72f62662011-01-16 21:27:44 +00003140{
Gilles Peskine449bd832023-01-11 14:50:10 +01003141 if (ssl == NULL || ssl->session == NULL) {
3142 return NULL;
3143 }
Paul Bakker926c8e42013-03-06 10:23:34 +01003144
Gilles Peskine449bd832023-01-11 14:50:10 +01003145 return mbedtls_ssl_get_ciphersuite_name(ssl->session->ciphersuite);
Paul Bakker72f62662011-01-16 21:27:44 +00003146}
3147
Gilles Peskine449bd832023-01-11 14:50:10 +01003148const char *mbedtls_ssl_get_version(const mbedtls_ssl_context *ssl)
Paul Bakker43ca69c2011-01-15 17:35:19 +00003149{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003150#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003151 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
3152 switch (ssl->tls_version) {
Glenn Strauss60bfe602022-03-14 19:04:24 -04003153 case MBEDTLS_SSL_VERSION_TLS1_2:
Gilles Peskine449bd832023-01-11 14:50:10 +01003154 return "DTLSv1.2";
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01003155 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01003156 return "unknown (DTLS)";
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01003157 }
3158 }
3159#endif
3160
Gilles Peskine449bd832023-01-11 14:50:10 +01003161 switch (ssl->tls_version) {
Glenn Strauss60bfe602022-03-14 19:04:24 -04003162 case MBEDTLS_SSL_VERSION_TLS1_2:
Gilles Peskine449bd832023-01-11 14:50:10 +01003163 return "TLSv1.2";
Glenn Strauss60bfe602022-03-14 19:04:24 -04003164 case MBEDTLS_SSL_VERSION_TLS1_3:
Gilles Peskine449bd832023-01-11 14:50:10 +01003165 return "TLSv1.3";
Paul Bakker43ca69c2011-01-15 17:35:19 +00003166 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01003167 return "unknown";
Paul Bakker43ca69c2011-01-15 17:35:19 +00003168 }
Paul Bakker43ca69c2011-01-15 17:35:19 +00003169}
3170
Waleed Elmelegy6a971fd2023-12-28 17:48:16 +00003171#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
3172
3173size_t mbedtls_ssl_get_output_record_size_limit(const mbedtls_ssl_context *ssl)
3174{
3175 const size_t max_len = MBEDTLS_SSL_OUT_CONTENT_LEN;
3176 size_t record_size_limit = max_len;
3177
3178 if (ssl->session != NULL &&
3179 ssl->session->record_size_limit >= MBEDTLS_SSL_RECORD_SIZE_LIMIT_MIN &&
3180 ssl->session->record_size_limit < max_len) {
3181 record_size_limit = ssl->session->record_size_limit;
3182 }
3183
3184 // TODO: this is currently untested
3185 /* During a handshake, use the value being negotiated */
3186 if (ssl->session_negotiate != NULL &&
3187 ssl->session_negotiate->record_size_limit >= MBEDTLS_SSL_RECORD_SIZE_LIMIT_MIN &&
3188 ssl->session_negotiate->record_size_limit < max_len) {
3189 record_size_limit = ssl->session_negotiate->record_size_limit;
3190 }
3191
3192 return record_size_limit;
3193}
3194#endif /* MBEDTLS_SSL_RECORD_SIZE_LIMIT */
3195
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02003196#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01003197size_t mbedtls_ssl_get_input_max_frag_len(const mbedtls_ssl_context *ssl)
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003198{
David Horstmann95d516f2021-05-04 18:36:56 +01003199 size_t max_len = MBEDTLS_SSL_IN_CONTENT_LEN;
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003200 size_t read_mfl;
3201
Jerry Yuddda0502022-12-01 19:43:12 +08003202#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003203 /* Use the configured MFL for the client if we're past SERVER_HELLO_DONE */
Gilles Peskine449bd832023-01-11 14:50:10 +01003204 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
3205 ssl->state >= MBEDTLS_SSL_SERVER_HELLO_DONE) {
3206 return ssl_mfl_code_to_length(ssl->conf->mfl_code);
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003207 }
Jerry Yuddda0502022-12-01 19:43:12 +08003208#endif
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003209
3210 /* Check if a smaller max length was negotiated */
Gilles Peskine449bd832023-01-11 14:50:10 +01003211 if (ssl->session_out != NULL) {
3212 read_mfl = ssl_mfl_code_to_length(ssl->session_out->mfl_code);
3213 if (read_mfl < max_len) {
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003214 max_len = read_mfl;
3215 }
3216 }
3217
Jerry Yuddda0502022-12-01 19:43:12 +08003218 /* During a handshake, use the value being negotiated */
Gilles Peskine449bd832023-01-11 14:50:10 +01003219 if (ssl->session_negotiate != NULL) {
3220 read_mfl = ssl_mfl_code_to_length(ssl->session_negotiate->mfl_code);
3221 if (read_mfl < max_len) {
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003222 max_len = read_mfl;
3223 }
3224 }
3225
Gilles Peskine449bd832023-01-11 14:50:10 +01003226 return max_len;
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003227}
3228
Gilles Peskine449bd832023-01-11 14:50:10 +01003229size_t mbedtls_ssl_get_output_max_frag_len(const mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02003230{
3231 size_t max_len;
3232
3233 /*
3234 * Assume mfl_code is correct since it was checked when set
3235 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003236 max_len = ssl_mfl_code_to_length(ssl->conf->mfl_code);
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02003237
Manuel Pégourié-Gonnard2cb17e22017-09-19 13:00:47 +02003238 /* Check if a smaller max length was negotiated */
Gilles Peskine449bd832023-01-11 14:50:10 +01003239 if (ssl->session_out != NULL &&
3240 ssl_mfl_code_to_length(ssl->session_out->mfl_code) < max_len) {
3241 max_len = ssl_mfl_code_to_length(ssl->session_out->mfl_code);
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02003242 }
3243
Manuel Pégourié-Gonnard2cb17e22017-09-19 13:00:47 +02003244 /* During a handshake, use the value being negotiated */
Gilles Peskine449bd832023-01-11 14:50:10 +01003245 if (ssl->session_negotiate != NULL &&
3246 ssl_mfl_code_to_length(ssl->session_negotiate->mfl_code) < max_len) {
3247 max_len = ssl_mfl_code_to_length(ssl->session_negotiate->mfl_code);
Manuel Pégourié-Gonnard2cb17e22017-09-19 13:00:47 +02003248 }
3249
Gilles Peskine449bd832023-01-11 14:50:10 +01003250 return max_len;
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02003251}
3252#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
3253
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003254#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003255size_t mbedtls_ssl_get_current_mtu(const mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003256{
Andrzej Kurekef43ce62018-10-09 08:24:12 -04003257 /* Return unlimited mtu for client hello messages to avoid fragmentation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01003258 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
3259 (ssl->state == MBEDTLS_SSL_CLIENT_HELLO ||
3260 ssl->state == MBEDTLS_SSL_SERVER_HELLO)) {
3261 return 0;
3262 }
Andrzej Kurekef43ce62018-10-09 08:24:12 -04003263
Gilles Peskine449bd832023-01-11 14:50:10 +01003264 if (ssl->handshake == NULL || ssl->handshake->mtu == 0) {
3265 return ssl->mtu;
3266 }
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003267
Gilles Peskine449bd832023-01-11 14:50:10 +01003268 if (ssl->mtu == 0) {
3269 return ssl->handshake->mtu;
3270 }
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003271
Gilles Peskine449bd832023-01-11 14:50:10 +01003272 return ssl->mtu < ssl->handshake->mtu ?
3273 ssl->mtu : ssl->handshake->mtu;
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003274}
3275#endif /* MBEDTLS_SSL_PROTO_DTLS */
3276
Gilles Peskine449bd832023-01-11 14:50:10 +01003277int mbedtls_ssl_get_max_out_record_payload(const mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003278{
3279 size_t max_len = MBEDTLS_SSL_OUT_CONTENT_LEN;
3280
Manuel Pégourié-Gonnard000281e2018-08-21 11:20:58 +02003281#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH) && \
Jan Brucknerf482dcc2023-03-15 09:09:06 +01003282 !defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT) && \
Manuel Pégourié-Gonnard000281e2018-08-21 11:20:58 +02003283 !defined(MBEDTLS_SSL_PROTO_DTLS)
3284 (void) ssl;
3285#endif
3286
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003287#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01003288 const size_t mfl = mbedtls_ssl_get_output_max_frag_len(ssl);
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003289
Gilles Peskine449bd832023-01-11 14:50:10 +01003290 if (max_len > mfl) {
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003291 max_len = mfl;
Gilles Peskine449bd832023-01-11 14:50:10 +01003292 }
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003293#endif
3294
Jan Brucknerf482dcc2023-03-15 09:09:06 +01003295#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
3296 const size_t record_size_limit = mbedtls_ssl_get_output_record_size_limit(ssl);
3297
3298 if (max_len > record_size_limit) {
3299 max_len = record_size_limit;
3300 }
3301#endif
3302
Waleed Elmelegy6a971fd2023-12-28 17:48:16 +00003303 if (ssl->transform_out != NULL &&
3304 ssl->transform_out->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Waleed Elmelegyf5017902024-01-09 14:18:34 +00003305 /*
3306 * In TLS 1.3 case, when records are protected, `max_len` as computed
3307 * above is the maximum length of the TLSInnerPlaintext structure that
3308 * along the plaintext payload contains the inner content type (one byte)
3309 * and some zero padding. Given the algorithm used for padding
3310 * in mbedtls_ssl_encrypt_buf(), compute the maximum length for
3311 * the plaintext payload. Round down to a multiple of
3312 * MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY and
3313 * subtract 1.
Waleed Elmelegy6a971fd2023-12-28 17:48:16 +00003314 */
3315 max_len = ((max_len / MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY) *
3316 MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY) - 1;
3317 }
3318
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003319#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003320 if (mbedtls_ssl_get_current_mtu(ssl) != 0) {
3321 const size_t mtu = mbedtls_ssl_get_current_mtu(ssl);
3322 const int ret = mbedtls_ssl_get_record_expansion(ssl);
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003323 const size_t overhead = (size_t) ret;
3324
Gilles Peskine449bd832023-01-11 14:50:10 +01003325 if (ret < 0) {
3326 return ret;
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003327 }
3328
Gilles Peskine449bd832023-01-11 14:50:10 +01003329 if (mtu <= overhead) {
3330 MBEDTLS_SSL_DEBUG_MSG(1, ("MTU too low for record expansion"));
3331 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
3332 }
3333
3334 if (max_len > mtu - overhead) {
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003335 max_len = mtu - overhead;
Gilles Peskine449bd832023-01-11 14:50:10 +01003336 }
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003337 }
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003338#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003339
Hanno Becker0defedb2018-08-10 12:35:02 +01003340#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH) && \
Waleed Elmelegy049cd302023-12-20 17:28:31 +00003341 !defined(MBEDTLS_SSL_PROTO_DTLS) && \
3342 !defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
Hanno Becker0defedb2018-08-10 12:35:02 +01003343 ((void) ssl);
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003344#endif
3345
Gilles Peskine449bd832023-01-11 14:50:10 +01003346 return (int) max_len;
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003347}
3348
Gilles Peskine449bd832023-01-11 14:50:10 +01003349int mbedtls_ssl_get_max_in_record_payload(const mbedtls_ssl_context *ssl)
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003350{
3351 size_t max_len = MBEDTLS_SSL_IN_CONTENT_LEN;
3352
3353#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
3354 (void) ssl;
3355#endif
3356
3357#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01003358 const size_t mfl = mbedtls_ssl_get_input_max_frag_len(ssl);
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003359
Gilles Peskine449bd832023-01-11 14:50:10 +01003360 if (max_len > mfl) {
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003361 max_len = mfl;
Gilles Peskine449bd832023-01-11 14:50:10 +01003362 }
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003363#endif
3364
Gilles Peskine449bd832023-01-11 14:50:10 +01003365 return (int) max_len;
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003366}
3367
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003368#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01003369const mbedtls_x509_crt *mbedtls_ssl_get_peer_cert(const mbedtls_ssl_context *ssl)
Paul Bakkerb0550d92012-10-30 07:51:03 +00003370{
Gilles Peskine449bd832023-01-11 14:50:10 +01003371 if (ssl == NULL || ssl->session == NULL) {
3372 return NULL;
3373 }
Paul Bakkerb0550d92012-10-30 07:51:03 +00003374
Hanno Beckere6824572019-02-07 13:18:46 +00003375#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01003376 return ssl->session->peer_cert;
Hanno Beckere6824572019-02-07 13:18:46 +00003377#else
Gilles Peskine449bd832023-01-11 14:50:10 +01003378 return NULL;
Hanno Beckere6824572019-02-07 13:18:46 +00003379#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Paul Bakkerb0550d92012-10-30 07:51:03 +00003380}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003381#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkerb0550d92012-10-30 07:51:03 +00003382
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003383#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01003384int mbedtls_ssl_get_session(const mbedtls_ssl_context *ssl,
3385 mbedtls_ssl_session *dst)
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003386{
Hanno Beckere810bbc2021-05-14 16:01:05 +01003387 int ret;
3388
Gilles Peskine449bd832023-01-11 14:50:10 +01003389 if (ssl == NULL ||
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003390 dst == NULL ||
3391 ssl->session == NULL ||
Gilles Peskine449bd832023-01-11 14:50:10 +01003392 ssl->conf->endpoint != MBEDTLS_SSL_IS_CLIENT) {
3393 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003394 }
3395
Hanno Beckere810bbc2021-05-14 16:01:05 +01003396 /* Since Mbed TLS 3.0, mbedtls_ssl_get_session() is no longer
3397 * idempotent: Each session can only be exported once.
3398 *
3399 * (This is in preparation for TLS 1.3 support where we will
3400 * need the ability to export multiple sessions (aka tickets),
3401 * which will be achieved by calling mbedtls_ssl_get_session()
3402 * multiple times until it fails.)
3403 *
3404 * Check whether we have already exported the current session,
3405 * and fail if so.
3406 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003407 if (ssl->session->exported == 1) {
3408 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
3409 }
Hanno Beckere810bbc2021-05-14 16:01:05 +01003410
Gilles Peskine449bd832023-01-11 14:50:10 +01003411 ret = mbedtls_ssl_session_copy(dst, ssl->session);
3412 if (ret != 0) {
3413 return ret;
3414 }
Hanno Beckere810bbc2021-05-14 16:01:05 +01003415
3416 /* Remember that we've exported the session. */
3417 ssl->session->exported = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01003418 return 0;
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003419}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003420#endif /* MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003421
David Horstmanncb01b362024-02-29 17:31:46 +00003422#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
3423
3424/* Serialization of TLS 1.2 sessions
David Horstmanne59f9702024-02-29 16:08:57 +00003425 *
David Horstmanncb01b362024-02-29 17:31:46 +00003426 * For more detail, see the description of ssl_session_save().
David Horstmanne59f9702024-02-29 16:08:57 +00003427 */
3428static size_t ssl_tls12_session_save(const mbedtls_ssl_session *session,
3429 unsigned char *buf,
3430 size_t buf_len)
3431{
3432 unsigned char *p = buf;
3433 size_t used = 0;
3434
3435#if defined(MBEDTLS_HAVE_TIME)
3436 uint64_t start;
3437#endif
3438#if defined(MBEDTLS_X509_CRT_PARSE_C)
3439#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
3440 size_t cert_len;
3441#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3442#endif /* MBEDTLS_X509_CRT_PARSE_C */
3443
3444 /*
3445 * Time
3446 */
3447#if defined(MBEDTLS_HAVE_TIME)
3448 used += 8;
3449
3450 if (used <= buf_len) {
3451 start = (uint64_t) session->start;
3452
3453 MBEDTLS_PUT_UINT64_BE(start, p, 0);
3454 p += 8;
3455 }
3456#endif /* MBEDTLS_HAVE_TIME */
3457
3458 /*
3459 * Basic mandatory fields
3460 */
3461 used += 1 /* id_len */
3462 + sizeof(session->id)
3463 + sizeof(session->master)
3464 + 4; /* verify_result */
3465
3466 if (used <= buf_len) {
3467 *p++ = MBEDTLS_BYTE_0(session->id_len);
3468 memcpy(p, session->id, 32);
3469 p += 32;
3470
3471 memcpy(p, session->master, 48);
3472 p += 48;
3473
3474 MBEDTLS_PUT_UINT32_BE(session->verify_result, p, 0);
3475 p += 4;
3476 }
3477
3478 /*
3479 * Peer's end-entity certificate
3480 */
3481#if defined(MBEDTLS_X509_CRT_PARSE_C)
3482#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
3483 if (session->peer_cert == NULL) {
3484 cert_len = 0;
3485 } else {
3486 cert_len = session->peer_cert->raw.len;
3487 }
3488
3489 used += 3 + cert_len;
3490
3491 if (used <= buf_len) {
3492 *p++ = MBEDTLS_BYTE_2(cert_len);
3493 *p++ = MBEDTLS_BYTE_1(cert_len);
3494 *p++ = MBEDTLS_BYTE_0(cert_len);
3495
3496 if (session->peer_cert != NULL) {
3497 memcpy(p, session->peer_cert->raw.p, cert_len);
3498 p += cert_len;
3499 }
3500 }
3501#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3502 if (session->peer_cert_digest != NULL) {
3503 used += 1 /* type */ + 1 /* length */ + session->peer_cert_digest_len;
3504 if (used <= buf_len) {
3505 *p++ = (unsigned char) session->peer_cert_digest_type;
3506 *p++ = (unsigned char) session->peer_cert_digest_len;
3507 memcpy(p, session->peer_cert_digest,
3508 session->peer_cert_digest_len);
3509 p += session->peer_cert_digest_len;
3510 }
3511 } else {
3512 used += 2;
3513 if (used <= buf_len) {
3514 *p++ = (unsigned char) MBEDTLS_MD_NONE;
3515 *p++ = 0;
3516 }
3517 }
3518#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3519#endif /* MBEDTLS_X509_CRT_PARSE_C */
3520
3521 /*
3522 * Session ticket if any, plus associated data
3523 */
3524#if defined(MBEDTLS_SSL_SESSION_TICKETS)
3525#if defined(MBEDTLS_SSL_CLI_C)
3526 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
3527 used += 3 + session->ticket_len + 4; /* len + ticket + lifetime */
3528
3529 if (used <= buf_len) {
3530 *p++ = MBEDTLS_BYTE_2(session->ticket_len);
3531 *p++ = MBEDTLS_BYTE_1(session->ticket_len);
3532 *p++ = MBEDTLS_BYTE_0(session->ticket_len);
3533
3534 if (session->ticket != NULL) {
3535 memcpy(p, session->ticket, session->ticket_len);
3536 p += session->ticket_len;
3537 }
3538
3539 MBEDTLS_PUT_UINT32_BE(session->ticket_lifetime, p, 0);
3540 p += 4;
3541 }
3542 }
3543#endif /* MBEDTLS_SSL_CLI_C */
3544#if defined(MBEDTLS_HAVE_TIME) && defined(MBEDTLS_SSL_SRV_C)
3545 if (session->endpoint == MBEDTLS_SSL_IS_SERVER) {
3546 used += 8;
3547
3548 if (used <= buf_len) {
3549 MBEDTLS_PUT_UINT64_BE((uint64_t) session->ticket_creation_time, p, 0);
3550 p += 8;
3551 }
3552 }
3553#endif /* MBEDTLS_HAVE_TIME && MBEDTLS_SSL_SRV_C */
3554#endif /* MBEDTLS_SSL_SESSION_TICKETS */
3555
3556 /*
3557 * Misc extension-related info
3558 */
3559#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
3560 used += 1;
3561
3562 if (used <= buf_len) {
3563 *p++ = session->mfl_code;
3564 }
3565#endif
3566
3567#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
3568 used += 1;
3569
3570 if (used <= buf_len) {
3571 *p++ = MBEDTLS_BYTE_0(session->encrypt_then_mac);
3572 }
3573#endif
3574
3575 return used;
3576}
3577
3578MBEDTLS_CHECK_RETURN_CRITICAL
3579static int ssl_tls12_session_load(mbedtls_ssl_session *session,
3580 const unsigned char *buf,
3581 size_t len)
3582{
3583#if defined(MBEDTLS_HAVE_TIME)
3584 uint64_t start;
3585#endif
3586#if defined(MBEDTLS_X509_CRT_PARSE_C)
3587#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
3588 size_t cert_len;
3589#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3590#endif /* MBEDTLS_X509_CRT_PARSE_C */
3591
3592 const unsigned char *p = buf;
3593 const unsigned char * const end = buf + len;
3594
3595 /*
3596 * Time
3597 */
3598#if defined(MBEDTLS_HAVE_TIME)
3599 if (8 > (size_t) (end - p)) {
3600 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3601 }
3602
3603 start = MBEDTLS_GET_UINT64_BE(p, 0);
3604 p += 8;
3605
3606 session->start = (time_t) start;
3607#endif /* MBEDTLS_HAVE_TIME */
3608
3609 /*
3610 * Basic mandatory fields
3611 */
3612 if (1 + 32 + 48 + 4 > (size_t) (end - p)) {
3613 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3614 }
3615
3616 session->id_len = *p++;
3617 memcpy(session->id, p, 32);
3618 p += 32;
3619
3620 memcpy(session->master, p, 48);
3621 p += 48;
3622
3623 session->verify_result = MBEDTLS_GET_UINT32_BE(p, 0);
3624 p += 4;
3625
3626 /* Immediately clear invalid pointer values that have been read, in case
3627 * we exit early before we replaced them with valid ones. */
3628#if defined(MBEDTLS_X509_CRT_PARSE_C)
3629#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
3630 session->peer_cert = NULL;
3631#else
3632 session->peer_cert_digest = NULL;
3633#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3634#endif /* MBEDTLS_X509_CRT_PARSE_C */
3635#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
3636 session->ticket = NULL;
3637#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
3638
3639 /*
3640 * Peer certificate
3641 */
3642#if defined(MBEDTLS_X509_CRT_PARSE_C)
3643#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
3644 /* Deserialize CRT from the end of the ticket. */
3645 if (3 > (size_t) (end - p)) {
3646 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3647 }
3648
3649 cert_len = MBEDTLS_GET_UINT24_BE(p, 0);
3650 p += 3;
3651
3652 if (cert_len != 0) {
3653 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
3654
3655 if (cert_len > (size_t) (end - p)) {
3656 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3657 }
3658
3659 session->peer_cert = mbedtls_calloc(1, sizeof(mbedtls_x509_crt));
3660
3661 if (session->peer_cert == NULL) {
3662 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
3663 }
3664
3665 mbedtls_x509_crt_init(session->peer_cert);
3666
3667 if ((ret = mbedtls_x509_crt_parse_der(session->peer_cert,
3668 p, cert_len)) != 0) {
3669 mbedtls_x509_crt_free(session->peer_cert);
3670 mbedtls_free(session->peer_cert);
3671 session->peer_cert = NULL;
3672 return ret;
3673 }
3674
3675 p += cert_len;
3676 }
3677#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3678 /* Deserialize CRT digest from the end of the ticket. */
3679 if (2 > (size_t) (end - p)) {
3680 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3681 }
3682
3683 session->peer_cert_digest_type = (mbedtls_md_type_t) *p++;
3684 session->peer_cert_digest_len = (size_t) *p++;
3685
3686 if (session->peer_cert_digest_len != 0) {
3687 const mbedtls_md_info_t *md_info =
3688 mbedtls_md_info_from_type(session->peer_cert_digest_type);
3689 if (md_info == NULL) {
3690 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3691 }
3692 if (session->peer_cert_digest_len != mbedtls_md_get_size(md_info)) {
3693 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3694 }
3695
3696 if (session->peer_cert_digest_len > (size_t) (end - p)) {
3697 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3698 }
3699
3700 session->peer_cert_digest =
3701 mbedtls_calloc(1, session->peer_cert_digest_len);
3702 if (session->peer_cert_digest == NULL) {
3703 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
3704 }
3705
3706 memcpy(session->peer_cert_digest, p,
3707 session->peer_cert_digest_len);
3708 p += session->peer_cert_digest_len;
3709 }
3710#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3711#endif /* MBEDTLS_X509_CRT_PARSE_C */
3712
3713 /*
3714 * Session ticket and associated data
3715 */
3716#if defined(MBEDTLS_SSL_SESSION_TICKETS)
3717#if defined(MBEDTLS_SSL_CLI_C)
3718 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
3719 if (3 > (size_t) (end - p)) {
3720 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3721 }
3722
3723 session->ticket_len = MBEDTLS_GET_UINT24_BE(p, 0);
3724 p += 3;
3725
3726 if (session->ticket_len != 0) {
3727 if (session->ticket_len > (size_t) (end - p)) {
3728 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3729 }
3730
3731 session->ticket = mbedtls_calloc(1, session->ticket_len);
3732 if (session->ticket == NULL) {
3733 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
3734 }
3735
3736 memcpy(session->ticket, p, session->ticket_len);
3737 p += session->ticket_len;
3738 }
3739
3740 if (4 > (size_t) (end - p)) {
3741 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3742 }
3743
3744 session->ticket_lifetime = MBEDTLS_GET_UINT32_BE(p, 0);
3745 p += 4;
3746 }
3747#endif /* MBEDTLS_SSL_CLI_C */
3748#if defined(MBEDTLS_HAVE_TIME) && defined(MBEDTLS_SSL_SRV_C)
3749 if (session->endpoint == MBEDTLS_SSL_IS_SERVER) {
3750 if (8 > (size_t) (end - p)) {
3751 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3752 }
3753 session->ticket_creation_time = MBEDTLS_GET_UINT64_BE(p, 0);
3754 p += 8;
3755 }
3756#endif /* MBEDTLS_HAVE_TIME && MBEDTLS_SSL_SRV_C */
3757#endif /* MBEDTLS_SSL_SESSION_TICKETS */
3758
3759 /*
3760 * Misc extension-related info
3761 */
3762#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
3763 if (1 > (size_t) (end - p)) {
3764 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3765 }
3766
3767 session->mfl_code = *p++;
3768#endif
3769
3770#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
3771 if (1 > (size_t) (end - p)) {
3772 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3773 }
3774
3775 session->encrypt_then_mac = *p++;
3776#endif
3777
3778 /* Done, should have consumed entire buffer */
3779 if (p != end) {
3780 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3781 }
3782
3783 return 0;
3784}
3785
3786#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
3787
3788#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
3789/* Serialization of TLS 1.3 sessions:
3790 *
David Horstmanncb01b362024-02-29 17:31:46 +00003791 * For more detail, see the description of ssl_session_save().
David Horstmanne59f9702024-02-29 16:08:57 +00003792 */
3793#if defined(MBEDTLS_SSL_SESSION_TICKETS)
3794MBEDTLS_CHECK_RETURN_CRITICAL
3795static int ssl_tls13_session_save(const mbedtls_ssl_session *session,
3796 unsigned char *buf,
3797 size_t buf_len,
3798 size_t *olen)
3799{
3800 unsigned char *p = buf;
3801#if defined(MBEDTLS_SSL_CLI_C) && \
3802 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
3803 size_t hostname_len = (session->hostname == NULL) ?
3804 0 : strlen(session->hostname) + 1;
3805#endif
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003806
3807#if defined(MBEDTLS_SSL_SRV_C) && \
3808 defined(MBEDTLS_SSL_EARLY_DATA) && defined(MBEDTLS_SSL_ALPN)
Waleed Elmelegydaa4da72024-03-13 16:25:34 +00003809 const size_t alpn_len = (session->ticket_alpn == NULL) ?
Waleed Elmelegyb28ab0a2024-03-13 16:48:28 +00003810 0 : strlen(session->ticket_alpn) + 1;
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003811#endif
David Horstmanne59f9702024-02-29 16:08:57 +00003812 size_t needed = 4 /* ticket_age_add */
3813 + 1 /* ticket_flags */
3814 + 1; /* resumption_key length */
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003815
David Horstmanne59f9702024-02-29 16:08:57 +00003816 *olen = 0;
3817
3818 if (session->resumption_key_len > MBEDTLS_SSL_TLS1_3_TICKET_RESUMPTION_KEY_LEN) {
3819 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3820 }
3821 needed += session->resumption_key_len; /* resumption_key */
3822
3823#if defined(MBEDTLS_SSL_EARLY_DATA)
3824 needed += 4; /* max_early_data_size */
3825#endif
3826#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
3827 needed += 2; /* record_size_limit */
3828#endif /* MBEDTLS_SSL_RECORD_SIZE_LIMIT */
3829
3830#if defined(MBEDTLS_HAVE_TIME)
3831 needed += 8; /* ticket_creation_time or ticket_reception_time */
3832#endif
3833
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003834#if defined(MBEDTLS_SSL_SRV_C)
3835 if (session->endpoint == MBEDTLS_SSL_IS_SERVER) {
3836#if defined(MBEDTLS_SSL_EARLY_DATA) && defined(MBEDTLS_SSL_ALPN)
Waleed Elmelegydaa4da72024-03-13 16:25:34 +00003837 needed += 2 /* alpn_len */
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003838 + alpn_len; /* alpn */
3839#endif
3840 }
3841#endif /* MBEDTLS_SSL_SRV_C */
3842
David Horstmanne59f9702024-02-29 16:08:57 +00003843#if defined(MBEDTLS_SSL_CLI_C)
3844 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
3845#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
3846 needed += 2 /* hostname_len */
3847 + hostname_len; /* hostname */
3848#endif
3849
3850 needed += 4 /* ticket_lifetime */
3851 + 2; /* ticket_len */
3852
3853 /* Check size_t overflow */
3854 if (session->ticket_len > SIZE_MAX - needed) {
3855 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3856 }
3857
3858 needed += session->ticket_len; /* ticket */
3859 }
3860#endif /* MBEDTLS_SSL_CLI_C */
3861
3862 *olen = needed;
3863 if (needed > buf_len) {
3864 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
3865 }
3866
3867 MBEDTLS_PUT_UINT32_BE(session->ticket_age_add, p, 0);
3868 p[4] = session->ticket_flags;
3869
3870 /* save resumption_key */
3871 p[5] = session->resumption_key_len;
3872 p += 6;
3873 memcpy(p, session->resumption_key, session->resumption_key_len);
3874 p += session->resumption_key_len;
3875
3876#if defined(MBEDTLS_SSL_EARLY_DATA)
3877 MBEDTLS_PUT_UINT32_BE(session->max_early_data_size, p, 0);
3878 p += 4;
3879#endif
3880#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
3881 MBEDTLS_PUT_UINT16_BE(session->record_size_limit, p, 0);
3882 p += 2;
3883#endif /* MBEDTLS_SSL_RECORD_SIZE_LIMIT */
3884
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003885#if defined(MBEDTLS_SSL_SRV_C)
David Horstmanne59f9702024-02-29 16:08:57 +00003886 if (session->endpoint == MBEDTLS_SSL_IS_SERVER) {
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003887#if defined(MBEDTLS_HAVE_TIME)
David Horstmanne59f9702024-02-29 16:08:57 +00003888 MBEDTLS_PUT_UINT64_BE((uint64_t) session->ticket_creation_time, p, 0);
3889 p += 8;
David Horstmanne59f9702024-02-29 16:08:57 +00003890#endif /* MBEDTLS_HAVE_TIME */
3891
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003892#if defined(MBEDTLS_SSL_EARLY_DATA) && defined(MBEDTLS_SSL_ALPN)
Waleed Elmelegydaa4da72024-03-13 16:25:34 +00003893 MBEDTLS_PUT_UINT16_BE(alpn_len, p, 0);
3894 p += 2;
3895
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003896 if (alpn_len > 0) {
3897 /* save chosen alpn */
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00003898 memcpy(p, session->ticket_alpn, alpn_len);
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003899 p += alpn_len;
3900 }
3901#endif /* MBEDTLS_SSL_EARLY_DATA && MBEDTLS_SSL_ALPN */
3902 }
3903#endif /* MBEDTLS_SSL_SRV_C */
3904
David Horstmanne59f9702024-02-29 16:08:57 +00003905#if defined(MBEDTLS_SSL_CLI_C)
3906 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
3907#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
3908 MBEDTLS_PUT_UINT16_BE(hostname_len, p, 0);
3909 p += 2;
3910 if (hostname_len > 0) {
3911 /* save host name */
3912 memcpy(p, session->hostname, hostname_len);
3913 p += hostname_len;
3914 }
3915#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
3916
3917#if defined(MBEDTLS_HAVE_TIME)
3918 MBEDTLS_PUT_UINT64_BE((uint64_t) session->ticket_reception_time, p, 0);
3919 p += 8;
3920#endif
3921 MBEDTLS_PUT_UINT32_BE(session->ticket_lifetime, p, 0);
3922 p += 4;
3923
3924 MBEDTLS_PUT_UINT16_BE(session->ticket_len, p, 0);
3925 p += 2;
3926
3927 if (session->ticket != NULL && session->ticket_len > 0) {
3928 memcpy(p, session->ticket, session->ticket_len);
3929 p += session->ticket_len;
3930 }
3931 }
3932#endif /* MBEDTLS_SSL_CLI_C */
3933 return 0;
3934}
3935
3936MBEDTLS_CHECK_RETURN_CRITICAL
3937static int ssl_tls13_session_load(mbedtls_ssl_session *session,
3938 const unsigned char *buf,
3939 size_t len)
3940{
3941 const unsigned char *p = buf;
3942 const unsigned char *end = buf + len;
3943
3944 if (end - p < 6) {
3945 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3946 }
3947 session->ticket_age_add = MBEDTLS_GET_UINT32_BE(p, 0);
3948 session->ticket_flags = p[4];
3949
3950 /* load resumption_key */
3951 session->resumption_key_len = p[5];
3952 p += 6;
3953
3954 if (end - p < session->resumption_key_len) {
3955 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3956 }
3957
3958 if (sizeof(session->resumption_key) < session->resumption_key_len) {
3959 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3960 }
3961 memcpy(session->resumption_key, p, session->resumption_key_len);
3962 p += session->resumption_key_len;
3963
3964#if defined(MBEDTLS_SSL_EARLY_DATA)
3965 if (end - p < 4) {
3966 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3967 }
3968 session->max_early_data_size = MBEDTLS_GET_UINT32_BE(p, 0);
3969 p += 4;
3970#endif
3971#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
3972 if (end - p < 2) {
3973 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3974 }
3975 session->record_size_limit = MBEDTLS_GET_UINT16_BE(p, 0);
3976 p += 2;
3977#endif /* MBEDTLS_SSL_RECORD_SIZE_LIMIT */
3978
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003979#if defined(MBEDTLS_SSL_SRV_C)
David Horstmanne59f9702024-02-29 16:08:57 +00003980 if (session->endpoint == MBEDTLS_SSL_IS_SERVER) {
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003981#if defined(MBEDTLS_HAVE_TIME)
David Horstmanne59f9702024-02-29 16:08:57 +00003982 if (end - p < 8) {
3983 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3984 }
3985 session->ticket_creation_time = MBEDTLS_GET_UINT64_BE(p, 0);
3986 p += 8;
David Horstmanne59f9702024-02-29 16:08:57 +00003987#endif /* MBEDTLS_HAVE_TIME */
3988
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003989#if defined(MBEDTLS_SSL_EARLY_DATA) && defined(MBEDTLS_SSL_ALPN)
Waleed Elmelegydaa4da72024-03-13 16:25:34 +00003990 size_t alpn_len;
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003991
Waleed Elmelegydaa4da72024-03-13 16:25:34 +00003992 if (end - p < 2) {
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003993 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3994 }
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00003995
Waleed Elmelegydaa4da72024-03-13 16:25:34 +00003996 alpn_len = MBEDTLS_GET_UINT16_BE(p, 0);
3997 p += 2;
3998
3999 if (end - p < (long int) alpn_len) {
Waleed Elmelegy7dfba342024-03-12 16:22:39 +00004000 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4001 }
4002
Waleed Elmelegy2824a202024-02-23 17:51:47 +00004003 if (alpn_len > 0) {
Waleed Elmelegydaa4da72024-03-13 16:25:34 +00004004 int ret = mbedtls_ssl_session_set_ticket_alpn(session, (char *) p);
4005 if (ret != 0) {
4006 return ret;
Waleed Elmelegy2824a202024-02-23 17:51:47 +00004007 }
Waleed Elmelegy2824a202024-02-23 17:51:47 +00004008 p += alpn_len;
4009 }
4010#endif /* MBEDTLS_SSL_EARLY_DATA && MBEDTLS_SSL_ALPN */
4011 }
4012#endif /* MBEDTLS_SSL_SRV_C */
4013
David Horstmanne59f9702024-02-29 16:08:57 +00004014#if defined(MBEDTLS_SSL_CLI_C)
4015 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
4016#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
4017 size_t hostname_len;
4018 /* load host name */
4019 if (end - p < 2) {
4020 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4021 }
4022 hostname_len = MBEDTLS_GET_UINT16_BE(p, 0);
4023 p += 2;
4024
4025 if (end - p < (long int) hostname_len) {
4026 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4027 }
4028 if (hostname_len > 0) {
4029 session->hostname = mbedtls_calloc(1, hostname_len);
4030 if (session->hostname == NULL) {
4031 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
4032 }
4033 memcpy(session->hostname, p, hostname_len);
4034 p += hostname_len;
4035 }
4036#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
4037
4038#if defined(MBEDTLS_HAVE_TIME)
4039 if (end - p < 8) {
4040 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4041 }
4042 session->ticket_reception_time = MBEDTLS_GET_UINT64_BE(p, 0);
4043 p += 8;
4044#endif
4045 if (end - p < 4) {
4046 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4047 }
4048 session->ticket_lifetime = MBEDTLS_GET_UINT32_BE(p, 0);
4049 p += 4;
4050
4051 if (end - p < 2) {
4052 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4053 }
4054 session->ticket_len = MBEDTLS_GET_UINT16_BE(p, 0);
4055 p += 2;
4056
4057 if (end - p < (long int) session->ticket_len) {
4058 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4059 }
4060 if (session->ticket_len > 0) {
4061 session->ticket = mbedtls_calloc(1, session->ticket_len);
4062 if (session->ticket == NULL) {
4063 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
4064 }
4065 memcpy(session->ticket, p, session->ticket_len);
4066 p += session->ticket_len;
4067 }
4068 }
4069#endif /* MBEDTLS_SSL_CLI_C */
4070
4071 return 0;
4072
4073}
4074#else /* MBEDTLS_SSL_SESSION_TICKETS */
4075MBEDTLS_CHECK_RETURN_CRITICAL
4076static int ssl_tls13_session_save(const mbedtls_ssl_session *session,
4077 unsigned char *buf,
4078 size_t buf_len,
4079 size_t *olen)
4080{
4081 ((void) session);
4082 ((void) buf);
4083 ((void) buf_len);
4084 *olen = 0;
4085 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
4086}
4087
4088static int ssl_tls13_session_load(const mbedtls_ssl_session *session,
Norbert Fabritius93b2c322023-01-24 17:48:29 +01004089 const unsigned char *buf,
David Horstmanne59f9702024-02-29 16:08:57 +00004090 size_t buf_len)
4091{
4092 ((void) session);
4093 ((void) buf);
4094 ((void) buf_len);
4095 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
4096}
4097#endif /* !MBEDTLS_SSL_SESSION_TICKETS */
4098#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
4099
Paul Bakker5121ce52009-01-03 21:22:43 +00004100/*
Hanno Beckera835da52019-05-16 12:39:07 +01004101 * Define ticket header determining Mbed TLS version
4102 * and structure of the ticket.
4103 */
4104
Hanno Becker94ef3b32019-05-16 12:50:45 +01004105/*
Hanno Becker50b59662019-05-28 14:30:45 +01004106 * Define bitflag determining compile-time settings influencing
4107 * structure of serialized SSL sessions.
Hanno Becker94ef3b32019-05-16 12:50:45 +01004108 */
4109
Hanno Becker50b59662019-05-28 14:30:45 +01004110#if defined(MBEDTLS_HAVE_TIME)
Hanno Becker3e088662019-05-29 11:10:18 +01004111#define SSL_SERIALIZED_SESSION_CONFIG_TIME 1
Hanno Becker50b59662019-05-28 14:30:45 +01004112#else
Hanno Becker3e088662019-05-29 11:10:18 +01004113#define SSL_SERIALIZED_SESSION_CONFIG_TIME 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01004114#endif /* MBEDTLS_HAVE_TIME */
4115
4116#if defined(MBEDTLS_X509_CRT_PARSE_C)
Hanno Becker3e088662019-05-29 11:10:18 +01004117#define SSL_SERIALIZED_SESSION_CONFIG_CRT 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01004118#else
Hanno Becker3e088662019-05-29 11:10:18 +01004119#define SSL_SERIALIZED_SESSION_CONFIG_CRT 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01004120#endif /* MBEDTLS_X509_CRT_PARSE_C */
4121
David Horstmann5c5a32f2024-02-13 17:53:35 +00004122#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
David Horstmannf686f1d2024-03-01 11:20:32 +00004123#define SSL_SERIALIZED_SESSION_CONFIG_KEEP_PEER_CRT 1
David Horstmann5c5a32f2024-02-13 17:53:35 +00004124#else
David Horstmannf686f1d2024-03-01 11:20:32 +00004125#define SSL_SERIALIZED_SESSION_CONFIG_KEEP_PEER_CRT 0
David Horstmann5c5a32f2024-02-13 17:53:35 +00004126#endif /* MBEDTLS_SSL_SESSION_TICKETS */
4127
Hanno Becker94ef3b32019-05-16 12:50:45 +01004128#if defined(MBEDTLS_SSL_CLI_C) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Hanno Becker3e088662019-05-29 11:10:18 +01004129#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01004130#else
Hanno Becker3e088662019-05-29 11:10:18 +01004131#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01004132#endif /* MBEDTLS_SSL_CLI_C && MBEDTLS_SSL_SESSION_TICKETS */
4133
4134#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Hanno Becker3e088662019-05-29 11:10:18 +01004135#define SSL_SERIALIZED_SESSION_CONFIG_MFL 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01004136#else
Hanno Becker3e088662019-05-29 11:10:18 +01004137#define SSL_SERIALIZED_SESSION_CONFIG_MFL 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01004138#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
4139
Hanno Becker94ef3b32019-05-16 12:50:45 +01004140#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Hanno Becker3e088662019-05-29 11:10:18 +01004141#define SSL_SERIALIZED_SESSION_CONFIG_ETM 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01004142#else
Hanno Becker3e088662019-05-29 11:10:18 +01004143#define SSL_SERIALIZED_SESSION_CONFIG_ETM 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01004144#endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC */
4145
Hanno Becker94ef3b32019-05-16 12:50:45 +01004146#if defined(MBEDTLS_SSL_SESSION_TICKETS)
4147#define SSL_SERIALIZED_SESSION_CONFIG_TICKET 1
4148#else
4149#define SSL_SERIALIZED_SESSION_CONFIG_TICKET 0
4150#endif /* MBEDTLS_SSL_SESSION_TICKETS */
4151
David Horstmann92b258b2024-02-13 17:23:34 +00004152#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
4153#define SSL_SERIALIZED_SESSION_CONFIG_SNI 1
4154#else
4155#define SSL_SERIALIZED_SESSION_CONFIG_SNI 0
4156#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
4157
4158#if defined(MBEDTLS_SSL_EARLY_DATA)
4159#define SSL_SERIALIZED_SESSION_CONFIG_EARLY_DATA 1
4160#else
4161#define SSL_SERIALIZED_SESSION_CONFIG_EARLY_DATA 0
4162#endif /* MBEDTLS_SSL_EARLY_DATA */
4163
4164#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
4165#define SSL_SERIALIZED_SESSION_CONFIG_RECORD_SIZE 1
4166#else
4167#define SSL_SERIALIZED_SESSION_CONFIG_RECORD_SIZE 0
4168#endif /* MBEDTLS_SSL_RECORD_SIZE_LIMIT */
4169
Waleed Elmelegy7dfba342024-03-12 16:22:39 +00004170#if defined(MBEDTLS_SSL_ALPN) && defined(MBEDTLS_SSL_SRV_C) && \
4171 defined(MBEDTLS_SSL_EARLY_DATA)
Waleed Elmelegy11025632024-03-07 15:25:52 +00004172#define SSL_SERIALIZED_SESSION_CONFIG_ALPN 1
4173#else
4174#define SSL_SERIALIZED_SESSION_CONFIG_ALPN 0
4175#endif /* MBEDTLS_SSL_ALPN */
4176
Hanno Becker3e088662019-05-29 11:10:18 +01004177#define SSL_SERIALIZED_SESSION_CONFIG_TIME_BIT 0
4178#define SSL_SERIALIZED_SESSION_CONFIG_CRT_BIT 1
4179#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET_BIT 2
4180#define SSL_SERIALIZED_SESSION_CONFIG_MFL_BIT 3
Hanno Becker37bdbe62021-08-01 05:38:58 +01004181#define SSL_SERIALIZED_SESSION_CONFIG_ETM_BIT 4
4182#define SSL_SERIALIZED_SESSION_CONFIG_TICKET_BIT 5
David Horstmannf686f1d2024-03-01 11:20:32 +00004183#define SSL_SERIALIZED_SESSION_CONFIG_KEEP_PEER_CRT_BIT 6
David Horstmann92b258b2024-02-13 17:23:34 +00004184#define SSL_SERIALIZED_SESSION_CONFIG_SNI_BIT 7
4185#define SSL_SERIALIZED_SESSION_CONFIG_EARLY_DATA_BIT 8
4186#define SSL_SERIALIZED_SESSION_CONFIG_RECORD_SIZE_BIT 9
Waleed Elmelegy11025632024-03-07 15:25:52 +00004187#define SSL_SERIALIZED_SESSION_CONFIG_ALPN_BIT 10
Hanno Becker3e088662019-05-29 11:10:18 +01004188
Hanno Becker50b59662019-05-28 14:30:45 +01004189#define SSL_SERIALIZED_SESSION_CONFIG_BITFLAG \
Gilles Peskine449bd832023-01-11 14:50:10 +01004190 ((uint16_t) ( \
4191 (SSL_SERIALIZED_SESSION_CONFIG_TIME << SSL_SERIALIZED_SESSION_CONFIG_TIME_BIT) | \
4192 (SSL_SERIALIZED_SESSION_CONFIG_CRT << SSL_SERIALIZED_SESSION_CONFIG_CRT_BIT) | \
4193 (SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET << \
4194 SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET_BIT) | \
4195 (SSL_SERIALIZED_SESSION_CONFIG_MFL << SSL_SERIALIZED_SESSION_CONFIG_MFL_BIT) | \
4196 (SSL_SERIALIZED_SESSION_CONFIG_ETM << SSL_SERIALIZED_SESSION_CONFIG_ETM_BIT) | \
David Horstmann5c5a32f2024-02-13 17:53:35 +00004197 (SSL_SERIALIZED_SESSION_CONFIG_TICKET << SSL_SERIALIZED_SESSION_CONFIG_TICKET_BIT) | \
David Horstmann71fa1a92024-03-01 12:32:18 +00004198 (SSL_SERIALIZED_SESSION_CONFIG_KEEP_PEER_CRT << \
4199 SSL_SERIALIZED_SESSION_CONFIG_KEEP_PEER_CRT_BIT) | \
David Horstmann92b258b2024-02-13 17:23:34 +00004200 (SSL_SERIALIZED_SESSION_CONFIG_SNI << SSL_SERIALIZED_SESSION_CONFIG_SNI_BIT) | \
4201 (SSL_SERIALIZED_SESSION_CONFIG_EARLY_DATA << \
4202 SSL_SERIALIZED_SESSION_CONFIG_EARLY_DATA_BIT) | \
4203 (SSL_SERIALIZED_SESSION_CONFIG_RECORD_SIZE << \
Waleed Elmelegy11025632024-03-07 15:25:52 +00004204 SSL_SERIALIZED_SESSION_CONFIG_RECORD_SIZE_BIT) | \
Waleed Elmelegy75e33fa2024-03-07 16:57:58 +00004205 (SSL_SERIALIZED_SESSION_CONFIG_ALPN << \
Waleed Elmelegy11025632024-03-07 15:25:52 +00004206 SSL_SERIALIZED_SESSION_CONFIG_ALPN_BIT)))
Hanno Becker94ef3b32019-05-16 12:50:45 +01004207
Chien Wong4e9683e2023-12-28 17:07:43 +08004208static const unsigned char ssl_serialized_session_header[] = {
Hanno Becker94ef3b32019-05-16 12:50:45 +01004209 MBEDTLS_VERSION_MAJOR,
4210 MBEDTLS_VERSION_MINOR,
4211 MBEDTLS_VERSION_PATCH,
Gilles Peskine449bd832023-01-11 14:50:10 +01004212 MBEDTLS_BYTE_1(SSL_SERIALIZED_SESSION_CONFIG_BITFLAG),
4213 MBEDTLS_BYTE_0(SSL_SERIALIZED_SESSION_CONFIG_BITFLAG),
Hanno Beckerf8787072019-05-16 12:41:07 +01004214};
Hanno Beckera835da52019-05-16 12:39:07 +01004215
4216/*
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004217 * Serialize a session in the following format:
Manuel Pégourié-Gonnard35eb8022019-05-16 11:11:08 +02004218 * (in the presentation language of TLS, RFC 8446 section 3)
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004219 *
David Horstmanncb01b362024-02-29 17:31:46 +00004220 * TLS 1.2 session:
4221 *
4222 * struct {
4223 * #if defined(MBEDTLS_SSL_SESSION_TICKETS)
4224 * opaque ticket<0..2^24-1>; // length 0 means no ticket
4225 * uint32 ticket_lifetime;
4226 * #endif
4227 * } ClientOnlyData;
4228 *
4229 * struct {
4230 * #if defined(MBEDTLS_HAVE_TIME)
4231 * uint64 start_time;
4232 * #endif
4233 * uint8 session_id_len; // at most 32
4234 * opaque session_id[32];
4235 * opaque master[48]; // fixed length in the standard
4236 * uint32 verify_result;
4237 * #if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
4238 * opaque peer_cert<0..2^24-1>; // length 0 means no peer cert
4239 * #else
David Horstmann76ba26a2024-03-01 12:03:35 +00004240 * uint8 peer_cert_digest_type;
David Horstmanncb01b362024-02-29 17:31:46 +00004241 * opaque peer_cert_digest<0..2^8-1>
4242 * #endif
4243 * select (endpoint) {
4244 * case client: ClientOnlyData;
4245 * case server: uint64 ticket_creation_time;
4246 * };
4247 * #if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
4248 * uint8 mfl_code; // up to 255 according to standard
4249 * #endif
4250 * #if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
4251 * uint8 encrypt_then_mac; // 0 or 1
4252 * #endif
4253 * } serialized_session_tls12;
4254 *
4255 *
4256 * TLS 1.3 Session:
4257 *
4258 * struct {
4259 * #if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
4260 * opaque hostname<0..2^16-1>;
4261 * #endif
4262 * #if defined(MBEDTLS_HAVE_TIME)
4263 * uint64 ticket_reception_time;
4264 * #endif
4265 * uint32 ticket_lifetime;
4266 * opaque ticket<1..2^16-1>;
4267 * } ClientOnlyData;
4268 *
4269 * struct {
4270 * uint32 ticket_age_add;
4271 * uint8 ticket_flags;
4272 * opaque resumption_key<0..255>;
4273 * #if defined(MBEDTLS_SSL_EARLY_DATA)
4274 * uint32 max_early_data_size;
4275 * #endif
4276 * #if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
4277 * uint16 record_size_limit;
4278 * #endif
4279 * select ( endpoint ) {
4280 * case client: ClientOnlyData;
Waleed Elmelegy7dfba342024-03-12 16:22:39 +00004281 * case server:
David Horstmanncb01b362024-02-29 17:31:46 +00004282 * #if defined(MBEDTLS_HAVE_TIME)
Waleed Elmelegy7dfba342024-03-12 16:22:39 +00004283 * uint64 ticket_creation_time;
David Horstmanncb01b362024-02-29 17:31:46 +00004284 * #endif
Waleed Elmelegyfe9ae082024-03-07 15:47:31 +00004285 * #if defined(MBEDTLS_SSL_EARLY_DATA) && defined(MBEDTLS_SSL_ALPN)
Waleed Elmelegydaa4da72024-03-13 16:25:34 +00004286 * opaque ticket_alpn<0..256>;
David Horstmanncb01b362024-02-29 17:31:46 +00004287 * #endif
4288 * };
4289 * } serialized_session_tls13;
4290 *
4291 *
4292 * SSL session:
4293 *
4294 * struct {
Hanno Beckerdc28b6c2019-05-29 11:08:00 +01004295 *
Hanno Beckerdce50972021-08-01 05:39:23 +01004296 * opaque mbedtls_version[3]; // library version: major, minor, patch
4297 * opaque session_format[2]; // library-version specific 16-bit field
4298 * // determining the format of the remaining
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004299 * // serialized data.
Hanno Beckerdc28b6c2019-05-29 11:08:00 +01004300 *
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004301 * Note: When updating the format, remember to keep
4302 * these version+format bytes.
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004303 *
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004304 * // In this version, `session_format` determines
4305 * // the setting of those compile-time
4306 * // configuration options which influence
4307 * // the structure of mbedtls_ssl_session.
4308 *
Glenn Straussda7851c2022-03-14 13:29:48 -04004309 * uint8_t minor_ver; // Protocol minor version. Possible values:
Jerry Yu0c2a7382022-12-06 13:27:25 +08004310 * // - TLS 1.2 (0x0303)
4311 * // - TLS 1.3 (0x0304)
David Horstmann531aca22024-02-29 18:14:28 +00004312 * uint8_t endpoint;
4313 * uint16_t ciphersuite;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004314 *
Glenn Straussda7851c2022-03-14 13:29:48 -04004315 * select (serialized_session.tls_version) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004316 *
Glenn Straussda7851c2022-03-14 13:29:48 -04004317 * case MBEDTLS_SSL_VERSION_TLS1_2:
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004318 * serialized_session_tls12 data;
Jerry Yu0c2a7382022-12-06 13:27:25 +08004319 * case MBEDTLS_SSL_VERSION_TLS1_3:
Jerry Yuddda0502022-12-01 19:43:12 +08004320 * serialized_session_tls13 data;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004321 *
4322 * };
4323 *
4324 * } serialized_session;
4325 *
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004326 */
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004327
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004328MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004329static int ssl_session_save(const mbedtls_ssl_session *session,
4330 unsigned char omit_header,
4331 unsigned char *buf,
4332 size_t buf_len,
4333 size_t *olen)
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004334{
4335 unsigned char *p = buf;
4336 size_t used = 0;
Jerry Yu251a12e2022-07-13 15:15:48 +08004337 size_t remaining_len;
Jerry Yue36fdd62022-08-17 21:31:36 +08004338#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
4339 size_t out_len;
4340 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
4341#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01004342 if (session == NULL) {
4343 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
4344 }
Jerry Yu438ddd82022-07-07 06:55:50 +00004345
Gilles Peskine449bd832023-01-11 14:50:10 +01004346 if (!omit_header) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004347 /*
4348 * Add Mbed TLS version identifier
4349 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004350 used += sizeof(ssl_serialized_session_header);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004351
Gilles Peskine449bd832023-01-11 14:50:10 +01004352 if (used <= buf_len) {
4353 memcpy(p, ssl_serialized_session_header,
4354 sizeof(ssl_serialized_session_header));
4355 p += sizeof(ssl_serialized_session_header);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004356 }
4357 }
4358
4359 /*
Ronald Cron40a4ab02024-01-15 10:21:30 +01004360 * TLS version identifier, endpoint, ciphersuite
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004361 */
Ronald Cron40a4ab02024-01-15 10:21:30 +01004362 used += 1 /* TLS version */
4363 + 1 /* endpoint */
4364 + 2; /* ciphersuite */
Gilles Peskine449bd832023-01-11 14:50:10 +01004365 if (used <= buf_len) {
4366 *p++ = MBEDTLS_BYTE_0(session->tls_version);
Ronald Cron40a4ab02024-01-15 10:21:30 +01004367 *p++ = session->endpoint;
4368 MBEDTLS_PUT_UINT16_BE(session->ciphersuite, p, 0);
4369 p += 2;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004370 }
4371
4372 /* Forward to version-specific serialization routine. */
Jerry Yufca4d572022-07-21 10:37:48 +08004373 remaining_len = (buf_len >= used) ? buf_len - used : 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01004374 switch (session->tls_version) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004375#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01004376 case MBEDTLS_SSL_VERSION_TLS1_2:
4377 used += ssl_tls12_session_save(session, p, remaining_len);
4378 break;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004379#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
4380
Jerry Yu251a12e2022-07-13 15:15:48 +08004381#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004382 case MBEDTLS_SSL_VERSION_TLS1_3:
4383 ret = ssl_tls13_session_save(session, p, remaining_len, &out_len);
4384 if (ret != 0 && ret != MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL) {
4385 return ret;
4386 }
4387 used += out_len;
4388 break;
Jerry Yu251a12e2022-07-13 15:15:48 +08004389#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
4390
Gilles Peskine449bd832023-01-11 14:50:10 +01004391 default:
4392 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004393 }
4394
4395 *olen = used;
Gilles Peskine449bd832023-01-11 14:50:10 +01004396 if (used > buf_len) {
4397 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
4398 }
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004399
Gilles Peskine449bd832023-01-11 14:50:10 +01004400 return 0;
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004401}
4402
4403/*
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02004404 * Public wrapper for ssl_session_save()
4405 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004406int mbedtls_ssl_session_save(const mbedtls_ssl_session *session,
4407 unsigned char *buf,
4408 size_t buf_len,
4409 size_t *olen)
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02004410{
Gilles Peskine449bd832023-01-11 14:50:10 +01004411 return ssl_session_save(session, 0, buf, buf_len, olen);
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02004412}
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004413
Jerry Yuf1b23ca2022-02-18 11:48:47 +08004414/*
4415 * Deserialize session, see mbedtls_ssl_session_save() for format.
4416 *
4417 * This internal version is wrapped by a public function that cleans up in
4418 * case of error, and has an extra option omit_header.
4419 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004420MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004421static int ssl_session_load(mbedtls_ssl_session *session,
4422 unsigned char omit_header,
4423 const unsigned char *buf,
4424 size_t len)
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004425{
4426 const unsigned char *p = buf;
4427 const unsigned char * const end = buf + len;
Jerry Yu438ddd82022-07-07 06:55:50 +00004428 size_t remaining_len;
4429
4430
Gilles Peskine449bd832023-01-11 14:50:10 +01004431 if (session == NULL) {
4432 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
4433 }
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004434
Gilles Peskine449bd832023-01-11 14:50:10 +01004435 if (!omit_header) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004436 /*
4437 * Check Mbed TLS version identifier
4438 */
4439
Gilles Peskine449bd832023-01-11 14:50:10 +01004440 if ((size_t) (end - p) < sizeof(ssl_serialized_session_header)) {
4441 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004442 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004443
4444 if (memcmp(p, ssl_serialized_session_header,
4445 sizeof(ssl_serialized_session_header)) != 0) {
4446 return MBEDTLS_ERR_SSL_VERSION_MISMATCH;
4447 }
4448 p += sizeof(ssl_serialized_session_header);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004449 }
4450
4451 /*
Ronald Cron40a4ab02024-01-15 10:21:30 +01004452 * TLS version identifier, endpoint, ciphersuite
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004453 */
Ronald Cron40a4ab02024-01-15 10:21:30 +01004454 if (4 > (size_t) (end - p)) {
Gilles Peskine449bd832023-01-11 14:50:10 +01004455 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4456 }
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01004457 session->tls_version = (mbedtls_ssl_protocol_version) (0x0300 | *p++);
Ronald Cron40a4ab02024-01-15 10:21:30 +01004458 session->endpoint = *p++;
4459 session->ciphersuite = MBEDTLS_GET_UINT16_BE(p, 0);
4460 p += 2;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004461
4462 /* Dispatch according to TLS version. */
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00004463 remaining_len = (size_t) (end - p);
Gilles Peskine449bd832023-01-11 14:50:10 +01004464 switch (session->tls_version) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004465#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01004466 case MBEDTLS_SSL_VERSION_TLS1_2:
4467 return ssl_tls12_session_load(session, p, remaining_len);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004468#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
4469
Jerry Yu438ddd82022-07-07 06:55:50 +00004470#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004471 case MBEDTLS_SSL_VERSION_TLS1_3:
4472 return ssl_tls13_session_load(session, p, remaining_len);
Jerry Yu438ddd82022-07-07 06:55:50 +00004473#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
4474
Gilles Peskine449bd832023-01-11 14:50:10 +01004475 default:
4476 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004477 }
4478}
4479
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004480/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02004481 * Deserialize session: public wrapper for error cleaning
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02004482 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004483int mbedtls_ssl_session_load(mbedtls_ssl_session *session,
4484 const unsigned char *buf,
4485 size_t len)
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02004486{
Gilles Peskine449bd832023-01-11 14:50:10 +01004487 int ret = ssl_session_load(session, 0, buf, len);
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02004488
Gilles Peskine449bd832023-01-11 14:50:10 +01004489 if (ret != 0) {
4490 mbedtls_ssl_session_free(session);
4491 }
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02004492
Gilles Peskine449bd832023-01-11 14:50:10 +01004493 return ret;
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02004494}
4495
4496/*
Paul Bakker1961b702013-01-25 14:49:24 +01004497 * Perform a single step of the SSL handshake
Paul Bakker5121ce52009-01-03 21:22:43 +00004498 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004499MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004500static int ssl_prepare_handshake_step(mbedtls_ssl_context *ssl)
Hanno Becker41934dd2021-08-07 19:13:43 +01004501{
4502 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
4503
Ronald Cron66dbf912022-02-02 15:33:46 +01004504 /*
4505 * We may have not been able to send to the peer all the handshake data
Ronald Cron3f20b772022-03-08 16:00:02 +01004506 * that were written into the output buffer by the previous handshake step,
4507 * if the write to the network callback returned with the
Ronald Cron66dbf912022-02-02 15:33:46 +01004508 * #MBEDTLS_ERR_SSL_WANT_WRITE error code.
4509 * We proceed to the next handshake step only when all data from the
4510 * previous one have been sent to the peer, thus we make sure that this is
4511 * the case here by calling `mbedtls_ssl_flush_output()`. The function may
4512 * return with the #MBEDTLS_ERR_SSL_WANT_WRITE error code in which case
4513 * we have to wait before to go ahead.
4514 * In the case of TLS 1.3, handshake step handlers do not send data to the
4515 * peer. Data are only sent here and through
4516 * `mbedtls_ssl_handle_pending_alert` in case an error that triggered an
Andrzej Kurek5c65c572022-04-13 14:28:52 -04004517 * alert occurred.
Ronald Cron66dbf912022-02-02 15:33:46 +01004518 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004519 if ((ret = mbedtls_ssl_flush_output(ssl)) != 0) {
4520 return ret;
4521 }
Hanno Becker41934dd2021-08-07 19:13:43 +01004522
4523#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004524 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
4525 ssl->handshake->retransmit_state == MBEDTLS_SSL_RETRANS_SENDING) {
4526 if ((ret = mbedtls_ssl_flight_transmit(ssl)) != 0) {
4527 return ret;
4528 }
Hanno Becker41934dd2021-08-07 19:13:43 +01004529 }
4530#endif /* MBEDTLS_SSL_PROTO_DTLS */
4531
Gilles Peskine449bd832023-01-11 14:50:10 +01004532 return ret;
Hanno Becker41934dd2021-08-07 19:13:43 +01004533}
4534
Gilles Peskine449bd832023-01-11 14:50:10 +01004535int mbedtls_ssl_handshake_step(mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00004536{
Hanno Becker41934dd2021-08-07 19:13:43 +01004537 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00004538
Gilles Peskine449bd832023-01-11 14:50:10 +01004539 if (ssl == NULL ||
Hanno Becker41934dd2021-08-07 19:13:43 +01004540 ssl->conf == NULL ||
4541 ssl->handshake == NULL ||
Gilles Peskine449bd832023-01-11 14:50:10 +01004542 ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER) {
4543 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Becker41934dd2021-08-07 19:13:43 +01004544 }
4545
Gilles Peskine449bd832023-01-11 14:50:10 +01004546 ret = ssl_prepare_handshake_step(ssl);
4547 if (ret != 0) {
4548 return ret;
4549 }
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02004550
Gilles Peskine449bd832023-01-11 14:50:10 +01004551 ret = mbedtls_ssl_handle_pending_alert(ssl);
4552 if (ret != 0) {
Jerry Yue7047812021-09-13 19:26:39 +08004553 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01004554 }
Jerry Yue7047812021-09-13 19:26:39 +08004555
Tom Cosgrove2fdc7b32022-09-21 12:33:17 +01004556 /* If ssl->conf->endpoint is not one of MBEDTLS_SSL_IS_CLIENT or
4557 * MBEDTLS_SSL_IS_SERVER, this is the return code we give */
4558 ret = MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4559
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004560#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004561 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
4562 MBEDTLS_SSL_DEBUG_MSG(2, ("client state: %s",
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01004563 mbedtls_ssl_states_str((mbedtls_ssl_states) ssl->state)));
Jerry Yub9930e72021-08-06 17:11:51 +08004564
Gilles Peskine449bd832023-01-11 14:50:10 +01004565 switch (ssl->state) {
Ronald Cron9f0fba32022-02-10 16:45:15 +01004566 case MBEDTLS_SSL_HELLO_REQUEST:
4567 ssl->state = MBEDTLS_SSL_CLIENT_HELLO;
Tom Cosgrove87d9c6c2022-09-22 09:27:56 +01004568 ret = 0;
Ronald Cron9f0fba32022-02-10 16:45:15 +01004569 break;
Jerry Yub9930e72021-08-06 17:11:51 +08004570
Ronald Cron9f0fba32022-02-10 16:45:15 +01004571 case MBEDTLS_SSL_CLIENT_HELLO:
Gilles Peskine449bd832023-01-11 14:50:10 +01004572 ret = mbedtls_ssl_write_client_hello(ssl);
Ronald Cron9f0fba32022-02-10 16:45:15 +01004573 break;
4574
4575 default:
4576#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004577 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
4578 ret = mbedtls_ssl_tls13_handshake_client_step(ssl);
4579 } else {
4580 ret = mbedtls_ssl_handshake_client_step(ssl);
4581 }
Ronald Cron9f0fba32022-02-10 16:45:15 +01004582#elif defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01004583 ret = mbedtls_ssl_handshake_client_step(ssl);
Ronald Cron9f0fba32022-02-10 16:45:15 +01004584#else
Gilles Peskine449bd832023-01-11 14:50:10 +01004585 ret = mbedtls_ssl_tls13_handshake_client_step(ssl);
Ronald Cron9f0fba32022-02-10 16:45:15 +01004586#endif
4587 }
Jerry Yub9930e72021-08-06 17:11:51 +08004588 }
Ronald Cron6291b232023-03-08 15:51:25 +01004589#endif /* MBEDTLS_SSL_CLI_C */
4590
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004591#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004592 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Ronald Cron6291b232023-03-08 15:51:25 +01004593#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
4594 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Gilles Peskine449bd832023-01-11 14:50:10 +01004595 ret = mbedtls_ssl_tls13_handshake_server_step(ssl);
Ronald Cron6291b232023-03-08 15:51:25 +01004596 } else {
Gilles Peskine449bd832023-01-11 14:50:10 +01004597 ret = mbedtls_ssl_handshake_server_step(ssl);
4598 }
Ronald Cron6291b232023-03-08 15:51:25 +01004599#elif defined(MBEDTLS_SSL_PROTO_TLS1_2)
4600 ret = mbedtls_ssl_handshake_server_step(ssl);
4601#else
4602 ret = mbedtls_ssl_tls13_handshake_server_step(ssl);
Paul Bakker5121ce52009-01-03 21:22:43 +00004603#endif
Ronald Cron6291b232023-03-08 15:51:25 +01004604 }
4605#endif /* MBEDTLS_SSL_SRV_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00004606
Gilles Peskine449bd832023-01-11 14:50:10 +01004607 if (ret != 0) {
Jerry Yubbd5a3f2021-09-18 20:50:22 +08004608 /* handshake_step return error. And it is same
4609 * with alert_reason.
4610 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004611 if (ssl->send_alert) {
4612 ret = mbedtls_ssl_handle_pending_alert(ssl);
Jerry Yue7047812021-09-13 19:26:39 +08004613 goto cleanup;
4614 }
4615 }
4616
4617cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +01004618 return ret;
Paul Bakker1961b702013-01-25 14:49:24 +01004619}
4620
4621/*
4622 * Perform the SSL handshake
4623 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004624int mbedtls_ssl_handshake(mbedtls_ssl_context *ssl)
Paul Bakker1961b702013-01-25 14:49:24 +01004625{
4626 int ret = 0;
4627
Hanno Beckera817ea42020-10-20 15:20:23 +01004628 /* Sanity checks */
4629
Gilles Peskine449bd832023-01-11 14:50:10 +01004630 if (ssl == NULL || ssl->conf == NULL) {
4631 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4632 }
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02004633
Hanno Beckera817ea42020-10-20 15:20:23 +01004634#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004635 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
4636 (ssl->f_set_timer == NULL || ssl->f_get_timer == NULL)) {
4637 MBEDTLS_SSL_DEBUG_MSG(1, ("You must use "
4638 "mbedtls_ssl_set_timer_cb() for DTLS"));
4639 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Beckera817ea42020-10-20 15:20:23 +01004640 }
4641#endif /* MBEDTLS_SSL_PROTO_DTLS */
4642
Gilles Peskine449bd832023-01-11 14:50:10 +01004643 MBEDTLS_SSL_DEBUG_MSG(2, ("=> handshake"));
Paul Bakker1961b702013-01-25 14:49:24 +01004644
Hanno Beckera817ea42020-10-20 15:20:23 +01004645 /* Main handshake loop */
Gilles Peskine449bd832023-01-11 14:50:10 +01004646 while (ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER) {
4647 ret = mbedtls_ssl_handshake_step(ssl);
Paul Bakker1961b702013-01-25 14:49:24 +01004648
Gilles Peskine449bd832023-01-11 14:50:10 +01004649 if (ret != 0) {
Paul Bakker1961b702013-01-25 14:49:24 +01004650 break;
Gilles Peskine449bd832023-01-11 14:50:10 +01004651 }
Paul Bakker1961b702013-01-25 14:49:24 +01004652 }
4653
Gilles Peskine449bd832023-01-11 14:50:10 +01004654 MBEDTLS_SSL_DEBUG_MSG(2, ("<= handshake"));
Paul Bakker5121ce52009-01-03 21:22:43 +00004655
Gilles Peskine449bd832023-01-11 14:50:10 +01004656 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00004657}
4658
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004659#if defined(MBEDTLS_SSL_RENEGOTIATION)
4660#if defined(MBEDTLS_SSL_SRV_C)
Paul Bakker5121ce52009-01-03 21:22:43 +00004661/*
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004662 * Write HelloRequest to request renegotiation on server
Paul Bakker48916f92012-09-16 19:57:18 +00004663 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004664MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004665static int ssl_write_hello_request(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004666{
Janos Follath865b3eb2019-12-16 11:46:15 +00004667 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004668
Gilles Peskine449bd832023-01-11 14:50:10 +01004669 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write hello request"));
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004670
4671 ssl->out_msglen = 4;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004672 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
4673 ssl->out_msg[0] = MBEDTLS_SSL_HS_HELLO_REQUEST;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004674
Gilles Peskine449bd832023-01-11 14:50:10 +01004675 if ((ret = mbedtls_ssl_write_handshake_msg(ssl)) != 0) {
4676 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_handshake_msg", ret);
4677 return ret;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004678 }
4679
Gilles Peskine449bd832023-01-11 14:50:10 +01004680 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write hello request"));
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004681
Gilles Peskine449bd832023-01-11 14:50:10 +01004682 return 0;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004683}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004684#endif /* MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004685
4686/*
4687 * Actually renegotiate current connection, triggered by either:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004688 * - any side: calling mbedtls_ssl_renegotiate(),
4689 * - client: receiving a HelloRequest during mbedtls_ssl_read(),
4690 * - server: receiving any handshake message on server during mbedtls_ssl_read() after
Manuel Pégourié-Gonnard55e4ff22014-08-19 11:16:35 +02004691 * the initial handshake is completed.
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004692 * If the handshake doesn't complete due to waiting for I/O, it will continue
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004693 * during the next calls to mbedtls_ssl_renegotiate() or mbedtls_ssl_read() respectively.
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004694 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004695int mbedtls_ssl_start_renegotiation(mbedtls_ssl_context *ssl)
Paul Bakker48916f92012-09-16 19:57:18 +00004696{
Janos Follath865b3eb2019-12-16 11:46:15 +00004697 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker48916f92012-09-16 19:57:18 +00004698
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 if ((ret = ssl_handshake_init(ssl)) != 0) {
4702 return ret;
4703 }
Paul Bakker48916f92012-09-16 19:57:18 +00004704
Manuel Pégourié-Gonnard0557bd52014-08-19 19:18:39 +02004705 /* RFC 6347 4.2.2: "[...] the HelloRequest will have message_seq = 0 and
4706 * the ServerHello will have message_seq = 1" */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004707#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004708 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
4709 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING) {
4710 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02004711 ssl->handshake->out_msg_seq = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004712 } else {
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02004713 ssl->handshake->in_msg_seq = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004714 }
Manuel Pégourié-Gonnard0557bd52014-08-19 19:18:39 +02004715 }
4716#endif
4717
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004718 ssl->state = MBEDTLS_SSL_HELLO_REQUEST;
4719 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS;
Paul Bakker48916f92012-09-16 19:57:18 +00004720
Gilles Peskine449bd832023-01-11 14:50:10 +01004721 if ((ret = mbedtls_ssl_handshake(ssl)) != 0) {
4722 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_handshake", ret);
4723 return ret;
Paul Bakker48916f92012-09-16 19:57:18 +00004724 }
4725
Gilles Peskine449bd832023-01-11 14:50:10 +01004726 MBEDTLS_SSL_DEBUG_MSG(2, ("<= renegotiate"));
Paul Bakker48916f92012-09-16 19:57:18 +00004727
Gilles Peskine449bd832023-01-11 14:50:10 +01004728 return 0;
Paul Bakker48916f92012-09-16 19:57:18 +00004729}
4730
4731/*
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004732 * Renegotiate current connection on client,
4733 * or request renegotiation on server
4734 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004735int mbedtls_ssl_renegotiate(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004736{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004737 int ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004738
Gilles Peskine449bd832023-01-11 14:50:10 +01004739 if (ssl == NULL || ssl->conf == NULL) {
4740 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4741 }
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02004742
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004743#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004744 /* On server, just send the request */
Gilles Peskine449bd832023-01-11 14:50:10 +01004745 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
4746 if (mbedtls_ssl_is_handshake_over(ssl) == 0) {
4747 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4748 }
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004749
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004750 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_PENDING;
Manuel Pégourié-Gonnardf07f4212014-08-15 19:04:47 +02004751
4752 /* Did we already try/start sending HelloRequest? */
Gilles Peskine449bd832023-01-11 14:50:10 +01004753 if (ssl->out_left != 0) {
4754 return mbedtls_ssl_flush_output(ssl);
4755 }
Manuel Pégourié-Gonnardf07f4212014-08-15 19:04:47 +02004756
Gilles Peskine449bd832023-01-11 14:50:10 +01004757 return ssl_write_hello_request(ssl);
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004758 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004759#endif /* MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004760
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004761#if defined(MBEDTLS_SSL_CLI_C)
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004762 /*
4763 * On client, either start the renegotiation process or,
4764 * if already in progress, continue the handshake
4765 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004766 if (ssl->renego_status != MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS) {
4767 if (mbedtls_ssl_is_handshake_over(ssl) == 0) {
4768 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004769 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004770
4771 if ((ret = mbedtls_ssl_start_renegotiation(ssl)) != 0) {
4772 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_start_renegotiation", ret);
4773 return ret;
4774 }
4775 } else {
4776 if ((ret = mbedtls_ssl_handshake(ssl)) != 0) {
4777 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_handshake", ret);
4778 return ret;
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004779 }
4780 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004781#endif /* MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004782
Gilles Peskine449bd832023-01-11 14:50:10 +01004783 return ret;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004784}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004785#endif /* MBEDTLS_SSL_RENEGOTIATION */
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004786
Gilles Peskine449bd832023-01-11 14:50:10 +01004787void mbedtls_ssl_handshake_free(mbedtls_ssl_context *ssl)
Paul Bakker48916f92012-09-16 19:57:18 +00004788{
Gilles Peskine9b562d52018-04-25 20:32:43 +02004789 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
4790
Gilles Peskine449bd832023-01-11 14:50:10 +01004791 if (handshake == NULL) {
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004792 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01004793 }
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004794
Valerio Setti6f0441d2023-07-03 12:11:36 +02004795#if defined(MBEDTLS_PK_HAVE_ECC_KEYS)
Brett Warrene0edc842021-08-17 09:53:13 +01004796#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004797 if (ssl->handshake->group_list_heap_allocated) {
4798 mbedtls_free((void *) handshake->group_list);
4799 }
Brett Warrene0edc842021-08-17 09:53:13 +01004800 handshake->group_list = NULL;
4801#endif /* MBEDTLS_DEPRECATED_REMOVED */
Valerio Setti6f0441d2023-07-03 12:11:36 +02004802#endif /* MBEDTLS_PK_HAVE_ECC_KEYS */
Brett Warrene0edc842021-08-17 09:53:13 +01004803
Ronald Crone68ab4f2022-10-05 12:46:29 +02004804#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yuf017ee42022-01-12 15:49:48 +08004805#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004806 if (ssl->handshake->sig_algs_heap_allocated) {
4807 mbedtls_free((void *) handshake->sig_algs);
4808 }
Jerry Yuf017ee42022-01-12 15:49:48 +08004809 handshake->sig_algs = NULL;
4810#endif /* MBEDTLS_DEPRECATED_REMOVED */
Xiaofei Baic234ecf2022-02-08 09:59:23 +00004811#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004812 if (ssl->handshake->certificate_request_context) {
4813 mbedtls_free((void *) handshake->certificate_request_context);
Xiaofei Baic234ecf2022-02-08 09:59:23 +00004814 }
4815#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Ronald Crone68ab4f2022-10-05 12:46:29 +02004816#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Jerry Yuf017ee42022-01-12 15:49:48 +08004817
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02004818#if defined(MBEDTLS_SSL_ASYNC_PRIVATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01004819 if (ssl->conf->f_async_cancel != NULL && handshake->async_in_progress != 0) {
4820 ssl->conf->f_async_cancel(ssl);
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02004821 handshake->async_in_progress = 0;
4822 }
4823#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
4824
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01004825#if defined(MBEDTLS_MD_CAN_SHA256)
Andrzej Kurekeb342242019-01-29 09:14:33 -05004826#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01004827 psa_hash_abort(&handshake->fin_sha256_psa);
Andrzej Kurekeb342242019-01-29 09:14:33 -05004828#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01004829 mbedtls_md_free(&handshake->fin_sha256);
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02004830#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -05004831#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01004832#if defined(MBEDTLS_MD_CAN_SHA384)
Andrzej Kurekeb342242019-01-29 09:14:33 -05004833#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01004834 psa_hash_abort(&handshake->fin_sha384_psa);
Andrzej Kurekeb342242019-01-29 09:14:33 -05004835#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01004836 mbedtls_md_free(&handshake->fin_sha384);
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02004837#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -05004838#endif
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02004839
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004840#if defined(MBEDTLS_DHM_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004841 mbedtls_dhm_free(&handshake->dhm_ctx);
Paul Bakker48916f92012-09-16 19:57:18 +00004842#endif
Valerio Setti7aeec542023-07-05 18:57:21 +02004843#if !defined(MBEDTLS_USE_PSA_CRYPTO) && \
Valerio Setti6eb00542023-07-07 17:04:24 +02004844 defined(MBEDTLS_KEY_EXCHANGE_SOME_ECDH_OR_ECDHE_1_2_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004845 mbedtls_ecdh_free(&handshake->ecdh_ctx);
Paul Bakker61d113b2013-07-04 11:51:43 +02004846#endif
Valerio Setti02c25b52022-11-15 14:08:42 +01004847
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02004848#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Neil Armstrongca7d5062022-05-31 14:43:23 +02004849#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01004850 psa_pake_abort(&handshake->psa_pake_ctx);
Valerio Settieb3f7882022-12-08 18:42:58 +01004851 /*
4852 * Opaque keys are not stored in the handshake's data and it's the user
4853 * responsibility to destroy them. Clear ones, instead, are created by
4854 * the TLS library and should be destroyed at the same level
4855 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004856 if (!mbedtls_svc_key_id_is_null(handshake->psa_pake_password)) {
4857 psa_destroy_key(handshake->psa_pake_password);
Valerio Settieb3f7882022-12-08 18:42:58 +01004858 }
Neil Armstrongca7d5062022-05-31 14:43:23 +02004859 handshake->psa_pake_password = MBEDTLS_SVC_KEY_ID_INIT;
4860#else
Gilles Peskine449bd832023-01-11 14:50:10 +01004861 mbedtls_ecjpake_free(&handshake->ecjpake_ctx);
Neil Armstrongca7d5062022-05-31 14:43:23 +02004862#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard77c06462015-09-17 13:59:49 +02004863#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004864 mbedtls_free(handshake->ecjpake_cache);
Manuel Pégourié-Gonnard77c06462015-09-17 13:59:49 +02004865 handshake->ecjpake_cache = NULL;
4866 handshake->ecjpake_cache_len = 0;
4867#endif
Manuel Pégourié-Gonnard76cfd3f2015-09-15 12:10:54 +02004868#endif
Paul Bakker61d113b2013-07-04 11:51:43 +02004869
Valerio Setti7aeec542023-07-05 18:57:21 +02004870#if defined(MBEDTLS_KEY_EXCHANGE_SOME_ECDH_OR_ECDHE_ANY_ENABLED) || \
Valerio Setti45d56f32023-07-13 17:23:20 +02004871 defined(MBEDTLS_KEY_EXCHANGE_WITH_ECDSA_ANY_ENABLED) || \
Janos Follath4ae5c292016-02-10 11:27:43 +00004872 defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Paul Bakker9af723c2014-05-01 13:03:14 +02004873 /* explicit void pointer cast for buggy MS compiler */
Gilles Peskine449bd832023-01-11 14:50:10 +01004874 mbedtls_free((void *) handshake->curves_tls_id);
Manuel Pégourié-Gonnardd09453c2013-09-23 19:11:32 +02004875#endif
4876
Ronald Cron73fe8df2022-10-05 14:31:43 +02004877#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED)
Neil Armstrong501c9322022-05-03 09:35:09 +02004878#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01004879 if (!mbedtls_svc_key_id_is_null(ssl->handshake->psk_opaque)) {
Neil Armstrong501c9322022-05-03 09:35:09 +02004880 /* The maintenance of the external PSK key slot is the
4881 * user's responsibility. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004882 if (ssl->handshake->psk_opaque_is_internal) {
4883 psa_destroy_key(ssl->handshake->psk_opaque);
Neil Armstrong501c9322022-05-03 09:35:09 +02004884 ssl->handshake->psk_opaque_is_internal = 0;
4885 }
4886 ssl->handshake->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
4887 }
Neil Armstronge952a302022-05-03 10:22:14 +02004888#else
Gilles Peskine449bd832023-01-11 14:50:10 +01004889 if (handshake->psk != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01004890 mbedtls_zeroize_and_free(handshake->psk, handshake->psk_len);
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01004891 }
Neil Armstronge952a302022-05-03 10:22:14 +02004892#endif /* MBEDTLS_USE_PSA_CRYPTO */
Ronald Cron73fe8df2022-10-05 14:31:43 +02004893#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED */
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01004894
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004895#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
4896 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Manuel Pégourié-Gonnard83724542013-09-24 22:30:56 +02004897 /*
4898 * Free only the linked list wrapper, not the keys themselves
4899 * since the belong to the SNI callback
4900 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004901 ssl_key_cert_free(handshake->sni_key_cert);
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004902#endif /* MBEDTLS_X509_CRT_PARSE_C && MBEDTLS_SSL_SERVER_NAME_INDICATION */
Manuel Pégourié-Gonnard705fcca2013-09-23 20:04:20 +02004903
Gilles Peskineeccd8882020-03-10 12:19:08 +01004904#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004905 mbedtls_x509_crt_restart_free(&handshake->ecrs_ctx);
4906 if (handshake->ecrs_peer_cert != NULL) {
4907 mbedtls_x509_crt_free(handshake->ecrs_peer_cert);
4908 mbedtls_free(handshake->ecrs_peer_cert);
Hanno Becker3dad3112019-02-05 17:19:52 +00004909 }
Manuel Pégourié-Gonnard862cde52017-05-17 11:56:15 +02004910#endif
4911
Hanno Becker75173122019-02-06 16:18:31 +00004912#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
4913 !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01004914 mbedtls_pk_free(&handshake->peer_pubkey);
Hanno Becker75173122019-02-06 16:18:31 +00004915#endif /* MBEDTLS_X509_CRT_PARSE_C && !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
4916
XiaokangQian9b93c0d2022-02-09 06:02:25 +00004917#if defined(MBEDTLS_SSL_CLI_C) && \
Gilles Peskine449bd832023-01-11 14:50:10 +01004918 (defined(MBEDTLS_SSL_PROTO_DTLS) || defined(MBEDTLS_SSL_PROTO_TLS1_3))
4919 mbedtls_free(handshake->cookie);
XiaokangQian9b93c0d2022-02-09 06:02:25 +00004920#endif /* MBEDTLS_SSL_CLI_C &&
4921 ( MBEDTLS_SSL_PROTO_DTLS || MBEDTLS_SSL_PROTO_TLS1_3 ) */
XiaokangQian8499b6c2022-01-27 09:00:11 +00004922
4923#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004924 mbedtls_ssl_flight_free(handshake->flight);
4925 mbedtls_ssl_buffering_free(ssl);
XiaokangQian8499b6c2022-01-27 09:00:11 +00004926#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard74848812014-07-11 02:43:49 +02004927
Valerio Settiea59c432023-07-25 11:14:03 +02004928#if defined(MBEDTLS_KEY_EXCHANGE_SOME_XXDH_PSA_ANY_ENABLED)
Przemek Stekiel7ac93be2023-07-04 10:02:38 +02004929 if (handshake->xxdh_psa_privkey_is_external == 0) {
4930 psa_destroy_key(handshake->xxdh_psa_privkey);
Gilles Peskine449bd832023-01-11 14:50:10 +01004931 }
Valerio Settiea59c432023-07-25 11:14:03 +02004932#endif /* MBEDTLS_KEY_EXCHANGE_SOME_XXDH_PSA_ANY_ENABLED */
Hanno Becker4a63ed42019-01-08 11:39:35 +00004933
Ronald Cron6f135e12021-12-08 16:57:54 +01004934#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004935 mbedtls_ssl_transform_free(handshake->transform_handshake);
4936 mbedtls_free(handshake->transform_handshake);
Jerry Yu3d9b5902022-11-04 14:07:25 +08004937#if defined(MBEDTLS_SSL_EARLY_DATA)
Gilles Peskine449bd832023-01-11 14:50:10 +01004938 mbedtls_ssl_transform_free(handshake->transform_earlydata);
4939 mbedtls_free(handshake->transform_earlydata);
Jerry Yu3d9b5902022-11-04 14:07:25 +08004940#endif
Ronald Cron6f135e12021-12-08 16:57:54 +01004941#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yuba9c7272021-10-30 11:54:10 +08004942
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05004943
4944#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
4945 /* If the buffers are too big - reallocate. Because of the way Mbed TLS
4946 * processes datagrams and the fact that a datagram is allowed to have
4947 * several records in it, it is possible that the I/O buffers are not
4948 * empty at this stage */
Gilles Peskine449bd832023-01-11 14:50:10 +01004949 handle_buffer_resizing(ssl, 1, mbedtls_ssl_get_input_buflen(ssl),
4950 mbedtls_ssl_get_output_buflen(ssl));
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05004951#endif
Hanno Becker3aa186f2021-08-10 09:24:19 +01004952
Jerry Yuba9c7272021-10-30 11:54:10 +08004953 /* mbedtls_platform_zeroize MUST be last one in this function */
Gilles Peskine449bd832023-01-11 14:50:10 +01004954 mbedtls_platform_zeroize(handshake,
4955 sizeof(mbedtls_ssl_handshake_params));
Paul Bakker48916f92012-09-16 19:57:18 +00004956}
4957
Gilles Peskine449bd832023-01-11 14:50:10 +01004958void mbedtls_ssl_session_free(mbedtls_ssl_session *session)
Paul Bakker48916f92012-09-16 19:57:18 +00004959{
Gilles Peskine449bd832023-01-11 14:50:10 +01004960 if (session == NULL) {
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004961 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01004962 }
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004963
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004964#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004965 ssl_clear_peer_cert(session);
Paul Bakkered27a042013-04-18 22:46:23 +02004966#endif
Paul Bakker0a597072012-09-25 21:55:46 +00004967
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02004968#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
Xiaokang Qianbc663a02022-10-09 11:14:39 +00004969#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && \
4970 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01004971 mbedtls_free(session->hostname);
Xiaokang Qian281fd1b2022-09-20 11:35:41 +00004972#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01004973 mbedtls_free(session->ticket);
Paul Bakkera503a632013-08-14 13:48:06 +02004974#endif
Manuel Pégourié-Gonnard75d44012013-08-02 14:44:04 +02004975
Waleed Elmelegy2824a202024-02-23 17:51:47 +00004976#if defined(MBEDTLS_SSL_EARLY_DATA) && defined(MBEDTLS_SSL_ALPN) && \
4977 defined(MBEDTLS_SSL_SRV_C)
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00004978 mbedtls_free(session->ticket_alpn);
Paul Bakker5121ce52009-01-03 21:22:43 +00004979#endif
4980
Gilles Peskine449bd832023-01-11 14:50:10 +01004981 mbedtls_platform_zeroize(session, sizeof(mbedtls_ssl_session));
Paul Bakker5121ce52009-01-03 21:22:43 +00004982}
4983
Manuel Pégourié-Gonnard5c0e3772019-07-23 16:13:17 +02004984#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004985
4986#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
4987#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID 1u
4988#else
4989#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID 0u
4990#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
4991
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004992#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT 1u
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004993
4994#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
4995#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY 1u
4996#else
4997#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY 0u
4998#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
4999
5000#if defined(MBEDTLS_SSL_ALPN)
5001#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN 1u
5002#else
5003#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN 0u
5004#endif /* MBEDTLS_SSL_ALPN */
5005
5006#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID_BIT 0
5007#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT_BIT 1
5008#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY_BIT 2
5009#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN_BIT 3
5010
5011#define SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG \
Gilles Peskine449bd832023-01-11 14:50:10 +01005012 ((uint32_t) ( \
5013 (SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID << \
5014 SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID_BIT) | \
5015 (SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT << \
5016 SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT_BIT) | \
5017 (SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY << \
5018 SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY_BIT) | \
5019 (SSL_SERIALIZED_CONTEXT_CONFIG_ALPN << SSL_SERIALIZED_CONTEXT_CONFIG_ALPN_BIT) | \
5020 0u))
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02005021
Chien Wong4e9683e2023-12-28 17:07:43 +08005022static const unsigned char ssl_serialized_context_header[] = {
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005023 MBEDTLS_VERSION_MAJOR,
5024 MBEDTLS_VERSION_MINOR,
5025 MBEDTLS_VERSION_PATCH,
Gilles Peskine449bd832023-01-11 14:50:10 +01005026 MBEDTLS_BYTE_1(SSL_SERIALIZED_SESSION_CONFIG_BITFLAG),
5027 MBEDTLS_BYTE_0(SSL_SERIALIZED_SESSION_CONFIG_BITFLAG),
5028 MBEDTLS_BYTE_2(SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG),
5029 MBEDTLS_BYTE_1(SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG),
5030 MBEDTLS_BYTE_0(SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG),
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005031};
5032
Paul Bakker5121ce52009-01-03 21:22:43 +00005033/*
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005034 * Serialize a full SSL context
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02005035 *
5036 * The format of the serialized data is:
5037 * (in the presentation language of TLS, RFC 8446 section 3)
5038 *
5039 * // header
5040 * opaque mbedtls_version[3]; // major, minor, patch
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005041 * opaque context_format[5]; // version-specific field determining
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02005042 * // the format of the remaining
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005043 * // serialized data.
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02005044 * Note: When updating the format, remember to keep these
5045 * version+format bytes. (We may make their size part of the API.)
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02005046 *
5047 * // session sub-structure
5048 * opaque session<1..2^32-1>; // see mbedtls_ssl_session_save()
5049 * // transform sub-structure
5050 * uint8 random[64]; // ServerHello.random+ClientHello.random
5051 * uint8 in_cid<0..2^8-1> // Connection ID: expected incoming value
5052 * uint8 out_cid<0..2^8-1> // Connection ID: outgoing value to use
5053 * // fields from ssl_context
5054 * uint32 badmac_seen; // DTLS: number of records with failing MAC
5055 * uint64 in_window_top; // DTLS: last validated record seq_num
5056 * uint64 in_window; // DTLS: bitmask for replay protection
5057 * uint8 disable_datagram_packing; // DTLS: only one record per datagram
5058 * uint64 cur_out_ctr; // Record layer: outgoing sequence number
5059 * uint16 mtu; // DTLS: path mtu (max outgoing fragment size)
5060 * uint8 alpn_chosen<0..2^8-1> // ALPN: negotiated application protocol
5061 *
5062 * Note that many fields of the ssl_context or sub-structures are not
5063 * serialized, as they fall in one of the following categories:
5064 *
5065 * 1. forced value (eg in_left must be 0)
5066 * 2. pointer to dynamically-allocated memory (eg session, transform)
5067 * 3. value can be re-derived from other data (eg session keys from MS)
5068 * 4. value was temporary (eg content of input buffer)
5069 * 5. value will be provided by the user again (eg I/O callbacks and context)
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005070 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005071int mbedtls_ssl_context_save(mbedtls_ssl_context *ssl,
5072 unsigned char *buf,
5073 size_t buf_len,
5074 size_t *olen)
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005075{
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005076 unsigned char *p = buf;
5077 size_t used = 0;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005078 size_t session_len;
5079 int ret = 0;
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005080
Manuel Pégourié-Gonnard1aaf6692019-07-10 14:14:05 +02005081 /*
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02005082 * Enforce usage restrictions, see "return BAD_INPUT_DATA" in
5083 * this function's documentation.
5084 *
5085 * These are due to assumptions/limitations in the implementation. Some of
5086 * them are likely to stay (no handshake in progress) some might go away
5087 * (only DTLS) but are currently used to simplify the implementation.
Manuel Pégourié-Gonnard1aaf6692019-07-10 14:14:05 +02005088 */
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02005089 /* The initial handshake must be over */
Gilles Peskine449bd832023-01-11 14:50:10 +01005090 if (mbedtls_ssl_is_handshake_over(ssl) == 0) {
5091 MBEDTLS_SSL_DEBUG_MSG(1, ("Initial handshake isn't over"));
5092 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03005093 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005094 if (ssl->handshake != NULL) {
5095 MBEDTLS_SSL_DEBUG_MSG(1, ("Handshake isn't completed"));
5096 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03005097 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02005098 /* Double-check that sub-structures are indeed ready */
Gilles Peskine449bd832023-01-11 14:50:10 +01005099 if (ssl->transform == NULL || ssl->session == NULL) {
5100 MBEDTLS_SSL_DEBUG_MSG(1, ("Serialised structures aren't ready"));
5101 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03005102 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02005103 /* There must be no pending incoming or outgoing data */
Gilles Peskine449bd832023-01-11 14:50:10 +01005104 if (mbedtls_ssl_check_pending(ssl) != 0) {
5105 MBEDTLS_SSL_DEBUG_MSG(1, ("There is pending incoming data"));
5106 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03005107 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005108 if (ssl->out_left != 0) {
5109 MBEDTLS_SSL_DEBUG_MSG(1, ("There is pending outgoing data"));
5110 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03005111 }
Dave Rodgman556e8a32022-12-06 16:31:25 +00005112 /* Protocol must be DTLS, not TLS */
Gilles Peskine449bd832023-01-11 14:50:10 +01005113 if (ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
5114 MBEDTLS_SSL_DEBUG_MSG(1, ("Only DTLS is supported"));
5115 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03005116 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02005117 /* Version must be 1.2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005118 if (ssl->tls_version != MBEDTLS_SSL_VERSION_TLS1_2) {
5119 MBEDTLS_SSL_DEBUG_MSG(1, ("Only version 1.2 supported"));
5120 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03005121 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02005122 /* We must be using an AEAD ciphersuite */
Gilles Peskine449bd832023-01-11 14:50:10 +01005123 if (mbedtls_ssl_transform_uses_aead(ssl->transform) != 1) {
5124 MBEDTLS_SSL_DEBUG_MSG(1, ("Only AEAD ciphersuites supported"));
5125 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03005126 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02005127 /* Renegotiation must not be enabled */
5128#if defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01005129 if (ssl->conf->disable_renegotiation != MBEDTLS_SSL_RENEGOTIATION_DISABLED) {
5130 MBEDTLS_SSL_DEBUG_MSG(1, ("Renegotiation must not be enabled"));
5131 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03005132 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02005133#endif
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005134
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005135 /*
5136 * Version and format identifier
5137 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005138 used += sizeof(ssl_serialized_context_header);
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005139
Gilles Peskine449bd832023-01-11 14:50:10 +01005140 if (used <= buf_len) {
5141 memcpy(p, ssl_serialized_context_header,
5142 sizeof(ssl_serialized_context_header));
5143 p += sizeof(ssl_serialized_context_header);
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005144 }
5145
5146 /*
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005147 * Session (length + data)
5148 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005149 ret = ssl_session_save(ssl->session, 1, NULL, 0, &session_len);
5150 if (ret != MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL) {
5151 return ret;
5152 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005153
5154 used += 4 + session_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01005155 if (used <= buf_len) {
5156 MBEDTLS_PUT_UINT32_BE(session_len, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01005157 p += 4;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005158
Gilles Peskine449bd832023-01-11 14:50:10 +01005159 ret = ssl_session_save(ssl->session, 1,
5160 p, session_len, &session_len);
5161 if (ret != 0) {
5162 return ret;
5163 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005164
5165 p += session_len;
5166 }
5167
5168 /*
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005169 * Transform
5170 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005171 used += sizeof(ssl->transform->randbytes);
5172 if (used <= buf_len) {
5173 memcpy(p, ssl->transform->randbytes,
5174 sizeof(ssl->transform->randbytes));
5175 p += sizeof(ssl->transform->randbytes);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005176 }
5177
5178#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Dave Rodgmanc37ad442023-11-03 23:36:06 +00005179 used += 2U + ssl->transform->in_cid_len + ssl->transform->out_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01005180 if (used <= buf_len) {
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005181 *p++ = ssl->transform->in_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01005182 memcpy(p, ssl->transform->in_cid, ssl->transform->in_cid_len);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005183 p += ssl->transform->in_cid_len;
5184
5185 *p++ = ssl->transform->out_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01005186 memcpy(p, ssl->transform->out_cid, ssl->transform->out_cid_len);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005187 p += ssl->transform->out_cid_len;
5188 }
5189#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
5190
5191 /*
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005192 * Saved fields from top-level ssl_context structure
5193 */
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005194 used += 4;
Gilles Peskine449bd832023-01-11 14:50:10 +01005195 if (used <= buf_len) {
5196 MBEDTLS_PUT_UINT32_BE(ssl->badmac_seen, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01005197 p += 4;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005198 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005199
5200#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
5201 used += 16;
Gilles Peskine449bd832023-01-11 14:50:10 +01005202 if (used <= buf_len) {
5203 MBEDTLS_PUT_UINT64_BE(ssl->in_window_top, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01005204 p += 8;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005205
Gilles Peskine449bd832023-01-11 14:50:10 +01005206 MBEDTLS_PUT_UINT64_BE(ssl->in_window, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01005207 p += 8;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005208 }
5209#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
5210
5211#if defined(MBEDTLS_SSL_PROTO_DTLS)
5212 used += 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01005213 if (used <= buf_len) {
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005214 *p++ = ssl->disable_datagram_packing;
5215 }
5216#endif /* MBEDTLS_SSL_PROTO_DTLS */
5217
Jerry Yuae0b2e22021-10-08 15:21:19 +08005218 used += MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Gilles Peskine449bd832023-01-11 14:50:10 +01005219 if (used <= buf_len) {
5220 memcpy(p, ssl->cur_out_ctr, MBEDTLS_SSL_SEQUENCE_NUMBER_LEN);
Jerry Yuae0b2e22021-10-08 15:21:19 +08005221 p += MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005222 }
5223
5224#if defined(MBEDTLS_SSL_PROTO_DTLS)
5225 used += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01005226 if (used <= buf_len) {
5227 MBEDTLS_PUT_UINT16_BE(ssl->mtu, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01005228 p += 2;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005229 }
5230#endif /* MBEDTLS_SSL_PROTO_DTLS */
5231
5232#if defined(MBEDTLS_SSL_ALPN)
5233 {
5234 const uint8_t alpn_len = ssl->alpn_chosen
Gilles Peskine449bd832023-01-11 14:50:10 +01005235 ? (uint8_t) strlen(ssl->alpn_chosen)
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005236 : 0;
5237
5238 used += 1 + alpn_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01005239 if (used <= buf_len) {
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005240 *p++ = alpn_len;
5241
Gilles Peskine449bd832023-01-11 14:50:10 +01005242 if (ssl->alpn_chosen != NULL) {
5243 memcpy(p, ssl->alpn_chosen, alpn_len);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005244 p += alpn_len;
5245 }
5246 }
5247 }
5248#endif /* MBEDTLS_SSL_ALPN */
5249
5250 /*
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005251 * Done
5252 */
5253 *olen = used;
5254
Gilles Peskine449bd832023-01-11 14:50:10 +01005255 if (used > buf_len) {
5256 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
5257 }
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005258
Gilles Peskine449bd832023-01-11 14:50:10 +01005259 MBEDTLS_SSL_DEBUG_BUF(4, "saved context", buf, used);
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005260
Gilles Peskine449bd832023-01-11 14:50:10 +01005261 return mbedtls_ssl_session_reset_int(ssl, 0);
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005262}
5263
5264/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02005265 * Deserialize context, see mbedtls_ssl_context_save() for format.
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005266 *
5267 * This internal version is wrapped by a public function that cleans up in
5268 * case of error.
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005269 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005270MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01005271static int ssl_context_load(mbedtls_ssl_context *ssl,
5272 const unsigned char *buf,
5273 size_t len)
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005274{
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005275 const unsigned char *p = buf;
5276 const unsigned char * const end = buf + len;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005277 size_t session_len;
Janos Follath865b3eb2019-12-16 11:46:15 +00005278 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04005279#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Andrzej Kurek894edde2022-09-29 06:31:14 -04005280 tls_prf_fn prf_func = NULL;
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04005281#endif
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005282
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02005283 /*
5284 * The context should have been freshly setup or reset.
5285 * Give the user an error in case of obvious misuse.
Manuel Pégourié-Gonnard4ca930f2019-07-26 16:31:53 +02005286 * (Checking session is useful because it won't be NULL if we're
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02005287 * renegotiating, or if the user mistakenly loaded a session first.)
5288 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005289 if (ssl->state != MBEDTLS_SSL_HELLO_REQUEST ||
5290 ssl->session != NULL) {
5291 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02005292 }
5293
5294 /*
5295 * We can't check that the config matches the initial one, but we can at
5296 * least check it matches the requirements for serializing.
5297 */
Dave Rodgmane99b24d2023-09-14 15:45:03 +01005298 if (
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02005299#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard9a96fd72019-07-23 17:11:24 +02005300 ssl->conf->disable_renegotiation != MBEDTLS_SSL_RENEGOTIATION_DISABLED ||
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02005301#endif
Dave Rodgmane99b24d2023-09-14 15:45:03 +01005302 ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM ||
5303 ssl->conf->max_tls_version < MBEDTLS_SSL_VERSION_TLS1_2 ||
5304 ssl->conf->min_tls_version > MBEDTLS_SSL_VERSION_TLS1_2
5305 ) {
Gilles Peskine449bd832023-01-11 14:50:10 +01005306 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02005307 }
5308
Gilles Peskine449bd832023-01-11 14:50:10 +01005309 MBEDTLS_SSL_DEBUG_BUF(4, "context to load", buf, len);
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005310
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005311 /*
5312 * Check version identifier
5313 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005314 if ((size_t) (end - p) < sizeof(ssl_serialized_context_header)) {
5315 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005316 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005317
5318 if (memcmp(p, ssl_serialized_context_header,
5319 sizeof(ssl_serialized_context_header)) != 0) {
5320 return MBEDTLS_ERR_SSL_VERSION_MISMATCH;
5321 }
5322 p += sizeof(ssl_serialized_context_header);
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005323
5324 /*
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005325 * Session
5326 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005327 if ((size_t) (end - p) < 4) {
5328 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5329 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005330
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01005331 session_len = MBEDTLS_GET_UINT32_BE(p, 0);
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005332 p += 4;
5333
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02005334 /* This has been allocated by ssl_handshake_init(), called by
Hanno Becker43aefe22020-02-05 10:44:56 +00005335 * by either mbedtls_ssl_session_reset_int() or mbedtls_ssl_setup(). */
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02005336 ssl->session = ssl->session_negotiate;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005337 ssl->session_in = ssl->session;
5338 ssl->session_out = ssl->session;
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02005339 ssl->session_negotiate = NULL;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005340
Gilles Peskine449bd832023-01-11 14:50:10 +01005341 if ((size_t) (end - p) < session_len) {
5342 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5343 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005344
Gilles Peskine449bd832023-01-11 14:50:10 +01005345 ret = ssl_session_load(ssl->session, 1, p, session_len);
5346 if (ret != 0) {
5347 mbedtls_ssl_session_free(ssl->session);
5348 return ret;
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02005349 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005350
5351 p += session_len;
5352
5353 /*
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005354 * Transform
5355 */
5356
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02005357 /* This has been allocated by ssl_handshake_init(), called by
Hanno Becker43aefe22020-02-05 10:44:56 +00005358 * by either mbedtls_ssl_session_reset_int() or mbedtls_ssl_setup(). */
Jerry Yu2e199812022-12-01 18:57:19 +08005359#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02005360 ssl->transform = ssl->transform_negotiate;
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005361 ssl->transform_in = ssl->transform;
5362 ssl->transform_out = ssl->transform;
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02005363 ssl->transform_negotiate = NULL;
Jerry Yu2e199812022-12-01 18:57:19 +08005364#endif
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005365
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04005366#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005367 prf_func = ssl_tls12prf_from_cs(ssl->session->ciphersuite);
5368 if (prf_func == NULL) {
5369 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5370 }
Andrzej Kurek894edde2022-09-29 06:31:14 -04005371
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005372 /* Read random bytes and populate structure */
Gilles Peskine449bd832023-01-11 14:50:10 +01005373 if ((size_t) (end - p) < sizeof(ssl->transform->randbytes)) {
5374 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5375 }
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04005376
Gilles Peskine449bd832023-01-11 14:50:10 +01005377 ret = ssl_tls12_populate_transform(ssl->transform,
5378 ssl->session->ciphersuite,
5379 ssl->session->master,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02005380#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01005381 ssl->session->encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02005382#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01005383 prf_func,
5384 p, /* currently pointing to randbytes */
5385 MBEDTLS_SSL_VERSION_TLS1_2, /* (D)TLS 1.2 is forced */
5386 ssl->conf->endpoint,
5387 ssl);
5388 if (ret != 0) {
5389 return ret;
5390 }
Jerry Yu840fbb22022-02-17 14:59:29 +08005391#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005392 p += sizeof(ssl->transform->randbytes);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005393
5394#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
5395 /* Read connection IDs and store them */
Gilles Peskine449bd832023-01-11 14:50:10 +01005396 if ((size_t) (end - p) < 1) {
5397 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5398 }
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005399
5400 ssl->transform->in_cid_len = *p++;
5401
Gilles Peskine449bd832023-01-11 14:50:10 +01005402 if ((size_t) (end - p) < ssl->transform->in_cid_len + 1u) {
5403 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5404 }
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005405
Gilles Peskine449bd832023-01-11 14:50:10 +01005406 memcpy(ssl->transform->in_cid, p, ssl->transform->in_cid_len);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005407 p += ssl->transform->in_cid_len;
5408
5409 ssl->transform->out_cid_len = *p++;
5410
Gilles Peskine449bd832023-01-11 14:50:10 +01005411 if ((size_t) (end - p) < ssl->transform->out_cid_len) {
5412 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5413 }
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005414
Gilles Peskine449bd832023-01-11 14:50:10 +01005415 memcpy(ssl->transform->out_cid, p, ssl->transform->out_cid_len);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005416 p += ssl->transform->out_cid_len;
5417#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
5418
5419 /*
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005420 * Saved fields from top-level ssl_context structure
5421 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005422 if ((size_t) (end - p) < 4) {
5423 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5424 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005425
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01005426 ssl->badmac_seen = MBEDTLS_GET_UINT32_BE(p, 0);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005427 p += 4;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005428
5429#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Gilles Peskine449bd832023-01-11 14:50:10 +01005430 if ((size_t) (end - p) < 16) {
5431 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5432 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005433
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01005434 ssl->in_window_top = MBEDTLS_GET_UINT64_BE(p, 0);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005435 p += 8;
5436
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01005437 ssl->in_window = MBEDTLS_GET_UINT64_BE(p, 0);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005438 p += 8;
5439#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
5440
5441#if defined(MBEDTLS_SSL_PROTO_DTLS)
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 ssl->disable_datagram_packing = *p++;
5447#endif /* MBEDTLS_SSL_PROTO_DTLS */
5448
Gilles Peskine449bd832023-01-11 14:50:10 +01005449 if ((size_t) (end - p) < sizeof(ssl->cur_out_ctr)) {
5450 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5451 }
5452 memcpy(ssl->cur_out_ctr, p, sizeof(ssl->cur_out_ctr));
5453 p += sizeof(ssl->cur_out_ctr);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005454
5455#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005456 if ((size_t) (end - p) < 2) {
5457 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5458 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005459
Dave Rodgmana3d0f612023-11-03 23:34:02 +00005460 ssl->mtu = MBEDTLS_GET_UINT16_BE(p, 0);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005461 p += 2;
5462#endif /* MBEDTLS_SSL_PROTO_DTLS */
5463
5464#if defined(MBEDTLS_SSL_ALPN)
5465 {
5466 uint8_t alpn_len;
5467 const char **cur;
5468
Gilles Peskine449bd832023-01-11 14:50:10 +01005469 if ((size_t) (end - p) < 1) {
5470 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5471 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005472
5473 alpn_len = *p++;
5474
Gilles Peskine449bd832023-01-11 14:50:10 +01005475 if (alpn_len != 0 && ssl->conf->alpn_list != NULL) {
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005476 /* alpn_chosen should point to an item in the configured list */
Gilles Peskine449bd832023-01-11 14:50:10 +01005477 for (cur = ssl->conf->alpn_list; *cur != NULL; cur++) {
5478 if (strlen(*cur) == alpn_len &&
Waleed Elmelegy131b2ff2024-03-14 01:39:39 +00005479 memcmp(p, *cur, alpn_len) == 0) {
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005480 ssl->alpn_chosen = *cur;
5481 break;
5482 }
5483 }
5484 }
5485
5486 /* can only happen on conf mismatch */
Gilles Peskine449bd832023-01-11 14:50:10 +01005487 if (alpn_len != 0 && ssl->alpn_chosen == NULL) {
5488 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5489 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005490
5491 p += alpn_len;
5492 }
5493#endif /* MBEDTLS_SSL_ALPN */
5494
5495 /*
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02005496 * Forced fields from top-level ssl_context structure
5497 *
5498 * Most of them already set to the correct value by mbedtls_ssl_init() and
5499 * mbedtls_ssl_reset(), so we only need to set the remaining ones.
5500 */
5501 ssl->state = MBEDTLS_SSL_HANDSHAKE_OVER;
Glenn Strauss60bfe602022-03-14 19:04:24 -04005502 ssl->tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02005503
Hanno Becker361b10d2019-08-30 10:42:49 +01005504 /* Adjust pointers for header fields of outgoing records to
5505 * the given transform, accounting for explicit IV and CID. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005506 mbedtls_ssl_update_out_pointers(ssl, ssl->transform);
Hanno Becker361b10d2019-08-30 10:42:49 +01005507
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02005508#if defined(MBEDTLS_SSL_PROTO_DTLS)
5509 ssl->in_epoch = 1;
5510#endif
5511
5512 /* mbedtls_ssl_reset() leaves the handshake sub-structure allocated,
5513 * which we don't want - otherwise we'd end up freeing the wrong transform
Hanno Beckerce5f5fd2020-02-05 10:47:44 +00005514 * by calling mbedtls_ssl_handshake_wrapup_free_hs_transform()
5515 * inappropriately. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005516 if (ssl->handshake != NULL) {
5517 mbedtls_ssl_handshake_free(ssl);
5518 mbedtls_free(ssl->handshake);
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02005519 ssl->handshake = NULL;
5520 }
5521
5522 /*
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005523 * Done - should have consumed entire buffer
5524 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005525 if (p != end) {
5526 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5527 }
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005528
Gilles Peskine449bd832023-01-11 14:50:10 +01005529 return 0;
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005530}
5531
5532/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02005533 * Deserialize context: public wrapper for error cleaning
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005534 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005535int mbedtls_ssl_context_load(mbedtls_ssl_context *context,
5536 const unsigned char *buf,
5537 size_t len)
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005538{
Gilles Peskine449bd832023-01-11 14:50:10 +01005539 int ret = ssl_context_load(context, buf, len);
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005540
Gilles Peskine449bd832023-01-11 14:50:10 +01005541 if (ret != 0) {
5542 mbedtls_ssl_free(context);
5543 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005544
Gilles Peskine449bd832023-01-11 14:50:10 +01005545 return ret;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005546}
Manuel Pégourié-Gonnard5c0e3772019-07-23 16:13:17 +02005547#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005548
5549/*
Paul Bakker5121ce52009-01-03 21:22:43 +00005550 * Free an SSL context
5551 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005552void mbedtls_ssl_free(mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00005553{
Gilles Peskine449bd832023-01-11 14:50:10 +01005554 if (ssl == NULL) {
Paul Bakkeraccaffe2014-06-26 13:37:14 +02005555 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01005556 }
Paul Bakkeraccaffe2014-06-26 13:37:14 +02005557
Gilles Peskine449bd832023-01-11 14:50:10 +01005558 MBEDTLS_SSL_DEBUG_MSG(2, ("=> free"));
Paul Bakker5121ce52009-01-03 21:22:43 +00005559
Gilles Peskine449bd832023-01-11 14:50:10 +01005560 if (ssl->out_buf != NULL) {
sander-visserb8aa2072020-05-06 22:05:13 +02005561#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
5562 size_t out_buf_len = ssl->out_buf_len;
5563#else
5564 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
5565#endif
5566
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005567 mbedtls_zeroize_and_free(ssl->out_buf, out_buf_len);
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05005568 ssl->out_buf = NULL;
Paul Bakker5121ce52009-01-03 21:22:43 +00005569 }
5570
Gilles Peskine449bd832023-01-11 14:50:10 +01005571 if (ssl->in_buf != NULL) {
sander-visserb8aa2072020-05-06 22:05:13 +02005572#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
5573 size_t in_buf_len = ssl->in_buf_len;
5574#else
5575 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
5576#endif
5577
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005578 mbedtls_zeroize_and_free(ssl->in_buf, in_buf_len);
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05005579 ssl->in_buf = NULL;
Paul Bakker5121ce52009-01-03 21:22:43 +00005580 }
5581
Gilles Peskine449bd832023-01-11 14:50:10 +01005582 if (ssl->transform) {
5583 mbedtls_ssl_transform_free(ssl->transform);
5584 mbedtls_free(ssl->transform);
Paul Bakker48916f92012-09-16 19:57:18 +00005585 }
5586
Gilles Peskine449bd832023-01-11 14:50:10 +01005587 if (ssl->handshake) {
5588 mbedtls_ssl_handshake_free(ssl);
5589 mbedtls_free(ssl->handshake);
Jerry Yu2e199812022-12-01 18:57:19 +08005590
5591#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005592 mbedtls_ssl_transform_free(ssl->transform_negotiate);
5593 mbedtls_free(ssl->transform_negotiate);
Jerry Yu2e199812022-12-01 18:57:19 +08005594#endif
5595
Gilles Peskine449bd832023-01-11 14:50:10 +01005596 mbedtls_ssl_session_free(ssl->session_negotiate);
5597 mbedtls_free(ssl->session_negotiate);
Paul Bakker48916f92012-09-16 19:57:18 +00005598 }
5599
Ronald Cron6f135e12021-12-08 16:57:54 +01005600#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01005601 mbedtls_ssl_transform_free(ssl->transform_application);
5602 mbedtls_free(ssl->transform_application);
Ronald Cron6f135e12021-12-08 16:57:54 +01005603#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker3aa186f2021-08-10 09:24:19 +01005604
Gilles Peskine449bd832023-01-11 14:50:10 +01005605 if (ssl->session) {
5606 mbedtls_ssl_session_free(ssl->session);
5607 mbedtls_free(ssl->session);
Paul Bakkerc0463502013-02-14 11:19:38 +01005608 }
5609
Manuel Pégourié-Gonnard55fab2d2015-05-11 16:15:19 +02005610#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskinee61852e2025-02-12 23:28:48 +01005611 mbedtls_ssl_free_hostname(ssl);
Paul Bakker0be444a2013-08-27 21:55:01 +02005612#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00005613
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02005614#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005615 mbedtls_free(ssl->cli_id);
Manuel Pégourié-Gonnard43c02182014-07-22 17:32:01 +02005616#endif
5617
Gilles Peskine449bd832023-01-11 14:50:10 +01005618 MBEDTLS_SSL_DEBUG_MSG(2, ("<= free"));
Paul Bakker2da561c2009-02-05 18:00:28 +00005619
Paul Bakker86f04f42013-02-14 11:20:09 +01005620 /* Actually clear after last debug message */
Gilles Peskine449bd832023-01-11 14:50:10 +01005621 mbedtls_platform_zeroize(ssl, sizeof(mbedtls_ssl_context));
Paul Bakker5121ce52009-01-03 21:22:43 +00005622}
5623
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005624/*
Shaun Case8b0ecbc2021-12-20 21:14:10 -08005625 * Initialize mbedtls_ssl_config
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005626 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005627void mbedtls_ssl_config_init(mbedtls_ssl_config *conf)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005628{
Gilles Peskine449bd832023-01-11 14:50:10 +01005629 memset(conf, 0, sizeof(mbedtls_ssl_config));
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005630}
5631
Gilles Peskineae270bf2021-06-02 00:05:29 +02005632/* The selection should be the same as mbedtls_x509_crt_profile_default in
5633 * x509_crt.c, plus Montgomery curves for ECDHE. Here, the order matters:
Gilles Peskineb1940a72021-06-02 15:18:12 +02005634 * curves with a lower resource usage come first.
Gilles Peskineae270bf2021-06-02 00:05:29 +02005635 * See the documentation of mbedtls_ssl_conf_curves() for what we promise
Gilles Peskineb1940a72021-06-02 15:18:12 +02005636 * about this list.
5637 */
Chien Wong4e9683e2023-12-28 17:07:43 +08005638static const uint16_t ssl_preset_default_groups[] = {
Valerio Settidb6b4db2023-09-01 09:20:51 +02005639#if defined(MBEDTLS_ECP_HAVE_CURVE25519)
Brett Warrene0edc842021-08-17 09:53:13 +01005640 MBEDTLS_SSL_IANA_TLS_GROUP_X25519,
Gilles Peskineae270bf2021-06-02 00:05:29 +02005641#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005642#if defined(MBEDTLS_ECP_HAVE_SECP256R1)
Brett Warrene0edc842021-08-17 09:53:13 +01005643 MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1,
Gilles Peskineae270bf2021-06-02 00:05:29 +02005644#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005645#if defined(MBEDTLS_ECP_HAVE_SECP384R1)
Brett Warrene0edc842021-08-17 09:53:13 +01005646 MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02005647#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005648#if defined(MBEDTLS_ECP_HAVE_CURVE448)
Brett Warrene0edc842021-08-17 09:53:13 +01005649 MBEDTLS_SSL_IANA_TLS_GROUP_X448,
Gilles Peskineb1940a72021-06-02 15:18:12 +02005650#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005651#if defined(MBEDTLS_ECP_HAVE_SECP521R1)
Brett Warrene0edc842021-08-17 09:53:13 +01005652 MBEDTLS_SSL_IANA_TLS_GROUP_SECP521R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02005653#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005654#if defined(MBEDTLS_ECP_HAVE_BP256R1)
Brett Warrene0edc842021-08-17 09:53:13 +01005655 MBEDTLS_SSL_IANA_TLS_GROUP_BP256R1,
Gilles Peskineae270bf2021-06-02 00:05:29 +02005656#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005657#if defined(MBEDTLS_ECP_HAVE_BP384R1)
Brett Warrene0edc842021-08-17 09:53:13 +01005658 MBEDTLS_SSL_IANA_TLS_GROUP_BP384R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02005659#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005660#if defined(MBEDTLS_ECP_HAVE_BP512R1)
Brett Warrene0edc842021-08-17 09:53:13 +01005661 MBEDTLS_SSL_IANA_TLS_GROUP_BP512R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02005662#endif
Przemek Stekiel316c19e2023-05-31 15:25:11 +02005663#if defined(PSA_WANT_ALG_FFDH)
Przemek Stekiel383f4712022-12-12 14:48:57 +01005664 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE2048,
5665 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE3072,
5666 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE4096,
5667 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE6144,
5668 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE8192,
5669#endif
Brett Warrene0edc842021-08-17 09:53:13 +01005670 MBEDTLS_SSL_IANA_TLS_GROUP_NONE
Gilles Peskineae270bf2021-06-02 00:05:29 +02005671};
Gilles Peskineae270bf2021-06-02 00:05:29 +02005672
Alexey Tsvetkov2ca34372022-06-07 10:21:05 +03005673static const int ssl_preset_suiteb_ciphersuites[] = {
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005674 MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256,
5675 MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384,
5676 0
5677};
5678
Ronald Crone68ab4f2022-10-05 12:46:29 +02005679#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Hanno Becker9c6aa7b2021-08-10 13:50:43 +01005680
Jerry Yu909df7b2022-01-22 11:56:27 +08005681/* NOTICE:
Jerry Yu0b994b82022-01-25 17:22:12 +08005682 * For ssl_preset_*_sig_algs and ssl_tls12_preset_*_sig_algs, the following
Jerry Yu370e1462022-01-25 10:36:53 +08005683 * rules SHOULD be upheld.
5684 * - No duplicate entries.
5685 * - But if there is a good reason, do not change the order of the algorithms.
Jerry Yu09a99fc2022-07-28 14:22:17 +08005686 * - ssl_tls12_preset* is for TLS 1.2 use only.
Jerry Yu370e1462022-01-25 10:36:53 +08005687 * - ssl_preset_* is for TLS 1.3 only or hybrid TLS 1.3/1.2 handshakes.
Jerry Yu1a8b4812022-01-20 17:56:50 +08005688 */
Chien Wong4e9683e2023-12-28 17:07:43 +08005689static const uint16_t ssl_preset_default_sig_algs[] = {
Jerry Yu1a8b4812022-01-20 17:56:50 +08005690
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005691#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005692 defined(MBEDTLS_MD_CAN_SHA256) && \
Valerio Setticf29c5d2023-09-01 09:03:41 +02005693 defined(PSA_WANT_ECC_SECP_R1_256)
Jerry Yued5e9f42022-01-26 11:21:34 +08005694 MBEDTLS_TLS1_3_SIG_ECDSA_SECP256R1_SHA256,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005695 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256)
5696#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08005697
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005698#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005699 defined(MBEDTLS_MD_CAN_SHA384) && \
Valerio Setticf29c5d2023-09-01 09:03:41 +02005700 defined(PSA_WANT_ECC_SECP_R1_384)
Jerry Yu909df7b2022-01-22 11:56:27 +08005701 MBEDTLS_TLS1_3_SIG_ECDSA_SECP384R1_SHA384,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005702 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384)
5703#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08005704
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005705#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005706 defined(MBEDTLS_MD_CAN_SHA512) && \
Valerio Setticf29c5d2023-09-01 09:03:41 +02005707 defined(PSA_WANT_ECC_SECP_R1_521)
Jerry Yued5e9f42022-01-26 11:21:34 +08005708 MBEDTLS_TLS1_3_SIG_ECDSA_SECP521R1_SHA512,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005709 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA512)
5710#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08005711
Yanray Wang1136fad2023-11-22 16:54:31 +08005712#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && defined(MBEDTLS_MD_CAN_SHA512)
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005713 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA512,
Yanray Wang1136fad2023-11-22 16:54:31 +08005714#endif
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005715
Yanray Wang1136fad2023-11-22 16:54:31 +08005716#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && defined(MBEDTLS_MD_CAN_SHA384)
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005717 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA384,
Yanray Wang1136fad2023-11-22 16:54:31 +08005718#endif
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005719
Yanray Wang1136fad2023-11-22 16:54:31 +08005720#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && defined(MBEDTLS_MD_CAN_SHA256)
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005721 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256,
Yanray Wang1136fad2023-11-22 16:54:31 +08005722#endif
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005723
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005724#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_MD_CAN_SHA512)
Jerry Yu693a47a2022-06-23 14:02:28 +08005725 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA512,
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005726#endif /* MBEDTLS_RSA_C && MBEDTLS_MD_CAN_SHA512 */
Jerry Yu693a47a2022-06-23 14:02:28 +08005727
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005728#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_MD_CAN_SHA384)
Jerry Yu693a47a2022-06-23 14:02:28 +08005729 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA384,
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005730#endif /* MBEDTLS_RSA_C && MBEDTLS_MD_CAN_SHA384 */
Jerry Yu693a47a2022-06-23 14:02:28 +08005731
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005732#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_MD_CAN_SHA256)
Jerry Yu693a47a2022-06-23 14:02:28 +08005733 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA256,
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005734#endif /* MBEDTLS_RSA_C && MBEDTLS_MD_CAN_SHA256 */
Jerry Yu693a47a2022-06-23 14:02:28 +08005735
Gabor Mezei15b95a62022-05-09 16:37:58 +02005736 MBEDTLS_TLS_SIG_NONE
Jerry Yu909df7b2022-01-22 11:56:27 +08005737};
5738
5739/* NOTICE: see above */
5740#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
5741static uint16_t ssl_tls12_preset_default_sig_algs[] = {
Yanray Wang1136fad2023-11-22 16:54:31 +08005742
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005743#if defined(MBEDTLS_MD_CAN_SHA512)
Valerio Settie9646ec2023-08-02 20:02:28 +02005744#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005745 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA512),
Jerry Yu713013f2022-01-17 18:16:35 +08005746#endif
Jerry Yu09a99fc2022-07-28 14:22:17 +08005747#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT)
5748 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA512,
Yanray Wang1136fad2023-11-22 16:54:31 +08005749#endif
Gabor Mezeic1051b62022-05-10 13:13:58 +02005750#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005751 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA512),
Gabor Mezeic1051b62022-05-10 13:13:58 +02005752#endif
Yanray Wang1136fad2023-11-22 16:54:31 +08005753#endif /* MBEDTLS_MD_CAN_SHA512 */
5754
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005755#if defined(MBEDTLS_MD_CAN_SHA384)
Valerio Settie9646ec2023-08-02 20:02:28 +02005756#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005757 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384),
Jerry Yu11f0a9c2022-01-12 18:43:08 +08005758#endif
Jerry Yu09a99fc2022-07-28 14:22:17 +08005759#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT)
5760 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA384,
Yanray Wang1136fad2023-11-22 16:54:31 +08005761#endif
Gabor Mezeic1051b62022-05-10 13:13:58 +02005762#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005763 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA384),
Gabor Mezeic1051b62022-05-10 13:13:58 +02005764#endif
Yanray Wang1136fad2023-11-22 16:54:31 +08005765#endif /* MBEDTLS_MD_CAN_SHA384 */
5766
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005767#if defined(MBEDTLS_MD_CAN_SHA256)
Valerio Settie9646ec2023-08-02 20:02:28 +02005768#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005769 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256),
Jerry Yu11f0a9c2022-01-12 18:43:08 +08005770#endif
Jerry Yu09a99fc2022-07-28 14:22:17 +08005771#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT)
5772 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256,
Yanray Wang1136fad2023-11-22 16:54:31 +08005773#endif
Gabor Mezeic1051b62022-05-10 13:13:58 +02005774#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005775 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA256),
Gabor Mezeic1051b62022-05-10 13:13:58 +02005776#endif
Yanray Wang1136fad2023-11-22 16:54:31 +08005777#endif /* MBEDTLS_MD_CAN_SHA256 */
5778
Gabor Mezei15b95a62022-05-09 16:37:58 +02005779 MBEDTLS_TLS_SIG_NONE
Jerry Yu909df7b2022-01-22 11:56:27 +08005780};
5781#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Yanray Wang1136fad2023-11-22 16:54:31 +08005782
Jerry Yu909df7b2022-01-22 11:56:27 +08005783/* NOTICE: see above */
Chien Wong4e9683e2023-12-28 17:07:43 +08005784static const uint16_t ssl_preset_suiteb_sig_algs[] = {
Jerry Yu909df7b2022-01-22 11:56:27 +08005785
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005786#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Valerio Setti45d56f32023-07-13 17:23:20 +02005787 defined(MBEDTLS_MD_CAN_SHA256) && \
Valerio Settidb6b4db2023-09-01 09:20:51 +02005788 defined(MBEDTLS_ECP_HAVE_SECP256R1)
Jerry Yu909df7b2022-01-22 11:56:27 +08005789 MBEDTLS_TLS1_3_SIG_ECDSA_SECP256R1_SHA256,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005790 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256)
5791#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08005792
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005793#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Valerio Setti45d56f32023-07-13 17:23:20 +02005794 defined(MBEDTLS_MD_CAN_SHA384) && \
Valerio Settidb6b4db2023-09-01 09:20:51 +02005795 defined(MBEDTLS_ECP_HAVE_SECP384R1)
Jerry Yu53037892022-01-25 11:02:06 +08005796 MBEDTLS_TLS1_3_SIG_ECDSA_SECP384R1_SHA384,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005797 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384)
5798#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08005799
Gabor Mezei15b95a62022-05-09 16:37:58 +02005800 MBEDTLS_TLS_SIG_NONE
Jerry Yu713013f2022-01-17 18:16:35 +08005801};
Jerry Yu6106fdc2022-01-12 16:36:14 +08005802
Jerry Yu909df7b2022-01-22 11:56:27 +08005803/* NOTICE: see above */
5804#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
5805static uint16_t ssl_tls12_preset_suiteb_sig_algs[] = {
Yanray Wang1136fad2023-11-22 16:54:31 +08005806
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005807#if defined(MBEDTLS_MD_CAN_SHA256)
Valerio Settie9646ec2023-08-02 20:02:28 +02005808#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005809 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256),
Jerry Yu713013f2022-01-17 18:16:35 +08005810#endif
Yanray Wang1136fad2023-11-22 16:54:31 +08005811#endif /* MBEDTLS_MD_CAN_SHA256 */
Yanray Wang69ceb392023-11-22 16:32:39 +08005812
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005813#if defined(MBEDTLS_MD_CAN_SHA384)
Valerio Settie9646ec2023-08-02 20:02:28 +02005814#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005815 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384),
Jerry Yu18c833e2022-01-25 10:55:47 +08005816#endif
Yanray Wang1136fad2023-11-22 16:54:31 +08005817#endif /* MBEDTLS_MD_CAN_SHA384 */
5818
Gabor Mezei15b95a62022-05-09 16:37:58 +02005819 MBEDTLS_TLS_SIG_NONE
Hanno Becker9c6aa7b2021-08-10 13:50:43 +01005820};
Jerry Yu909df7b2022-01-22 11:56:27 +08005821#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
5822
Ronald Crone68ab4f2022-10-05 12:46:29 +02005823#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005824
Chien Wong4e9683e2023-12-28 17:07:43 +08005825static const uint16_t ssl_preset_suiteb_groups[] = {
Valerio Settidb6b4db2023-09-01 09:20:51 +02005826#if defined(MBEDTLS_ECP_HAVE_SECP256R1)
Brett Warrene0edc842021-08-17 09:53:13 +01005827 MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1,
Jaeden Amerod4311042019-06-03 08:27:16 +01005828#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005829#if defined(MBEDTLS_ECP_HAVE_SECP384R1)
Brett Warrene0edc842021-08-17 09:53:13 +01005830 MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1,
Jaeden Amerod4311042019-06-03 08:27:16 +01005831#endif
Brett Warrene0edc842021-08-17 09:53:13 +01005832 MBEDTLS_SSL_IANA_TLS_GROUP_NONE
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005833};
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005834
Ronald Crone68ab4f2022-10-05 12:46:29 +02005835#if defined(MBEDTLS_DEBUG_C) && defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu909df7b2022-01-22 11:56:27 +08005836/* Function for checking `ssl_preset_*_sig_algs` and `ssl_tls12_preset_*_sig_algs`
Jerry Yu370e1462022-01-25 10:36:53 +08005837 * to make sure there are no duplicated signature algorithm entries. */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005838MBEDTLS_CHECK_RETURN_CRITICAL
Chien Wong4e9683e2023-12-28 17:07:43 +08005839static int ssl_check_no_sig_alg_duplication(const uint16_t *sig_algs)
Jerry Yu1a8b4812022-01-20 17:56:50 +08005840{
5841 size_t i, j;
5842 int ret = 0;
Jerry Yu909df7b2022-01-22 11:56:27 +08005843
Gilles Peskine449bd832023-01-11 14:50:10 +01005844 for (i = 0; sig_algs[i] != MBEDTLS_TLS_SIG_NONE; i++) {
5845 for (j = 0; j < i; j++) {
5846 if (sig_algs[i] != sig_algs[j]) {
Jerry Yuf377d642022-01-25 10:43:59 +08005847 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01005848 }
5849 mbedtls_printf(" entry(%04x,%" MBEDTLS_PRINTF_SIZET
5850 ") is duplicated at %" MBEDTLS_PRINTF_SIZET "\n",
5851 sig_algs[i], j, i);
Jerry Yuf377d642022-01-25 10:43:59 +08005852 ret = -1;
Jerry Yu1a8b4812022-01-20 17:56:50 +08005853 }
5854 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005855 return ret;
Jerry Yu1a8b4812022-01-20 17:56:50 +08005856}
5857
Ronald Crone68ab4f2022-10-05 12:46:29 +02005858#endif /* MBEDTLS_DEBUG_C && MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Jerry Yu1a8b4812022-01-20 17:56:50 +08005859
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005860/*
Tillmann Karras588ad502015-09-25 04:27:22 +02005861 * Load default in mbedtls_ssl_config
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005862 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005863int mbedtls_ssl_config_defaults(mbedtls_ssl_config *conf,
5864 int endpoint, int transport, int preset)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005865{
Manuel Pégourié-Gonnard8b431fb2015-05-11 12:54:52 +02005866#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Janos Follath865b3eb2019-12-16 11:46:15 +00005867 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard8b431fb2015-05-11 12:54:52 +02005868#endif
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005869
Ronald Crone68ab4f2022-10-05 12:46:29 +02005870#if defined(MBEDTLS_DEBUG_C) && defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005871 if (ssl_check_no_sig_alg_duplication(ssl_preset_suiteb_sig_algs)) {
5872 mbedtls_printf("ssl_preset_suiteb_sig_algs has duplicated entries\n");
5873 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu1a8b4812022-01-20 17:56:50 +08005874 }
5875
Gilles Peskine449bd832023-01-11 14:50:10 +01005876 if (ssl_check_no_sig_alg_duplication(ssl_preset_default_sig_algs)) {
5877 mbedtls_printf("ssl_preset_default_sig_algs has duplicated entries\n");
5878 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu1a8b4812022-01-20 17:56:50 +08005879 }
Jerry Yu909df7b2022-01-22 11:56:27 +08005880
5881#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005882 if (ssl_check_no_sig_alg_duplication(ssl_tls12_preset_suiteb_sig_algs)) {
5883 mbedtls_printf("ssl_tls12_preset_suiteb_sig_algs has duplicated entries\n");
5884 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu909df7b2022-01-22 11:56:27 +08005885 }
5886
Gilles Peskine449bd832023-01-11 14:50:10 +01005887 if (ssl_check_no_sig_alg_duplication(ssl_tls12_preset_default_sig_algs)) {
5888 mbedtls_printf("ssl_tls12_preset_default_sig_algs has duplicated entries\n");
5889 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu909df7b2022-01-22 11:56:27 +08005890 }
5891#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Ronald Crone68ab4f2022-10-05 12:46:29 +02005892#endif /* MBEDTLS_DEBUG_C && MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Jerry Yu1a8b4812022-01-20 17:56:50 +08005893
Manuel Pégourié-Gonnard0de074f2015-05-14 12:58:01 +02005894 /* Use the functions here so that they are covered in tests,
5895 * but otherwise access member directly for efficiency */
Gilles Peskine449bd832023-01-11 14:50:10 +01005896 mbedtls_ssl_conf_endpoint(conf, endpoint);
5897 mbedtls_ssl_conf_transport(conf, transport);
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005898
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005899 /*
5900 * Things that are common to all presets
5901 */
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02005902#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005903 if (endpoint == MBEDTLS_SSL_IS_CLIENT) {
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02005904 conf->authmode = MBEDTLS_SSL_VERIFY_REQUIRED;
5905#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Ronald Crond67f8012024-08-28 07:45:57 +02005906 mbedtls_ssl_conf_session_tickets(conf, MBEDTLS_SSL_SESSION_TICKETS_ENABLED);
Ronald Cronbedddd72024-08-27 14:18:50 +02005907#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Ronald Cronc46edd42024-08-28 16:54:42 +02005908 /* Contrary to TLS 1.2 tickets, TLS 1.3 NewSessionTicket message
5909 * handling is disabled by default in Mbed TLS 3.6.x for backward
5910 * compatibility with client applications developed using Mbed TLS 3.5
5911 * or earlier with the default configuration.
5912 *
5913 * Up to Mbed TLS 3.5, in the default configuration TLS 1.3 was
5914 * disabled, and a Mbed TLS client with the default configuration would
5915 * establish a TLS 1.2 connection with a TLS 1.2 and TLS 1.3 capable
5916 * server.
5917 *
5918 * Starting with Mbed TLS 3.6.0, TLS 1.3 is enabled by default, and thus
5919 * an Mbed TLS client with the default configuration establishes a
5920 * TLS 1.3 connection with a TLS 1.2 and TLS 1.3 capable server. If
5921 * following the handshake the TLS 1.3 server sends NewSessionTicket
5922 * messages and the Mbed TLS client processes them, this results in
5923 * Mbed TLS high level APIs (mbedtls_ssl_read(),
5924 * mbedtls_ssl_handshake(), ...) to eventually return an
5925 * #MBEDTLS_ERR_SSL_RECEIVED_NEW_SESSION_TICKET non fatal error code
5926 * (see the documentation of mbedtls_ssl_read() for more information on
5927 * that error code). Applications unaware of that TLS 1.3 specific non
5928 * fatal error code are then failing.
5929 */
Ronald Cron9f44c882024-08-28 16:44:10 +02005930 mbedtls_ssl_conf_tls13_enable_signal_new_session_tickets(
5931 conf, MBEDTLS_SSL_TLS1_3_SIGNAL_NEW_SESSION_TICKETS_DISABLED);
Ronald Cronbedddd72024-08-27 14:18:50 +02005932#endif
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02005933#endif
5934 }
5935#endif
5936
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005937#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
5938 conf->encrypt_then_mac = MBEDTLS_SSL_ETM_ENABLED;
5939#endif
5940
5941#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
5942 conf->extended_ms = MBEDTLS_SSL_EXTENDED_MS_ENABLED;
5943#endif
5944
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02005945#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005946 conf->f_cookie_write = ssl_cookie_write_dummy;
5947 conf->f_cookie_check = ssl_cookie_check_dummy;
5948#endif
5949
5950#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
5951 conf->anti_replay = MBEDTLS_SSL_ANTI_REPLAY_ENABLED;
5952#endif
5953
Janos Follath088ce432017-04-10 12:42:31 +01005954#if defined(MBEDTLS_SSL_SRV_C)
5955 conf->cert_req_ca_list = MBEDTLS_SSL_CERT_REQ_CA_LIST_ENABLED;
TRodziewicz3946f792021-06-14 12:11:18 +02005956 conf->respect_cli_pref = MBEDTLS_SSL_SRV_CIPHERSUITE_ORDER_SERVER;
Janos Follath088ce432017-04-10 12:42:31 +01005957#endif
5958
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005959#if defined(MBEDTLS_SSL_PROTO_DTLS)
5960 conf->hs_timeout_min = MBEDTLS_SSL_DTLS_TIMEOUT_DFL_MIN;
5961 conf->hs_timeout_max = MBEDTLS_SSL_DTLS_TIMEOUT_DFL_MAX;
5962#endif
5963
5964#if defined(MBEDTLS_SSL_RENEGOTIATION)
5965 conf->renego_max_records = MBEDTLS_SSL_RENEGO_MAX_RECORDS_DEFAULT;
Gilles Peskine449bd832023-01-11 14:50:10 +01005966 memset(conf->renego_period, 0x00, 2);
5967 memset(conf->renego_period + 2, 0xFF, 6);
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005968#endif
5969
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005970#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005971 if (endpoint == MBEDTLS_SSL_IS_SERVER) {
Hanno Beckere2defad2021-07-24 05:59:17 +01005972 const unsigned char dhm_p[] =
5973 MBEDTLS_DHM_RFC3526_MODP_2048_P_BIN;
5974 const unsigned char dhm_g[] =
5975 MBEDTLS_DHM_RFC3526_MODP_2048_G_BIN;
Hanno Becker00d0a682017-10-04 13:14:29 +01005976
Gilles Peskine449bd832023-01-11 14:50:10 +01005977 if ((ret = mbedtls_ssl_conf_dh_param_bin(conf,
5978 dhm_p, sizeof(dhm_p),
5979 dhm_g, sizeof(dhm_g))) != 0) {
5980 return ret;
Hanno Beckere2defad2021-07-24 05:59:17 +01005981 }
5982 }
Manuel Pégourié-Gonnardbd990d62015-06-11 14:49:42 +02005983#endif
5984
Ronald Cron6f135e12021-12-08 16:57:54 +01005985#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yu6ee56aa2022-12-06 17:47:22 +08005986
5987#if defined(MBEDTLS_SSL_EARLY_DATA)
Yanray Wangd5ed36f2023-11-07 11:40:43 +08005988 mbedtls_ssl_conf_early_data(conf, MBEDTLS_SSL_EARLY_DATA_DISABLED);
Jerry Yu6ee56aa2022-12-06 17:47:22 +08005989#if defined(MBEDTLS_SSL_SRV_C)
Yanray Wang07517612023-11-07 11:47:36 +08005990 mbedtls_ssl_conf_max_early_data_size(conf, MBEDTLS_SSL_MAX_EARLY_DATA_SIZE);
Jerry Yu6ee56aa2022-12-06 17:47:22 +08005991#endif
5992#endif /* MBEDTLS_SSL_EARLY_DATA */
5993
Jerry Yud0766ec2022-09-22 10:46:57 +08005994#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Jerry Yu1ad7ace2022-08-09 13:28:39 +08005995 mbedtls_ssl_conf_new_session_tickets(
Gilles Peskine449bd832023-01-11 14:50:10 +01005996 conf, MBEDTLS_SSL_TLS1_3_DEFAULT_NEW_SESSION_TICKETS);
Jerry Yu1ad7ace2022-08-09 13:28:39 +08005997#endif
Hanno Becker71f1ed62021-07-24 06:01:47 +01005998 /*
5999 * Allow all TLS 1.3 key exchange modes by default.
6000 */
Xiaofei Bai746f9482021-11-12 08:53:56 +00006001 conf->tls13_kex_modes = MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_ALL;
Ronald Cron6f135e12021-12-08 16:57:54 +01006002#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker71f1ed62021-07-24 06:01:47 +01006003
Gilles Peskine449bd832023-01-11 14:50:10 +01006004 if (transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Glenn Strauss2dfcea22022-03-14 17:26:42 -04006005#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
XiaokangQian4d3a6042022-04-21 13:46:17 +00006006 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
XiaokangQian060d8672022-04-21 09:24:56 +00006007 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
XiaokangQian4d3a6042022-04-21 13:46:17 +00006008#else
Gilles Peskine449bd832023-01-11 14:50:10 +01006009 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
XiaokangQian060d8672022-04-21 09:24:56 +00006010#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01006011 } else {
XiaokangQian4d3a6042022-04-21 13:46:17 +00006012#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
Ronald Cron097ba142023-03-08 16:18:00 +01006013 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
6014 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
XiaokangQian4d3a6042022-04-21 13:46:17 +00006015#elif defined(MBEDTLS_SSL_PROTO_TLS1_3)
6016 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
6017 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
6018#elif defined(MBEDTLS_SSL_PROTO_TLS1_2)
6019 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
6020 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
6021#else
Gilles Peskine449bd832023-01-11 14:50:10 +01006022 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
XiaokangQian4d3a6042022-04-21 13:46:17 +00006023#endif
6024 }
Glenn Strauss2dfcea22022-03-14 17:26:42 -04006025
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02006026 /*
6027 * Preset-specific defaults
6028 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006029 switch (preset) {
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02006030 /*
6031 * NSA Suite B
6032 */
6033 case MBEDTLS_SSL_PRESET_SUITEB:
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02006034
Hanno Beckerd60b6c62021-04-29 12:04:11 +01006035 conf->ciphersuite_list = ssl_preset_suiteb_ciphersuites;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02006036
6037#if defined(MBEDTLS_X509_CRT_PARSE_C)
6038 conf->cert_profile = &mbedtls_x509_crt_profile_suiteb;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02006039#endif
6040
Ronald Crone68ab4f2022-10-05 12:46:29 +02006041#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu909df7b2022-01-22 11:56:27 +08006042#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01006043 if (mbedtls_ssl_conf_is_tls12_only(conf)) {
Jerry Yu909df7b2022-01-22 11:56:27 +08006044 conf->sig_algs = ssl_tls12_preset_suiteb_sig_algs;
Gilles Peskine449bd832023-01-11 14:50:10 +01006045 } else
Jerry Yu909df7b2022-01-22 11:56:27 +08006046#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006047 conf->sig_algs = ssl_preset_suiteb_sig_algs;
Ronald Crone68ab4f2022-10-05 12:46:29 +02006048#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02006049
Manuel Pégourié-Gonnardf07ce3b2023-09-22 11:53:41 +02006050#if defined(MBEDTLS_ECP_C) && !defined(MBEDTLS_DEPRECATED_REMOVED)
Brett Warrene0edc842021-08-17 09:53:13 +01006051 conf->curve_list = NULL;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02006052#endif
Brett Warrene0edc842021-08-17 09:53:13 +01006053 conf->group_list = ssl_preset_suiteb_groups;
Manuel Pégourié-Gonnardc98204e2015-08-11 04:21:01 +02006054 break;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02006055
6056 /*
6057 * Default
6058 */
6059 default:
Ronald Cronf6606552022-03-15 11:23:25 +01006060
Hanno Beckerd60b6c62021-04-29 12:04:11 +01006061 conf->ciphersuite_list = mbedtls_ssl_list_ciphersuites();
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02006062
6063#if defined(MBEDTLS_X509_CRT_PARSE_C)
6064 conf->cert_profile = &mbedtls_x509_crt_profile_default;
6065#endif
6066
Ronald Crone68ab4f2022-10-05 12:46:29 +02006067#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu909df7b2022-01-22 11:56:27 +08006068#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01006069 if (mbedtls_ssl_conf_is_tls12_only(conf)) {
Jerry Yu909df7b2022-01-22 11:56:27 +08006070 conf->sig_algs = ssl_tls12_preset_default_sig_algs;
Gilles Peskine449bd832023-01-11 14:50:10 +01006071 } else
Jerry Yu909df7b2022-01-22 11:56:27 +08006072#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006073 conf->sig_algs = ssl_preset_default_sig_algs;
Ronald Crone68ab4f2022-10-05 12:46:29 +02006074#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02006075
Manuel Pégourié-Gonnardf07ce3b2023-09-22 11:53:41 +02006076#if defined(MBEDTLS_ECP_C) && !defined(MBEDTLS_DEPRECATED_REMOVED)
Brett Warrene0edc842021-08-17 09:53:13 +01006077 conf->curve_list = NULL;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02006078#endif
Brett Warrene0edc842021-08-17 09:53:13 +01006079 conf->group_list = ssl_preset_default_groups;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02006080
6081#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_CLI_C)
6082 conf->dhm_min_bitlen = 1024;
6083#endif
6084 }
6085
Gilles Peskine449bd832023-01-11 14:50:10 +01006086 return 0;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02006087}
6088
6089/*
6090 * Free mbedtls_ssl_config
6091 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006092void mbedtls_ssl_config_free(mbedtls_ssl_config *conf)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02006093{
Troy-Butlerda73abc2024-04-02 13:37:31 -04006094 if (conf == NULL) {
6095 return;
6096 }
6097
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02006098#if defined(MBEDTLS_DHM_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01006099 mbedtls_mpi_free(&conf->dhm_P);
6100 mbedtls_mpi_free(&conf->dhm_G);
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02006101#endif
6102
Ronald Cron73fe8df2022-10-05 14:31:43 +02006103#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED)
Neil Armstrong501c9322022-05-03 09:35:09 +02006104#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01006105 if (!mbedtls_svc_key_id_is_null(conf->psk_opaque)) {
Neil Armstrong501c9322022-05-03 09:35:09 +02006106 conf->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
6107 }
Neil Armstrong8ecd6682022-05-05 11:40:35 +02006108#endif /* MBEDTLS_USE_PSA_CRYPTO */
Gilles Peskine449bd832023-01-11 14:50:10 +01006109 if (conf->psk != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01006110 mbedtls_zeroize_and_free(conf->psk, conf->psk_len);
Azim Khan27e8a122018-03-21 14:24:11 +00006111 conf->psk = NULL;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02006112 conf->psk_len = 0;
junyeonLEE316b1622017-12-20 16:29:30 +09006113 }
6114
Gilles Peskine449bd832023-01-11 14:50:10 +01006115 if (conf->psk_identity != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01006116 mbedtls_zeroize_and_free(conf->psk_identity, conf->psk_identity_len);
Azim Khan27e8a122018-03-21 14:24:11 +00006117 conf->psk_identity = NULL;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02006118 conf->psk_identity_len = 0;
6119 }
Ronald Cron73fe8df2022-10-05 14:31:43 +02006120#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED */
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02006121
6122#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01006123 ssl_key_cert_free(conf->key_cert);
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02006124#endif
6125
Gilles Peskine449bd832023-01-11 14:50:10 +01006126 mbedtls_platform_zeroize(conf, sizeof(mbedtls_ssl_config));
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02006127}
6128
Manuel Pégourié-Gonnard5674a972015-10-19 15:14:03 +02006129#if defined(MBEDTLS_PK_C) && \
Valerio Settie9646ec2023-08-02 20:02:28 +02006130 (defined(MBEDTLS_RSA_C) || defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED))
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02006131/*
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006132 * Convert between MBEDTLS_PK_XXX and SSL_SIG_XXX
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02006133 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006134unsigned char mbedtls_ssl_sig_from_pk(mbedtls_pk_context *pk)
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02006135{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006136#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01006137 if (mbedtls_pk_can_do(pk, MBEDTLS_PK_RSA)) {
6138 return MBEDTLS_SSL_SIG_RSA;
6139 }
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02006140#endif
Valerio Settie9646ec2023-08-02 20:02:28 +02006141#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01006142 if (mbedtls_pk_can_do(pk, MBEDTLS_PK_ECDSA)) {
6143 return MBEDTLS_SSL_SIG_ECDSA;
6144 }
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02006145#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01006146 return MBEDTLS_SSL_SIG_ANON;
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02006147}
6148
Gilles Peskine449bd832023-01-11 14:50:10 +01006149unsigned char mbedtls_ssl_sig_from_pk_alg(mbedtls_pk_type_t type)
Hanno Becker7e5437a2017-04-28 17:15:26 +01006150{
Gilles Peskine449bd832023-01-11 14:50:10 +01006151 switch (type) {
Hanno Becker7e5437a2017-04-28 17:15:26 +01006152 case MBEDTLS_PK_RSA:
Gilles Peskine449bd832023-01-11 14:50:10 +01006153 return MBEDTLS_SSL_SIG_RSA;
Hanno Becker7e5437a2017-04-28 17:15:26 +01006154 case MBEDTLS_PK_ECDSA:
6155 case MBEDTLS_PK_ECKEY:
Gilles Peskine449bd832023-01-11 14:50:10 +01006156 return MBEDTLS_SSL_SIG_ECDSA;
Hanno Becker7e5437a2017-04-28 17:15:26 +01006157 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006158 return MBEDTLS_SSL_SIG_ANON;
Hanno Becker7e5437a2017-04-28 17:15:26 +01006159 }
6160}
6161
Gilles Peskine449bd832023-01-11 14:50:10 +01006162mbedtls_pk_type_t mbedtls_ssl_pk_alg_from_sig(unsigned char sig)
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02006163{
Gilles Peskine449bd832023-01-11 14:50:10 +01006164 switch (sig) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006165#if defined(MBEDTLS_RSA_C)
6166 case MBEDTLS_SSL_SIG_RSA:
Gilles Peskine449bd832023-01-11 14:50:10 +01006167 return MBEDTLS_PK_RSA;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02006168#endif
Valerio Settie9646ec2023-08-02 20:02:28 +02006169#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006170 case MBEDTLS_SSL_SIG_ECDSA:
Gilles Peskine449bd832023-01-11 14:50:10 +01006171 return MBEDTLS_PK_ECDSA;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02006172#endif
6173 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006174 return MBEDTLS_PK_NONE;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02006175 }
6176}
Valerio Settie9646ec2023-08-02 20:02:28 +02006177#endif /* MBEDTLS_PK_C &&
6178 ( MBEDTLS_RSA_C || MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED ) */
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02006179
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02006180/*
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006181 * Convert from MBEDTLS_SSL_HASH_XXX to MBEDTLS_MD_XXX
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02006182 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006183mbedtls_md_type_t mbedtls_ssl_md_alg_from_hash(unsigned char hash)
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02006184{
Gilles Peskine449bd832023-01-11 14:50:10 +01006185 switch (hash) {
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006186#if defined(MBEDTLS_MD_CAN_MD5)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006187 case MBEDTLS_SSL_HASH_MD5:
Gilles Peskine449bd832023-01-11 14:50:10 +01006188 return MBEDTLS_MD_MD5;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02006189#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006190#if defined(MBEDTLS_MD_CAN_SHA1)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006191 case MBEDTLS_SSL_HASH_SHA1:
Gilles Peskine449bd832023-01-11 14:50:10 +01006192 return MBEDTLS_MD_SHA1;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02006193#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006194#if defined(MBEDTLS_MD_CAN_SHA224)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006195 case MBEDTLS_SSL_HASH_SHA224:
Gilles Peskine449bd832023-01-11 14:50:10 +01006196 return MBEDTLS_MD_SHA224;
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02006197#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006198#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006199 case MBEDTLS_SSL_HASH_SHA256:
Gilles Peskine449bd832023-01-11 14:50:10 +01006200 return MBEDTLS_MD_SHA256;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02006201#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006202#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006203 case MBEDTLS_SSL_HASH_SHA384:
Gilles Peskine449bd832023-01-11 14:50:10 +01006204 return MBEDTLS_MD_SHA384;
Mateusz Starzyk3352a532021-04-06 14:28:22 +02006205#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006206#if defined(MBEDTLS_MD_CAN_SHA512)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006207 case MBEDTLS_SSL_HASH_SHA512:
Gilles Peskine449bd832023-01-11 14:50:10 +01006208 return MBEDTLS_MD_SHA512;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02006209#endif
6210 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006211 return MBEDTLS_MD_NONE;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02006212 }
6213}
6214
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006215/*
6216 * Convert from MBEDTLS_MD_XXX to MBEDTLS_SSL_HASH_XXX
6217 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006218unsigned char mbedtls_ssl_hash_from_md_alg(int md)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006219{
Gilles Peskine449bd832023-01-11 14:50:10 +01006220 switch (md) {
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006221#if defined(MBEDTLS_MD_CAN_MD5)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006222 case MBEDTLS_MD_MD5:
Gilles Peskine449bd832023-01-11 14:50:10 +01006223 return MBEDTLS_SSL_HASH_MD5;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006224#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006225#if defined(MBEDTLS_MD_CAN_SHA1)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006226 case MBEDTLS_MD_SHA1:
Gilles Peskine449bd832023-01-11 14:50:10 +01006227 return MBEDTLS_SSL_HASH_SHA1;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006228#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006229#if defined(MBEDTLS_MD_CAN_SHA224)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006230 case MBEDTLS_MD_SHA224:
Gilles Peskine449bd832023-01-11 14:50:10 +01006231 return MBEDTLS_SSL_HASH_SHA224;
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02006232#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006233#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006234 case MBEDTLS_MD_SHA256:
Gilles Peskine449bd832023-01-11 14:50:10 +01006235 return MBEDTLS_SSL_HASH_SHA256;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006236#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006237#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006238 case MBEDTLS_MD_SHA384:
Gilles Peskine449bd832023-01-11 14:50:10 +01006239 return MBEDTLS_SSL_HASH_SHA384;
Mateusz Starzyk3352a532021-04-06 14:28:22 +02006240#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006241#if defined(MBEDTLS_MD_CAN_SHA512)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006242 case MBEDTLS_MD_SHA512:
Gilles Peskine449bd832023-01-11 14:50:10 +01006243 return MBEDTLS_SSL_HASH_SHA512;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006244#endif
6245 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006246 return MBEDTLS_SSL_HASH_NONE;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006247 }
6248}
6249
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01006250/*
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006251 * Check if a curve proposed by the peer is in our list.
Manuel Pégourié-Gonnard9d412d82015-06-17 12:10:46 +02006252 * Return 0 if we're willing to use it, -1 otherwise.
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01006253 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006254int mbedtls_ssl_check_curve_tls_id(const mbedtls_ssl_context *ssl, uint16_t tls_id)
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01006255{
Gilles Peskine449bd832023-01-11 14:50:10 +01006256 const uint16_t *group_list = mbedtls_ssl_get_groups(ssl);
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01006257
Gilles Peskine449bd832023-01-11 14:50:10 +01006258 if (group_list == NULL) {
6259 return -1;
Brett Warrene0edc842021-08-17 09:53:13 +01006260 }
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01006261
Gilles Peskine449bd832023-01-11 14:50:10 +01006262 for (; *group_list != 0; group_list++) {
6263 if (*group_list == tls_id) {
6264 return 0;
6265 }
6266 }
6267
6268 return -1;
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01006269}
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01006270
Valerio Setti49e69072023-06-27 17:27:51 +02006271#if defined(MBEDTLS_PK_HAVE_ECC_KEYS)
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01006272/*
6273 * Same as mbedtls_ssl_check_curve_tls_id() but with a mbedtls_ecp_group_id.
6274 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006275int mbedtls_ssl_check_curve(const mbedtls_ssl_context *ssl, mbedtls_ecp_group_id grp_id)
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01006276{
Gilles Peskine449bd832023-01-11 14:50:10 +01006277 uint16_t tls_id = mbedtls_ssl_get_tls_id_from_ecp_group_id(grp_id);
Leonid Rozenboim19e59732022-08-08 16:52:38 -07006278
Gilles Peskine449bd832023-01-11 14:50:10 +01006279 if (tls_id == 0) {
Leonid Rozenboim19e59732022-08-08 16:52:38 -07006280 return -1;
Gilles Peskine449bd832023-01-11 14:50:10 +01006281 }
Leonid Rozenboim19e59732022-08-08 16:52:38 -07006282
Gilles Peskine449bd832023-01-11 14:50:10 +01006283 return mbedtls_ssl_check_curve_tls_id(ssl, tls_id);
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01006284}
Valerio Setti49e69072023-06-27 17:27:51 +02006285#endif /* MBEDTLS_PK_HAVE_ECC_KEYS */
Valerio Setti67419f02023-01-04 16:12:42 +01006286
Valerio Setti18c9fed2022-12-30 17:44:24 +01006287static const struct {
6288 uint16_t tls_id;
6289 mbedtls_ecp_group_id ecp_group_id;
6290 psa_ecc_family_t psa_family;
6291 uint16_t bits;
Valerio Setti18c9fed2022-12-30 17:44:24 +01006292} tls_id_match_table[] =
6293{
Valerio Settidb6b4db2023-09-01 09:20:51 +02006294#if defined(MBEDTLS_ECP_HAVE_SECP521R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02006295 { 25, MBEDTLS_ECP_DP_SECP521R1, PSA_ECC_FAMILY_SECP_R1, 521 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006296#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02006297#if defined(MBEDTLS_ECP_HAVE_BP512R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02006298 { 28, MBEDTLS_ECP_DP_BP512R1, PSA_ECC_FAMILY_BRAINPOOL_P_R1, 512 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006299#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02006300#if defined(MBEDTLS_ECP_HAVE_SECP384R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02006301 { 24, MBEDTLS_ECP_DP_SECP384R1, PSA_ECC_FAMILY_SECP_R1, 384 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006302#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02006303#if defined(MBEDTLS_ECP_HAVE_BP384R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02006304 { 27, MBEDTLS_ECP_DP_BP384R1, PSA_ECC_FAMILY_BRAINPOOL_P_R1, 384 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006305#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02006306#if defined(MBEDTLS_ECP_HAVE_SECP256R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02006307 { 23, MBEDTLS_ECP_DP_SECP256R1, PSA_ECC_FAMILY_SECP_R1, 256 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006308#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02006309#if defined(MBEDTLS_ECP_HAVE_SECP256K1)
Valerio Settiacd32c02023-06-29 18:06:29 +02006310 { 22, MBEDTLS_ECP_DP_SECP256K1, PSA_ECC_FAMILY_SECP_K1, 256 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006311#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02006312#if defined(MBEDTLS_ECP_HAVE_BP256R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02006313 { 26, MBEDTLS_ECP_DP_BP256R1, PSA_ECC_FAMILY_BRAINPOOL_P_R1, 256 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006314#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02006315#if defined(MBEDTLS_ECP_HAVE_SECP224R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02006316 { 21, MBEDTLS_ECP_DP_SECP224R1, PSA_ECC_FAMILY_SECP_R1, 224 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006317#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02006318#if defined(MBEDTLS_ECP_HAVE_SECP224K1)
Valerio Settiacd32c02023-06-29 18:06:29 +02006319 { 20, MBEDTLS_ECP_DP_SECP224K1, PSA_ECC_FAMILY_SECP_K1, 224 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006320#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02006321#if defined(MBEDTLS_ECP_HAVE_SECP192R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02006322 { 19, MBEDTLS_ECP_DP_SECP192R1, PSA_ECC_FAMILY_SECP_R1, 192 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006323#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02006324#if defined(MBEDTLS_ECP_HAVE_SECP192K1)
Valerio Settiacd32c02023-06-29 18:06:29 +02006325 { 18, MBEDTLS_ECP_DP_SECP192K1, PSA_ECC_FAMILY_SECP_K1, 192 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006326#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02006327#if defined(MBEDTLS_ECP_HAVE_CURVE25519)
Valerio Settiacd32c02023-06-29 18:06:29 +02006328 { 29, MBEDTLS_ECP_DP_CURVE25519, PSA_ECC_FAMILY_MONTGOMERY, 255 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006329#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02006330#if defined(MBEDTLS_ECP_HAVE_CURVE448)
Valerio Settiacd32c02023-06-29 18:06:29 +02006331 { 30, MBEDTLS_ECP_DP_CURVE448, PSA_ECC_FAMILY_MONTGOMERY, 448 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006332#endif
Valerio Settiacd32c02023-06-29 18:06:29 +02006333 { 0, MBEDTLS_ECP_DP_NONE, 0, 0 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006334};
6335
Gilles Peskine449bd832023-01-11 14:50:10 +01006336int mbedtls_ssl_get_psa_curve_info_from_tls_id(uint16_t tls_id,
Przemek Stekielda4fba62023-06-02 14:52:28 +02006337 psa_key_type_t *type,
Gilles Peskine449bd832023-01-11 14:50:10 +01006338 size_t *bits)
Valerio Setti18c9fed2022-12-30 17:44:24 +01006339{
Gilles Peskine449bd832023-01-11 14:50:10 +01006340 for (int i = 0; tls_id_match_table[i].tls_id != 0; i++) {
6341 if (tls_id_match_table[i].tls_id == tls_id) {
Przemek Stekielda4fba62023-06-02 14:52:28 +02006342 if (type != NULL) {
6343 *type = PSA_KEY_TYPE_ECC_KEY_PAIR(tls_id_match_table[i].psa_family);
Gilles Peskine449bd832023-01-11 14:50:10 +01006344 }
6345 if (bits != NULL) {
Valerio Setti18c9fed2022-12-30 17:44:24 +01006346 *bits = tls_id_match_table[i].bits;
Gilles Peskine449bd832023-01-11 14:50:10 +01006347 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01006348 return PSA_SUCCESS;
6349 }
6350 }
6351
6352 return PSA_ERROR_NOT_SUPPORTED;
6353}
6354
Gilles Peskine449bd832023-01-11 14:50:10 +01006355mbedtls_ecp_group_id mbedtls_ssl_get_ecp_group_id_from_tls_id(uint16_t tls_id)
Valerio Setti18c9fed2022-12-30 17:44:24 +01006356{
Gilles Peskine449bd832023-01-11 14:50:10 +01006357 for (int i = 0; tls_id_match_table[i].tls_id != 0; i++) {
6358 if (tls_id_match_table[i].tls_id == tls_id) {
Valerio Setti18c9fed2022-12-30 17:44:24 +01006359 return tls_id_match_table[i].ecp_group_id;
Gilles Peskine449bd832023-01-11 14:50:10 +01006360 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01006361 }
6362
6363 return MBEDTLS_ECP_DP_NONE;
6364}
6365
Gilles Peskine449bd832023-01-11 14:50:10 +01006366uint16_t mbedtls_ssl_get_tls_id_from_ecp_group_id(mbedtls_ecp_group_id grp_id)
Valerio Setti18c9fed2022-12-30 17:44:24 +01006367{
Gilles Peskine449bd832023-01-11 14:50:10 +01006368 for (int i = 0; tls_id_match_table[i].ecp_group_id != MBEDTLS_ECP_DP_NONE;
6369 i++) {
6370 if (tls_id_match_table[i].ecp_group_id == grp_id) {
Valerio Setti18c9fed2022-12-30 17:44:24 +01006371 return tls_id_match_table[i].tls_id;
Gilles Peskine449bd832023-01-11 14:50:10 +01006372 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01006373 }
6374
6375 return 0;
6376}
6377
Valerio Setti67419f02023-01-04 16:12:42 +01006378#if defined(MBEDTLS_DEBUG_C)
Valerio Settiacd32c02023-06-29 18:06:29 +02006379static const struct {
6380 uint16_t tls_id;
6381 const char *name;
6382} tls_id_curve_name_table[] =
6383{
Valerio Setti54e23792023-07-07 10:49:27 +02006384 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP521R1, "secp521r1" },
6385 { MBEDTLS_SSL_IANA_TLS_GROUP_BP512R1, "brainpoolP512r1" },
6386 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1, "secp384r1" },
6387 { MBEDTLS_SSL_IANA_TLS_GROUP_BP384R1, "brainpoolP384r1" },
6388 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1, "secp256r1" },
6389 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP256K1, "secp256k1" },
6390 { MBEDTLS_SSL_IANA_TLS_GROUP_BP256R1, "brainpoolP256r1" },
6391 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP224R1, "secp224r1" },
6392 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP224K1, "secp224k1" },
6393 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP192R1, "secp192r1" },
6394 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP192K1, "secp192k1" },
6395 { MBEDTLS_SSL_IANA_TLS_GROUP_X25519, "x25519" },
6396 { MBEDTLS_SSL_IANA_TLS_GROUP_X448, "x448" },
Valerio Settiacd32c02023-06-29 18:06:29 +02006397 { 0, NULL },
6398};
6399
Gilles Peskine449bd832023-01-11 14:50:10 +01006400const char *mbedtls_ssl_get_curve_name_from_tls_id(uint16_t tls_id)
Valerio Setti18c9fed2022-12-30 17:44:24 +01006401{
Valerio Settiacd32c02023-06-29 18:06:29 +02006402 for (int i = 0; tls_id_curve_name_table[i].tls_id != 0; i++) {
6403 if (tls_id_curve_name_table[i].tls_id == tls_id) {
6404 return tls_id_curve_name_table[i].name;
Gilles Peskine449bd832023-01-11 14:50:10 +01006405 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01006406 }
6407
6408 return NULL;
6409}
Valerio Setti67419f02023-01-04 16:12:42 +01006410#endif
Valerio Setti18c9fed2022-12-30 17:44:24 +01006411
Jerry Yu148165c2021-09-24 23:20:59 +08006412#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01006413int mbedtls_ssl_get_handshake_transcript(mbedtls_ssl_context *ssl,
6414 const mbedtls_md_type_t md,
6415 unsigned char *dst,
6416 size_t dst_len,
6417 size_t *olen)
Jerry Yu148165c2021-09-24 23:20:59 +08006418{
Ronald Cronf6893e12022-01-07 22:09:01 +01006419 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
6420 psa_hash_operation_t *hash_operation_to_clone;
6421 psa_hash_operation_t hash_operation = psa_hash_operation_init();
6422
Jerry Yu148165c2021-09-24 23:20:59 +08006423 *olen = 0;
Ronald Cronf6893e12022-01-07 22:09:01 +01006424
Gilles Peskine449bd832023-01-11 14:50:10 +01006425 switch (md) {
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006426#if defined(MBEDTLS_MD_CAN_SHA384)
Gilles Peskine449bd832023-01-11 14:50:10 +01006427 case MBEDTLS_MD_SHA384:
6428 hash_operation_to_clone = &ssl->handshake->fin_sha384_psa;
6429 break;
Ronald Cronf6893e12022-01-07 22:09:01 +01006430#endif
6431
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006432#if defined(MBEDTLS_MD_CAN_SHA256)
Gilles Peskine449bd832023-01-11 14:50:10 +01006433 case MBEDTLS_MD_SHA256:
6434 hash_operation_to_clone = &ssl->handshake->fin_sha256_psa;
6435 break;
Ronald Cronf6893e12022-01-07 22:09:01 +01006436#endif
6437
Gilles Peskine449bd832023-01-11 14:50:10 +01006438 default:
6439 goto exit;
6440 }
6441
6442 status = psa_hash_clone(hash_operation_to_clone, &hash_operation);
6443 if (status != PSA_SUCCESS) {
Ronald Cronf6893e12022-01-07 22:09:01 +01006444 goto exit;
6445 }
6446
Gilles Peskine449bd832023-01-11 14:50:10 +01006447 status = psa_hash_finish(&hash_operation, dst, dst_len, olen);
6448 if (status != PSA_SUCCESS) {
Ronald Cronf6893e12022-01-07 22:09:01 +01006449 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006450 }
Ronald Cronf6893e12022-01-07 22:09:01 +01006451
6452exit:
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006453#if !defined(MBEDTLS_MD_CAN_SHA384) && \
6454 !defined(MBEDTLS_MD_CAN_SHA256)
Andrzej Kurekeabeb302022-10-17 07:52:51 -04006455 (void) ssl;
6456#endif
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05006457 return PSA_TO_MBEDTLS_ERR(status);
Jerry Yu148165c2021-09-24 23:20:59 +08006458}
6459#else /* MBEDTLS_USE_PSA_CRYPTO */
6460
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006461#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006462MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006463static int ssl_get_handshake_transcript_sha384(mbedtls_ssl_context *ssl,
6464 unsigned char *dst,
6465 size_t dst_len,
6466 size_t *olen)
Jerry Yu24c0ec32021-09-09 14:21:07 +08006467{
Jerry Yu24c0ec32021-09-09 14:21:07 +08006468 int ret;
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01006469 mbedtls_md_context_t sha384;
Jerry Yu24c0ec32021-09-09 14:21:07 +08006470
Gilles Peskine449bd832023-01-11 14:50:10 +01006471 if (dst_len < 48) {
6472 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
6473 }
Jerry Yu24c0ec32021-09-09 14:21:07 +08006474
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01006475 mbedtls_md_init(&sha384);
6476 ret = mbedtls_md_setup(&sha384, mbedtls_md_info_from_type(MBEDTLS_MD_SHA384), 0);
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01006477 if (ret != 0) {
6478 goto exit;
6479 }
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01006480 ret = mbedtls_md_clone(&sha384, &ssl->handshake->fin_sha384);
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01006481 if (ret != 0) {
6482 goto exit;
6483 }
Jerry Yu24c0ec32021-09-09 14:21:07 +08006484
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01006485 if ((ret = mbedtls_md_finish(&sha384, dst)) != 0) {
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01006486 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_finish", ret);
Jerry Yu24c0ec32021-09-09 14:21:07 +08006487 goto exit;
6488 }
6489
6490 *olen = 48;
6491
6492exit:
6493
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01006494 mbedtls_md_free(&sha384);
Gilles Peskine449bd832023-01-11 14:50:10 +01006495 return ret;
Jerry Yu24c0ec32021-09-09 14:21:07 +08006496}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006497#endif /* MBEDTLS_MD_CAN_SHA384 */
Jerry Yu24c0ec32021-09-09 14:21:07 +08006498
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006499#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006500MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006501static int ssl_get_handshake_transcript_sha256(mbedtls_ssl_context *ssl,
6502 unsigned char *dst,
6503 size_t dst_len,
6504 size_t *olen)
Jerry Yu24c0ec32021-09-09 14:21:07 +08006505{
Jerry Yu24c0ec32021-09-09 14:21:07 +08006506 int ret;
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01006507 mbedtls_md_context_t sha256;
Jerry Yu24c0ec32021-09-09 14:21:07 +08006508
Gilles Peskine449bd832023-01-11 14:50:10 +01006509 if (dst_len < 32) {
6510 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
6511 }
Jerry Yu24c0ec32021-09-09 14:21:07 +08006512
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01006513 mbedtls_md_init(&sha256);
6514 ret = mbedtls_md_setup(&sha256, mbedtls_md_info_from_type(MBEDTLS_MD_SHA256), 0);
6515 if (ret != 0) {
6516 goto exit;
6517 }
6518 ret = mbedtls_md_clone(&sha256, &ssl->handshake->fin_sha256);
6519 if (ret != 0) {
6520 goto exit;
6521 }
Jerry Yuc5aef882021-12-23 20:15:02 +08006522
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01006523 if ((ret = mbedtls_md_finish(&sha256, dst)) != 0) {
6524 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_finish", ret);
Jerry Yu24c0ec32021-09-09 14:21:07 +08006525 goto exit;
6526 }
6527
6528 *olen = 32;
6529
6530exit:
6531
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01006532 mbedtls_md_free(&sha256);
Gilles Peskine449bd832023-01-11 14:50:10 +01006533 return ret;
Jerry Yu24c0ec32021-09-09 14:21:07 +08006534}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006535#endif /* MBEDTLS_MD_CAN_SHA256 */
Jerry Yu24c0ec32021-09-09 14:21:07 +08006536
Gilles Peskine449bd832023-01-11 14:50:10 +01006537int mbedtls_ssl_get_handshake_transcript(mbedtls_ssl_context *ssl,
6538 const mbedtls_md_type_t md,
6539 unsigned char *dst,
6540 size_t dst_len,
6541 size_t *olen)
Jerry Yu24c0ec32021-09-09 14:21:07 +08006542{
Gilles Peskine449bd832023-01-11 14:50:10 +01006543 switch (md) {
Jerry Yuc1ddeef2021-10-08 15:14:45 +08006544
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006545#if defined(MBEDTLS_MD_CAN_SHA384)
Gilles Peskine449bd832023-01-11 14:50:10 +01006546 case MBEDTLS_MD_SHA384:
6547 return ssl_get_handshake_transcript_sha384(ssl, dst, dst_len, olen);
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006548#endif /* MBEDTLS_MD_CAN_SHA384*/
Jerry Yuc1ddeef2021-10-08 15:14:45 +08006549
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006550#if defined(MBEDTLS_MD_CAN_SHA256)
Gilles Peskine449bd832023-01-11 14:50:10 +01006551 case MBEDTLS_MD_SHA256:
6552 return ssl_get_handshake_transcript_sha256(ssl, dst, dst_len, olen);
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006553#endif /* MBEDTLS_MD_CAN_SHA256*/
Jerry Yuc1ddeef2021-10-08 15:14:45 +08006554
Gilles Peskine449bd832023-01-11 14:50:10 +01006555 default:
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006556#if !defined(MBEDTLS_MD_CAN_SHA384) && \
6557 !defined(MBEDTLS_MD_CAN_SHA256)
Gilles Peskine449bd832023-01-11 14:50:10 +01006558 (void) ssl;
6559 (void) dst;
6560 (void) dst_len;
6561 (void) olen;
Andrzej Kurek409248a2022-10-24 10:33:21 -04006562#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01006563 break;
Jerry Yuc1ddeef2021-10-08 15:14:45 +08006564 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006565 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yu24c0ec32021-09-09 14:21:07 +08006566}
XiaokangQian647719a2021-12-07 09:16:29 +00006567
Jerry Yu148165c2021-09-24 23:20:59 +08006568#endif /* !MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu24c0ec32021-09-09 14:21:07 +08006569
Ronald Crone68ab4f2022-10-05 12:46:29 +02006570#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Gabor Mezei078e8032022-04-27 21:17:56 +02006571/* mbedtls_ssl_parse_sig_alg_ext()
6572 *
6573 * The `extension_data` field of signature algorithm contains a `SignatureSchemeList`
6574 * value (TLS 1.3 RFC8446):
6575 * enum {
6576 * ....
6577 * ecdsa_secp256r1_sha256( 0x0403 ),
6578 * ecdsa_secp384r1_sha384( 0x0503 ),
6579 * ecdsa_secp521r1_sha512( 0x0603 ),
6580 * ....
6581 * } SignatureScheme;
6582 *
6583 * struct {
6584 * SignatureScheme supported_signature_algorithms<2..2^16-2>;
6585 * } SignatureSchemeList;
6586 *
6587 * The `extension_data` field of signature algorithm contains a `SignatureAndHashAlgorithm`
6588 * value (TLS 1.2 RFC5246):
6589 * enum {
6590 * none(0), md5(1), sha1(2), sha224(3), sha256(4), sha384(5),
6591 * sha512(6), (255)
6592 * } HashAlgorithm;
6593 *
6594 * enum { anonymous(0), rsa(1), dsa(2), ecdsa(3), (255) }
6595 * SignatureAlgorithm;
6596 *
6597 * struct {
6598 * HashAlgorithm hash;
6599 * SignatureAlgorithm signature;
6600 * } SignatureAndHashAlgorithm;
6601 *
6602 * SignatureAndHashAlgorithm
6603 * supported_signature_algorithms<2..2^16-2>;
6604 *
6605 * The TLS 1.3 signature algorithm extension was defined to be a compatible
6606 * generalization of the TLS 1.2 signature algorithm extension.
6607 * `SignatureAndHashAlgorithm` field of TLS 1.2 can be represented by
6608 * `SignatureScheme` field of TLS 1.3
6609 *
6610 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006611int mbedtls_ssl_parse_sig_alg_ext(mbedtls_ssl_context *ssl,
6612 const unsigned char *buf,
6613 const unsigned char *end)
Gabor Mezei078e8032022-04-27 21:17:56 +02006614{
6615 const unsigned char *p = buf;
6616 size_t supported_sig_algs_len = 0;
6617 const unsigned char *supported_sig_algs_end;
6618 uint16_t sig_alg;
6619 uint32_t common_idx = 0;
6620
Gilles Peskine449bd832023-01-11 14:50:10 +01006621 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
6622 supported_sig_algs_len = MBEDTLS_GET_UINT16_BE(p, 0);
Gabor Mezei078e8032022-04-27 21:17:56 +02006623 p += 2;
6624
Gilles Peskine449bd832023-01-11 14:50:10 +01006625 memset(ssl->handshake->received_sig_algs, 0,
6626 sizeof(ssl->handshake->received_sig_algs));
Gabor Mezei078e8032022-04-27 21:17:56 +02006627
Gilles Peskine449bd832023-01-11 14:50:10 +01006628 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, supported_sig_algs_len);
Gabor Mezei078e8032022-04-27 21:17:56 +02006629 supported_sig_algs_end = p + supported_sig_algs_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01006630 while (p < supported_sig_algs_end) {
6631 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, supported_sig_algs_end, 2);
6632 sig_alg = MBEDTLS_GET_UINT16_BE(p, 0);
Gabor Mezei078e8032022-04-27 21:17:56 +02006633 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01006634 MBEDTLS_SSL_DEBUG_MSG(4, ("received signature algorithm: 0x%x %s",
6635 sig_alg,
6636 mbedtls_ssl_sig_alg_to_str(sig_alg)));
Jerry Yu2fe6c632022-06-29 10:02:38 +08006637#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01006638 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_2 &&
6639 (!(mbedtls_ssl_sig_alg_is_supported(ssl, sig_alg) &&
6640 mbedtls_ssl_sig_alg_is_offered(ssl, sig_alg)))) {
Gabor Mezei078e8032022-04-27 21:17:56 +02006641 continue;
Jerry Yu2fe6c632022-06-29 10:02:38 +08006642 }
6643#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gabor Mezei078e8032022-04-27 21:17:56 +02006644
Gilles Peskine449bd832023-01-11 14:50:10 +01006645 MBEDTLS_SSL_DEBUG_MSG(4, ("valid signature algorithm: %s",
6646 mbedtls_ssl_sig_alg_to_str(sig_alg)));
Gabor Mezei078e8032022-04-27 21:17:56 +02006647
Gilles Peskine449bd832023-01-11 14:50:10 +01006648 if (common_idx + 1 < MBEDTLS_RECEIVED_SIG_ALGS_SIZE) {
Gabor Mezei078e8032022-04-27 21:17:56 +02006649 ssl->handshake->received_sig_algs[common_idx] = sig_alg;
6650 common_idx += 1;
6651 }
6652 }
6653 /* Check that we consumed all the message. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006654 if (p != end) {
6655 MBEDTLS_SSL_DEBUG_MSG(1,
6656 ("Signature algorithms extension length misaligned"));
6657 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR,
6658 MBEDTLS_ERR_SSL_DECODE_ERROR);
6659 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Gabor Mezei078e8032022-04-27 21:17:56 +02006660 }
6661
Gilles Peskine449bd832023-01-11 14:50:10 +01006662 if (common_idx == 0) {
6663 MBEDTLS_SSL_DEBUG_MSG(3, ("no signature algorithm in common"));
6664 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE,
6665 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE);
6666 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Gabor Mezei078e8032022-04-27 21:17:56 +02006667 }
6668
Gabor Mezei15b95a62022-05-09 16:37:58 +02006669 ssl->handshake->received_sig_algs[common_idx] = MBEDTLS_TLS_SIG_NONE;
Gilles Peskine449bd832023-01-11 14:50:10 +01006670 return 0;
Gabor Mezei078e8032022-04-27 21:17:56 +02006671}
6672
Ronald Crone68ab4f2022-10-05 12:46:29 +02006673#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Gabor Mezei078e8032022-04-27 21:17:56 +02006674
Jerry Yudc7bd172022-02-17 13:44:15 +08006675#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
6676
6677#if defined(MBEDTLS_USE_PSA_CRYPTO)
6678
Gilles Peskine449bd832023-01-11 14:50:10 +01006679static psa_status_t setup_psa_key_derivation(psa_key_derivation_operation_t *derivation,
6680 mbedtls_svc_key_id_t key,
6681 psa_algorithm_t alg,
6682 const unsigned char *raw_psk, size_t raw_psk_length,
6683 const unsigned char *seed, size_t seed_length,
6684 const unsigned char *label, size_t label_length,
6685 const unsigned char *other_secret,
6686 size_t other_secret_length,
6687 size_t capacity)
Jerry Yudc7bd172022-02-17 13:44:15 +08006688{
6689 psa_status_t status;
6690
Gilles Peskine449bd832023-01-11 14:50:10 +01006691 status = psa_key_derivation_setup(derivation, alg);
6692 if (status != PSA_SUCCESS) {
6693 return status;
6694 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006695
Gilles Peskine449bd832023-01-11 14:50:10 +01006696 if (PSA_ALG_IS_TLS12_PRF(alg) || PSA_ALG_IS_TLS12_PSK_TO_MS(alg)) {
6697 status = psa_key_derivation_input_bytes(derivation,
6698 PSA_KEY_DERIVATION_INPUT_SEED,
6699 seed, seed_length);
6700 if (status != PSA_SUCCESS) {
6701 return status;
Przemek Stekiel1f027032022-04-05 17:12:11 +02006702 }
6703
Gilles Peskine449bd832023-01-11 14:50:10 +01006704 if (other_secret != NULL) {
6705 status = psa_key_derivation_input_bytes(derivation,
6706 PSA_KEY_DERIVATION_INPUT_OTHER_SECRET,
6707 other_secret, other_secret_length);
6708 if (status != PSA_SUCCESS) {
6709 return status;
6710 }
6711 }
6712
6713 if (mbedtls_svc_key_id_is_null(key)) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006714 status = psa_key_derivation_input_bytes(
6715 derivation, PSA_KEY_DERIVATION_INPUT_SECRET,
Gilles Peskine449bd832023-01-11 14:50:10 +01006716 raw_psk, raw_psk_length);
6717 } else {
Jerry Yudc7bd172022-02-17 13:44:15 +08006718 status = psa_key_derivation_input_key(
Gilles Peskine449bd832023-01-11 14:50:10 +01006719 derivation, PSA_KEY_DERIVATION_INPUT_SECRET, key);
Jerry Yudc7bd172022-02-17 13:44:15 +08006720 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006721 if (status != PSA_SUCCESS) {
6722 return status;
6723 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006724
Gilles Peskine449bd832023-01-11 14:50:10 +01006725 status = psa_key_derivation_input_bytes(derivation,
6726 PSA_KEY_DERIVATION_INPUT_LABEL,
6727 label, label_length);
6728 if (status != PSA_SUCCESS) {
6729 return status;
6730 }
6731 } else {
6732 return PSA_ERROR_NOT_SUPPORTED;
Jerry Yudc7bd172022-02-17 13:44:15 +08006733 }
6734
Gilles Peskine449bd832023-01-11 14:50:10 +01006735 status = psa_key_derivation_set_capacity(derivation, capacity);
6736 if (status != PSA_SUCCESS) {
6737 return status;
6738 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006739
Gilles Peskine449bd832023-01-11 14:50:10 +01006740 return PSA_SUCCESS;
Jerry Yudc7bd172022-02-17 13:44:15 +08006741}
6742
Andrzej Kurek57d10632022-10-24 10:32:01 -04006743#if defined(PSA_WANT_ALG_SHA_384) || \
6744 defined(PSA_WANT_ALG_SHA_256)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006745MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006746static int tls_prf_generic(mbedtls_md_type_t md_type,
6747 const unsigned char *secret, size_t slen,
6748 const char *label,
6749 const unsigned char *random, size_t rlen,
6750 unsigned char *dstbuf, size_t dlen)
Jerry Yudc7bd172022-02-17 13:44:15 +08006751{
6752 psa_status_t status;
6753 psa_algorithm_t alg;
6754 mbedtls_svc_key_id_t master_key = MBEDTLS_SVC_KEY_ID_INIT;
6755 psa_key_derivation_operation_t derivation =
6756 PSA_KEY_DERIVATION_OPERATION_INIT;
6757
Gilles Peskine449bd832023-01-11 14:50:10 +01006758 if (md_type == MBEDTLS_MD_SHA384) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006759 alg = PSA_ALG_TLS12_PRF(PSA_ALG_SHA_384);
Gilles Peskine449bd832023-01-11 14:50:10 +01006760 } else {
Jerry Yudc7bd172022-02-17 13:44:15 +08006761 alg = PSA_ALG_TLS12_PRF(PSA_ALG_SHA_256);
Gilles Peskine449bd832023-01-11 14:50:10 +01006762 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006763
6764 /* Normally a "secret" should be long enough to be impossible to
6765 * find by brute force, and in particular should not be empty. But
6766 * this PRF is also used to derive an IV, in particular in EAP-TLS,
6767 * and for this use case it makes sense to have a 0-length "secret".
6768 * Since the key API doesn't allow importing a key of length 0,
6769 * keep master_key=0, which setup_psa_key_derivation() understands
6770 * to mean a 0-length "secret" input. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006771 if (slen != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006772 psa_key_attributes_t key_attributes = psa_key_attributes_init();
Gilles Peskine449bd832023-01-11 14:50:10 +01006773 psa_set_key_usage_flags(&key_attributes, PSA_KEY_USAGE_DERIVE);
6774 psa_set_key_algorithm(&key_attributes, alg);
6775 psa_set_key_type(&key_attributes, PSA_KEY_TYPE_DERIVE);
Jerry Yudc7bd172022-02-17 13:44:15 +08006776
Gilles Peskine449bd832023-01-11 14:50:10 +01006777 status = psa_import_key(&key_attributes, secret, slen, &master_key);
6778 if (status != PSA_SUCCESS) {
6779 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
6780 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006781 }
6782
Gilles Peskine449bd832023-01-11 14:50:10 +01006783 status = setup_psa_key_derivation(&derivation,
6784 master_key, alg,
6785 NULL, 0,
6786 random, rlen,
6787 (unsigned char const *) label,
6788 (size_t) strlen(label),
6789 NULL, 0,
6790 dlen);
6791 if (status != PSA_SUCCESS) {
6792 psa_key_derivation_abort(&derivation);
6793 psa_destroy_key(master_key);
6794 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yudc7bd172022-02-17 13:44:15 +08006795 }
6796
Gilles Peskine449bd832023-01-11 14:50:10 +01006797 status = psa_key_derivation_output_bytes(&derivation, dstbuf, dlen);
6798 if (status != PSA_SUCCESS) {
6799 psa_key_derivation_abort(&derivation);
6800 psa_destroy_key(master_key);
6801 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yudc7bd172022-02-17 13:44:15 +08006802 }
6803
Gilles Peskine449bd832023-01-11 14:50:10 +01006804 status = psa_key_derivation_abort(&derivation);
6805 if (status != PSA_SUCCESS) {
6806 psa_destroy_key(master_key);
6807 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yudc7bd172022-02-17 13:44:15 +08006808 }
6809
Gilles Peskine449bd832023-01-11 14:50:10 +01006810 if (!mbedtls_svc_key_id_is_null(master_key)) {
6811 status = psa_destroy_key(master_key);
6812 }
6813 if (status != PSA_SUCCESS) {
6814 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
6815 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006816
Gilles Peskine449bd832023-01-11 14:50:10 +01006817 return 0;
Jerry Yudc7bd172022-02-17 13:44:15 +08006818}
Andrzej Kurek57d10632022-10-24 10:32:01 -04006819#endif /* PSA_WANT_ALG_SHA_256 || PSA_WANT_ALG_SHA_384 */
Jerry Yudc7bd172022-02-17 13:44:15 +08006820#else /* MBEDTLS_USE_PSA_CRYPTO */
6821
Andrzej Kurek57d10632022-10-24 10:32:01 -04006822#if defined(MBEDTLS_MD_C) && \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006823 (defined(MBEDTLS_MD_CAN_SHA256) || \
6824 defined(MBEDTLS_MD_CAN_SHA384))
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006825MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006826static int tls_prf_generic(mbedtls_md_type_t md_type,
6827 const unsigned char *secret, size_t slen,
6828 const char *label,
6829 const unsigned char *random, size_t rlen,
6830 unsigned char *dstbuf, size_t dlen)
Jerry Yudc7bd172022-02-17 13:44:15 +08006831{
6832 size_t nb;
6833 size_t i, j, k, md_len;
6834 unsigned char *tmp;
6835 size_t tmp_len = 0;
6836 unsigned char h_i[MBEDTLS_MD_MAX_SIZE];
6837 const mbedtls_md_info_t *md_info;
6838 mbedtls_md_context_t md_ctx;
6839 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6840
Gilles Peskine449bd832023-01-11 14:50:10 +01006841 mbedtls_md_init(&md_ctx);
Jerry Yudc7bd172022-02-17 13:44:15 +08006842
Gilles Peskine449bd832023-01-11 14:50:10 +01006843 if ((md_info = mbedtls_md_info_from_type(md_type)) == NULL) {
6844 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
6845 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006846
Gilles Peskine449bd832023-01-11 14:50:10 +01006847 md_len = mbedtls_md_get_size(md_info);
Jerry Yudc7bd172022-02-17 13:44:15 +08006848
Gilles Peskine449bd832023-01-11 14:50:10 +01006849 tmp_len = md_len + strlen(label) + rlen;
6850 tmp = mbedtls_calloc(1, tmp_len);
6851 if (tmp == NULL) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006852 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
6853 goto exit;
6854 }
6855
Gilles Peskine449bd832023-01-11 14:50:10 +01006856 nb = strlen(label);
6857 memcpy(tmp + md_len, label, nb);
6858 memcpy(tmp + md_len + nb, random, rlen);
Jerry Yudc7bd172022-02-17 13:44:15 +08006859 nb += rlen;
6860
6861 /*
6862 * Compute P_<hash>(secret, label + random)[0..dlen]
6863 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006864 if ((ret = mbedtls_md_setup(&md_ctx, md_info, 1)) != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006865 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006866 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006867
Gilles Peskine449bd832023-01-11 14:50:10 +01006868 ret = mbedtls_md_hmac_starts(&md_ctx, secret, slen);
6869 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006870 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006871 }
6872 ret = mbedtls_md_hmac_update(&md_ctx, tmp + md_len, nb);
6873 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006874 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006875 }
6876 ret = mbedtls_md_hmac_finish(&md_ctx, tmp);
6877 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006878 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006879 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006880
Gilles Peskine449bd832023-01-11 14:50:10 +01006881 for (i = 0; i < dlen; i += md_len) {
6882 ret = mbedtls_md_hmac_reset(&md_ctx);
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, h_i);
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 ret = mbedtls_md_hmac_reset(&md_ctx);
6896 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006897 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006898 }
6899 ret = mbedtls_md_hmac_update(&md_ctx, tmp, md_len);
6900 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006901 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006902 }
6903 ret = mbedtls_md_hmac_finish(&md_ctx, tmp);
6904 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006905 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006906 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006907
Gilles Peskine449bd832023-01-11 14:50:10 +01006908 k = (i + md_len > dlen) ? dlen % md_len : md_len;
Jerry Yudc7bd172022-02-17 13:44:15 +08006909
Gilles Peskine449bd832023-01-11 14:50:10 +01006910 for (j = 0; j < k; j++) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006911 dstbuf[i + j] = h_i[j];
Gilles Peskine449bd832023-01-11 14:50:10 +01006912 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006913 }
6914
6915exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01006916 mbedtls_md_free(&md_ctx);
Jerry Yudc7bd172022-02-17 13:44:15 +08006917
Gilles Peskine449bd832023-01-11 14:50:10 +01006918 if (tmp != NULL) {
6919 mbedtls_platform_zeroize(tmp, tmp_len);
6920 }
Dave Rodgman29b9b2b2022-11-01 16:08:14 +00006921
Gilles Peskine449bd832023-01-11 14:50:10 +01006922 mbedtls_platform_zeroize(h_i, sizeof(h_i));
Jerry Yudc7bd172022-02-17 13:44:15 +08006923
Gilles Peskine449bd832023-01-11 14:50:10 +01006924 mbedtls_free(tmp);
Jerry Yudc7bd172022-02-17 13:44:15 +08006925
Gilles Peskine449bd832023-01-11 14:50:10 +01006926 return ret;
Jerry Yudc7bd172022-02-17 13:44:15 +08006927}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006928#endif /* MBEDTLS_MD_C && ( MBEDTLS_MD_CAN_SHA256 || MBEDTLS_MD_CAN_SHA384 ) */
Jerry Yudc7bd172022-02-17 13:44:15 +08006929#endif /* MBEDTLS_USE_PSA_CRYPTO */
6930
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006931#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006932MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006933static int tls_prf_sha256(const unsigned char *secret, size_t slen,
6934 const char *label,
6935 const unsigned char *random, size_t rlen,
6936 unsigned char *dstbuf, size_t dlen)
Jerry Yudc7bd172022-02-17 13:44:15 +08006937{
Gilles Peskine449bd832023-01-11 14:50:10 +01006938 return tls_prf_generic(MBEDTLS_MD_SHA256, secret, slen,
6939 label, random, rlen, dstbuf, dlen);
Jerry Yudc7bd172022-02-17 13:44:15 +08006940}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006941#endif /* MBEDTLS_MD_CAN_SHA256*/
Jerry Yudc7bd172022-02-17 13:44:15 +08006942
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006943#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006944MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006945static int tls_prf_sha384(const unsigned char *secret, size_t slen,
6946 const char *label,
6947 const unsigned char *random, size_t rlen,
6948 unsigned char *dstbuf, size_t dlen)
Jerry Yudc7bd172022-02-17 13:44:15 +08006949{
Gilles Peskine449bd832023-01-11 14:50:10 +01006950 return tls_prf_generic(MBEDTLS_MD_SHA384, secret, slen,
6951 label, random, rlen, dstbuf, dlen);
Jerry Yudc7bd172022-02-17 13:44:15 +08006952}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006953#endif /* MBEDTLS_MD_CAN_SHA384*/
Jerry Yudc7bd172022-02-17 13:44:15 +08006954
Jerry Yuf009d862022-02-17 14:01:37 +08006955/*
6956 * Set appropriate PRF function and other SSL / TLS1.2 functions
6957 *
6958 * Inputs:
Jerry Yuf009d862022-02-17 14:01:37 +08006959 * - hash associated with the ciphersuite (only used by TLS 1.2)
6960 *
6961 * Outputs:
6962 * - the tls_prf, calc_verify and calc_finished members of handshake structure
6963 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006964MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006965static int ssl_set_handshake_prfs(mbedtls_ssl_handshake_params *handshake,
6966 mbedtls_md_type_t hash)
Jerry Yuf009d862022-02-17 14:01:37 +08006967{
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006968#if defined(MBEDTLS_MD_CAN_SHA384)
Gilles Peskine449bd832023-01-11 14:50:10 +01006969 if (hash == MBEDTLS_MD_SHA384) {
Jerry Yuf009d862022-02-17 14:01:37 +08006970 handshake->tls_prf = tls_prf_sha384;
6971 handshake->calc_verify = ssl_calc_verify_tls_sha384;
6972 handshake->calc_finished = ssl_calc_finished_tls_sha384;
Gilles Peskine449bd832023-01-11 14:50:10 +01006973 } else
Jerry Yuf009d862022-02-17 14:01:37 +08006974#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006975#if defined(MBEDTLS_MD_CAN_SHA256)
Jerry Yuf009d862022-02-17 14:01:37 +08006976 {
Ronald Cron81591aa2022-03-07 09:05:51 +01006977 (void) hash;
Jerry Yuf009d862022-02-17 14:01:37 +08006978 handshake->tls_prf = tls_prf_sha256;
6979 handshake->calc_verify = ssl_calc_verify_tls_sha256;
6980 handshake->calc_finished = ssl_calc_finished_tls_sha256;
6981 }
Ronald Cron81591aa2022-03-07 09:05:51 +01006982#else
Jerry Yuf009d862022-02-17 14:01:37 +08006983 {
Jerry Yuf009d862022-02-17 14:01:37 +08006984 (void) handshake;
Ronald Cron81591aa2022-03-07 09:05:51 +01006985 (void) hash;
Gilles Peskine449bd832023-01-11 14:50:10 +01006986 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yuf009d862022-02-17 14:01:37 +08006987 }
Ronald Cron81591aa2022-03-07 09:05:51 +01006988#endif
Jerry Yuf009d862022-02-17 14:01:37 +08006989
Gilles Peskine449bd832023-01-11 14:50:10 +01006990 return 0;
Jerry Yuf009d862022-02-17 14:01:37 +08006991}
Jerry Yud6ab2352022-02-17 14:03:43 +08006992
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006993/*
6994 * Compute master secret if needed
6995 *
6996 * Parameters:
6997 * [in/out] handshake
6998 * [in] resume, premaster, extended_ms, calc_verify, tls_prf
6999 * (PSA-PSK) ciphersuite_info, psk_opaque
7000 * [out] premaster (cleared)
7001 * [out] master
7002 * [in] ssl: optionally used for debugging, EMS and PSA-PSK
7003 * debug: conf->f_dbg, conf->p_dbg
7004 * EMS: passed to calc_verify (debug + session_negotiate)
Ronald Crona25cf582022-03-07 11:10:36 +01007005 * PSA-PSA: conf
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007006 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007007MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007008static int ssl_compute_master(mbedtls_ssl_handshake_params *handshake,
7009 unsigned char *master,
7010 const mbedtls_ssl_context *ssl)
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007011{
7012 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7013
7014 /* cf. RFC 5246, Section 8.1:
7015 * "The master secret is always exactly 48 bytes in length." */
7016 size_t const master_secret_len = 48;
7017
7018#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
7019 unsigned char session_hash[48];
7020#endif /* MBEDTLS_SSL_EXTENDED_MASTER_SECRET */
7021
7022 /* The label for the KDF used for key expansion.
7023 * This is either "master secret" or "extended master secret"
7024 * depending on whether the Extended Master Secret extension
7025 * is used. */
7026 char const *lbl = "master secret";
7027
Przemek Stekielae4ed302022-04-05 17:15:55 +02007028 /* The seed for the KDF used for key expansion.
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007029 * - If the Extended Master Secret extension is not used,
7030 * this is ClientHello.Random + ServerHello.Random
7031 * (see Sect. 8.1 in RFC 5246).
7032 * - If the Extended Master Secret extension is used,
7033 * this is the transcript of the handshake so far.
7034 * (see Sect. 4 in RFC 7627). */
Przemek Stekielae4ed302022-04-05 17:15:55 +02007035 unsigned char const *seed = handshake->randbytes;
7036 size_t seed_len = 64;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007037
7038#if !defined(MBEDTLS_DEBUG_C) && \
7039 !defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET) && \
7040 !(defined(MBEDTLS_USE_PSA_CRYPTO) && \
Gilles Peskine449bd832023-01-11 14:50:10 +01007041 defined(MBEDTLS_KEY_EXCHANGE_PSK_ENABLED))
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007042 ssl = NULL; /* make sure we don't use it except for those cases */
7043 (void) ssl;
7044#endif
7045
Gilles Peskine449bd832023-01-11 14:50:10 +01007046 if (handshake->resume != 0) {
7047 MBEDTLS_SSL_DEBUG_MSG(3, ("no premaster (session resumed)"));
7048 return 0;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007049 }
7050
7051#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
Gilles Peskine449bd832023-01-11 14:50:10 +01007052 if (handshake->extended_ms == MBEDTLS_SSL_EXTENDED_MS_ENABLED) {
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007053 lbl = "extended master secret";
Przemek Stekielae4ed302022-04-05 17:15:55 +02007054 seed = session_hash;
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01007055 ret = handshake->calc_verify(ssl, session_hash, &seed_len);
7056 if (ret != 0) {
7057 MBEDTLS_SSL_DEBUG_RET(1, "calc_verify", ret);
7058 }
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007059
Gilles Peskine449bd832023-01-11 14:50:10 +01007060 MBEDTLS_SSL_DEBUG_BUF(3, "session hash for extended master secret",
7061 session_hash, seed_len);
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007062 }
Przemek Stekiel169bf0b2022-04-29 07:53:29 +02007063#endif /* MBEDTLS_SSL_EXTENDED_MASTER_SECRET */
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007064
Przemek Stekiel99114f32022-04-22 11:20:09 +02007065#if defined(MBEDTLS_USE_PSA_CRYPTO) && \
Przemek Stekiel8a4b7fd2022-04-28 09:22:22 +02007066 defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007067 if (mbedtls_ssl_ciphersuite_uses_psk(handshake->ciphersuite_info) == 1) {
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007068 /* Perform PSK-to-MS expansion in a single step. */
7069 psa_status_t status;
7070 psa_algorithm_t alg;
7071 mbedtls_svc_key_id_t psk;
7072 psa_key_derivation_operation_t derivation =
7073 PSA_KEY_DERIVATION_OPERATION_INIT;
Dave Rodgman2eab4622023-10-05 13:30:37 +01007074 mbedtls_md_type_t hash_alg = (mbedtls_md_type_t) handshake->ciphersuite_info->mac;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007075
Gilles Peskine449bd832023-01-11 14:50:10 +01007076 MBEDTLS_SSL_DEBUG_MSG(2, ("perform PSA-based PSK-to-MS expansion"));
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007077
Gilles Peskine449bd832023-01-11 14:50:10 +01007078 psk = mbedtls_ssl_get_opaque_psk(ssl);
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007079
Gilles Peskine449bd832023-01-11 14:50:10 +01007080 if (hash_alg == MBEDTLS_MD_SHA384) {
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007081 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_384);
Gilles Peskine449bd832023-01-11 14:50:10 +01007082 } else {
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007083 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_256);
Gilles Peskine449bd832023-01-11 14:50:10 +01007084 }
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007085
Przemek Stekiel51a1f362022-04-13 08:57:06 +02007086 size_t other_secret_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01007087 unsigned char *other_secret = NULL;
Przemek Stekielc2033402022-04-05 17:19:41 +02007088
Gilles Peskine449bd832023-01-11 14:50:10 +01007089 switch (handshake->ciphersuite_info->key_exchange) {
Przemek Stekiel19b80f82022-04-14 08:29:31 +02007090 /* Provide other secret.
Przemek Stekiel51a1f362022-04-13 08:57:06 +02007091 * Other secret is stored in premaster, where first 2 bytes hold the
Przemek Stekiel19b80f82022-04-14 08:29:31 +02007092 * length of the other key.
Przemek Stekielc2033402022-04-05 17:19:41 +02007093 */
Przemek Stekiel19b80f82022-04-14 08:29:31 +02007094 case MBEDTLS_KEY_EXCHANGE_RSA_PSK:
Przemek Stekiel8abcee92022-04-28 09:16:28 +02007095 /* For RSA-PSK other key length is always 48 bytes. */
Przemek Stekiel19b80f82022-04-14 08:29:31 +02007096 other_secret_len = 48;
7097 other_secret = handshake->premaster + 2;
7098 break;
7099 case MBEDTLS_KEY_EXCHANGE_ECDHE_PSK:
Przemek Stekielb293aaa2022-04-19 12:22:38 +02007100 case MBEDTLS_KEY_EXCHANGE_DHE_PSK:
Przemek Stekiel19b80f82022-04-14 08:29:31 +02007101 other_secret_len = MBEDTLS_GET_UINT16_BE(handshake->premaster, 0);
7102 other_secret = handshake->premaster + 2;
7103 break;
7104 default:
7105 break;
Przemek Stekielc2033402022-04-05 17:19:41 +02007106 }
7107
Gilles Peskine449bd832023-01-11 14:50:10 +01007108 status = setup_psa_key_derivation(&derivation, psk, alg,
7109 ssl->conf->psk, ssl->conf->psk_len,
7110 seed, seed_len,
7111 (unsigned char const *) lbl,
7112 (size_t) strlen(lbl),
7113 other_secret, other_secret_len,
7114 master_secret_len);
7115 if (status != PSA_SUCCESS) {
7116 psa_key_derivation_abort(&derivation);
7117 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007118 }
7119
Gilles Peskine449bd832023-01-11 14:50:10 +01007120 status = psa_key_derivation_output_bytes(&derivation,
7121 master,
7122 master_secret_len);
7123 if (status != PSA_SUCCESS) {
7124 psa_key_derivation_abort(&derivation);
7125 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007126 }
7127
Gilles Peskine449bd832023-01-11 14:50:10 +01007128 status = psa_key_derivation_abort(&derivation);
7129 if (status != PSA_SUCCESS) {
7130 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
7131 }
7132 } else
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007133#endif
7134 {
Neil Armstrongca7d5062022-05-31 14:43:23 +02007135#if defined(MBEDTLS_USE_PSA_CRYPTO) && \
Gilles Peskine449bd832023-01-11 14:50:10 +01007136 defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
7137 if (handshake->ciphersuite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_ECJPAKE) {
Neil Armstrongca7d5062022-05-31 14:43:23 +02007138 psa_status_t status;
7139 psa_algorithm_t alg = PSA_ALG_TLS12_ECJPAKE_TO_PMS;
7140 psa_key_derivation_operation_t derivation =
7141 PSA_KEY_DERIVATION_OPERATION_INIT;
7142
Gilles Peskine449bd832023-01-11 14:50:10 +01007143 MBEDTLS_SSL_DEBUG_MSG(2, ("perform PSA-based PMS KDF for ECJPAKE"));
Neil Armstrongca7d5062022-05-31 14:43:23 +02007144
7145 handshake->pmslen = PSA_TLS12_ECJPAKE_TO_PMS_DATA_SIZE;
7146
Gilles Peskine449bd832023-01-11 14:50:10 +01007147 status = psa_key_derivation_setup(&derivation, alg);
7148 if (status != PSA_SUCCESS) {
7149 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Neil Armstrongca7d5062022-05-31 14:43:23 +02007150 }
7151
Gilles Peskine449bd832023-01-11 14:50:10 +01007152 status = psa_key_derivation_set_capacity(&derivation,
7153 PSA_TLS12_ECJPAKE_TO_PMS_DATA_SIZE);
7154 if (status != PSA_SUCCESS) {
7155 psa_key_derivation_abort(&derivation);
7156 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Neil Armstrongca7d5062022-05-31 14:43:23 +02007157 }
7158
Gilles Peskine449bd832023-01-11 14:50:10 +01007159 status = psa_pake_get_implicit_key(&handshake->psa_pake_ctx,
7160 &derivation);
7161 if (status != PSA_SUCCESS) {
7162 psa_key_derivation_abort(&derivation);
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_output_bytes(&derivation,
7167 handshake->premaster,
7168 handshake->pmslen);
7169 if (status != PSA_SUCCESS) {
7170 psa_key_derivation_abort(&derivation);
7171 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
7172 }
7173
7174 status = psa_key_derivation_abort(&derivation);
7175 if (status != PSA_SUCCESS) {
7176 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Neil Armstrongca7d5062022-05-31 14:43:23 +02007177 }
7178 }
7179#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01007180 ret = handshake->tls_prf(handshake->premaster, handshake->pmslen,
7181 lbl, seed, seed_len,
7182 master,
7183 master_secret_len);
7184 if (ret != 0) {
7185 MBEDTLS_SSL_DEBUG_RET(1, "prf", ret);
7186 return ret;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007187 }
7188
Gilles Peskine449bd832023-01-11 14:50:10 +01007189 MBEDTLS_SSL_DEBUG_BUF(3, "premaster secret",
7190 handshake->premaster,
7191 handshake->pmslen);
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007192
Gilles Peskine449bd832023-01-11 14:50:10 +01007193 mbedtls_platform_zeroize(handshake->premaster,
7194 sizeof(handshake->premaster));
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007195 }
7196
Gilles Peskine449bd832023-01-11 14:50:10 +01007197 return 0;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007198}
7199
Gilles Peskine449bd832023-01-11 14:50:10 +01007200int mbedtls_ssl_derive_keys(mbedtls_ssl_context *ssl)
Jerry Yud62f87e2022-02-17 14:09:02 +08007201{
7202 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7203 const mbedtls_ssl_ciphersuite_t * const ciphersuite_info =
7204 ssl->handshake->ciphersuite_info;
7205
Gilles Peskine449bd832023-01-11 14:50:10 +01007206 MBEDTLS_SSL_DEBUG_MSG(2, ("=> derive keys"));
Jerry Yud62f87e2022-02-17 14:09:02 +08007207
7208 /* Set PRF, calc_verify and calc_finished function pointers */
Gilles Peskine449bd832023-01-11 14:50:10 +01007209 ret = ssl_set_handshake_prfs(ssl->handshake,
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01007210 (mbedtls_md_type_t) ciphersuite_info->mac);
Gilles Peskine449bd832023-01-11 14:50:10 +01007211 if (ret != 0) {
7212 MBEDTLS_SSL_DEBUG_RET(1, "ssl_set_handshake_prfs", ret);
7213 return ret;
Jerry Yud62f87e2022-02-17 14:09:02 +08007214 }
7215
7216 /* Compute master secret if needed */
Gilles Peskine449bd832023-01-11 14:50:10 +01007217 ret = ssl_compute_master(ssl->handshake,
7218 ssl->session_negotiate->master,
7219 ssl);
7220 if (ret != 0) {
7221 MBEDTLS_SSL_DEBUG_RET(1, "ssl_compute_master", ret);
7222 return ret;
Jerry Yud62f87e2022-02-17 14:09:02 +08007223 }
7224
7225 /* Swap the client and server random values:
7226 * - MS derivation wanted client+server (RFC 5246 8.1)
7227 * - key derivation wants server+client (RFC 5246 6.3) */
7228 {
7229 unsigned char tmp[64];
Gilles Peskine449bd832023-01-11 14:50:10 +01007230 memcpy(tmp, ssl->handshake->randbytes, 64);
7231 memcpy(ssl->handshake->randbytes, tmp + 32, 32);
7232 memcpy(ssl->handshake->randbytes + 32, tmp, 32);
7233 mbedtls_platform_zeroize(tmp, sizeof(tmp));
Jerry Yud62f87e2022-02-17 14:09:02 +08007234 }
7235
7236 /* Populate transform structure */
Gilles Peskine449bd832023-01-11 14:50:10 +01007237 ret = ssl_tls12_populate_transform(ssl->transform_negotiate,
7238 ssl->session_negotiate->ciphersuite,
7239 ssl->session_negotiate->master,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02007240#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01007241 ssl->session_negotiate->encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02007242#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01007243 ssl->handshake->tls_prf,
7244 ssl->handshake->randbytes,
7245 ssl->tls_version,
7246 ssl->conf->endpoint,
7247 ssl);
7248 if (ret != 0) {
7249 MBEDTLS_SSL_DEBUG_RET(1, "ssl_tls12_populate_transform", ret);
7250 return ret;
Jerry Yud62f87e2022-02-17 14:09:02 +08007251 }
7252
7253 /* We no longer need Server/ClientHello.random values */
Gilles Peskine449bd832023-01-11 14:50:10 +01007254 mbedtls_platform_zeroize(ssl->handshake->randbytes,
7255 sizeof(ssl->handshake->randbytes));
Jerry Yud62f87e2022-02-17 14:09:02 +08007256
Gilles Peskine449bd832023-01-11 14:50:10 +01007257 MBEDTLS_SSL_DEBUG_MSG(2, ("<= derive keys"));
Jerry Yud62f87e2022-02-17 14:09:02 +08007258
Gilles Peskine449bd832023-01-11 14:50:10 +01007259 return 0;
Jerry Yud62f87e2022-02-17 14:09:02 +08007260}
Jerry Yu8392e0d2022-02-17 14:10:24 +08007261
Gilles Peskine449bd832023-01-11 14:50:10 +01007262int mbedtls_ssl_set_calc_verify_md(mbedtls_ssl_context *ssl, int md)
Ronald Cron4dcbca92022-03-07 10:21:40 +01007263{
Gilles Peskine449bd832023-01-11 14:50:10 +01007264 switch (md) {
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01007265#if defined(MBEDTLS_MD_CAN_SHA384)
Ronald Cron4dcbca92022-03-07 10:21:40 +01007266 case MBEDTLS_SSL_HASH_SHA384:
7267 ssl->handshake->calc_verify = ssl_calc_verify_tls_sha384;
7268 break;
7269#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01007270#if defined(MBEDTLS_MD_CAN_SHA256)
Ronald Cron4dcbca92022-03-07 10:21:40 +01007271 case MBEDTLS_SSL_HASH_SHA256:
7272 ssl->handshake->calc_verify = ssl_calc_verify_tls_sha256;
7273 break;
7274#endif
7275 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01007276 return -1;
Ronald Cron4dcbca92022-03-07 10:21:40 +01007277 }
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01007278#if !defined(MBEDTLS_MD_CAN_SHA384) && \
7279 !defined(MBEDTLS_MD_CAN_SHA256)
Andrzej Kurekeabeb302022-10-17 07:52:51 -04007280 (void) ssl;
7281#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01007282 return 0;
Ronald Cron4dcbca92022-03-07 10:21:40 +01007283}
7284
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007285#if defined(MBEDTLS_USE_PSA_CRYPTO)
7286static int ssl_calc_verify_tls_psa(const mbedtls_ssl_context *ssl,
7287 const psa_hash_operation_t *hs_op,
7288 size_t buffer_size,
7289 unsigned char *hash,
7290 size_t *hlen)
7291{
7292 psa_status_t status;
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007293 psa_hash_operation_t cloned_op = psa_hash_operation_init();
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007294
7295#if !defined(MBEDTLS_DEBUG_C)
7296 (void) ssl;
7297#endif
7298 MBEDTLS_SSL_DEBUG_MSG(2, ("=> PSA calc verify"));
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007299 status = psa_hash_clone(hs_op, &cloned_op);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007300 if (status != PSA_SUCCESS) {
7301 goto exit;
7302 }
7303
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007304 status = psa_hash_finish(&cloned_op, hash, buffer_size, hlen);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007305 if (status != PSA_SUCCESS) {
7306 goto exit;
7307 }
7308
7309 MBEDTLS_SSL_DEBUG_BUF(3, "PSA calculated verify result", hash, *hlen);
7310 MBEDTLS_SSL_DEBUG_MSG(2, ("<= PSA calc verify"));
7311
7312exit:
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007313 psa_hash_abort(&cloned_op);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007314 return mbedtls_md_error_from_psa(status);
7315}
7316#else
7317static int ssl_calc_verify_tls_legacy(const mbedtls_ssl_context *ssl,
7318 const mbedtls_md_context_t *hs_ctx,
7319 unsigned char *hash,
7320 size_t *hlen)
7321{
7322 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007323 mbedtls_md_context_t cloned_ctx;
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007324
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007325 mbedtls_md_init(&cloned_ctx);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007326
7327#if !defined(MBEDTLS_DEBUG_C)
7328 (void) ssl;
7329#endif
7330 MBEDTLS_SSL_DEBUG_MSG(2, ("=> calc verify"));
7331
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007332 ret = mbedtls_md_setup(&cloned_ctx, mbedtls_md_info_from_ctx(hs_ctx), 0);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007333 if (ret != 0) {
7334 goto exit;
7335 }
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007336 ret = mbedtls_md_clone(&cloned_ctx, hs_ctx);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007337 if (ret != 0) {
7338 goto exit;
7339 }
7340
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007341 ret = mbedtls_md_finish(&cloned_ctx, hash);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007342 if (ret != 0) {
7343 goto exit;
7344 }
7345
7346 *hlen = mbedtls_md_get_size(mbedtls_md_info_from_ctx(hs_ctx));
7347
7348 MBEDTLS_SSL_DEBUG_BUF(3, "calculated verify result", hash, *hlen);
7349 MBEDTLS_SSL_DEBUG_MSG(2, ("<= calc verify"));
7350
7351exit:
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007352 mbedtls_md_free(&cloned_ctx);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007353 return ret;
7354}
7355#endif /* MBEDTLS_USE_PSA_CRYPTO */
7356
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01007357#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +01007358int ssl_calc_verify_tls_sha256(const mbedtls_ssl_context *ssl,
7359 unsigned char *hash,
7360 size_t *hlen)
Jerry Yu8392e0d2022-02-17 14:10:24 +08007361{
7362#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007363 return ssl_calc_verify_tls_psa(ssl, &ssl->handshake->fin_sha256_psa, 32,
7364 hash, hlen);
Jerry Yu8392e0d2022-02-17 14:10:24 +08007365#else
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007366 return ssl_calc_verify_tls_legacy(ssl, &ssl->handshake->fin_sha256,
7367 hash, hlen);
Jerry Yu8392e0d2022-02-17 14:10:24 +08007368#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu8392e0d2022-02-17 14:10:24 +08007369}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01007370#endif /* MBEDTLS_MD_CAN_SHA256 */
Jerry Yu8392e0d2022-02-17 14:10:24 +08007371
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01007372#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +01007373int ssl_calc_verify_tls_sha384(const mbedtls_ssl_context *ssl,
7374 unsigned char *hash,
7375 size_t *hlen)
Jerry Yuc1cb3842022-02-17 14:13:48 +08007376{
7377#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007378 return ssl_calc_verify_tls_psa(ssl, &ssl->handshake->fin_sha384_psa, 48,
7379 hash, hlen);
Jerry Yuc1cb3842022-02-17 14:13:48 +08007380#else
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007381 return ssl_calc_verify_tls_legacy(ssl, &ssl->handshake->fin_sha384,
7382 hash, hlen);
Jerry Yuc1cb3842022-02-17 14:13:48 +08007383#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yuc1cb3842022-02-17 14:13:48 +08007384}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01007385#endif /* MBEDTLS_MD_CAN_SHA384 */
Jerry Yuc1cb3842022-02-17 14:13:48 +08007386
Neil Armstrong80f6f322022-05-03 17:56:38 +02007387#if !defined(MBEDTLS_USE_PSA_CRYPTO) && \
7388 defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007389int mbedtls_ssl_psk_derive_premaster(mbedtls_ssl_context *ssl, mbedtls_key_exchange_type_t key_ex)
Jerry Yuce3dca42022-02-17 14:16:37 +08007390{
7391 unsigned char *p = ssl->handshake->premaster;
Gilles Peskine449bd832023-01-11 14:50:10 +01007392 unsigned char *end = p + sizeof(ssl->handshake->premaster);
Jerry Yuce3dca42022-02-17 14:16:37 +08007393 const unsigned char *psk = NULL;
7394 size_t psk_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01007395 int psk_ret = mbedtls_ssl_get_psk(ssl, &psk, &psk_len);
Jerry Yuce3dca42022-02-17 14:16:37 +08007396
Gilles Peskine449bd832023-01-11 14:50:10 +01007397 if (psk_ret == MBEDTLS_ERR_SSL_PRIVATE_KEY_REQUIRED) {
Jerry Yuce3dca42022-02-17 14:16:37 +08007398 /*
7399 * This should never happen because the existence of a PSK is always
Przemek Stekielb293aaa2022-04-19 12:22:38 +02007400 * checked before calling this function.
7401 *
7402 * The exception is opaque DHE-PSK. For DHE-PSK fill premaster with
Przemek Stekiel8abcee92022-04-28 09:16:28 +02007403 * the shared secret without PSK.
Jerry Yuce3dca42022-02-17 14:16:37 +08007404 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007405 if (key_ex != MBEDTLS_KEY_EXCHANGE_DHE_PSK) {
7406 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
7407 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Przemek Stekielb293aaa2022-04-19 12:22:38 +02007408 }
Jerry Yuce3dca42022-02-17 14:16:37 +08007409 }
7410
7411 /*
7412 * PMS = struct {
7413 * opaque other_secret<0..2^16-1>;
7414 * opaque psk<0..2^16-1>;
7415 * };
7416 * with "other_secret" depending on the particular key exchange
7417 */
7418#if defined(MBEDTLS_KEY_EXCHANGE_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007419 if (key_ex == MBEDTLS_KEY_EXCHANGE_PSK) {
7420 if (end - p < 2) {
7421 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
7422 }
Jerry Yuce3dca42022-02-17 14:16:37 +08007423
Gilles Peskine449bd832023-01-11 14:50:10 +01007424 MBEDTLS_PUT_UINT16_BE(psk_len, p, 0);
Jerry Yuce3dca42022-02-17 14:16:37 +08007425 p += 2;
7426
Gilles Peskine449bd832023-01-11 14:50:10 +01007427 if (end < p || (size_t) (end - p) < psk_len) {
7428 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
7429 }
Jerry Yuce3dca42022-02-17 14:16:37 +08007430
Gilles Peskine449bd832023-01-11 14:50:10 +01007431 memset(p, 0, psk_len);
Jerry Yuce3dca42022-02-17 14:16:37 +08007432 p += psk_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01007433 } else
Jerry Yuce3dca42022-02-17 14:16:37 +08007434#endif /* MBEDTLS_KEY_EXCHANGE_PSK_ENABLED */
7435#if defined(MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007436 if (key_ex == MBEDTLS_KEY_EXCHANGE_RSA_PSK) {
Jerry Yuce3dca42022-02-17 14:16:37 +08007437 /*
7438 * other_secret already set by the ClientKeyExchange message,
7439 * and is 48 bytes long
7440 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007441 if (end - p < 2) {
7442 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
7443 }
Jerry Yuce3dca42022-02-17 14:16:37 +08007444
7445 *p++ = 0;
7446 *p++ = 48;
7447 p += 48;
Gilles Peskine449bd832023-01-11 14:50:10 +01007448 } else
Jerry Yuce3dca42022-02-17 14:16:37 +08007449#endif /* MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED */
7450#if defined(MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007451 if (key_ex == MBEDTLS_KEY_EXCHANGE_DHE_PSK) {
Jerry Yuce3dca42022-02-17 14:16:37 +08007452 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7453 size_t len;
7454
7455 /* Write length only when we know the actual value */
Gilles Peskine449bd832023-01-11 14:50:10 +01007456 if ((ret = mbedtls_dhm_calc_secret(&ssl->handshake->dhm_ctx,
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00007457 p + 2, (size_t) (end - (p + 2)), &len,
Gilles Peskine449bd832023-01-11 14:50:10 +01007458 ssl->conf->f_rng, ssl->conf->p_rng)) != 0) {
7459 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_dhm_calc_secret", ret);
7460 return ret;
Jerry Yuce3dca42022-02-17 14:16:37 +08007461 }
Gilles Peskine449bd832023-01-11 14:50:10 +01007462 MBEDTLS_PUT_UINT16_BE(len, p, 0);
Jerry Yuce3dca42022-02-17 14:16:37 +08007463 p += 2 + len;
7464
Gilles Peskine449bd832023-01-11 14:50:10 +01007465 MBEDTLS_SSL_DEBUG_MPI(3, "DHM: K ", &ssl->handshake->dhm_ctx.K);
7466 } else
Jerry Yuce3dca42022-02-17 14:16:37 +08007467#endif /* MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED */
Neil Armstrong80f6f322022-05-03 17:56:38 +02007468#if defined(MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007469 if (key_ex == MBEDTLS_KEY_EXCHANGE_ECDHE_PSK) {
Jerry Yuce3dca42022-02-17 14:16:37 +08007470 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7471 size_t zlen;
7472
Gilles Peskine449bd832023-01-11 14:50:10 +01007473 if ((ret = mbedtls_ecdh_calc_secret(&ssl->handshake->ecdh_ctx, &zlen,
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00007474 p + 2, (size_t) (end - (p + 2)),
Gilles Peskine449bd832023-01-11 14:50:10 +01007475 ssl->conf->f_rng, ssl->conf->p_rng)) != 0) {
7476 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ecdh_calc_secret", ret);
7477 return ret;
Jerry Yuce3dca42022-02-17 14:16:37 +08007478 }
7479
Gilles Peskine449bd832023-01-11 14:50:10 +01007480 MBEDTLS_PUT_UINT16_BE(zlen, p, 0);
Jerry Yuce3dca42022-02-17 14:16:37 +08007481 p += 2 + zlen;
7482
Gilles Peskine449bd832023-01-11 14:50:10 +01007483 MBEDTLS_SSL_DEBUG_ECDH(3, &ssl->handshake->ecdh_ctx,
7484 MBEDTLS_DEBUG_ECDH_Z);
7485 } else
Neil Armstrong80f6f322022-05-03 17:56:38 +02007486#endif /* MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED */
Jerry Yuce3dca42022-02-17 14:16:37 +08007487 {
Gilles Peskine449bd832023-01-11 14:50:10 +01007488 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
7489 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yuce3dca42022-02-17 14:16:37 +08007490 }
7491
7492 /* opaque psk<0..2^16-1>; */
Gilles Peskine449bd832023-01-11 14:50:10 +01007493 if (end - p < 2) {
7494 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
7495 }
Jerry Yuce3dca42022-02-17 14:16:37 +08007496
Gilles Peskine449bd832023-01-11 14:50:10 +01007497 MBEDTLS_PUT_UINT16_BE(psk_len, p, 0);
Jerry Yuce3dca42022-02-17 14:16:37 +08007498 p += 2;
7499
Gilles Peskine449bd832023-01-11 14:50:10 +01007500 if (end < p || (size_t) (end - p) < psk_len) {
7501 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
7502 }
Jerry Yuce3dca42022-02-17 14:16:37 +08007503
Gilles Peskine449bd832023-01-11 14:50:10 +01007504 memcpy(p, psk, psk_len);
Jerry Yuce3dca42022-02-17 14:16:37 +08007505 p += psk_len;
7506
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00007507 ssl->handshake->pmslen = (size_t) (p - ssl->handshake->premaster);
Jerry Yuce3dca42022-02-17 14:16:37 +08007508
Gilles Peskine449bd832023-01-11 14:50:10 +01007509 return 0;
Jerry Yuce3dca42022-02-17 14:16:37 +08007510}
Neil Armstrong80f6f322022-05-03 17:56:38 +02007511#endif /* !MBEDTLS_USE_PSA_CRYPTO && MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
Jerry Yuc2c673d2022-02-17 14:20:39 +08007512
7513#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007514MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007515static int ssl_write_hello_request(mbedtls_ssl_context *ssl);
Jerry Yuc2c673d2022-02-17 14:20:39 +08007516
7517#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01007518int mbedtls_ssl_resend_hello_request(mbedtls_ssl_context *ssl)
Jerry Yuc2c673d2022-02-17 14:20:39 +08007519{
7520 /* If renegotiation is not enforced, retransmit until we would reach max
7521 * timeout if we were using the usual handshake doubling scheme */
Gilles Peskine449bd832023-01-11 14:50:10 +01007522 if (ssl->conf->renego_max_records < 0) {
Jerry Yuc2c673d2022-02-17 14:20:39 +08007523 uint32_t ratio = ssl->conf->hs_timeout_max / ssl->conf->hs_timeout_min + 1;
7524 unsigned char doublings = 1;
7525
Gilles Peskine449bd832023-01-11 14:50:10 +01007526 while (ratio != 0) {
Jerry Yuc2c673d2022-02-17 14:20:39 +08007527 ++doublings;
7528 ratio >>= 1;
7529 }
7530
Gilles Peskine449bd832023-01-11 14:50:10 +01007531 if (++ssl->renego_records_seen > doublings) {
7532 MBEDTLS_SSL_DEBUG_MSG(2, ("no longer retransmitting hello request"));
7533 return 0;
Jerry Yuc2c673d2022-02-17 14:20:39 +08007534 }
7535 }
7536
Gilles Peskine449bd832023-01-11 14:50:10 +01007537 return ssl_write_hello_request(ssl);
Jerry Yuc2c673d2022-02-17 14:20:39 +08007538}
7539#endif
7540#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_RENEGOTIATION */
Jerry Yud9526692022-02-17 14:23:47 +08007541
Jerry Yud9526692022-02-17 14:23:47 +08007542/*
7543 * Handshake functions
7544 */
7545#if !defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
7546/* No certificate support -> dummy functions */
Gilles Peskine449bd832023-01-11 14:50:10 +01007547int mbedtls_ssl_write_certificate(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08007548{
7549 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
7550 ssl->handshake->ciphersuite_info;
7551
Gilles Peskine449bd832023-01-11 14:50:10 +01007552 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007553
Gilles Peskine449bd832023-01-11 14:50:10 +01007554 if (!mbedtls_ssl_ciphersuite_uses_srv_cert(ciphersuite_info)) {
7555 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007556 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01007557 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007558 }
7559
Gilles Peskine449bd832023-01-11 14:50:10 +01007560 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
7561 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007562}
7563
Gilles Peskine449bd832023-01-11 14:50:10 +01007564int mbedtls_ssl_parse_certificate(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08007565{
7566 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
7567 ssl->handshake->ciphersuite_info;
7568
Gilles Peskine449bd832023-01-11 14:50:10 +01007569 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007570
Gilles Peskine449bd832023-01-11 14:50:10 +01007571 if (!mbedtls_ssl_ciphersuite_uses_srv_cert(ciphersuite_info)) {
7572 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007573 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01007574 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007575 }
7576
Gilles Peskine449bd832023-01-11 14:50:10 +01007577 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
7578 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007579}
7580
7581#else /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
7582/* Some certificate support -> implement write and parse */
7583
Gilles Peskine449bd832023-01-11 14:50:10 +01007584int mbedtls_ssl_write_certificate(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08007585{
7586 int ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
7587 size_t i, n;
7588 const mbedtls_x509_crt *crt;
7589 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
7590 ssl->handshake->ciphersuite_info;
7591
Gilles Peskine449bd832023-01-11 14:50:10 +01007592 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007593
Gilles Peskine449bd832023-01-11 14:50:10 +01007594 if (!mbedtls_ssl_ciphersuite_uses_srv_cert(ciphersuite_info)) {
7595 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007596 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01007597 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007598 }
7599
7600#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007601 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
7602 if (ssl->handshake->client_auth == 0) {
7603 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007604 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01007605 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007606 }
7607 }
7608#endif /* MBEDTLS_SSL_CLI_C */
7609#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007610 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
7611 if (mbedtls_ssl_own_cert(ssl) == NULL) {
Jerry Yud9526692022-02-17 14:23:47 +08007612 /* Should never happen because we shouldn't have picked the
7613 * ciphersuite if we don't have a certificate. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007614 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007615 }
7616 }
7617#endif
7618
Gilles Peskine449bd832023-01-11 14:50:10 +01007619 MBEDTLS_SSL_DEBUG_CRT(3, "own certificate", mbedtls_ssl_own_cert(ssl));
Jerry Yud9526692022-02-17 14:23:47 +08007620
7621 /*
7622 * 0 . 0 handshake type
7623 * 1 . 3 handshake length
7624 * 4 . 6 length of all certs
7625 * 7 . 9 length of cert. 1
7626 * 10 . n-1 peer certificate
7627 * n . n+2 length of cert. 2
7628 * n+3 . ... upper level cert, etc.
7629 */
7630 i = 7;
Gilles Peskine449bd832023-01-11 14:50:10 +01007631 crt = mbedtls_ssl_own_cert(ssl);
Jerry Yud9526692022-02-17 14:23:47 +08007632
Gilles Peskine449bd832023-01-11 14:50:10 +01007633 while (crt != NULL) {
Jerry Yud9526692022-02-17 14:23:47 +08007634 n = crt->raw.len;
Gilles Peskine449bd832023-01-11 14:50:10 +01007635 if (n > MBEDTLS_SSL_OUT_CONTENT_LEN - 3 - i) {
7636 MBEDTLS_SSL_DEBUG_MSG(1, ("certificate too large, %" MBEDTLS_PRINTF_SIZET
7637 " > %" MBEDTLS_PRINTF_SIZET,
7638 i + 3 + n, (size_t) MBEDTLS_SSL_OUT_CONTENT_LEN));
7639 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
Jerry Yud9526692022-02-17 14:23:47 +08007640 }
7641
Gilles Peskine449bd832023-01-11 14:50:10 +01007642 ssl->out_msg[i] = MBEDTLS_BYTE_2(n);
7643 ssl->out_msg[i + 1] = MBEDTLS_BYTE_1(n);
7644 ssl->out_msg[i + 2] = MBEDTLS_BYTE_0(n);
Jerry Yud9526692022-02-17 14:23:47 +08007645
Gilles Peskine449bd832023-01-11 14:50:10 +01007646 i += 3; memcpy(ssl->out_msg + i, crt->raw.p, n);
Jerry Yud9526692022-02-17 14:23:47 +08007647 i += n; crt = crt->next;
7648 }
7649
Gilles Peskine449bd832023-01-11 14:50:10 +01007650 ssl->out_msg[4] = MBEDTLS_BYTE_2(i - 7);
7651 ssl->out_msg[5] = MBEDTLS_BYTE_1(i - 7);
7652 ssl->out_msg[6] = MBEDTLS_BYTE_0(i - 7);
Jerry Yud9526692022-02-17 14:23:47 +08007653
7654 ssl->out_msglen = i;
7655 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
7656 ssl->out_msg[0] = MBEDTLS_SSL_HS_CERTIFICATE;
7657
7658 ssl->state++;
7659
Gilles Peskine449bd832023-01-11 14:50:10 +01007660 if ((ret = mbedtls_ssl_write_handshake_msg(ssl)) != 0) {
7661 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_handshake_msg", ret);
7662 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007663 }
7664
Gilles Peskine449bd832023-01-11 14:50:10 +01007665 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007666
Gilles Peskine449bd832023-01-11 14:50:10 +01007667 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007668}
7669
7670#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
7671
7672#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007673MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007674static int ssl_check_peer_crt_unchanged(mbedtls_ssl_context *ssl,
7675 unsigned char *crt_buf,
7676 size_t crt_buf_len)
Jerry Yud9526692022-02-17 14:23:47 +08007677{
7678 mbedtls_x509_crt const * const peer_crt = ssl->session->peer_cert;
7679
Gilles Peskine449bd832023-01-11 14:50:10 +01007680 if (peer_crt == NULL) {
7681 return -1;
7682 }
Jerry Yud9526692022-02-17 14:23:47 +08007683
Gilles Peskine449bd832023-01-11 14:50:10 +01007684 if (peer_crt->raw.len != crt_buf_len) {
7685 return -1;
7686 }
Jerry Yud9526692022-02-17 14:23:47 +08007687
Gilles Peskine449bd832023-01-11 14:50:10 +01007688 return memcmp(peer_crt->raw.p, crt_buf, peer_crt->raw.len);
Jerry Yud9526692022-02-17 14:23:47 +08007689}
7690#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007691MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007692static int ssl_check_peer_crt_unchanged(mbedtls_ssl_context *ssl,
7693 unsigned char *crt_buf,
7694 size_t crt_buf_len)
Jerry Yud9526692022-02-17 14:23:47 +08007695{
7696 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7697 unsigned char const * const peer_cert_digest =
7698 ssl->session->peer_cert_digest;
7699 mbedtls_md_type_t const peer_cert_digest_type =
7700 ssl->session->peer_cert_digest_type;
7701 mbedtls_md_info_t const * const digest_info =
Gilles Peskine449bd832023-01-11 14:50:10 +01007702 mbedtls_md_info_from_type(peer_cert_digest_type);
Jerry Yud9526692022-02-17 14:23:47 +08007703 unsigned char tmp_digest[MBEDTLS_SSL_PEER_CERT_DIGEST_MAX_LEN];
7704 size_t digest_len;
7705
Gilles Peskine449bd832023-01-11 14:50:10 +01007706 if (peer_cert_digest == NULL || digest_info == NULL) {
7707 return -1;
7708 }
Jerry Yud9526692022-02-17 14:23:47 +08007709
Gilles Peskine449bd832023-01-11 14:50:10 +01007710 digest_len = mbedtls_md_get_size(digest_info);
7711 if (digest_len > MBEDTLS_SSL_PEER_CERT_DIGEST_MAX_LEN) {
7712 return -1;
7713 }
Jerry Yud9526692022-02-17 14:23:47 +08007714
Gilles Peskine449bd832023-01-11 14:50:10 +01007715 ret = mbedtls_md(digest_info, crt_buf, crt_buf_len, tmp_digest);
7716 if (ret != 0) {
7717 return -1;
7718 }
Jerry Yud9526692022-02-17 14:23:47 +08007719
Gilles Peskine449bd832023-01-11 14:50:10 +01007720 return memcmp(tmp_digest, peer_cert_digest, digest_len);
Jerry Yud9526692022-02-17 14:23:47 +08007721}
7722#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7723#endif /* MBEDTLS_SSL_RENEGOTIATION && MBEDTLS_SSL_CLI_C */
7724
7725/*
7726 * Once the certificate message is read, parse it into a cert chain and
7727 * perform basic checks, but leave actual verification to the caller
7728 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007729MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007730static int ssl_parse_certificate_chain(mbedtls_ssl_context *ssl,
7731 mbedtls_x509_crt *chain)
Jerry Yud9526692022-02-17 14:23:47 +08007732{
7733 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7734#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007735 int crt_cnt = 0;
Jerry Yud9526692022-02-17 14:23:47 +08007736#endif
7737 size_t i, n;
7738 uint8_t alert;
7739
Gilles Peskine449bd832023-01-11 14:50:10 +01007740 if (ssl->in_msgtype != MBEDTLS_SSL_MSG_HANDSHAKE) {
7741 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7742 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7743 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
7744 return MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
Jerry Yud9526692022-02-17 14:23:47 +08007745 }
7746
Gilles Peskine449bd832023-01-11 14:50:10 +01007747 if (ssl->in_msg[0] != MBEDTLS_SSL_HS_CERTIFICATE) {
7748 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7749 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
7750 return MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
Jerry Yud9526692022-02-17 14:23:47 +08007751 }
7752
Gilles Peskine449bd832023-01-11 14:50:10 +01007753 if (ssl->in_hslen < mbedtls_ssl_hs_hdr_len(ssl) + 3 + 3) {
7754 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7755 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7756 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
7757 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007758 }
7759
Gilles Peskine449bd832023-01-11 14:50:10 +01007760 i = mbedtls_ssl_hs_hdr_len(ssl);
Jerry Yud9526692022-02-17 14:23:47 +08007761
7762 /*
7763 * Same message structure as in mbedtls_ssl_write_certificate()
7764 */
Dave Rodgmana3d0f612023-11-03 23:34:02 +00007765 n = MBEDTLS_GET_UINT16_BE(ssl->in_msg, i + 1);
Jerry Yud9526692022-02-17 14:23:47 +08007766
Gilles Peskine449bd832023-01-11 14:50:10 +01007767 if (ssl->in_msg[i] != 0 ||
7768 ssl->in_hslen != n + 3 + mbedtls_ssl_hs_hdr_len(ssl)) {
7769 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7770 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7771 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
7772 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007773 }
7774
7775 /* Make &ssl->in_msg[i] point to the beginning of the CRT chain. */
7776 i += 3;
7777
7778 /* Iterate through and parse the CRTs in the provided chain. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007779 while (i < ssl->in_hslen) {
Jerry Yud9526692022-02-17 14:23:47 +08007780 /* Check that there's room for the next CRT's length fields. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007781 if (i + 3 > ssl->in_hslen) {
7782 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7783 mbedtls_ssl_send_alert_message(ssl,
7784 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 /* In theory, the CRT can be up to 2**24 Bytes, but we don't support
7789 * anything beyond 2**16 ~ 64K. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007790 if (ssl->in_msg[i] != 0) {
7791 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7792 mbedtls_ssl_send_alert_message(ssl,
7793 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7794 MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT);
7795 return MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
Jerry Yud9526692022-02-17 14:23:47 +08007796 }
7797
7798 /* Read length of the next CRT in the chain. */
Dave Rodgmana3d0f612023-11-03 23:34:02 +00007799 n = MBEDTLS_GET_UINT16_BE(ssl->in_msg, i + 1);
Jerry Yud9526692022-02-17 14:23:47 +08007800 i += 3;
7801
Gilles Peskine449bd832023-01-11 14:50:10 +01007802 if (n < 128 || i + n > ssl->in_hslen) {
7803 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7804 mbedtls_ssl_send_alert_message(ssl,
7805 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7806 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
7807 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007808 }
7809
7810 /* Check if we're handling the first CRT in the chain. */
7811#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007812 if (crt_cnt++ == 0 &&
Jerry Yud9526692022-02-17 14:23:47 +08007813 ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
Gilles Peskine449bd832023-01-11 14:50:10 +01007814 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS) {
Jerry Yud9526692022-02-17 14:23:47 +08007815 /* During client-side renegotiation, check that the server's
7816 * end-CRTs hasn't changed compared to the initial handshake,
7817 * mitigating the triple handshake attack. On success, reuse
7818 * the original end-CRT instead of parsing it again. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007819 MBEDTLS_SSL_DEBUG_MSG(3, ("Check that peer CRT hasn't changed during renegotiation"));
7820 if (ssl_check_peer_crt_unchanged(ssl,
7821 &ssl->in_msg[i],
7822 n) != 0) {
7823 MBEDTLS_SSL_DEBUG_MSG(1, ("new server cert during renegotiation"));
7824 mbedtls_ssl_send_alert_message(ssl,
7825 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7826 MBEDTLS_SSL_ALERT_MSG_ACCESS_DENIED);
7827 return MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
Jerry Yud9526692022-02-17 14:23:47 +08007828 }
7829
7830 /* Now we can safely free the original chain. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007831 ssl_clear_peer_cert(ssl->session);
Jerry Yud9526692022-02-17 14:23:47 +08007832 }
7833#endif /* MBEDTLS_SSL_RENEGOTIATION && MBEDTLS_SSL_CLI_C */
7834
7835 /* Parse the next certificate in the chain. */
7836#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01007837 ret = mbedtls_x509_crt_parse_der(chain, ssl->in_msg + i, n);
Jerry Yud9526692022-02-17 14:23:47 +08007838#else
7839 /* If we don't need to store the CRT chain permanently, parse
7840 * it in-place from the input buffer instead of making a copy. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007841 ret = mbedtls_x509_crt_parse_der_nocopy(chain, ssl->in_msg + i, n);
Jerry Yud9526692022-02-17 14:23:47 +08007842#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Gilles Peskine449bd832023-01-11 14:50:10 +01007843 switch (ret) {
Jerry Yud9526692022-02-17 14:23:47 +08007844 case 0: /*ok*/
7845 case MBEDTLS_ERR_X509_UNKNOWN_SIG_ALG + MBEDTLS_ERR_OID_NOT_FOUND:
7846 /* Ignore certificate with an unknown algorithm: maybe a
7847 prior certificate was already trusted. */
7848 break;
7849
7850 case MBEDTLS_ERR_X509_ALLOC_FAILED:
7851 alert = MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR;
7852 goto crt_parse_der_failed;
7853
7854 case MBEDTLS_ERR_X509_UNKNOWN_VERSION:
7855 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
7856 goto crt_parse_der_failed;
7857
7858 default:
7859 alert = MBEDTLS_SSL_ALERT_MSG_BAD_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01007860crt_parse_der_failed:
7861 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL, alert);
7862 MBEDTLS_SSL_DEBUG_RET(1, " mbedtls_x509_crt_parse_der", ret);
7863 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007864 }
7865
7866 i += n;
7867 }
7868
Gilles Peskine449bd832023-01-11 14:50:10 +01007869 MBEDTLS_SSL_DEBUG_CRT(3, "peer certificate", chain);
7870 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007871}
7872
7873#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007874MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007875static int ssl_srv_check_client_no_crt_notification(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08007876{
Gilles Peskine449bd832023-01-11 14:50:10 +01007877 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
7878 return -1;
7879 }
Jerry Yud9526692022-02-17 14:23:47 +08007880
Gilles Peskine449bd832023-01-11 14:50:10 +01007881 if (ssl->in_hslen == 3 + mbedtls_ssl_hs_hdr_len(ssl) &&
Jerry Yud9526692022-02-17 14:23:47 +08007882 ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
7883 ssl->in_msg[0] == MBEDTLS_SSL_HS_CERTIFICATE &&
Gilles Peskine449bd832023-01-11 14:50:10 +01007884 memcmp(ssl->in_msg + mbedtls_ssl_hs_hdr_len(ssl), "\0\0\0", 3) == 0) {
7885 MBEDTLS_SSL_DEBUG_MSG(1, ("peer has no certificate"));
7886 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007887 }
Gilles Peskine449bd832023-01-11 14:50:10 +01007888 return -1;
Jerry Yud9526692022-02-17 14:23:47 +08007889}
7890#endif /* MBEDTLS_SSL_SRV_C */
7891
7892/* Check if a certificate message is expected.
7893 * Return either
7894 * - SSL_CERTIFICATE_EXPECTED, or
7895 * - SSL_CERTIFICATE_SKIP
7896 * indicating whether a Certificate message is expected or not.
7897 */
7898#define SSL_CERTIFICATE_EXPECTED 0
7899#define SSL_CERTIFICATE_SKIP 1
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007900MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007901static int ssl_parse_certificate_coordinate(mbedtls_ssl_context *ssl,
7902 int authmode)
Jerry Yud9526692022-02-17 14:23:47 +08007903{
7904 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
7905 ssl->handshake->ciphersuite_info;
7906
Gilles Peskine449bd832023-01-11 14:50:10 +01007907 if (!mbedtls_ssl_ciphersuite_uses_srv_cert(ciphersuite_info)) {
7908 return SSL_CERTIFICATE_SKIP;
7909 }
Jerry Yud9526692022-02-17 14:23:47 +08007910
7911#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007912 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
7913 if (ciphersuite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_RSA_PSK) {
7914 return SSL_CERTIFICATE_SKIP;
7915 }
Jerry Yud9526692022-02-17 14:23:47 +08007916
Gilles Peskine449bd832023-01-11 14:50:10 +01007917 if (authmode == MBEDTLS_SSL_VERIFY_NONE) {
Jerry Yud9526692022-02-17 14:23:47 +08007918 ssl->session_negotiate->verify_result =
7919 MBEDTLS_X509_BADCERT_SKIP_VERIFY;
Gilles Peskine449bd832023-01-11 14:50:10 +01007920 return SSL_CERTIFICATE_SKIP;
Jerry Yud9526692022-02-17 14:23:47 +08007921 }
7922 }
7923#else
7924 ((void) authmode);
7925#endif /* MBEDTLS_SSL_SRV_C */
7926
Gilles Peskine449bd832023-01-11 14:50:10 +01007927 return SSL_CERTIFICATE_EXPECTED;
Jerry Yud9526692022-02-17 14:23:47 +08007928}
7929
Jerry Yud9526692022-02-17 14:23:47 +08007930#if !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007931MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007932static int ssl_remember_peer_crt_digest(mbedtls_ssl_context *ssl,
7933 unsigned char *start, size_t len)
Jerry Yud9526692022-02-17 14:23:47 +08007934{
7935 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7936 /* Remember digest of the peer's end-CRT. */
7937 ssl->session_negotiate->peer_cert_digest =
Gilles Peskine449bd832023-01-11 14:50:10 +01007938 mbedtls_calloc(1, MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN);
7939 if (ssl->session_negotiate->peer_cert_digest == NULL) {
7940 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc(%d bytes) failed",
7941 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN));
7942 mbedtls_ssl_send_alert_message(ssl,
7943 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7944 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR);
Jerry Yud9526692022-02-17 14:23:47 +08007945
Gilles Peskine449bd832023-01-11 14:50:10 +01007946 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
Jerry Yud9526692022-02-17 14:23:47 +08007947 }
7948
Gilles Peskine449bd832023-01-11 14:50:10 +01007949 ret = mbedtls_md(mbedtls_md_info_from_type(
7950 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE),
7951 start, len,
7952 ssl->session_negotiate->peer_cert_digest);
Jerry Yud9526692022-02-17 14:23:47 +08007953
7954 ssl->session_negotiate->peer_cert_digest_type =
7955 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE;
7956 ssl->session_negotiate->peer_cert_digest_len =
7957 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN;
7958
Gilles Peskine449bd832023-01-11 14:50:10 +01007959 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007960}
7961
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007962MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007963static int ssl_remember_peer_pubkey(mbedtls_ssl_context *ssl,
7964 unsigned char *start, size_t len)
Jerry Yud9526692022-02-17 14:23:47 +08007965{
7966 unsigned char *end = start + len;
7967 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7968
7969 /* Make a copy of the peer's raw public key. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007970 mbedtls_pk_init(&ssl->handshake->peer_pubkey);
7971 ret = mbedtls_pk_parse_subpubkey(&start, end,
7972 &ssl->handshake->peer_pubkey);
7973 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007974 /* We should have parsed the public key before. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007975 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007976 }
7977
Gilles Peskine449bd832023-01-11 14:50:10 +01007978 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007979}
7980#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7981
Gilles Peskine449bd832023-01-11 14:50:10 +01007982int mbedtls_ssl_parse_certificate(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08007983{
7984 int ret = 0;
7985 int crt_expected;
Manuel Pégourié-Gonnarde1cc9262024-08-14 09:47:38 +02007986 /* Authmode: precedence order is SNI if used else configuration */
Jerry Yud9526692022-02-17 14:23:47 +08007987#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
7988 const int authmode = ssl->handshake->sni_authmode != MBEDTLS_SSL_VERIFY_UNSET
7989 ? ssl->handshake->sni_authmode
7990 : ssl->conf->authmode;
7991#else
7992 const int authmode = ssl->conf->authmode;
7993#endif
7994 void *rs_ctx = NULL;
7995 mbedtls_x509_crt *chain = NULL;
7996
Gilles Peskine449bd832023-01-11 14:50:10 +01007997 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007998
Gilles Peskine449bd832023-01-11 14:50:10 +01007999 crt_expected = ssl_parse_certificate_coordinate(ssl, authmode);
8000 if (crt_expected == SSL_CERTIFICATE_SKIP) {
8001 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08008002 goto exit;
8003 }
8004
8005#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01008006 if (ssl->handshake->ecrs_enabled &&
8007 ssl->handshake->ecrs_state == ssl_ecrs_crt_verify) {
Jerry Yud9526692022-02-17 14:23:47 +08008008 chain = ssl->handshake->ecrs_peer_cert;
8009 ssl->handshake->ecrs_peer_cert = NULL;
8010 goto crt_verify;
8011 }
8012#endif
8013
Gilles Peskine449bd832023-01-11 14:50:10 +01008014 if ((ret = mbedtls_ssl_read_record(ssl, 1)) != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08008015 /* mbedtls_ssl_read_record may have sent an alert already. We
8016 let it decide whether to alert. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008017 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_read_record", ret);
Jerry Yud9526692022-02-17 14:23:47 +08008018 goto exit;
8019 }
8020
8021#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008022 if (ssl_srv_check_client_no_crt_notification(ssl) == 0) {
Jerry Yud9526692022-02-17 14:23:47 +08008023 ssl->session_negotiate->verify_result = MBEDTLS_X509_BADCERT_MISSING;
8024
Gilles Peskine449bd832023-01-11 14:50:10 +01008025 if (authmode != MBEDTLS_SSL_VERIFY_OPTIONAL) {
Jerry Yud9526692022-02-17 14:23:47 +08008026 ret = MBEDTLS_ERR_SSL_NO_CLIENT_CERTIFICATE;
Gilles Peskine449bd832023-01-11 14:50:10 +01008027 }
Jerry Yud9526692022-02-17 14:23:47 +08008028
8029 goto exit;
8030 }
8031#endif /* MBEDTLS_SSL_SRV_C */
8032
8033 /* Clear existing peer CRT structure in case we tried to
8034 * reuse a session but it failed, and allocate a new one. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008035 ssl_clear_peer_cert(ssl->session_negotiate);
Jerry Yud9526692022-02-17 14:23:47 +08008036
Gilles Peskine449bd832023-01-11 14:50:10 +01008037 chain = mbedtls_calloc(1, sizeof(mbedtls_x509_crt));
8038 if (chain == NULL) {
8039 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc(%" MBEDTLS_PRINTF_SIZET " bytes) failed",
8040 sizeof(mbedtls_x509_crt)));
8041 mbedtls_ssl_send_alert_message(ssl,
8042 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8043 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR);
Jerry Yud9526692022-02-17 14:23:47 +08008044
8045 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
8046 goto exit;
8047 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008048 mbedtls_x509_crt_init(chain);
Jerry Yud9526692022-02-17 14:23:47 +08008049
Gilles Peskine449bd832023-01-11 14:50:10 +01008050 ret = ssl_parse_certificate_chain(ssl, chain);
8051 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08008052 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01008053 }
Jerry Yud9526692022-02-17 14:23:47 +08008054
8055#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01008056 if (ssl->handshake->ecrs_enabled) {
Jerry Yud9526692022-02-17 14:23:47 +08008057 ssl->handshake->ecrs_state = ssl_ecrs_crt_verify;
Gilles Peskine449bd832023-01-11 14:50:10 +01008058 }
Jerry Yud9526692022-02-17 14:23:47 +08008059
8060crt_verify:
Gilles Peskine449bd832023-01-11 14:50:10 +01008061 if (ssl->handshake->ecrs_enabled) {
Jerry Yud9526692022-02-17 14:23:47 +08008062 rs_ctx = &ssl->handshake->ecrs_ctx;
Gilles Peskine449bd832023-01-11 14:50:10 +01008063 }
Jerry Yud9526692022-02-17 14:23:47 +08008064#endif
8065
Manuel Pégourié-Gonnardce603302024-08-16 11:03:42 +02008066 ret = mbedtls_ssl_verify_certificate(ssl, authmode, chain,
8067 ssl->handshake->ciphersuite_info,
8068 rs_ctx);
Gilles Peskine449bd832023-01-11 14:50:10 +01008069 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08008070 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01008071 }
Jerry Yud9526692022-02-17 14:23:47 +08008072
8073#if !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
8074 {
8075 unsigned char *crt_start, *pk_start;
8076 size_t crt_len, pk_len;
8077
8078 /* We parse the CRT chain without copying, so
8079 * these pointers point into the input buffer,
8080 * and are hence still valid after freeing the
8081 * CRT chain. */
8082
8083 crt_start = chain->raw.p;
8084 crt_len = chain->raw.len;
8085
8086 pk_start = chain->pk_raw.p;
8087 pk_len = chain->pk_raw.len;
8088
8089 /* Free the CRT structures before computing
8090 * digest and copying the peer's public key. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008091 mbedtls_x509_crt_free(chain);
8092 mbedtls_free(chain);
Jerry Yud9526692022-02-17 14:23:47 +08008093 chain = NULL;
8094
Gilles Peskine449bd832023-01-11 14:50:10 +01008095 ret = ssl_remember_peer_crt_digest(ssl, crt_start, crt_len);
8096 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08008097 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01008098 }
Jerry Yud9526692022-02-17 14:23:47 +08008099
Gilles Peskine449bd832023-01-11 14:50:10 +01008100 ret = ssl_remember_peer_pubkey(ssl, pk_start, pk_len);
8101 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08008102 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01008103 }
Jerry Yud9526692022-02-17 14:23:47 +08008104 }
8105#else /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
8106 /* Pass ownership to session structure. */
8107 ssl->session_negotiate->peer_cert = chain;
8108 chain = NULL;
8109#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
8110
Gilles Peskine449bd832023-01-11 14:50:10 +01008111 MBEDTLS_SSL_DEBUG_MSG(2, ("<= parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08008112
8113exit:
8114
Gilles Peskine449bd832023-01-11 14:50:10 +01008115 if (ret == 0) {
Jerry Yud9526692022-02-17 14:23:47 +08008116 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01008117 }
Jerry Yud9526692022-02-17 14:23:47 +08008118
8119#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01008120 if (ret == MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS) {
Jerry Yud9526692022-02-17 14:23:47 +08008121 ssl->handshake->ecrs_peer_cert = chain;
8122 chain = NULL;
8123 }
8124#endif
8125
Gilles Peskine449bd832023-01-11 14:50:10 +01008126 if (chain != NULL) {
8127 mbedtls_x509_crt_free(chain);
8128 mbedtls_free(chain);
Jerry Yud9526692022-02-17 14:23:47 +08008129 }
8130
Gilles Peskine449bd832023-01-11 14:50:10 +01008131 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08008132}
8133#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
8134
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008135static int ssl_calc_finished_tls_generic(mbedtls_ssl_context *ssl, void *ctx,
8136 unsigned char *padbuf, size_t hlen,
8137 unsigned char *buf, int from)
Jerry Yu615bd6f2022-02-17 14:25:15 +08008138{
Dave Rodgmanc37ad442023-11-03 23:36:06 +00008139 unsigned int len = 12;
Jerry Yu615bd6f2022-02-17 14:25:15 +08008140 const char *sender;
Jerry Yu615bd6f2022-02-17 14:25:15 +08008141#if defined(MBEDTLS_USE_PSA_CRYPTO)
Jerry Yu615bd6f2022-02-17 14:25:15 +08008142 psa_status_t status;
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008143 psa_hash_operation_t *hs_op = ctx;
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02008144 psa_hash_operation_t cloned_op = PSA_HASH_OPERATION_INIT;
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008145 size_t hash_size;
Jerry Yu615bd6f2022-02-17 14:25:15 +08008146#else
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01008147 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008148 mbedtls_md_context_t *hs_ctx = ctx;
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02008149 mbedtls_md_context_t cloned_ctx;
8150 mbedtls_md_init(&cloned_ctx);
Jerry Yu615bd6f2022-02-17 14:25:15 +08008151#endif
8152
8153 mbedtls_ssl_session *session = ssl->session_negotiate;
Gilles Peskine449bd832023-01-11 14:50:10 +01008154 if (!session) {
Jerry Yu615bd6f2022-02-17 14:25:15 +08008155 session = ssl->session;
Gilles Peskine449bd832023-01-11 14:50:10 +01008156 }
Jerry Yu615bd6f2022-02-17 14:25:15 +08008157
Gilles Peskine449bd832023-01-11 14:50:10 +01008158 sender = (from == MBEDTLS_SSL_IS_CLIENT)
Jerry Yu615bd6f2022-02-17 14:25:15 +08008159 ? "client finished"
8160 : "server finished";
8161
8162#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008163 MBEDTLS_SSL_DEBUG_MSG(2, ("=> calc PSA finished tls"));
Jerry Yu615bd6f2022-02-17 14:25:15 +08008164
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02008165 status = psa_hash_clone(hs_op, &cloned_op);
Gilles Peskine449bd832023-01-11 14:50:10 +01008166 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01008167 goto exit;
Jerry Yu615bd6f2022-02-17 14:25:15 +08008168 }
8169
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02008170 status = psa_hash_finish(&cloned_op, padbuf, hlen, &hash_size);
Gilles Peskine449bd832023-01-11 14:50:10 +01008171 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01008172 goto exit;
Jerry Yu615bd6f2022-02-17 14:25:15 +08008173 }
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008174 MBEDTLS_SSL_DEBUG_BUF(3, "PSA calculated padbuf", padbuf, hlen);
Jerry Yu615bd6f2022-02-17 14:25:15 +08008175#else
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008176 MBEDTLS_SSL_DEBUG_MSG(2, ("=> calc finished tls"));
Jerry Yu615bd6f2022-02-17 14:25:15 +08008177
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02008178 ret = mbedtls_md_setup(&cloned_ctx, mbedtls_md_info_from_ctx(hs_ctx), 0);
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01008179 if (ret != 0) {
8180 goto exit;
8181 }
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02008182 ret = mbedtls_md_clone(&cloned_ctx, hs_ctx);
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01008183 if (ret != 0) {
8184 goto exit;
8185 }
Jerry Yu615bd6f2022-02-17 14:25:15 +08008186
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02008187 ret = mbedtls_md_finish(&cloned_ctx, padbuf);
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008188 if (ret != 0) {
8189 goto exit;
8190 }
8191#endif /* MBEDTLS_USE_PSA_CRYPTO */
8192
8193 MBEDTLS_SSL_DEBUG_BUF(4, "finished output", padbuf, hlen);
8194
Jerry Yu615bd6f2022-02-17 14:25:15 +08008195 /*
8196 * TLSv1.2:
8197 * hash = PRF( master, finished_label,
8198 * Hash( handshake ) )[0.11]
8199 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008200 ssl->handshake->tls_prf(session->master, 48, sender,
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008201 padbuf, hlen, buf, len);
Jerry Yu615bd6f2022-02-17 14:25:15 +08008202
Gilles Peskine449bd832023-01-11 14:50:10 +01008203 MBEDTLS_SSL_DEBUG_BUF(3, "calc finished result", buf, len);
Jerry Yu615bd6f2022-02-17 14:25:15 +08008204
Paul Elliottecb95be2023-08-11 16:41:04 +01008205 mbedtls_platform_zeroize(padbuf, hlen);
Jerry Yu615bd6f2022-02-17 14:25:15 +08008206
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008207 MBEDTLS_SSL_DEBUG_MSG(2, ("<= calc finished"));
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01008208
8209exit:
8210#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02008211 psa_hash_abort(&cloned_op);
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +02008212 return mbedtls_md_error_from_psa(status);
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01008213#else
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02008214 mbedtls_md_free(&cloned_ctx);
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01008215 return ret;
8216#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu615bd6f2022-02-17 14:25:15 +08008217}
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008218
8219#if defined(MBEDTLS_MD_CAN_SHA256)
8220static int ssl_calc_finished_tls_sha256(
8221 mbedtls_ssl_context *ssl, unsigned char *buf, int from)
8222{
8223 unsigned char padbuf[32];
8224 return ssl_calc_finished_tls_generic(ssl,
8225#if defined(MBEDTLS_USE_PSA_CRYPTO)
8226 &ssl->handshake->fin_sha256_psa,
8227#else
8228 &ssl->handshake->fin_sha256,
8229#endif
8230 padbuf, sizeof(padbuf),
8231 buf, from);
8232}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01008233#endif /* MBEDTLS_MD_CAN_SHA256*/
Jerry Yu615bd6f2022-02-17 14:25:15 +08008234
Jerry Yub7ba49e2022-02-17 14:25:53 +08008235
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01008236#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +01008237static int ssl_calc_finished_tls_sha384(
Gilles Peskine449bd832023-01-11 14:50:10 +01008238 mbedtls_ssl_context *ssl, unsigned char *buf, int from)
Jerry Yub7ba49e2022-02-17 14:25:53 +08008239{
Jerry Yub7ba49e2022-02-17 14:25:53 +08008240 unsigned char padbuf[48];
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008241 return ssl_calc_finished_tls_generic(ssl,
Jerry Yub7ba49e2022-02-17 14:25:53 +08008242#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008243 &ssl->handshake->fin_sha384_psa,
Jerry Yub7ba49e2022-02-17 14:25:53 +08008244#else
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008245 &ssl->handshake->fin_sha384,
Jerry Yub7ba49e2022-02-17 14:25:53 +08008246#endif
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008247 padbuf, sizeof(padbuf),
8248 buf, from);
Jerry Yub7ba49e2022-02-17 14:25:53 +08008249}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01008250#endif /* MBEDTLS_MD_CAN_SHA384*/
Jerry Yub7ba49e2022-02-17 14:25:53 +08008251
Gilles Peskine449bd832023-01-11 14:50:10 +01008252void mbedtls_ssl_handshake_wrapup_free_hs_transform(mbedtls_ssl_context *ssl)
Jerry Yuaef00152022-02-17 14:27:31 +08008253{
Gilles Peskine449bd832023-01-11 14:50:10 +01008254 MBEDTLS_SSL_DEBUG_MSG(3, ("=> handshake wrapup: final free"));
Jerry Yuaef00152022-02-17 14:27:31 +08008255
8256 /*
8257 * Free our handshake params
8258 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008259 mbedtls_ssl_handshake_free(ssl);
8260 mbedtls_free(ssl->handshake);
Jerry Yuaef00152022-02-17 14:27:31 +08008261 ssl->handshake = NULL;
8262
8263 /*
Shaun Case8b0ecbc2021-12-20 21:14:10 -08008264 * Free the previous transform and switch in the current one
Jerry Yuaef00152022-02-17 14:27:31 +08008265 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008266 if (ssl->transform) {
8267 mbedtls_ssl_transform_free(ssl->transform);
8268 mbedtls_free(ssl->transform);
Jerry Yuaef00152022-02-17 14:27:31 +08008269 }
8270 ssl->transform = ssl->transform_negotiate;
8271 ssl->transform_negotiate = NULL;
8272
Gilles Peskine449bd832023-01-11 14:50:10 +01008273 MBEDTLS_SSL_DEBUG_MSG(3, ("<= handshake wrapup: final free"));
Jerry Yuaef00152022-02-17 14:27:31 +08008274}
8275
Gilles Peskine449bd832023-01-11 14:50:10 +01008276void mbedtls_ssl_handshake_wrapup(mbedtls_ssl_context *ssl)
Jerry Yu2a9fff52022-02-17 14:28:51 +08008277{
8278 int resume = ssl->handshake->resume;
8279
Gilles Peskine449bd832023-01-11 14:50:10 +01008280 MBEDTLS_SSL_DEBUG_MSG(3, ("=> handshake wrapup"));
Jerry Yu2a9fff52022-02-17 14:28:51 +08008281
8282#if defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01008283 if (ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS) {
Jerry Yu2a9fff52022-02-17 14:28:51 +08008284 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_DONE;
8285 ssl->renego_records_seen = 0;
8286 }
8287#endif
8288
8289 /*
8290 * Free the previous session and switch in the current one
8291 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008292 if (ssl->session) {
Jerry Yu2a9fff52022-02-17 14:28:51 +08008293#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
8294 /* RFC 7366 3.1: keep the EtM state */
8295 ssl->session_negotiate->encrypt_then_mac =
Gilles Peskine449bd832023-01-11 14:50:10 +01008296 ssl->session->encrypt_then_mac;
Jerry Yu2a9fff52022-02-17 14:28:51 +08008297#endif
8298
Gilles Peskine449bd832023-01-11 14:50:10 +01008299 mbedtls_ssl_session_free(ssl->session);
8300 mbedtls_free(ssl->session);
Jerry Yu2a9fff52022-02-17 14:28:51 +08008301 }
8302 ssl->session = ssl->session_negotiate;
8303 ssl->session_negotiate = NULL;
8304
8305 /*
8306 * Add cache entry
8307 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008308 if (ssl->conf->f_set_cache != NULL &&
Jerry Yu2a9fff52022-02-17 14:28:51 +08008309 ssl->session->id_len != 0 &&
Gilles Peskine449bd832023-01-11 14:50:10 +01008310 resume == 0) {
8311 if (ssl->conf->f_set_cache(ssl->conf->p_cache,
8312 ssl->session->id,
8313 ssl->session->id_len,
8314 ssl->session) != 0) {
8315 MBEDTLS_SSL_DEBUG_MSG(1, ("cache did not store session"));
8316 }
Jerry Yu2a9fff52022-02-17 14:28:51 +08008317 }
8318
8319#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01008320 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
8321 ssl->handshake->flight != NULL) {
Jerry Yu2a9fff52022-02-17 14:28:51 +08008322 /* Cancel handshake timer */
Gilles Peskine449bd832023-01-11 14:50:10 +01008323 mbedtls_ssl_set_timer(ssl, 0);
Jerry Yu2a9fff52022-02-17 14:28:51 +08008324
8325 /* Keep last flight around in case we need to resend it:
8326 * we need the handshake and transform structures for that */
Gilles Peskine449bd832023-01-11 14:50:10 +01008327 MBEDTLS_SSL_DEBUG_MSG(3, ("skip freeing handshake and transform"));
8328 } else
Jerry Yu2a9fff52022-02-17 14:28:51 +08008329#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01008330 mbedtls_ssl_handshake_wrapup_free_hs_transform(ssl);
Jerry Yu2a9fff52022-02-17 14:28:51 +08008331
Jerry Yu5ed73ff2022-10-27 13:08:42 +08008332 ssl->state = MBEDTLS_SSL_HANDSHAKE_OVER;
Jerry Yu2a9fff52022-02-17 14:28:51 +08008333
Gilles Peskine449bd832023-01-11 14:50:10 +01008334 MBEDTLS_SSL_DEBUG_MSG(3, ("<= handshake wrapup"));
Jerry Yu2a9fff52022-02-17 14:28:51 +08008335}
8336
Gilles Peskine449bd832023-01-11 14:50:10 +01008337int mbedtls_ssl_write_finished(mbedtls_ssl_context *ssl)
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008338{
Dave Rodgmanc37ad442023-11-03 23:36:06 +00008339 int ret;
8340 unsigned int hash_len;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008341
Gilles Peskine449bd832023-01-11 14:50:10 +01008342 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write finished"));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008343
Gilles Peskine449bd832023-01-11 14:50:10 +01008344 mbedtls_ssl_update_out_pointers(ssl, ssl->transform_negotiate);
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008345
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01008346 ret = ssl->handshake->calc_finished(ssl, ssl->out_msg + 4, ssl->conf->endpoint);
8347 if (ret != 0) {
8348 MBEDTLS_SSL_DEBUG_RET(1, "calc_finished", ret);
8349 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008350
8351 /*
8352 * RFC 5246 7.4.9 (Page 63) says 12 is the default length and ciphersuites
8353 * may define some other value. Currently (early 2016), no defined
8354 * ciphersuite does this (and this is unlikely to change as activity has
8355 * moved to TLS 1.3 now) so we can keep the hardcoded 12 here.
8356 */
8357 hash_len = 12;
8358
8359#if defined(MBEDTLS_SSL_RENEGOTIATION)
8360 ssl->verify_data_len = hash_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01008361 memcpy(ssl->own_verify_data, ssl->out_msg + 4, hash_len);
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008362#endif
8363
8364 ssl->out_msglen = 4 + hash_len;
8365 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
8366 ssl->out_msg[0] = MBEDTLS_SSL_HS_FINISHED;
8367
8368 /*
8369 * In case of session resuming, invert the client and server
8370 * ChangeCipherSpec messages order.
8371 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008372 if (ssl->handshake->resume != 0) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008373#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008374 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008375 ssl->state = MBEDTLS_SSL_HANDSHAKE_WRAPUP;
Gilles Peskine449bd832023-01-11 14:50:10 +01008376 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008377#endif
8378#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008379 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008380 ssl->state = MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC;
Gilles Peskine449bd832023-01-11 14:50:10 +01008381 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008382#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01008383 } else {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008384 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01008385 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008386
8387 /*
8388 * Switch to our negotiated transform and session parameters for outbound
8389 * data.
8390 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008391 MBEDTLS_SSL_DEBUG_MSG(3, ("switching to new transform spec for outbound data"));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008392
8393#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01008394 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008395 unsigned char i;
8396
8397 /* Remember current epoch settings for resending */
8398 ssl->handshake->alt_transform_out = ssl->transform_out;
Gilles Peskine449bd832023-01-11 14:50:10 +01008399 memcpy(ssl->handshake->alt_out_ctr, ssl->cur_out_ctr,
8400 sizeof(ssl->handshake->alt_out_ctr));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008401
8402 /* Set sequence_number to zero */
Gilles Peskine449bd832023-01-11 14:50:10 +01008403 memset(&ssl->cur_out_ctr[2], 0, sizeof(ssl->cur_out_ctr) - 2);
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008404
8405
8406 /* Increment epoch */
Gilles Peskine449bd832023-01-11 14:50:10 +01008407 for (i = 2; i > 0; i--) {
8408 if (++ssl->cur_out_ctr[i - 1] != 0) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008409 break;
Gilles Peskine449bd832023-01-11 14:50:10 +01008410 }
8411 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008412
8413 /* The loop goes to its end iff the counter is wrapping */
Gilles Peskine449bd832023-01-11 14:50:10 +01008414 if (i == 0) {
8415 MBEDTLS_SSL_DEBUG_MSG(1, ("DTLS epoch would wrap"));
8416 return MBEDTLS_ERR_SSL_COUNTER_WRAPPING;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008417 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008418 } else
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008419#endif /* MBEDTLS_SSL_PROTO_DTLS */
Gilles Peskine449bd832023-01-11 14:50:10 +01008420 memset(ssl->cur_out_ctr, 0, sizeof(ssl->cur_out_ctr));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008421
8422 ssl->transform_out = ssl->transform_negotiate;
8423 ssl->session_out = ssl->session_negotiate;
8424
8425#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01008426 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
8427 mbedtls_ssl_send_flight_completed(ssl);
8428 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008429#endif
8430
Gilles Peskine449bd832023-01-11 14:50:10 +01008431 if ((ret = mbedtls_ssl_write_handshake_msg(ssl)) != 0) {
8432 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_handshake_msg", ret);
8433 return ret;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008434 }
8435
8436#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01008437 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
8438 (ret = mbedtls_ssl_flight_transmit(ssl)) != 0) {
8439 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_flight_transmit", ret);
8440 return ret;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008441 }
8442#endif
8443
Gilles Peskine449bd832023-01-11 14:50:10 +01008444 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write finished"));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008445
Gilles Peskine449bd832023-01-11 14:50:10 +01008446 return 0;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008447}
8448
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008449#define SSL_MAX_HASH_LEN 12
8450
Gilles Peskine449bd832023-01-11 14:50:10 +01008451int mbedtls_ssl_parse_finished(mbedtls_ssl_context *ssl)
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008452{
8453 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
8454 unsigned int hash_len = 12;
8455 unsigned char buf[SSL_MAX_HASH_LEN];
8456
Gilles Peskine449bd832023-01-11 14:50:10 +01008457 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse finished"));
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008458
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01008459 ret = ssl->handshake->calc_finished(ssl, buf, ssl->conf->endpoint ^ 1);
8460 if (ret != 0) {
8461 MBEDTLS_SSL_DEBUG_RET(1, "calc_finished", ret);
8462 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008463
Gilles Peskine449bd832023-01-11 14:50:10 +01008464 if ((ret = mbedtls_ssl_read_record(ssl, 1)) != 0) {
8465 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_read_record", ret);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008466 goto exit;
8467 }
8468
Gilles Peskine449bd832023-01-11 14:50:10 +01008469 if (ssl->in_msgtype != MBEDTLS_SSL_MSG_HANDSHAKE) {
8470 MBEDTLS_SSL_DEBUG_MSG(1, ("bad finished message"));
8471 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8472 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008473 ret = MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
8474 goto exit;
8475 }
8476
Gilles Peskine449bd832023-01-11 14:50:10 +01008477 if (ssl->in_msg[0] != MBEDTLS_SSL_HS_FINISHED) {
8478 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8479 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008480 ret = MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
8481 goto exit;
8482 }
8483
Gilles Peskine449bd832023-01-11 14:50:10 +01008484 if (ssl->in_hslen != mbedtls_ssl_hs_hdr_len(ssl) + hash_len) {
8485 MBEDTLS_SSL_DEBUG_MSG(1, ("bad finished message"));
8486 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8487 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008488 ret = MBEDTLS_ERR_SSL_DECODE_ERROR;
8489 goto exit;
8490 }
8491
Gilles Peskine449bd832023-01-11 14:50:10 +01008492 if (mbedtls_ct_memcmp(ssl->in_msg + mbedtls_ssl_hs_hdr_len(ssl),
8493 buf, hash_len) != 0) {
8494 MBEDTLS_SSL_DEBUG_MSG(1, ("bad finished message"));
8495 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8496 MBEDTLS_SSL_ALERT_MSG_DECRYPT_ERROR);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008497 ret = MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
8498 goto exit;
8499 }
8500
8501#if defined(MBEDTLS_SSL_RENEGOTIATION)
8502 ssl->verify_data_len = hash_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01008503 memcpy(ssl->peer_verify_data, buf, hash_len);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008504#endif
8505
Gilles Peskine449bd832023-01-11 14:50:10 +01008506 if (ssl->handshake->resume != 0) {
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008507#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008508 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008509 ssl->state = MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC;
Gilles Peskine449bd832023-01-11 14:50:10 +01008510 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008511#endif
8512#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008513 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008514 ssl->state = MBEDTLS_SSL_HANDSHAKE_WRAPUP;
Gilles Peskine449bd832023-01-11 14:50:10 +01008515 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008516#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01008517 } else {
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008518 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01008519 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008520
8521#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01008522 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
8523 mbedtls_ssl_recv_flight_completed(ssl);
8524 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008525#endif
8526
Gilles Peskine449bd832023-01-11 14:50:10 +01008527 MBEDTLS_SSL_DEBUG_MSG(2, ("<= parse finished"));
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008528
8529exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01008530 mbedtls_platform_zeroize(buf, hash_len);
8531 return ret;
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008532}
8533
Jerry Yu392112c2022-02-17 14:34:10 +08008534#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
8535/*
8536 * Helper to get TLS 1.2 PRF from ciphersuite
8537 * (Duplicates bits of logic from ssl_set_handshake_prfs().)
8538 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008539static tls_prf_fn ssl_tls12prf_from_cs(int ciphersuite_id)
Jerry Yu392112c2022-02-17 14:34:10 +08008540{
Jerry Yu392112c2022-02-17 14:34:10 +08008541 const mbedtls_ssl_ciphersuite_t * const ciphersuite_info =
Gilles Peskine449bd832023-01-11 14:50:10 +01008542 mbedtls_ssl_ciphersuite_from_id(ciphersuite_id);
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01008543#if defined(MBEDTLS_MD_CAN_SHA384)
Gilles Peskine449bd832023-01-11 14:50:10 +01008544 if (ciphersuite_info != NULL && ciphersuite_info->mac == MBEDTLS_MD_SHA384) {
8545 return tls_prf_sha384;
8546 } else
Jerry Yu392112c2022-02-17 14:34:10 +08008547#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01008548#if defined(MBEDTLS_MD_CAN_SHA256)
Andrzej Kurek894edde2022-09-29 06:31:14 -04008549 {
Gilles Peskine449bd832023-01-11 14:50:10 +01008550 if (ciphersuite_info != NULL && ciphersuite_info->mac == MBEDTLS_MD_SHA256) {
8551 return tls_prf_sha256;
8552 }
Andrzej Kurek894edde2022-09-29 06:31:14 -04008553 }
8554#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01008555#if !defined(MBEDTLS_MD_CAN_SHA384) && \
8556 !defined(MBEDTLS_MD_CAN_SHA256)
Andrzej Kurek894edde2022-09-29 06:31:14 -04008557 (void) ciphersuite_info;
8558#endif
Andrzej Kurekeabeb302022-10-17 07:52:51 -04008559
Gilles Peskine449bd832023-01-11 14:50:10 +01008560 return NULL;
Jerry Yu392112c2022-02-17 14:34:10 +08008561}
8562#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
Jerry Yue93ffcd2022-02-17 14:37:06 +08008563
Gilles Peskine449bd832023-01-11 14:50:10 +01008564static mbedtls_tls_prf_types tls_prf_get_type(mbedtls_ssl_tls_prf_cb *tls_prf)
Jerry Yue93ffcd2022-02-17 14:37:06 +08008565{
8566 ((void) tls_prf);
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01008567#if defined(MBEDTLS_MD_CAN_SHA384)
Gilles Peskine449bd832023-01-11 14:50:10 +01008568 if (tls_prf == tls_prf_sha384) {
8569 return MBEDTLS_SSL_TLS_PRF_SHA384;
8570 } else
Jerry Yue93ffcd2022-02-17 14:37:06 +08008571#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01008572#if defined(MBEDTLS_MD_CAN_SHA256)
Gilles Peskine449bd832023-01-11 14:50:10 +01008573 if (tls_prf == tls_prf_sha256) {
8574 return MBEDTLS_SSL_TLS_PRF_SHA256;
8575 } else
Jerry Yue93ffcd2022-02-17 14:37:06 +08008576#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01008577 return MBEDTLS_SSL_TLS_PRF_NONE;
Jerry Yue93ffcd2022-02-17 14:37:06 +08008578}
8579
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008580/*
8581 * Populate a transform structure with session keys and all the other
8582 * necessary information.
8583 *
8584 * Parameters:
8585 * - [in/out]: transform: structure to populate
8586 * [in] must be just initialised with mbedtls_ssl_transform_init()
8587 * [out] fully populated, ready for use by mbedtls_ssl_{en,de}crypt_buf()
8588 * - [in] ciphersuite
8589 * - [in] master
8590 * - [in] encrypt_then_mac
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008591 * - [in] tls_prf: pointer to PRF to use for key derivation
8592 * - [in] randbytes: buffer holding ServerHello.random + ClientHello.random
Glenn Strauss07c64162022-03-14 12:34:51 -04008593 * - [in] tls_version: TLS version
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008594 * - [in] endpoint: client or server
8595 * - [in] ssl: used for:
8596 * - ssl->conf->{f,p}_export_keys
8597 * [in] optionally used for:
8598 * - MBEDTLS_DEBUG_C: ssl->conf->{f,p}_dbg
8599 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02008600MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01008601static int ssl_tls12_populate_transform(mbedtls_ssl_transform *transform,
8602 int ciphersuite,
8603 const unsigned char master[48],
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008604#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01008605 int encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008606#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01008607 ssl_tls_prf_t tls_prf,
8608 const unsigned char randbytes[64],
8609 mbedtls_ssl_protocol_version tls_version,
8610 unsigned endpoint,
8611 const mbedtls_ssl_context *ssl)
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008612{
8613 int ret = 0;
8614 unsigned char keyblk[256];
8615 unsigned char *key1;
8616 unsigned char *key2;
8617 unsigned char *mac_enc;
8618 unsigned char *mac_dec;
8619 size_t mac_key_len = 0;
8620 size_t iv_copy_len;
8621 size_t keylen;
8622 const mbedtls_ssl_ciphersuite_t *ciphersuite_info;
Neil Armstrong7fea33e2022-04-01 15:40:25 +02008623 mbedtls_ssl_mode_t ssl_mode;
Neil Armstronge4512952022-03-08 09:08:22 +01008624#if !defined(MBEDTLS_USE_PSA_CRYPTO)
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008625 const mbedtls_cipher_info_t *cipher_info;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008626 const mbedtls_md_info_t *md_info;
Neil Armstronge4512952022-03-08 09:08:22 +01008627#endif /* !MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008628
8629#if defined(MBEDTLS_USE_PSA_CRYPTO)
8630 psa_key_type_t key_type;
8631 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
8632 psa_algorithm_t alg;
Neil Armstronge4512952022-03-08 09:08:22 +01008633 psa_algorithm_t mac_alg = 0;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008634 size_t key_bits;
8635 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
8636#endif
8637
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008638 /*
8639 * Some data just needs copying into the structure
8640 */
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008641#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008642 transform->encrypt_then_mac = encrypt_then_mac;
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008643#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Glenn Strauss07c64162022-03-14 12:34:51 -04008644 transform->tls_version = tls_version;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008645
8646#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01008647 memcpy(transform->randbytes, randbytes, sizeof(transform->randbytes));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008648#endif
8649
8650#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01008651 if (tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008652 /* At the moment, we keep TLS <= 1.2 and TLS 1.3 transform
8653 * generation separate. This should never happen. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008654 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008655 }
8656#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
8657
8658 /*
8659 * Get various info structures
8660 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008661 ciphersuite_info = mbedtls_ssl_ciphersuite_from_id(ciphersuite);
8662 if (ciphersuite_info == NULL) {
8663 MBEDTLS_SSL_DEBUG_MSG(1, ("ciphersuite info for %d not found",
8664 ciphersuite));
8665 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008666 }
8667
Neil Armstrongab555e02022-04-04 11:07:59 +02008668 ssl_mode = mbedtls_ssl_get_mode_from_ciphersuite(
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008669#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01008670 encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008671#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01008672 ciphersuite_info);
Neil Armstrong7fea33e2022-04-01 15:40:25 +02008673
Gilles Peskine449bd832023-01-11 14:50:10 +01008674 if (ssl_mode == MBEDTLS_SSL_MODE_AEAD) {
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008675 transform->taglen =
8676 ciphersuite_info->flags & MBEDTLS_CIPHERSUITE_SHORT_TAG ? 8 : 16;
Gilles Peskine449bd832023-01-11 14:50:10 +01008677 }
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008678
8679#if defined(MBEDTLS_USE_PSA_CRYPTO)
Dave Rodgman2eab4622023-10-05 13:30:37 +01008680 if ((status = mbedtls_ssl_cipher_to_psa((mbedtls_cipher_type_t) ciphersuite_info->cipher,
Gilles Peskine449bd832023-01-11 14:50:10 +01008681 transform->taglen,
8682 &alg,
8683 &key_type,
8684 &key_bits)) != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008685 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01008686 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_cipher_to_psa", ret);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008687 goto end;
8688 }
8689#else
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01008690 cipher_info = mbedtls_cipher_info_from_type((mbedtls_cipher_type_t) ciphersuite_info->cipher);
Gilles Peskine449bd832023-01-11 14:50:10 +01008691 if (cipher_info == NULL) {
8692 MBEDTLS_SSL_DEBUG_MSG(1, ("cipher info for %u not found",
8693 ciphersuite_info->cipher));
8694 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008695 }
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008696#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008697
Neil Armstronge4512952022-03-08 09:08:22 +01008698#if defined(MBEDTLS_USE_PSA_CRYPTO)
Dave Rodgman2eab4622023-10-05 13:30:37 +01008699 mac_alg = mbedtls_md_psa_alg_from_type((mbedtls_md_type_t) ciphersuite_info->mac);
Gilles Peskine449bd832023-01-11 14:50:10 +01008700 if (mac_alg == 0) {
Manuel Pégourié-Gonnard2d6d9932023-03-28 11:38:08 +02008701 MBEDTLS_SSL_DEBUG_MSG(1, ("mbedtls_md_psa_alg_from_type for %u not found",
Gilles Peskine449bd832023-01-11 14:50:10 +01008702 (unsigned) ciphersuite_info->mac));
8703 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Neil Armstronge4512952022-03-08 09:08:22 +01008704 }
8705#else
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01008706 md_info = mbedtls_md_info_from_type((mbedtls_md_type_t) ciphersuite_info->mac);
Gilles Peskine449bd832023-01-11 14:50:10 +01008707 if (md_info == NULL) {
8708 MBEDTLS_SSL_DEBUG_MSG(1, ("mbedtls_md info for %u not found",
8709 (unsigned) ciphersuite_info->mac));
8710 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008711 }
Neil Armstronge4512952022-03-08 09:08:22 +01008712#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008713
8714#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
8715 /* Copy own and peer's CID if the use of the CID
8716 * extension has been negotiated. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008717 if (ssl->handshake->cid_in_use == MBEDTLS_SSL_CID_ENABLED) {
8718 MBEDTLS_SSL_DEBUG_MSG(3, ("Copy CIDs into SSL transform"));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008719
8720 transform->in_cid_len = ssl->own_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01008721 memcpy(transform->in_cid, ssl->own_cid, ssl->own_cid_len);
8722 MBEDTLS_SSL_DEBUG_BUF(3, "Incoming CID", transform->in_cid,
8723 transform->in_cid_len);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008724
8725 transform->out_cid_len = ssl->handshake->peer_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01008726 memcpy(transform->out_cid, ssl->handshake->peer_cid,
8727 ssl->handshake->peer_cid_len);
8728 MBEDTLS_SSL_DEBUG_BUF(3, "Outgoing CID", transform->out_cid,
8729 transform->out_cid_len);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008730 }
8731#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
8732
8733 /*
8734 * Compute key block using the PRF
8735 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008736 ret = tls_prf(master, 48, "key expansion", randbytes, 64, keyblk, 256);
8737 if (ret != 0) {
8738 MBEDTLS_SSL_DEBUG_RET(1, "prf", ret);
8739 return ret;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008740 }
8741
Gilles Peskine449bd832023-01-11 14:50:10 +01008742 MBEDTLS_SSL_DEBUG_MSG(3, ("ciphersuite = %s",
8743 mbedtls_ssl_get_ciphersuite_name(ciphersuite)));
8744 MBEDTLS_SSL_DEBUG_BUF(3, "master secret", master, 48);
8745 MBEDTLS_SSL_DEBUG_BUF(4, "random bytes", randbytes, 64);
8746 MBEDTLS_SSL_DEBUG_BUF(4, "key block", keyblk, 256);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008747
8748 /*
8749 * Determine the appropriate key, IV and MAC length.
8750 */
8751
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008752#if defined(MBEDTLS_USE_PSA_CRYPTO)
8753 keylen = PSA_BITS_TO_BYTES(key_bits);
8754#else
Gilles Peskine449bd832023-01-11 14:50:10 +01008755 keylen = mbedtls_cipher_info_get_key_bitlen(cipher_info) / 8;
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008756#endif
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008757
Valerio Settie5707042023-10-11 11:54:42 +02008758#if defined(MBEDTLS_SSL_HAVE_AEAD)
Gilles Peskine449bd832023-01-11 14:50:10 +01008759 if (ssl_mode == MBEDTLS_SSL_MODE_AEAD) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008760 size_t explicit_ivlen;
8761
8762 transform->maclen = 0;
8763 mac_key_len = 0;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008764
8765 /* All modes haves 96-bit IVs, but the length of the static parts vary
8766 * with mode and version:
8767 * - For GCM and CCM in TLS 1.2, there's a static IV of 4 Bytes
8768 * (to be concatenated with a dynamically chosen IV of 8 Bytes)
8769 * - For ChaChaPoly in TLS 1.2, and all modes in TLS 1.3, there's
8770 * a static IV of 12 Bytes (to be XOR'ed with the 8 Byte record
8771 * sequence number).
8772 */
8773 transform->ivlen = 12;
David Horstmann3b2276a2022-10-06 14:49:08 +01008774
8775 int is_chachapoly = 0;
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008776#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01008777 is_chachapoly = (key_type == PSA_KEY_TYPE_CHACHA20);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008778#else
Gilles Peskine449bd832023-01-11 14:50:10 +01008779 is_chachapoly = (mbedtls_cipher_info_get_mode(cipher_info)
8780 == MBEDTLS_MODE_CHACHAPOLY);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008781#endif /* MBEDTLS_USE_PSA_CRYPTO */
David Horstmann3b2276a2022-10-06 14:49:08 +01008782
Gilles Peskine449bd832023-01-11 14:50:10 +01008783 if (is_chachapoly) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008784 transform->fixed_ivlen = 12;
Gilles Peskine449bd832023-01-11 14:50:10 +01008785 } else {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008786 transform->fixed_ivlen = 4;
Gilles Peskine449bd832023-01-11 14:50:10 +01008787 }
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008788
8789 /* Minimum length of encrypted record */
8790 explicit_ivlen = transform->ivlen - transform->fixed_ivlen;
8791 transform->minlen = explicit_ivlen + transform->taglen;
Gilles Peskine449bd832023-01-11 14:50:10 +01008792 } else
Valerio Settie5707042023-10-11 11:54:42 +02008793#endif /* MBEDTLS_SSL_HAVE_AEAD */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008794#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01008795 if (ssl_mode == MBEDTLS_SSL_MODE_STREAM ||
Neil Armstrong7fea33e2022-04-01 15:40:25 +02008796 ssl_mode == MBEDTLS_SSL_MODE_CBC ||
Gilles Peskine449bd832023-01-11 14:50:10 +01008797 ssl_mode == MBEDTLS_SSL_MODE_CBC_ETM) {
Neil Armstronge4512952022-03-08 09:08:22 +01008798#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01008799 size_t block_size = PSA_BLOCK_CIPHER_BLOCK_LENGTH(key_type);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008800#else
Dave Rodgman85a88132023-06-24 11:41:50 +01008801 size_t block_size = mbedtls_cipher_info_get_block_size(cipher_info);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008802#endif /* MBEDTLS_USE_PSA_CRYPTO */
8803
8804#if defined(MBEDTLS_USE_PSA_CRYPTO)
Neil Armstronge4512952022-03-08 09:08:22 +01008805 /* Get MAC length */
8806 mac_key_len = PSA_HASH_LENGTH(mac_alg);
8807#else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008808 /* Initialize HMAC contexts */
Gilles Peskine449bd832023-01-11 14:50:10 +01008809 if ((ret = mbedtls_md_setup(&transform->md_ctx_enc, md_info, 1)) != 0 ||
8810 (ret = mbedtls_md_setup(&transform->md_ctx_dec, md_info, 1)) != 0) {
8811 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_setup", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008812 goto end;
8813 }
8814
8815 /* Get MAC length */
Gilles Peskine449bd832023-01-11 14:50:10 +01008816 mac_key_len = mbedtls_md_get_size(md_info);
Neil Armstronge4512952022-03-08 09:08:22 +01008817#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008818 transform->maclen = mac_key_len;
8819
8820 /* IV length */
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008821#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01008822 transform->ivlen = PSA_CIPHER_IV_LENGTH(key_type, alg);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008823#else
Dave Rodgmanbb521fd2023-06-24 11:21:25 +01008824 transform->ivlen = mbedtls_cipher_info_get_iv_size(cipher_info);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008825#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008826
8827 /* Minimum length */
Gilles Peskine449bd832023-01-11 14:50:10 +01008828 if (ssl_mode == MBEDTLS_SSL_MODE_STREAM) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008829 transform->minlen = transform->maclen;
Gilles Peskine449bd832023-01-11 14:50:10 +01008830 } else {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008831 /*
8832 * GenericBlockCipher:
8833 * 1. if EtM is in use: one block plus MAC
8834 * otherwise: * first multiple of blocklen greater than maclen
8835 * 2. IV
8836 */
8837#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01008838 if (ssl_mode == MBEDTLS_SSL_MODE_CBC_ETM) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008839 transform->minlen = transform->maclen
Gilles Peskine449bd832023-01-11 14:50:10 +01008840 + block_size;
8841 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008842#endif
8843 {
8844 transform->minlen = transform->maclen
Gilles Peskine449bd832023-01-11 14:50:10 +01008845 + block_size
8846 - transform->maclen % block_size;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008847 }
8848
Gilles Peskine449bd832023-01-11 14:50:10 +01008849 if (tls_version == MBEDTLS_SSL_VERSION_TLS1_2) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008850 transform->minlen += transform->ivlen;
Gilles Peskine449bd832023-01-11 14:50:10 +01008851 } else {
8852 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008853 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
8854 goto end;
8855 }
8856 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008857 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008858#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
8859 {
Gilles Peskine449bd832023-01-11 14:50:10 +01008860 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
8861 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008862 }
8863
Gilles Peskine449bd832023-01-11 14:50:10 +01008864 MBEDTLS_SSL_DEBUG_MSG(3, ("keylen: %u, minlen: %u, ivlen: %u, maclen: %u",
8865 (unsigned) keylen,
8866 (unsigned) transform->minlen,
8867 (unsigned) transform->ivlen,
8868 (unsigned) transform->maclen));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008869
8870 /*
8871 * Finally setup the cipher contexts, IVs and MAC secrets.
8872 */
8873#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008874 if (endpoint == MBEDTLS_SSL_IS_CLIENT) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008875 key1 = keyblk + mac_key_len * 2;
8876 key2 = keyblk + mac_key_len * 2 + keylen;
8877
8878 mac_enc = keyblk;
8879 mac_dec = keyblk + mac_key_len;
8880
Gilles Peskine449bd832023-01-11 14:50:10 +01008881 iv_copy_len = (transform->fixed_ivlen) ?
8882 transform->fixed_ivlen : transform->ivlen;
8883 memcpy(transform->iv_enc, key2 + keylen, iv_copy_len);
8884 memcpy(transform->iv_dec, key2 + keylen + iv_copy_len,
8885 iv_copy_len);
8886 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008887#endif /* MBEDTLS_SSL_CLI_C */
8888#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008889 if (endpoint == MBEDTLS_SSL_IS_SERVER) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008890 key1 = keyblk + mac_key_len * 2 + keylen;
8891 key2 = keyblk + mac_key_len * 2;
8892
8893 mac_enc = keyblk + mac_key_len;
8894 mac_dec = keyblk;
8895
Gilles Peskine449bd832023-01-11 14:50:10 +01008896 iv_copy_len = (transform->fixed_ivlen) ?
8897 transform->fixed_ivlen : transform->ivlen;
8898 memcpy(transform->iv_dec, key1 + keylen, iv_copy_len);
8899 memcpy(transform->iv_enc, key1 + keylen + iv_copy_len,
8900 iv_copy_len);
8901 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008902#endif /* MBEDTLS_SSL_SRV_C */
8903 {
Gilles Peskine449bd832023-01-11 14:50:10 +01008904 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008905 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
8906 goto end;
8907 }
8908
Paul Elliott4fb19552023-10-18 12:15:30 +01008909 if (ssl->f_export_keys != NULL) {
Gilles Peskine449bd832023-01-11 14:50:10 +01008910 ssl->f_export_keys(ssl->p_export_keys,
8911 MBEDTLS_SSL_KEY_EXPORT_TLS12_MASTER_SECRET,
8912 master, 48,
8913 randbytes + 32,
8914 randbytes,
8915 tls_prf_get_type(tls_prf));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008916 }
8917
8918#if defined(MBEDTLS_USE_PSA_CRYPTO)
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008919 transform->psa_alg = alg;
8920
Gilles Peskine449bd832023-01-11 14:50:10 +01008921 if (alg != MBEDTLS_SSL_NULL_CIPHER) {
8922 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_ENCRYPT);
8923 psa_set_key_algorithm(&attributes, alg);
8924 psa_set_key_type(&attributes, key_type);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008925
Gilles Peskine449bd832023-01-11 14:50:10 +01008926 if ((status = psa_import_key(&attributes,
8927 key1,
8928 PSA_BITS_TO_BYTES(key_bits),
8929 &transform->psa_key_enc)) != PSA_SUCCESS) {
8930 MBEDTLS_SSL_DEBUG_RET(3, "psa_import_key", (int) status);
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008931 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01008932 MBEDTLS_SSL_DEBUG_RET(1, "psa_import_key", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008933 goto end;
8934 }
8935
Gilles Peskine449bd832023-01-11 14:50:10 +01008936 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_DECRYPT);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008937
Gilles Peskine449bd832023-01-11 14:50:10 +01008938 if ((status = psa_import_key(&attributes,
8939 key2,
8940 PSA_BITS_TO_BYTES(key_bits),
8941 &transform->psa_key_dec)) != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008942 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01008943 MBEDTLS_SSL_DEBUG_RET(1, "psa_import_key", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008944 goto end;
8945 }
8946 }
8947#else
Gilles Peskine449bd832023-01-11 14:50:10 +01008948 if ((ret = mbedtls_cipher_setup(&transform->cipher_ctx_enc,
8949 cipher_info)) != 0) {
8950 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_setup", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008951 goto end;
8952 }
8953
Gilles Peskine449bd832023-01-11 14:50:10 +01008954 if ((ret = mbedtls_cipher_setup(&transform->cipher_ctx_dec,
8955 cipher_info)) != 0) {
8956 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_setup", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008957 goto end;
8958 }
8959
Gilles Peskine449bd832023-01-11 14:50:10 +01008960 if ((ret = mbedtls_cipher_setkey(&transform->cipher_ctx_enc, key1,
8961 (int) mbedtls_cipher_info_get_key_bitlen(cipher_info),
8962 MBEDTLS_ENCRYPT)) != 0) {
8963 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_setkey", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008964 goto end;
8965 }
8966
Gilles Peskine449bd832023-01-11 14:50:10 +01008967 if ((ret = mbedtls_cipher_setkey(&transform->cipher_ctx_dec, key2,
8968 (int) mbedtls_cipher_info_get_key_bitlen(cipher_info),
8969 MBEDTLS_DECRYPT)) != 0) {
8970 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_setkey", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008971 goto end;
8972 }
8973
8974#if defined(MBEDTLS_CIPHER_MODE_CBC)
Gilles Peskine449bd832023-01-11 14:50:10 +01008975 if (mbedtls_cipher_info_get_mode(cipher_info) == MBEDTLS_MODE_CBC) {
8976 if ((ret = mbedtls_cipher_set_padding_mode(&transform->cipher_ctx_enc,
8977 MBEDTLS_PADDING_NONE)) != 0) {
8978 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_set_padding_mode", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008979 goto end;
8980 }
8981
Gilles Peskine449bd832023-01-11 14:50:10 +01008982 if ((ret = mbedtls_cipher_set_padding_mode(&transform->cipher_ctx_dec,
8983 MBEDTLS_PADDING_NONE)) != 0) {
8984 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_set_padding_mode", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008985 goto end;
8986 }
8987 }
8988#endif /* MBEDTLS_CIPHER_MODE_CBC */
8989#endif /* MBEDTLS_USE_PSA_CRYPTO */
8990
Neil Armstrong29c0c042022-03-17 17:47:28 +01008991#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
8992 /* For HMAC-based ciphersuites, initialize the HMAC transforms.
8993 For AEAD-based ciphersuites, there is nothing to do here. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008994 if (mac_key_len != 0) {
Neil Armstrong29c0c042022-03-17 17:47:28 +01008995#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01008996 transform->psa_mac_alg = PSA_ALG_HMAC(mac_alg);
Neil Armstrong29c0c042022-03-17 17:47:28 +01008997
Gilles Peskine449bd832023-01-11 14:50:10 +01008998 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_SIGN_MESSAGE);
8999 psa_set_key_algorithm(&attributes, PSA_ALG_HMAC(mac_alg));
9000 psa_set_key_type(&attributes, PSA_KEY_TYPE_HMAC);
Neil Armstrong29c0c042022-03-17 17:47:28 +01009001
Gilles Peskine449bd832023-01-11 14:50:10 +01009002 if ((status = psa_import_key(&attributes,
9003 mac_enc, mac_key_len,
9004 &transform->psa_mac_enc)) != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05009005 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01009006 MBEDTLS_SSL_DEBUG_RET(1, "psa_import_mac_key", ret);
Neil Armstrong29c0c042022-03-17 17:47:28 +01009007 goto end;
9008 }
9009
Gilles Peskine449bd832023-01-11 14:50:10 +01009010 if ((transform->psa_alg == MBEDTLS_SSL_NULL_CIPHER) ||
9011 ((transform->psa_alg == PSA_ALG_CBC_NO_PADDING)
Andrzej Kurek8c95ac42022-08-17 16:17:00 -04009012#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01009013 && (transform->encrypt_then_mac == MBEDTLS_SSL_ETM_DISABLED)
Andrzej Kurek8c95ac42022-08-17 16:17:00 -04009014#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01009015 )) {
Neil Armstrong29c0c042022-03-17 17:47:28 +01009016 /* mbedtls_ct_hmac() requires the key to be exportable */
Gilles Peskine449bd832023-01-11 14:50:10 +01009017 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_EXPORT |
9018 PSA_KEY_USAGE_VERIFY_HASH);
9019 } else {
9020 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_VERIFY_HASH);
9021 }
Neil Armstrong29c0c042022-03-17 17:47:28 +01009022
Gilles Peskine449bd832023-01-11 14:50:10 +01009023 if ((status = psa_import_key(&attributes,
9024 mac_dec, mac_key_len,
9025 &transform->psa_mac_dec)) != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05009026 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01009027 MBEDTLS_SSL_DEBUG_RET(1, "psa_import_mac_key", ret);
Neil Armstrong29c0c042022-03-17 17:47:28 +01009028 goto end;
9029 }
9030#else
Gilles Peskine449bd832023-01-11 14:50:10 +01009031 ret = mbedtls_md_hmac_starts(&transform->md_ctx_enc, mac_enc, mac_key_len);
9032 if (ret != 0) {
Neil Armstrong29c0c042022-03-17 17:47:28 +01009033 goto end;
Gilles Peskine449bd832023-01-11 14:50:10 +01009034 }
9035 ret = mbedtls_md_hmac_starts(&transform->md_ctx_dec, mac_dec, mac_key_len);
9036 if (ret != 0) {
Neil Armstrong29c0c042022-03-17 17:47:28 +01009037 goto end;
Gilles Peskine449bd832023-01-11 14:50:10 +01009038 }
Neil Armstrong29c0c042022-03-17 17:47:28 +01009039#endif /* MBEDTLS_USE_PSA_CRYPTO */
9040 }
9041#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
9042
9043 ((void) mac_dec);
9044 ((void) mac_enc);
9045
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009046end:
Gilles Peskine449bd832023-01-11 14:50:10 +01009047 mbedtls_platform_zeroize(keyblk, sizeof(keyblk));
9048 return ret;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009049}
9050
Valerio Settia08b1a42022-11-17 15:10:02 +01009051#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED) && \
9052 defined(MBEDTLS_USE_PSA_CRYPTO)
Valerio Setti6b3dab02022-11-17 17:14:54 +01009053int mbedtls_psa_ecjpake_read_round(
Gilles Peskine449bd832023-01-11 14:50:10 +01009054 psa_pake_operation_t *pake_ctx,
9055 const unsigned char *buf,
9056 size_t len, mbedtls_ecjpake_rounds_t round)
Valerio Settia08b1a42022-11-17 15:10:02 +01009057{
9058 psa_status_t status;
9059 size_t input_offset = 0;
Valerio Setti819de862022-11-17 18:05:19 +01009060 /*
Valerio Setti6b3dab02022-11-17 17:14:54 +01009061 * At round one repeat the KEY_SHARE, ZK_PUBLIC & ZF_PROOF twice
9062 * At round two perform a single cycle
9063 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009064 unsigned int remaining_steps = (round == MBEDTLS_ECJPAKE_ROUND_ONE) ? 2 : 1;
Valerio Settia08b1a42022-11-17 15:10:02 +01009065
Gilles Peskine449bd832023-01-11 14:50:10 +01009066 for (; remaining_steps > 0; remaining_steps--) {
9067 for (psa_pake_step_t step = PSA_PAKE_STEP_KEY_SHARE;
Valerio Settia08b1a42022-11-17 15:10:02 +01009068 step <= PSA_PAKE_STEP_ZK_PROOF;
Gilles Peskine449bd832023-01-11 14:50:10 +01009069 ++step) {
Valerio Settia08b1a42022-11-17 15:10:02 +01009070 /* Length is stored at the first byte */
9071 size_t length = buf[input_offset];
9072 input_offset += 1;
9073
Gilles Peskine449bd832023-01-11 14:50:10 +01009074 if (input_offset + length > len) {
Valerio Settia08b1a42022-11-17 15:10:02 +01009075 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
9076 }
9077
Gilles Peskine449bd832023-01-11 14:50:10 +01009078 status = psa_pake_input(pake_ctx, step,
9079 buf + input_offset, length);
9080 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05009081 return PSA_TO_MBEDTLS_ERR(status);
Valerio Settia08b1a42022-11-17 15:10:02 +01009082 }
9083
9084 input_offset += length;
9085 }
9086 }
9087
Gilles Peskine449bd832023-01-11 14:50:10 +01009088 if (input_offset != len) {
Valerio Setti61ea17d2022-11-18 12:11:00 +01009089 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Gilles Peskine449bd832023-01-11 14:50:10 +01009090 }
Valerio Setti30ebe112022-11-17 16:23:34 +01009091
Gilles Peskine449bd832023-01-11 14:50:10 +01009092 return 0;
Valerio Settia08b1a42022-11-17 15:10:02 +01009093}
9094
Valerio Setti6b3dab02022-11-17 17:14:54 +01009095int mbedtls_psa_ecjpake_write_round(
Gilles Peskine449bd832023-01-11 14:50:10 +01009096 psa_pake_operation_t *pake_ctx,
9097 unsigned char *buf,
9098 size_t len, size_t *olen,
9099 mbedtls_ecjpake_rounds_t round)
Valerio Settia08b1a42022-11-17 15:10:02 +01009100{
9101 psa_status_t status;
9102 size_t output_offset = 0;
9103 size_t output_len;
Valerio Setti819de862022-11-17 18:05:19 +01009104 /*
Valerio Setti6b3dab02022-11-17 17:14:54 +01009105 * At round one repeat the KEY_SHARE, ZK_PUBLIC & ZF_PROOF twice
9106 * At round two perform a single cycle
9107 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009108 unsigned int remaining_steps = (round == MBEDTLS_ECJPAKE_ROUND_ONE) ? 2 : 1;
Valerio Settia08b1a42022-11-17 15:10:02 +01009109
Gilles Peskine449bd832023-01-11 14:50:10 +01009110 for (; remaining_steps > 0; remaining_steps--) {
9111 for (psa_pake_step_t step = PSA_PAKE_STEP_KEY_SHARE;
9112 step <= PSA_PAKE_STEP_ZK_PROOF;
9113 ++step) {
Valerio Setti79f6b6b2022-11-21 14:17:03 +01009114 /*
Valerio Settid4a9b1a2022-11-22 11:11:10 +01009115 * For each step, prepend 1 byte with the length of the data as
9116 * given by psa_pake_output().
Valerio Setti79f6b6b2022-11-21 14:17:03 +01009117 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009118 status = psa_pake_output(pake_ctx, step,
9119 buf + output_offset + 1,
9120 len - output_offset - 1,
9121 &output_len);
9122 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05009123 return PSA_TO_MBEDTLS_ERR(status);
Valerio Settia08b1a42022-11-17 15:10:02 +01009124 }
9125
Valerio Setti99d88c12022-11-22 16:03:43 +01009126 *(buf + output_offset) = (uint8_t) output_len;
Valerio Setti79f6b6b2022-11-21 14:17:03 +01009127
9128 output_offset += output_len + 1;
Valerio Settia08b1a42022-11-17 15:10:02 +01009129 }
9130 }
9131
9132 *olen = output_offset;
9133
Gilles Peskine449bd832023-01-11 14:50:10 +01009134 return 0;
Valerio Settia08b1a42022-11-17 15:10:02 +01009135}
Valerio Settia08b1a42022-11-17 15:10:02 +01009136#endif //MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED && MBEDTLS_USE_PSA_CRYPTO
9137
Jerry Yuee40f9d2022-02-17 14:55:16 +08009138#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01009139int mbedtls_ssl_get_key_exchange_md_tls1_2(mbedtls_ssl_context *ssl,
9140 unsigned char *hash, size_t *hashlen,
9141 unsigned char *data, size_t data_len,
9142 mbedtls_md_type_t md_alg)
Jerry Yuee40f9d2022-02-17 14:55:16 +08009143{
9144 psa_status_t status;
9145 psa_hash_operation_t hash_operation = PSA_HASH_OPERATION_INIT;
Manuel Pégourié-Gonnard2d6d9932023-03-28 11:38:08 +02009146 psa_algorithm_t hash_alg = mbedtls_md_psa_alg_from_type(md_alg);
Jerry Yuee40f9d2022-02-17 14:55:16 +08009147
Gilles Peskine449bd832023-01-11 14:50:10 +01009148 MBEDTLS_SSL_DEBUG_MSG(3, ("Perform PSA-based computation of digest of ServerKeyExchange"));
Jerry Yuee40f9d2022-02-17 14:55:16 +08009149
Gilles Peskine449bd832023-01-11 14:50:10 +01009150 if ((status = psa_hash_setup(&hash_operation,
9151 hash_alg)) != PSA_SUCCESS) {
9152 MBEDTLS_SSL_DEBUG_RET(1, "psa_hash_setup", status);
Jerry Yuee40f9d2022-02-17 14:55:16 +08009153 goto exit;
9154 }
9155
Gilles Peskine449bd832023-01-11 14:50:10 +01009156 if ((status = psa_hash_update(&hash_operation, ssl->handshake->randbytes,
9157 64)) != PSA_SUCCESS) {
9158 MBEDTLS_SSL_DEBUG_RET(1, "psa_hash_update", status);
Jerry Yuee40f9d2022-02-17 14:55:16 +08009159 goto exit;
9160 }
9161
Gilles Peskine449bd832023-01-11 14:50:10 +01009162 if ((status = psa_hash_update(&hash_operation,
9163 data, data_len)) != PSA_SUCCESS) {
9164 MBEDTLS_SSL_DEBUG_RET(1, "psa_hash_update", status);
Jerry Yuee40f9d2022-02-17 14:55:16 +08009165 goto exit;
9166 }
9167
Gilles Peskine449bd832023-01-11 14:50:10 +01009168 if ((status = psa_hash_finish(&hash_operation, hash, PSA_HASH_MAX_SIZE,
9169 hashlen)) != PSA_SUCCESS) {
9170 MBEDTLS_SSL_DEBUG_RET(1, "psa_hash_finish", status);
9171 goto exit;
Jerry Yuee40f9d2022-02-17 14:55:16 +08009172 }
9173
9174exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01009175 if (status != PSA_SUCCESS) {
9176 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
9177 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR);
9178 switch (status) {
Jerry Yuee40f9d2022-02-17 14:55:16 +08009179 case PSA_ERROR_NOT_SUPPORTED:
Gilles Peskine449bd832023-01-11 14:50:10 +01009180 return MBEDTLS_ERR_MD_FEATURE_UNAVAILABLE;
Jerry Yuee40f9d2022-02-17 14:55:16 +08009181 case PSA_ERROR_BAD_STATE: /* Intentional fallthrough */
9182 case PSA_ERROR_BUFFER_TOO_SMALL:
Gilles Peskine449bd832023-01-11 14:50:10 +01009183 return MBEDTLS_ERR_MD_BAD_INPUT_DATA;
Jerry Yuee40f9d2022-02-17 14:55:16 +08009184 case PSA_ERROR_INSUFFICIENT_MEMORY:
Gilles Peskine449bd832023-01-11 14:50:10 +01009185 return MBEDTLS_ERR_MD_ALLOC_FAILED;
Jerry Yuee40f9d2022-02-17 14:55:16 +08009186 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01009187 return MBEDTLS_ERR_PLATFORM_HW_ACCEL_FAILED;
Jerry Yuee40f9d2022-02-17 14:55:16 +08009188 }
9189 }
Gilles Peskine449bd832023-01-11 14:50:10 +01009190 return 0;
Jerry Yuee40f9d2022-02-17 14:55:16 +08009191}
9192
9193#else
9194
Gilles Peskine449bd832023-01-11 14:50:10 +01009195int mbedtls_ssl_get_key_exchange_md_tls1_2(mbedtls_ssl_context *ssl,
9196 unsigned char *hash, size_t *hashlen,
9197 unsigned char *data, size_t data_len,
9198 mbedtls_md_type_t md_alg)
Jerry Yuee40f9d2022-02-17 14:55:16 +08009199{
9200 int ret = 0;
9201 mbedtls_md_context_t ctx;
Gilles Peskine449bd832023-01-11 14:50:10 +01009202 const mbedtls_md_info_t *md_info = mbedtls_md_info_from_type(md_alg);
9203 *hashlen = mbedtls_md_get_size(md_info);
Jerry Yuee40f9d2022-02-17 14:55:16 +08009204
Gilles Peskine449bd832023-01-11 14:50:10 +01009205 MBEDTLS_SSL_DEBUG_MSG(3, ("Perform mbedtls-based computation of digest of ServerKeyExchange"));
Jerry Yuee40f9d2022-02-17 14:55:16 +08009206
Gilles Peskine449bd832023-01-11 14:50:10 +01009207 mbedtls_md_init(&ctx);
Jerry Yuee40f9d2022-02-17 14:55:16 +08009208
9209 /*
9210 * digitally-signed struct {
9211 * opaque client_random[32];
9212 * opaque server_random[32];
9213 * ServerDHParams params;
9214 * };
9215 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009216 if ((ret = mbedtls_md_setup(&ctx, md_info, 0)) != 0) {
9217 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_setup", ret);
Jerry Yuee40f9d2022-02-17 14:55:16 +08009218 goto exit;
9219 }
Gilles Peskine449bd832023-01-11 14:50:10 +01009220 if ((ret = mbedtls_md_starts(&ctx)) != 0) {
9221 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_starts", ret);
Jerry Yuee40f9d2022-02-17 14:55:16 +08009222 goto exit;
9223 }
Gilles Peskine449bd832023-01-11 14:50:10 +01009224 if ((ret = mbedtls_md_update(&ctx, ssl->handshake->randbytes, 64)) != 0) {
9225 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_update", ret);
Jerry Yuee40f9d2022-02-17 14:55:16 +08009226 goto exit;
9227 }
Gilles Peskine449bd832023-01-11 14:50:10 +01009228 if ((ret = mbedtls_md_update(&ctx, data, data_len)) != 0) {
9229 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_update", ret);
Jerry Yuee40f9d2022-02-17 14:55:16 +08009230 goto exit;
9231 }
Gilles Peskine449bd832023-01-11 14:50:10 +01009232 if ((ret = mbedtls_md_finish(&ctx, hash)) != 0) {
9233 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_finish", ret);
Jerry Yuee40f9d2022-02-17 14:55:16 +08009234 goto exit;
9235 }
9236
9237exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01009238 mbedtls_md_free(&ctx);
Jerry Yuee40f9d2022-02-17 14:55:16 +08009239
Gilles Peskine449bd832023-01-11 14:50:10 +01009240 if (ret != 0) {
9241 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
9242 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR);
9243 }
Jerry Yuee40f9d2022-02-17 14:55:16 +08009244
Gilles Peskine449bd832023-01-11 14:50:10 +01009245 return ret;
Jerry Yuee40f9d2022-02-17 14:55:16 +08009246}
9247#endif /* MBEDTLS_USE_PSA_CRYPTO */
9248
Jerry Yud9d91da2022-02-17 14:57:06 +08009249#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
9250
Gabor Mezeia3d016c2022-05-10 12:44:09 +02009251/* Find the preferred hash for a given signature algorithm. */
9252unsigned int mbedtls_ssl_tls12_get_preferred_hash_for_sig_alg(
Gilles Peskine449bd832023-01-11 14:50:10 +01009253 mbedtls_ssl_context *ssl,
9254 unsigned int sig_alg)
Jerry Yud9d91da2022-02-17 14:57:06 +08009255{
Gabor Mezei078e8032022-04-27 21:17:56 +02009256 unsigned int i;
Gabor Mezeia3d016c2022-05-10 12:44:09 +02009257 uint16_t *received_sig_algs = ssl->handshake->received_sig_algs;
Gabor Mezei078e8032022-04-27 21:17:56 +02009258
Gilles Peskine449bd832023-01-11 14:50:10 +01009259 if (sig_alg == MBEDTLS_SSL_SIG_ANON) {
9260 return MBEDTLS_SSL_HASH_NONE;
9261 }
Gabor Mezei078e8032022-04-27 21:17:56 +02009262
Gilles Peskine449bd832023-01-11 14:50:10 +01009263 for (i = 0; received_sig_algs[i] != MBEDTLS_TLS_SIG_NONE; i++) {
Neil Armstrong9f1176a2022-06-24 18:19:19 +02009264 unsigned int hash_alg_received =
Gilles Peskine449bd832023-01-11 14:50:10 +01009265 MBEDTLS_SSL_TLS12_HASH_ALG_FROM_SIG_AND_HASH_ALG(
9266 received_sig_algs[i]);
Neil Armstrong9f1176a2022-06-24 18:19:19 +02009267 unsigned int sig_alg_received =
Gilles Peskine449bd832023-01-11 14:50:10 +01009268 MBEDTLS_SSL_TLS12_SIG_ALG_FROM_SIG_AND_HASH_ALG(
9269 received_sig_algs[i]);
Neil Armstrong9f1176a2022-06-24 18:19:19 +02009270
Manuel Pégourié-Gonnard47bb3802023-06-05 12:40:32 +02009271 mbedtls_md_type_t md_alg =
9272 mbedtls_ssl_md_alg_from_hash((unsigned char) hash_alg_received);
9273 if (md_alg == MBEDTLS_MD_NONE) {
9274 continue;
9275 }
9276
Gilles Peskine449bd832023-01-11 14:50:10 +01009277 if (sig_alg == sig_alg_received) {
Neil Armstrong9f1176a2022-06-24 18:19:19 +02009278#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01009279 if (ssl->handshake->key_cert && ssl->handshake->key_cert->key) {
Neil Armstrong96eceb82022-06-30 18:05:05 +02009280 psa_algorithm_t psa_hash_alg =
Manuel Pégourié-Gonnard47bb3802023-06-05 12:40:32 +02009281 mbedtls_md_psa_alg_from_type(md_alg);
Neil Armstrong9f1176a2022-06-24 18:19:19 +02009282
Gilles Peskine449bd832023-01-11 14:50:10 +01009283 if (sig_alg_received == MBEDTLS_SSL_SIG_ECDSA &&
9284 !mbedtls_pk_can_do_ext(ssl->handshake->key_cert->key,
9285 PSA_ALG_ECDSA(psa_hash_alg),
9286 PSA_KEY_USAGE_SIGN_HASH)) {
Neil Armstrong9f1176a2022-06-24 18:19:19 +02009287 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01009288 }
Neil Armstrong9f1176a2022-06-24 18:19:19 +02009289
Gilles Peskine449bd832023-01-11 14:50:10 +01009290 if (sig_alg_received == MBEDTLS_SSL_SIG_RSA &&
9291 !mbedtls_pk_can_do_ext(ssl->handshake->key_cert->key,
9292 PSA_ALG_RSA_PKCS1V15_SIGN(
9293 psa_hash_alg),
9294 PSA_KEY_USAGE_SIGN_HASH)) {
Neil Armstrong9f1176a2022-06-24 18:19:19 +02009295 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01009296 }
Neil Armstrong9f1176a2022-06-24 18:19:19 +02009297 }
Neil Armstrong9f1176a2022-06-24 18:19:19 +02009298#endif /* MBEDTLS_USE_PSA_CRYPTO */
Neil Armstrong96eceb82022-06-30 18:05:05 +02009299
Gilles Peskine449bd832023-01-11 14:50:10 +01009300 return hash_alg_received;
Neil Armstrong9f1176a2022-06-24 18:19:19 +02009301 }
Jerry Yud9d91da2022-02-17 14:57:06 +08009302 }
Jerry Yud9d91da2022-02-17 14:57:06 +08009303
Gilles Peskine449bd832023-01-11 14:50:10 +01009304 return MBEDTLS_SSL_HASH_NONE;
Jerry Yud9d91da2022-02-17 14:57:06 +08009305}
9306
9307#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
9308
Jerry Yudc7bd172022-02-17 13:44:15 +08009309#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
9310
XiaokangQian75d40ef2022-04-20 11:05:24 +00009311int mbedtls_ssl_validate_ciphersuite(
9312 const mbedtls_ssl_context *ssl,
9313 const mbedtls_ssl_ciphersuite_t *suite_info,
9314 mbedtls_ssl_protocol_version min_tls_version,
Gilles Peskine449bd832023-01-11 14:50:10 +01009315 mbedtls_ssl_protocol_version max_tls_version)
XiaokangQian75d40ef2022-04-20 11:05:24 +00009316{
9317 (void) ssl;
9318
Gilles Peskine449bd832023-01-11 14:50:10 +01009319 if (suite_info == NULL) {
9320 return -1;
9321 }
XiaokangQian75d40ef2022-04-20 11:05:24 +00009322
Gilles Peskine449bd832023-01-11 14:50:10 +01009323 if ((suite_info->min_tls_version > max_tls_version) ||
9324 (suite_info->max_tls_version < min_tls_version)) {
9325 return -1;
XiaokangQian75d40ef2022-04-20 11:05:24 +00009326 }
9327
XiaokangQian060d8672022-04-21 09:24:56 +00009328#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_CLI_C)
XiaokangQian75d40ef2022-04-20 11:05:24 +00009329#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Neil Armstrongca7d5062022-05-31 14:43:23 +02009330#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01009331 if (suite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_ECJPAKE &&
9332 ssl->handshake->psa_pake_ctx_is_ok != 1)
Neil Armstrongca7d5062022-05-31 14:43:23 +02009333#else
Gilles Peskine449bd832023-01-11 14:50:10 +01009334 if (suite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_ECJPAKE &&
9335 mbedtls_ecjpake_check(&ssl->handshake->ecjpake_ctx) != 0)
Neil Armstrongca7d5062022-05-31 14:43:23 +02009336#endif /* MBEDTLS_USE_PSA_CRYPTO */
XiaokangQian75d40ef2022-04-20 11:05:24 +00009337 {
Gilles Peskine449bd832023-01-11 14:50:10 +01009338 return -1;
XiaokangQian75d40ef2022-04-20 11:05:24 +00009339 }
9340#endif
9341
9342 /* Don't suggest PSK-based ciphersuite if no PSK is available. */
9343#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01009344 if (mbedtls_ssl_ciphersuite_uses_psk(suite_info) &&
9345 mbedtls_ssl_conf_has_static_psk(ssl->conf) == 0) {
9346 return -1;
XiaokangQian75d40ef2022-04-20 11:05:24 +00009347 }
9348#endif /* MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
9349#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
9350
Gilles Peskine449bd832023-01-11 14:50:10 +01009351 return 0;
XiaokangQian75d40ef2022-04-20 11:05:24 +00009352}
9353
Ronald Crone68ab4f2022-10-05 12:46:29 +02009354#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
XiaokangQianeaf36512022-04-24 09:07:44 +00009355/*
9356 * Function for writing a signature algorithm extension.
9357 *
9358 * The `extension_data` field of signature algorithm contains a `SignatureSchemeList`
9359 * value (TLS 1.3 RFC8446):
9360 * enum {
9361 * ....
9362 * ecdsa_secp256r1_sha256( 0x0403 ),
9363 * ecdsa_secp384r1_sha384( 0x0503 ),
9364 * ecdsa_secp521r1_sha512( 0x0603 ),
9365 * ....
9366 * } SignatureScheme;
9367 *
9368 * struct {
9369 * SignatureScheme supported_signature_algorithms<2..2^16-2>;
9370 * } SignatureSchemeList;
9371 *
9372 * The `extension_data` field of signature algorithm contains a `SignatureAndHashAlgorithm`
9373 * value (TLS 1.2 RFC5246):
9374 * enum {
9375 * none(0), md5(1), sha1(2), sha224(3), sha256(4), sha384(5),
9376 * sha512(6), (255)
9377 * } HashAlgorithm;
9378 *
9379 * enum { anonymous(0), rsa(1), dsa(2), ecdsa(3), (255) }
9380 * SignatureAlgorithm;
9381 *
9382 * struct {
9383 * HashAlgorithm hash;
9384 * SignatureAlgorithm signature;
9385 * } SignatureAndHashAlgorithm;
9386 *
9387 * SignatureAndHashAlgorithm
9388 * supported_signature_algorithms<2..2^16-2>;
9389 *
9390 * The TLS 1.3 signature algorithm extension was defined to be a compatible
9391 * generalization of the TLS 1.2 signature algorithm extension.
9392 * `SignatureAndHashAlgorithm` field of TLS 1.2 can be represented by
9393 * `SignatureScheme` field of TLS 1.3
9394 *
9395 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009396int mbedtls_ssl_write_sig_alg_ext(mbedtls_ssl_context *ssl, unsigned char *buf,
9397 const unsigned char *end, size_t *out_len)
XiaokangQianeaf36512022-04-24 09:07:44 +00009398{
9399 unsigned char *p = buf;
9400 unsigned char *supported_sig_alg; /* Start of supported_signature_algorithms */
9401 size_t supported_sig_alg_len = 0; /* Length of supported_signature_algorithms */
9402
9403 *out_len = 0;
9404
Gilles Peskine449bd832023-01-11 14:50:10 +01009405 MBEDTLS_SSL_DEBUG_MSG(3, ("adding signature_algorithms extension"));
XiaokangQianeaf36512022-04-24 09:07:44 +00009406
9407 /* Check if we have space for header and length field:
9408 * - extension_type (2 bytes)
9409 * - extension_data_length (2 bytes)
9410 * - supported_signature_algorithms_length (2 bytes)
9411 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009412 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 6);
XiaokangQianeaf36512022-04-24 09:07:44 +00009413 p += 6;
9414
9415 /*
9416 * Write supported_signature_algorithms
9417 */
9418 supported_sig_alg = p;
Gilles Peskine449bd832023-01-11 14:50:10 +01009419 const uint16_t *sig_alg = mbedtls_ssl_get_sig_algs(ssl);
9420 if (sig_alg == NULL) {
9421 return MBEDTLS_ERR_SSL_BAD_CONFIG;
9422 }
XiaokangQianeaf36512022-04-24 09:07:44 +00009423
Gilles Peskine449bd832023-01-11 14:50:10 +01009424 for (; *sig_alg != MBEDTLS_TLS1_3_SIG_NONE; sig_alg++) {
9425 MBEDTLS_SSL_DEBUG_MSG(3, ("got signature scheme [%x] %s",
9426 *sig_alg,
9427 mbedtls_ssl_sig_alg_to_str(*sig_alg)));
9428 if (!mbedtls_ssl_sig_alg_is_supported(ssl, *sig_alg)) {
XiaokangQianeaf36512022-04-24 09:07:44 +00009429 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01009430 }
9431 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 2);
9432 MBEDTLS_PUT_UINT16_BE(*sig_alg, p, 0);
XiaokangQianeaf36512022-04-24 09:07:44 +00009433 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01009434 MBEDTLS_SSL_DEBUG_MSG(3, ("sent signature scheme [%x] %s",
9435 *sig_alg,
9436 mbedtls_ssl_sig_alg_to_str(*sig_alg)));
XiaokangQianeaf36512022-04-24 09:07:44 +00009437 }
9438
9439 /* Length of supported_signature_algorithms */
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00009440 supported_sig_alg_len = (size_t) (p - supported_sig_alg);
Gilles Peskine449bd832023-01-11 14:50:10 +01009441 if (supported_sig_alg_len == 0) {
9442 MBEDTLS_SSL_DEBUG_MSG(1, ("No signature algorithms defined."));
9443 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
XiaokangQianeaf36512022-04-24 09:07:44 +00009444 }
9445
Gilles Peskine449bd832023-01-11 14:50:10 +01009446 MBEDTLS_PUT_UINT16_BE(MBEDTLS_TLS_EXT_SIG_ALG, buf, 0);
9447 MBEDTLS_PUT_UINT16_BE(supported_sig_alg_len + 2, buf, 2);
9448 MBEDTLS_PUT_UINT16_BE(supported_sig_alg_len, buf, 4);
XiaokangQianeaf36512022-04-24 09:07:44 +00009449
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00009450 *out_len = (size_t) (p - buf);
XiaokangQianeaf36512022-04-24 09:07:44 +00009451
9452#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01009453 mbedtls_ssl_tls13_set_hs_sent_ext_mask(ssl, MBEDTLS_TLS_EXT_SIG_ALG);
XiaokangQianeaf36512022-04-24 09:07:44 +00009454#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yu0c354a22022-08-29 15:25:36 +08009455
Gilles Peskine449bd832023-01-11 14:50:10 +01009456 return 0;
XiaokangQianeaf36512022-04-24 09:07:44 +00009457}
Ronald Crone68ab4f2022-10-05 12:46:29 +02009458#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
XiaokangQianeaf36512022-04-24 09:07:44 +00009459
XiaokangQian40a35232022-05-07 09:02:40 +00009460#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
XiaokangQian9b2b7712022-05-17 02:57:00 +00009461/*
9462 * mbedtls_ssl_parse_server_name_ext
9463 *
9464 * Structure of server_name extension:
9465 *
9466 * enum {
9467 * host_name(0), (255)
9468 * } NameType;
9469 * opaque HostName<1..2^16-1>;
9470 *
9471 * struct {
9472 * NameType name_type;
9473 * select (name_type) {
9474 * case host_name: HostName;
9475 * } name;
9476 * } ServerName;
9477 * struct {
9478 * ServerName server_name_list<1..2^16-1>
9479 * } ServerNameList;
9480 */
Ronald Cronce7d76e2022-07-08 18:56:49 +02009481MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01009482int mbedtls_ssl_parse_server_name_ext(mbedtls_ssl_context *ssl,
9483 const unsigned char *buf,
9484 const unsigned char *end)
XiaokangQian40a35232022-05-07 09:02:40 +00009485{
9486 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
9487 const unsigned char *p = buf;
XiaokangQian9b2b7712022-05-17 02:57:00 +00009488 size_t server_name_list_len, hostname_len;
9489 const unsigned char *server_name_list_end;
XiaokangQian40a35232022-05-07 09:02:40 +00009490
Gilles Peskine449bd832023-01-11 14:50:10 +01009491 MBEDTLS_SSL_DEBUG_MSG(3, ("parse ServerName extension"));
XiaokangQian40a35232022-05-07 09:02:40 +00009492
Gilles Peskine449bd832023-01-11 14:50:10 +01009493 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
9494 server_name_list_len = MBEDTLS_GET_UINT16_BE(p, 0);
XiaokangQian40a35232022-05-07 09:02:40 +00009495 p += 2;
9496
Gilles Peskine449bd832023-01-11 14:50:10 +01009497 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, server_name_list_len);
XiaokangQian9b2b7712022-05-17 02:57:00 +00009498 server_name_list_end = p + server_name_list_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01009499 while (p < server_name_list_end) {
9500 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, server_name_list_end, 3);
9501 hostname_len = MBEDTLS_GET_UINT16_BE(p, 1);
9502 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, server_name_list_end,
9503 hostname_len + 3);
XiaokangQian40a35232022-05-07 09:02:40 +00009504
Gilles Peskine449bd832023-01-11 14:50:10 +01009505 if (p[0] == MBEDTLS_TLS_EXT_SERVERNAME_HOSTNAME) {
XiaokangQian75fe8c72022-06-15 09:42:45 +00009506 /* sni_name is intended to be used only during the parsing of the
9507 * ClientHello message (it is reset to NULL before the end of
9508 * the message parsing). Thus it is ok to just point to the
9509 * reception buffer and not make a copy of it.
9510 */
XiaokangQianf2a94202022-05-20 06:44:24 +00009511 ssl->handshake->sni_name = p + 3;
9512 ssl->handshake->sni_name_len = hostname_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01009513 if (ssl->conf->f_sni == NULL) {
9514 return 0;
XiaokangQian40a35232022-05-07 09:02:40 +00009515 }
Gilles Peskine449bd832023-01-11 14:50:10 +01009516 ret = ssl->conf->f_sni(ssl->conf->p_sni,
9517 ssl, p + 3, hostname_len);
9518 if (ret != 0) {
9519 MBEDTLS_SSL_DEBUG_RET(1, "ssl_sni_wrapper", ret);
9520 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_UNRECOGNIZED_NAME,
9521 MBEDTLS_ERR_SSL_UNRECOGNIZED_NAME);
9522 return MBEDTLS_ERR_SSL_UNRECOGNIZED_NAME;
9523 }
9524 return 0;
XiaokangQian40a35232022-05-07 09:02:40 +00009525 }
9526
9527 p += hostname_len + 3;
9528 }
9529
Gilles Peskine449bd832023-01-11 14:50:10 +01009530 return 0;
XiaokangQian40a35232022-05-07 09:02:40 +00009531}
9532#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
9533
XiaokangQianacb39922022-06-17 10:18:48 +00009534#if defined(MBEDTLS_SSL_ALPN)
Ronald Cronce7d76e2022-07-08 18:56:49 +02009535MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01009536int mbedtls_ssl_parse_alpn_ext(mbedtls_ssl_context *ssl,
9537 const unsigned char *buf,
9538 const unsigned char *end)
XiaokangQianacb39922022-06-17 10:18:48 +00009539{
9540 const unsigned char *p = buf;
XiaokangQianc7403452022-06-23 03:24:12 +00009541 size_t protocol_name_list_len;
XiaokangQian95d5f542022-06-24 02:29:26 +00009542 const unsigned char *protocol_name_list;
9543 const unsigned char *protocol_name_list_end;
XiaokangQianc7403452022-06-23 03:24:12 +00009544 size_t protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00009545
9546 /* If ALPN not configured, just ignore the extension */
Gilles Peskine449bd832023-01-11 14:50:10 +01009547 if (ssl->conf->alpn_list == NULL) {
9548 return 0;
9549 }
XiaokangQianacb39922022-06-17 10:18:48 +00009550
9551 /*
XiaokangQianc7403452022-06-23 03:24:12 +00009552 * RFC7301, section 3.1
9553 * opaque ProtocolName<1..2^8-1>;
XiaokangQianacb39922022-06-17 10:18:48 +00009554 *
XiaokangQianc7403452022-06-23 03:24:12 +00009555 * struct {
9556 * ProtocolName protocol_name_list<2..2^16-1>
9557 * } ProtocolNameList;
XiaokangQianacb39922022-06-17 10:18:48 +00009558 */
9559
XiaokangQianc7403452022-06-23 03:24:12 +00009560 /*
XiaokangQian0b776e22022-06-24 09:04:59 +00009561 * protocol_name_list_len 2 bytes
9562 * protocol_name_len 1 bytes
9563 * protocol_name >=1 byte
XiaokangQianc7403452022-06-23 03:24:12 +00009564 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009565 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 4);
XiaokangQianacb39922022-06-17 10:18:48 +00009566
Gilles Peskine449bd832023-01-11 14:50:10 +01009567 protocol_name_list_len = MBEDTLS_GET_UINT16_BE(p, 0);
XiaokangQianacb39922022-06-17 10:18:48 +00009568 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01009569 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, protocol_name_list_len);
XiaokangQian95d5f542022-06-24 02:29:26 +00009570 protocol_name_list = p;
9571 protocol_name_list_end = p + protocol_name_list_len;
XiaokangQianacb39922022-06-17 10:18:48 +00009572
9573 /* Validate peer's list (lengths) */
Gilles Peskine449bd832023-01-11 14:50:10 +01009574 while (p < protocol_name_list_end) {
XiaokangQian95d5f542022-06-24 02:29:26 +00009575 protocol_name_len = *p++;
Gilles Peskine449bd832023-01-11 14:50:10 +01009576 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, protocol_name_list_end,
9577 protocol_name_len);
9578 if (protocol_name_len == 0) {
XiaokangQian95d5f542022-06-24 02:29:26 +00009579 MBEDTLS_SSL_PEND_FATAL_ALERT(
9580 MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
Gilles Peskine449bd832023-01-11 14:50:10 +01009581 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
9582 return MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
XiaokangQian95d5f542022-06-24 02:29:26 +00009583 }
9584
9585 p += protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00009586 }
9587
9588 /* Use our order of preference */
Gilles Peskine449bd832023-01-11 14:50:10 +01009589 for (const char **alpn = ssl->conf->alpn_list; *alpn != NULL; alpn++) {
9590 size_t const alpn_len = strlen(*alpn);
XiaokangQian95d5f542022-06-24 02:29:26 +00009591 p = protocol_name_list;
Gilles Peskine449bd832023-01-11 14:50:10 +01009592 while (p < protocol_name_list_end) {
XiaokangQian95d5f542022-06-24 02:29:26 +00009593 protocol_name_len = *p++;
Gilles Peskine449bd832023-01-11 14:50:10 +01009594 if (protocol_name_len == alpn_len &&
9595 memcmp(p, *alpn, alpn_len) == 0) {
XiaokangQianacb39922022-06-17 10:18:48 +00009596 ssl->alpn_chosen = *alpn;
Gilles Peskine449bd832023-01-11 14:50:10 +01009597 return 0;
XiaokangQianacb39922022-06-17 10:18:48 +00009598 }
XiaokangQian95d5f542022-06-24 02:29:26 +00009599
9600 p += protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00009601 }
9602 }
9603
XiaokangQian95d5f542022-06-24 02:29:26 +00009604 /* If we get here, no match was found */
XiaokangQianacb39922022-06-17 10:18:48 +00009605 MBEDTLS_SSL_PEND_FATAL_ALERT(
Gilles Peskine449bd832023-01-11 14:50:10 +01009606 MBEDTLS_SSL_ALERT_MSG_NO_APPLICATION_PROTOCOL,
9607 MBEDTLS_ERR_SSL_NO_APPLICATION_PROTOCOL);
9608 return MBEDTLS_ERR_SSL_NO_APPLICATION_PROTOCOL;
XiaokangQianacb39922022-06-17 10:18:48 +00009609}
9610
Gilles Peskine449bd832023-01-11 14:50:10 +01009611int mbedtls_ssl_write_alpn_ext(mbedtls_ssl_context *ssl,
9612 unsigned char *buf,
9613 unsigned char *end,
9614 size_t *out_len)
XiaokangQianacb39922022-06-17 10:18:48 +00009615{
9616 unsigned char *p = buf;
XiaokangQian95d5f542022-06-24 02:29:26 +00009617 size_t protocol_name_len;
XiaokangQianc7403452022-06-23 03:24:12 +00009618 *out_len = 0;
XiaokangQianacb39922022-06-17 10:18:48 +00009619
Gilles Peskine449bd832023-01-11 14:50:10 +01009620 if (ssl->alpn_chosen == NULL) {
9621 return 0;
XiaokangQianacb39922022-06-17 10:18:48 +00009622 }
9623
Gilles Peskine449bd832023-01-11 14:50:10 +01009624 protocol_name_len = strlen(ssl->alpn_chosen);
9625 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 7 + protocol_name_len);
XiaokangQianacb39922022-06-17 10:18:48 +00009626
Gilles Peskine449bd832023-01-11 14:50:10 +01009627 MBEDTLS_SSL_DEBUG_MSG(3, ("server side, adding alpn extension"));
XiaokangQianacb39922022-06-17 10:18:48 +00009628 /*
9629 * 0 . 1 ext identifier
9630 * 2 . 3 ext length
9631 * 4 . 5 protocol list length
9632 * 6 . 6 protocol name length
9633 * 7 . 7+n protocol name
9634 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009635 MBEDTLS_PUT_UINT16_BE(MBEDTLS_TLS_EXT_ALPN, p, 0);
XiaokangQianacb39922022-06-17 10:18:48 +00009636
XiaokangQian95d5f542022-06-24 02:29:26 +00009637 *out_len = 7 + protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00009638
Gilles Peskine449bd832023-01-11 14:50:10 +01009639 MBEDTLS_PUT_UINT16_BE(protocol_name_len + 3, p, 2);
9640 MBEDTLS_PUT_UINT16_BE(protocol_name_len + 1, p, 4);
XiaokangQian0b776e22022-06-24 09:04:59 +00009641 /* Note: the length of the chosen protocol has been checked to be less
9642 * than 255 bytes in `mbedtls_ssl_conf_alpn_protocols`.
9643 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009644 p[6] = MBEDTLS_BYTE_0(protocol_name_len);
XiaokangQianacb39922022-06-17 10:18:48 +00009645
Gilles Peskine449bd832023-01-11 14:50:10 +01009646 memcpy(p + 7, ssl->alpn_chosen, protocol_name_len);
Jerry Yub95dd362022-11-08 21:19:34 +08009647
9648#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01009649 mbedtls_ssl_tls13_set_hs_sent_ext_mask(ssl, MBEDTLS_TLS_EXT_ALPN);
Jerry Yub95dd362022-11-08 21:19:34 +08009650#endif
9651
Gilles Peskine449bd832023-01-11 14:50:10 +01009652 return 0;
XiaokangQianacb39922022-06-17 10:18:48 +00009653}
9654#endif /* MBEDTLS_SSL_ALPN */
9655
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009656#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && \
Xiaokang Qian03409292022-10-12 02:49:52 +00009657 defined(MBEDTLS_SSL_SESSION_TICKETS) && \
Xiaokang Qianed0620c2022-10-12 06:58:13 +00009658 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION) && \
Xiaokang Qianed3afcd2022-10-12 08:31:11 +00009659 defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01009660int mbedtls_ssl_session_set_hostname(mbedtls_ssl_session *session,
9661 const char *hostname)
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009662{
9663 /* Initialize to suppress unnecessary compiler warning */
9664 size_t hostname_len = 0;
9665
9666 /* Check if new hostname is valid before
9667 * making any change to current one */
Gilles Peskine449bd832023-01-11 14:50:10 +01009668 if (hostname != NULL) {
9669 hostname_len = strlen(hostname);
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009670
Gilles Peskine449bd832023-01-11 14:50:10 +01009671 if (hostname_len > MBEDTLS_SSL_MAX_HOST_NAME_LEN) {
9672 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9673 }
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009674 }
9675
9676 /* Now it's clear that we will overwrite the old hostname,
9677 * so we can free it safely */
Gilles Peskine449bd832023-01-11 14:50:10 +01009678 if (session->hostname != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01009679 mbedtls_zeroize_and_free(session->hostname,
Gilles Peskine449bd832023-01-11 14:50:10 +01009680 strlen(session->hostname));
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009681 }
9682
9683 /* Passing NULL as hostname shall clear the old one */
Gilles Peskine449bd832023-01-11 14:50:10 +01009684 if (hostname == NULL) {
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009685 session->hostname = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01009686 } else {
9687 session->hostname = mbedtls_calloc(1, hostname_len + 1);
9688 if (session->hostname == NULL) {
9689 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
9690 }
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009691
Gilles Peskine449bd832023-01-11 14:50:10 +01009692 memcpy(session->hostname, hostname, hostname_len);
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009693 }
9694
Gilles Peskine449bd832023-01-11 14:50:10 +01009695 return 0;
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009696}
Xiaokang Qian03409292022-10-12 02:49:52 +00009697#endif /* MBEDTLS_SSL_PROTO_TLS1_3 &&
9698 MBEDTLS_SSL_SESSION_TICKETS &&
Xiaokang Qianed0620c2022-10-12 06:58:13 +00009699 MBEDTLS_SSL_SERVER_NAME_INDICATION &&
Xiaokang Qianed3afcd2022-10-12 08:31:11 +00009700 MBEDTLS_SSL_CLI_C */
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009701
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00009702#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_EARLY_DATA) && \
9703 defined(MBEDTLS_SSL_ALPN)
Waleed Elmelegy7dfba342024-03-12 16:22:39 +00009704int mbedtls_ssl_session_set_ticket_alpn(mbedtls_ssl_session *session,
9705 const char *alpn)
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00009706{
9707 size_t alpn_len = 0;
9708
9709 if (alpn != NULL) {
9710 alpn_len = strlen(alpn);
9711
9712 if (alpn_len > MBEDTLS_SSL_MAX_ALPN_NAME_LEN) {
9713 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9714 }
9715 }
9716
9717 if (session->ticket_alpn != NULL) {
9718 mbedtls_zeroize_and_free(session->ticket_alpn,
9719 strlen(session->ticket_alpn));
Waleed Elmelegy7dfba342024-03-12 16:22:39 +00009720 session->ticket_alpn = NULL;
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00009721 }
9722
Waleed Elmelegy7dfba342024-03-12 16:22:39 +00009723 if (alpn != NULL) {
9724 session->ticket_alpn = mbedtls_calloc(alpn_len + 1, 1);
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00009725 if (session->ticket_alpn == NULL) {
9726 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
9727 }
Waleed Elmelegy7dfba342024-03-12 16:22:39 +00009728 memcpy(session->ticket_alpn, alpn, alpn_len);
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00009729 }
9730
9731 return 0;
9732}
9733#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_EARLY_DATA && MBEDTLS_SSL_ALPN */
Manuel Pégourié-Gonnardc32a4a22024-08-20 12:14:43 +02009734
9735/*
9736 * The following functions are used by 1.2 and 1.3, client and server.
9737 */
9738#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
9739int mbedtls_ssl_check_cert_usage(const mbedtls_x509_crt *cert,
9740 const mbedtls_ssl_ciphersuite_t *ciphersuite,
9741 int recv_endpoint,
9742 mbedtls_ssl_protocol_version tls_version,
9743 uint32_t *flags)
9744{
9745 int ret = 0;
9746 unsigned int usage = 0;
9747 const char *ext_oid;
9748 size_t ext_len;
9749
9750 /*
9751 * keyUsage
9752 */
9753
9754 /* Note: don't guard this with MBEDTLS_SSL_CLI_C because the server wants
9755 * to check what a compliant client will think while choosing which cert
9756 * to send to the client. */
9757#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
9758 if (tls_version == MBEDTLS_SSL_VERSION_TLS1_2 &&
9759 recv_endpoint == MBEDTLS_SSL_IS_CLIENT) {
9760 /* TLS 1.2 server part of the key exchange */
9761 switch (ciphersuite->key_exchange) {
9762 case MBEDTLS_KEY_EXCHANGE_RSA:
9763 case MBEDTLS_KEY_EXCHANGE_RSA_PSK:
9764 usage = MBEDTLS_X509_KU_KEY_ENCIPHERMENT;
9765 break;
9766
9767 case MBEDTLS_KEY_EXCHANGE_DHE_RSA:
9768 case MBEDTLS_KEY_EXCHANGE_ECDHE_RSA:
9769 case MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA:
9770 usage = MBEDTLS_X509_KU_DIGITAL_SIGNATURE;
9771 break;
9772
9773 case MBEDTLS_KEY_EXCHANGE_ECDH_RSA:
9774 case MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA:
9775 usage = MBEDTLS_X509_KU_KEY_AGREEMENT;
9776 break;
9777
9778 /* Don't use default: we want warnings when adding new values */
9779 case MBEDTLS_KEY_EXCHANGE_NONE:
9780 case MBEDTLS_KEY_EXCHANGE_PSK:
9781 case MBEDTLS_KEY_EXCHANGE_DHE_PSK:
9782 case MBEDTLS_KEY_EXCHANGE_ECDHE_PSK:
9783 case MBEDTLS_KEY_EXCHANGE_ECJPAKE:
9784 usage = 0;
9785 }
9786 } else
9787#endif
9788 {
9789 /* This is either TLS 1.3 authentication, which always uses signatures,
9790 * or 1.2 client auth: rsa_sign and mbedtls_ecdsa_sign are the only
9791 * options we implement, both using signatures. */
9792 (void) tls_version;
9793 (void) ciphersuite;
9794 usage = MBEDTLS_X509_KU_DIGITAL_SIGNATURE;
9795 }
9796
9797 if (mbedtls_x509_crt_check_key_usage(cert, usage) != 0) {
9798 *flags |= MBEDTLS_X509_BADCERT_KEY_USAGE;
9799 ret = -1;
9800 }
9801
9802 /*
9803 * extKeyUsage
9804 */
9805
9806 if (recv_endpoint == MBEDTLS_SSL_IS_CLIENT) {
9807 ext_oid = MBEDTLS_OID_SERVER_AUTH;
9808 ext_len = MBEDTLS_OID_SIZE(MBEDTLS_OID_SERVER_AUTH);
9809 } else {
9810 ext_oid = MBEDTLS_OID_CLIENT_AUTH;
9811 ext_len = MBEDTLS_OID_SIZE(MBEDTLS_OID_CLIENT_AUTH);
9812 }
9813
9814 if (mbedtls_x509_crt_check_extended_key_usage(cert, ext_oid, ext_len) != 0) {
9815 *flags |= MBEDTLS_X509_BADCERT_EXT_KEY_USAGE;
9816 ret = -1;
9817 }
9818
9819 return ret;
9820}
9821
Gilles Peskinee61852e2025-02-12 23:28:48 +01009822static int get_hostname_for_verification(mbedtls_ssl_context *ssl,
9823 const char **hostname)
9824{
9825 if (!mbedtls_ssl_has_set_hostname_been_called(ssl)) {
9826 MBEDTLS_SSL_DEBUG_MSG(1, ("Certificate verification without having set hostname"));
9827 }
9828
9829 *hostname = mbedtls_ssl_get_hostname_pointer(ssl);
9830 if (*hostname == NULL) {
9831 MBEDTLS_SSL_DEBUG_MSG(2, ("Certificate verification without CN verification"));
9832 }
9833
9834 return 0;
9835}
9836
Manuel Pégourié-Gonnardc32a4a22024-08-20 12:14:43 +02009837int mbedtls_ssl_verify_certificate(mbedtls_ssl_context *ssl,
9838 int authmode,
9839 mbedtls_x509_crt *chain,
9840 const mbedtls_ssl_ciphersuite_t *ciphersuite_info,
9841 void *rs_ctx)
9842{
9843 if (authmode == MBEDTLS_SSL_VERIFY_NONE) {
9844 return 0;
9845 }
9846
9847 /*
9848 * Primary check: use the appropriate X.509 verification function
9849 */
9850 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *);
9851 void *p_vrfy;
9852 if (ssl->f_vrfy != NULL) {
9853 MBEDTLS_SSL_DEBUG_MSG(3, ("Use context-specific verification callback"));
9854 f_vrfy = ssl->f_vrfy;
9855 p_vrfy = ssl->p_vrfy;
9856 } else {
9857 MBEDTLS_SSL_DEBUG_MSG(3, ("Use configuration-specific verification callback"));
9858 f_vrfy = ssl->conf->f_vrfy;
9859 p_vrfy = ssl->conf->p_vrfy;
9860 }
9861
Gilles Peskinee61852e2025-02-12 23:28:48 +01009862 const char *hostname = "";
9863 int ret = get_hostname_for_verification(ssl, &hostname);
9864 if (ret != 0) {
9865 MBEDTLS_SSL_DEBUG_RET(1, "get_hostname_for_verification", ret);
9866 return ret;
9867 }
9868
Manuel Pégourié-Gonnardc32a4a22024-08-20 12:14:43 +02009869 int have_ca_chain_or_callback = 0;
9870#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
9871 if (ssl->conf->f_ca_cb != NULL) {
9872 ((void) rs_ctx);
9873 have_ca_chain_or_callback = 1;
9874
9875 MBEDTLS_SSL_DEBUG_MSG(3, ("use CA callback for X.509 CRT verification"));
9876 ret = mbedtls_x509_crt_verify_with_ca_cb(
9877 chain,
9878 ssl->conf->f_ca_cb,
9879 ssl->conf->p_ca_cb,
9880 ssl->conf->cert_profile,
Gilles Peskinee61852e2025-02-12 23:28:48 +01009881 hostname,
Manuel Pégourié-Gonnardc32a4a22024-08-20 12:14:43 +02009882 &ssl->session_negotiate->verify_result,
9883 f_vrfy, p_vrfy);
9884 } else
9885#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
9886 {
9887 mbedtls_x509_crt *ca_chain;
9888 mbedtls_x509_crl *ca_crl;
9889#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
9890 if (ssl->handshake->sni_ca_chain != NULL) {
9891 ca_chain = ssl->handshake->sni_ca_chain;
9892 ca_crl = ssl->handshake->sni_ca_crl;
9893 } else
9894#endif
9895 {
9896 ca_chain = ssl->conf->ca_chain;
9897 ca_crl = ssl->conf->ca_crl;
9898 }
9899
9900 if (ca_chain != NULL) {
9901 have_ca_chain_or_callback = 1;
9902 }
9903
9904 ret = mbedtls_x509_crt_verify_restartable(
9905 chain,
9906 ca_chain, ca_crl,
9907 ssl->conf->cert_profile,
Gilles Peskinee61852e2025-02-12 23:28:48 +01009908 hostname,
Manuel Pégourié-Gonnardc32a4a22024-08-20 12:14:43 +02009909 &ssl->session_negotiate->verify_result,
9910 f_vrfy, p_vrfy, rs_ctx);
9911 }
9912
9913 if (ret != 0) {
9914 MBEDTLS_SSL_DEBUG_RET(1, "x509_verify_cert", ret);
9915 }
9916
9917#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
9918 if (ret == MBEDTLS_ERR_ECP_IN_PROGRESS) {
9919 return MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS;
9920 }
9921#endif
9922
9923 /*
9924 * Secondary checks: always done, but change 'ret' only if it was 0
9925 */
9926
9927 /* With TLS 1.2 and ECC certs, check that the curve used by the
9928 * certificate is on our list of acceptable curves.
9929 *
9930 * With TLS 1.3 this is not needed because the curve is part of the
9931 * signature algorithm (eg ecdsa_secp256r1_sha256) which is checked when
9932 * we validate the signature made with the key associated to this cert.
9933 */
9934#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && \
9935 defined(MBEDTLS_PK_HAVE_ECC_KEYS)
9936 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_2 &&
9937 mbedtls_pk_can_do(&chain->pk, MBEDTLS_PK_ECKEY)) {
9938 if (mbedtls_ssl_check_curve(ssl, mbedtls_pk_get_ec_group_id(&chain->pk)) != 0) {
9939 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate (EC key curve)"));
9940 ssl->session_negotiate->verify_result |= MBEDTLS_X509_BADCERT_BAD_KEY;
9941 if (ret == 0) {
9942 ret = MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
9943 }
9944 }
9945 }
9946#endif /* MBEDTLS_SSL_PROTO_TLS1_2 && MBEDTLS_PK_HAVE_ECC_KEYS */
9947
9948 /* Check X.509 usage extensions (keyUsage, extKeyUsage) */
9949 if (mbedtls_ssl_check_cert_usage(chain,
9950 ciphersuite_info,
9951 ssl->conf->endpoint,
9952 ssl->tls_version,
9953 &ssl->session_negotiate->verify_result) != 0) {
9954 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate (usage extensions)"));
9955 if (ret == 0) {
9956 ret = MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
9957 }
9958 }
9959
9960 /* With authmode optional, we want to keep going if the certificate was
9961 * unacceptable, but still fail on other errors (out of memory etc),
9962 * including fatal errors from the f_vrfy callback.
9963 *
9964 * The only acceptable errors are:
9965 * - MBEDTLS_ERR_X509_CERT_VERIFY_FAILED: cert rejected by primary check;
9966 * - MBEDTLS_ERR_SSL_BAD_CERTIFICATE: cert rejected by secondary checks.
9967 * Anything else is a fatal error. */
9968 if (authmode == MBEDTLS_SSL_VERIFY_OPTIONAL &&
9969 (ret == MBEDTLS_ERR_X509_CERT_VERIFY_FAILED ||
9970 ret == MBEDTLS_ERR_SSL_BAD_CERTIFICATE)) {
9971 ret = 0;
9972 }
9973
9974 /* Return a specific error as this is a user error: inconsistent
9975 * configuration - can't verify without trust anchors. */
9976 if (have_ca_chain_or_callback == 0 && authmode == MBEDTLS_SSL_VERIFY_REQUIRED) {
9977 MBEDTLS_SSL_DEBUG_MSG(1, ("got no CA chain"));
9978 ret = MBEDTLS_ERR_SSL_CA_CHAIN_REQUIRED;
9979 }
9980
9981 if (ret != 0) {
9982 uint8_t alert;
9983
9984 /* The certificate may have been rejected for several reasons.
9985 Pick one and send the corresponding alert. Which alert to send
9986 may be a subject of debate in some cases. */
9987 if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_OTHER) {
9988 alert = MBEDTLS_SSL_ALERT_MSG_ACCESS_DENIED;
9989 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_CN_MISMATCH) {
9990 alert = MBEDTLS_SSL_ALERT_MSG_BAD_CERT;
9991 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_KEY_USAGE) {
9992 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
9993 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_EXT_KEY_USAGE) {
9994 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
9995 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_BAD_PK) {
9996 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
9997 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_BAD_KEY) {
9998 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
9999 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_EXPIRED) {
10000 alert = MBEDTLS_SSL_ALERT_MSG_CERT_EXPIRED;
10001 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_REVOKED) {
10002 alert = MBEDTLS_SSL_ALERT_MSG_CERT_REVOKED;
10003 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_NOT_TRUSTED) {
10004 alert = MBEDTLS_SSL_ALERT_MSG_UNKNOWN_CA;
10005 } else {
10006 alert = MBEDTLS_SSL_ALERT_MSG_CERT_UNKNOWN;
10007 }
10008 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
10009 alert);
10010 }
10011
10012#if defined(MBEDTLS_DEBUG_C)
10013 if (ssl->session_negotiate->verify_result != 0) {
10014 MBEDTLS_SSL_DEBUG_MSG(3, ("! Certificate verification flags %08x",
10015 (unsigned int) ssl->session_negotiate->verify_result));
10016 } else {
10017 MBEDTLS_SSL_DEBUG_MSG(3, ("Certificate verification flags clear"));
10018 }
10019#endif /* MBEDTLS_DEBUG_C */
10020
10021 return ret;
10022}
10023#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
10024
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020010025#endif /* MBEDTLS_SSL_TLS_C */