blob: 21d70af77281ef979898d3134a328628d2da84fe [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
Jerry Yudef7ae42022-10-30 14:13:19 +08001357#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
1358 /* RFC 8446 section 4.4.3
1359 *
1360 * If the verification fails, the receiver MUST terminate the handshake with
1361 * a "decrypt_error" alert.
1362 *
1363 * If the client is configured as TLS 1.3 only with optional verify, return
1364 * bad config.
1365 *
1366 */
Pengyu Lv0a1ff2b2023-11-14 11:03:32 +08001367 if (mbedtls_ssl_conf_tls13_is_ephemeral_enabled(
Gilles Peskine449bd832023-01-11 14:50:10 +01001368 (mbedtls_ssl_context *) ssl) &&
Jerry Yudef7ae42022-10-30 14:13:19 +08001369 ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
1370 ssl->conf->max_tls_version == MBEDTLS_SSL_VERSION_TLS1_3 &&
1371 ssl->conf->min_tls_version == MBEDTLS_SSL_VERSION_TLS1_3 &&
Gilles Peskine449bd832023-01-11 14:50:10 +01001372 ssl->conf->authmode == MBEDTLS_SSL_VERIFY_OPTIONAL) {
Jerry Yudef7ae42022-10-30 14:13:19 +08001373 MBEDTLS_SSL_DEBUG_MSG(
Gilles Peskine449bd832023-01-11 14:50:10 +01001374 1, ("Optional verify auth mode "
1375 "is not available for TLS 1.3 client"));
1376 return MBEDTLS_ERR_SSL_BAD_CONFIG;
Jerry Yudef7ae42022-10-30 14:13:19 +08001377 }
1378#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
1379
Yanray Wangb422cab2023-12-01 16:18:10 +08001380 if (ssl->conf->f_rng == NULL) {
1381 MBEDTLS_SSL_DEBUG_MSG(1, ("no RNG provided"));
1382 return MBEDTLS_ERR_SSL_NO_RNG;
1383 }
1384
Jerry Yu60835a82021-08-04 10:13:52 +08001385 /* Space for further checks */
1386
Gilles Peskine449bd832023-01-11 14:50:10 +01001387 return 0;
Jerry Yu60835a82021-08-04 10:13:52 +08001388}
1389
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +02001390/*
1391 * Setup an SSL context
1392 */
Hanno Becker2a43f6f2018-08-10 11:12:52 +01001393
Gilles Peskine449bd832023-01-11 14:50:10 +01001394int mbedtls_ssl_setup(mbedtls_ssl_context *ssl,
1395 const mbedtls_ssl_config *conf)
Paul Bakker5121ce52009-01-03 21:22:43 +00001396{
Janos Follath865b3eb2019-12-16 11:46:15 +00001397 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Darryl Greenb33cc762019-11-28 14:29:44 +00001398 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
1399 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
Paul Bakker5121ce52009-01-03 21:22:43 +00001400
Manuel Pégourié-Gonnarddef0bbe2015-05-04 14:56:36 +02001401 ssl->conf = conf;
Paul Bakker62f2dee2012-09-28 07:31:51 +00001402
Gilles Peskine449bd832023-01-11 14:50:10 +01001403 if ((ret = ssl_conf_check(ssl)) != 0) {
1404 return ret;
1405 }
Ronald Cron8a12aee2023-03-08 15:30:43 +01001406 ssl->tls_version = ssl->conf->max_tls_version;
Jerry Yu60835a82021-08-04 10:13:52 +08001407
Paul Bakker62f2dee2012-09-28 07:31:51 +00001408 /*
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01001409 * Prepare base structures
Paul Bakker62f2dee2012-09-28 07:31:51 +00001410 */
k-stachowiakc9a5f022018-07-24 13:53:31 +02001411
1412 /* Set to NULL in case of an error condition */
1413 ssl->out_buf = NULL;
k-stachowiaka47911c2018-07-04 17:41:58 +02001414
Darryl Greenb33cc762019-11-28 14:29:44 +00001415#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1416 ssl->in_buf_len = in_buf_len;
1417#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001418 ssl->in_buf = mbedtls_calloc(1, in_buf_len);
1419 if (ssl->in_buf == NULL) {
1420 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc(%" MBEDTLS_PRINTF_SIZET " bytes) failed", in_buf_len));
k-stachowiak9f7798e2018-07-31 16:52:32 +02001421 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
k-stachowiaka47911c2018-07-04 17:41:58 +02001422 goto error;
Angus Grattond8213d02016-05-25 20:56:48 +10001423 }
1424
Darryl Greenb33cc762019-11-28 14:29:44 +00001425#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1426 ssl->out_buf_len = out_buf_len;
1427#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001428 ssl->out_buf = mbedtls_calloc(1, out_buf_len);
1429 if (ssl->out_buf == NULL) {
1430 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc(%" MBEDTLS_PRINTF_SIZET " bytes) failed", out_buf_len));
k-stachowiak9f7798e2018-07-31 16:52:32 +02001431 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
k-stachowiaka47911c2018-07-04 17:41:58 +02001432 goto error;
Paul Bakker5121ce52009-01-03 21:22:43 +00001433 }
1434
Gilles Peskine449bd832023-01-11 14:50:10 +01001435 mbedtls_ssl_reset_in_out_pointers(ssl);
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02001436
Johan Pascalb62bb512015-12-03 21:56:45 +01001437#if defined(MBEDTLS_SSL_DTLS_SRTP)
Gilles Peskine449bd832023-01-11 14:50:10 +01001438 memset(&ssl->dtls_srtp_info, 0, sizeof(ssl->dtls_srtp_info));
Johan Pascalb62bb512015-12-03 21:56:45 +01001439#endif
1440
Gilles Peskine449bd832023-01-11 14:50:10 +01001441 if ((ret = ssl_handshake_init(ssl)) != 0) {
k-stachowiaka47911c2018-07-04 17:41:58 +02001442 goto error;
Gilles Peskine449bd832023-01-11 14:50:10 +01001443 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001444
Gilles Peskine449bd832023-01-11 14:50:10 +01001445 return 0;
k-stachowiaka47911c2018-07-04 17:41:58 +02001446
1447error:
Gilles Peskine449bd832023-01-11 14:50:10 +01001448 mbedtls_free(ssl->in_buf);
1449 mbedtls_free(ssl->out_buf);
k-stachowiaka47911c2018-07-04 17:41:58 +02001450
1451 ssl->conf = NULL;
1452
Darryl Greenb33cc762019-11-28 14:29:44 +00001453#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1454 ssl->in_buf_len = 0;
1455 ssl->out_buf_len = 0;
1456#endif
k-stachowiaka47911c2018-07-04 17:41:58 +02001457 ssl->in_buf = NULL;
1458 ssl->out_buf = NULL;
1459
1460 ssl->in_hdr = NULL;
1461 ssl->in_ctr = NULL;
1462 ssl->in_len = NULL;
1463 ssl->in_iv = NULL;
1464 ssl->in_msg = NULL;
1465
1466 ssl->out_hdr = NULL;
1467 ssl->out_ctr = NULL;
1468 ssl->out_len = NULL;
1469 ssl->out_iv = NULL;
1470 ssl->out_msg = NULL;
1471
Gilles Peskine449bd832023-01-11 14:50:10 +01001472 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00001473}
1474
1475/*
Paul Bakker7eb013f2011-10-06 12:37:39 +00001476 * Reset an initialized and used SSL context for re-use while retaining
1477 * all application-set variables, function pointers and data.
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001478 *
1479 * If partial is non-zero, keep data in the input buffer and client ID.
1480 * (Use when a DTLS client reconnects from the same port.)
Paul Bakker7eb013f2011-10-06 12:37:39 +00001481 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001482void mbedtls_ssl_session_reset_msg_layer(mbedtls_ssl_context *ssl,
1483 int partial)
Paul Bakker7eb013f2011-10-06 12:37:39 +00001484{
Darryl Greenb33cc762019-11-28 14:29:44 +00001485#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1486 size_t in_buf_len = ssl->in_buf_len;
1487 size_t out_buf_len = ssl->out_buf_len;
1488#else
1489 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
1490 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
1491#endif
Paul Bakker48916f92012-09-16 19:57:18 +00001492
Hanno Beckerb0302c42021-08-03 09:39:42 +01001493#if !defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE) || !defined(MBEDTLS_SSL_SRV_C)
1494 partial = 0;
Hanno Becker7e772132018-08-10 12:38:21 +01001495#endif
1496
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001497 /* Cancel any possibly running timer */
Gilles Peskine449bd832023-01-11 14:50:10 +01001498 mbedtls_ssl_set_timer(ssl, 0);
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001499
Gilles Peskine449bd832023-01-11 14:50:10 +01001500 mbedtls_ssl_reset_in_out_pointers(ssl);
Hanno Beckerb0302c42021-08-03 09:39:42 +01001501
1502 /* Reset incoming message parsing */
1503 ssl->in_offt = NULL;
1504 ssl->nb_zero = 0;
1505 ssl->in_msgtype = 0;
1506 ssl->in_msglen = 0;
1507 ssl->in_hslen = 0;
1508 ssl->keep_current_message = 0;
1509 ssl->transform_in = NULL;
1510
1511#if defined(MBEDTLS_SSL_PROTO_DTLS)
1512 ssl->next_record_offset = 0;
1513 ssl->in_epoch = 0;
1514#endif
1515
1516 /* Keep current datagram if partial == 1 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001517 if (partial == 0) {
Hanno Beckerb0302c42021-08-03 09:39:42 +01001518 ssl->in_left = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01001519 memset(ssl->in_buf, 0, in_buf_len);
Hanno Beckerb0302c42021-08-03 09:39:42 +01001520 }
1521
Ronald Cronad8c17b2022-06-10 17:18:09 +02001522 ssl->send_alert = 0;
1523
Hanno Beckerb0302c42021-08-03 09:39:42 +01001524 /* Reset outgoing message writing */
1525 ssl->out_msgtype = 0;
1526 ssl->out_msglen = 0;
1527 ssl->out_left = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01001528 memset(ssl->out_buf, 0, out_buf_len);
1529 memset(ssl->cur_out_ctr, 0, sizeof(ssl->cur_out_ctr));
Hanno Beckerb0302c42021-08-03 09:39:42 +01001530 ssl->transform_out = NULL;
1531
1532#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Gilles Peskine449bd832023-01-11 14:50:10 +01001533 mbedtls_ssl_dtls_replay_reset(ssl);
Hanno Beckerb0302c42021-08-03 09:39:42 +01001534#endif
1535
XiaokangQian2b01dc32022-01-21 02:53:13 +00001536#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01001537 if (ssl->transform) {
1538 mbedtls_ssl_transform_free(ssl->transform);
1539 mbedtls_free(ssl->transform);
Hanno Beckerb0302c42021-08-03 09:39:42 +01001540 ssl->transform = NULL;
1541 }
XiaokangQian2b01dc32022-01-21 02:53:13 +00001542#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
1543
XiaokangQian2b01dc32022-01-21 02:53:13 +00001544#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01001545 mbedtls_ssl_transform_free(ssl->transform_application);
1546 mbedtls_free(ssl->transform_application);
XiaokangQian2b01dc32022-01-21 02:53:13 +00001547 ssl->transform_application = NULL;
1548
Gilles Peskine449bd832023-01-11 14:50:10 +01001549 if (ssl->handshake != NULL) {
Jerry Yu3d9b5902022-11-04 14:07:25 +08001550#if defined(MBEDTLS_SSL_EARLY_DATA)
Gilles Peskine449bd832023-01-11 14:50:10 +01001551 mbedtls_ssl_transform_free(ssl->handshake->transform_earlydata);
1552 mbedtls_free(ssl->handshake->transform_earlydata);
XiaokangQian2b01dc32022-01-21 02:53:13 +00001553 ssl->handshake->transform_earlydata = NULL;
Jerry Yu3d9b5902022-11-04 14:07:25 +08001554#endif
XiaokangQian2b01dc32022-01-21 02:53:13 +00001555
Gilles Peskine449bd832023-01-11 14:50:10 +01001556 mbedtls_ssl_transform_free(ssl->handshake->transform_handshake);
1557 mbedtls_free(ssl->handshake->transform_handshake);
XiaokangQian2b01dc32022-01-21 02:53:13 +00001558 ssl->handshake->transform_handshake = NULL;
1559 }
1560
XiaokangQian2b01dc32022-01-21 02:53:13 +00001561#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Beckerb0302c42021-08-03 09:39:42 +01001562}
1563
Gilles Peskine449bd832023-01-11 14:50:10 +01001564int mbedtls_ssl_session_reset_int(mbedtls_ssl_context *ssl, int partial)
Hanno Beckerb0302c42021-08-03 09:39:42 +01001565{
1566 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1567
1568 ssl->state = MBEDTLS_SSL_HELLO_REQUEST;
Ronald Cron195c0bc2024-02-08 08:51:20 +01001569 ssl->tls_version = ssl->conf->max_tls_version;
Hanno Beckerb0302c42021-08-03 09:39:42 +01001570
Gilles Peskine449bd832023-01-11 14:50:10 +01001571 mbedtls_ssl_session_reset_msg_layer(ssl, partial);
Hanno Beckerb0302c42021-08-03 09:39:42 +01001572
1573 /* Reset renegotiation state */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001574#if defined(MBEDTLS_SSL_RENEGOTIATION)
1575 ssl->renego_status = MBEDTLS_SSL_INITIAL_HANDSHAKE;
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001576 ssl->renego_records_seen = 0;
Paul Bakker48916f92012-09-16 19:57:18 +00001577
1578 ssl->verify_data_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01001579 memset(ssl->own_verify_data, 0, MBEDTLS_SSL_VERIFY_DATA_MAX_LEN);
1580 memset(ssl->peer_verify_data, 0, MBEDTLS_SSL_VERIFY_DATA_MAX_LEN);
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001581#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001582 ssl->secure_renegotiation = MBEDTLS_SSL_LEGACY_RENEGOTIATION;
Paul Bakker48916f92012-09-16 19:57:18 +00001583
Hanno Beckerb0302c42021-08-03 09:39:42 +01001584 ssl->session_in = NULL;
Hanno Becker78640902018-08-13 16:35:15 +01001585 ssl->session_out = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01001586 if (ssl->session) {
1587 mbedtls_ssl_session_free(ssl->session);
1588 mbedtls_free(ssl->session);
Paul Bakkerc0463502013-02-14 11:19:38 +01001589 ssl->session = NULL;
1590 }
1591
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001592#if defined(MBEDTLS_SSL_ALPN)
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001593 ssl->alpn_chosen = NULL;
1594#endif
1595
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001596#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
David Horstmann3b2276a2022-10-06 14:49:08 +01001597 int free_cli_id = 1;
Hanno Becker4ccbf062018-08-10 11:20:38 +01001598#if defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE)
Gilles Peskine449bd832023-01-11 14:50:10 +01001599 free_cli_id = (partial == 0);
Hanno Becker4ccbf062018-08-10 11:20:38 +01001600#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001601 if (free_cli_id) {
1602 mbedtls_free(ssl->cli_id);
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001603 ssl->cli_id = NULL;
1604 ssl->cli_id_len = 0;
1605 }
Manuel Pégourié-Gonnard43c02182014-07-22 17:32:01 +02001606#endif
1607
Gilles Peskine449bd832023-01-11 14:50:10 +01001608 if ((ret = ssl_handshake_init(ssl)) != 0) {
1609 return ret;
1610 }
Paul Bakker2770fbd2012-07-03 13:30:23 +00001611
Gilles Peskine449bd832023-01-11 14:50:10 +01001612 return 0;
Paul Bakker7eb013f2011-10-06 12:37:39 +00001613}
1614
Manuel Pégourié-Gonnard779e4292013-08-03 13:50:48 +02001615/*
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001616 * Reset an initialized and used SSL context for re-use while retaining
1617 * all application-set variables, function pointers and data.
1618 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001619int mbedtls_ssl_session_reset(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001620{
Gilles Peskine449bd832023-01-11 14:50:10 +01001621 return mbedtls_ssl_session_reset_int(ssl, 0);
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001622}
1623
1624/*
Paul Bakker5121ce52009-01-03 21:22:43 +00001625 * SSL set accessors
1626 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001627void mbedtls_ssl_conf_endpoint(mbedtls_ssl_config *conf, int endpoint)
Paul Bakker5121ce52009-01-03 21:22:43 +00001628{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001629 conf->endpoint = endpoint;
Paul Bakker5121ce52009-01-03 21:22:43 +00001630}
1631
Gilles Peskine449bd832023-01-11 14:50:10 +01001632void mbedtls_ssl_conf_transport(mbedtls_ssl_config *conf, int transport)
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001633{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001634 conf->transport = transport;
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001635}
1636
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001637#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Gilles Peskine449bd832023-01-11 14:50:10 +01001638void mbedtls_ssl_conf_dtls_anti_replay(mbedtls_ssl_config *conf, char mode)
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02001639{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001640 conf->anti_replay = mode;
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02001641}
1642#endif
1643
Gilles Peskine449bd832023-01-11 14:50:10 +01001644void mbedtls_ssl_conf_dtls_badmac_limit(mbedtls_ssl_config *conf, unsigned limit)
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001645{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001646 conf->badmac_limit = limit;
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001647}
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001648
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001649#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker04da1892018-08-14 13:22:10 +01001650
Gilles Peskine449bd832023-01-11 14:50:10 +01001651void mbedtls_ssl_set_datagram_packing(mbedtls_ssl_context *ssl,
1652 unsigned allow_packing)
Hanno Becker04da1892018-08-14 13:22:10 +01001653{
1654 ssl->disable_datagram_packing = !allow_packing;
1655}
1656
Gilles Peskine449bd832023-01-11 14:50:10 +01001657void mbedtls_ssl_conf_handshake_timeout(mbedtls_ssl_config *conf,
1658 uint32_t min, uint32_t max)
Manuel Pégourié-Gonnard905dd242014-10-01 12:03:55 +02001659{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001660 conf->hs_timeout_min = min;
1661 conf->hs_timeout_max = max;
Manuel Pégourié-Gonnard905dd242014-10-01 12:03:55 +02001662}
1663#endif
1664
Gilles Peskine449bd832023-01-11 14:50:10 +01001665void mbedtls_ssl_conf_authmode(mbedtls_ssl_config *conf, int authmode)
Paul Bakker5121ce52009-01-03 21:22:43 +00001666{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001667 conf->authmode = authmode;
Paul Bakker5121ce52009-01-03 21:22:43 +00001668}
1669
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001670#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001671void mbedtls_ssl_conf_verify(mbedtls_ssl_config *conf,
1672 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *),
1673 void *p_vrfy)
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001674{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001675 conf->f_vrfy = f_vrfy;
1676 conf->p_vrfy = p_vrfy;
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001677}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001678#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001679
Gilles Peskine449bd832023-01-11 14:50:10 +01001680void mbedtls_ssl_conf_rng(mbedtls_ssl_config *conf,
1681 int (*f_rng)(void *, unsigned char *, size_t),
1682 void *p_rng)
Paul Bakker5121ce52009-01-03 21:22:43 +00001683{
Manuel Pégourié-Gonnard750e4d72015-05-07 12:35:38 +01001684 conf->f_rng = f_rng;
1685 conf->p_rng = p_rng;
Paul Bakker5121ce52009-01-03 21:22:43 +00001686}
1687
Gilles Peskine449bd832023-01-11 14:50:10 +01001688void mbedtls_ssl_conf_dbg(mbedtls_ssl_config *conf,
1689 void (*f_dbg)(void *, int, const char *, int, const char *),
1690 void *p_dbg)
Paul Bakker5121ce52009-01-03 21:22:43 +00001691{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001692 conf->f_dbg = f_dbg;
1693 conf->p_dbg = p_dbg;
Paul Bakker5121ce52009-01-03 21:22:43 +00001694}
1695
Gilles Peskine449bd832023-01-11 14:50:10 +01001696void mbedtls_ssl_set_bio(mbedtls_ssl_context *ssl,
1697 void *p_bio,
1698 mbedtls_ssl_send_t *f_send,
1699 mbedtls_ssl_recv_t *f_recv,
1700 mbedtls_ssl_recv_timeout_t *f_recv_timeout)
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02001701{
1702 ssl->p_bio = p_bio;
1703 ssl->f_send = f_send;
1704 ssl->f_recv = f_recv;
1705 ssl->f_recv_timeout = f_recv_timeout;
Manuel Pégourié-Gonnard97fd52c2015-05-06 15:38:52 +01001706}
1707
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02001708#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01001709void mbedtls_ssl_set_mtu(mbedtls_ssl_context *ssl, uint16_t mtu)
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02001710{
1711 ssl->mtu = mtu;
1712}
1713#endif
1714
Gilles Peskine449bd832023-01-11 14:50:10 +01001715void mbedtls_ssl_conf_read_timeout(mbedtls_ssl_config *conf, uint32_t timeout)
Manuel Pégourié-Gonnard97fd52c2015-05-06 15:38:52 +01001716{
1717 conf->read_timeout = timeout;
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02001718}
1719
Gilles Peskine449bd832023-01-11 14:50:10 +01001720void mbedtls_ssl_set_timer_cb(mbedtls_ssl_context *ssl,
1721 void *p_timer,
1722 mbedtls_ssl_set_timer_t *f_set_timer,
1723 mbedtls_ssl_get_timer_t *f_get_timer)
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02001724{
1725 ssl->p_timer = p_timer;
1726 ssl->f_set_timer = f_set_timer;
1727 ssl->f_get_timer = f_get_timer;
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001728
1729 /* Make sure we start with no timer running */
Gilles Peskine449bd832023-01-11 14:50:10 +01001730 mbedtls_ssl_set_timer(ssl, 0);
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02001731}
1732
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001733#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001734void mbedtls_ssl_conf_session_cache(mbedtls_ssl_config *conf,
1735 void *p_cache,
1736 mbedtls_ssl_cache_get_t *f_get_cache,
1737 mbedtls_ssl_cache_set_t *f_set_cache)
Paul Bakker5121ce52009-01-03 21:22:43 +00001738{
Manuel Pégourié-Gonnard5cb33082015-05-06 18:06:26 +01001739 conf->p_cache = p_cache;
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001740 conf->f_get_cache = f_get_cache;
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001741 conf->f_set_cache = f_set_cache;
Paul Bakker5121ce52009-01-03 21:22:43 +00001742}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001743#endif /* MBEDTLS_SSL_SRV_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00001744
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001745#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001746int mbedtls_ssl_set_session(mbedtls_ssl_context *ssl, const mbedtls_ssl_session *session)
Paul Bakker5121ce52009-01-03 21:22:43 +00001747{
Janos Follath865b3eb2019-12-16 11:46:15 +00001748 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001749
Gilles Peskine449bd832023-01-11 14:50:10 +01001750 if (ssl == NULL ||
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001751 session == NULL ||
1752 ssl->session_negotiate == NULL ||
Gilles Peskine449bd832023-01-11 14:50:10 +01001753 ssl->conf->endpoint != MBEDTLS_SSL_IS_CLIENT) {
1754 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001755 }
1756
Gilles Peskine449bd832023-01-11 14:50:10 +01001757 if (ssl->handshake->resume == 1) {
1758 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
1759 }
Hanno Beckere810bbc2021-05-14 16:01:05 +01001760
Jerry Yu21092062022-10-10 21:21:31 +08001761#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01001762 if (session->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Ronald Cron8d630842024-04-04 14:05:21 +02001763#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Jerry Yu21092062022-10-10 21:21:31 +08001764 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
Gilles Peskine449bd832023-01-11 14:50:10 +01001765 mbedtls_ssl_ciphersuite_from_id(session->ciphersuite);
Jerry Yu21092062022-10-10 21:21:31 +08001766
Gilles Peskine449bd832023-01-11 14:50:10 +01001767 if (mbedtls_ssl_validate_ciphersuite(
Jerry Yu21092062022-10-10 21:21:31 +08001768 ssl, ciphersuite_info, MBEDTLS_SSL_VERSION_TLS1_3,
Gilles Peskine449bd832023-01-11 14:50:10 +01001769 MBEDTLS_SSL_VERSION_TLS1_3) != 0) {
1770 MBEDTLS_SSL_DEBUG_MSG(4, ("%d is not a valid TLS 1.3 ciphersuite.",
1771 session->ciphersuite));
1772 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jerry Yu21092062022-10-10 21:21:31 +08001773 }
Ronald Cron8d630842024-04-04 14:05:21 +02001774#else
1775 /*
1776 * If session tickets are not enabled, it is not possible to resume a
1777 * TLS 1.3 session, thus do not make any change to the SSL context in
1778 * the first place.
1779 */
1780 return 0;
1781#endif
Jerry Yu40afab62022-10-08 10:42:13 +08001782 }
Jerry Yu21092062022-10-10 21:21:31 +08001783#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yu40afab62022-10-08 10:42:13 +08001784
Gilles Peskine449bd832023-01-11 14:50:10 +01001785 if ((ret = mbedtls_ssl_session_copy(ssl->session_negotiate,
1786 session)) != 0) {
1787 return ret;
1788 }
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001789
Paul Bakker0a597072012-09-25 21:55:46 +00001790 ssl->handshake->resume = 1;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001791
Gilles Peskine449bd832023-01-11 14:50:10 +01001792 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00001793}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001794#endif /* MBEDTLS_SSL_CLI_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00001795
Gilles Peskine449bd832023-01-11 14:50:10 +01001796void mbedtls_ssl_conf_ciphersuites(mbedtls_ssl_config *conf,
1797 const int *ciphersuites)
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001798{
Hanno Beckerd60b6c62021-04-29 12:04:11 +01001799 conf->ciphersuite_list = ciphersuites;
Paul Bakker5121ce52009-01-03 21:22:43 +00001800}
1801
Ronald Cron6f135e12021-12-08 16:57:54 +01001802#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01001803void mbedtls_ssl_conf_tls13_key_exchange_modes(mbedtls_ssl_config *conf,
1804 const int kex_modes)
Hanno Becker71f1ed62021-07-24 06:01:47 +01001805{
Xiaofei Bai746f9482021-11-12 08:53:56 +00001806 conf->tls13_kex_modes = kex_modes & MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_ALL;
Hanno Becker71f1ed62021-07-24 06:01:47 +01001807}
Xiaokang Qian72de95d2022-10-25 02:54:33 +00001808
1809#if defined(MBEDTLS_SSL_EARLY_DATA)
Yanray Wangd5ed36f2023-11-07 11:40:43 +08001810void mbedtls_ssl_conf_early_data(mbedtls_ssl_config *conf,
1811 int early_data_enabled)
Xiaokang Qian72de95d2022-10-25 02:54:33 +00001812{
1813 conf->early_data_enabled = early_data_enabled;
1814}
Jerry Yucc4e0072022-11-22 17:22:22 +08001815
1816#if defined(MBEDTLS_SSL_SRV_C)
Yanray Wang07517612023-11-07 11:47:36 +08001817void mbedtls_ssl_conf_max_early_data_size(
Gilles Peskine449bd832023-01-11 14:50:10 +01001818 mbedtls_ssl_config *conf, uint32_t max_early_data_size)
Jerry Yucc4e0072022-11-22 17:22:22 +08001819{
Jerry Yu39da9852022-12-06 16:58:36 +08001820 conf->max_early_data_size = max_early_data_size;
Jerry Yucc4e0072022-11-22 17:22:22 +08001821}
1822#endif /* MBEDTLS_SSL_SRV_C */
1823
Xiaokang Qian72de95d2022-10-25 02:54:33 +00001824#endif /* MBEDTLS_SSL_EARLY_DATA */
Ronald Cron6f135e12021-12-08 16:57:54 +01001825#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker71f1ed62021-07-24 06:01:47 +01001826
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001827#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001828void mbedtls_ssl_conf_cert_profile(mbedtls_ssl_config *conf,
1829 const mbedtls_x509_crt_profile *profile)
Manuel Pégourié-Gonnard6e3ee3a2015-06-17 10:58:20 +02001830{
1831 conf->cert_profile = profile;
1832}
1833
Gilles Peskine449bd832023-01-11 14:50:10 +01001834static void ssl_key_cert_free(mbedtls_ssl_key_cert *key_cert)
Glenn Strauss36872db2022-01-22 05:06:31 -05001835{
1836 mbedtls_ssl_key_cert *cur = key_cert, *next;
1837
Gilles Peskine449bd832023-01-11 14:50:10 +01001838 while (cur != NULL) {
Glenn Strauss36872db2022-01-22 05:06:31 -05001839 next = cur->next;
Gilles Peskine449bd832023-01-11 14:50:10 +01001840 mbedtls_free(cur);
Glenn Strauss36872db2022-01-22 05:06:31 -05001841 cur = next;
1842 }
1843}
1844
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001845/* Append a new keycert entry to a (possibly empty) list */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001846MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001847static int ssl_append_key_cert(mbedtls_ssl_key_cert **head,
1848 mbedtls_x509_crt *cert,
1849 mbedtls_pk_context *key)
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001850{
niisato8ee24222018-06-25 19:05:48 +09001851 mbedtls_ssl_key_cert *new_cert;
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001852
Gilles Peskine449bd832023-01-11 14:50:10 +01001853 if (cert == NULL) {
Glenn Strauss36872db2022-01-22 05:06:31 -05001854 /* Free list if cert is null */
Gilles Peskine449bd832023-01-11 14:50:10 +01001855 ssl_key_cert_free(*head);
Glenn Strauss36872db2022-01-22 05:06:31 -05001856 *head = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01001857 return 0;
Glenn Strauss36872db2022-01-22 05:06:31 -05001858 }
1859
Gilles Peskine449bd832023-01-11 14:50:10 +01001860 new_cert = mbedtls_calloc(1, sizeof(mbedtls_ssl_key_cert));
1861 if (new_cert == NULL) {
1862 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
1863 }
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001864
niisato8ee24222018-06-25 19:05:48 +09001865 new_cert->cert = cert;
1866 new_cert->key = key;
1867 new_cert->next = NULL;
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001868
Glenn Strauss36872db2022-01-22 05:06:31 -05001869 /* Update head if the list was null, else add to the end */
Gilles Peskine449bd832023-01-11 14:50:10 +01001870 if (*head == NULL) {
niisato8ee24222018-06-25 19:05:48 +09001871 *head = new_cert;
Gilles Peskine449bd832023-01-11 14:50:10 +01001872 } else {
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001873 mbedtls_ssl_key_cert *cur = *head;
Gilles Peskine449bd832023-01-11 14:50:10 +01001874 while (cur->next != NULL) {
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001875 cur = cur->next;
Gilles Peskine449bd832023-01-11 14:50:10 +01001876 }
niisato8ee24222018-06-25 19:05:48 +09001877 cur->next = new_cert;
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001878 }
1879
Gilles Peskine449bd832023-01-11 14:50:10 +01001880 return 0;
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001881}
1882
Gilles Peskine449bd832023-01-11 14:50:10 +01001883int mbedtls_ssl_conf_own_cert(mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001884 mbedtls_x509_crt *own_cert,
Gilles Peskine449bd832023-01-11 14:50:10 +01001885 mbedtls_pk_context *pk_key)
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001886{
Gilles Peskine449bd832023-01-11 14:50:10 +01001887 return ssl_append_key_cert(&conf->key_cert, own_cert, pk_key);
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001888}
1889
Gilles Peskine449bd832023-01-11 14:50:10 +01001890void mbedtls_ssl_conf_ca_chain(mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01001891 mbedtls_x509_crt *ca_chain,
Gilles Peskine449bd832023-01-11 14:50:10 +01001892 mbedtls_x509_crl *ca_crl)
Paul Bakker5121ce52009-01-03 21:22:43 +00001893{
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01001894 conf->ca_chain = ca_chain;
1895 conf->ca_crl = ca_crl;
Hanno Becker5adaad92019-03-27 16:54:37 +00001896
1897#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
1898 /* mbedtls_ssl_conf_ca_chain() and mbedtls_ssl_conf_ca_cb()
1899 * cannot be used together. */
1900 conf->f_ca_cb = NULL;
1901 conf->p_ca_cb = NULL;
1902#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
Paul Bakker5121ce52009-01-03 21:22:43 +00001903}
Hanno Becker5adaad92019-03-27 16:54:37 +00001904
1905#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
Gilles Peskine449bd832023-01-11 14:50:10 +01001906void mbedtls_ssl_conf_ca_cb(mbedtls_ssl_config *conf,
1907 mbedtls_x509_crt_ca_cb_t f_ca_cb,
1908 void *p_ca_cb)
Hanno Becker5adaad92019-03-27 16:54:37 +00001909{
1910 conf->f_ca_cb = f_ca_cb;
1911 conf->p_ca_cb = p_ca_cb;
1912
1913 /* mbedtls_ssl_conf_ca_chain() and mbedtls_ssl_conf_ca_cb()
1914 * cannot be used together. */
1915 conf->ca_chain = NULL;
1916 conf->ca_crl = NULL;
1917}
1918#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001919#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkereb2c6582012-09-27 19:15:01 +00001920
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001921#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01001922const unsigned char *mbedtls_ssl_get_hs_sni(mbedtls_ssl_context *ssl,
1923 size_t *name_len)
Glenn Strauss69894072022-01-24 12:58:00 -05001924{
1925 *name_len = ssl->handshake->sni_name_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01001926 return ssl->handshake->sni_name;
Glenn Strauss69894072022-01-24 12:58:00 -05001927}
1928
Gilles Peskine449bd832023-01-11 14:50:10 +01001929int mbedtls_ssl_set_hs_own_cert(mbedtls_ssl_context *ssl,
1930 mbedtls_x509_crt *own_cert,
1931 mbedtls_pk_context *pk_key)
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001932{
Gilles Peskine449bd832023-01-11 14:50:10 +01001933 return ssl_append_key_cert(&ssl->handshake->sni_key_cert,
1934 own_cert, pk_key);
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001935}
Manuel Pégourié-Gonnard22bfa4b2015-05-11 08:46:37 +02001936
Gilles Peskine449bd832023-01-11 14:50:10 +01001937void mbedtls_ssl_set_hs_ca_chain(mbedtls_ssl_context *ssl,
1938 mbedtls_x509_crt *ca_chain,
1939 mbedtls_x509_crl *ca_crl)
Manuel Pégourié-Gonnard22bfa4b2015-05-11 08:46:37 +02001940{
1941 ssl->handshake->sni_ca_chain = ca_chain;
1942 ssl->handshake->sni_ca_crl = ca_crl;
1943}
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +02001944
Glenn Strauss999ef702022-03-11 01:37:23 -05001945#if defined(MBEDTLS_KEY_EXCHANGE_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01001946void mbedtls_ssl_set_hs_dn_hints(mbedtls_ssl_context *ssl,
1947 const mbedtls_x509_crt *crt)
Glenn Strauss999ef702022-03-11 01:37:23 -05001948{
1949 ssl->handshake->dn_hints = crt;
1950}
1951#endif /* MBEDTLS_KEY_EXCHANGE_CERT_REQ_ALLOWED_ENABLED */
1952
Gilles Peskine449bd832023-01-11 14:50:10 +01001953void mbedtls_ssl_set_hs_authmode(mbedtls_ssl_context *ssl,
1954 int authmode)
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +02001955{
1956 ssl->handshake->sni_authmode = authmode;
1957}
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001958#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
1959
Hanno Becker8927c832019-04-03 12:52:50 +01001960#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001961void mbedtls_ssl_set_verify(mbedtls_ssl_context *ssl,
1962 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *),
1963 void *p_vrfy)
Hanno Becker8927c832019-04-03 12:52:50 +01001964{
1965 ssl->f_vrfy = f_vrfy;
1966 ssl->p_vrfy = p_vrfy;
1967}
1968#endif
1969
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02001970#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02001971
Valerio Setti016f6822022-12-09 14:17:50 +01001972#if defined(MBEDTLS_USE_PSA_CRYPTO)
Przemek Stekielfde11282023-03-13 16:06:09 +01001973static const uint8_t jpake_server_id[] = { 's', 'e', 'r', 'v', 'e', 'r' };
1974static const uint8_t jpake_client_id[] = { 'c', 'l', 'i', 'e', 'n', 't' };
1975
Valerio Setti016f6822022-12-09 14:17:50 +01001976static psa_status_t mbedtls_ssl_set_hs_ecjpake_password_common(
Gilles Peskine449bd832023-01-11 14:50:10 +01001977 mbedtls_ssl_context *ssl,
1978 mbedtls_svc_key_id_t pwd)
Valerio Setti016f6822022-12-09 14:17:50 +01001979{
1980 psa_status_t status;
Valerio Setti016f6822022-12-09 14:17:50 +01001981 psa_pake_cipher_suite_t cipher_suite = psa_pake_cipher_suite_init();
Przemek Stekielfde11282023-03-13 16:06:09 +01001982 const uint8_t *user = NULL;
Przemek Stekiel4cd20312023-03-01 11:11:28 +01001983 size_t user_len = 0;
Przemek Stekielfde11282023-03-13 16:06:09 +01001984 const uint8_t *peer = NULL;
Przemek Stekiel4cd20312023-03-01 11:11:28 +01001985 size_t peer_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01001986 psa_pake_cs_set_algorithm(&cipher_suite, PSA_ALG_JPAKE);
1987 psa_pake_cs_set_primitive(&cipher_suite,
1988 PSA_PAKE_PRIMITIVE(PSA_PAKE_PRIMITIVE_TYPE_ECC,
1989 PSA_ECC_FAMILY_SECP_R1,
1990 256));
1991 psa_pake_cs_set_hash(&cipher_suite, PSA_ALG_SHA_256);
Valerio Setti016f6822022-12-09 14:17:50 +01001992
Gilles Peskine449bd832023-01-11 14:50:10 +01001993 status = psa_pake_setup(&ssl->handshake->psa_pake_ctx, &cipher_suite);
1994 if (status != PSA_SUCCESS) {
Valerio Setti016f6822022-12-09 14:17:50 +01001995 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001996 }
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02001997
Gilles Peskine449bd832023-01-11 14:50:10 +01001998 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Przemek Stekielfde11282023-03-13 16:06:09 +01001999 user = jpake_server_id;
2000 user_len = sizeof(jpake_server_id);
2001 peer = jpake_client_id;
2002 peer_len = sizeof(jpake_client_id);
Gilles Peskine449bd832023-01-11 14:50:10 +01002003 } else {
Przemek Stekielfde11282023-03-13 16:06:09 +01002004 user = jpake_client_id;
2005 user_len = sizeof(jpake_client_id);
2006 peer = jpake_server_id;
2007 peer_len = sizeof(jpake_server_id);
Gilles Peskine449bd832023-01-11 14:50:10 +01002008 }
Neil Armstrongca7d5062022-05-31 14:43:23 +02002009
Przemek Stekiel4cd20312023-03-01 11:11:28 +01002010 status = psa_pake_set_user(&ssl->handshake->psa_pake_ctx, user, user_len);
2011 if (status != PSA_SUCCESS) {
2012 return status;
2013 }
2014
2015 status = psa_pake_set_peer(&ssl->handshake->psa_pake_ctx, peer, peer_len);
Gilles Peskine449bd832023-01-11 14:50:10 +01002016 if (status != PSA_SUCCESS) {
Valerio Setti016f6822022-12-09 14:17:50 +01002017 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01002018 }
Valerio Setti016f6822022-12-09 14:17:50 +01002019
Gilles Peskine449bd832023-01-11 14:50:10 +01002020 status = psa_pake_set_password_key(&ssl->handshake->psa_pake_ctx, pwd);
2021 if (status != PSA_SUCCESS) {
Valerio Setti016f6822022-12-09 14:17:50 +01002022 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01002023 }
Valerio Setti016f6822022-12-09 14:17:50 +01002024
2025 ssl->handshake->psa_pake_ctx_is_ok = 1;
2026
Gilles Peskine449bd832023-01-11 14:50:10 +01002027 return PSA_SUCCESS;
Valerio Setti016f6822022-12-09 14:17:50 +01002028}
2029
Gilles Peskine449bd832023-01-11 14:50:10 +01002030int mbedtls_ssl_set_hs_ecjpake_password(mbedtls_ssl_context *ssl,
2031 const unsigned char *pw,
2032 size_t pw_len)
Valerio Setti016f6822022-12-09 14:17:50 +01002033{
2034 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
2035 psa_status_t status;
2036
Gilles Peskine449bd832023-01-11 14:50:10 +01002037 if (ssl->handshake == NULL || ssl->conf == NULL) {
2038 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Neil Armstrongca7d5062022-05-31 14:43:23 +02002039 }
2040
Gilles Peskine449bd832023-01-11 14:50:10 +01002041 /* Empty password is not valid */
2042 if ((pw == NULL) || (pw_len == 0)) {
2043 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2044 }
2045
2046 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_DERIVE);
2047 psa_set_key_algorithm(&attributes, PSA_ALG_JPAKE);
2048 psa_set_key_type(&attributes, PSA_KEY_TYPE_PASSWORD);
2049
2050 status = psa_import_key(&attributes, pw, pw_len,
2051 &ssl->handshake->psa_pake_password);
2052 if (status != PSA_SUCCESS) {
2053 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
2054 }
2055
2056 status = mbedtls_ssl_set_hs_ecjpake_password_common(ssl,
2057 ssl->handshake->psa_pake_password);
2058 if (status != PSA_SUCCESS) {
2059 psa_destroy_key(ssl->handshake->psa_pake_password);
2060 psa_pake_abort(&ssl->handshake->psa_pake_ctx);
2061 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
2062 }
2063
2064 return 0;
Valerio Setti02c25b52022-11-15 14:08:42 +01002065}
Valerio Settia9a97dc2022-11-28 18:26:16 +01002066
Gilles Peskine449bd832023-01-11 14:50:10 +01002067int mbedtls_ssl_set_hs_ecjpake_password_opaque(mbedtls_ssl_context *ssl,
2068 mbedtls_svc_key_id_t pwd)
Valerio Settia9a97dc2022-11-28 18:26:16 +01002069{
Valerio Settia9a97dc2022-11-28 18:26:16 +01002070 psa_status_t status;
2071
Gilles Peskine449bd832023-01-11 14:50:10 +01002072 if (ssl->handshake == NULL || ssl->conf == NULL) {
2073 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Neil Armstrongca7d5062022-05-31 14:43:23 +02002074 }
2075
Gilles Peskine449bd832023-01-11 14:50:10 +01002076 if (mbedtls_svc_key_id_is_null(pwd)) {
2077 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2078 }
2079
2080 status = mbedtls_ssl_set_hs_ecjpake_password_common(ssl, pwd);
2081 if (status != PSA_SUCCESS) {
2082 psa_pake_abort(&ssl->handshake->psa_pake_ctx);
2083 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
2084 }
2085
2086 return 0;
Valerio Setti02c25b52022-11-15 14:08:42 +01002087}
2088#else /* MBEDTLS_USE_PSA_CRYPTO */
Gilles Peskine449bd832023-01-11 14:50:10 +01002089int mbedtls_ssl_set_hs_ecjpake_password(mbedtls_ssl_context *ssl,
2090 const unsigned char *pw,
2091 size_t pw_len)
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002092{
2093 mbedtls_ecjpake_role role;
2094
Gilles Peskine449bd832023-01-11 14:50:10 +01002095 if (ssl->handshake == NULL || ssl->conf == NULL) {
2096 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2097 }
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002098
Valerio Settic689ed82022-12-07 14:40:38 +01002099 /* Empty password is not valid */
Gilles Peskine449bd832023-01-11 14:50:10 +01002100 if ((pw == NULL) || (pw_len == 0)) {
2101 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2102 }
Valerio Settic689ed82022-12-07 14:40:38 +01002103
Gilles Peskine449bd832023-01-11 14:50:10 +01002104 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002105 role = MBEDTLS_ECJPAKE_SERVER;
Gilles Peskine449bd832023-01-11 14:50:10 +01002106 } else {
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002107 role = MBEDTLS_ECJPAKE_CLIENT;
Gilles Peskine449bd832023-01-11 14:50:10 +01002108 }
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002109
Gilles Peskine449bd832023-01-11 14:50:10 +01002110 return mbedtls_ecjpake_setup(&ssl->handshake->ecjpake_ctx,
2111 role,
2112 MBEDTLS_MD_SHA256,
2113 MBEDTLS_ECP_DP_SECP256R1,
2114 pw, pw_len);
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002115}
Valerio Setti02c25b52022-11-15 14:08:42 +01002116#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02002117#endif /* MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED */
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002118
Ronald Cron73fe8df2022-10-05 14:31:43 +02002119#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01002120int mbedtls_ssl_conf_has_static_psk(mbedtls_ssl_config const *conf)
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002121{
Gilles Peskine449bd832023-01-11 14:50:10 +01002122 if (conf->psk_identity == NULL ||
2123 conf->psk_identity_len == 0) {
2124 return 0;
Ronald Crond29e13e2022-10-19 10:33:48 +02002125 }
2126
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002127#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01002128 if (!mbedtls_svc_key_id_is_null(conf->psk_opaque)) {
2129 return 1;
2130 }
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002131#endif /* MBEDTLS_USE_PSA_CRYPTO */
Ronald Crond29e13e2022-10-19 10:33:48 +02002132
Gilles Peskine449bd832023-01-11 14:50:10 +01002133 if (conf->psk != NULL && conf->psk_len != 0) {
2134 return 1;
2135 }
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002136
Gilles Peskine449bd832023-01-11 14:50:10 +01002137 return 0;
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002138}
2139
Gilles Peskine449bd832023-01-11 14:50:10 +01002140static void ssl_conf_remove_psk(mbedtls_ssl_config *conf)
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002141{
2142 /* Remove reference to existing PSK, if any. */
2143#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01002144 if (!mbedtls_svc_key_id_is_null(conf->psk_opaque)) {
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002145 /* The maintenance of the PSK key slot is the
2146 * user's responsibility. */
Ronald Croncf56a0a2020-08-04 09:51:30 +02002147 conf->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002148 }
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002149#endif /* MBEDTLS_USE_PSA_CRYPTO */
Gilles Peskine449bd832023-01-11 14:50:10 +01002150 if (conf->psk != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01002151 mbedtls_zeroize_and_free(conf->psk, conf->psk_len);
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002152 conf->psk = NULL;
2153 conf->psk_len = 0;
2154 }
2155
2156 /* Remove reference to PSK identity, if any. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002157 if (conf->psk_identity != NULL) {
2158 mbedtls_free(conf->psk_identity);
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002159 conf->psk_identity = NULL;
2160 conf->psk_identity_len = 0;
2161 }
2162}
2163
Hanno Becker7390c712018-11-15 13:33:04 +00002164/* This function assumes that PSK identity in the SSL config is unset.
2165 * It checks that the provided identity is well-formed and attempts
2166 * to make a copy of it in the SSL config.
2167 * On failure, the PSK identity in the config remains unset. */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002168MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002169static int ssl_conf_set_psk_identity(mbedtls_ssl_config *conf,
2170 unsigned char const *psk_identity,
2171 size_t psk_identity_len)
Paul Bakkerd4a56ec2013-04-16 18:05:29 +02002172{
Manuel Pégourié-Gonnardc6b5d832015-08-27 16:37:35 +02002173 /* Identity len will be encoded on two bytes */
Gilles Peskine449bd832023-01-11 14:50:10 +01002174 if (psk_identity == NULL ||
Ronald Cron2a87e9b2022-10-19 10:55:26 +02002175 psk_identity_len == 0 ||
Gilles Peskine449bd832023-01-11 14:50:10 +01002176 (psk_identity_len >> 16) != 0 ||
2177 psk_identity_len > MBEDTLS_SSL_OUT_CONTENT_LEN) {
2178 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnardc6b5d832015-08-27 16:37:35 +02002179 }
2180
Gilles Peskine449bd832023-01-11 14:50:10 +01002181 conf->psk_identity = mbedtls_calloc(1, psk_identity_len);
2182 if (conf->psk_identity == NULL) {
2183 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
2184 }
Paul Bakker6db455e2013-09-18 17:29:31 +02002185
Manuel Pégourié-Gonnard120fdbd2015-05-07 17:07:50 +01002186 conf->psk_identity_len = psk_identity_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01002187 memcpy(conf->psk_identity, psk_identity, conf->psk_identity_len);
Paul Bakker5ad403f2013-09-18 21:21:30 +02002188
Gilles Peskine449bd832023-01-11 14:50:10 +01002189 return 0;
Paul Bakker6db455e2013-09-18 17:29:31 +02002190}
2191
Gilles Peskine449bd832023-01-11 14:50:10 +01002192int mbedtls_ssl_conf_psk(mbedtls_ssl_config *conf,
2193 const unsigned char *psk, size_t psk_len,
2194 const unsigned char *psk_identity, size_t psk_identity_len)
Hanno Becker7390c712018-11-15 13:33:04 +00002195{
Janos Follath865b3eb2019-12-16 11:46:15 +00002196 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002197
2198 /* We currently only support one PSK, raw or opaque. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002199 if (mbedtls_ssl_conf_has_static_psk(conf)) {
2200 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
2201 }
Hanno Becker7390c712018-11-15 13:33:04 +00002202
2203 /* Check and set raw PSK */
Gilles Peskine449bd832023-01-11 14:50:10 +01002204 if (psk == NULL) {
2205 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2206 }
2207 if (psk_len == 0) {
2208 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2209 }
2210 if (psk_len > MBEDTLS_PSK_MAX_LEN) {
2211 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2212 }
Piotr Nowicki9926eaf2019-11-20 14:54:36 +01002213
Gilles Peskine449bd832023-01-11 14:50:10 +01002214 if ((conf->psk = mbedtls_calloc(1, psk_len)) == NULL) {
2215 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
2216 }
Hanno Becker7390c712018-11-15 13:33:04 +00002217 conf->psk_len = psk_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01002218 memcpy(conf->psk, psk, conf->psk_len);
Hanno Becker7390c712018-11-15 13:33:04 +00002219
2220 /* Check and set PSK Identity */
Gilles Peskine449bd832023-01-11 14:50:10 +01002221 ret = ssl_conf_set_psk_identity(conf, psk_identity, psk_identity_len);
2222 if (ret != 0) {
2223 ssl_conf_remove_psk(conf);
2224 }
Hanno Becker7390c712018-11-15 13:33:04 +00002225
Gilles Peskine449bd832023-01-11 14:50:10 +01002226 return ret;
Hanno Becker7390c712018-11-15 13:33:04 +00002227}
2228
Gilles Peskine449bd832023-01-11 14:50:10 +01002229static void ssl_remove_psk(mbedtls_ssl_context *ssl)
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002230{
2231#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01002232 if (!mbedtls_svc_key_id_is_null(ssl->handshake->psk_opaque)) {
Neil Armstrong501c9322022-05-03 09:35:09 +02002233 /* The maintenance of the external PSK key slot is the
2234 * user's responsibility. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002235 if (ssl->handshake->psk_opaque_is_internal) {
2236 psa_destroy_key(ssl->handshake->psk_opaque);
Neil Armstrong501c9322022-05-03 09:35:09 +02002237 ssl->handshake->psk_opaque_is_internal = 0;
2238 }
Ronald Croncf56a0a2020-08-04 09:51:30 +02002239 ssl->handshake->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002240 }
Neil Armstronge952a302022-05-03 10:22:14 +02002241#else
Gilles Peskine449bd832023-01-11 14:50:10 +01002242 if (ssl->handshake->psk != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01002243 mbedtls_zeroize_and_free(ssl->handshake->psk,
Gilles Peskine449bd832023-01-11 14:50:10 +01002244 ssl->handshake->psk_len);
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002245 ssl->handshake->psk_len = 0;
lhuang046d4d94f2024-06-11 12:37:02 -07002246 ssl->handshake->psk = NULL;
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002247 }
Neil Armstronge952a302022-05-03 10:22:14 +02002248#endif /* MBEDTLS_USE_PSA_CRYPTO */
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002249}
2250
Gilles Peskine449bd832023-01-11 14:50:10 +01002251int mbedtls_ssl_set_hs_psk(mbedtls_ssl_context *ssl,
2252 const unsigned char *psk, size_t psk_len)
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002253{
Neil Armstrong501c9322022-05-03 09:35:09 +02002254#if defined(MBEDTLS_USE_PSA_CRYPTO)
2255 psa_key_attributes_t key_attributes = psa_key_attributes_init();
Jerry Yu5d01c052022-08-17 10:18:10 +08002256 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Jerry Yu24b8c812022-08-20 19:06:56 +08002257 psa_algorithm_t alg = PSA_ALG_NONE;
Jerry Yu5d01c052022-08-17 10:18:10 +08002258 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Neil Armstrong501c9322022-05-03 09:35:09 +02002259#endif /* MBEDTLS_USE_PSA_CRYPTO */
2260
Gilles Peskine449bd832023-01-11 14:50:10 +01002261 if (psk == NULL || ssl->handshake == NULL) {
2262 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2263 }
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002264
Gilles Peskine449bd832023-01-11 14:50:10 +01002265 if (psk_len > MBEDTLS_PSK_MAX_LEN) {
2266 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2267 }
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002268
Gilles Peskine449bd832023-01-11 14:50:10 +01002269 ssl_remove_psk(ssl);
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002270
Neil Armstrong501c9322022-05-03 09:35:09 +02002271#if defined(MBEDTLS_USE_PSA_CRYPTO)
Jerry Yuccc68a42022-07-26 16:39:20 +08002272#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01002273 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_2) {
2274 if (ssl->handshake->ciphersuite_info->mac == MBEDTLS_MD_SHA384) {
2275 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_384);
2276 } else {
2277 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_256);
2278 }
2279 psa_set_key_usage_flags(&key_attributes, PSA_KEY_USAGE_DERIVE);
Jerry Yuccc68a42022-07-26 16:39:20 +08002280 }
2281#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Neil Armstrong501c9322022-05-03 09:35:09 +02002282
Jerry Yu568ec252022-07-22 21:27:34 +08002283#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01002284 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
2285 alg = PSA_ALG_HKDF_EXTRACT(PSA_ALG_ANY_HASH);
2286 psa_set_key_usage_flags(&key_attributes,
2287 PSA_KEY_USAGE_DERIVE | PSA_KEY_USAGE_EXPORT);
Jerry Yuccc68a42022-07-26 16:39:20 +08002288 }
2289#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
2290
Gilles Peskine449bd832023-01-11 14:50:10 +01002291 psa_set_key_algorithm(&key_attributes, alg);
2292 psa_set_key_type(&key_attributes, PSA_KEY_TYPE_DERIVE);
Neil Armstrong501c9322022-05-03 09:35:09 +02002293
Gilles Peskine449bd832023-01-11 14:50:10 +01002294 status = psa_import_key(&key_attributes, psk, psk_len, &key);
2295 if (status != PSA_SUCCESS) {
2296 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
2297 }
Neil Armstrong501c9322022-05-03 09:35:09 +02002298
2299 /* Allow calling psa_destroy_key() on psk remove */
2300 ssl->handshake->psk_opaque_is_internal = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01002301 return mbedtls_ssl_set_hs_psk_opaque(ssl, key);
Neil Armstrong501c9322022-05-03 09:35:09 +02002302#else
Gilles Peskine449bd832023-01-11 14:50:10 +01002303 if ((ssl->handshake->psk = mbedtls_calloc(1, psk_len)) == NULL) {
2304 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
2305 }
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002306
2307 ssl->handshake->psk_len = psk_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01002308 memcpy(ssl->handshake->psk, psk, ssl->handshake->psk_len);
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002309
Gilles Peskine449bd832023-01-11 14:50:10 +01002310 return 0;
Neil Armstrong501c9322022-05-03 09:35:09 +02002311#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002312}
2313
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002314#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01002315int mbedtls_ssl_conf_psk_opaque(mbedtls_ssl_config *conf,
2316 mbedtls_svc_key_id_t psk,
2317 const unsigned char *psk_identity,
2318 size_t psk_identity_len)
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002319{
Janos Follath865b3eb2019-12-16 11:46:15 +00002320 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002321
2322 /* We currently only support one PSK, raw or opaque. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002323 if (mbedtls_ssl_conf_has_static_psk(conf)) {
2324 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
2325 }
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002326
Hanno Becker7390c712018-11-15 13:33:04 +00002327 /* Check and set opaque PSK */
Gilles Peskine449bd832023-01-11 14:50:10 +01002328 if (mbedtls_svc_key_id_is_null(psk)) {
2329 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2330 }
Ronald Croncf56a0a2020-08-04 09:51:30 +02002331 conf->psk_opaque = psk;
Hanno Becker7390c712018-11-15 13:33:04 +00002332
2333 /* Check and set PSK Identity */
Gilles Peskine449bd832023-01-11 14:50:10 +01002334 ret = ssl_conf_set_psk_identity(conf, psk_identity,
2335 psk_identity_len);
2336 if (ret != 0) {
2337 ssl_conf_remove_psk(conf);
2338 }
Hanno Becker7390c712018-11-15 13:33:04 +00002339
Gilles Peskine449bd832023-01-11 14:50:10 +01002340 return ret;
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002341}
2342
Gilles Peskine449bd832023-01-11 14:50:10 +01002343int mbedtls_ssl_set_hs_psk_opaque(mbedtls_ssl_context *ssl,
2344 mbedtls_svc_key_id_t psk)
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002345{
Gilles Peskine449bd832023-01-11 14:50:10 +01002346 if ((mbedtls_svc_key_id_is_null(psk)) ||
2347 (ssl->handshake == NULL)) {
2348 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2349 }
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002350
Gilles Peskine449bd832023-01-11 14:50:10 +01002351 ssl_remove_psk(ssl);
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002352 ssl->handshake->psk_opaque = psk;
Gilles Peskine449bd832023-01-11 14:50:10 +01002353 return 0;
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002354}
2355#endif /* MBEDTLS_USE_PSA_CRYPTO */
2356
Jerry Yu8897c072022-08-12 13:56:53 +08002357#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002358void mbedtls_ssl_conf_psk_cb(mbedtls_ssl_config *conf,
2359 int (*f_psk)(void *, mbedtls_ssl_context *, const unsigned char *,
2360 size_t),
2361 void *p_psk)
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002362{
2363 conf->f_psk = f_psk;
2364 conf->p_psk = p_psk;
2365}
Jerry Yu8897c072022-08-12 13:56:53 +08002366#endif /* MBEDTLS_SSL_SRV_C */
2367
Ronald Cron73fe8df2022-10-05 14:31:43 +02002368#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED */
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002369
2370#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine301711e2022-04-26 16:57:05 +02002371static mbedtls_ssl_mode_t mbedtls_ssl_get_base_mode(
Gilles Peskine449bd832023-01-11 14:50:10 +01002372 psa_algorithm_t alg)
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002373{
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002374#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01002375 if (alg == PSA_ALG_CBC_NO_PADDING) {
2376 return MBEDTLS_SSL_MODE_CBC;
2377 }
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002378#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
Gilles Peskine449bd832023-01-11 14:50:10 +01002379 if (PSA_ALG_IS_AEAD(alg)) {
2380 return MBEDTLS_SSL_MODE_AEAD;
2381 }
2382 return MBEDTLS_SSL_MODE_STREAM;
Gilles Peskine301711e2022-04-26 16:57:05 +02002383}
2384
2385#else /* MBEDTLS_USE_PSA_CRYPTO */
2386
2387static mbedtls_ssl_mode_t mbedtls_ssl_get_base_mode(
Gilles Peskine449bd832023-01-11 14:50:10 +01002388 mbedtls_cipher_mode_t mode)
Gilles Peskine301711e2022-04-26 16:57:05 +02002389{
2390#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01002391 if (mode == MBEDTLS_MODE_CBC) {
2392 return MBEDTLS_SSL_MODE_CBC;
2393 }
Gilles Peskine301711e2022-04-26 16:57:05 +02002394#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
2395
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002396#if defined(MBEDTLS_GCM_C) || \
2397 defined(MBEDTLS_CCM_C) || \
2398 defined(MBEDTLS_CHACHAPOLY_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002399 if (mode == MBEDTLS_MODE_GCM ||
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002400 mode == MBEDTLS_MODE_CCM ||
Gilles Peskine449bd832023-01-11 14:50:10 +01002401 mode == MBEDTLS_MODE_CHACHAPOLY) {
2402 return MBEDTLS_SSL_MODE_AEAD;
2403 }
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002404#endif /* MBEDTLS_GCM_C || MBEDTLS_CCM_C || MBEDTLS_CHACHAPOLY_C */
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002405
Gilles Peskine449bd832023-01-11 14:50:10 +01002406 return MBEDTLS_SSL_MODE_STREAM;
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002407}
Gilles Peskine301711e2022-04-26 16:57:05 +02002408#endif /* MBEDTLS_USE_PSA_CRYPTO */
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002409
Gilles Peskinee108d982022-04-26 16:50:40 +02002410static mbedtls_ssl_mode_t mbedtls_ssl_get_actual_mode(
2411 mbedtls_ssl_mode_t base_mode,
Gilles Peskine449bd832023-01-11 14:50:10 +01002412 int encrypt_then_mac)
Gilles Peskinee108d982022-04-26 16:50:40 +02002413{
2414#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01002415 if (encrypt_then_mac == MBEDTLS_SSL_ETM_ENABLED &&
2416 base_mode == MBEDTLS_SSL_MODE_CBC) {
2417 return MBEDTLS_SSL_MODE_CBC_ETM;
Gilles Peskinee108d982022-04-26 16:50:40 +02002418 }
2419#else
2420 (void) encrypt_then_mac;
2421#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002422 return base_mode;
Gilles Peskinee108d982022-04-26 16:50:40 +02002423}
2424
Neil Armstrongab555e02022-04-04 11:07:59 +02002425mbedtls_ssl_mode_t mbedtls_ssl_get_mode_from_transform(
Gilles Peskine449bd832023-01-11 14:50:10 +01002426 const mbedtls_ssl_transform *transform)
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002427{
Gilles Peskinee108d982022-04-26 16:50:40 +02002428 mbedtls_ssl_mode_t base_mode = mbedtls_ssl_get_base_mode(
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002429#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01002430 transform->psa_alg
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002431#else
Gilles Peskine449bd832023-01-11 14:50:10 +01002432 mbedtls_cipher_get_cipher_mode(&transform->cipher_ctx_enc)
Gilles Peskinee108d982022-04-26 16:50:40 +02002433#endif
2434 );
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002435
Gilles Peskinee108d982022-04-26 16:50:40 +02002436 int encrypt_then_mac = 0;
Neil Armstrongf2c82f02022-04-05 11:16:53 +02002437#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskinee108d982022-04-26 16:50:40 +02002438 encrypt_then_mac = transform->encrypt_then_mac;
2439#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002440 return mbedtls_ssl_get_actual_mode(base_mode, encrypt_then_mac);
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002441}
2442
Neil Armstrongab555e02022-04-04 11:07:59 +02002443mbedtls_ssl_mode_t mbedtls_ssl_get_mode_from_ciphersuite(
Neil Armstrongf2c82f02022-04-05 11:16:53 +02002444#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01002445 int encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02002446#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01002447 const mbedtls_ssl_ciphersuite_t *suite)
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002448{
Gilles Peskinee108d982022-04-26 16:50:40 +02002449 mbedtls_ssl_mode_t base_mode = MBEDTLS_SSL_MODE_STREAM;
2450
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002451#if defined(MBEDTLS_USE_PSA_CRYPTO)
2452 psa_status_t status;
2453 psa_algorithm_t alg;
2454 psa_key_type_t type;
2455 size_t size;
Dave Rodgman2eab4622023-10-05 13:30:37 +01002456 status = mbedtls_ssl_cipher_to_psa((mbedtls_cipher_type_t) suite->cipher,
2457 0, &alg, &type, &size);
Gilles Peskine449bd832023-01-11 14:50:10 +01002458 if (status == PSA_SUCCESS) {
2459 base_mode = mbedtls_ssl_get_base_mode(alg);
2460 }
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002461#else
2462 const mbedtls_cipher_info_t *cipher =
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01002463 mbedtls_cipher_info_from_type((mbedtls_cipher_type_t) suite->cipher);
Gilles Peskine449bd832023-01-11 14:50:10 +01002464 if (cipher != NULL) {
Gilles Peskinee108d982022-04-26 16:50:40 +02002465 base_mode =
2466 mbedtls_ssl_get_base_mode(
Gilles Peskine449bd832023-01-11 14:50:10 +01002467 mbedtls_cipher_info_get_mode(cipher));
Gilles Peskinee108d982022-04-26 16:50:40 +02002468 }
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002469#endif /* MBEDTLS_USE_PSA_CRYPTO */
2470
Gilles Peskinee108d982022-04-26 16:50:40 +02002471#if !defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
2472 int encrypt_then_mac = 0;
2473#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002474 return mbedtls_ssl_get_actual_mode(base_mode, encrypt_then_mac);
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002475}
2476
Neil Armstrong8395d7a2022-05-18 11:44:56 +02002477#if defined(MBEDTLS_USE_PSA_CRYPTO) || defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yu251a12e2022-07-13 15:15:48 +08002478
Gilles Peskine449bd832023-01-11 14:50:10 +01002479psa_status_t mbedtls_ssl_cipher_to_psa(mbedtls_cipher_type_t mbedtls_cipher_type,
2480 size_t taglen,
2481 psa_algorithm_t *alg,
2482 psa_key_type_t *key_type,
2483 size_t *key_size)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002484{
Yanray Wang19e4dc82023-11-16 18:02:05 +08002485#if !defined(MBEDTLS_SSL_HAVE_CCM)
2486 (void) taglen;
2487#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002488 switch (mbedtls_cipher_type) {
Yanray Wang1a369d62023-11-16 15:17:31 +08002489#if defined(MBEDTLS_SSL_HAVE_AES) && defined(MBEDTLS_SSL_HAVE_CBC)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002490 case MBEDTLS_CIPHER_AES_128_CBC:
2491 *alg = PSA_ALG_CBC_NO_PADDING;
2492 *key_type = PSA_KEY_TYPE_AES;
2493 *key_size = 128;
2494 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002495#endif
2496#if defined(MBEDTLS_SSL_HAVE_AES) && defined(MBEDTLS_SSL_HAVE_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002497 case MBEDTLS_CIPHER_AES_128_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002498 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002499 *key_type = PSA_KEY_TYPE_AES;
2500 *key_size = 128;
2501 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002502#endif
2503#if defined(MBEDTLS_SSL_HAVE_AES) && defined(MBEDTLS_SSL_HAVE_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002504 case MBEDTLS_CIPHER_AES_128_GCM:
2505 *alg = PSA_ALG_GCM;
2506 *key_type = PSA_KEY_TYPE_AES;
2507 *key_size = 128;
2508 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002509#endif
2510#if defined(MBEDTLS_SSL_HAVE_AES) && defined(MBEDTLS_SSL_HAVE_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002511 case MBEDTLS_CIPHER_AES_192_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002512 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002513 *key_type = PSA_KEY_TYPE_AES;
2514 *key_size = 192;
2515 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002516#endif
2517#if defined(MBEDTLS_SSL_HAVE_AES) && defined(MBEDTLS_SSL_HAVE_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002518 case MBEDTLS_CIPHER_AES_192_GCM:
2519 *alg = PSA_ALG_GCM;
2520 *key_type = PSA_KEY_TYPE_AES;
2521 *key_size = 192;
2522 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002523#endif
2524#if defined(MBEDTLS_SSL_HAVE_AES) && defined(MBEDTLS_SSL_HAVE_CBC)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002525 case MBEDTLS_CIPHER_AES_256_CBC:
2526 *alg = PSA_ALG_CBC_NO_PADDING;
2527 *key_type = PSA_KEY_TYPE_AES;
2528 *key_size = 256;
2529 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002530#endif
2531#if defined(MBEDTLS_SSL_HAVE_AES) && defined(MBEDTLS_SSL_HAVE_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002532 case MBEDTLS_CIPHER_AES_256_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002533 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002534 *key_type = PSA_KEY_TYPE_AES;
2535 *key_size = 256;
2536 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002537#endif
2538#if defined(MBEDTLS_SSL_HAVE_AES) && defined(MBEDTLS_SSL_HAVE_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002539 case MBEDTLS_CIPHER_AES_256_GCM:
2540 *alg = PSA_ALG_GCM;
2541 *key_type = PSA_KEY_TYPE_AES;
2542 *key_size = 256;
2543 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002544#endif
2545#if defined(MBEDTLS_SSL_HAVE_ARIA) && defined(MBEDTLS_SSL_HAVE_CBC)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002546 case MBEDTLS_CIPHER_ARIA_128_CBC:
2547 *alg = PSA_ALG_CBC_NO_PADDING;
2548 *key_type = PSA_KEY_TYPE_ARIA;
2549 *key_size = 128;
2550 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002551#endif
2552#if defined(MBEDTLS_SSL_HAVE_ARIA) && defined(MBEDTLS_SSL_HAVE_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002553 case MBEDTLS_CIPHER_ARIA_128_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002554 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002555 *key_type = PSA_KEY_TYPE_ARIA;
2556 *key_size = 128;
2557 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002558#endif
2559#if defined(MBEDTLS_SSL_HAVE_ARIA) && defined(MBEDTLS_SSL_HAVE_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002560 case MBEDTLS_CIPHER_ARIA_128_GCM:
2561 *alg = PSA_ALG_GCM;
2562 *key_type = PSA_KEY_TYPE_ARIA;
2563 *key_size = 128;
2564 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002565#endif
2566#if defined(MBEDTLS_SSL_HAVE_ARIA) && defined(MBEDTLS_SSL_HAVE_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002567 case MBEDTLS_CIPHER_ARIA_192_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002568 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002569 *key_type = PSA_KEY_TYPE_ARIA;
2570 *key_size = 192;
2571 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002572#endif
2573#if defined(MBEDTLS_SSL_HAVE_ARIA) && defined(MBEDTLS_SSL_HAVE_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002574 case MBEDTLS_CIPHER_ARIA_192_GCM:
2575 *alg = PSA_ALG_GCM;
2576 *key_type = PSA_KEY_TYPE_ARIA;
2577 *key_size = 192;
2578 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002579#endif
2580#if defined(MBEDTLS_SSL_HAVE_ARIA) && defined(MBEDTLS_SSL_HAVE_CBC)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002581 case MBEDTLS_CIPHER_ARIA_256_CBC:
2582 *alg = PSA_ALG_CBC_NO_PADDING;
2583 *key_type = PSA_KEY_TYPE_ARIA;
2584 *key_size = 256;
2585 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002586#endif
2587#if defined(MBEDTLS_SSL_HAVE_ARIA) && defined(MBEDTLS_SSL_HAVE_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002588 case MBEDTLS_CIPHER_ARIA_256_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002589 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002590 *key_type = PSA_KEY_TYPE_ARIA;
2591 *key_size = 256;
2592 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002593#endif
2594#if defined(MBEDTLS_SSL_HAVE_ARIA) && defined(MBEDTLS_SSL_HAVE_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002595 case MBEDTLS_CIPHER_ARIA_256_GCM:
2596 *alg = PSA_ALG_GCM;
2597 *key_type = PSA_KEY_TYPE_ARIA;
2598 *key_size = 256;
2599 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002600#endif
2601#if defined(MBEDTLS_SSL_HAVE_CAMELLIA) && defined(MBEDTLS_SSL_HAVE_CBC)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002602 case MBEDTLS_CIPHER_CAMELLIA_128_CBC:
2603 *alg = PSA_ALG_CBC_NO_PADDING;
2604 *key_type = PSA_KEY_TYPE_CAMELLIA;
2605 *key_size = 128;
2606 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002607#endif
2608#if defined(MBEDTLS_SSL_HAVE_CAMELLIA) && defined(MBEDTLS_SSL_HAVE_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002609 case MBEDTLS_CIPHER_CAMELLIA_128_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002610 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002611 *key_type = PSA_KEY_TYPE_CAMELLIA;
2612 *key_size = 128;
2613 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002614#endif
2615#if defined(MBEDTLS_SSL_HAVE_CAMELLIA) && defined(MBEDTLS_SSL_HAVE_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002616 case MBEDTLS_CIPHER_CAMELLIA_128_GCM:
2617 *alg = PSA_ALG_GCM;
2618 *key_type = PSA_KEY_TYPE_CAMELLIA;
2619 *key_size = 128;
2620 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002621#endif
2622#if defined(MBEDTLS_SSL_HAVE_CAMELLIA) && defined(MBEDTLS_SSL_HAVE_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002623 case MBEDTLS_CIPHER_CAMELLIA_192_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002624 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002625 *key_type = PSA_KEY_TYPE_CAMELLIA;
2626 *key_size = 192;
2627 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002628#endif
2629#if defined(MBEDTLS_SSL_HAVE_CAMELLIA) && defined(MBEDTLS_SSL_HAVE_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002630 case MBEDTLS_CIPHER_CAMELLIA_192_GCM:
2631 *alg = PSA_ALG_GCM;
2632 *key_type = PSA_KEY_TYPE_CAMELLIA;
2633 *key_size = 192;
2634 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002635#endif
2636#if defined(MBEDTLS_SSL_HAVE_CAMELLIA) && defined(MBEDTLS_SSL_HAVE_CBC)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002637 case MBEDTLS_CIPHER_CAMELLIA_256_CBC:
2638 *alg = PSA_ALG_CBC_NO_PADDING;
2639 *key_type = PSA_KEY_TYPE_CAMELLIA;
2640 *key_size = 256;
2641 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002642#endif
2643#if defined(MBEDTLS_SSL_HAVE_CAMELLIA) && defined(MBEDTLS_SSL_HAVE_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002644 case MBEDTLS_CIPHER_CAMELLIA_256_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002645 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002646 *key_type = PSA_KEY_TYPE_CAMELLIA;
2647 *key_size = 256;
2648 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002649#endif
2650#if defined(MBEDTLS_SSL_HAVE_CAMELLIA) && defined(MBEDTLS_SSL_HAVE_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002651 case MBEDTLS_CIPHER_CAMELLIA_256_GCM:
2652 *alg = PSA_ALG_GCM;
2653 *key_type = PSA_KEY_TYPE_CAMELLIA;
2654 *key_size = 256;
2655 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002656#endif
2657#if defined(MBEDTLS_SSL_HAVE_CHACHAPOLY)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002658 case MBEDTLS_CIPHER_CHACHA20_POLY1305:
2659 *alg = PSA_ALG_CHACHA20_POLY1305;
2660 *key_type = PSA_KEY_TYPE_CHACHA20;
2661 *key_size = 256;
2662 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002663#endif
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002664 case MBEDTLS_CIPHER_NULL:
2665 *alg = MBEDTLS_SSL_NULL_CIPHER;
2666 *key_type = 0;
2667 *key_size = 0;
2668 break;
2669 default:
2670 return PSA_ERROR_NOT_SUPPORTED;
2671 }
2672
2673 return PSA_SUCCESS;
2674}
Neil Armstrong8395d7a2022-05-18 11:44:56 +02002675#endif /* MBEDTLS_USE_PSA_CRYPTO || MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002676
Manuel Pégourié-Gonnardcf141ca2015-05-20 10:35:51 +02002677#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002678int mbedtls_ssl_conf_dh_param_bin(mbedtls_ssl_config *conf,
2679 const unsigned char *dhm_P, size_t P_len,
2680 const unsigned char *dhm_G, size_t G_len)
Hanno Beckera90658f2017-10-04 15:29:08 +01002681{
Janos Follath865b3eb2019-12-16 11:46:15 +00002682 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Beckera90658f2017-10-04 15:29:08 +01002683
Gilles Peskine449bd832023-01-11 14:50:10 +01002684 mbedtls_mpi_free(&conf->dhm_P);
2685 mbedtls_mpi_free(&conf->dhm_G);
Glenn Strausscee11292021-12-20 01:43:17 -05002686
Gilles Peskine449bd832023-01-11 14:50:10 +01002687 if ((ret = mbedtls_mpi_read_binary(&conf->dhm_P, dhm_P, P_len)) != 0 ||
2688 (ret = mbedtls_mpi_read_binary(&conf->dhm_G, dhm_G, G_len)) != 0) {
2689 mbedtls_mpi_free(&conf->dhm_P);
2690 mbedtls_mpi_free(&conf->dhm_G);
2691 return ret;
Hanno Beckera90658f2017-10-04 15:29:08 +01002692 }
2693
Gilles Peskine449bd832023-01-11 14:50:10 +01002694 return 0;
Hanno Beckera90658f2017-10-04 15:29:08 +01002695}
Paul Bakker5121ce52009-01-03 21:22:43 +00002696
Gilles Peskine449bd832023-01-11 14:50:10 +01002697int mbedtls_ssl_conf_dh_param_ctx(mbedtls_ssl_config *conf, mbedtls_dhm_context *dhm_ctx)
Paul Bakker1b57b062011-01-06 15:48:19 +00002698{
Janos Follath865b3eb2019-12-16 11:46:15 +00002699 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker1b57b062011-01-06 15:48:19 +00002700
Gilles Peskine449bd832023-01-11 14:50:10 +01002701 mbedtls_mpi_free(&conf->dhm_P);
2702 mbedtls_mpi_free(&conf->dhm_G);
Glenn Strausscee11292021-12-20 01:43:17 -05002703
Gilles Peskine449bd832023-01-11 14:50:10 +01002704 if ((ret = mbedtls_dhm_get_value(dhm_ctx, MBEDTLS_DHM_PARAM_P,
2705 &conf->dhm_P)) != 0 ||
2706 (ret = mbedtls_dhm_get_value(dhm_ctx, MBEDTLS_DHM_PARAM_G,
2707 &conf->dhm_G)) != 0) {
2708 mbedtls_mpi_free(&conf->dhm_P);
2709 mbedtls_mpi_free(&conf->dhm_G);
2710 return ret;
Manuel Pégourié-Gonnard1028b742015-05-06 17:33:07 +01002711 }
Paul Bakker1b57b062011-01-06 15:48:19 +00002712
Gilles Peskine449bd832023-01-11 14:50:10 +01002713 return 0;
Paul Bakker1b57b062011-01-06 15:48:19 +00002714}
Manuel Pégourié-Gonnardcf141ca2015-05-20 10:35:51 +02002715#endif /* MBEDTLS_DHM_C && MBEDTLS_SSL_SRV_C */
Paul Bakker1b57b062011-01-06 15:48:19 +00002716
Manuel Pégourié-Gonnardbd990d62015-06-11 14:49:42 +02002717#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_CLI_C)
2718/*
2719 * Set the minimum length for Diffie-Hellman parameters
2720 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002721void mbedtls_ssl_conf_dhm_min_bitlen(mbedtls_ssl_config *conf,
2722 unsigned int bitlen)
Manuel Pégourié-Gonnardbd990d62015-06-11 14:49:42 +02002723{
2724 conf->dhm_min_bitlen = bitlen;
2725}
2726#endif /* MBEDTLS_DHM_C && MBEDTLS_SSL_CLI_C */
2727
Ronald Crone68ab4f2022-10-05 12:46:29 +02002728#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu7ddc38c2022-01-19 11:08:05 +08002729#if !defined(MBEDTLS_DEPRECATED_REMOVED) && defined(MBEDTLS_SSL_PROTO_TLS1_2)
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02002730/*
2731 * Set allowed/preferred hashes for handshake signatures
2732 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002733void mbedtls_ssl_conf_sig_hashes(mbedtls_ssl_config *conf,
2734 const int *hashes)
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02002735{
2736 conf->sig_hashes = hashes;
2737}
Jerry Yu7ddc38c2022-01-19 11:08:05 +08002738#endif /* !MBEDTLS_DEPRECATED_REMOVED && MBEDTLS_SSL_PROTO_TLS1_2 */
Hanno Becker1cd6e002021-08-10 13:27:10 +01002739
Jerry Yuf017ee42022-01-12 15:49:48 +08002740/* Configure allowed signature algorithms for handshake */
Gilles Peskine449bd832023-01-11 14:50:10 +01002741void mbedtls_ssl_conf_sig_algs(mbedtls_ssl_config *conf,
2742 const uint16_t *sig_algs)
Hanno Becker1cd6e002021-08-10 13:27:10 +01002743{
Jerry Yuf017ee42022-01-12 15:49:48 +08002744#if !defined(MBEDTLS_DEPRECATED_REMOVED)
2745 conf->sig_hashes = NULL;
2746#endif /* !MBEDTLS_DEPRECATED_REMOVED */
2747 conf->sig_algs = sig_algs;
Hanno Becker1cd6e002021-08-10 13:27:10 +01002748}
Ronald Crone68ab4f2022-10-05 12:46:29 +02002749#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02002750
Manuel Pégourié-Gonnardf07ce3b2023-09-22 11:53:41 +02002751#if defined(MBEDTLS_ECP_C)
Brett Warrene0edc842021-08-17 09:53:13 +01002752#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002753/*
2754 * Set the allowed elliptic curves
Brett Warrene0edc842021-08-17 09:53:13 +01002755 *
2756 * mbedtls_ssl_setup() takes the provided list
2757 * and translates it to a list of IANA TLS group identifiers,
2758 * stored in ssl->handshake->group_list.
2759 *
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002760 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002761void mbedtls_ssl_conf_curves(mbedtls_ssl_config *conf,
2762 const mbedtls_ecp_group_id *curve_list)
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002763{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002764 conf->curve_list = curve_list;
Brett Warrene0edc842021-08-17 09:53:13 +01002765 conf->group_list = NULL;
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002766}
Brett Warrene0edc842021-08-17 09:53:13 +01002767#endif /* MBEDTLS_DEPRECATED_REMOVED */
Manuel Pégourié-Gonnardf07ce3b2023-09-22 11:53:41 +02002768#endif /* MBEDTLS_ECP_C */
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002769
Brett Warrene0edc842021-08-17 09:53:13 +01002770/*
2771 * Set the allowed groups
2772 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002773void mbedtls_ssl_conf_groups(mbedtls_ssl_config *conf,
2774 const uint16_t *group_list)
Brett Warrene0edc842021-08-17 09:53:13 +01002775{
Manuel Pégourié-Gonnardf07ce3b2023-09-22 11:53:41 +02002776#if defined(MBEDTLS_ECP_C) && !defined(MBEDTLS_DEPRECATED_REMOVED)
Brett Warrene0edc842021-08-17 09:53:13 +01002777 conf->curve_list = NULL;
2778#endif
2779 conf->group_list = group_list;
2780}
2781
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01002782#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002783int mbedtls_ssl_set_hostname(mbedtls_ssl_context *ssl, const char *hostname)
Paul Bakker5121ce52009-01-03 21:22:43 +00002784{
Hanno Becker947194e2017-04-07 13:25:49 +01002785 /* Initialize to suppress unnecessary compiler warning */
2786 size_t hostname_len = 0;
2787
2788 /* Check if new hostname is valid before
2789 * making any change to current one */
Gilles Peskine449bd832023-01-11 14:50:10 +01002790 if (hostname != NULL) {
2791 hostname_len = strlen(hostname);
Hanno Becker947194e2017-04-07 13:25:49 +01002792
Gilles Peskine449bd832023-01-11 14:50:10 +01002793 if (hostname_len > MBEDTLS_SSL_MAX_HOST_NAME_LEN) {
2794 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2795 }
Hanno Becker947194e2017-04-07 13:25:49 +01002796 }
2797
2798 /* Now it's clear that we will overwrite the old hostname,
2799 * so we can free it safely */
2800
Gilles Peskine449bd832023-01-11 14:50:10 +01002801 if (ssl->hostname != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01002802 mbedtls_zeroize_and_free(ssl->hostname, strlen(ssl->hostname));
Hanno Becker947194e2017-04-07 13:25:49 +01002803 }
2804
2805 /* Passing NULL as hostname shall clear the old one */
Manuel Pégourié-Gonnardba26c242015-05-06 10:47:06 +01002806
Gilles Peskine449bd832023-01-11 14:50:10 +01002807 if (hostname == NULL) {
Hanno Becker947194e2017-04-07 13:25:49 +01002808 ssl->hostname = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01002809 } else {
2810 ssl->hostname = mbedtls_calloc(1, hostname_len + 1);
2811 if (ssl->hostname == NULL) {
2812 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
2813 }
Paul Bakker75c1a6f2013-08-19 14:25:29 +02002814
Gilles Peskine449bd832023-01-11 14:50:10 +01002815 memcpy(ssl->hostname, hostname, hostname_len);
Paul Bakker75c1a6f2013-08-19 14:25:29 +02002816
Hanno Becker947194e2017-04-07 13:25:49 +01002817 ssl->hostname[hostname_len] = '\0';
2818 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002819
Gilles Peskine449bd832023-01-11 14:50:10 +01002820 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00002821}
Hanno Becker1a9a51c2017-04-07 13:02:16 +01002822#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00002823
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01002824#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01002825void mbedtls_ssl_conf_sni(mbedtls_ssl_config *conf,
2826 int (*f_sni)(void *, mbedtls_ssl_context *,
2827 const unsigned char *, size_t),
2828 void *p_sni)
Paul Bakker5701cdc2012-09-27 21:49:42 +00002829{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002830 conf->f_sni = f_sni;
2831 conf->p_sni = p_sni;
Paul Bakker5701cdc2012-09-27 21:49:42 +00002832}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002833#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
Paul Bakker5701cdc2012-09-27 21:49:42 +00002834
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002835#if defined(MBEDTLS_SSL_ALPN)
Gilles Peskine449bd832023-01-11 14:50:10 +01002836int mbedtls_ssl_conf_alpn_protocols(mbedtls_ssl_config *conf, const char **protos)
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002837{
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002838 size_t cur_len, tot_len;
2839 const char **p;
2840
2841 /*
Brian J Murray1903fb32016-11-06 04:45:15 -08002842 * RFC 7301 3.1: "Empty strings MUST NOT be included and byte strings
2843 * MUST NOT be truncated."
2844 * We check lengths now rather than later.
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002845 */
2846 tot_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01002847 for (p = protos; *p != NULL; p++) {
2848 cur_len = strlen(*p);
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002849 tot_len += cur_len;
2850
Gilles Peskine449bd832023-01-11 14:50:10 +01002851 if ((cur_len == 0) ||
2852 (cur_len > MBEDTLS_SSL_MAX_ALPN_NAME_LEN) ||
2853 (tot_len > MBEDTLS_SSL_MAX_ALPN_LIST_LEN)) {
2854 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2855 }
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002856 }
2857
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002858 conf->alpn_list = protos;
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002859
Gilles Peskine449bd832023-01-11 14:50:10 +01002860 return 0;
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002861}
2862
Gilles Peskine449bd832023-01-11 14:50:10 +01002863const char *mbedtls_ssl_get_alpn_protocol(const mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002864{
Gilles Peskine449bd832023-01-11 14:50:10 +01002865 return ssl->alpn_chosen;
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002866}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002867#endif /* MBEDTLS_SSL_ALPN */
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002868
Johan Pascalb62bb512015-12-03 21:56:45 +01002869#if defined(MBEDTLS_SSL_DTLS_SRTP)
Gilles Peskine449bd832023-01-11 14:50:10 +01002870void mbedtls_ssl_conf_srtp_mki_value_supported(mbedtls_ssl_config *conf,
2871 int support_mki_value)
Ron Eldor591f1622018-01-22 12:30:04 +02002872{
2873 conf->dtls_srtp_mki_support = support_mki_value;
2874}
2875
Gilles Peskine449bd832023-01-11 14:50:10 +01002876int mbedtls_ssl_dtls_srtp_set_mki_value(mbedtls_ssl_context *ssl,
2877 unsigned char *mki_value,
2878 uint16_t mki_len)
Ron Eldor591f1622018-01-22 12:30:04 +02002879{
Gilles Peskine449bd832023-01-11 14:50:10 +01002880 if (mki_len > MBEDTLS_TLS_SRTP_MAX_MKI_LENGTH) {
2881 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Ron Eldora9788042018-12-05 11:04:31 +02002882 }
Ron Eldor591f1622018-01-22 12:30:04 +02002883
Gilles Peskine449bd832023-01-11 14:50:10 +01002884 if (ssl->conf->dtls_srtp_mki_support == MBEDTLS_SSL_DTLS_SRTP_MKI_UNSUPPORTED) {
2885 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Ron Eldora9788042018-12-05 11:04:31 +02002886 }
Ron Eldor591f1622018-01-22 12:30:04 +02002887
Gilles Peskine449bd832023-01-11 14:50:10 +01002888 memcpy(ssl->dtls_srtp_info.mki_value, mki_value, mki_len);
Ron Eldor591f1622018-01-22 12:30:04 +02002889 ssl->dtls_srtp_info.mki_len = mki_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01002890 return 0;
Ron Eldor591f1622018-01-22 12:30:04 +02002891}
2892
Gilles Peskine449bd832023-01-11 14:50:10 +01002893int mbedtls_ssl_conf_dtls_srtp_protection_profiles(mbedtls_ssl_config *conf,
2894 const mbedtls_ssl_srtp_profile *profiles)
Johan Pascalb62bb512015-12-03 21:56:45 +01002895{
Johan Pascal253d0262020-09-22 13:04:45 +02002896 const mbedtls_ssl_srtp_profile *p;
2897 size_t list_size = 0;
Johan Pascalb62bb512015-12-03 21:56:45 +01002898
Johan Pascal253d0262020-09-22 13:04:45 +02002899 /* check the profiles list: all entry must be valid,
2900 * its size cannot be more than the total number of supported profiles, currently 4 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002901 for (p = profiles; *p != MBEDTLS_TLS_SRTP_UNSET &&
2902 list_size <= MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH;
2903 p++) {
2904 if (mbedtls_ssl_check_srtp_profile_value(*p) != MBEDTLS_TLS_SRTP_UNSET) {
Johan Pascal76fdf1d2020-10-22 23:31:00 +02002905 list_size++;
Gilles Peskine449bd832023-01-11 14:50:10 +01002906 } else {
Johan Pascal76fdf1d2020-10-22 23:31:00 +02002907 /* unsupported value, stop parsing and set the size to an error value */
2908 list_size = MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH + 1;
Johan Pascalb62bb512015-12-03 21:56:45 +01002909 }
2910 }
2911
Gilles Peskine449bd832023-01-11 14:50:10 +01002912 if (list_size > MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH) {
2913 conf->dtls_srtp_profile_list = NULL;
2914 conf->dtls_srtp_profile_list_len = 0;
2915 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Johan Pascal253d0262020-09-22 13:04:45 +02002916 }
2917
Johan Pascal9bc97ca2020-09-21 23:44:45 +02002918 conf->dtls_srtp_profile_list = profiles;
Johan Pascal253d0262020-09-22 13:04:45 +02002919 conf->dtls_srtp_profile_list_len = list_size;
Johan Pascalb62bb512015-12-03 21:56:45 +01002920
Gilles Peskine449bd832023-01-11 14:50:10 +01002921 return 0;
Johan Pascalb62bb512015-12-03 21:56:45 +01002922}
2923
Gilles Peskine449bd832023-01-11 14:50:10 +01002924void mbedtls_ssl_get_dtls_srtp_negotiation_result(const mbedtls_ssl_context *ssl,
2925 mbedtls_dtls_srtp_info *dtls_srtp_info)
Johan Pascalb62bb512015-12-03 21:56:45 +01002926{
Johan Pascal2258a4f2020-10-28 13:53:09 +01002927 dtls_srtp_info->chosen_dtls_srtp_profile = ssl->dtls_srtp_info.chosen_dtls_srtp_profile;
2928 /* do not copy the mki value if there is no chosen profile */
Gilles Peskine449bd832023-01-11 14:50:10 +01002929 if (dtls_srtp_info->chosen_dtls_srtp_profile == MBEDTLS_TLS_SRTP_UNSET) {
Johan Pascal2258a4f2020-10-28 13:53:09 +01002930 dtls_srtp_info->mki_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01002931 } else {
Johan Pascal2258a4f2020-10-28 13:53:09 +01002932 dtls_srtp_info->mki_len = ssl->dtls_srtp_info.mki_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01002933 memcpy(dtls_srtp_info->mki_value, ssl->dtls_srtp_info.mki_value,
2934 ssl->dtls_srtp_info.mki_len);
Johan Pascal2258a4f2020-10-28 13:53:09 +01002935 }
Johan Pascalb62bb512015-12-03 21:56:45 +01002936}
Johan Pascalb62bb512015-12-03 21:56:45 +01002937#endif /* MBEDTLS_SSL_DTLS_SRTP */
2938
Aditya Patwardhan3096f332022-07-26 14:31:46 +05302939#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Gilles Peskine449bd832023-01-11 14:50:10 +01002940void mbedtls_ssl_conf_max_version(mbedtls_ssl_config *conf, int major, int minor)
Paul Bakker490ecc82011-10-06 13:04:09 +00002941{
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01002942 conf->max_tls_version = (mbedtls_ssl_protocol_version) ((major << 8) | minor);
Paul Bakker490ecc82011-10-06 13:04:09 +00002943}
2944
Gilles Peskine449bd832023-01-11 14:50:10 +01002945void mbedtls_ssl_conf_min_version(mbedtls_ssl_config *conf, int major, int minor)
Paul Bakker1d29fb52012-09-28 13:28:45 +00002946{
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01002947 conf->min_tls_version = (mbedtls_ssl_protocol_version) ((major << 8) | minor);
Paul Bakker1d29fb52012-09-28 13:28:45 +00002948}
Aditya Patwardhan3096f332022-07-26 14:31:46 +05302949#endif /* MBEDTLS_DEPRECATED_REMOVED */
Paul Bakker1d29fb52012-09-28 13:28:45 +00002950
Janos Follath088ce432017-04-10 12:42:31 +01002951#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002952void mbedtls_ssl_conf_cert_req_ca_list(mbedtls_ssl_config *conf,
2953 char cert_req_ca_list)
Janos Follath088ce432017-04-10 12:42:31 +01002954{
2955 conf->cert_req_ca_list = cert_req_ca_list;
2956}
2957#endif
2958
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002959#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01002960void mbedtls_ssl_conf_encrypt_then_mac(mbedtls_ssl_config *conf, char etm)
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01002961{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002962 conf->encrypt_then_mac = etm;
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01002963}
2964#endif
2965
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002966#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
Gilles Peskine449bd832023-01-11 14:50:10 +01002967void mbedtls_ssl_conf_extended_master_secret(mbedtls_ssl_config *conf, char ems)
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02002968{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002969 conf->extended_ms = ems;
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02002970}
2971#endif
2972
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002973#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01002974int mbedtls_ssl_conf_max_frag_len(mbedtls_ssl_config *conf, unsigned char mfl_code)
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002975{
Gilles Peskine449bd832023-01-11 14:50:10 +01002976 if (mfl_code >= MBEDTLS_SSL_MAX_FRAG_LEN_INVALID ||
2977 ssl_mfl_code_to_length(mfl_code) > MBEDTLS_TLS_EXT_ADV_CONTENT_LEN) {
2978 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002979 }
2980
Manuel Pégourié-Gonnard6bf89d62015-05-05 17:01:57 +01002981 conf->mfl_code = mfl_code;
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002982
Gilles Peskine449bd832023-01-11 14:50:10 +01002983 return 0;
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002984}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002985#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002986
Gilles Peskine449bd832023-01-11 14:50:10 +01002987void mbedtls_ssl_conf_legacy_renegotiation(mbedtls_ssl_config *conf, int allow_legacy)
Paul Bakker48916f92012-09-16 19:57:18 +00002988{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002989 conf->allow_legacy_renegotiation = allow_legacy;
Paul Bakker48916f92012-09-16 19:57:18 +00002990}
2991
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002992#if defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01002993void mbedtls_ssl_conf_renegotiation(mbedtls_ssl_config *conf, int renegotiation)
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01002994{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002995 conf->disable_renegotiation = renegotiation;
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01002996}
2997
Gilles Peskine449bd832023-01-11 14:50:10 +01002998void mbedtls_ssl_conf_renegotiation_enforced(mbedtls_ssl_config *conf, int max_records)
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02002999{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003000 conf->renego_max_records = max_records;
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02003001}
3002
Gilles Peskine449bd832023-01-11 14:50:10 +01003003void mbedtls_ssl_conf_renegotiation_period(mbedtls_ssl_config *conf,
3004 const unsigned char period[8])
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01003005{
Gilles Peskine449bd832023-01-11 14:50:10 +01003006 memcpy(conf->renego_period, period, 8);
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01003007}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003008#endif /* MBEDTLS_SSL_RENEGOTIATION */
Paul Bakker5121ce52009-01-03 21:22:43 +00003009
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003010#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02003011#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01003012void mbedtls_ssl_conf_session_tickets(mbedtls_ssl_config *conf, int use_tickets)
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02003013{
Manuel Pégourié-Gonnard2b494452015-05-06 10:05:11 +01003014 conf->session_tickets = use_tickets;
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02003015}
Ronald Cronbedddd72024-08-27 14:18:50 +02003016#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
3017void mbedtls_ssl_conf_enable_new_session_tickets(mbedtls_ssl_config *conf,
3018 int new_session_tickets_enabled)
3019{
3020 conf->new_session_tickets_enabled = new_session_tickets_enabled;
3021}
3022#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
3023#endif /* MBEDTLS_SSL_CLI_C */
Paul Bakker606b4ba2013-08-14 16:52:14 +02003024
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02003025#if defined(MBEDTLS_SSL_SRV_C)
Jerry Yu1ad7ace2022-08-09 13:28:39 +08003026
Jerry Yud0766ec2022-09-22 10:46:57 +08003027#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003028void mbedtls_ssl_conf_new_session_tickets(mbedtls_ssl_config *conf,
3029 uint16_t num_tickets)
Jerry Yu1ad7ace2022-08-09 13:28:39 +08003030{
Jerry Yud0766ec2022-09-22 10:46:57 +08003031 conf->new_session_tickets_count = num_tickets;
Jerry Yu1ad7ace2022-08-09 13:28:39 +08003032}
3033#endif
3034
Gilles Peskine449bd832023-01-11 14:50:10 +01003035void mbedtls_ssl_conf_session_tickets_cb(mbedtls_ssl_config *conf,
3036 mbedtls_ssl_ticket_write_t *f_ticket_write,
3037 mbedtls_ssl_ticket_parse_t *f_ticket_parse,
3038 void *p_ticket)
Paul Bakker606b4ba2013-08-14 16:52:14 +02003039{
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02003040 conf->f_ticket_write = f_ticket_write;
3041 conf->f_ticket_parse = f_ticket_parse;
3042 conf->p_ticket = p_ticket;
Paul Bakker606b4ba2013-08-14 16:52:14 +02003043}
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02003044#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003045#endif /* MBEDTLS_SSL_SESSION_TICKETS */
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02003046
Gilles Peskine449bd832023-01-11 14:50:10 +01003047void mbedtls_ssl_set_export_keys_cb(mbedtls_ssl_context *ssl,
3048 mbedtls_ssl_export_keys_t *f_export_keys,
3049 void *p_export_keys)
Robert Cragie4feb7ae2015-10-02 13:33:37 +01003050{
Hanno Becker7e6c1782021-06-08 09:24:55 +01003051 ssl->f_export_keys = f_export_keys;
3052 ssl->p_export_keys = p_export_keys;
Ron Eldorf5cc10d2019-05-07 18:33:40 +03003053}
Robert Cragie4feb7ae2015-10-02 13:33:37 +01003054
Gilles Peskineb74a1c72018-04-24 13:09:22 +02003055#if defined(MBEDTLS_SSL_ASYNC_PRIVATE)
Gilles Peskine8bf79f62018-01-05 21:11:53 +01003056void mbedtls_ssl_conf_async_private_cb(
3057 mbedtls_ssl_config *conf,
3058 mbedtls_ssl_async_sign_t *f_async_sign,
3059 mbedtls_ssl_async_decrypt_t *f_async_decrypt,
3060 mbedtls_ssl_async_resume_t *f_async_resume,
3061 mbedtls_ssl_async_cancel_t *f_async_cancel,
Gilles Peskine449bd832023-01-11 14:50:10 +01003062 void *async_config_data)
Gilles Peskine8bf79f62018-01-05 21:11:53 +01003063{
3064 conf->f_async_sign_start = f_async_sign;
3065 conf->f_async_decrypt_start = f_async_decrypt;
3066 conf->f_async_resume = f_async_resume;
3067 conf->f_async_cancel = f_async_cancel;
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003068 conf->p_async_config_data = async_config_data;
3069}
3070
Gilles Peskine449bd832023-01-11 14:50:10 +01003071void *mbedtls_ssl_conf_get_async_config_data(const mbedtls_ssl_config *conf)
Gilles Peskine8f97af72018-04-26 11:46:10 +02003072{
Gilles Peskine449bd832023-01-11 14:50:10 +01003073 return conf->p_async_config_data;
Gilles Peskine8f97af72018-04-26 11:46:10 +02003074}
3075
Gilles Peskine449bd832023-01-11 14:50:10 +01003076void *mbedtls_ssl_get_async_operation_data(const mbedtls_ssl_context *ssl)
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003077{
Gilles Peskine449bd832023-01-11 14:50:10 +01003078 if (ssl->handshake == NULL) {
3079 return NULL;
3080 } else {
3081 return ssl->handshake->user_async_ctx;
3082 }
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003083}
3084
Gilles Peskine449bd832023-01-11 14:50:10 +01003085void mbedtls_ssl_set_async_operation_data(mbedtls_ssl_context *ssl,
3086 void *ctx)
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003087{
Gilles Peskine449bd832023-01-11 14:50:10 +01003088 if (ssl->handshake != NULL) {
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003089 ssl->handshake->user_async_ctx = ctx;
Gilles Peskine449bd832023-01-11 14:50:10 +01003090 }
Gilles Peskine8bf79f62018-01-05 21:11:53 +01003091}
Gilles Peskineb74a1c72018-04-24 13:09:22 +02003092#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
Gilles Peskine8bf79f62018-01-05 21:11:53 +01003093
Paul Bakker5121ce52009-01-03 21:22:43 +00003094/*
3095 * SSL get accessors
3096 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003097uint32_t mbedtls_ssl_get_verify_result(const mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00003098{
Gilles Peskine449bd832023-01-11 14:50:10 +01003099 if (ssl->session != NULL) {
3100 return ssl->session->verify_result;
3101 }
Manuel Pégourié-Gonnarde89163c2015-01-23 14:30:57 +00003102
Gilles Peskine449bd832023-01-11 14:50:10 +01003103 if (ssl->session_negotiate != NULL) {
3104 return ssl->session_negotiate->verify_result;
3105 }
Manuel Pégourié-Gonnarde89163c2015-01-23 14:30:57 +00003106
Gilles Peskine449bd832023-01-11 14:50:10 +01003107 return 0xFFFFFFFF;
Paul Bakker5121ce52009-01-03 21:22:43 +00003108}
3109
Gilles Peskine449bd832023-01-11 14:50:10 +01003110int mbedtls_ssl_get_ciphersuite_id_from_ssl(const mbedtls_ssl_context *ssl)
Glenn Strauss8f526902022-01-13 00:04:49 -05003111{
Gilles Peskine449bd832023-01-11 14:50:10 +01003112 if (ssl == NULL || ssl->session == NULL) {
3113 return 0;
3114 }
Glenn Strauss8f526902022-01-13 00:04:49 -05003115
Gilles Peskine449bd832023-01-11 14:50:10 +01003116 return ssl->session->ciphersuite;
Glenn Strauss8f526902022-01-13 00:04:49 -05003117}
3118
Gilles Peskine449bd832023-01-11 14:50:10 +01003119const char *mbedtls_ssl_get_ciphersuite(const mbedtls_ssl_context *ssl)
Paul Bakker72f62662011-01-16 21:27:44 +00003120{
Gilles Peskine449bd832023-01-11 14:50:10 +01003121 if (ssl == NULL || ssl->session == NULL) {
3122 return NULL;
3123 }
Paul Bakker926c8e42013-03-06 10:23:34 +01003124
Gilles Peskine449bd832023-01-11 14:50:10 +01003125 return mbedtls_ssl_get_ciphersuite_name(ssl->session->ciphersuite);
Paul Bakker72f62662011-01-16 21:27:44 +00003126}
3127
Gilles Peskine449bd832023-01-11 14:50:10 +01003128const char *mbedtls_ssl_get_version(const mbedtls_ssl_context *ssl)
Paul Bakker43ca69c2011-01-15 17:35:19 +00003129{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003130#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003131 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
3132 switch (ssl->tls_version) {
Glenn Strauss60bfe602022-03-14 19:04:24 -04003133 case MBEDTLS_SSL_VERSION_TLS1_2:
Gilles Peskine449bd832023-01-11 14:50:10 +01003134 return "DTLSv1.2";
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01003135 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01003136 return "unknown (DTLS)";
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01003137 }
3138 }
3139#endif
3140
Gilles Peskine449bd832023-01-11 14:50:10 +01003141 switch (ssl->tls_version) {
Glenn Strauss60bfe602022-03-14 19:04:24 -04003142 case MBEDTLS_SSL_VERSION_TLS1_2:
Gilles Peskine449bd832023-01-11 14:50:10 +01003143 return "TLSv1.2";
Glenn Strauss60bfe602022-03-14 19:04:24 -04003144 case MBEDTLS_SSL_VERSION_TLS1_3:
Gilles Peskine449bd832023-01-11 14:50:10 +01003145 return "TLSv1.3";
Paul Bakker43ca69c2011-01-15 17:35:19 +00003146 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01003147 return "unknown";
Paul Bakker43ca69c2011-01-15 17:35:19 +00003148 }
Paul Bakker43ca69c2011-01-15 17:35:19 +00003149}
3150
Waleed Elmelegy6a971fd2023-12-28 17:48:16 +00003151#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
3152
3153size_t mbedtls_ssl_get_output_record_size_limit(const mbedtls_ssl_context *ssl)
3154{
3155 const size_t max_len = MBEDTLS_SSL_OUT_CONTENT_LEN;
3156 size_t record_size_limit = max_len;
3157
3158 if (ssl->session != NULL &&
3159 ssl->session->record_size_limit >= MBEDTLS_SSL_RECORD_SIZE_LIMIT_MIN &&
3160 ssl->session->record_size_limit < max_len) {
3161 record_size_limit = ssl->session->record_size_limit;
3162 }
3163
3164 // TODO: this is currently untested
3165 /* During a handshake, use the value being negotiated */
3166 if (ssl->session_negotiate != NULL &&
3167 ssl->session_negotiate->record_size_limit >= MBEDTLS_SSL_RECORD_SIZE_LIMIT_MIN &&
3168 ssl->session_negotiate->record_size_limit < max_len) {
3169 record_size_limit = ssl->session_negotiate->record_size_limit;
3170 }
3171
3172 return record_size_limit;
3173}
3174#endif /* MBEDTLS_SSL_RECORD_SIZE_LIMIT */
3175
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02003176#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01003177size_t mbedtls_ssl_get_input_max_frag_len(const mbedtls_ssl_context *ssl)
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003178{
David Horstmann95d516f2021-05-04 18:36:56 +01003179 size_t max_len = MBEDTLS_SSL_IN_CONTENT_LEN;
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003180 size_t read_mfl;
3181
Jerry Yuddda0502022-12-01 19:43:12 +08003182#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003183 /* Use the configured MFL for the client if we're past SERVER_HELLO_DONE */
Gilles Peskine449bd832023-01-11 14:50:10 +01003184 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
3185 ssl->state >= MBEDTLS_SSL_SERVER_HELLO_DONE) {
3186 return ssl_mfl_code_to_length(ssl->conf->mfl_code);
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003187 }
Jerry Yuddda0502022-12-01 19:43:12 +08003188#endif
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003189
3190 /* Check if a smaller max length was negotiated */
Gilles Peskine449bd832023-01-11 14:50:10 +01003191 if (ssl->session_out != NULL) {
3192 read_mfl = ssl_mfl_code_to_length(ssl->session_out->mfl_code);
3193 if (read_mfl < max_len) {
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003194 max_len = read_mfl;
3195 }
3196 }
3197
Jerry Yuddda0502022-12-01 19:43:12 +08003198 /* During a handshake, use the value being negotiated */
Gilles Peskine449bd832023-01-11 14:50:10 +01003199 if (ssl->session_negotiate != NULL) {
3200 read_mfl = ssl_mfl_code_to_length(ssl->session_negotiate->mfl_code);
3201 if (read_mfl < max_len) {
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003202 max_len = read_mfl;
3203 }
3204 }
3205
Gilles Peskine449bd832023-01-11 14:50:10 +01003206 return max_len;
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003207}
3208
Gilles Peskine449bd832023-01-11 14:50:10 +01003209size_t mbedtls_ssl_get_output_max_frag_len(const mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02003210{
3211 size_t max_len;
3212
3213 /*
3214 * Assume mfl_code is correct since it was checked when set
3215 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003216 max_len = ssl_mfl_code_to_length(ssl->conf->mfl_code);
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02003217
Manuel Pégourié-Gonnard2cb17e22017-09-19 13:00:47 +02003218 /* Check if a smaller max length was negotiated */
Gilles Peskine449bd832023-01-11 14:50:10 +01003219 if (ssl->session_out != NULL &&
3220 ssl_mfl_code_to_length(ssl->session_out->mfl_code) < max_len) {
3221 max_len = ssl_mfl_code_to_length(ssl->session_out->mfl_code);
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02003222 }
3223
Manuel Pégourié-Gonnard2cb17e22017-09-19 13:00:47 +02003224 /* During a handshake, use the value being negotiated */
Gilles Peskine449bd832023-01-11 14:50:10 +01003225 if (ssl->session_negotiate != NULL &&
3226 ssl_mfl_code_to_length(ssl->session_negotiate->mfl_code) < max_len) {
3227 max_len = ssl_mfl_code_to_length(ssl->session_negotiate->mfl_code);
Manuel Pégourié-Gonnard2cb17e22017-09-19 13:00:47 +02003228 }
3229
Gilles Peskine449bd832023-01-11 14:50:10 +01003230 return max_len;
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02003231}
3232#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
3233
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003234#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003235size_t mbedtls_ssl_get_current_mtu(const mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003236{
Andrzej Kurekef43ce62018-10-09 08:24:12 -04003237 /* Return unlimited mtu for client hello messages to avoid fragmentation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01003238 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
3239 (ssl->state == MBEDTLS_SSL_CLIENT_HELLO ||
3240 ssl->state == MBEDTLS_SSL_SERVER_HELLO)) {
3241 return 0;
3242 }
Andrzej Kurekef43ce62018-10-09 08:24:12 -04003243
Gilles Peskine449bd832023-01-11 14:50:10 +01003244 if (ssl->handshake == NULL || ssl->handshake->mtu == 0) {
3245 return ssl->mtu;
3246 }
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003247
Gilles Peskine449bd832023-01-11 14:50:10 +01003248 if (ssl->mtu == 0) {
3249 return ssl->handshake->mtu;
3250 }
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003251
Gilles Peskine449bd832023-01-11 14:50:10 +01003252 return ssl->mtu < ssl->handshake->mtu ?
3253 ssl->mtu : ssl->handshake->mtu;
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003254}
3255#endif /* MBEDTLS_SSL_PROTO_DTLS */
3256
Gilles Peskine449bd832023-01-11 14:50:10 +01003257int mbedtls_ssl_get_max_out_record_payload(const mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003258{
3259 size_t max_len = MBEDTLS_SSL_OUT_CONTENT_LEN;
3260
Manuel Pégourié-Gonnard000281e2018-08-21 11:20:58 +02003261#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH) && \
Jan Brucknerf482dcc2023-03-15 09:09:06 +01003262 !defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT) && \
Manuel Pégourié-Gonnard000281e2018-08-21 11:20:58 +02003263 !defined(MBEDTLS_SSL_PROTO_DTLS)
3264 (void) ssl;
3265#endif
3266
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003267#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01003268 const size_t mfl = mbedtls_ssl_get_output_max_frag_len(ssl);
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003269
Gilles Peskine449bd832023-01-11 14:50:10 +01003270 if (max_len > mfl) {
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003271 max_len = mfl;
Gilles Peskine449bd832023-01-11 14:50:10 +01003272 }
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003273#endif
3274
Jan Brucknerf482dcc2023-03-15 09:09:06 +01003275#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
3276 const size_t record_size_limit = mbedtls_ssl_get_output_record_size_limit(ssl);
3277
3278 if (max_len > record_size_limit) {
3279 max_len = record_size_limit;
3280 }
3281#endif
3282
Waleed Elmelegy6a971fd2023-12-28 17:48:16 +00003283 if (ssl->transform_out != NULL &&
3284 ssl->transform_out->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Waleed Elmelegyf5017902024-01-09 14:18:34 +00003285 /*
3286 * In TLS 1.3 case, when records are protected, `max_len` as computed
3287 * above is the maximum length of the TLSInnerPlaintext structure that
3288 * along the plaintext payload contains the inner content type (one byte)
3289 * and some zero padding. Given the algorithm used for padding
3290 * in mbedtls_ssl_encrypt_buf(), compute the maximum length for
3291 * the plaintext payload. Round down to a multiple of
3292 * MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY and
3293 * subtract 1.
Waleed Elmelegy6a971fd2023-12-28 17:48:16 +00003294 */
3295 max_len = ((max_len / MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY) *
3296 MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY) - 1;
3297 }
3298
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003299#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003300 if (mbedtls_ssl_get_current_mtu(ssl) != 0) {
3301 const size_t mtu = mbedtls_ssl_get_current_mtu(ssl);
3302 const int ret = mbedtls_ssl_get_record_expansion(ssl);
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003303 const size_t overhead = (size_t) ret;
3304
Gilles Peskine449bd832023-01-11 14:50:10 +01003305 if (ret < 0) {
3306 return ret;
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003307 }
3308
Gilles Peskine449bd832023-01-11 14:50:10 +01003309 if (mtu <= overhead) {
3310 MBEDTLS_SSL_DEBUG_MSG(1, ("MTU too low for record expansion"));
3311 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
3312 }
3313
3314 if (max_len > mtu - overhead) {
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003315 max_len = mtu - overhead;
Gilles Peskine449bd832023-01-11 14:50:10 +01003316 }
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003317 }
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003318#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003319
Hanno Becker0defedb2018-08-10 12:35:02 +01003320#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH) && \
Waleed Elmelegy049cd302023-12-20 17:28:31 +00003321 !defined(MBEDTLS_SSL_PROTO_DTLS) && \
3322 !defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
Hanno Becker0defedb2018-08-10 12:35:02 +01003323 ((void) ssl);
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003324#endif
3325
Gilles Peskine449bd832023-01-11 14:50:10 +01003326 return (int) max_len;
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003327}
3328
Gilles Peskine449bd832023-01-11 14:50:10 +01003329int mbedtls_ssl_get_max_in_record_payload(const mbedtls_ssl_context *ssl)
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003330{
3331 size_t max_len = MBEDTLS_SSL_IN_CONTENT_LEN;
3332
3333#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
3334 (void) ssl;
3335#endif
3336
3337#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01003338 const size_t mfl = mbedtls_ssl_get_input_max_frag_len(ssl);
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003339
Gilles Peskine449bd832023-01-11 14:50:10 +01003340 if (max_len > mfl) {
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003341 max_len = mfl;
Gilles Peskine449bd832023-01-11 14:50:10 +01003342 }
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003343#endif
3344
Gilles Peskine449bd832023-01-11 14:50:10 +01003345 return (int) max_len;
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003346}
3347
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003348#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01003349const mbedtls_x509_crt *mbedtls_ssl_get_peer_cert(const mbedtls_ssl_context *ssl)
Paul Bakkerb0550d92012-10-30 07:51:03 +00003350{
Gilles Peskine449bd832023-01-11 14:50:10 +01003351 if (ssl == NULL || ssl->session == NULL) {
3352 return NULL;
3353 }
Paul Bakkerb0550d92012-10-30 07:51:03 +00003354
Hanno Beckere6824572019-02-07 13:18:46 +00003355#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01003356 return ssl->session->peer_cert;
Hanno Beckere6824572019-02-07 13:18:46 +00003357#else
Gilles Peskine449bd832023-01-11 14:50:10 +01003358 return NULL;
Hanno Beckere6824572019-02-07 13:18:46 +00003359#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Paul Bakkerb0550d92012-10-30 07:51:03 +00003360}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003361#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkerb0550d92012-10-30 07:51:03 +00003362
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003363#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01003364int mbedtls_ssl_get_session(const mbedtls_ssl_context *ssl,
3365 mbedtls_ssl_session *dst)
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003366{
Hanno Beckere810bbc2021-05-14 16:01:05 +01003367 int ret;
3368
Gilles Peskine449bd832023-01-11 14:50:10 +01003369 if (ssl == NULL ||
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003370 dst == NULL ||
3371 ssl->session == NULL ||
Gilles Peskine449bd832023-01-11 14:50:10 +01003372 ssl->conf->endpoint != MBEDTLS_SSL_IS_CLIENT) {
3373 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003374 }
3375
Hanno Beckere810bbc2021-05-14 16:01:05 +01003376 /* Since Mbed TLS 3.0, mbedtls_ssl_get_session() is no longer
3377 * idempotent: Each session can only be exported once.
3378 *
3379 * (This is in preparation for TLS 1.3 support where we will
3380 * need the ability to export multiple sessions (aka tickets),
3381 * which will be achieved by calling mbedtls_ssl_get_session()
3382 * multiple times until it fails.)
3383 *
3384 * Check whether we have already exported the current session,
3385 * and fail if so.
3386 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003387 if (ssl->session->exported == 1) {
3388 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
3389 }
Hanno Beckere810bbc2021-05-14 16:01:05 +01003390
Gilles Peskine449bd832023-01-11 14:50:10 +01003391 ret = mbedtls_ssl_session_copy(dst, ssl->session);
3392 if (ret != 0) {
3393 return ret;
3394 }
Hanno Beckere810bbc2021-05-14 16:01:05 +01003395
3396 /* Remember that we've exported the session. */
3397 ssl->session->exported = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01003398 return 0;
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003399}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003400#endif /* MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003401
David Horstmanncb01b362024-02-29 17:31:46 +00003402#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
3403
3404/* Serialization of TLS 1.2 sessions
David Horstmanne59f9702024-02-29 16:08:57 +00003405 *
David Horstmanncb01b362024-02-29 17:31:46 +00003406 * For more detail, see the description of ssl_session_save().
David Horstmanne59f9702024-02-29 16:08:57 +00003407 */
3408static size_t ssl_tls12_session_save(const mbedtls_ssl_session *session,
3409 unsigned char *buf,
3410 size_t buf_len)
3411{
3412 unsigned char *p = buf;
3413 size_t used = 0;
3414
3415#if defined(MBEDTLS_HAVE_TIME)
3416 uint64_t start;
3417#endif
3418#if defined(MBEDTLS_X509_CRT_PARSE_C)
3419#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
3420 size_t cert_len;
3421#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3422#endif /* MBEDTLS_X509_CRT_PARSE_C */
3423
3424 /*
3425 * Time
3426 */
3427#if defined(MBEDTLS_HAVE_TIME)
3428 used += 8;
3429
3430 if (used <= buf_len) {
3431 start = (uint64_t) session->start;
3432
3433 MBEDTLS_PUT_UINT64_BE(start, p, 0);
3434 p += 8;
3435 }
3436#endif /* MBEDTLS_HAVE_TIME */
3437
3438 /*
3439 * Basic mandatory fields
3440 */
3441 used += 1 /* id_len */
3442 + sizeof(session->id)
3443 + sizeof(session->master)
3444 + 4; /* verify_result */
3445
3446 if (used <= buf_len) {
3447 *p++ = MBEDTLS_BYTE_0(session->id_len);
3448 memcpy(p, session->id, 32);
3449 p += 32;
3450
3451 memcpy(p, session->master, 48);
3452 p += 48;
3453
3454 MBEDTLS_PUT_UINT32_BE(session->verify_result, p, 0);
3455 p += 4;
3456 }
3457
3458 /*
3459 * Peer's end-entity certificate
3460 */
3461#if defined(MBEDTLS_X509_CRT_PARSE_C)
3462#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
3463 if (session->peer_cert == NULL) {
3464 cert_len = 0;
3465 } else {
3466 cert_len = session->peer_cert->raw.len;
3467 }
3468
3469 used += 3 + cert_len;
3470
3471 if (used <= buf_len) {
3472 *p++ = MBEDTLS_BYTE_2(cert_len);
3473 *p++ = MBEDTLS_BYTE_1(cert_len);
3474 *p++ = MBEDTLS_BYTE_0(cert_len);
3475
3476 if (session->peer_cert != NULL) {
3477 memcpy(p, session->peer_cert->raw.p, cert_len);
3478 p += cert_len;
3479 }
3480 }
3481#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3482 if (session->peer_cert_digest != NULL) {
3483 used += 1 /* type */ + 1 /* length */ + session->peer_cert_digest_len;
3484 if (used <= buf_len) {
3485 *p++ = (unsigned char) session->peer_cert_digest_type;
3486 *p++ = (unsigned char) session->peer_cert_digest_len;
3487 memcpy(p, session->peer_cert_digest,
3488 session->peer_cert_digest_len);
3489 p += session->peer_cert_digest_len;
3490 }
3491 } else {
3492 used += 2;
3493 if (used <= buf_len) {
3494 *p++ = (unsigned char) MBEDTLS_MD_NONE;
3495 *p++ = 0;
3496 }
3497 }
3498#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3499#endif /* MBEDTLS_X509_CRT_PARSE_C */
3500
3501 /*
3502 * Session ticket if any, plus associated data
3503 */
3504#if defined(MBEDTLS_SSL_SESSION_TICKETS)
3505#if defined(MBEDTLS_SSL_CLI_C)
3506 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
3507 used += 3 + session->ticket_len + 4; /* len + ticket + lifetime */
3508
3509 if (used <= buf_len) {
3510 *p++ = MBEDTLS_BYTE_2(session->ticket_len);
3511 *p++ = MBEDTLS_BYTE_1(session->ticket_len);
3512 *p++ = MBEDTLS_BYTE_0(session->ticket_len);
3513
3514 if (session->ticket != NULL) {
3515 memcpy(p, session->ticket, session->ticket_len);
3516 p += session->ticket_len;
3517 }
3518
3519 MBEDTLS_PUT_UINT32_BE(session->ticket_lifetime, p, 0);
3520 p += 4;
3521 }
3522 }
3523#endif /* MBEDTLS_SSL_CLI_C */
3524#if defined(MBEDTLS_HAVE_TIME) && defined(MBEDTLS_SSL_SRV_C)
3525 if (session->endpoint == MBEDTLS_SSL_IS_SERVER) {
3526 used += 8;
3527
3528 if (used <= buf_len) {
3529 MBEDTLS_PUT_UINT64_BE((uint64_t) session->ticket_creation_time, p, 0);
3530 p += 8;
3531 }
3532 }
3533#endif /* MBEDTLS_HAVE_TIME && MBEDTLS_SSL_SRV_C */
3534#endif /* MBEDTLS_SSL_SESSION_TICKETS */
3535
3536 /*
3537 * Misc extension-related info
3538 */
3539#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
3540 used += 1;
3541
3542 if (used <= buf_len) {
3543 *p++ = session->mfl_code;
3544 }
3545#endif
3546
3547#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
3548 used += 1;
3549
3550 if (used <= buf_len) {
3551 *p++ = MBEDTLS_BYTE_0(session->encrypt_then_mac);
3552 }
3553#endif
3554
3555 return used;
3556}
3557
3558MBEDTLS_CHECK_RETURN_CRITICAL
3559static int ssl_tls12_session_load(mbedtls_ssl_session *session,
3560 const unsigned char *buf,
3561 size_t len)
3562{
3563#if defined(MBEDTLS_HAVE_TIME)
3564 uint64_t start;
3565#endif
3566#if defined(MBEDTLS_X509_CRT_PARSE_C)
3567#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
3568 size_t cert_len;
3569#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3570#endif /* MBEDTLS_X509_CRT_PARSE_C */
3571
3572 const unsigned char *p = buf;
3573 const unsigned char * const end = buf + len;
3574
3575 /*
3576 * Time
3577 */
3578#if defined(MBEDTLS_HAVE_TIME)
3579 if (8 > (size_t) (end - p)) {
3580 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3581 }
3582
3583 start = MBEDTLS_GET_UINT64_BE(p, 0);
3584 p += 8;
3585
3586 session->start = (time_t) start;
3587#endif /* MBEDTLS_HAVE_TIME */
3588
3589 /*
3590 * Basic mandatory fields
3591 */
3592 if (1 + 32 + 48 + 4 > (size_t) (end - p)) {
3593 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3594 }
3595
3596 session->id_len = *p++;
3597 memcpy(session->id, p, 32);
3598 p += 32;
3599
3600 memcpy(session->master, p, 48);
3601 p += 48;
3602
3603 session->verify_result = MBEDTLS_GET_UINT32_BE(p, 0);
3604 p += 4;
3605
3606 /* Immediately clear invalid pointer values that have been read, in case
3607 * we exit early before we replaced them with valid ones. */
3608#if defined(MBEDTLS_X509_CRT_PARSE_C)
3609#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
3610 session->peer_cert = NULL;
3611#else
3612 session->peer_cert_digest = NULL;
3613#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3614#endif /* MBEDTLS_X509_CRT_PARSE_C */
3615#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
3616 session->ticket = NULL;
3617#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
3618
3619 /*
3620 * Peer certificate
3621 */
3622#if defined(MBEDTLS_X509_CRT_PARSE_C)
3623#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
3624 /* Deserialize CRT from the end of the ticket. */
3625 if (3 > (size_t) (end - p)) {
3626 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3627 }
3628
3629 cert_len = MBEDTLS_GET_UINT24_BE(p, 0);
3630 p += 3;
3631
3632 if (cert_len != 0) {
3633 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
3634
3635 if (cert_len > (size_t) (end - p)) {
3636 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3637 }
3638
3639 session->peer_cert = mbedtls_calloc(1, sizeof(mbedtls_x509_crt));
3640
3641 if (session->peer_cert == NULL) {
3642 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
3643 }
3644
3645 mbedtls_x509_crt_init(session->peer_cert);
3646
3647 if ((ret = mbedtls_x509_crt_parse_der(session->peer_cert,
3648 p, cert_len)) != 0) {
3649 mbedtls_x509_crt_free(session->peer_cert);
3650 mbedtls_free(session->peer_cert);
3651 session->peer_cert = NULL;
3652 return ret;
3653 }
3654
3655 p += cert_len;
3656 }
3657#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3658 /* Deserialize CRT digest from the end of the ticket. */
3659 if (2 > (size_t) (end - p)) {
3660 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3661 }
3662
3663 session->peer_cert_digest_type = (mbedtls_md_type_t) *p++;
3664 session->peer_cert_digest_len = (size_t) *p++;
3665
3666 if (session->peer_cert_digest_len != 0) {
3667 const mbedtls_md_info_t *md_info =
3668 mbedtls_md_info_from_type(session->peer_cert_digest_type);
3669 if (md_info == NULL) {
3670 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3671 }
3672 if (session->peer_cert_digest_len != mbedtls_md_get_size(md_info)) {
3673 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3674 }
3675
3676 if (session->peer_cert_digest_len > (size_t) (end - p)) {
3677 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3678 }
3679
3680 session->peer_cert_digest =
3681 mbedtls_calloc(1, session->peer_cert_digest_len);
3682 if (session->peer_cert_digest == NULL) {
3683 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
3684 }
3685
3686 memcpy(session->peer_cert_digest, p,
3687 session->peer_cert_digest_len);
3688 p += session->peer_cert_digest_len;
3689 }
3690#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3691#endif /* MBEDTLS_X509_CRT_PARSE_C */
3692
3693 /*
3694 * Session ticket and associated data
3695 */
3696#if defined(MBEDTLS_SSL_SESSION_TICKETS)
3697#if defined(MBEDTLS_SSL_CLI_C)
3698 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
3699 if (3 > (size_t) (end - p)) {
3700 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3701 }
3702
3703 session->ticket_len = MBEDTLS_GET_UINT24_BE(p, 0);
3704 p += 3;
3705
3706 if (session->ticket_len != 0) {
3707 if (session->ticket_len > (size_t) (end - p)) {
3708 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3709 }
3710
3711 session->ticket = mbedtls_calloc(1, session->ticket_len);
3712 if (session->ticket == NULL) {
3713 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
3714 }
3715
3716 memcpy(session->ticket, p, session->ticket_len);
3717 p += session->ticket_len;
3718 }
3719
3720 if (4 > (size_t) (end - p)) {
3721 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3722 }
3723
3724 session->ticket_lifetime = MBEDTLS_GET_UINT32_BE(p, 0);
3725 p += 4;
3726 }
3727#endif /* MBEDTLS_SSL_CLI_C */
3728#if defined(MBEDTLS_HAVE_TIME) && defined(MBEDTLS_SSL_SRV_C)
3729 if (session->endpoint == MBEDTLS_SSL_IS_SERVER) {
3730 if (8 > (size_t) (end - p)) {
3731 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3732 }
3733 session->ticket_creation_time = MBEDTLS_GET_UINT64_BE(p, 0);
3734 p += 8;
3735 }
3736#endif /* MBEDTLS_HAVE_TIME && MBEDTLS_SSL_SRV_C */
3737#endif /* MBEDTLS_SSL_SESSION_TICKETS */
3738
3739 /*
3740 * Misc extension-related info
3741 */
3742#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
3743 if (1 > (size_t) (end - p)) {
3744 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3745 }
3746
3747 session->mfl_code = *p++;
3748#endif
3749
3750#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
3751 if (1 > (size_t) (end - p)) {
3752 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3753 }
3754
3755 session->encrypt_then_mac = *p++;
3756#endif
3757
3758 /* Done, should have consumed entire buffer */
3759 if (p != end) {
3760 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3761 }
3762
3763 return 0;
3764}
3765
3766#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
3767
3768#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
3769/* Serialization of TLS 1.3 sessions:
3770 *
David Horstmanncb01b362024-02-29 17:31:46 +00003771 * For more detail, see the description of ssl_session_save().
David Horstmanne59f9702024-02-29 16:08:57 +00003772 */
3773#if defined(MBEDTLS_SSL_SESSION_TICKETS)
3774MBEDTLS_CHECK_RETURN_CRITICAL
3775static int ssl_tls13_session_save(const mbedtls_ssl_session *session,
3776 unsigned char *buf,
3777 size_t buf_len,
3778 size_t *olen)
3779{
3780 unsigned char *p = buf;
3781#if defined(MBEDTLS_SSL_CLI_C) && \
3782 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
3783 size_t hostname_len = (session->hostname == NULL) ?
3784 0 : strlen(session->hostname) + 1;
3785#endif
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003786
3787#if defined(MBEDTLS_SSL_SRV_C) && \
3788 defined(MBEDTLS_SSL_EARLY_DATA) && defined(MBEDTLS_SSL_ALPN)
Waleed Elmelegydaa4da72024-03-13 16:25:34 +00003789 const size_t alpn_len = (session->ticket_alpn == NULL) ?
Waleed Elmelegyb28ab0a2024-03-13 16:48:28 +00003790 0 : strlen(session->ticket_alpn) + 1;
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003791#endif
David Horstmanne59f9702024-02-29 16:08:57 +00003792 size_t needed = 4 /* ticket_age_add */
3793 + 1 /* ticket_flags */
3794 + 1; /* resumption_key length */
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003795
David Horstmanne59f9702024-02-29 16:08:57 +00003796 *olen = 0;
3797
3798 if (session->resumption_key_len > MBEDTLS_SSL_TLS1_3_TICKET_RESUMPTION_KEY_LEN) {
3799 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3800 }
3801 needed += session->resumption_key_len; /* resumption_key */
3802
3803#if defined(MBEDTLS_SSL_EARLY_DATA)
3804 needed += 4; /* max_early_data_size */
3805#endif
3806#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
3807 needed += 2; /* record_size_limit */
3808#endif /* MBEDTLS_SSL_RECORD_SIZE_LIMIT */
3809
3810#if defined(MBEDTLS_HAVE_TIME)
3811 needed += 8; /* ticket_creation_time or ticket_reception_time */
3812#endif
3813
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003814#if defined(MBEDTLS_SSL_SRV_C)
3815 if (session->endpoint == MBEDTLS_SSL_IS_SERVER) {
3816#if defined(MBEDTLS_SSL_EARLY_DATA) && defined(MBEDTLS_SSL_ALPN)
Waleed Elmelegydaa4da72024-03-13 16:25:34 +00003817 needed += 2 /* alpn_len */
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003818 + alpn_len; /* alpn */
3819#endif
3820 }
3821#endif /* MBEDTLS_SSL_SRV_C */
3822
David Horstmanne59f9702024-02-29 16:08:57 +00003823#if defined(MBEDTLS_SSL_CLI_C)
3824 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
3825#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
3826 needed += 2 /* hostname_len */
3827 + hostname_len; /* hostname */
3828#endif
3829
3830 needed += 4 /* ticket_lifetime */
3831 + 2; /* ticket_len */
3832
3833 /* Check size_t overflow */
3834 if (session->ticket_len > SIZE_MAX - needed) {
3835 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3836 }
3837
3838 needed += session->ticket_len; /* ticket */
3839 }
3840#endif /* MBEDTLS_SSL_CLI_C */
3841
3842 *olen = needed;
3843 if (needed > buf_len) {
3844 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
3845 }
3846
3847 MBEDTLS_PUT_UINT32_BE(session->ticket_age_add, p, 0);
3848 p[4] = session->ticket_flags;
3849
3850 /* save resumption_key */
3851 p[5] = session->resumption_key_len;
3852 p += 6;
3853 memcpy(p, session->resumption_key, session->resumption_key_len);
3854 p += session->resumption_key_len;
3855
3856#if defined(MBEDTLS_SSL_EARLY_DATA)
3857 MBEDTLS_PUT_UINT32_BE(session->max_early_data_size, p, 0);
3858 p += 4;
3859#endif
3860#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
3861 MBEDTLS_PUT_UINT16_BE(session->record_size_limit, p, 0);
3862 p += 2;
3863#endif /* MBEDTLS_SSL_RECORD_SIZE_LIMIT */
3864
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003865#if defined(MBEDTLS_SSL_SRV_C)
David Horstmanne59f9702024-02-29 16:08:57 +00003866 if (session->endpoint == MBEDTLS_SSL_IS_SERVER) {
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003867#if defined(MBEDTLS_HAVE_TIME)
David Horstmanne59f9702024-02-29 16:08:57 +00003868 MBEDTLS_PUT_UINT64_BE((uint64_t) session->ticket_creation_time, p, 0);
3869 p += 8;
David Horstmanne59f9702024-02-29 16:08:57 +00003870#endif /* MBEDTLS_HAVE_TIME */
3871
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003872#if defined(MBEDTLS_SSL_EARLY_DATA) && defined(MBEDTLS_SSL_ALPN)
Waleed Elmelegydaa4da72024-03-13 16:25:34 +00003873 MBEDTLS_PUT_UINT16_BE(alpn_len, p, 0);
3874 p += 2;
3875
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003876 if (alpn_len > 0) {
3877 /* save chosen alpn */
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00003878 memcpy(p, session->ticket_alpn, alpn_len);
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003879 p += alpn_len;
3880 }
3881#endif /* MBEDTLS_SSL_EARLY_DATA && MBEDTLS_SSL_ALPN */
3882 }
3883#endif /* MBEDTLS_SSL_SRV_C */
3884
David Horstmanne59f9702024-02-29 16:08:57 +00003885#if defined(MBEDTLS_SSL_CLI_C)
3886 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
3887#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
3888 MBEDTLS_PUT_UINT16_BE(hostname_len, p, 0);
3889 p += 2;
3890 if (hostname_len > 0) {
3891 /* save host name */
3892 memcpy(p, session->hostname, hostname_len);
3893 p += hostname_len;
3894 }
3895#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
3896
3897#if defined(MBEDTLS_HAVE_TIME)
3898 MBEDTLS_PUT_UINT64_BE((uint64_t) session->ticket_reception_time, p, 0);
3899 p += 8;
3900#endif
3901 MBEDTLS_PUT_UINT32_BE(session->ticket_lifetime, p, 0);
3902 p += 4;
3903
3904 MBEDTLS_PUT_UINT16_BE(session->ticket_len, p, 0);
3905 p += 2;
3906
3907 if (session->ticket != NULL && session->ticket_len > 0) {
3908 memcpy(p, session->ticket, session->ticket_len);
3909 p += session->ticket_len;
3910 }
3911 }
3912#endif /* MBEDTLS_SSL_CLI_C */
3913 return 0;
3914}
3915
3916MBEDTLS_CHECK_RETURN_CRITICAL
3917static int ssl_tls13_session_load(mbedtls_ssl_session *session,
3918 const unsigned char *buf,
3919 size_t len)
3920{
3921 const unsigned char *p = buf;
3922 const unsigned char *end = buf + len;
3923
3924 if (end - p < 6) {
3925 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3926 }
3927 session->ticket_age_add = MBEDTLS_GET_UINT32_BE(p, 0);
3928 session->ticket_flags = p[4];
3929
3930 /* load resumption_key */
3931 session->resumption_key_len = p[5];
3932 p += 6;
3933
3934 if (end - p < session->resumption_key_len) {
3935 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3936 }
3937
3938 if (sizeof(session->resumption_key) < session->resumption_key_len) {
3939 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3940 }
3941 memcpy(session->resumption_key, p, session->resumption_key_len);
3942 p += session->resumption_key_len;
3943
3944#if defined(MBEDTLS_SSL_EARLY_DATA)
3945 if (end - p < 4) {
3946 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3947 }
3948 session->max_early_data_size = MBEDTLS_GET_UINT32_BE(p, 0);
3949 p += 4;
3950#endif
3951#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
3952 if (end - p < 2) {
3953 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3954 }
3955 session->record_size_limit = MBEDTLS_GET_UINT16_BE(p, 0);
3956 p += 2;
3957#endif /* MBEDTLS_SSL_RECORD_SIZE_LIMIT */
3958
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003959#if defined(MBEDTLS_SSL_SRV_C)
David Horstmanne59f9702024-02-29 16:08:57 +00003960 if (session->endpoint == MBEDTLS_SSL_IS_SERVER) {
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003961#if defined(MBEDTLS_HAVE_TIME)
David Horstmanne59f9702024-02-29 16:08:57 +00003962 if (end - p < 8) {
3963 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3964 }
3965 session->ticket_creation_time = MBEDTLS_GET_UINT64_BE(p, 0);
3966 p += 8;
David Horstmanne59f9702024-02-29 16:08:57 +00003967#endif /* MBEDTLS_HAVE_TIME */
3968
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003969#if defined(MBEDTLS_SSL_EARLY_DATA) && defined(MBEDTLS_SSL_ALPN)
Waleed Elmelegydaa4da72024-03-13 16:25:34 +00003970 size_t alpn_len;
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003971
Waleed Elmelegydaa4da72024-03-13 16:25:34 +00003972 if (end - p < 2) {
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003973 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3974 }
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00003975
Waleed Elmelegydaa4da72024-03-13 16:25:34 +00003976 alpn_len = MBEDTLS_GET_UINT16_BE(p, 0);
3977 p += 2;
3978
3979 if (end - p < (long int) alpn_len) {
Waleed Elmelegy7dfba342024-03-12 16:22:39 +00003980 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3981 }
3982
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003983 if (alpn_len > 0) {
Waleed Elmelegydaa4da72024-03-13 16:25:34 +00003984 int ret = mbedtls_ssl_session_set_ticket_alpn(session, (char *) p);
3985 if (ret != 0) {
3986 return ret;
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003987 }
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003988 p += alpn_len;
3989 }
3990#endif /* MBEDTLS_SSL_EARLY_DATA && MBEDTLS_SSL_ALPN */
3991 }
3992#endif /* MBEDTLS_SSL_SRV_C */
3993
David Horstmanne59f9702024-02-29 16:08:57 +00003994#if defined(MBEDTLS_SSL_CLI_C)
3995 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
3996#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
3997 size_t hostname_len;
3998 /* load host name */
3999 if (end - p < 2) {
4000 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4001 }
4002 hostname_len = MBEDTLS_GET_UINT16_BE(p, 0);
4003 p += 2;
4004
4005 if (end - p < (long int) hostname_len) {
4006 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4007 }
4008 if (hostname_len > 0) {
4009 session->hostname = mbedtls_calloc(1, hostname_len);
4010 if (session->hostname == NULL) {
4011 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
4012 }
4013 memcpy(session->hostname, p, hostname_len);
4014 p += hostname_len;
4015 }
4016#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
4017
4018#if defined(MBEDTLS_HAVE_TIME)
4019 if (end - p < 8) {
4020 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4021 }
4022 session->ticket_reception_time = MBEDTLS_GET_UINT64_BE(p, 0);
4023 p += 8;
4024#endif
4025 if (end - p < 4) {
4026 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4027 }
4028 session->ticket_lifetime = MBEDTLS_GET_UINT32_BE(p, 0);
4029 p += 4;
4030
4031 if (end - p < 2) {
4032 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4033 }
4034 session->ticket_len = MBEDTLS_GET_UINT16_BE(p, 0);
4035 p += 2;
4036
4037 if (end - p < (long int) session->ticket_len) {
4038 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4039 }
4040 if (session->ticket_len > 0) {
4041 session->ticket = mbedtls_calloc(1, session->ticket_len);
4042 if (session->ticket == NULL) {
4043 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
4044 }
4045 memcpy(session->ticket, p, session->ticket_len);
4046 p += session->ticket_len;
4047 }
4048 }
4049#endif /* MBEDTLS_SSL_CLI_C */
4050
4051 return 0;
4052
4053}
4054#else /* MBEDTLS_SSL_SESSION_TICKETS */
4055MBEDTLS_CHECK_RETURN_CRITICAL
4056static int ssl_tls13_session_save(const mbedtls_ssl_session *session,
4057 unsigned char *buf,
4058 size_t buf_len,
4059 size_t *olen)
4060{
4061 ((void) session);
4062 ((void) buf);
4063 ((void) buf_len);
4064 *olen = 0;
4065 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
4066}
4067
4068static int ssl_tls13_session_load(const mbedtls_ssl_session *session,
Norbert Fabritius93b2c322023-01-24 17:48:29 +01004069 const unsigned char *buf,
David Horstmanne59f9702024-02-29 16:08:57 +00004070 size_t buf_len)
4071{
4072 ((void) session);
4073 ((void) buf);
4074 ((void) buf_len);
4075 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
4076}
4077#endif /* !MBEDTLS_SSL_SESSION_TICKETS */
4078#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
4079
Paul Bakker5121ce52009-01-03 21:22:43 +00004080/*
Hanno Beckera835da52019-05-16 12:39:07 +01004081 * Define ticket header determining Mbed TLS version
4082 * and structure of the ticket.
4083 */
4084
Hanno Becker94ef3b32019-05-16 12:50:45 +01004085/*
Hanno Becker50b59662019-05-28 14:30:45 +01004086 * Define bitflag determining compile-time settings influencing
4087 * structure of serialized SSL sessions.
Hanno Becker94ef3b32019-05-16 12:50:45 +01004088 */
4089
Hanno Becker50b59662019-05-28 14:30:45 +01004090#if defined(MBEDTLS_HAVE_TIME)
Hanno Becker3e088662019-05-29 11:10:18 +01004091#define SSL_SERIALIZED_SESSION_CONFIG_TIME 1
Hanno Becker50b59662019-05-28 14:30:45 +01004092#else
Hanno Becker3e088662019-05-29 11:10:18 +01004093#define SSL_SERIALIZED_SESSION_CONFIG_TIME 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01004094#endif /* MBEDTLS_HAVE_TIME */
4095
4096#if defined(MBEDTLS_X509_CRT_PARSE_C)
Hanno Becker3e088662019-05-29 11:10:18 +01004097#define SSL_SERIALIZED_SESSION_CONFIG_CRT 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01004098#else
Hanno Becker3e088662019-05-29 11:10:18 +01004099#define SSL_SERIALIZED_SESSION_CONFIG_CRT 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01004100#endif /* MBEDTLS_X509_CRT_PARSE_C */
4101
David Horstmann5c5a32f2024-02-13 17:53:35 +00004102#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
David Horstmannf686f1d2024-03-01 11:20:32 +00004103#define SSL_SERIALIZED_SESSION_CONFIG_KEEP_PEER_CRT 1
David Horstmann5c5a32f2024-02-13 17:53:35 +00004104#else
David Horstmannf686f1d2024-03-01 11:20:32 +00004105#define SSL_SERIALIZED_SESSION_CONFIG_KEEP_PEER_CRT 0
David Horstmann5c5a32f2024-02-13 17:53:35 +00004106#endif /* MBEDTLS_SSL_SESSION_TICKETS */
4107
Hanno Becker94ef3b32019-05-16 12:50:45 +01004108#if defined(MBEDTLS_SSL_CLI_C) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Hanno Becker3e088662019-05-29 11:10:18 +01004109#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01004110#else
Hanno Becker3e088662019-05-29 11:10:18 +01004111#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01004112#endif /* MBEDTLS_SSL_CLI_C && MBEDTLS_SSL_SESSION_TICKETS */
4113
4114#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Hanno Becker3e088662019-05-29 11:10:18 +01004115#define SSL_SERIALIZED_SESSION_CONFIG_MFL 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01004116#else
Hanno Becker3e088662019-05-29 11:10:18 +01004117#define SSL_SERIALIZED_SESSION_CONFIG_MFL 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01004118#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
4119
Hanno Becker94ef3b32019-05-16 12:50:45 +01004120#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Hanno Becker3e088662019-05-29 11:10:18 +01004121#define SSL_SERIALIZED_SESSION_CONFIG_ETM 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01004122#else
Hanno Becker3e088662019-05-29 11:10:18 +01004123#define SSL_SERIALIZED_SESSION_CONFIG_ETM 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01004124#endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC */
4125
Hanno Becker94ef3b32019-05-16 12:50:45 +01004126#if defined(MBEDTLS_SSL_SESSION_TICKETS)
4127#define SSL_SERIALIZED_SESSION_CONFIG_TICKET 1
4128#else
4129#define SSL_SERIALIZED_SESSION_CONFIG_TICKET 0
4130#endif /* MBEDTLS_SSL_SESSION_TICKETS */
4131
David Horstmann92b258b2024-02-13 17:23:34 +00004132#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
4133#define SSL_SERIALIZED_SESSION_CONFIG_SNI 1
4134#else
4135#define SSL_SERIALIZED_SESSION_CONFIG_SNI 0
4136#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
4137
4138#if defined(MBEDTLS_SSL_EARLY_DATA)
4139#define SSL_SERIALIZED_SESSION_CONFIG_EARLY_DATA 1
4140#else
4141#define SSL_SERIALIZED_SESSION_CONFIG_EARLY_DATA 0
4142#endif /* MBEDTLS_SSL_EARLY_DATA */
4143
4144#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
4145#define SSL_SERIALIZED_SESSION_CONFIG_RECORD_SIZE 1
4146#else
4147#define SSL_SERIALIZED_SESSION_CONFIG_RECORD_SIZE 0
4148#endif /* MBEDTLS_SSL_RECORD_SIZE_LIMIT */
4149
Waleed Elmelegy7dfba342024-03-12 16:22:39 +00004150#if defined(MBEDTLS_SSL_ALPN) && defined(MBEDTLS_SSL_SRV_C) && \
4151 defined(MBEDTLS_SSL_EARLY_DATA)
Waleed Elmelegy11025632024-03-07 15:25:52 +00004152#define SSL_SERIALIZED_SESSION_CONFIG_ALPN 1
4153#else
4154#define SSL_SERIALIZED_SESSION_CONFIG_ALPN 0
4155#endif /* MBEDTLS_SSL_ALPN */
4156
Hanno Becker3e088662019-05-29 11:10:18 +01004157#define SSL_SERIALIZED_SESSION_CONFIG_TIME_BIT 0
4158#define SSL_SERIALIZED_SESSION_CONFIG_CRT_BIT 1
4159#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET_BIT 2
4160#define SSL_SERIALIZED_SESSION_CONFIG_MFL_BIT 3
Hanno Becker37bdbe62021-08-01 05:38:58 +01004161#define SSL_SERIALIZED_SESSION_CONFIG_ETM_BIT 4
4162#define SSL_SERIALIZED_SESSION_CONFIG_TICKET_BIT 5
David Horstmannf686f1d2024-03-01 11:20:32 +00004163#define SSL_SERIALIZED_SESSION_CONFIG_KEEP_PEER_CRT_BIT 6
David Horstmann92b258b2024-02-13 17:23:34 +00004164#define SSL_SERIALIZED_SESSION_CONFIG_SNI_BIT 7
4165#define SSL_SERIALIZED_SESSION_CONFIG_EARLY_DATA_BIT 8
4166#define SSL_SERIALIZED_SESSION_CONFIG_RECORD_SIZE_BIT 9
Waleed Elmelegy11025632024-03-07 15:25:52 +00004167#define SSL_SERIALIZED_SESSION_CONFIG_ALPN_BIT 10
Hanno Becker3e088662019-05-29 11:10:18 +01004168
Hanno Becker50b59662019-05-28 14:30:45 +01004169#define SSL_SERIALIZED_SESSION_CONFIG_BITFLAG \
Gilles Peskine449bd832023-01-11 14:50:10 +01004170 ((uint16_t) ( \
4171 (SSL_SERIALIZED_SESSION_CONFIG_TIME << SSL_SERIALIZED_SESSION_CONFIG_TIME_BIT) | \
4172 (SSL_SERIALIZED_SESSION_CONFIG_CRT << SSL_SERIALIZED_SESSION_CONFIG_CRT_BIT) | \
4173 (SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET << \
4174 SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET_BIT) | \
4175 (SSL_SERIALIZED_SESSION_CONFIG_MFL << SSL_SERIALIZED_SESSION_CONFIG_MFL_BIT) | \
4176 (SSL_SERIALIZED_SESSION_CONFIG_ETM << SSL_SERIALIZED_SESSION_CONFIG_ETM_BIT) | \
David Horstmann5c5a32f2024-02-13 17:53:35 +00004177 (SSL_SERIALIZED_SESSION_CONFIG_TICKET << SSL_SERIALIZED_SESSION_CONFIG_TICKET_BIT) | \
David Horstmann71fa1a92024-03-01 12:32:18 +00004178 (SSL_SERIALIZED_SESSION_CONFIG_KEEP_PEER_CRT << \
4179 SSL_SERIALIZED_SESSION_CONFIG_KEEP_PEER_CRT_BIT) | \
David Horstmann92b258b2024-02-13 17:23:34 +00004180 (SSL_SERIALIZED_SESSION_CONFIG_SNI << SSL_SERIALIZED_SESSION_CONFIG_SNI_BIT) | \
4181 (SSL_SERIALIZED_SESSION_CONFIG_EARLY_DATA << \
4182 SSL_SERIALIZED_SESSION_CONFIG_EARLY_DATA_BIT) | \
4183 (SSL_SERIALIZED_SESSION_CONFIG_RECORD_SIZE << \
Waleed Elmelegy11025632024-03-07 15:25:52 +00004184 SSL_SERIALIZED_SESSION_CONFIG_RECORD_SIZE_BIT) | \
Waleed Elmelegy75e33fa2024-03-07 16:57:58 +00004185 (SSL_SERIALIZED_SESSION_CONFIG_ALPN << \
Waleed Elmelegy11025632024-03-07 15:25:52 +00004186 SSL_SERIALIZED_SESSION_CONFIG_ALPN_BIT)))
Hanno Becker94ef3b32019-05-16 12:50:45 +01004187
Chien Wong4e9683e2023-12-28 17:07:43 +08004188static const unsigned char ssl_serialized_session_header[] = {
Hanno Becker94ef3b32019-05-16 12:50:45 +01004189 MBEDTLS_VERSION_MAJOR,
4190 MBEDTLS_VERSION_MINOR,
4191 MBEDTLS_VERSION_PATCH,
Gilles Peskine449bd832023-01-11 14:50:10 +01004192 MBEDTLS_BYTE_1(SSL_SERIALIZED_SESSION_CONFIG_BITFLAG),
4193 MBEDTLS_BYTE_0(SSL_SERIALIZED_SESSION_CONFIG_BITFLAG),
Hanno Beckerf8787072019-05-16 12:41:07 +01004194};
Hanno Beckera835da52019-05-16 12:39:07 +01004195
4196/*
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004197 * Serialize a session in the following format:
Manuel Pégourié-Gonnard35eb8022019-05-16 11:11:08 +02004198 * (in the presentation language of TLS, RFC 8446 section 3)
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004199 *
David Horstmanncb01b362024-02-29 17:31:46 +00004200 * TLS 1.2 session:
4201 *
4202 * struct {
4203 * #if defined(MBEDTLS_SSL_SESSION_TICKETS)
4204 * opaque ticket<0..2^24-1>; // length 0 means no ticket
4205 * uint32 ticket_lifetime;
4206 * #endif
4207 * } ClientOnlyData;
4208 *
4209 * struct {
4210 * #if defined(MBEDTLS_HAVE_TIME)
4211 * uint64 start_time;
4212 * #endif
4213 * uint8 session_id_len; // at most 32
4214 * opaque session_id[32];
4215 * opaque master[48]; // fixed length in the standard
4216 * uint32 verify_result;
4217 * #if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
4218 * opaque peer_cert<0..2^24-1>; // length 0 means no peer cert
4219 * #else
David Horstmann76ba26a2024-03-01 12:03:35 +00004220 * uint8 peer_cert_digest_type;
David Horstmanncb01b362024-02-29 17:31:46 +00004221 * opaque peer_cert_digest<0..2^8-1>
4222 * #endif
4223 * select (endpoint) {
4224 * case client: ClientOnlyData;
4225 * case server: uint64 ticket_creation_time;
4226 * };
4227 * #if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
4228 * uint8 mfl_code; // up to 255 according to standard
4229 * #endif
4230 * #if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
4231 * uint8 encrypt_then_mac; // 0 or 1
4232 * #endif
4233 * } serialized_session_tls12;
4234 *
4235 *
4236 * TLS 1.3 Session:
4237 *
4238 * struct {
4239 * #if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
4240 * opaque hostname<0..2^16-1>;
4241 * #endif
4242 * #if defined(MBEDTLS_HAVE_TIME)
4243 * uint64 ticket_reception_time;
4244 * #endif
4245 * uint32 ticket_lifetime;
4246 * opaque ticket<1..2^16-1>;
4247 * } ClientOnlyData;
4248 *
4249 * struct {
4250 * uint32 ticket_age_add;
4251 * uint8 ticket_flags;
4252 * opaque resumption_key<0..255>;
4253 * #if defined(MBEDTLS_SSL_EARLY_DATA)
4254 * uint32 max_early_data_size;
4255 * #endif
4256 * #if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
4257 * uint16 record_size_limit;
4258 * #endif
4259 * select ( endpoint ) {
4260 * case client: ClientOnlyData;
Waleed Elmelegy7dfba342024-03-12 16:22:39 +00004261 * case server:
David Horstmanncb01b362024-02-29 17:31:46 +00004262 * #if defined(MBEDTLS_HAVE_TIME)
Waleed Elmelegy7dfba342024-03-12 16:22:39 +00004263 * uint64 ticket_creation_time;
David Horstmanncb01b362024-02-29 17:31:46 +00004264 * #endif
Waleed Elmelegyfe9ae082024-03-07 15:47:31 +00004265 * #if defined(MBEDTLS_SSL_EARLY_DATA) && defined(MBEDTLS_SSL_ALPN)
Waleed Elmelegydaa4da72024-03-13 16:25:34 +00004266 * opaque ticket_alpn<0..256>;
David Horstmanncb01b362024-02-29 17:31:46 +00004267 * #endif
4268 * };
4269 * } serialized_session_tls13;
4270 *
4271 *
4272 * SSL session:
4273 *
4274 * struct {
Hanno Beckerdc28b6c2019-05-29 11:08:00 +01004275 *
Hanno Beckerdce50972021-08-01 05:39:23 +01004276 * opaque mbedtls_version[3]; // library version: major, minor, patch
4277 * opaque session_format[2]; // library-version specific 16-bit field
4278 * // determining the format of the remaining
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004279 * // serialized data.
Hanno Beckerdc28b6c2019-05-29 11:08:00 +01004280 *
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004281 * Note: When updating the format, remember to keep
4282 * these version+format bytes.
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004283 *
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004284 * // In this version, `session_format` determines
4285 * // the setting of those compile-time
4286 * // configuration options which influence
4287 * // the structure of mbedtls_ssl_session.
4288 *
Glenn Straussda7851c2022-03-14 13:29:48 -04004289 * uint8_t minor_ver; // Protocol minor version. Possible values:
Jerry Yu0c2a7382022-12-06 13:27:25 +08004290 * // - TLS 1.2 (0x0303)
4291 * // - TLS 1.3 (0x0304)
David Horstmann531aca22024-02-29 18:14:28 +00004292 * uint8_t endpoint;
4293 * uint16_t ciphersuite;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004294 *
Glenn Straussda7851c2022-03-14 13:29:48 -04004295 * select (serialized_session.tls_version) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004296 *
Glenn Straussda7851c2022-03-14 13:29:48 -04004297 * case MBEDTLS_SSL_VERSION_TLS1_2:
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004298 * serialized_session_tls12 data;
Jerry Yu0c2a7382022-12-06 13:27:25 +08004299 * case MBEDTLS_SSL_VERSION_TLS1_3:
Jerry Yuddda0502022-12-01 19:43:12 +08004300 * serialized_session_tls13 data;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004301 *
4302 * };
4303 *
4304 * } serialized_session;
4305 *
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004306 */
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004307
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004308MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004309static int ssl_session_save(const mbedtls_ssl_session *session,
4310 unsigned char omit_header,
4311 unsigned char *buf,
4312 size_t buf_len,
4313 size_t *olen)
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004314{
4315 unsigned char *p = buf;
4316 size_t used = 0;
Jerry Yu251a12e2022-07-13 15:15:48 +08004317 size_t remaining_len;
Jerry Yue36fdd62022-08-17 21:31:36 +08004318#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
4319 size_t out_len;
4320 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
4321#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01004322 if (session == NULL) {
4323 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
4324 }
Jerry Yu438ddd82022-07-07 06:55:50 +00004325
Gilles Peskine449bd832023-01-11 14:50:10 +01004326 if (!omit_header) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004327 /*
4328 * Add Mbed TLS version identifier
4329 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004330 used += sizeof(ssl_serialized_session_header);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004331
Gilles Peskine449bd832023-01-11 14:50:10 +01004332 if (used <= buf_len) {
4333 memcpy(p, ssl_serialized_session_header,
4334 sizeof(ssl_serialized_session_header));
4335 p += sizeof(ssl_serialized_session_header);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004336 }
4337 }
4338
4339 /*
Ronald Cron40a4ab02024-01-15 10:21:30 +01004340 * TLS version identifier, endpoint, ciphersuite
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004341 */
Ronald Cron40a4ab02024-01-15 10:21:30 +01004342 used += 1 /* TLS version */
4343 + 1 /* endpoint */
4344 + 2; /* ciphersuite */
Gilles Peskine449bd832023-01-11 14:50:10 +01004345 if (used <= buf_len) {
4346 *p++ = MBEDTLS_BYTE_0(session->tls_version);
Ronald Cron40a4ab02024-01-15 10:21:30 +01004347 *p++ = session->endpoint;
4348 MBEDTLS_PUT_UINT16_BE(session->ciphersuite, p, 0);
4349 p += 2;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004350 }
4351
4352 /* Forward to version-specific serialization routine. */
Jerry Yufca4d572022-07-21 10:37:48 +08004353 remaining_len = (buf_len >= used) ? buf_len - used : 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01004354 switch (session->tls_version) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004355#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01004356 case MBEDTLS_SSL_VERSION_TLS1_2:
4357 used += ssl_tls12_session_save(session, p, remaining_len);
4358 break;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004359#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
4360
Jerry Yu251a12e2022-07-13 15:15:48 +08004361#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004362 case MBEDTLS_SSL_VERSION_TLS1_3:
4363 ret = ssl_tls13_session_save(session, p, remaining_len, &out_len);
4364 if (ret != 0 && ret != MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL) {
4365 return ret;
4366 }
4367 used += out_len;
4368 break;
Jerry Yu251a12e2022-07-13 15:15:48 +08004369#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
4370
Gilles Peskine449bd832023-01-11 14:50:10 +01004371 default:
4372 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004373 }
4374
4375 *olen = used;
Gilles Peskine449bd832023-01-11 14:50:10 +01004376 if (used > buf_len) {
4377 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
4378 }
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004379
Gilles Peskine449bd832023-01-11 14:50:10 +01004380 return 0;
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004381}
4382
4383/*
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02004384 * Public wrapper for ssl_session_save()
4385 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004386int mbedtls_ssl_session_save(const mbedtls_ssl_session *session,
4387 unsigned char *buf,
4388 size_t buf_len,
4389 size_t *olen)
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02004390{
Gilles Peskine449bd832023-01-11 14:50:10 +01004391 return ssl_session_save(session, 0, buf, buf_len, olen);
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02004392}
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004393
Jerry Yuf1b23ca2022-02-18 11:48:47 +08004394/*
4395 * Deserialize session, see mbedtls_ssl_session_save() for format.
4396 *
4397 * This internal version is wrapped by a public function that cleans up in
4398 * case of error, and has an extra option omit_header.
4399 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004400MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004401static int ssl_session_load(mbedtls_ssl_session *session,
4402 unsigned char omit_header,
4403 const unsigned char *buf,
4404 size_t len)
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004405{
4406 const unsigned char *p = buf;
4407 const unsigned char * const end = buf + len;
Jerry Yu438ddd82022-07-07 06:55:50 +00004408 size_t remaining_len;
4409
4410
Gilles Peskine449bd832023-01-11 14:50:10 +01004411 if (session == NULL) {
4412 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
4413 }
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004414
Gilles Peskine449bd832023-01-11 14:50:10 +01004415 if (!omit_header) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004416 /*
4417 * Check Mbed TLS version identifier
4418 */
4419
Gilles Peskine449bd832023-01-11 14:50:10 +01004420 if ((size_t) (end - p) < sizeof(ssl_serialized_session_header)) {
4421 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004422 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004423
4424 if (memcmp(p, ssl_serialized_session_header,
4425 sizeof(ssl_serialized_session_header)) != 0) {
4426 return MBEDTLS_ERR_SSL_VERSION_MISMATCH;
4427 }
4428 p += sizeof(ssl_serialized_session_header);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004429 }
4430
4431 /*
Ronald Cron40a4ab02024-01-15 10:21:30 +01004432 * TLS version identifier, endpoint, ciphersuite
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004433 */
Ronald Cron40a4ab02024-01-15 10:21:30 +01004434 if (4 > (size_t) (end - p)) {
Gilles Peskine449bd832023-01-11 14:50:10 +01004435 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4436 }
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01004437 session->tls_version = (mbedtls_ssl_protocol_version) (0x0300 | *p++);
Ronald Cron40a4ab02024-01-15 10:21:30 +01004438 session->endpoint = *p++;
4439 session->ciphersuite = MBEDTLS_GET_UINT16_BE(p, 0);
4440 p += 2;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004441
4442 /* Dispatch according to TLS version. */
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00004443 remaining_len = (size_t) (end - p);
Gilles Peskine449bd832023-01-11 14:50:10 +01004444 switch (session->tls_version) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004445#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01004446 case MBEDTLS_SSL_VERSION_TLS1_2:
4447 return ssl_tls12_session_load(session, p, remaining_len);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004448#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
4449
Jerry Yu438ddd82022-07-07 06:55:50 +00004450#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004451 case MBEDTLS_SSL_VERSION_TLS1_3:
4452 return ssl_tls13_session_load(session, p, remaining_len);
Jerry Yu438ddd82022-07-07 06:55:50 +00004453#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
4454
Gilles Peskine449bd832023-01-11 14:50:10 +01004455 default:
4456 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004457 }
4458}
4459
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004460/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02004461 * Deserialize session: public wrapper for error cleaning
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02004462 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004463int mbedtls_ssl_session_load(mbedtls_ssl_session *session,
4464 const unsigned char *buf,
4465 size_t len)
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02004466{
Gilles Peskine449bd832023-01-11 14:50:10 +01004467 int ret = ssl_session_load(session, 0, buf, len);
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02004468
Gilles Peskine449bd832023-01-11 14:50:10 +01004469 if (ret != 0) {
4470 mbedtls_ssl_session_free(session);
4471 }
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02004472
Gilles Peskine449bd832023-01-11 14:50:10 +01004473 return ret;
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02004474}
4475
4476/*
Paul Bakker1961b702013-01-25 14:49:24 +01004477 * Perform a single step of the SSL handshake
Paul Bakker5121ce52009-01-03 21:22:43 +00004478 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004479MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004480static int ssl_prepare_handshake_step(mbedtls_ssl_context *ssl)
Hanno Becker41934dd2021-08-07 19:13:43 +01004481{
4482 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
4483
Ronald Cron66dbf912022-02-02 15:33:46 +01004484 /*
4485 * We may have not been able to send to the peer all the handshake data
Ronald Cron3f20b772022-03-08 16:00:02 +01004486 * that were written into the output buffer by the previous handshake step,
4487 * if the write to the network callback returned with the
Ronald Cron66dbf912022-02-02 15:33:46 +01004488 * #MBEDTLS_ERR_SSL_WANT_WRITE error code.
4489 * We proceed to the next handshake step only when all data from the
4490 * previous one have been sent to the peer, thus we make sure that this is
4491 * the case here by calling `mbedtls_ssl_flush_output()`. The function may
4492 * return with the #MBEDTLS_ERR_SSL_WANT_WRITE error code in which case
4493 * we have to wait before to go ahead.
4494 * In the case of TLS 1.3, handshake step handlers do not send data to the
4495 * peer. Data are only sent here and through
4496 * `mbedtls_ssl_handle_pending_alert` in case an error that triggered an
Andrzej Kurek5c65c572022-04-13 14:28:52 -04004497 * alert occurred.
Ronald Cron66dbf912022-02-02 15:33:46 +01004498 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004499 if ((ret = mbedtls_ssl_flush_output(ssl)) != 0) {
4500 return ret;
4501 }
Hanno Becker41934dd2021-08-07 19:13:43 +01004502
4503#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004504 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
4505 ssl->handshake->retransmit_state == MBEDTLS_SSL_RETRANS_SENDING) {
4506 if ((ret = mbedtls_ssl_flight_transmit(ssl)) != 0) {
4507 return ret;
4508 }
Hanno Becker41934dd2021-08-07 19:13:43 +01004509 }
4510#endif /* MBEDTLS_SSL_PROTO_DTLS */
4511
Gilles Peskine449bd832023-01-11 14:50:10 +01004512 return ret;
Hanno Becker41934dd2021-08-07 19:13:43 +01004513}
4514
Gilles Peskine449bd832023-01-11 14:50:10 +01004515int mbedtls_ssl_handshake_step(mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00004516{
Hanno Becker41934dd2021-08-07 19:13:43 +01004517 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00004518
Gilles Peskine449bd832023-01-11 14:50:10 +01004519 if (ssl == NULL ||
Hanno Becker41934dd2021-08-07 19:13:43 +01004520 ssl->conf == NULL ||
4521 ssl->handshake == NULL ||
Gilles Peskine449bd832023-01-11 14:50:10 +01004522 ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER) {
4523 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Becker41934dd2021-08-07 19:13:43 +01004524 }
4525
Gilles Peskine449bd832023-01-11 14:50:10 +01004526 ret = ssl_prepare_handshake_step(ssl);
4527 if (ret != 0) {
4528 return ret;
4529 }
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02004530
Gilles Peskine449bd832023-01-11 14:50:10 +01004531 ret = mbedtls_ssl_handle_pending_alert(ssl);
4532 if (ret != 0) {
Jerry Yue7047812021-09-13 19:26:39 +08004533 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01004534 }
Jerry Yue7047812021-09-13 19:26:39 +08004535
Tom Cosgrove2fdc7b32022-09-21 12:33:17 +01004536 /* If ssl->conf->endpoint is not one of MBEDTLS_SSL_IS_CLIENT or
4537 * MBEDTLS_SSL_IS_SERVER, this is the return code we give */
4538 ret = MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4539
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004540#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004541 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
4542 MBEDTLS_SSL_DEBUG_MSG(2, ("client state: %s",
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01004543 mbedtls_ssl_states_str((mbedtls_ssl_states) ssl->state)));
Jerry Yub9930e72021-08-06 17:11:51 +08004544
Gilles Peskine449bd832023-01-11 14:50:10 +01004545 switch (ssl->state) {
Ronald Cron9f0fba32022-02-10 16:45:15 +01004546 case MBEDTLS_SSL_HELLO_REQUEST:
4547 ssl->state = MBEDTLS_SSL_CLIENT_HELLO;
Tom Cosgrove87d9c6c2022-09-22 09:27:56 +01004548 ret = 0;
Ronald Cron9f0fba32022-02-10 16:45:15 +01004549 break;
Jerry Yub9930e72021-08-06 17:11:51 +08004550
Ronald Cron9f0fba32022-02-10 16:45:15 +01004551 case MBEDTLS_SSL_CLIENT_HELLO:
Gilles Peskine449bd832023-01-11 14:50:10 +01004552 ret = mbedtls_ssl_write_client_hello(ssl);
Ronald Cron9f0fba32022-02-10 16:45:15 +01004553 break;
4554
4555 default:
4556#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004557 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
4558 ret = mbedtls_ssl_tls13_handshake_client_step(ssl);
4559 } else {
4560 ret = mbedtls_ssl_handshake_client_step(ssl);
4561 }
Ronald Cron9f0fba32022-02-10 16:45:15 +01004562#elif defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01004563 ret = mbedtls_ssl_handshake_client_step(ssl);
Ronald Cron9f0fba32022-02-10 16:45:15 +01004564#else
Gilles Peskine449bd832023-01-11 14:50:10 +01004565 ret = mbedtls_ssl_tls13_handshake_client_step(ssl);
Ronald Cron9f0fba32022-02-10 16:45:15 +01004566#endif
4567 }
Jerry Yub9930e72021-08-06 17:11:51 +08004568 }
Ronald Cron6291b232023-03-08 15:51:25 +01004569#endif /* MBEDTLS_SSL_CLI_C */
4570
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004571#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004572 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Ronald Cron6291b232023-03-08 15:51:25 +01004573#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
4574 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Gilles Peskine449bd832023-01-11 14:50:10 +01004575 ret = mbedtls_ssl_tls13_handshake_server_step(ssl);
Ronald Cron6291b232023-03-08 15:51:25 +01004576 } else {
Gilles Peskine449bd832023-01-11 14:50:10 +01004577 ret = mbedtls_ssl_handshake_server_step(ssl);
4578 }
Ronald Cron6291b232023-03-08 15:51:25 +01004579#elif defined(MBEDTLS_SSL_PROTO_TLS1_2)
4580 ret = mbedtls_ssl_handshake_server_step(ssl);
4581#else
4582 ret = mbedtls_ssl_tls13_handshake_server_step(ssl);
Paul Bakker5121ce52009-01-03 21:22:43 +00004583#endif
Ronald Cron6291b232023-03-08 15:51:25 +01004584 }
4585#endif /* MBEDTLS_SSL_SRV_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00004586
Gilles Peskine449bd832023-01-11 14:50:10 +01004587 if (ret != 0) {
Jerry Yubbd5a3f2021-09-18 20:50:22 +08004588 /* handshake_step return error. And it is same
4589 * with alert_reason.
4590 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004591 if (ssl->send_alert) {
4592 ret = mbedtls_ssl_handle_pending_alert(ssl);
Jerry Yue7047812021-09-13 19:26:39 +08004593 goto cleanup;
4594 }
4595 }
4596
4597cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +01004598 return ret;
Paul Bakker1961b702013-01-25 14:49:24 +01004599}
4600
4601/*
4602 * Perform the SSL handshake
4603 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004604int mbedtls_ssl_handshake(mbedtls_ssl_context *ssl)
Paul Bakker1961b702013-01-25 14:49:24 +01004605{
4606 int ret = 0;
4607
Hanno Beckera817ea42020-10-20 15:20:23 +01004608 /* Sanity checks */
4609
Gilles Peskine449bd832023-01-11 14:50:10 +01004610 if (ssl == NULL || ssl->conf == NULL) {
4611 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4612 }
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02004613
Hanno Beckera817ea42020-10-20 15:20:23 +01004614#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004615 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
4616 (ssl->f_set_timer == NULL || ssl->f_get_timer == NULL)) {
4617 MBEDTLS_SSL_DEBUG_MSG(1, ("You must use "
4618 "mbedtls_ssl_set_timer_cb() for DTLS"));
4619 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Beckera817ea42020-10-20 15:20:23 +01004620 }
4621#endif /* MBEDTLS_SSL_PROTO_DTLS */
4622
Gilles Peskine449bd832023-01-11 14:50:10 +01004623 MBEDTLS_SSL_DEBUG_MSG(2, ("=> handshake"));
Paul Bakker1961b702013-01-25 14:49:24 +01004624
Hanno Beckera817ea42020-10-20 15:20:23 +01004625 /* Main handshake loop */
Gilles Peskine449bd832023-01-11 14:50:10 +01004626 while (ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER) {
4627 ret = mbedtls_ssl_handshake_step(ssl);
Paul Bakker1961b702013-01-25 14:49:24 +01004628
Gilles Peskine449bd832023-01-11 14:50:10 +01004629 if (ret != 0) {
Paul Bakker1961b702013-01-25 14:49:24 +01004630 break;
Gilles Peskine449bd832023-01-11 14:50:10 +01004631 }
Paul Bakker1961b702013-01-25 14:49:24 +01004632 }
4633
Gilles Peskine449bd832023-01-11 14:50:10 +01004634 MBEDTLS_SSL_DEBUG_MSG(2, ("<= handshake"));
Paul Bakker5121ce52009-01-03 21:22:43 +00004635
Gilles Peskine449bd832023-01-11 14:50:10 +01004636 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00004637}
4638
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004639#if defined(MBEDTLS_SSL_RENEGOTIATION)
4640#if defined(MBEDTLS_SSL_SRV_C)
Paul Bakker5121ce52009-01-03 21:22:43 +00004641/*
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004642 * Write HelloRequest to request renegotiation on server
Paul Bakker48916f92012-09-16 19:57:18 +00004643 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004644MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004645static int ssl_write_hello_request(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004646{
Janos Follath865b3eb2019-12-16 11:46:15 +00004647 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004648
Gilles Peskine449bd832023-01-11 14:50:10 +01004649 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write hello request"));
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004650
4651 ssl->out_msglen = 4;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004652 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
4653 ssl->out_msg[0] = MBEDTLS_SSL_HS_HELLO_REQUEST;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004654
Gilles Peskine449bd832023-01-11 14:50:10 +01004655 if ((ret = mbedtls_ssl_write_handshake_msg(ssl)) != 0) {
4656 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_handshake_msg", ret);
4657 return ret;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004658 }
4659
Gilles Peskine449bd832023-01-11 14:50:10 +01004660 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write hello request"));
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004661
Gilles Peskine449bd832023-01-11 14:50:10 +01004662 return 0;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004663}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004664#endif /* MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004665
4666/*
4667 * Actually renegotiate current connection, triggered by either:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004668 * - any side: calling mbedtls_ssl_renegotiate(),
4669 * - client: receiving a HelloRequest during mbedtls_ssl_read(),
4670 * - server: receiving any handshake message on server during mbedtls_ssl_read() after
Manuel Pégourié-Gonnard55e4ff22014-08-19 11:16:35 +02004671 * the initial handshake is completed.
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004672 * If the handshake doesn't complete due to waiting for I/O, it will continue
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004673 * during the next calls to mbedtls_ssl_renegotiate() or mbedtls_ssl_read() respectively.
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004674 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004675int mbedtls_ssl_start_renegotiation(mbedtls_ssl_context *ssl)
Paul Bakker48916f92012-09-16 19:57:18 +00004676{
Janos Follath865b3eb2019-12-16 11:46:15 +00004677 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker48916f92012-09-16 19:57:18 +00004678
Gilles Peskine449bd832023-01-11 14:50:10 +01004679 MBEDTLS_SSL_DEBUG_MSG(2, ("=> renegotiate"));
Paul Bakker48916f92012-09-16 19:57:18 +00004680
Gilles Peskine449bd832023-01-11 14:50:10 +01004681 if ((ret = ssl_handshake_init(ssl)) != 0) {
4682 return ret;
4683 }
Paul Bakker48916f92012-09-16 19:57:18 +00004684
Manuel Pégourié-Gonnard0557bd52014-08-19 19:18:39 +02004685 /* RFC 6347 4.2.2: "[...] the HelloRequest will have message_seq = 0 and
4686 * the ServerHello will have message_seq = 1" */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004687#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004688 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
4689 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING) {
4690 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02004691 ssl->handshake->out_msg_seq = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004692 } else {
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02004693 ssl->handshake->in_msg_seq = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004694 }
Manuel Pégourié-Gonnard0557bd52014-08-19 19:18:39 +02004695 }
4696#endif
4697
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004698 ssl->state = MBEDTLS_SSL_HELLO_REQUEST;
4699 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS;
Paul Bakker48916f92012-09-16 19:57:18 +00004700
Gilles Peskine449bd832023-01-11 14:50:10 +01004701 if ((ret = mbedtls_ssl_handshake(ssl)) != 0) {
4702 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_handshake", ret);
4703 return ret;
Paul Bakker48916f92012-09-16 19:57:18 +00004704 }
4705
Gilles Peskine449bd832023-01-11 14:50:10 +01004706 MBEDTLS_SSL_DEBUG_MSG(2, ("<= renegotiate"));
Paul Bakker48916f92012-09-16 19:57:18 +00004707
Gilles Peskine449bd832023-01-11 14:50:10 +01004708 return 0;
Paul Bakker48916f92012-09-16 19:57:18 +00004709}
4710
4711/*
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004712 * Renegotiate current connection on client,
4713 * or request renegotiation on server
4714 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004715int mbedtls_ssl_renegotiate(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004716{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004717 int ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004718
Gilles Peskine449bd832023-01-11 14:50:10 +01004719 if (ssl == NULL || ssl->conf == NULL) {
4720 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4721 }
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02004722
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004723#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004724 /* On server, just send the request */
Gilles Peskine449bd832023-01-11 14:50:10 +01004725 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
4726 if (mbedtls_ssl_is_handshake_over(ssl) == 0) {
4727 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4728 }
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004729
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004730 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_PENDING;
Manuel Pégourié-Gonnardf07f4212014-08-15 19:04:47 +02004731
4732 /* Did we already try/start sending HelloRequest? */
Gilles Peskine449bd832023-01-11 14:50:10 +01004733 if (ssl->out_left != 0) {
4734 return mbedtls_ssl_flush_output(ssl);
4735 }
Manuel Pégourié-Gonnardf07f4212014-08-15 19:04:47 +02004736
Gilles Peskine449bd832023-01-11 14:50:10 +01004737 return ssl_write_hello_request(ssl);
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004738 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004739#endif /* MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004740
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004741#if defined(MBEDTLS_SSL_CLI_C)
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004742 /*
4743 * On client, either start the renegotiation process or,
4744 * if already in progress, continue the handshake
4745 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004746 if (ssl->renego_status != MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS) {
4747 if (mbedtls_ssl_is_handshake_over(ssl) == 0) {
4748 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004749 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004750
4751 if ((ret = mbedtls_ssl_start_renegotiation(ssl)) != 0) {
4752 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_start_renegotiation", ret);
4753 return ret;
4754 }
4755 } else {
4756 if ((ret = mbedtls_ssl_handshake(ssl)) != 0) {
4757 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_handshake", ret);
4758 return ret;
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004759 }
4760 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004761#endif /* MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004762
Gilles Peskine449bd832023-01-11 14:50:10 +01004763 return ret;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004764}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004765#endif /* MBEDTLS_SSL_RENEGOTIATION */
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004766
Gilles Peskine449bd832023-01-11 14:50:10 +01004767void mbedtls_ssl_handshake_free(mbedtls_ssl_context *ssl)
Paul Bakker48916f92012-09-16 19:57:18 +00004768{
Gilles Peskine9b562d52018-04-25 20:32:43 +02004769 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
4770
Gilles Peskine449bd832023-01-11 14:50:10 +01004771 if (handshake == NULL) {
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004772 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01004773 }
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004774
Valerio Setti6f0441d2023-07-03 12:11:36 +02004775#if defined(MBEDTLS_PK_HAVE_ECC_KEYS)
Brett Warrene0edc842021-08-17 09:53:13 +01004776#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004777 if (ssl->handshake->group_list_heap_allocated) {
4778 mbedtls_free((void *) handshake->group_list);
4779 }
Brett Warrene0edc842021-08-17 09:53:13 +01004780 handshake->group_list = NULL;
4781#endif /* MBEDTLS_DEPRECATED_REMOVED */
Valerio Setti6f0441d2023-07-03 12:11:36 +02004782#endif /* MBEDTLS_PK_HAVE_ECC_KEYS */
Brett Warrene0edc842021-08-17 09:53:13 +01004783
Ronald Crone68ab4f2022-10-05 12:46:29 +02004784#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yuf017ee42022-01-12 15:49:48 +08004785#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004786 if (ssl->handshake->sig_algs_heap_allocated) {
4787 mbedtls_free((void *) handshake->sig_algs);
4788 }
Jerry Yuf017ee42022-01-12 15:49:48 +08004789 handshake->sig_algs = NULL;
4790#endif /* MBEDTLS_DEPRECATED_REMOVED */
Xiaofei Baic234ecf2022-02-08 09:59:23 +00004791#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004792 if (ssl->handshake->certificate_request_context) {
4793 mbedtls_free((void *) handshake->certificate_request_context);
Xiaofei Baic234ecf2022-02-08 09:59:23 +00004794 }
4795#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Ronald Crone68ab4f2022-10-05 12:46:29 +02004796#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Jerry Yuf017ee42022-01-12 15:49:48 +08004797
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02004798#if defined(MBEDTLS_SSL_ASYNC_PRIVATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01004799 if (ssl->conf->f_async_cancel != NULL && handshake->async_in_progress != 0) {
4800 ssl->conf->f_async_cancel(ssl);
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02004801 handshake->async_in_progress = 0;
4802 }
4803#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
4804
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01004805#if defined(MBEDTLS_MD_CAN_SHA256)
Andrzej Kurekeb342242019-01-29 09:14:33 -05004806#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01004807 psa_hash_abort(&handshake->fin_sha256_psa);
Andrzej Kurekeb342242019-01-29 09:14:33 -05004808#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01004809 mbedtls_md_free(&handshake->fin_sha256);
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02004810#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -05004811#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01004812#if defined(MBEDTLS_MD_CAN_SHA384)
Andrzej Kurekeb342242019-01-29 09:14:33 -05004813#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01004814 psa_hash_abort(&handshake->fin_sha384_psa);
Andrzej Kurekeb342242019-01-29 09:14:33 -05004815#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01004816 mbedtls_md_free(&handshake->fin_sha384);
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02004817#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -05004818#endif
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02004819
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004820#if defined(MBEDTLS_DHM_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004821 mbedtls_dhm_free(&handshake->dhm_ctx);
Paul Bakker48916f92012-09-16 19:57:18 +00004822#endif
Valerio Setti7aeec542023-07-05 18:57:21 +02004823#if !defined(MBEDTLS_USE_PSA_CRYPTO) && \
Valerio Setti6eb00542023-07-07 17:04:24 +02004824 defined(MBEDTLS_KEY_EXCHANGE_SOME_ECDH_OR_ECDHE_1_2_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004825 mbedtls_ecdh_free(&handshake->ecdh_ctx);
Paul Bakker61d113b2013-07-04 11:51:43 +02004826#endif
Valerio Setti02c25b52022-11-15 14:08:42 +01004827
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02004828#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Neil Armstrongca7d5062022-05-31 14:43:23 +02004829#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01004830 psa_pake_abort(&handshake->psa_pake_ctx);
Valerio Settieb3f7882022-12-08 18:42:58 +01004831 /*
4832 * Opaque keys are not stored in the handshake's data and it's the user
4833 * responsibility to destroy them. Clear ones, instead, are created by
4834 * the TLS library and should be destroyed at the same level
4835 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004836 if (!mbedtls_svc_key_id_is_null(handshake->psa_pake_password)) {
4837 psa_destroy_key(handshake->psa_pake_password);
Valerio Settieb3f7882022-12-08 18:42:58 +01004838 }
Neil Armstrongca7d5062022-05-31 14:43:23 +02004839 handshake->psa_pake_password = MBEDTLS_SVC_KEY_ID_INIT;
4840#else
Gilles Peskine449bd832023-01-11 14:50:10 +01004841 mbedtls_ecjpake_free(&handshake->ecjpake_ctx);
Neil Armstrongca7d5062022-05-31 14:43:23 +02004842#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard77c06462015-09-17 13:59:49 +02004843#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004844 mbedtls_free(handshake->ecjpake_cache);
Manuel Pégourié-Gonnard77c06462015-09-17 13:59:49 +02004845 handshake->ecjpake_cache = NULL;
4846 handshake->ecjpake_cache_len = 0;
4847#endif
Manuel Pégourié-Gonnard76cfd3f2015-09-15 12:10:54 +02004848#endif
Paul Bakker61d113b2013-07-04 11:51:43 +02004849
Valerio Setti7aeec542023-07-05 18:57:21 +02004850#if defined(MBEDTLS_KEY_EXCHANGE_SOME_ECDH_OR_ECDHE_ANY_ENABLED) || \
Valerio Setti45d56f32023-07-13 17:23:20 +02004851 defined(MBEDTLS_KEY_EXCHANGE_WITH_ECDSA_ANY_ENABLED) || \
Janos Follath4ae5c292016-02-10 11:27:43 +00004852 defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Paul Bakker9af723c2014-05-01 13:03:14 +02004853 /* explicit void pointer cast for buggy MS compiler */
Gilles Peskine449bd832023-01-11 14:50:10 +01004854 mbedtls_free((void *) handshake->curves_tls_id);
Manuel Pégourié-Gonnardd09453c2013-09-23 19:11:32 +02004855#endif
4856
Ronald Cron73fe8df2022-10-05 14:31:43 +02004857#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED)
Neil Armstrong501c9322022-05-03 09:35:09 +02004858#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01004859 if (!mbedtls_svc_key_id_is_null(ssl->handshake->psk_opaque)) {
Neil Armstrong501c9322022-05-03 09:35:09 +02004860 /* The maintenance of the external PSK key slot is the
4861 * user's responsibility. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004862 if (ssl->handshake->psk_opaque_is_internal) {
4863 psa_destroy_key(ssl->handshake->psk_opaque);
Neil Armstrong501c9322022-05-03 09:35:09 +02004864 ssl->handshake->psk_opaque_is_internal = 0;
4865 }
4866 ssl->handshake->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
4867 }
Neil Armstronge952a302022-05-03 10:22:14 +02004868#else
Gilles Peskine449bd832023-01-11 14:50:10 +01004869 if (handshake->psk != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01004870 mbedtls_zeroize_and_free(handshake->psk, handshake->psk_len);
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01004871 }
Neil Armstronge952a302022-05-03 10:22:14 +02004872#endif /* MBEDTLS_USE_PSA_CRYPTO */
Ronald Cron73fe8df2022-10-05 14:31:43 +02004873#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED */
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01004874
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004875#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
4876 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Manuel Pégourié-Gonnard83724542013-09-24 22:30:56 +02004877 /*
4878 * Free only the linked list wrapper, not the keys themselves
4879 * since the belong to the SNI callback
4880 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004881 ssl_key_cert_free(handshake->sni_key_cert);
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004882#endif /* MBEDTLS_X509_CRT_PARSE_C && MBEDTLS_SSL_SERVER_NAME_INDICATION */
Manuel Pégourié-Gonnard705fcca2013-09-23 20:04:20 +02004883
Gilles Peskineeccd8882020-03-10 12:19:08 +01004884#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004885 mbedtls_x509_crt_restart_free(&handshake->ecrs_ctx);
4886 if (handshake->ecrs_peer_cert != NULL) {
4887 mbedtls_x509_crt_free(handshake->ecrs_peer_cert);
4888 mbedtls_free(handshake->ecrs_peer_cert);
Hanno Becker3dad3112019-02-05 17:19:52 +00004889 }
Manuel Pégourié-Gonnard862cde52017-05-17 11:56:15 +02004890#endif
4891
Hanno Becker75173122019-02-06 16:18:31 +00004892#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
4893 !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01004894 mbedtls_pk_free(&handshake->peer_pubkey);
Hanno Becker75173122019-02-06 16:18:31 +00004895#endif /* MBEDTLS_X509_CRT_PARSE_C && !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
4896
XiaokangQian9b93c0d2022-02-09 06:02:25 +00004897#if defined(MBEDTLS_SSL_CLI_C) && \
Gilles Peskine449bd832023-01-11 14:50:10 +01004898 (defined(MBEDTLS_SSL_PROTO_DTLS) || defined(MBEDTLS_SSL_PROTO_TLS1_3))
4899 mbedtls_free(handshake->cookie);
XiaokangQian9b93c0d2022-02-09 06:02:25 +00004900#endif /* MBEDTLS_SSL_CLI_C &&
4901 ( MBEDTLS_SSL_PROTO_DTLS || MBEDTLS_SSL_PROTO_TLS1_3 ) */
XiaokangQian8499b6c2022-01-27 09:00:11 +00004902
4903#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004904 mbedtls_ssl_flight_free(handshake->flight);
4905 mbedtls_ssl_buffering_free(ssl);
XiaokangQian8499b6c2022-01-27 09:00:11 +00004906#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard74848812014-07-11 02:43:49 +02004907
Valerio Settiea59c432023-07-25 11:14:03 +02004908#if defined(MBEDTLS_KEY_EXCHANGE_SOME_XXDH_PSA_ANY_ENABLED)
Przemek Stekiel7ac93be2023-07-04 10:02:38 +02004909 if (handshake->xxdh_psa_privkey_is_external == 0) {
4910 psa_destroy_key(handshake->xxdh_psa_privkey);
Gilles Peskine449bd832023-01-11 14:50:10 +01004911 }
Valerio Settiea59c432023-07-25 11:14:03 +02004912#endif /* MBEDTLS_KEY_EXCHANGE_SOME_XXDH_PSA_ANY_ENABLED */
Hanno Becker4a63ed42019-01-08 11:39:35 +00004913
Ronald Cron6f135e12021-12-08 16:57:54 +01004914#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004915 mbedtls_ssl_transform_free(handshake->transform_handshake);
4916 mbedtls_free(handshake->transform_handshake);
Jerry Yu3d9b5902022-11-04 14:07:25 +08004917#if defined(MBEDTLS_SSL_EARLY_DATA)
Gilles Peskine449bd832023-01-11 14:50:10 +01004918 mbedtls_ssl_transform_free(handshake->transform_earlydata);
4919 mbedtls_free(handshake->transform_earlydata);
Jerry Yu3d9b5902022-11-04 14:07:25 +08004920#endif
Ronald Cron6f135e12021-12-08 16:57:54 +01004921#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yuba9c7272021-10-30 11:54:10 +08004922
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05004923
4924#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
4925 /* If the buffers are too big - reallocate. Because of the way Mbed TLS
4926 * processes datagrams and the fact that a datagram is allowed to have
4927 * several records in it, it is possible that the I/O buffers are not
4928 * empty at this stage */
Gilles Peskine449bd832023-01-11 14:50:10 +01004929 handle_buffer_resizing(ssl, 1, mbedtls_ssl_get_input_buflen(ssl),
4930 mbedtls_ssl_get_output_buflen(ssl));
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05004931#endif
Hanno Becker3aa186f2021-08-10 09:24:19 +01004932
Jerry Yuba9c7272021-10-30 11:54:10 +08004933 /* mbedtls_platform_zeroize MUST be last one in this function */
Gilles Peskine449bd832023-01-11 14:50:10 +01004934 mbedtls_platform_zeroize(handshake,
4935 sizeof(mbedtls_ssl_handshake_params));
Paul Bakker48916f92012-09-16 19:57:18 +00004936}
4937
Gilles Peskine449bd832023-01-11 14:50:10 +01004938void mbedtls_ssl_session_free(mbedtls_ssl_session *session)
Paul Bakker48916f92012-09-16 19:57:18 +00004939{
Gilles Peskine449bd832023-01-11 14:50:10 +01004940 if (session == NULL) {
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004941 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01004942 }
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004943
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004944#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004945 ssl_clear_peer_cert(session);
Paul Bakkered27a042013-04-18 22:46:23 +02004946#endif
Paul Bakker0a597072012-09-25 21:55:46 +00004947
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02004948#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
Xiaokang Qianbc663a02022-10-09 11:14:39 +00004949#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && \
4950 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01004951 mbedtls_free(session->hostname);
Xiaokang Qian281fd1b2022-09-20 11:35:41 +00004952#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01004953 mbedtls_free(session->ticket);
Paul Bakkera503a632013-08-14 13:48:06 +02004954#endif
Manuel Pégourié-Gonnard75d44012013-08-02 14:44:04 +02004955
Waleed Elmelegy2824a202024-02-23 17:51:47 +00004956#if defined(MBEDTLS_SSL_EARLY_DATA) && defined(MBEDTLS_SSL_ALPN) && \
4957 defined(MBEDTLS_SSL_SRV_C)
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00004958 mbedtls_free(session->ticket_alpn);
Paul Bakker5121ce52009-01-03 21:22:43 +00004959#endif
4960
Gilles Peskine449bd832023-01-11 14:50:10 +01004961 mbedtls_platform_zeroize(session, sizeof(mbedtls_ssl_session));
Paul Bakker5121ce52009-01-03 21:22:43 +00004962}
4963
Manuel Pégourié-Gonnard5c0e3772019-07-23 16:13:17 +02004964#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004965
4966#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
4967#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID 1u
4968#else
4969#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID 0u
4970#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
4971
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004972#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT 1u
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004973
4974#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
4975#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY 1u
4976#else
4977#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY 0u
4978#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
4979
4980#if defined(MBEDTLS_SSL_ALPN)
4981#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN 1u
4982#else
4983#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN 0u
4984#endif /* MBEDTLS_SSL_ALPN */
4985
4986#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID_BIT 0
4987#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT_BIT 1
4988#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY_BIT 2
4989#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN_BIT 3
4990
4991#define SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG \
Gilles Peskine449bd832023-01-11 14:50:10 +01004992 ((uint32_t) ( \
4993 (SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID << \
4994 SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID_BIT) | \
4995 (SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT << \
4996 SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT_BIT) | \
4997 (SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY << \
4998 SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY_BIT) | \
4999 (SSL_SERIALIZED_CONTEXT_CONFIG_ALPN << SSL_SERIALIZED_CONTEXT_CONFIG_ALPN_BIT) | \
5000 0u))
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02005001
Chien Wong4e9683e2023-12-28 17:07:43 +08005002static const unsigned char ssl_serialized_context_header[] = {
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005003 MBEDTLS_VERSION_MAJOR,
5004 MBEDTLS_VERSION_MINOR,
5005 MBEDTLS_VERSION_PATCH,
Gilles Peskine449bd832023-01-11 14:50:10 +01005006 MBEDTLS_BYTE_1(SSL_SERIALIZED_SESSION_CONFIG_BITFLAG),
5007 MBEDTLS_BYTE_0(SSL_SERIALIZED_SESSION_CONFIG_BITFLAG),
5008 MBEDTLS_BYTE_2(SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG),
5009 MBEDTLS_BYTE_1(SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG),
5010 MBEDTLS_BYTE_0(SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG),
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005011};
5012
Paul Bakker5121ce52009-01-03 21:22:43 +00005013/*
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005014 * Serialize a full SSL context
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02005015 *
5016 * The format of the serialized data is:
5017 * (in the presentation language of TLS, RFC 8446 section 3)
5018 *
5019 * // header
5020 * opaque mbedtls_version[3]; // major, minor, patch
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005021 * opaque context_format[5]; // version-specific field determining
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02005022 * // the format of the remaining
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005023 * // serialized data.
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02005024 * Note: When updating the format, remember to keep these
5025 * version+format bytes. (We may make their size part of the API.)
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02005026 *
5027 * // session sub-structure
5028 * opaque session<1..2^32-1>; // see mbedtls_ssl_session_save()
5029 * // transform sub-structure
5030 * uint8 random[64]; // ServerHello.random+ClientHello.random
5031 * uint8 in_cid<0..2^8-1> // Connection ID: expected incoming value
5032 * uint8 out_cid<0..2^8-1> // Connection ID: outgoing value to use
5033 * // fields from ssl_context
5034 * uint32 badmac_seen; // DTLS: number of records with failing MAC
5035 * uint64 in_window_top; // DTLS: last validated record seq_num
5036 * uint64 in_window; // DTLS: bitmask for replay protection
5037 * uint8 disable_datagram_packing; // DTLS: only one record per datagram
5038 * uint64 cur_out_ctr; // Record layer: outgoing sequence number
5039 * uint16 mtu; // DTLS: path mtu (max outgoing fragment size)
5040 * uint8 alpn_chosen<0..2^8-1> // ALPN: negotiated application protocol
5041 *
5042 * Note that many fields of the ssl_context or sub-structures are not
5043 * serialized, as they fall in one of the following categories:
5044 *
5045 * 1. forced value (eg in_left must be 0)
5046 * 2. pointer to dynamically-allocated memory (eg session, transform)
5047 * 3. value can be re-derived from other data (eg session keys from MS)
5048 * 4. value was temporary (eg content of input buffer)
5049 * 5. value will be provided by the user again (eg I/O callbacks and context)
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005050 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005051int mbedtls_ssl_context_save(mbedtls_ssl_context *ssl,
5052 unsigned char *buf,
5053 size_t buf_len,
5054 size_t *olen)
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005055{
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005056 unsigned char *p = buf;
5057 size_t used = 0;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005058 size_t session_len;
5059 int ret = 0;
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005060
Manuel Pégourié-Gonnard1aaf6692019-07-10 14:14:05 +02005061 /*
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02005062 * Enforce usage restrictions, see "return BAD_INPUT_DATA" in
5063 * this function's documentation.
5064 *
5065 * These are due to assumptions/limitations in the implementation. Some of
5066 * them are likely to stay (no handshake in progress) some might go away
5067 * (only DTLS) but are currently used to simplify the implementation.
Manuel Pégourié-Gonnard1aaf6692019-07-10 14:14:05 +02005068 */
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02005069 /* The initial handshake must be over */
Gilles Peskine449bd832023-01-11 14:50:10 +01005070 if (mbedtls_ssl_is_handshake_over(ssl) == 0) {
5071 MBEDTLS_SSL_DEBUG_MSG(1, ("Initial handshake isn't over"));
5072 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03005073 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005074 if (ssl->handshake != NULL) {
5075 MBEDTLS_SSL_DEBUG_MSG(1, ("Handshake isn't completed"));
5076 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03005077 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02005078 /* Double-check that sub-structures are indeed ready */
Gilles Peskine449bd832023-01-11 14:50:10 +01005079 if (ssl->transform == NULL || ssl->session == NULL) {
5080 MBEDTLS_SSL_DEBUG_MSG(1, ("Serialised structures aren't ready"));
5081 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03005082 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02005083 /* There must be no pending incoming or outgoing data */
Gilles Peskine449bd832023-01-11 14:50:10 +01005084 if (mbedtls_ssl_check_pending(ssl) != 0) {
5085 MBEDTLS_SSL_DEBUG_MSG(1, ("There is pending incoming data"));
5086 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03005087 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005088 if (ssl->out_left != 0) {
5089 MBEDTLS_SSL_DEBUG_MSG(1, ("There is pending outgoing data"));
5090 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03005091 }
Dave Rodgman556e8a32022-12-06 16:31:25 +00005092 /* Protocol must be DTLS, not TLS */
Gilles Peskine449bd832023-01-11 14:50:10 +01005093 if (ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
5094 MBEDTLS_SSL_DEBUG_MSG(1, ("Only DTLS is supported"));
5095 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03005096 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02005097 /* Version must be 1.2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005098 if (ssl->tls_version != MBEDTLS_SSL_VERSION_TLS1_2) {
5099 MBEDTLS_SSL_DEBUG_MSG(1, ("Only version 1.2 supported"));
5100 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03005101 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02005102 /* We must be using an AEAD ciphersuite */
Gilles Peskine449bd832023-01-11 14:50:10 +01005103 if (mbedtls_ssl_transform_uses_aead(ssl->transform) != 1) {
5104 MBEDTLS_SSL_DEBUG_MSG(1, ("Only AEAD ciphersuites supported"));
5105 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03005106 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02005107 /* Renegotiation must not be enabled */
5108#if defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01005109 if (ssl->conf->disable_renegotiation != MBEDTLS_SSL_RENEGOTIATION_DISABLED) {
5110 MBEDTLS_SSL_DEBUG_MSG(1, ("Renegotiation must not be enabled"));
5111 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03005112 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02005113#endif
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005114
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005115 /*
5116 * Version and format identifier
5117 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005118 used += sizeof(ssl_serialized_context_header);
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005119
Gilles Peskine449bd832023-01-11 14:50:10 +01005120 if (used <= buf_len) {
5121 memcpy(p, ssl_serialized_context_header,
5122 sizeof(ssl_serialized_context_header));
5123 p += sizeof(ssl_serialized_context_header);
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005124 }
5125
5126 /*
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005127 * Session (length + data)
5128 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005129 ret = ssl_session_save(ssl->session, 1, NULL, 0, &session_len);
5130 if (ret != MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL) {
5131 return ret;
5132 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005133
5134 used += 4 + session_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01005135 if (used <= buf_len) {
5136 MBEDTLS_PUT_UINT32_BE(session_len, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01005137 p += 4;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005138
Gilles Peskine449bd832023-01-11 14:50:10 +01005139 ret = ssl_session_save(ssl->session, 1,
5140 p, session_len, &session_len);
5141 if (ret != 0) {
5142 return ret;
5143 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005144
5145 p += session_len;
5146 }
5147
5148 /*
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005149 * Transform
5150 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005151 used += sizeof(ssl->transform->randbytes);
5152 if (used <= buf_len) {
5153 memcpy(p, ssl->transform->randbytes,
5154 sizeof(ssl->transform->randbytes));
5155 p += sizeof(ssl->transform->randbytes);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005156 }
5157
5158#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Dave Rodgmanc37ad442023-11-03 23:36:06 +00005159 used += 2U + ssl->transform->in_cid_len + ssl->transform->out_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01005160 if (used <= buf_len) {
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005161 *p++ = ssl->transform->in_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01005162 memcpy(p, ssl->transform->in_cid, ssl->transform->in_cid_len);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005163 p += ssl->transform->in_cid_len;
5164
5165 *p++ = ssl->transform->out_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01005166 memcpy(p, ssl->transform->out_cid, ssl->transform->out_cid_len);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005167 p += ssl->transform->out_cid_len;
5168 }
5169#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
5170
5171 /*
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005172 * Saved fields from top-level ssl_context structure
5173 */
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005174 used += 4;
Gilles Peskine449bd832023-01-11 14:50:10 +01005175 if (used <= buf_len) {
5176 MBEDTLS_PUT_UINT32_BE(ssl->badmac_seen, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01005177 p += 4;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005178 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005179
5180#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
5181 used += 16;
Gilles Peskine449bd832023-01-11 14:50:10 +01005182 if (used <= buf_len) {
5183 MBEDTLS_PUT_UINT64_BE(ssl->in_window_top, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01005184 p += 8;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005185
Gilles Peskine449bd832023-01-11 14:50:10 +01005186 MBEDTLS_PUT_UINT64_BE(ssl->in_window, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01005187 p += 8;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005188 }
5189#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
5190
5191#if defined(MBEDTLS_SSL_PROTO_DTLS)
5192 used += 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01005193 if (used <= buf_len) {
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005194 *p++ = ssl->disable_datagram_packing;
5195 }
5196#endif /* MBEDTLS_SSL_PROTO_DTLS */
5197
Jerry Yuae0b2e22021-10-08 15:21:19 +08005198 used += MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Gilles Peskine449bd832023-01-11 14:50:10 +01005199 if (used <= buf_len) {
5200 memcpy(p, ssl->cur_out_ctr, MBEDTLS_SSL_SEQUENCE_NUMBER_LEN);
Jerry Yuae0b2e22021-10-08 15:21:19 +08005201 p += MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005202 }
5203
5204#if defined(MBEDTLS_SSL_PROTO_DTLS)
5205 used += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01005206 if (used <= buf_len) {
5207 MBEDTLS_PUT_UINT16_BE(ssl->mtu, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01005208 p += 2;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005209 }
5210#endif /* MBEDTLS_SSL_PROTO_DTLS */
5211
5212#if defined(MBEDTLS_SSL_ALPN)
5213 {
5214 const uint8_t alpn_len = ssl->alpn_chosen
Gilles Peskine449bd832023-01-11 14:50:10 +01005215 ? (uint8_t) strlen(ssl->alpn_chosen)
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005216 : 0;
5217
5218 used += 1 + alpn_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01005219 if (used <= buf_len) {
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005220 *p++ = alpn_len;
5221
Gilles Peskine449bd832023-01-11 14:50:10 +01005222 if (ssl->alpn_chosen != NULL) {
5223 memcpy(p, ssl->alpn_chosen, alpn_len);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005224 p += alpn_len;
5225 }
5226 }
5227 }
5228#endif /* MBEDTLS_SSL_ALPN */
5229
5230 /*
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005231 * Done
5232 */
5233 *olen = used;
5234
Gilles Peskine449bd832023-01-11 14:50:10 +01005235 if (used > buf_len) {
5236 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
5237 }
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005238
Gilles Peskine449bd832023-01-11 14:50:10 +01005239 MBEDTLS_SSL_DEBUG_BUF(4, "saved context", buf, used);
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005240
Gilles Peskine449bd832023-01-11 14:50:10 +01005241 return mbedtls_ssl_session_reset_int(ssl, 0);
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005242}
5243
5244/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02005245 * Deserialize context, see mbedtls_ssl_context_save() for format.
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005246 *
5247 * This internal version is wrapped by a public function that cleans up in
5248 * case of error.
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005249 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005250MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01005251static int ssl_context_load(mbedtls_ssl_context *ssl,
5252 const unsigned char *buf,
5253 size_t len)
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005254{
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005255 const unsigned char *p = buf;
5256 const unsigned char * const end = buf + len;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005257 size_t session_len;
Janos Follath865b3eb2019-12-16 11:46:15 +00005258 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04005259#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Andrzej Kurek894edde2022-09-29 06:31:14 -04005260 tls_prf_fn prf_func = NULL;
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04005261#endif
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005262
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02005263 /*
5264 * The context should have been freshly setup or reset.
5265 * Give the user an error in case of obvious misuse.
Manuel Pégourié-Gonnard4ca930f2019-07-26 16:31:53 +02005266 * (Checking session is useful because it won't be NULL if we're
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02005267 * renegotiating, or if the user mistakenly loaded a session first.)
5268 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005269 if (ssl->state != MBEDTLS_SSL_HELLO_REQUEST ||
5270 ssl->session != NULL) {
5271 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02005272 }
5273
5274 /*
5275 * We can't check that the config matches the initial one, but we can at
5276 * least check it matches the requirements for serializing.
5277 */
Dave Rodgmane99b24d2023-09-14 15:45:03 +01005278 if (
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02005279#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard9a96fd72019-07-23 17:11:24 +02005280 ssl->conf->disable_renegotiation != MBEDTLS_SSL_RENEGOTIATION_DISABLED ||
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02005281#endif
Dave Rodgmane99b24d2023-09-14 15:45:03 +01005282 ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM ||
5283 ssl->conf->max_tls_version < MBEDTLS_SSL_VERSION_TLS1_2 ||
5284 ssl->conf->min_tls_version > MBEDTLS_SSL_VERSION_TLS1_2
5285 ) {
Gilles Peskine449bd832023-01-11 14:50:10 +01005286 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02005287 }
5288
Gilles Peskine449bd832023-01-11 14:50:10 +01005289 MBEDTLS_SSL_DEBUG_BUF(4, "context to load", buf, len);
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005290
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005291 /*
5292 * Check version identifier
5293 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005294 if ((size_t) (end - p) < sizeof(ssl_serialized_context_header)) {
5295 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005296 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005297
5298 if (memcmp(p, ssl_serialized_context_header,
5299 sizeof(ssl_serialized_context_header)) != 0) {
5300 return MBEDTLS_ERR_SSL_VERSION_MISMATCH;
5301 }
5302 p += sizeof(ssl_serialized_context_header);
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005303
5304 /*
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005305 * Session
5306 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005307 if ((size_t) (end - p) < 4) {
5308 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5309 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005310
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01005311 session_len = MBEDTLS_GET_UINT32_BE(p, 0);
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005312 p += 4;
5313
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02005314 /* This has been allocated by ssl_handshake_init(), called by
Hanno Becker43aefe22020-02-05 10:44:56 +00005315 * by either mbedtls_ssl_session_reset_int() or mbedtls_ssl_setup(). */
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02005316 ssl->session = ssl->session_negotiate;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005317 ssl->session_in = ssl->session;
5318 ssl->session_out = ssl->session;
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02005319 ssl->session_negotiate = NULL;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005320
Gilles Peskine449bd832023-01-11 14:50:10 +01005321 if ((size_t) (end - p) < session_len) {
5322 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5323 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005324
Gilles Peskine449bd832023-01-11 14:50:10 +01005325 ret = ssl_session_load(ssl->session, 1, p, session_len);
5326 if (ret != 0) {
5327 mbedtls_ssl_session_free(ssl->session);
5328 return ret;
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02005329 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005330
5331 p += session_len;
5332
5333 /*
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005334 * Transform
5335 */
5336
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02005337 /* This has been allocated by ssl_handshake_init(), called by
Hanno Becker43aefe22020-02-05 10:44:56 +00005338 * by either mbedtls_ssl_session_reset_int() or mbedtls_ssl_setup(). */
Jerry Yu2e199812022-12-01 18:57:19 +08005339#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02005340 ssl->transform = ssl->transform_negotiate;
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005341 ssl->transform_in = ssl->transform;
5342 ssl->transform_out = ssl->transform;
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02005343 ssl->transform_negotiate = NULL;
Jerry Yu2e199812022-12-01 18:57:19 +08005344#endif
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005345
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04005346#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005347 prf_func = ssl_tls12prf_from_cs(ssl->session->ciphersuite);
5348 if (prf_func == NULL) {
5349 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5350 }
Andrzej Kurek894edde2022-09-29 06:31:14 -04005351
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005352 /* Read random bytes and populate structure */
Gilles Peskine449bd832023-01-11 14:50:10 +01005353 if ((size_t) (end - p) < sizeof(ssl->transform->randbytes)) {
5354 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5355 }
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04005356
Gilles Peskine449bd832023-01-11 14:50:10 +01005357 ret = ssl_tls12_populate_transform(ssl->transform,
5358 ssl->session->ciphersuite,
5359 ssl->session->master,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02005360#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01005361 ssl->session->encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02005362#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01005363 prf_func,
5364 p, /* currently pointing to randbytes */
5365 MBEDTLS_SSL_VERSION_TLS1_2, /* (D)TLS 1.2 is forced */
5366 ssl->conf->endpoint,
5367 ssl);
5368 if (ret != 0) {
5369 return ret;
5370 }
Jerry Yu840fbb22022-02-17 14:59:29 +08005371#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005372 p += sizeof(ssl->transform->randbytes);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005373
5374#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
5375 /* Read connection IDs and store them */
Gilles Peskine449bd832023-01-11 14:50:10 +01005376 if ((size_t) (end - p) < 1) {
5377 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5378 }
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005379
5380 ssl->transform->in_cid_len = *p++;
5381
Gilles Peskine449bd832023-01-11 14:50:10 +01005382 if ((size_t) (end - p) < ssl->transform->in_cid_len + 1u) {
5383 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5384 }
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005385
Gilles Peskine449bd832023-01-11 14:50:10 +01005386 memcpy(ssl->transform->in_cid, p, ssl->transform->in_cid_len);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005387 p += ssl->transform->in_cid_len;
5388
5389 ssl->transform->out_cid_len = *p++;
5390
Gilles Peskine449bd832023-01-11 14:50:10 +01005391 if ((size_t) (end - p) < ssl->transform->out_cid_len) {
5392 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5393 }
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005394
Gilles Peskine449bd832023-01-11 14:50:10 +01005395 memcpy(ssl->transform->out_cid, p, ssl->transform->out_cid_len);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005396 p += ssl->transform->out_cid_len;
5397#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
5398
5399 /*
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005400 * Saved fields from top-level ssl_context structure
5401 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005402 if ((size_t) (end - p) < 4) {
5403 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5404 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005405
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01005406 ssl->badmac_seen = MBEDTLS_GET_UINT32_BE(p, 0);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005407 p += 4;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005408
5409#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Gilles Peskine449bd832023-01-11 14:50:10 +01005410 if ((size_t) (end - p) < 16) {
5411 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5412 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005413
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01005414 ssl->in_window_top = MBEDTLS_GET_UINT64_BE(p, 0);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005415 p += 8;
5416
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01005417 ssl->in_window = MBEDTLS_GET_UINT64_BE(p, 0);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005418 p += 8;
5419#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
5420
5421#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005422 if ((size_t) (end - p) < 1) {
5423 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5424 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005425
5426 ssl->disable_datagram_packing = *p++;
5427#endif /* MBEDTLS_SSL_PROTO_DTLS */
5428
Gilles Peskine449bd832023-01-11 14:50:10 +01005429 if ((size_t) (end - p) < sizeof(ssl->cur_out_ctr)) {
5430 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5431 }
5432 memcpy(ssl->cur_out_ctr, p, sizeof(ssl->cur_out_ctr));
5433 p += sizeof(ssl->cur_out_ctr);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005434
5435#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005436 if ((size_t) (end - p) < 2) {
5437 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5438 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005439
Dave Rodgmana3d0f612023-11-03 23:34:02 +00005440 ssl->mtu = MBEDTLS_GET_UINT16_BE(p, 0);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005441 p += 2;
5442#endif /* MBEDTLS_SSL_PROTO_DTLS */
5443
5444#if defined(MBEDTLS_SSL_ALPN)
5445 {
5446 uint8_t alpn_len;
5447 const char **cur;
5448
Gilles Peskine449bd832023-01-11 14:50:10 +01005449 if ((size_t) (end - p) < 1) {
5450 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5451 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005452
5453 alpn_len = *p++;
5454
Gilles Peskine449bd832023-01-11 14:50:10 +01005455 if (alpn_len != 0 && ssl->conf->alpn_list != NULL) {
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005456 /* alpn_chosen should point to an item in the configured list */
Gilles Peskine449bd832023-01-11 14:50:10 +01005457 for (cur = ssl->conf->alpn_list; *cur != NULL; cur++) {
5458 if (strlen(*cur) == alpn_len &&
Waleed Elmelegy131b2ff2024-03-14 01:39:39 +00005459 memcmp(p, *cur, alpn_len) == 0) {
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005460 ssl->alpn_chosen = *cur;
5461 break;
5462 }
5463 }
5464 }
5465
5466 /* can only happen on conf mismatch */
Gilles Peskine449bd832023-01-11 14:50:10 +01005467 if (alpn_len != 0 && ssl->alpn_chosen == NULL) {
5468 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5469 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005470
5471 p += alpn_len;
5472 }
5473#endif /* MBEDTLS_SSL_ALPN */
5474
5475 /*
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02005476 * Forced fields from top-level ssl_context structure
5477 *
5478 * Most of them already set to the correct value by mbedtls_ssl_init() and
5479 * mbedtls_ssl_reset(), so we only need to set the remaining ones.
5480 */
5481 ssl->state = MBEDTLS_SSL_HANDSHAKE_OVER;
Glenn Strauss60bfe602022-03-14 19:04:24 -04005482 ssl->tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02005483
Hanno Becker361b10d2019-08-30 10:42:49 +01005484 /* Adjust pointers for header fields of outgoing records to
5485 * the given transform, accounting for explicit IV and CID. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005486 mbedtls_ssl_update_out_pointers(ssl, ssl->transform);
Hanno Becker361b10d2019-08-30 10:42:49 +01005487
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02005488#if defined(MBEDTLS_SSL_PROTO_DTLS)
5489 ssl->in_epoch = 1;
5490#endif
5491
5492 /* mbedtls_ssl_reset() leaves the handshake sub-structure allocated,
5493 * which we don't want - otherwise we'd end up freeing the wrong transform
Hanno Beckerce5f5fd2020-02-05 10:47:44 +00005494 * by calling mbedtls_ssl_handshake_wrapup_free_hs_transform()
5495 * inappropriately. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005496 if (ssl->handshake != NULL) {
5497 mbedtls_ssl_handshake_free(ssl);
5498 mbedtls_free(ssl->handshake);
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02005499 ssl->handshake = NULL;
5500 }
5501
5502 /*
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005503 * Done - should have consumed entire buffer
5504 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005505 if (p != end) {
5506 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5507 }
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005508
Gilles Peskine449bd832023-01-11 14:50:10 +01005509 return 0;
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005510}
5511
5512/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02005513 * Deserialize context: public wrapper for error cleaning
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005514 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005515int mbedtls_ssl_context_load(mbedtls_ssl_context *context,
5516 const unsigned char *buf,
5517 size_t len)
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005518{
Gilles Peskine449bd832023-01-11 14:50:10 +01005519 int ret = ssl_context_load(context, buf, len);
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005520
Gilles Peskine449bd832023-01-11 14:50:10 +01005521 if (ret != 0) {
5522 mbedtls_ssl_free(context);
5523 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005524
Gilles Peskine449bd832023-01-11 14:50:10 +01005525 return ret;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005526}
Manuel Pégourié-Gonnard5c0e3772019-07-23 16:13:17 +02005527#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005528
5529/*
Paul Bakker5121ce52009-01-03 21:22:43 +00005530 * Free an SSL context
5531 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005532void mbedtls_ssl_free(mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00005533{
Gilles Peskine449bd832023-01-11 14:50:10 +01005534 if (ssl == NULL) {
Paul Bakkeraccaffe2014-06-26 13:37:14 +02005535 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01005536 }
Paul Bakkeraccaffe2014-06-26 13:37:14 +02005537
Gilles Peskine449bd832023-01-11 14:50:10 +01005538 MBEDTLS_SSL_DEBUG_MSG(2, ("=> free"));
Paul Bakker5121ce52009-01-03 21:22:43 +00005539
Gilles Peskine449bd832023-01-11 14:50:10 +01005540 if (ssl->out_buf != NULL) {
sander-visserb8aa2072020-05-06 22:05:13 +02005541#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
5542 size_t out_buf_len = ssl->out_buf_len;
5543#else
5544 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
5545#endif
5546
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005547 mbedtls_zeroize_and_free(ssl->out_buf, out_buf_len);
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05005548 ssl->out_buf = NULL;
Paul Bakker5121ce52009-01-03 21:22:43 +00005549 }
5550
Gilles Peskine449bd832023-01-11 14:50:10 +01005551 if (ssl->in_buf != NULL) {
sander-visserb8aa2072020-05-06 22:05:13 +02005552#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
5553 size_t in_buf_len = ssl->in_buf_len;
5554#else
5555 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
5556#endif
5557
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005558 mbedtls_zeroize_and_free(ssl->in_buf, in_buf_len);
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05005559 ssl->in_buf = NULL;
Paul Bakker5121ce52009-01-03 21:22:43 +00005560 }
5561
Gilles Peskine449bd832023-01-11 14:50:10 +01005562 if (ssl->transform) {
5563 mbedtls_ssl_transform_free(ssl->transform);
5564 mbedtls_free(ssl->transform);
Paul Bakker48916f92012-09-16 19:57:18 +00005565 }
5566
Gilles Peskine449bd832023-01-11 14:50:10 +01005567 if (ssl->handshake) {
5568 mbedtls_ssl_handshake_free(ssl);
5569 mbedtls_free(ssl->handshake);
Jerry Yu2e199812022-12-01 18:57:19 +08005570
5571#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005572 mbedtls_ssl_transform_free(ssl->transform_negotiate);
5573 mbedtls_free(ssl->transform_negotiate);
Jerry Yu2e199812022-12-01 18:57:19 +08005574#endif
5575
Gilles Peskine449bd832023-01-11 14:50:10 +01005576 mbedtls_ssl_session_free(ssl->session_negotiate);
5577 mbedtls_free(ssl->session_negotiate);
Paul Bakker48916f92012-09-16 19:57:18 +00005578 }
5579
Ronald Cron6f135e12021-12-08 16:57:54 +01005580#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01005581 mbedtls_ssl_transform_free(ssl->transform_application);
5582 mbedtls_free(ssl->transform_application);
Ronald Cron6f135e12021-12-08 16:57:54 +01005583#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker3aa186f2021-08-10 09:24:19 +01005584
Gilles Peskine449bd832023-01-11 14:50:10 +01005585 if (ssl->session) {
5586 mbedtls_ssl_session_free(ssl->session);
5587 mbedtls_free(ssl->session);
Paul Bakkerc0463502013-02-14 11:19:38 +01005588 }
5589
Manuel Pégourié-Gonnard55fab2d2015-05-11 16:15:19 +02005590#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005591 if (ssl->hostname != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005592 mbedtls_zeroize_and_free(ssl->hostname, strlen(ssl->hostname));
Paul Bakker5121ce52009-01-03 21:22:43 +00005593 }
Paul Bakker0be444a2013-08-27 21:55:01 +02005594#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00005595
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02005596#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005597 mbedtls_free(ssl->cli_id);
Manuel Pégourié-Gonnard43c02182014-07-22 17:32:01 +02005598#endif
5599
Gilles Peskine449bd832023-01-11 14:50:10 +01005600 MBEDTLS_SSL_DEBUG_MSG(2, ("<= free"));
Paul Bakker2da561c2009-02-05 18:00:28 +00005601
Paul Bakker86f04f42013-02-14 11:20:09 +01005602 /* Actually clear after last debug message */
Gilles Peskine449bd832023-01-11 14:50:10 +01005603 mbedtls_platform_zeroize(ssl, sizeof(mbedtls_ssl_context));
Paul Bakker5121ce52009-01-03 21:22:43 +00005604}
5605
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005606/*
Shaun Case8b0ecbc2021-12-20 21:14:10 -08005607 * Initialize mbedtls_ssl_config
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005608 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005609void mbedtls_ssl_config_init(mbedtls_ssl_config *conf)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005610{
Gilles Peskine449bd832023-01-11 14:50:10 +01005611 memset(conf, 0, sizeof(mbedtls_ssl_config));
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005612}
5613
Gilles Peskineae270bf2021-06-02 00:05:29 +02005614/* The selection should be the same as mbedtls_x509_crt_profile_default in
5615 * x509_crt.c, plus Montgomery curves for ECDHE. Here, the order matters:
Gilles Peskineb1940a72021-06-02 15:18:12 +02005616 * curves with a lower resource usage come first.
Gilles Peskineae270bf2021-06-02 00:05:29 +02005617 * See the documentation of mbedtls_ssl_conf_curves() for what we promise
Gilles Peskineb1940a72021-06-02 15:18:12 +02005618 * about this list.
5619 */
Chien Wong4e9683e2023-12-28 17:07:43 +08005620static const uint16_t ssl_preset_default_groups[] = {
Valerio Settidb6b4db2023-09-01 09:20:51 +02005621#if defined(MBEDTLS_ECP_HAVE_CURVE25519)
Brett Warrene0edc842021-08-17 09:53:13 +01005622 MBEDTLS_SSL_IANA_TLS_GROUP_X25519,
Gilles Peskineae270bf2021-06-02 00:05:29 +02005623#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005624#if defined(MBEDTLS_ECP_HAVE_SECP256R1)
Brett Warrene0edc842021-08-17 09:53:13 +01005625 MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1,
Gilles Peskineae270bf2021-06-02 00:05:29 +02005626#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005627#if defined(MBEDTLS_ECP_HAVE_SECP384R1)
Brett Warrene0edc842021-08-17 09:53:13 +01005628 MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02005629#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005630#if defined(MBEDTLS_ECP_HAVE_CURVE448)
Brett Warrene0edc842021-08-17 09:53:13 +01005631 MBEDTLS_SSL_IANA_TLS_GROUP_X448,
Gilles Peskineb1940a72021-06-02 15:18:12 +02005632#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005633#if defined(MBEDTLS_ECP_HAVE_SECP521R1)
Brett Warrene0edc842021-08-17 09:53:13 +01005634 MBEDTLS_SSL_IANA_TLS_GROUP_SECP521R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02005635#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005636#if defined(MBEDTLS_ECP_HAVE_BP256R1)
Brett Warrene0edc842021-08-17 09:53:13 +01005637 MBEDTLS_SSL_IANA_TLS_GROUP_BP256R1,
Gilles Peskineae270bf2021-06-02 00:05:29 +02005638#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005639#if defined(MBEDTLS_ECP_HAVE_BP384R1)
Brett Warrene0edc842021-08-17 09:53:13 +01005640 MBEDTLS_SSL_IANA_TLS_GROUP_BP384R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02005641#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005642#if defined(MBEDTLS_ECP_HAVE_BP512R1)
Brett Warrene0edc842021-08-17 09:53:13 +01005643 MBEDTLS_SSL_IANA_TLS_GROUP_BP512R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02005644#endif
Przemek Stekiel316c19e2023-05-31 15:25:11 +02005645#if defined(PSA_WANT_ALG_FFDH)
Przemek Stekiel383f4712022-12-12 14:48:57 +01005646 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE2048,
5647 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE3072,
5648 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE4096,
5649 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE6144,
5650 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE8192,
5651#endif
Brett Warrene0edc842021-08-17 09:53:13 +01005652 MBEDTLS_SSL_IANA_TLS_GROUP_NONE
Gilles Peskineae270bf2021-06-02 00:05:29 +02005653};
Gilles Peskineae270bf2021-06-02 00:05:29 +02005654
Alexey Tsvetkov2ca34372022-06-07 10:21:05 +03005655static const int ssl_preset_suiteb_ciphersuites[] = {
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005656 MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256,
5657 MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384,
5658 0
5659};
5660
Ronald Crone68ab4f2022-10-05 12:46:29 +02005661#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Hanno Becker9c6aa7b2021-08-10 13:50:43 +01005662
Jerry Yu909df7b2022-01-22 11:56:27 +08005663/* NOTICE:
Jerry Yu0b994b82022-01-25 17:22:12 +08005664 * For ssl_preset_*_sig_algs and ssl_tls12_preset_*_sig_algs, the following
Jerry Yu370e1462022-01-25 10:36:53 +08005665 * rules SHOULD be upheld.
5666 * - No duplicate entries.
5667 * - But if there is a good reason, do not change the order of the algorithms.
Jerry Yu09a99fc2022-07-28 14:22:17 +08005668 * - ssl_tls12_preset* is for TLS 1.2 use only.
Jerry Yu370e1462022-01-25 10:36:53 +08005669 * - ssl_preset_* is for TLS 1.3 only or hybrid TLS 1.3/1.2 handshakes.
Jerry Yu1a8b4812022-01-20 17:56:50 +08005670 */
Chien Wong4e9683e2023-12-28 17:07:43 +08005671static const uint16_t ssl_preset_default_sig_algs[] = {
Jerry Yu1a8b4812022-01-20 17:56:50 +08005672
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005673#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005674 defined(MBEDTLS_MD_CAN_SHA256) && \
Valerio Setticf29c5d2023-09-01 09:03:41 +02005675 defined(PSA_WANT_ECC_SECP_R1_256)
Jerry Yued5e9f42022-01-26 11:21:34 +08005676 MBEDTLS_TLS1_3_SIG_ECDSA_SECP256R1_SHA256,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005677 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256)
5678#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08005679
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005680#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005681 defined(MBEDTLS_MD_CAN_SHA384) && \
Valerio Setticf29c5d2023-09-01 09:03:41 +02005682 defined(PSA_WANT_ECC_SECP_R1_384)
Jerry Yu909df7b2022-01-22 11:56:27 +08005683 MBEDTLS_TLS1_3_SIG_ECDSA_SECP384R1_SHA384,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005684 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384)
5685#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08005686
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005687#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005688 defined(MBEDTLS_MD_CAN_SHA512) && \
Valerio Setticf29c5d2023-09-01 09:03:41 +02005689 defined(PSA_WANT_ECC_SECP_R1_521)
Jerry Yued5e9f42022-01-26 11:21:34 +08005690 MBEDTLS_TLS1_3_SIG_ECDSA_SECP521R1_SHA512,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005691 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA512)
5692#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08005693
Yanray Wang1136fad2023-11-22 16:54:31 +08005694#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && defined(MBEDTLS_MD_CAN_SHA512)
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005695 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA512,
Yanray Wang1136fad2023-11-22 16:54:31 +08005696#endif
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005697
Yanray Wang1136fad2023-11-22 16:54:31 +08005698#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && defined(MBEDTLS_MD_CAN_SHA384)
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005699 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA384,
Yanray Wang1136fad2023-11-22 16:54:31 +08005700#endif
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005701
Yanray Wang1136fad2023-11-22 16:54:31 +08005702#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && defined(MBEDTLS_MD_CAN_SHA256)
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005703 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256,
Yanray Wang1136fad2023-11-22 16:54:31 +08005704#endif
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005705
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005706#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_MD_CAN_SHA512)
Jerry Yu693a47a2022-06-23 14:02:28 +08005707 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA512,
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005708#endif /* MBEDTLS_RSA_C && MBEDTLS_MD_CAN_SHA512 */
Jerry Yu693a47a2022-06-23 14:02:28 +08005709
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005710#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_MD_CAN_SHA384)
Jerry Yu693a47a2022-06-23 14:02:28 +08005711 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA384,
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005712#endif /* MBEDTLS_RSA_C && MBEDTLS_MD_CAN_SHA384 */
Jerry Yu693a47a2022-06-23 14:02:28 +08005713
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005714#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_MD_CAN_SHA256)
Jerry Yu693a47a2022-06-23 14:02:28 +08005715 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA256,
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005716#endif /* MBEDTLS_RSA_C && MBEDTLS_MD_CAN_SHA256 */
Jerry Yu693a47a2022-06-23 14:02:28 +08005717
Gabor Mezei15b95a62022-05-09 16:37:58 +02005718 MBEDTLS_TLS_SIG_NONE
Jerry Yu909df7b2022-01-22 11:56:27 +08005719};
5720
5721/* NOTICE: see above */
5722#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
5723static uint16_t ssl_tls12_preset_default_sig_algs[] = {
Yanray Wang1136fad2023-11-22 16:54:31 +08005724
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005725#if defined(MBEDTLS_MD_CAN_SHA512)
Valerio Settie9646ec2023-08-02 20:02:28 +02005726#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005727 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA512),
Jerry Yu713013f2022-01-17 18:16:35 +08005728#endif
Jerry Yu09a99fc2022-07-28 14:22:17 +08005729#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT)
5730 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA512,
Yanray Wang1136fad2023-11-22 16:54:31 +08005731#endif
Gabor Mezeic1051b62022-05-10 13:13:58 +02005732#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005733 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA512),
Gabor Mezeic1051b62022-05-10 13:13:58 +02005734#endif
Yanray Wang1136fad2023-11-22 16:54:31 +08005735#endif /* MBEDTLS_MD_CAN_SHA512 */
5736
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005737#if defined(MBEDTLS_MD_CAN_SHA384)
Valerio Settie9646ec2023-08-02 20:02:28 +02005738#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005739 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384),
Jerry Yu11f0a9c2022-01-12 18:43:08 +08005740#endif
Jerry Yu09a99fc2022-07-28 14:22:17 +08005741#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT)
5742 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA384,
Yanray Wang1136fad2023-11-22 16:54:31 +08005743#endif
Gabor Mezeic1051b62022-05-10 13:13:58 +02005744#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005745 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA384),
Gabor Mezeic1051b62022-05-10 13:13:58 +02005746#endif
Yanray Wang1136fad2023-11-22 16:54:31 +08005747#endif /* MBEDTLS_MD_CAN_SHA384 */
5748
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005749#if defined(MBEDTLS_MD_CAN_SHA256)
Valerio Settie9646ec2023-08-02 20:02:28 +02005750#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005751 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256),
Jerry Yu11f0a9c2022-01-12 18:43:08 +08005752#endif
Jerry Yu09a99fc2022-07-28 14:22:17 +08005753#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT)
5754 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256,
Yanray Wang1136fad2023-11-22 16:54:31 +08005755#endif
Gabor Mezeic1051b62022-05-10 13:13:58 +02005756#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005757 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA256),
Gabor Mezeic1051b62022-05-10 13:13:58 +02005758#endif
Yanray Wang1136fad2023-11-22 16:54:31 +08005759#endif /* MBEDTLS_MD_CAN_SHA256 */
5760
Gabor Mezei15b95a62022-05-09 16:37:58 +02005761 MBEDTLS_TLS_SIG_NONE
Jerry Yu909df7b2022-01-22 11:56:27 +08005762};
5763#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Yanray Wang1136fad2023-11-22 16:54:31 +08005764
Jerry Yu909df7b2022-01-22 11:56:27 +08005765/* NOTICE: see above */
Chien Wong4e9683e2023-12-28 17:07:43 +08005766static const uint16_t ssl_preset_suiteb_sig_algs[] = {
Jerry Yu909df7b2022-01-22 11:56:27 +08005767
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005768#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Valerio Setti45d56f32023-07-13 17:23:20 +02005769 defined(MBEDTLS_MD_CAN_SHA256) && \
Valerio Settidb6b4db2023-09-01 09:20:51 +02005770 defined(MBEDTLS_ECP_HAVE_SECP256R1)
Jerry Yu909df7b2022-01-22 11:56:27 +08005771 MBEDTLS_TLS1_3_SIG_ECDSA_SECP256R1_SHA256,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005772 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256)
5773#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08005774
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005775#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Valerio Setti45d56f32023-07-13 17:23:20 +02005776 defined(MBEDTLS_MD_CAN_SHA384) && \
Valerio Settidb6b4db2023-09-01 09:20:51 +02005777 defined(MBEDTLS_ECP_HAVE_SECP384R1)
Jerry Yu53037892022-01-25 11:02:06 +08005778 MBEDTLS_TLS1_3_SIG_ECDSA_SECP384R1_SHA384,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005779 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384)
5780#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08005781
Gabor Mezei15b95a62022-05-09 16:37:58 +02005782 MBEDTLS_TLS_SIG_NONE
Jerry Yu713013f2022-01-17 18:16:35 +08005783};
Jerry Yu6106fdc2022-01-12 16:36:14 +08005784
Jerry Yu909df7b2022-01-22 11:56:27 +08005785/* NOTICE: see above */
5786#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
5787static uint16_t ssl_tls12_preset_suiteb_sig_algs[] = {
Yanray Wang1136fad2023-11-22 16:54:31 +08005788
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005789#if defined(MBEDTLS_MD_CAN_SHA256)
Valerio Settie9646ec2023-08-02 20:02:28 +02005790#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005791 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256),
Jerry Yu713013f2022-01-17 18:16:35 +08005792#endif
Yanray Wang1136fad2023-11-22 16:54:31 +08005793#endif /* MBEDTLS_MD_CAN_SHA256 */
Yanray Wang69ceb392023-11-22 16:32:39 +08005794
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005795#if defined(MBEDTLS_MD_CAN_SHA384)
Valerio Settie9646ec2023-08-02 20:02:28 +02005796#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005797 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384),
Jerry Yu18c833e2022-01-25 10:55:47 +08005798#endif
Yanray Wang1136fad2023-11-22 16:54:31 +08005799#endif /* MBEDTLS_MD_CAN_SHA384 */
5800
Gabor Mezei15b95a62022-05-09 16:37:58 +02005801 MBEDTLS_TLS_SIG_NONE
Hanno Becker9c6aa7b2021-08-10 13:50:43 +01005802};
Jerry Yu909df7b2022-01-22 11:56:27 +08005803#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
5804
Ronald Crone68ab4f2022-10-05 12:46:29 +02005805#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005806
Chien Wong4e9683e2023-12-28 17:07:43 +08005807static const uint16_t ssl_preset_suiteb_groups[] = {
Valerio Settidb6b4db2023-09-01 09:20:51 +02005808#if defined(MBEDTLS_ECP_HAVE_SECP256R1)
Brett Warrene0edc842021-08-17 09:53:13 +01005809 MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1,
Jaeden Amerod4311042019-06-03 08:27:16 +01005810#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005811#if defined(MBEDTLS_ECP_HAVE_SECP384R1)
Brett Warrene0edc842021-08-17 09:53:13 +01005812 MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1,
Jaeden Amerod4311042019-06-03 08:27:16 +01005813#endif
Brett Warrene0edc842021-08-17 09:53:13 +01005814 MBEDTLS_SSL_IANA_TLS_GROUP_NONE
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005815};
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005816
Ronald Crone68ab4f2022-10-05 12:46:29 +02005817#if defined(MBEDTLS_DEBUG_C) && defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu909df7b2022-01-22 11:56:27 +08005818/* Function for checking `ssl_preset_*_sig_algs` and `ssl_tls12_preset_*_sig_algs`
Jerry Yu370e1462022-01-25 10:36:53 +08005819 * to make sure there are no duplicated signature algorithm entries. */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005820MBEDTLS_CHECK_RETURN_CRITICAL
Chien Wong4e9683e2023-12-28 17:07:43 +08005821static int ssl_check_no_sig_alg_duplication(const uint16_t *sig_algs)
Jerry Yu1a8b4812022-01-20 17:56:50 +08005822{
5823 size_t i, j;
5824 int ret = 0;
Jerry Yu909df7b2022-01-22 11:56:27 +08005825
Gilles Peskine449bd832023-01-11 14:50:10 +01005826 for (i = 0; sig_algs[i] != MBEDTLS_TLS_SIG_NONE; i++) {
5827 for (j = 0; j < i; j++) {
5828 if (sig_algs[i] != sig_algs[j]) {
Jerry Yuf377d642022-01-25 10:43:59 +08005829 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01005830 }
5831 mbedtls_printf(" entry(%04x,%" MBEDTLS_PRINTF_SIZET
5832 ") is duplicated at %" MBEDTLS_PRINTF_SIZET "\n",
5833 sig_algs[i], j, i);
Jerry Yuf377d642022-01-25 10:43:59 +08005834 ret = -1;
Jerry Yu1a8b4812022-01-20 17:56:50 +08005835 }
5836 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005837 return ret;
Jerry Yu1a8b4812022-01-20 17:56:50 +08005838}
5839
Ronald Crone68ab4f2022-10-05 12:46:29 +02005840#endif /* MBEDTLS_DEBUG_C && MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Jerry Yu1a8b4812022-01-20 17:56:50 +08005841
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005842/*
Tillmann Karras588ad502015-09-25 04:27:22 +02005843 * Load default in mbedtls_ssl_config
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005844 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005845int mbedtls_ssl_config_defaults(mbedtls_ssl_config *conf,
5846 int endpoint, int transport, int preset)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005847{
Manuel Pégourié-Gonnard8b431fb2015-05-11 12:54:52 +02005848#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Janos Follath865b3eb2019-12-16 11:46:15 +00005849 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard8b431fb2015-05-11 12:54:52 +02005850#endif
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005851
Ronald Crone68ab4f2022-10-05 12:46:29 +02005852#if defined(MBEDTLS_DEBUG_C) && defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005853 if (ssl_check_no_sig_alg_duplication(ssl_preset_suiteb_sig_algs)) {
5854 mbedtls_printf("ssl_preset_suiteb_sig_algs has duplicated entries\n");
5855 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu1a8b4812022-01-20 17:56:50 +08005856 }
5857
Gilles Peskine449bd832023-01-11 14:50:10 +01005858 if (ssl_check_no_sig_alg_duplication(ssl_preset_default_sig_algs)) {
5859 mbedtls_printf("ssl_preset_default_sig_algs has duplicated entries\n");
5860 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu1a8b4812022-01-20 17:56:50 +08005861 }
Jerry Yu909df7b2022-01-22 11:56:27 +08005862
5863#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005864 if (ssl_check_no_sig_alg_duplication(ssl_tls12_preset_suiteb_sig_algs)) {
5865 mbedtls_printf("ssl_tls12_preset_suiteb_sig_algs has duplicated entries\n");
5866 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu909df7b2022-01-22 11:56:27 +08005867 }
5868
Gilles Peskine449bd832023-01-11 14:50:10 +01005869 if (ssl_check_no_sig_alg_duplication(ssl_tls12_preset_default_sig_algs)) {
5870 mbedtls_printf("ssl_tls12_preset_default_sig_algs has duplicated entries\n");
5871 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu909df7b2022-01-22 11:56:27 +08005872 }
5873#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Ronald Crone68ab4f2022-10-05 12:46:29 +02005874#endif /* MBEDTLS_DEBUG_C && MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Jerry Yu1a8b4812022-01-20 17:56:50 +08005875
Manuel Pégourié-Gonnard0de074f2015-05-14 12:58:01 +02005876 /* Use the functions here so that they are covered in tests,
5877 * but otherwise access member directly for efficiency */
Gilles Peskine449bd832023-01-11 14:50:10 +01005878 mbedtls_ssl_conf_endpoint(conf, endpoint);
5879 mbedtls_ssl_conf_transport(conf, transport);
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005880
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005881 /*
5882 * Things that are common to all presets
5883 */
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02005884#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005885 if (endpoint == MBEDTLS_SSL_IS_CLIENT) {
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02005886 conf->authmode = MBEDTLS_SSL_VERIFY_REQUIRED;
5887#if defined(MBEDTLS_SSL_SESSION_TICKETS)
5888 conf->session_tickets = MBEDTLS_SSL_SESSION_TICKETS_ENABLED;
Ronald Cronbedddd72024-08-27 14:18:50 +02005889#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
5890 conf->new_session_tickets_enabled = MBEDTLS_SSL_ENABLE_NEW_SESSION_TICKETS_DISABLED;
5891#endif
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02005892#endif
5893 }
5894#endif
5895
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005896#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
5897 conf->encrypt_then_mac = MBEDTLS_SSL_ETM_ENABLED;
5898#endif
5899
5900#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
5901 conf->extended_ms = MBEDTLS_SSL_EXTENDED_MS_ENABLED;
5902#endif
5903
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02005904#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005905 conf->f_cookie_write = ssl_cookie_write_dummy;
5906 conf->f_cookie_check = ssl_cookie_check_dummy;
5907#endif
5908
5909#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
5910 conf->anti_replay = MBEDTLS_SSL_ANTI_REPLAY_ENABLED;
5911#endif
5912
Janos Follath088ce432017-04-10 12:42:31 +01005913#if defined(MBEDTLS_SSL_SRV_C)
5914 conf->cert_req_ca_list = MBEDTLS_SSL_CERT_REQ_CA_LIST_ENABLED;
TRodziewicz3946f792021-06-14 12:11:18 +02005915 conf->respect_cli_pref = MBEDTLS_SSL_SRV_CIPHERSUITE_ORDER_SERVER;
Janos Follath088ce432017-04-10 12:42:31 +01005916#endif
5917
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005918#if defined(MBEDTLS_SSL_PROTO_DTLS)
5919 conf->hs_timeout_min = MBEDTLS_SSL_DTLS_TIMEOUT_DFL_MIN;
5920 conf->hs_timeout_max = MBEDTLS_SSL_DTLS_TIMEOUT_DFL_MAX;
5921#endif
5922
5923#if defined(MBEDTLS_SSL_RENEGOTIATION)
5924 conf->renego_max_records = MBEDTLS_SSL_RENEGO_MAX_RECORDS_DEFAULT;
Gilles Peskine449bd832023-01-11 14:50:10 +01005925 memset(conf->renego_period, 0x00, 2);
5926 memset(conf->renego_period + 2, 0xFF, 6);
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005927#endif
5928
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005929#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005930 if (endpoint == MBEDTLS_SSL_IS_SERVER) {
Hanno Beckere2defad2021-07-24 05:59:17 +01005931 const unsigned char dhm_p[] =
5932 MBEDTLS_DHM_RFC3526_MODP_2048_P_BIN;
5933 const unsigned char dhm_g[] =
5934 MBEDTLS_DHM_RFC3526_MODP_2048_G_BIN;
Hanno Becker00d0a682017-10-04 13:14:29 +01005935
Gilles Peskine449bd832023-01-11 14:50:10 +01005936 if ((ret = mbedtls_ssl_conf_dh_param_bin(conf,
5937 dhm_p, sizeof(dhm_p),
5938 dhm_g, sizeof(dhm_g))) != 0) {
5939 return ret;
Hanno Beckere2defad2021-07-24 05:59:17 +01005940 }
5941 }
Manuel Pégourié-Gonnardbd990d62015-06-11 14:49:42 +02005942#endif
5943
Ronald Cron6f135e12021-12-08 16:57:54 +01005944#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yu6ee56aa2022-12-06 17:47:22 +08005945
5946#if defined(MBEDTLS_SSL_EARLY_DATA)
Yanray Wangd5ed36f2023-11-07 11:40:43 +08005947 mbedtls_ssl_conf_early_data(conf, MBEDTLS_SSL_EARLY_DATA_DISABLED);
Jerry Yu6ee56aa2022-12-06 17:47:22 +08005948#if defined(MBEDTLS_SSL_SRV_C)
Yanray Wang07517612023-11-07 11:47:36 +08005949 mbedtls_ssl_conf_max_early_data_size(conf, MBEDTLS_SSL_MAX_EARLY_DATA_SIZE);
Jerry Yu6ee56aa2022-12-06 17:47:22 +08005950#endif
5951#endif /* MBEDTLS_SSL_EARLY_DATA */
5952
Jerry Yud0766ec2022-09-22 10:46:57 +08005953#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Jerry Yu1ad7ace2022-08-09 13:28:39 +08005954 mbedtls_ssl_conf_new_session_tickets(
Gilles Peskine449bd832023-01-11 14:50:10 +01005955 conf, MBEDTLS_SSL_TLS1_3_DEFAULT_NEW_SESSION_TICKETS);
Jerry Yu1ad7ace2022-08-09 13:28:39 +08005956#endif
Hanno Becker71f1ed62021-07-24 06:01:47 +01005957 /*
5958 * Allow all TLS 1.3 key exchange modes by default.
5959 */
Xiaofei Bai746f9482021-11-12 08:53:56 +00005960 conf->tls13_kex_modes = MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_ALL;
Ronald Cron6f135e12021-12-08 16:57:54 +01005961#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker71f1ed62021-07-24 06:01:47 +01005962
Gilles Peskine449bd832023-01-11 14:50:10 +01005963 if (transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Glenn Strauss2dfcea22022-03-14 17:26:42 -04005964#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
XiaokangQian4d3a6042022-04-21 13:46:17 +00005965 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
XiaokangQian060d8672022-04-21 09:24:56 +00005966 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
XiaokangQian4d3a6042022-04-21 13:46:17 +00005967#else
Gilles Peskine449bd832023-01-11 14:50:10 +01005968 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
XiaokangQian060d8672022-04-21 09:24:56 +00005969#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01005970 } else {
XiaokangQian4d3a6042022-04-21 13:46:17 +00005971#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
Ronald Cron097ba142023-03-08 16:18:00 +01005972 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
5973 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
XiaokangQian4d3a6042022-04-21 13:46:17 +00005974#elif defined(MBEDTLS_SSL_PROTO_TLS1_3)
5975 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
5976 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
5977#elif defined(MBEDTLS_SSL_PROTO_TLS1_2)
5978 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
5979 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
5980#else
Gilles Peskine449bd832023-01-11 14:50:10 +01005981 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
XiaokangQian4d3a6042022-04-21 13:46:17 +00005982#endif
5983 }
Glenn Strauss2dfcea22022-03-14 17:26:42 -04005984
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005985 /*
5986 * Preset-specific defaults
5987 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005988 switch (preset) {
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005989 /*
5990 * NSA Suite B
5991 */
5992 case MBEDTLS_SSL_PRESET_SUITEB:
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005993
Hanno Beckerd60b6c62021-04-29 12:04:11 +01005994 conf->ciphersuite_list = ssl_preset_suiteb_ciphersuites;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005995
5996#if defined(MBEDTLS_X509_CRT_PARSE_C)
5997 conf->cert_profile = &mbedtls_x509_crt_profile_suiteb;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005998#endif
5999
Ronald Crone68ab4f2022-10-05 12:46:29 +02006000#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu909df7b2022-01-22 11:56:27 +08006001#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01006002 if (mbedtls_ssl_conf_is_tls12_only(conf)) {
Jerry Yu909df7b2022-01-22 11:56:27 +08006003 conf->sig_algs = ssl_tls12_preset_suiteb_sig_algs;
Gilles Peskine449bd832023-01-11 14:50:10 +01006004 } else
Jerry Yu909df7b2022-01-22 11:56:27 +08006005#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006006 conf->sig_algs = ssl_preset_suiteb_sig_algs;
Ronald Crone68ab4f2022-10-05 12:46:29 +02006007#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02006008
Manuel Pégourié-Gonnardf07ce3b2023-09-22 11:53:41 +02006009#if defined(MBEDTLS_ECP_C) && !defined(MBEDTLS_DEPRECATED_REMOVED)
Brett Warrene0edc842021-08-17 09:53:13 +01006010 conf->curve_list = NULL;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02006011#endif
Brett Warrene0edc842021-08-17 09:53:13 +01006012 conf->group_list = ssl_preset_suiteb_groups;
Manuel Pégourié-Gonnardc98204e2015-08-11 04:21:01 +02006013 break;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02006014
6015 /*
6016 * Default
6017 */
6018 default:
Ronald Cronf6606552022-03-15 11:23:25 +01006019
Hanno Beckerd60b6c62021-04-29 12:04:11 +01006020 conf->ciphersuite_list = mbedtls_ssl_list_ciphersuites();
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02006021
6022#if defined(MBEDTLS_X509_CRT_PARSE_C)
6023 conf->cert_profile = &mbedtls_x509_crt_profile_default;
6024#endif
6025
Ronald Crone68ab4f2022-10-05 12:46:29 +02006026#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu909df7b2022-01-22 11:56:27 +08006027#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01006028 if (mbedtls_ssl_conf_is_tls12_only(conf)) {
Jerry Yu909df7b2022-01-22 11:56:27 +08006029 conf->sig_algs = ssl_tls12_preset_default_sig_algs;
Gilles Peskine449bd832023-01-11 14:50:10 +01006030 } else
Jerry Yu909df7b2022-01-22 11:56:27 +08006031#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006032 conf->sig_algs = ssl_preset_default_sig_algs;
Ronald Crone68ab4f2022-10-05 12:46:29 +02006033#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02006034
Manuel Pégourié-Gonnardf07ce3b2023-09-22 11:53:41 +02006035#if defined(MBEDTLS_ECP_C) && !defined(MBEDTLS_DEPRECATED_REMOVED)
Brett Warrene0edc842021-08-17 09:53:13 +01006036 conf->curve_list = NULL;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02006037#endif
Brett Warrene0edc842021-08-17 09:53:13 +01006038 conf->group_list = ssl_preset_default_groups;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02006039
6040#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_CLI_C)
6041 conf->dhm_min_bitlen = 1024;
6042#endif
6043 }
6044
Gilles Peskine449bd832023-01-11 14:50:10 +01006045 return 0;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02006046}
6047
6048/*
6049 * Free mbedtls_ssl_config
6050 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006051void mbedtls_ssl_config_free(mbedtls_ssl_config *conf)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02006052{
Troy-Butlerda73abc2024-04-02 13:37:31 -04006053 if (conf == NULL) {
6054 return;
6055 }
6056
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02006057#if defined(MBEDTLS_DHM_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01006058 mbedtls_mpi_free(&conf->dhm_P);
6059 mbedtls_mpi_free(&conf->dhm_G);
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02006060#endif
6061
Ronald Cron73fe8df2022-10-05 14:31:43 +02006062#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED)
Neil Armstrong501c9322022-05-03 09:35:09 +02006063#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01006064 if (!mbedtls_svc_key_id_is_null(conf->psk_opaque)) {
Neil Armstrong501c9322022-05-03 09:35:09 +02006065 conf->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
6066 }
Neil Armstrong8ecd6682022-05-05 11:40:35 +02006067#endif /* MBEDTLS_USE_PSA_CRYPTO */
Gilles Peskine449bd832023-01-11 14:50:10 +01006068 if (conf->psk != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01006069 mbedtls_zeroize_and_free(conf->psk, conf->psk_len);
Azim Khan27e8a122018-03-21 14:24:11 +00006070 conf->psk = NULL;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02006071 conf->psk_len = 0;
junyeonLEE316b1622017-12-20 16:29:30 +09006072 }
6073
Gilles Peskine449bd832023-01-11 14:50:10 +01006074 if (conf->psk_identity != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01006075 mbedtls_zeroize_and_free(conf->psk_identity, conf->psk_identity_len);
Azim Khan27e8a122018-03-21 14:24:11 +00006076 conf->psk_identity = NULL;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02006077 conf->psk_identity_len = 0;
6078 }
Ronald Cron73fe8df2022-10-05 14:31:43 +02006079#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED */
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02006080
6081#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01006082 ssl_key_cert_free(conf->key_cert);
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02006083#endif
6084
Gilles Peskine449bd832023-01-11 14:50:10 +01006085 mbedtls_platform_zeroize(conf, sizeof(mbedtls_ssl_config));
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02006086}
6087
Manuel Pégourié-Gonnard5674a972015-10-19 15:14:03 +02006088#if defined(MBEDTLS_PK_C) && \
Valerio Settie9646ec2023-08-02 20:02:28 +02006089 (defined(MBEDTLS_RSA_C) || defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED))
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02006090/*
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006091 * Convert between MBEDTLS_PK_XXX and SSL_SIG_XXX
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02006092 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006093unsigned char mbedtls_ssl_sig_from_pk(mbedtls_pk_context *pk)
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02006094{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006095#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01006096 if (mbedtls_pk_can_do(pk, MBEDTLS_PK_RSA)) {
6097 return MBEDTLS_SSL_SIG_RSA;
6098 }
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02006099#endif
Valerio Settie9646ec2023-08-02 20:02:28 +02006100#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01006101 if (mbedtls_pk_can_do(pk, MBEDTLS_PK_ECDSA)) {
6102 return MBEDTLS_SSL_SIG_ECDSA;
6103 }
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02006104#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01006105 return MBEDTLS_SSL_SIG_ANON;
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02006106}
6107
Gilles Peskine449bd832023-01-11 14:50:10 +01006108unsigned char mbedtls_ssl_sig_from_pk_alg(mbedtls_pk_type_t type)
Hanno Becker7e5437a2017-04-28 17:15:26 +01006109{
Gilles Peskine449bd832023-01-11 14:50:10 +01006110 switch (type) {
Hanno Becker7e5437a2017-04-28 17:15:26 +01006111 case MBEDTLS_PK_RSA:
Gilles Peskine449bd832023-01-11 14:50:10 +01006112 return MBEDTLS_SSL_SIG_RSA;
Hanno Becker7e5437a2017-04-28 17:15:26 +01006113 case MBEDTLS_PK_ECDSA:
6114 case MBEDTLS_PK_ECKEY:
Gilles Peskine449bd832023-01-11 14:50:10 +01006115 return MBEDTLS_SSL_SIG_ECDSA;
Hanno Becker7e5437a2017-04-28 17:15:26 +01006116 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006117 return MBEDTLS_SSL_SIG_ANON;
Hanno Becker7e5437a2017-04-28 17:15:26 +01006118 }
6119}
6120
Gilles Peskine449bd832023-01-11 14:50:10 +01006121mbedtls_pk_type_t mbedtls_ssl_pk_alg_from_sig(unsigned char sig)
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02006122{
Gilles Peskine449bd832023-01-11 14:50:10 +01006123 switch (sig) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006124#if defined(MBEDTLS_RSA_C)
6125 case MBEDTLS_SSL_SIG_RSA:
Gilles Peskine449bd832023-01-11 14:50:10 +01006126 return MBEDTLS_PK_RSA;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02006127#endif
Valerio Settie9646ec2023-08-02 20:02:28 +02006128#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006129 case MBEDTLS_SSL_SIG_ECDSA:
Gilles Peskine449bd832023-01-11 14:50:10 +01006130 return MBEDTLS_PK_ECDSA;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02006131#endif
6132 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006133 return MBEDTLS_PK_NONE;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02006134 }
6135}
Valerio Settie9646ec2023-08-02 20:02:28 +02006136#endif /* MBEDTLS_PK_C &&
6137 ( MBEDTLS_RSA_C || MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED ) */
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02006138
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02006139/*
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006140 * Convert from MBEDTLS_SSL_HASH_XXX to MBEDTLS_MD_XXX
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02006141 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006142mbedtls_md_type_t mbedtls_ssl_md_alg_from_hash(unsigned char hash)
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02006143{
Gilles Peskine449bd832023-01-11 14:50:10 +01006144 switch (hash) {
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006145#if defined(MBEDTLS_MD_CAN_MD5)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006146 case MBEDTLS_SSL_HASH_MD5:
Gilles Peskine449bd832023-01-11 14:50:10 +01006147 return MBEDTLS_MD_MD5;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02006148#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006149#if defined(MBEDTLS_MD_CAN_SHA1)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006150 case MBEDTLS_SSL_HASH_SHA1:
Gilles Peskine449bd832023-01-11 14:50:10 +01006151 return MBEDTLS_MD_SHA1;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02006152#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006153#if defined(MBEDTLS_MD_CAN_SHA224)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006154 case MBEDTLS_SSL_HASH_SHA224:
Gilles Peskine449bd832023-01-11 14:50:10 +01006155 return MBEDTLS_MD_SHA224;
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02006156#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006157#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006158 case MBEDTLS_SSL_HASH_SHA256:
Gilles Peskine449bd832023-01-11 14:50:10 +01006159 return MBEDTLS_MD_SHA256;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02006160#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006161#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006162 case MBEDTLS_SSL_HASH_SHA384:
Gilles Peskine449bd832023-01-11 14:50:10 +01006163 return MBEDTLS_MD_SHA384;
Mateusz Starzyk3352a532021-04-06 14:28:22 +02006164#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006165#if defined(MBEDTLS_MD_CAN_SHA512)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006166 case MBEDTLS_SSL_HASH_SHA512:
Gilles Peskine449bd832023-01-11 14:50:10 +01006167 return MBEDTLS_MD_SHA512;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02006168#endif
6169 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006170 return MBEDTLS_MD_NONE;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02006171 }
6172}
6173
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006174/*
6175 * Convert from MBEDTLS_MD_XXX to MBEDTLS_SSL_HASH_XXX
6176 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006177unsigned char mbedtls_ssl_hash_from_md_alg(int md)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006178{
Gilles Peskine449bd832023-01-11 14:50:10 +01006179 switch (md) {
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006180#if defined(MBEDTLS_MD_CAN_MD5)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006181 case MBEDTLS_MD_MD5:
Gilles Peskine449bd832023-01-11 14:50:10 +01006182 return MBEDTLS_SSL_HASH_MD5;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006183#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006184#if defined(MBEDTLS_MD_CAN_SHA1)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006185 case MBEDTLS_MD_SHA1:
Gilles Peskine449bd832023-01-11 14:50:10 +01006186 return MBEDTLS_SSL_HASH_SHA1;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006187#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006188#if defined(MBEDTLS_MD_CAN_SHA224)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006189 case MBEDTLS_MD_SHA224:
Gilles Peskine449bd832023-01-11 14:50:10 +01006190 return MBEDTLS_SSL_HASH_SHA224;
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02006191#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006192#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006193 case MBEDTLS_MD_SHA256:
Gilles Peskine449bd832023-01-11 14:50:10 +01006194 return MBEDTLS_SSL_HASH_SHA256;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006195#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006196#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006197 case MBEDTLS_MD_SHA384:
Gilles Peskine449bd832023-01-11 14:50:10 +01006198 return MBEDTLS_SSL_HASH_SHA384;
Mateusz Starzyk3352a532021-04-06 14:28:22 +02006199#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006200#if defined(MBEDTLS_MD_CAN_SHA512)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006201 case MBEDTLS_MD_SHA512:
Gilles Peskine449bd832023-01-11 14:50:10 +01006202 return MBEDTLS_SSL_HASH_SHA512;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006203#endif
6204 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006205 return MBEDTLS_SSL_HASH_NONE;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006206 }
6207}
6208
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01006209/*
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006210 * Check if a curve proposed by the peer is in our list.
Manuel Pégourié-Gonnard9d412d82015-06-17 12:10:46 +02006211 * Return 0 if we're willing to use it, -1 otherwise.
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01006212 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006213int mbedtls_ssl_check_curve_tls_id(const mbedtls_ssl_context *ssl, uint16_t tls_id)
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01006214{
Gilles Peskine449bd832023-01-11 14:50:10 +01006215 const uint16_t *group_list = mbedtls_ssl_get_groups(ssl);
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01006216
Gilles Peskine449bd832023-01-11 14:50:10 +01006217 if (group_list == NULL) {
6218 return -1;
Brett Warrene0edc842021-08-17 09:53:13 +01006219 }
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01006220
Gilles Peskine449bd832023-01-11 14:50:10 +01006221 for (; *group_list != 0; group_list++) {
6222 if (*group_list == tls_id) {
6223 return 0;
6224 }
6225 }
6226
6227 return -1;
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01006228}
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01006229
Valerio Setti49e69072023-06-27 17:27:51 +02006230#if defined(MBEDTLS_PK_HAVE_ECC_KEYS)
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01006231/*
6232 * Same as mbedtls_ssl_check_curve_tls_id() but with a mbedtls_ecp_group_id.
6233 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006234int mbedtls_ssl_check_curve(const mbedtls_ssl_context *ssl, mbedtls_ecp_group_id grp_id)
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01006235{
Gilles Peskine449bd832023-01-11 14:50:10 +01006236 uint16_t tls_id = mbedtls_ssl_get_tls_id_from_ecp_group_id(grp_id);
Leonid Rozenboim19e59732022-08-08 16:52:38 -07006237
Gilles Peskine449bd832023-01-11 14:50:10 +01006238 if (tls_id == 0) {
Leonid Rozenboim19e59732022-08-08 16:52:38 -07006239 return -1;
Gilles Peskine449bd832023-01-11 14:50:10 +01006240 }
Leonid Rozenboim19e59732022-08-08 16:52:38 -07006241
Gilles Peskine449bd832023-01-11 14:50:10 +01006242 return mbedtls_ssl_check_curve_tls_id(ssl, tls_id);
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01006243}
Valerio Setti49e69072023-06-27 17:27:51 +02006244#endif /* MBEDTLS_PK_HAVE_ECC_KEYS */
Valerio Setti67419f02023-01-04 16:12:42 +01006245
Valerio Setti18c9fed2022-12-30 17:44:24 +01006246static const struct {
6247 uint16_t tls_id;
6248 mbedtls_ecp_group_id ecp_group_id;
6249 psa_ecc_family_t psa_family;
6250 uint16_t bits;
Valerio Setti18c9fed2022-12-30 17:44:24 +01006251} tls_id_match_table[] =
6252{
Valerio Settidb6b4db2023-09-01 09:20:51 +02006253#if defined(MBEDTLS_ECP_HAVE_SECP521R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02006254 { 25, MBEDTLS_ECP_DP_SECP521R1, PSA_ECC_FAMILY_SECP_R1, 521 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006255#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02006256#if defined(MBEDTLS_ECP_HAVE_BP512R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02006257 { 28, MBEDTLS_ECP_DP_BP512R1, PSA_ECC_FAMILY_BRAINPOOL_P_R1, 512 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006258#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02006259#if defined(MBEDTLS_ECP_HAVE_SECP384R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02006260 { 24, MBEDTLS_ECP_DP_SECP384R1, PSA_ECC_FAMILY_SECP_R1, 384 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006261#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02006262#if defined(MBEDTLS_ECP_HAVE_BP384R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02006263 { 27, MBEDTLS_ECP_DP_BP384R1, PSA_ECC_FAMILY_BRAINPOOL_P_R1, 384 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006264#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02006265#if defined(MBEDTLS_ECP_HAVE_SECP256R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02006266 { 23, MBEDTLS_ECP_DP_SECP256R1, PSA_ECC_FAMILY_SECP_R1, 256 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006267#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02006268#if defined(MBEDTLS_ECP_HAVE_SECP256K1)
Valerio Settiacd32c02023-06-29 18:06:29 +02006269 { 22, MBEDTLS_ECP_DP_SECP256K1, PSA_ECC_FAMILY_SECP_K1, 256 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006270#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02006271#if defined(MBEDTLS_ECP_HAVE_BP256R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02006272 { 26, MBEDTLS_ECP_DP_BP256R1, PSA_ECC_FAMILY_BRAINPOOL_P_R1, 256 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006273#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02006274#if defined(MBEDTLS_ECP_HAVE_SECP224R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02006275 { 21, MBEDTLS_ECP_DP_SECP224R1, PSA_ECC_FAMILY_SECP_R1, 224 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006276#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02006277#if defined(MBEDTLS_ECP_HAVE_SECP224K1)
Valerio Settiacd32c02023-06-29 18:06:29 +02006278 { 20, MBEDTLS_ECP_DP_SECP224K1, PSA_ECC_FAMILY_SECP_K1, 224 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006279#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02006280#if defined(MBEDTLS_ECP_HAVE_SECP192R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02006281 { 19, MBEDTLS_ECP_DP_SECP192R1, PSA_ECC_FAMILY_SECP_R1, 192 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006282#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02006283#if defined(MBEDTLS_ECP_HAVE_SECP192K1)
Valerio Settiacd32c02023-06-29 18:06:29 +02006284 { 18, MBEDTLS_ECP_DP_SECP192K1, PSA_ECC_FAMILY_SECP_K1, 192 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006285#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02006286#if defined(MBEDTLS_ECP_HAVE_CURVE25519)
Valerio Settiacd32c02023-06-29 18:06:29 +02006287 { 29, MBEDTLS_ECP_DP_CURVE25519, PSA_ECC_FAMILY_MONTGOMERY, 255 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006288#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02006289#if defined(MBEDTLS_ECP_HAVE_CURVE448)
Valerio Settiacd32c02023-06-29 18:06:29 +02006290 { 30, MBEDTLS_ECP_DP_CURVE448, PSA_ECC_FAMILY_MONTGOMERY, 448 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006291#endif
Valerio Settiacd32c02023-06-29 18:06:29 +02006292 { 0, MBEDTLS_ECP_DP_NONE, 0, 0 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006293};
6294
Gilles Peskine449bd832023-01-11 14:50:10 +01006295int mbedtls_ssl_get_psa_curve_info_from_tls_id(uint16_t tls_id,
Przemek Stekielda4fba62023-06-02 14:52:28 +02006296 psa_key_type_t *type,
Gilles Peskine449bd832023-01-11 14:50:10 +01006297 size_t *bits)
Valerio Setti18c9fed2022-12-30 17:44:24 +01006298{
Gilles Peskine449bd832023-01-11 14:50:10 +01006299 for (int i = 0; tls_id_match_table[i].tls_id != 0; i++) {
6300 if (tls_id_match_table[i].tls_id == tls_id) {
Przemek Stekielda4fba62023-06-02 14:52:28 +02006301 if (type != NULL) {
6302 *type = PSA_KEY_TYPE_ECC_KEY_PAIR(tls_id_match_table[i].psa_family);
Gilles Peskine449bd832023-01-11 14:50:10 +01006303 }
6304 if (bits != NULL) {
Valerio Setti18c9fed2022-12-30 17:44:24 +01006305 *bits = tls_id_match_table[i].bits;
Gilles Peskine449bd832023-01-11 14:50:10 +01006306 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01006307 return PSA_SUCCESS;
6308 }
6309 }
6310
6311 return PSA_ERROR_NOT_SUPPORTED;
6312}
6313
Gilles Peskine449bd832023-01-11 14:50:10 +01006314mbedtls_ecp_group_id mbedtls_ssl_get_ecp_group_id_from_tls_id(uint16_t tls_id)
Valerio Setti18c9fed2022-12-30 17:44:24 +01006315{
Gilles Peskine449bd832023-01-11 14:50:10 +01006316 for (int i = 0; tls_id_match_table[i].tls_id != 0; i++) {
6317 if (tls_id_match_table[i].tls_id == tls_id) {
Valerio Setti18c9fed2022-12-30 17:44:24 +01006318 return tls_id_match_table[i].ecp_group_id;
Gilles Peskine449bd832023-01-11 14:50:10 +01006319 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01006320 }
6321
6322 return MBEDTLS_ECP_DP_NONE;
6323}
6324
Gilles Peskine449bd832023-01-11 14:50:10 +01006325uint16_t mbedtls_ssl_get_tls_id_from_ecp_group_id(mbedtls_ecp_group_id grp_id)
Valerio Setti18c9fed2022-12-30 17:44:24 +01006326{
Gilles Peskine449bd832023-01-11 14:50:10 +01006327 for (int i = 0; tls_id_match_table[i].ecp_group_id != MBEDTLS_ECP_DP_NONE;
6328 i++) {
6329 if (tls_id_match_table[i].ecp_group_id == grp_id) {
Valerio Setti18c9fed2022-12-30 17:44:24 +01006330 return tls_id_match_table[i].tls_id;
Gilles Peskine449bd832023-01-11 14:50:10 +01006331 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01006332 }
6333
6334 return 0;
6335}
6336
Valerio Setti67419f02023-01-04 16:12:42 +01006337#if defined(MBEDTLS_DEBUG_C)
Valerio Settiacd32c02023-06-29 18:06:29 +02006338static const struct {
6339 uint16_t tls_id;
6340 const char *name;
6341} tls_id_curve_name_table[] =
6342{
Valerio Setti54e23792023-07-07 10:49:27 +02006343 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP521R1, "secp521r1" },
6344 { MBEDTLS_SSL_IANA_TLS_GROUP_BP512R1, "brainpoolP512r1" },
6345 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1, "secp384r1" },
6346 { MBEDTLS_SSL_IANA_TLS_GROUP_BP384R1, "brainpoolP384r1" },
6347 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1, "secp256r1" },
6348 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP256K1, "secp256k1" },
6349 { MBEDTLS_SSL_IANA_TLS_GROUP_BP256R1, "brainpoolP256r1" },
6350 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP224R1, "secp224r1" },
6351 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP224K1, "secp224k1" },
6352 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP192R1, "secp192r1" },
6353 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP192K1, "secp192k1" },
6354 { MBEDTLS_SSL_IANA_TLS_GROUP_X25519, "x25519" },
6355 { MBEDTLS_SSL_IANA_TLS_GROUP_X448, "x448" },
Valerio Settiacd32c02023-06-29 18:06:29 +02006356 { 0, NULL },
6357};
6358
Gilles Peskine449bd832023-01-11 14:50:10 +01006359const char *mbedtls_ssl_get_curve_name_from_tls_id(uint16_t tls_id)
Valerio Setti18c9fed2022-12-30 17:44:24 +01006360{
Valerio Settiacd32c02023-06-29 18:06:29 +02006361 for (int i = 0; tls_id_curve_name_table[i].tls_id != 0; i++) {
6362 if (tls_id_curve_name_table[i].tls_id == tls_id) {
6363 return tls_id_curve_name_table[i].name;
Gilles Peskine449bd832023-01-11 14:50:10 +01006364 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01006365 }
6366
6367 return NULL;
6368}
Valerio Setti67419f02023-01-04 16:12:42 +01006369#endif
Valerio Setti18c9fed2022-12-30 17:44:24 +01006370
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006371#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01006372int mbedtls_ssl_check_cert_usage(const mbedtls_x509_crt *cert,
6373 const mbedtls_ssl_ciphersuite_t *ciphersuite,
6374 int cert_endpoint,
6375 uint32_t *flags)
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02006376{
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01006377 int ret = 0;
Dave Rodgmanc37ad442023-11-03 23:36:06 +00006378 unsigned int usage = 0;
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02006379 const char *ext_oid;
6380 size_t ext_len;
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02006381
Gilles Peskine449bd832023-01-11 14:50:10 +01006382 if (cert_endpoint == MBEDTLS_SSL_IS_SERVER) {
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02006383 /* Server part of the key exchange */
Gilles Peskine449bd832023-01-11 14:50:10 +01006384 switch (ciphersuite->key_exchange) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006385 case MBEDTLS_KEY_EXCHANGE_RSA:
6386 case MBEDTLS_KEY_EXCHANGE_RSA_PSK:
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01006387 usage = MBEDTLS_X509_KU_KEY_ENCIPHERMENT;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02006388 break;
6389
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006390 case MBEDTLS_KEY_EXCHANGE_DHE_RSA:
6391 case MBEDTLS_KEY_EXCHANGE_ECDHE_RSA:
6392 case MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA:
6393 usage = MBEDTLS_X509_KU_DIGITAL_SIGNATURE;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02006394 break;
6395
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006396 case MBEDTLS_KEY_EXCHANGE_ECDH_RSA:
6397 case MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA:
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01006398 usage = MBEDTLS_X509_KU_KEY_AGREEMENT;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02006399 break;
6400
6401 /* Don't use default: we want warnings when adding new values */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006402 case MBEDTLS_KEY_EXCHANGE_NONE:
6403 case MBEDTLS_KEY_EXCHANGE_PSK:
6404 case MBEDTLS_KEY_EXCHANGE_DHE_PSK:
6405 case MBEDTLS_KEY_EXCHANGE_ECDHE_PSK:
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +02006406 case MBEDTLS_KEY_EXCHANGE_ECJPAKE:
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02006407 usage = 0;
6408 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006409 } else {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006410 /* Client auth: we only implement rsa_sign and mbedtls_ecdsa_sign for now */
6411 usage = MBEDTLS_X509_KU_DIGITAL_SIGNATURE;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02006412 }
6413
Gilles Peskine449bd832023-01-11 14:50:10 +01006414 if (mbedtls_x509_crt_check_key_usage(cert, usage) != 0) {
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01006415 *flags |= MBEDTLS_X509_BADCERT_KEY_USAGE;
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01006416 ret = -1;
6417 }
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02006418
Gilles Peskine449bd832023-01-11 14:50:10 +01006419 if (cert_endpoint == MBEDTLS_SSL_IS_SERVER) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006420 ext_oid = MBEDTLS_OID_SERVER_AUTH;
Gilles Peskine449bd832023-01-11 14:50:10 +01006421 ext_len = MBEDTLS_OID_SIZE(MBEDTLS_OID_SERVER_AUTH);
6422 } else {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006423 ext_oid = MBEDTLS_OID_CLIENT_AUTH;
Gilles Peskine449bd832023-01-11 14:50:10 +01006424 ext_len = MBEDTLS_OID_SIZE(MBEDTLS_OID_CLIENT_AUTH);
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02006425 }
6426
Gilles Peskine449bd832023-01-11 14:50:10 +01006427 if (mbedtls_x509_crt_check_extended_key_usage(cert, ext_oid, ext_len) != 0) {
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01006428 *flags |= MBEDTLS_X509_BADCERT_EXT_KEY_USAGE;
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01006429 ret = -1;
6430 }
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02006431
Gilles Peskine449bd832023-01-11 14:50:10 +01006432 return ret;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02006433}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006434#endif /* MBEDTLS_X509_CRT_PARSE_C */
Manuel Pégourié-Gonnard3a306b92014-04-29 15:11:17 +02006435
Jerry Yu148165c2021-09-24 23:20:59 +08006436#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01006437int mbedtls_ssl_get_handshake_transcript(mbedtls_ssl_context *ssl,
6438 const mbedtls_md_type_t md,
6439 unsigned char *dst,
6440 size_t dst_len,
6441 size_t *olen)
Jerry Yu148165c2021-09-24 23:20:59 +08006442{
Ronald Cronf6893e12022-01-07 22:09:01 +01006443 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
6444 psa_hash_operation_t *hash_operation_to_clone;
6445 psa_hash_operation_t hash_operation = psa_hash_operation_init();
6446
Jerry Yu148165c2021-09-24 23:20:59 +08006447 *olen = 0;
Ronald Cronf6893e12022-01-07 22:09:01 +01006448
Gilles Peskine449bd832023-01-11 14:50:10 +01006449 switch (md) {
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006450#if defined(MBEDTLS_MD_CAN_SHA384)
Gilles Peskine449bd832023-01-11 14:50:10 +01006451 case MBEDTLS_MD_SHA384:
6452 hash_operation_to_clone = &ssl->handshake->fin_sha384_psa;
6453 break;
Ronald Cronf6893e12022-01-07 22:09:01 +01006454#endif
6455
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006456#if defined(MBEDTLS_MD_CAN_SHA256)
Gilles Peskine449bd832023-01-11 14:50:10 +01006457 case MBEDTLS_MD_SHA256:
6458 hash_operation_to_clone = &ssl->handshake->fin_sha256_psa;
6459 break;
Ronald Cronf6893e12022-01-07 22:09:01 +01006460#endif
6461
Gilles Peskine449bd832023-01-11 14:50:10 +01006462 default:
6463 goto exit;
6464 }
6465
6466 status = psa_hash_clone(hash_operation_to_clone, &hash_operation);
6467 if (status != PSA_SUCCESS) {
Ronald Cronf6893e12022-01-07 22:09:01 +01006468 goto exit;
6469 }
6470
Gilles Peskine449bd832023-01-11 14:50:10 +01006471 status = psa_hash_finish(&hash_operation, dst, dst_len, olen);
6472 if (status != PSA_SUCCESS) {
Ronald Cronf6893e12022-01-07 22:09:01 +01006473 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006474 }
Ronald Cronf6893e12022-01-07 22:09:01 +01006475
6476exit:
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006477#if !defined(MBEDTLS_MD_CAN_SHA384) && \
6478 !defined(MBEDTLS_MD_CAN_SHA256)
Andrzej Kurekeabeb302022-10-17 07:52:51 -04006479 (void) ssl;
6480#endif
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05006481 return PSA_TO_MBEDTLS_ERR(status);
Jerry Yu148165c2021-09-24 23:20:59 +08006482}
6483#else /* MBEDTLS_USE_PSA_CRYPTO */
6484
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006485#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006486MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006487static int ssl_get_handshake_transcript_sha384(mbedtls_ssl_context *ssl,
6488 unsigned char *dst,
6489 size_t dst_len,
6490 size_t *olen)
Jerry Yu24c0ec32021-09-09 14:21:07 +08006491{
Jerry Yu24c0ec32021-09-09 14:21:07 +08006492 int ret;
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01006493 mbedtls_md_context_t sha384;
Jerry Yu24c0ec32021-09-09 14:21:07 +08006494
Gilles Peskine449bd832023-01-11 14:50:10 +01006495 if (dst_len < 48) {
6496 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
6497 }
Jerry Yu24c0ec32021-09-09 14:21:07 +08006498
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01006499 mbedtls_md_init(&sha384);
6500 ret = mbedtls_md_setup(&sha384, mbedtls_md_info_from_type(MBEDTLS_MD_SHA384), 0);
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01006501 if (ret != 0) {
6502 goto exit;
6503 }
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01006504 ret = mbedtls_md_clone(&sha384, &ssl->handshake->fin_sha384);
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01006505 if (ret != 0) {
6506 goto exit;
6507 }
Jerry Yu24c0ec32021-09-09 14:21:07 +08006508
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01006509 if ((ret = mbedtls_md_finish(&sha384, dst)) != 0) {
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01006510 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_finish", ret);
Jerry Yu24c0ec32021-09-09 14:21:07 +08006511 goto exit;
6512 }
6513
6514 *olen = 48;
6515
6516exit:
6517
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01006518 mbedtls_md_free(&sha384);
Gilles Peskine449bd832023-01-11 14:50:10 +01006519 return ret;
Jerry Yu24c0ec32021-09-09 14:21:07 +08006520}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006521#endif /* MBEDTLS_MD_CAN_SHA384 */
Jerry Yu24c0ec32021-09-09 14:21:07 +08006522
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006523#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006524MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006525static int ssl_get_handshake_transcript_sha256(mbedtls_ssl_context *ssl,
6526 unsigned char *dst,
6527 size_t dst_len,
6528 size_t *olen)
Jerry Yu24c0ec32021-09-09 14:21:07 +08006529{
Jerry Yu24c0ec32021-09-09 14:21:07 +08006530 int ret;
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01006531 mbedtls_md_context_t sha256;
Jerry Yu24c0ec32021-09-09 14:21:07 +08006532
Gilles Peskine449bd832023-01-11 14:50:10 +01006533 if (dst_len < 32) {
6534 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
6535 }
Jerry Yu24c0ec32021-09-09 14:21:07 +08006536
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01006537 mbedtls_md_init(&sha256);
6538 ret = mbedtls_md_setup(&sha256, mbedtls_md_info_from_type(MBEDTLS_MD_SHA256), 0);
6539 if (ret != 0) {
6540 goto exit;
6541 }
6542 ret = mbedtls_md_clone(&sha256, &ssl->handshake->fin_sha256);
6543 if (ret != 0) {
6544 goto exit;
6545 }
Jerry Yuc5aef882021-12-23 20:15:02 +08006546
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01006547 if ((ret = mbedtls_md_finish(&sha256, dst)) != 0) {
6548 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_finish", ret);
Jerry Yu24c0ec32021-09-09 14:21:07 +08006549 goto exit;
6550 }
6551
6552 *olen = 32;
6553
6554exit:
6555
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01006556 mbedtls_md_free(&sha256);
Gilles Peskine449bd832023-01-11 14:50:10 +01006557 return ret;
Jerry Yu24c0ec32021-09-09 14:21:07 +08006558}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006559#endif /* MBEDTLS_MD_CAN_SHA256 */
Jerry Yu24c0ec32021-09-09 14:21:07 +08006560
Gilles Peskine449bd832023-01-11 14:50:10 +01006561int mbedtls_ssl_get_handshake_transcript(mbedtls_ssl_context *ssl,
6562 const mbedtls_md_type_t md,
6563 unsigned char *dst,
6564 size_t dst_len,
6565 size_t *olen)
Jerry Yu24c0ec32021-09-09 14:21:07 +08006566{
Gilles Peskine449bd832023-01-11 14:50:10 +01006567 switch (md) {
Jerry Yuc1ddeef2021-10-08 15:14:45 +08006568
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006569#if defined(MBEDTLS_MD_CAN_SHA384)
Gilles Peskine449bd832023-01-11 14:50:10 +01006570 case MBEDTLS_MD_SHA384:
6571 return ssl_get_handshake_transcript_sha384(ssl, dst, dst_len, olen);
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006572#endif /* MBEDTLS_MD_CAN_SHA384*/
Jerry Yuc1ddeef2021-10-08 15:14:45 +08006573
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006574#if defined(MBEDTLS_MD_CAN_SHA256)
Gilles Peskine449bd832023-01-11 14:50:10 +01006575 case MBEDTLS_MD_SHA256:
6576 return ssl_get_handshake_transcript_sha256(ssl, dst, dst_len, olen);
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006577#endif /* MBEDTLS_MD_CAN_SHA256*/
Jerry Yuc1ddeef2021-10-08 15:14:45 +08006578
Gilles Peskine449bd832023-01-11 14:50:10 +01006579 default:
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006580#if !defined(MBEDTLS_MD_CAN_SHA384) && \
6581 !defined(MBEDTLS_MD_CAN_SHA256)
Gilles Peskine449bd832023-01-11 14:50:10 +01006582 (void) ssl;
6583 (void) dst;
6584 (void) dst_len;
6585 (void) olen;
Andrzej Kurek409248a2022-10-24 10:33:21 -04006586#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01006587 break;
Jerry Yuc1ddeef2021-10-08 15:14:45 +08006588 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006589 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yu24c0ec32021-09-09 14:21:07 +08006590}
XiaokangQian647719a2021-12-07 09:16:29 +00006591
Jerry Yu148165c2021-09-24 23:20:59 +08006592#endif /* !MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu24c0ec32021-09-09 14:21:07 +08006593
Ronald Crone68ab4f2022-10-05 12:46:29 +02006594#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Gabor Mezei078e8032022-04-27 21:17:56 +02006595/* mbedtls_ssl_parse_sig_alg_ext()
6596 *
6597 * The `extension_data` field of signature algorithm contains a `SignatureSchemeList`
6598 * value (TLS 1.3 RFC8446):
6599 * enum {
6600 * ....
6601 * ecdsa_secp256r1_sha256( 0x0403 ),
6602 * ecdsa_secp384r1_sha384( 0x0503 ),
6603 * ecdsa_secp521r1_sha512( 0x0603 ),
6604 * ....
6605 * } SignatureScheme;
6606 *
6607 * struct {
6608 * SignatureScheme supported_signature_algorithms<2..2^16-2>;
6609 * } SignatureSchemeList;
6610 *
6611 * The `extension_data` field of signature algorithm contains a `SignatureAndHashAlgorithm`
6612 * value (TLS 1.2 RFC5246):
6613 * enum {
6614 * none(0), md5(1), sha1(2), sha224(3), sha256(4), sha384(5),
6615 * sha512(6), (255)
6616 * } HashAlgorithm;
6617 *
6618 * enum { anonymous(0), rsa(1), dsa(2), ecdsa(3), (255) }
6619 * SignatureAlgorithm;
6620 *
6621 * struct {
6622 * HashAlgorithm hash;
6623 * SignatureAlgorithm signature;
6624 * } SignatureAndHashAlgorithm;
6625 *
6626 * SignatureAndHashAlgorithm
6627 * supported_signature_algorithms<2..2^16-2>;
6628 *
6629 * The TLS 1.3 signature algorithm extension was defined to be a compatible
6630 * generalization of the TLS 1.2 signature algorithm extension.
6631 * `SignatureAndHashAlgorithm` field of TLS 1.2 can be represented by
6632 * `SignatureScheme` field of TLS 1.3
6633 *
6634 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006635int mbedtls_ssl_parse_sig_alg_ext(mbedtls_ssl_context *ssl,
6636 const unsigned char *buf,
6637 const unsigned char *end)
Gabor Mezei078e8032022-04-27 21:17:56 +02006638{
6639 const unsigned char *p = buf;
6640 size_t supported_sig_algs_len = 0;
6641 const unsigned char *supported_sig_algs_end;
6642 uint16_t sig_alg;
6643 uint32_t common_idx = 0;
6644
Gilles Peskine449bd832023-01-11 14:50:10 +01006645 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
6646 supported_sig_algs_len = MBEDTLS_GET_UINT16_BE(p, 0);
Gabor Mezei078e8032022-04-27 21:17:56 +02006647 p += 2;
6648
Gilles Peskine449bd832023-01-11 14:50:10 +01006649 memset(ssl->handshake->received_sig_algs, 0,
6650 sizeof(ssl->handshake->received_sig_algs));
Gabor Mezei078e8032022-04-27 21:17:56 +02006651
Gilles Peskine449bd832023-01-11 14:50:10 +01006652 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, supported_sig_algs_len);
Gabor Mezei078e8032022-04-27 21:17:56 +02006653 supported_sig_algs_end = p + supported_sig_algs_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01006654 while (p < supported_sig_algs_end) {
6655 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, supported_sig_algs_end, 2);
6656 sig_alg = MBEDTLS_GET_UINT16_BE(p, 0);
Gabor Mezei078e8032022-04-27 21:17:56 +02006657 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01006658 MBEDTLS_SSL_DEBUG_MSG(4, ("received signature algorithm: 0x%x %s",
6659 sig_alg,
6660 mbedtls_ssl_sig_alg_to_str(sig_alg)));
Jerry Yu2fe6c632022-06-29 10:02:38 +08006661#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01006662 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_2 &&
6663 (!(mbedtls_ssl_sig_alg_is_supported(ssl, sig_alg) &&
6664 mbedtls_ssl_sig_alg_is_offered(ssl, sig_alg)))) {
Gabor Mezei078e8032022-04-27 21:17:56 +02006665 continue;
Jerry Yu2fe6c632022-06-29 10:02:38 +08006666 }
6667#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gabor Mezei078e8032022-04-27 21:17:56 +02006668
Gilles Peskine449bd832023-01-11 14:50:10 +01006669 MBEDTLS_SSL_DEBUG_MSG(4, ("valid signature algorithm: %s",
6670 mbedtls_ssl_sig_alg_to_str(sig_alg)));
Gabor Mezei078e8032022-04-27 21:17:56 +02006671
Gilles Peskine449bd832023-01-11 14:50:10 +01006672 if (common_idx + 1 < MBEDTLS_RECEIVED_SIG_ALGS_SIZE) {
Gabor Mezei078e8032022-04-27 21:17:56 +02006673 ssl->handshake->received_sig_algs[common_idx] = sig_alg;
6674 common_idx += 1;
6675 }
6676 }
6677 /* Check that we consumed all the message. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006678 if (p != end) {
6679 MBEDTLS_SSL_DEBUG_MSG(1,
6680 ("Signature algorithms extension length misaligned"));
6681 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR,
6682 MBEDTLS_ERR_SSL_DECODE_ERROR);
6683 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Gabor Mezei078e8032022-04-27 21:17:56 +02006684 }
6685
Gilles Peskine449bd832023-01-11 14:50:10 +01006686 if (common_idx == 0) {
6687 MBEDTLS_SSL_DEBUG_MSG(3, ("no signature algorithm in common"));
6688 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE,
6689 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE);
6690 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Gabor Mezei078e8032022-04-27 21:17:56 +02006691 }
6692
Gabor Mezei15b95a62022-05-09 16:37:58 +02006693 ssl->handshake->received_sig_algs[common_idx] = MBEDTLS_TLS_SIG_NONE;
Gilles Peskine449bd832023-01-11 14:50:10 +01006694 return 0;
Gabor Mezei078e8032022-04-27 21:17:56 +02006695}
6696
Ronald Crone68ab4f2022-10-05 12:46:29 +02006697#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Gabor Mezei078e8032022-04-27 21:17:56 +02006698
Jerry Yudc7bd172022-02-17 13:44:15 +08006699#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
6700
6701#if defined(MBEDTLS_USE_PSA_CRYPTO)
6702
Gilles Peskine449bd832023-01-11 14:50:10 +01006703static psa_status_t setup_psa_key_derivation(psa_key_derivation_operation_t *derivation,
6704 mbedtls_svc_key_id_t key,
6705 psa_algorithm_t alg,
6706 const unsigned char *raw_psk, size_t raw_psk_length,
6707 const unsigned char *seed, size_t seed_length,
6708 const unsigned char *label, size_t label_length,
6709 const unsigned char *other_secret,
6710 size_t other_secret_length,
6711 size_t capacity)
Jerry Yudc7bd172022-02-17 13:44:15 +08006712{
6713 psa_status_t status;
6714
Gilles Peskine449bd832023-01-11 14:50:10 +01006715 status = psa_key_derivation_setup(derivation, alg);
6716 if (status != PSA_SUCCESS) {
6717 return status;
6718 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006719
Gilles Peskine449bd832023-01-11 14:50:10 +01006720 if (PSA_ALG_IS_TLS12_PRF(alg) || PSA_ALG_IS_TLS12_PSK_TO_MS(alg)) {
6721 status = psa_key_derivation_input_bytes(derivation,
6722 PSA_KEY_DERIVATION_INPUT_SEED,
6723 seed, seed_length);
6724 if (status != PSA_SUCCESS) {
6725 return status;
Przemek Stekiel1f027032022-04-05 17:12:11 +02006726 }
6727
Gilles Peskine449bd832023-01-11 14:50:10 +01006728 if (other_secret != NULL) {
6729 status = psa_key_derivation_input_bytes(derivation,
6730 PSA_KEY_DERIVATION_INPUT_OTHER_SECRET,
6731 other_secret, other_secret_length);
6732 if (status != PSA_SUCCESS) {
6733 return status;
6734 }
6735 }
6736
6737 if (mbedtls_svc_key_id_is_null(key)) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006738 status = psa_key_derivation_input_bytes(
6739 derivation, PSA_KEY_DERIVATION_INPUT_SECRET,
Gilles Peskine449bd832023-01-11 14:50:10 +01006740 raw_psk, raw_psk_length);
6741 } else {
Jerry Yudc7bd172022-02-17 13:44:15 +08006742 status = psa_key_derivation_input_key(
Gilles Peskine449bd832023-01-11 14:50:10 +01006743 derivation, PSA_KEY_DERIVATION_INPUT_SECRET, key);
Jerry Yudc7bd172022-02-17 13:44:15 +08006744 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006745 if (status != PSA_SUCCESS) {
6746 return status;
6747 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006748
Gilles Peskine449bd832023-01-11 14:50:10 +01006749 status = psa_key_derivation_input_bytes(derivation,
6750 PSA_KEY_DERIVATION_INPUT_LABEL,
6751 label, label_length);
6752 if (status != PSA_SUCCESS) {
6753 return status;
6754 }
6755 } else {
6756 return PSA_ERROR_NOT_SUPPORTED;
Jerry Yudc7bd172022-02-17 13:44:15 +08006757 }
6758
Gilles Peskine449bd832023-01-11 14:50:10 +01006759 status = psa_key_derivation_set_capacity(derivation, capacity);
6760 if (status != PSA_SUCCESS) {
6761 return status;
6762 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006763
Gilles Peskine449bd832023-01-11 14:50:10 +01006764 return PSA_SUCCESS;
Jerry Yudc7bd172022-02-17 13:44:15 +08006765}
6766
Andrzej Kurek57d10632022-10-24 10:32:01 -04006767#if defined(PSA_WANT_ALG_SHA_384) || \
6768 defined(PSA_WANT_ALG_SHA_256)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006769MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006770static int tls_prf_generic(mbedtls_md_type_t md_type,
6771 const unsigned char *secret, size_t slen,
6772 const char *label,
6773 const unsigned char *random, size_t rlen,
6774 unsigned char *dstbuf, size_t dlen)
Jerry Yudc7bd172022-02-17 13:44:15 +08006775{
6776 psa_status_t status;
6777 psa_algorithm_t alg;
6778 mbedtls_svc_key_id_t master_key = MBEDTLS_SVC_KEY_ID_INIT;
6779 psa_key_derivation_operation_t derivation =
6780 PSA_KEY_DERIVATION_OPERATION_INIT;
6781
Gilles Peskine449bd832023-01-11 14:50:10 +01006782 if (md_type == MBEDTLS_MD_SHA384) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006783 alg = PSA_ALG_TLS12_PRF(PSA_ALG_SHA_384);
Gilles Peskine449bd832023-01-11 14:50:10 +01006784 } else {
Jerry Yudc7bd172022-02-17 13:44:15 +08006785 alg = PSA_ALG_TLS12_PRF(PSA_ALG_SHA_256);
Gilles Peskine449bd832023-01-11 14:50:10 +01006786 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006787
6788 /* Normally a "secret" should be long enough to be impossible to
6789 * find by brute force, and in particular should not be empty. But
6790 * this PRF is also used to derive an IV, in particular in EAP-TLS,
6791 * and for this use case it makes sense to have a 0-length "secret".
6792 * Since the key API doesn't allow importing a key of length 0,
6793 * keep master_key=0, which setup_psa_key_derivation() understands
6794 * to mean a 0-length "secret" input. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006795 if (slen != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006796 psa_key_attributes_t key_attributes = psa_key_attributes_init();
Gilles Peskine449bd832023-01-11 14:50:10 +01006797 psa_set_key_usage_flags(&key_attributes, PSA_KEY_USAGE_DERIVE);
6798 psa_set_key_algorithm(&key_attributes, alg);
6799 psa_set_key_type(&key_attributes, PSA_KEY_TYPE_DERIVE);
Jerry Yudc7bd172022-02-17 13:44:15 +08006800
Gilles Peskine449bd832023-01-11 14:50:10 +01006801 status = psa_import_key(&key_attributes, secret, slen, &master_key);
6802 if (status != PSA_SUCCESS) {
6803 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
6804 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006805 }
6806
Gilles Peskine449bd832023-01-11 14:50:10 +01006807 status = setup_psa_key_derivation(&derivation,
6808 master_key, alg,
6809 NULL, 0,
6810 random, rlen,
6811 (unsigned char const *) label,
6812 (size_t) strlen(label),
6813 NULL, 0,
6814 dlen);
6815 if (status != PSA_SUCCESS) {
6816 psa_key_derivation_abort(&derivation);
6817 psa_destroy_key(master_key);
6818 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yudc7bd172022-02-17 13:44:15 +08006819 }
6820
Gilles Peskine449bd832023-01-11 14:50:10 +01006821 status = psa_key_derivation_output_bytes(&derivation, dstbuf, dlen);
6822 if (status != PSA_SUCCESS) {
6823 psa_key_derivation_abort(&derivation);
6824 psa_destroy_key(master_key);
6825 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yudc7bd172022-02-17 13:44:15 +08006826 }
6827
Gilles Peskine449bd832023-01-11 14:50:10 +01006828 status = psa_key_derivation_abort(&derivation);
6829 if (status != PSA_SUCCESS) {
6830 psa_destroy_key(master_key);
6831 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yudc7bd172022-02-17 13:44:15 +08006832 }
6833
Gilles Peskine449bd832023-01-11 14:50:10 +01006834 if (!mbedtls_svc_key_id_is_null(master_key)) {
6835 status = psa_destroy_key(master_key);
6836 }
6837 if (status != PSA_SUCCESS) {
6838 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
6839 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006840
Gilles Peskine449bd832023-01-11 14:50:10 +01006841 return 0;
Jerry Yudc7bd172022-02-17 13:44:15 +08006842}
Andrzej Kurek57d10632022-10-24 10:32:01 -04006843#endif /* PSA_WANT_ALG_SHA_256 || PSA_WANT_ALG_SHA_384 */
Jerry Yudc7bd172022-02-17 13:44:15 +08006844#else /* MBEDTLS_USE_PSA_CRYPTO */
6845
Andrzej Kurek57d10632022-10-24 10:32:01 -04006846#if defined(MBEDTLS_MD_C) && \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006847 (defined(MBEDTLS_MD_CAN_SHA256) || \
6848 defined(MBEDTLS_MD_CAN_SHA384))
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006849MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006850static int tls_prf_generic(mbedtls_md_type_t md_type,
6851 const unsigned char *secret, size_t slen,
6852 const char *label,
6853 const unsigned char *random, size_t rlen,
6854 unsigned char *dstbuf, size_t dlen)
Jerry Yudc7bd172022-02-17 13:44:15 +08006855{
6856 size_t nb;
6857 size_t i, j, k, md_len;
6858 unsigned char *tmp;
6859 size_t tmp_len = 0;
6860 unsigned char h_i[MBEDTLS_MD_MAX_SIZE];
6861 const mbedtls_md_info_t *md_info;
6862 mbedtls_md_context_t md_ctx;
6863 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6864
Gilles Peskine449bd832023-01-11 14:50:10 +01006865 mbedtls_md_init(&md_ctx);
Jerry Yudc7bd172022-02-17 13:44:15 +08006866
Gilles Peskine449bd832023-01-11 14:50:10 +01006867 if ((md_info = mbedtls_md_info_from_type(md_type)) == NULL) {
6868 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
6869 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006870
Gilles Peskine449bd832023-01-11 14:50:10 +01006871 md_len = mbedtls_md_get_size(md_info);
Jerry Yudc7bd172022-02-17 13:44:15 +08006872
Gilles Peskine449bd832023-01-11 14:50:10 +01006873 tmp_len = md_len + strlen(label) + rlen;
6874 tmp = mbedtls_calloc(1, tmp_len);
6875 if (tmp == NULL) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006876 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
6877 goto exit;
6878 }
6879
Gilles Peskine449bd832023-01-11 14:50:10 +01006880 nb = strlen(label);
6881 memcpy(tmp + md_len, label, nb);
6882 memcpy(tmp + md_len + nb, random, rlen);
Jerry Yudc7bd172022-02-17 13:44:15 +08006883 nb += rlen;
6884
6885 /*
6886 * Compute P_<hash>(secret, label + random)[0..dlen]
6887 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006888 if ((ret = mbedtls_md_setup(&md_ctx, md_info, 1)) != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006889 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006890 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006891
Gilles Peskine449bd832023-01-11 14:50:10 +01006892 ret = mbedtls_md_hmac_starts(&md_ctx, secret, slen);
6893 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006894 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006895 }
6896 ret = mbedtls_md_hmac_update(&md_ctx, tmp + md_len, nb);
6897 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006898 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006899 }
6900 ret = mbedtls_md_hmac_finish(&md_ctx, tmp);
6901 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006902 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006903 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006904
Gilles Peskine449bd832023-01-11 14:50:10 +01006905 for (i = 0; i < dlen; i += md_len) {
6906 ret = mbedtls_md_hmac_reset(&md_ctx);
6907 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006908 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006909 }
6910 ret = mbedtls_md_hmac_update(&md_ctx, tmp, md_len + nb);
6911 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006912 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006913 }
6914 ret = mbedtls_md_hmac_finish(&md_ctx, h_i);
6915 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006916 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006917 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006918
Gilles Peskine449bd832023-01-11 14:50:10 +01006919 ret = mbedtls_md_hmac_reset(&md_ctx);
6920 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006921 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006922 }
6923 ret = mbedtls_md_hmac_update(&md_ctx, tmp, md_len);
6924 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006925 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006926 }
6927 ret = mbedtls_md_hmac_finish(&md_ctx, tmp);
6928 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006929 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006930 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006931
Gilles Peskine449bd832023-01-11 14:50:10 +01006932 k = (i + md_len > dlen) ? dlen % md_len : md_len;
Jerry Yudc7bd172022-02-17 13:44:15 +08006933
Gilles Peskine449bd832023-01-11 14:50:10 +01006934 for (j = 0; j < k; j++) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006935 dstbuf[i + j] = h_i[j];
Gilles Peskine449bd832023-01-11 14:50:10 +01006936 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006937 }
6938
6939exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01006940 mbedtls_md_free(&md_ctx);
Jerry Yudc7bd172022-02-17 13:44:15 +08006941
Gilles Peskine449bd832023-01-11 14:50:10 +01006942 if (tmp != NULL) {
6943 mbedtls_platform_zeroize(tmp, tmp_len);
6944 }
Dave Rodgman29b9b2b2022-11-01 16:08:14 +00006945
Gilles Peskine449bd832023-01-11 14:50:10 +01006946 mbedtls_platform_zeroize(h_i, sizeof(h_i));
Jerry Yudc7bd172022-02-17 13:44:15 +08006947
Gilles Peskine449bd832023-01-11 14:50:10 +01006948 mbedtls_free(tmp);
Jerry Yudc7bd172022-02-17 13:44:15 +08006949
Gilles Peskine449bd832023-01-11 14:50:10 +01006950 return ret;
Jerry Yudc7bd172022-02-17 13:44:15 +08006951}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006952#endif /* MBEDTLS_MD_C && ( MBEDTLS_MD_CAN_SHA256 || MBEDTLS_MD_CAN_SHA384 ) */
Jerry Yudc7bd172022-02-17 13:44:15 +08006953#endif /* MBEDTLS_USE_PSA_CRYPTO */
6954
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006955#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006956MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006957static int tls_prf_sha256(const unsigned char *secret, size_t slen,
6958 const char *label,
6959 const unsigned char *random, size_t rlen,
6960 unsigned char *dstbuf, size_t dlen)
Jerry Yudc7bd172022-02-17 13:44:15 +08006961{
Gilles Peskine449bd832023-01-11 14:50:10 +01006962 return tls_prf_generic(MBEDTLS_MD_SHA256, secret, slen,
6963 label, random, rlen, dstbuf, dlen);
Jerry Yudc7bd172022-02-17 13:44:15 +08006964}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006965#endif /* MBEDTLS_MD_CAN_SHA256*/
Jerry Yudc7bd172022-02-17 13:44:15 +08006966
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006967#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006968MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006969static int tls_prf_sha384(const unsigned char *secret, size_t slen,
6970 const char *label,
6971 const unsigned char *random, size_t rlen,
6972 unsigned char *dstbuf, size_t dlen)
Jerry Yudc7bd172022-02-17 13:44:15 +08006973{
Gilles Peskine449bd832023-01-11 14:50:10 +01006974 return tls_prf_generic(MBEDTLS_MD_SHA384, secret, slen,
6975 label, random, rlen, dstbuf, dlen);
Jerry Yudc7bd172022-02-17 13:44:15 +08006976}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006977#endif /* MBEDTLS_MD_CAN_SHA384*/
Jerry Yudc7bd172022-02-17 13:44:15 +08006978
Jerry Yuf009d862022-02-17 14:01:37 +08006979/*
6980 * Set appropriate PRF function and other SSL / TLS1.2 functions
6981 *
6982 * Inputs:
Jerry Yuf009d862022-02-17 14:01:37 +08006983 * - hash associated with the ciphersuite (only used by TLS 1.2)
6984 *
6985 * Outputs:
6986 * - the tls_prf, calc_verify and calc_finished members of handshake structure
6987 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006988MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006989static int ssl_set_handshake_prfs(mbedtls_ssl_handshake_params *handshake,
6990 mbedtls_md_type_t hash)
Jerry Yuf009d862022-02-17 14:01:37 +08006991{
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006992#if defined(MBEDTLS_MD_CAN_SHA384)
Gilles Peskine449bd832023-01-11 14:50:10 +01006993 if (hash == MBEDTLS_MD_SHA384) {
Jerry Yuf009d862022-02-17 14:01:37 +08006994 handshake->tls_prf = tls_prf_sha384;
6995 handshake->calc_verify = ssl_calc_verify_tls_sha384;
6996 handshake->calc_finished = ssl_calc_finished_tls_sha384;
Gilles Peskine449bd832023-01-11 14:50:10 +01006997 } else
Jerry Yuf009d862022-02-17 14:01:37 +08006998#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006999#if defined(MBEDTLS_MD_CAN_SHA256)
Jerry Yuf009d862022-02-17 14:01:37 +08007000 {
Ronald Cron81591aa2022-03-07 09:05:51 +01007001 (void) hash;
Jerry Yuf009d862022-02-17 14:01:37 +08007002 handshake->tls_prf = tls_prf_sha256;
7003 handshake->calc_verify = ssl_calc_verify_tls_sha256;
7004 handshake->calc_finished = ssl_calc_finished_tls_sha256;
7005 }
Ronald Cron81591aa2022-03-07 09:05:51 +01007006#else
Jerry Yuf009d862022-02-17 14:01:37 +08007007 {
Jerry Yuf009d862022-02-17 14:01:37 +08007008 (void) handshake;
Ronald Cron81591aa2022-03-07 09:05:51 +01007009 (void) hash;
Gilles Peskine449bd832023-01-11 14:50:10 +01007010 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yuf009d862022-02-17 14:01:37 +08007011 }
Ronald Cron81591aa2022-03-07 09:05:51 +01007012#endif
Jerry Yuf009d862022-02-17 14:01:37 +08007013
Gilles Peskine449bd832023-01-11 14:50:10 +01007014 return 0;
Jerry Yuf009d862022-02-17 14:01:37 +08007015}
Jerry Yud6ab2352022-02-17 14:03:43 +08007016
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007017/*
7018 * Compute master secret if needed
7019 *
7020 * Parameters:
7021 * [in/out] handshake
7022 * [in] resume, premaster, extended_ms, calc_verify, tls_prf
7023 * (PSA-PSK) ciphersuite_info, psk_opaque
7024 * [out] premaster (cleared)
7025 * [out] master
7026 * [in] ssl: optionally used for debugging, EMS and PSA-PSK
7027 * debug: conf->f_dbg, conf->p_dbg
7028 * EMS: passed to calc_verify (debug + session_negotiate)
Ronald Crona25cf582022-03-07 11:10:36 +01007029 * PSA-PSA: conf
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007030 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007031MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007032static int ssl_compute_master(mbedtls_ssl_handshake_params *handshake,
7033 unsigned char *master,
7034 const mbedtls_ssl_context *ssl)
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007035{
7036 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7037
7038 /* cf. RFC 5246, Section 8.1:
7039 * "The master secret is always exactly 48 bytes in length." */
7040 size_t const master_secret_len = 48;
7041
7042#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
7043 unsigned char session_hash[48];
7044#endif /* MBEDTLS_SSL_EXTENDED_MASTER_SECRET */
7045
7046 /* The label for the KDF used for key expansion.
7047 * This is either "master secret" or "extended master secret"
7048 * depending on whether the Extended Master Secret extension
7049 * is used. */
7050 char const *lbl = "master secret";
7051
Przemek Stekielae4ed302022-04-05 17:15:55 +02007052 /* The seed for the KDF used for key expansion.
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007053 * - If the Extended Master Secret extension is not used,
7054 * this is ClientHello.Random + ServerHello.Random
7055 * (see Sect. 8.1 in RFC 5246).
7056 * - If the Extended Master Secret extension is used,
7057 * this is the transcript of the handshake so far.
7058 * (see Sect. 4 in RFC 7627). */
Przemek Stekielae4ed302022-04-05 17:15:55 +02007059 unsigned char const *seed = handshake->randbytes;
7060 size_t seed_len = 64;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007061
7062#if !defined(MBEDTLS_DEBUG_C) && \
7063 !defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET) && \
7064 !(defined(MBEDTLS_USE_PSA_CRYPTO) && \
Gilles Peskine449bd832023-01-11 14:50:10 +01007065 defined(MBEDTLS_KEY_EXCHANGE_PSK_ENABLED))
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007066 ssl = NULL; /* make sure we don't use it except for those cases */
7067 (void) ssl;
7068#endif
7069
Gilles Peskine449bd832023-01-11 14:50:10 +01007070 if (handshake->resume != 0) {
7071 MBEDTLS_SSL_DEBUG_MSG(3, ("no premaster (session resumed)"));
7072 return 0;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007073 }
7074
7075#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
Gilles Peskine449bd832023-01-11 14:50:10 +01007076 if (handshake->extended_ms == MBEDTLS_SSL_EXTENDED_MS_ENABLED) {
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007077 lbl = "extended master secret";
Przemek Stekielae4ed302022-04-05 17:15:55 +02007078 seed = session_hash;
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01007079 ret = handshake->calc_verify(ssl, session_hash, &seed_len);
7080 if (ret != 0) {
7081 MBEDTLS_SSL_DEBUG_RET(1, "calc_verify", ret);
7082 }
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007083
Gilles Peskine449bd832023-01-11 14:50:10 +01007084 MBEDTLS_SSL_DEBUG_BUF(3, "session hash for extended master secret",
7085 session_hash, seed_len);
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007086 }
Przemek Stekiel169bf0b2022-04-29 07:53:29 +02007087#endif /* MBEDTLS_SSL_EXTENDED_MASTER_SECRET */
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007088
Przemek Stekiel99114f32022-04-22 11:20:09 +02007089#if defined(MBEDTLS_USE_PSA_CRYPTO) && \
Przemek Stekiel8a4b7fd2022-04-28 09:22:22 +02007090 defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007091 if (mbedtls_ssl_ciphersuite_uses_psk(handshake->ciphersuite_info) == 1) {
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007092 /* Perform PSK-to-MS expansion in a single step. */
7093 psa_status_t status;
7094 psa_algorithm_t alg;
7095 mbedtls_svc_key_id_t psk;
7096 psa_key_derivation_operation_t derivation =
7097 PSA_KEY_DERIVATION_OPERATION_INIT;
Dave Rodgman2eab4622023-10-05 13:30:37 +01007098 mbedtls_md_type_t hash_alg = (mbedtls_md_type_t) handshake->ciphersuite_info->mac;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007099
Gilles Peskine449bd832023-01-11 14:50:10 +01007100 MBEDTLS_SSL_DEBUG_MSG(2, ("perform PSA-based PSK-to-MS expansion"));
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007101
Gilles Peskine449bd832023-01-11 14:50:10 +01007102 psk = mbedtls_ssl_get_opaque_psk(ssl);
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007103
Gilles Peskine449bd832023-01-11 14:50:10 +01007104 if (hash_alg == MBEDTLS_MD_SHA384) {
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007105 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_384);
Gilles Peskine449bd832023-01-11 14:50:10 +01007106 } else {
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007107 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_256);
Gilles Peskine449bd832023-01-11 14:50:10 +01007108 }
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007109
Przemek Stekiel51a1f362022-04-13 08:57:06 +02007110 size_t other_secret_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01007111 unsigned char *other_secret = NULL;
Przemek Stekielc2033402022-04-05 17:19:41 +02007112
Gilles Peskine449bd832023-01-11 14:50:10 +01007113 switch (handshake->ciphersuite_info->key_exchange) {
Przemek Stekiel19b80f82022-04-14 08:29:31 +02007114 /* Provide other secret.
Przemek Stekiel51a1f362022-04-13 08:57:06 +02007115 * Other secret is stored in premaster, where first 2 bytes hold the
Przemek Stekiel19b80f82022-04-14 08:29:31 +02007116 * length of the other key.
Przemek Stekielc2033402022-04-05 17:19:41 +02007117 */
Przemek Stekiel19b80f82022-04-14 08:29:31 +02007118 case MBEDTLS_KEY_EXCHANGE_RSA_PSK:
Przemek Stekiel8abcee92022-04-28 09:16:28 +02007119 /* For RSA-PSK other key length is always 48 bytes. */
Przemek Stekiel19b80f82022-04-14 08:29:31 +02007120 other_secret_len = 48;
7121 other_secret = handshake->premaster + 2;
7122 break;
7123 case MBEDTLS_KEY_EXCHANGE_ECDHE_PSK:
Przemek Stekielb293aaa2022-04-19 12:22:38 +02007124 case MBEDTLS_KEY_EXCHANGE_DHE_PSK:
Przemek Stekiel19b80f82022-04-14 08:29:31 +02007125 other_secret_len = MBEDTLS_GET_UINT16_BE(handshake->premaster, 0);
7126 other_secret = handshake->premaster + 2;
7127 break;
7128 default:
7129 break;
Przemek Stekielc2033402022-04-05 17:19:41 +02007130 }
7131
Gilles Peskine449bd832023-01-11 14:50:10 +01007132 status = setup_psa_key_derivation(&derivation, psk, alg,
7133 ssl->conf->psk, ssl->conf->psk_len,
7134 seed, seed_len,
7135 (unsigned char const *) lbl,
7136 (size_t) strlen(lbl),
7137 other_secret, other_secret_len,
7138 master_secret_len);
7139 if (status != PSA_SUCCESS) {
7140 psa_key_derivation_abort(&derivation);
7141 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007142 }
7143
Gilles Peskine449bd832023-01-11 14:50:10 +01007144 status = psa_key_derivation_output_bytes(&derivation,
7145 master,
7146 master_secret_len);
7147 if (status != PSA_SUCCESS) {
7148 psa_key_derivation_abort(&derivation);
7149 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007150 }
7151
Gilles Peskine449bd832023-01-11 14:50:10 +01007152 status = psa_key_derivation_abort(&derivation);
7153 if (status != PSA_SUCCESS) {
7154 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
7155 }
7156 } else
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007157#endif
7158 {
Neil Armstrongca7d5062022-05-31 14:43:23 +02007159#if defined(MBEDTLS_USE_PSA_CRYPTO) && \
Gilles Peskine449bd832023-01-11 14:50:10 +01007160 defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
7161 if (handshake->ciphersuite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_ECJPAKE) {
Neil Armstrongca7d5062022-05-31 14:43:23 +02007162 psa_status_t status;
7163 psa_algorithm_t alg = PSA_ALG_TLS12_ECJPAKE_TO_PMS;
7164 psa_key_derivation_operation_t derivation =
7165 PSA_KEY_DERIVATION_OPERATION_INIT;
7166
Gilles Peskine449bd832023-01-11 14:50:10 +01007167 MBEDTLS_SSL_DEBUG_MSG(2, ("perform PSA-based PMS KDF for ECJPAKE"));
Neil Armstrongca7d5062022-05-31 14:43:23 +02007168
7169 handshake->pmslen = PSA_TLS12_ECJPAKE_TO_PMS_DATA_SIZE;
7170
Gilles Peskine449bd832023-01-11 14:50:10 +01007171 status = psa_key_derivation_setup(&derivation, alg);
7172 if (status != PSA_SUCCESS) {
7173 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Neil Armstrongca7d5062022-05-31 14:43:23 +02007174 }
7175
Gilles Peskine449bd832023-01-11 14:50:10 +01007176 status = psa_key_derivation_set_capacity(&derivation,
7177 PSA_TLS12_ECJPAKE_TO_PMS_DATA_SIZE);
7178 if (status != PSA_SUCCESS) {
7179 psa_key_derivation_abort(&derivation);
7180 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Neil Armstrongca7d5062022-05-31 14:43:23 +02007181 }
7182
Gilles Peskine449bd832023-01-11 14:50:10 +01007183 status = psa_pake_get_implicit_key(&handshake->psa_pake_ctx,
7184 &derivation);
7185 if (status != PSA_SUCCESS) {
7186 psa_key_derivation_abort(&derivation);
7187 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Neil Armstrongca7d5062022-05-31 14:43:23 +02007188 }
7189
Gilles Peskine449bd832023-01-11 14:50:10 +01007190 status = psa_key_derivation_output_bytes(&derivation,
7191 handshake->premaster,
7192 handshake->pmslen);
7193 if (status != PSA_SUCCESS) {
7194 psa_key_derivation_abort(&derivation);
7195 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
7196 }
7197
7198 status = psa_key_derivation_abort(&derivation);
7199 if (status != PSA_SUCCESS) {
7200 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Neil Armstrongca7d5062022-05-31 14:43:23 +02007201 }
7202 }
7203#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01007204 ret = handshake->tls_prf(handshake->premaster, handshake->pmslen,
7205 lbl, seed, seed_len,
7206 master,
7207 master_secret_len);
7208 if (ret != 0) {
7209 MBEDTLS_SSL_DEBUG_RET(1, "prf", ret);
7210 return ret;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007211 }
7212
Gilles Peskine449bd832023-01-11 14:50:10 +01007213 MBEDTLS_SSL_DEBUG_BUF(3, "premaster secret",
7214 handshake->premaster,
7215 handshake->pmslen);
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007216
Gilles Peskine449bd832023-01-11 14:50:10 +01007217 mbedtls_platform_zeroize(handshake->premaster,
7218 sizeof(handshake->premaster));
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007219 }
7220
Gilles Peskine449bd832023-01-11 14:50:10 +01007221 return 0;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007222}
7223
Gilles Peskine449bd832023-01-11 14:50:10 +01007224int mbedtls_ssl_derive_keys(mbedtls_ssl_context *ssl)
Jerry Yud62f87e2022-02-17 14:09:02 +08007225{
7226 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7227 const mbedtls_ssl_ciphersuite_t * const ciphersuite_info =
7228 ssl->handshake->ciphersuite_info;
7229
Gilles Peskine449bd832023-01-11 14:50:10 +01007230 MBEDTLS_SSL_DEBUG_MSG(2, ("=> derive keys"));
Jerry Yud62f87e2022-02-17 14:09:02 +08007231
7232 /* Set PRF, calc_verify and calc_finished function pointers */
Gilles Peskine449bd832023-01-11 14:50:10 +01007233 ret = ssl_set_handshake_prfs(ssl->handshake,
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01007234 (mbedtls_md_type_t) ciphersuite_info->mac);
Gilles Peskine449bd832023-01-11 14:50:10 +01007235 if (ret != 0) {
7236 MBEDTLS_SSL_DEBUG_RET(1, "ssl_set_handshake_prfs", ret);
7237 return ret;
Jerry Yud62f87e2022-02-17 14:09:02 +08007238 }
7239
7240 /* Compute master secret if needed */
Gilles Peskine449bd832023-01-11 14:50:10 +01007241 ret = ssl_compute_master(ssl->handshake,
7242 ssl->session_negotiate->master,
7243 ssl);
7244 if (ret != 0) {
7245 MBEDTLS_SSL_DEBUG_RET(1, "ssl_compute_master", ret);
7246 return ret;
Jerry Yud62f87e2022-02-17 14:09:02 +08007247 }
7248
7249 /* Swap the client and server random values:
7250 * - MS derivation wanted client+server (RFC 5246 8.1)
7251 * - key derivation wants server+client (RFC 5246 6.3) */
7252 {
7253 unsigned char tmp[64];
Gilles Peskine449bd832023-01-11 14:50:10 +01007254 memcpy(tmp, ssl->handshake->randbytes, 64);
7255 memcpy(ssl->handshake->randbytes, tmp + 32, 32);
7256 memcpy(ssl->handshake->randbytes + 32, tmp, 32);
7257 mbedtls_platform_zeroize(tmp, sizeof(tmp));
Jerry Yud62f87e2022-02-17 14:09:02 +08007258 }
7259
7260 /* Populate transform structure */
Gilles Peskine449bd832023-01-11 14:50:10 +01007261 ret = ssl_tls12_populate_transform(ssl->transform_negotiate,
7262 ssl->session_negotiate->ciphersuite,
7263 ssl->session_negotiate->master,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02007264#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01007265 ssl->session_negotiate->encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02007266#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01007267 ssl->handshake->tls_prf,
7268 ssl->handshake->randbytes,
7269 ssl->tls_version,
7270 ssl->conf->endpoint,
7271 ssl);
7272 if (ret != 0) {
7273 MBEDTLS_SSL_DEBUG_RET(1, "ssl_tls12_populate_transform", ret);
7274 return ret;
Jerry Yud62f87e2022-02-17 14:09:02 +08007275 }
7276
7277 /* We no longer need Server/ClientHello.random values */
Gilles Peskine449bd832023-01-11 14:50:10 +01007278 mbedtls_platform_zeroize(ssl->handshake->randbytes,
7279 sizeof(ssl->handshake->randbytes));
Jerry Yud62f87e2022-02-17 14:09:02 +08007280
Gilles Peskine449bd832023-01-11 14:50:10 +01007281 MBEDTLS_SSL_DEBUG_MSG(2, ("<= derive keys"));
Jerry Yud62f87e2022-02-17 14:09:02 +08007282
Gilles Peskine449bd832023-01-11 14:50:10 +01007283 return 0;
Jerry Yud62f87e2022-02-17 14:09:02 +08007284}
Jerry Yu8392e0d2022-02-17 14:10:24 +08007285
Gilles Peskine449bd832023-01-11 14:50:10 +01007286int mbedtls_ssl_set_calc_verify_md(mbedtls_ssl_context *ssl, int md)
Ronald Cron4dcbca92022-03-07 10:21:40 +01007287{
Gilles Peskine449bd832023-01-11 14:50:10 +01007288 switch (md) {
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01007289#if defined(MBEDTLS_MD_CAN_SHA384)
Ronald Cron4dcbca92022-03-07 10:21:40 +01007290 case MBEDTLS_SSL_HASH_SHA384:
7291 ssl->handshake->calc_verify = ssl_calc_verify_tls_sha384;
7292 break;
7293#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01007294#if defined(MBEDTLS_MD_CAN_SHA256)
Ronald Cron4dcbca92022-03-07 10:21:40 +01007295 case MBEDTLS_SSL_HASH_SHA256:
7296 ssl->handshake->calc_verify = ssl_calc_verify_tls_sha256;
7297 break;
7298#endif
7299 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01007300 return -1;
Ronald Cron4dcbca92022-03-07 10:21:40 +01007301 }
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01007302#if !defined(MBEDTLS_MD_CAN_SHA384) && \
7303 !defined(MBEDTLS_MD_CAN_SHA256)
Andrzej Kurekeabeb302022-10-17 07:52:51 -04007304 (void) ssl;
7305#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01007306 return 0;
Ronald Cron4dcbca92022-03-07 10:21:40 +01007307}
7308
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007309#if defined(MBEDTLS_USE_PSA_CRYPTO)
7310static int ssl_calc_verify_tls_psa(const mbedtls_ssl_context *ssl,
7311 const psa_hash_operation_t *hs_op,
7312 size_t buffer_size,
7313 unsigned char *hash,
7314 size_t *hlen)
7315{
7316 psa_status_t status;
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007317 psa_hash_operation_t cloned_op = psa_hash_operation_init();
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007318
7319#if !defined(MBEDTLS_DEBUG_C)
7320 (void) ssl;
7321#endif
7322 MBEDTLS_SSL_DEBUG_MSG(2, ("=> PSA calc verify"));
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007323 status = psa_hash_clone(hs_op, &cloned_op);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007324 if (status != PSA_SUCCESS) {
7325 goto exit;
7326 }
7327
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007328 status = psa_hash_finish(&cloned_op, hash, buffer_size, hlen);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007329 if (status != PSA_SUCCESS) {
7330 goto exit;
7331 }
7332
7333 MBEDTLS_SSL_DEBUG_BUF(3, "PSA calculated verify result", hash, *hlen);
7334 MBEDTLS_SSL_DEBUG_MSG(2, ("<= PSA calc verify"));
7335
7336exit:
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007337 psa_hash_abort(&cloned_op);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007338 return mbedtls_md_error_from_psa(status);
7339}
7340#else
7341static int ssl_calc_verify_tls_legacy(const mbedtls_ssl_context *ssl,
7342 const mbedtls_md_context_t *hs_ctx,
7343 unsigned char *hash,
7344 size_t *hlen)
7345{
7346 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007347 mbedtls_md_context_t cloned_ctx;
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007348
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007349 mbedtls_md_init(&cloned_ctx);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007350
7351#if !defined(MBEDTLS_DEBUG_C)
7352 (void) ssl;
7353#endif
7354 MBEDTLS_SSL_DEBUG_MSG(2, ("=> calc verify"));
7355
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007356 ret = mbedtls_md_setup(&cloned_ctx, mbedtls_md_info_from_ctx(hs_ctx), 0);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007357 if (ret != 0) {
7358 goto exit;
7359 }
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007360 ret = mbedtls_md_clone(&cloned_ctx, hs_ctx);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007361 if (ret != 0) {
7362 goto exit;
7363 }
7364
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007365 ret = mbedtls_md_finish(&cloned_ctx, hash);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007366 if (ret != 0) {
7367 goto exit;
7368 }
7369
7370 *hlen = mbedtls_md_get_size(mbedtls_md_info_from_ctx(hs_ctx));
7371
7372 MBEDTLS_SSL_DEBUG_BUF(3, "calculated verify result", hash, *hlen);
7373 MBEDTLS_SSL_DEBUG_MSG(2, ("<= calc verify"));
7374
7375exit:
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007376 mbedtls_md_free(&cloned_ctx);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007377 return ret;
7378}
7379#endif /* MBEDTLS_USE_PSA_CRYPTO */
7380
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01007381#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +01007382int ssl_calc_verify_tls_sha256(const mbedtls_ssl_context *ssl,
7383 unsigned char *hash,
7384 size_t *hlen)
Jerry Yu8392e0d2022-02-17 14:10:24 +08007385{
7386#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007387 return ssl_calc_verify_tls_psa(ssl, &ssl->handshake->fin_sha256_psa, 32,
7388 hash, hlen);
Jerry Yu8392e0d2022-02-17 14:10:24 +08007389#else
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007390 return ssl_calc_verify_tls_legacy(ssl, &ssl->handshake->fin_sha256,
7391 hash, hlen);
Jerry Yu8392e0d2022-02-17 14:10:24 +08007392#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu8392e0d2022-02-17 14:10:24 +08007393}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01007394#endif /* MBEDTLS_MD_CAN_SHA256 */
Jerry Yu8392e0d2022-02-17 14:10:24 +08007395
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01007396#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +01007397int ssl_calc_verify_tls_sha384(const mbedtls_ssl_context *ssl,
7398 unsigned char *hash,
7399 size_t *hlen)
Jerry Yuc1cb3842022-02-17 14:13:48 +08007400{
7401#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007402 return ssl_calc_verify_tls_psa(ssl, &ssl->handshake->fin_sha384_psa, 48,
7403 hash, hlen);
Jerry Yuc1cb3842022-02-17 14:13:48 +08007404#else
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007405 return ssl_calc_verify_tls_legacy(ssl, &ssl->handshake->fin_sha384,
7406 hash, hlen);
Jerry Yuc1cb3842022-02-17 14:13:48 +08007407#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yuc1cb3842022-02-17 14:13:48 +08007408}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01007409#endif /* MBEDTLS_MD_CAN_SHA384 */
Jerry Yuc1cb3842022-02-17 14:13:48 +08007410
Neil Armstrong80f6f322022-05-03 17:56:38 +02007411#if !defined(MBEDTLS_USE_PSA_CRYPTO) && \
7412 defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007413int mbedtls_ssl_psk_derive_premaster(mbedtls_ssl_context *ssl, mbedtls_key_exchange_type_t key_ex)
Jerry Yuce3dca42022-02-17 14:16:37 +08007414{
7415 unsigned char *p = ssl->handshake->premaster;
Gilles Peskine449bd832023-01-11 14:50:10 +01007416 unsigned char *end = p + sizeof(ssl->handshake->premaster);
Jerry Yuce3dca42022-02-17 14:16:37 +08007417 const unsigned char *psk = NULL;
7418 size_t psk_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01007419 int psk_ret = mbedtls_ssl_get_psk(ssl, &psk, &psk_len);
Jerry Yuce3dca42022-02-17 14:16:37 +08007420
Gilles Peskine449bd832023-01-11 14:50:10 +01007421 if (psk_ret == MBEDTLS_ERR_SSL_PRIVATE_KEY_REQUIRED) {
Jerry Yuce3dca42022-02-17 14:16:37 +08007422 /*
7423 * This should never happen because the existence of a PSK is always
Przemek Stekielb293aaa2022-04-19 12:22:38 +02007424 * checked before calling this function.
7425 *
7426 * The exception is opaque DHE-PSK. For DHE-PSK fill premaster with
Przemek Stekiel8abcee92022-04-28 09:16:28 +02007427 * the shared secret without PSK.
Jerry Yuce3dca42022-02-17 14:16:37 +08007428 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007429 if (key_ex != MBEDTLS_KEY_EXCHANGE_DHE_PSK) {
7430 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
7431 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Przemek Stekielb293aaa2022-04-19 12:22:38 +02007432 }
Jerry Yuce3dca42022-02-17 14:16:37 +08007433 }
7434
7435 /*
7436 * PMS = struct {
7437 * opaque other_secret<0..2^16-1>;
7438 * opaque psk<0..2^16-1>;
7439 * };
7440 * with "other_secret" depending on the particular key exchange
7441 */
7442#if defined(MBEDTLS_KEY_EXCHANGE_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007443 if (key_ex == MBEDTLS_KEY_EXCHANGE_PSK) {
7444 if (end - p < 2) {
7445 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
7446 }
Jerry Yuce3dca42022-02-17 14:16:37 +08007447
Gilles Peskine449bd832023-01-11 14:50:10 +01007448 MBEDTLS_PUT_UINT16_BE(psk_len, p, 0);
Jerry Yuce3dca42022-02-17 14:16:37 +08007449 p += 2;
7450
Gilles Peskine449bd832023-01-11 14:50:10 +01007451 if (end < p || (size_t) (end - p) < psk_len) {
7452 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
7453 }
Jerry Yuce3dca42022-02-17 14:16:37 +08007454
Gilles Peskine449bd832023-01-11 14:50:10 +01007455 memset(p, 0, psk_len);
Jerry Yuce3dca42022-02-17 14:16:37 +08007456 p += psk_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01007457 } else
Jerry Yuce3dca42022-02-17 14:16:37 +08007458#endif /* MBEDTLS_KEY_EXCHANGE_PSK_ENABLED */
7459#if defined(MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007460 if (key_ex == MBEDTLS_KEY_EXCHANGE_RSA_PSK) {
Jerry Yuce3dca42022-02-17 14:16:37 +08007461 /*
7462 * other_secret already set by the ClientKeyExchange message,
7463 * and is 48 bytes long
7464 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007465 if (end - p < 2) {
7466 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
7467 }
Jerry Yuce3dca42022-02-17 14:16:37 +08007468
7469 *p++ = 0;
7470 *p++ = 48;
7471 p += 48;
Gilles Peskine449bd832023-01-11 14:50:10 +01007472 } else
Jerry Yuce3dca42022-02-17 14:16:37 +08007473#endif /* MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED */
7474#if defined(MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007475 if (key_ex == MBEDTLS_KEY_EXCHANGE_DHE_PSK) {
Jerry Yuce3dca42022-02-17 14:16:37 +08007476 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7477 size_t len;
7478
7479 /* Write length only when we know the actual value */
Gilles Peskine449bd832023-01-11 14:50:10 +01007480 if ((ret = mbedtls_dhm_calc_secret(&ssl->handshake->dhm_ctx,
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00007481 p + 2, (size_t) (end - (p + 2)), &len,
Gilles Peskine449bd832023-01-11 14:50:10 +01007482 ssl->conf->f_rng, ssl->conf->p_rng)) != 0) {
7483 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_dhm_calc_secret", ret);
7484 return ret;
Jerry Yuce3dca42022-02-17 14:16:37 +08007485 }
Gilles Peskine449bd832023-01-11 14:50:10 +01007486 MBEDTLS_PUT_UINT16_BE(len, p, 0);
Jerry Yuce3dca42022-02-17 14:16:37 +08007487 p += 2 + len;
7488
Gilles Peskine449bd832023-01-11 14:50:10 +01007489 MBEDTLS_SSL_DEBUG_MPI(3, "DHM: K ", &ssl->handshake->dhm_ctx.K);
7490 } else
Jerry Yuce3dca42022-02-17 14:16:37 +08007491#endif /* MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED */
Neil Armstrong80f6f322022-05-03 17:56:38 +02007492#if defined(MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007493 if (key_ex == MBEDTLS_KEY_EXCHANGE_ECDHE_PSK) {
Jerry Yuce3dca42022-02-17 14:16:37 +08007494 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7495 size_t zlen;
7496
Gilles Peskine449bd832023-01-11 14:50:10 +01007497 if ((ret = mbedtls_ecdh_calc_secret(&ssl->handshake->ecdh_ctx, &zlen,
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00007498 p + 2, (size_t) (end - (p + 2)),
Gilles Peskine449bd832023-01-11 14:50:10 +01007499 ssl->conf->f_rng, ssl->conf->p_rng)) != 0) {
7500 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ecdh_calc_secret", ret);
7501 return ret;
Jerry Yuce3dca42022-02-17 14:16:37 +08007502 }
7503
Gilles Peskine449bd832023-01-11 14:50:10 +01007504 MBEDTLS_PUT_UINT16_BE(zlen, p, 0);
Jerry Yuce3dca42022-02-17 14:16:37 +08007505 p += 2 + zlen;
7506
Gilles Peskine449bd832023-01-11 14:50:10 +01007507 MBEDTLS_SSL_DEBUG_ECDH(3, &ssl->handshake->ecdh_ctx,
7508 MBEDTLS_DEBUG_ECDH_Z);
7509 } else
Neil Armstrong80f6f322022-05-03 17:56:38 +02007510#endif /* MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED */
Jerry Yuce3dca42022-02-17 14:16:37 +08007511 {
Gilles Peskine449bd832023-01-11 14:50:10 +01007512 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
7513 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yuce3dca42022-02-17 14:16:37 +08007514 }
7515
7516 /* opaque psk<0..2^16-1>; */
Gilles Peskine449bd832023-01-11 14:50:10 +01007517 if (end - p < 2) {
7518 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
7519 }
Jerry Yuce3dca42022-02-17 14:16:37 +08007520
Gilles Peskine449bd832023-01-11 14:50:10 +01007521 MBEDTLS_PUT_UINT16_BE(psk_len, p, 0);
Jerry Yuce3dca42022-02-17 14:16:37 +08007522 p += 2;
7523
Gilles Peskine449bd832023-01-11 14:50:10 +01007524 if (end < p || (size_t) (end - p) < psk_len) {
7525 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
7526 }
Jerry Yuce3dca42022-02-17 14:16:37 +08007527
Gilles Peskine449bd832023-01-11 14:50:10 +01007528 memcpy(p, psk, psk_len);
Jerry Yuce3dca42022-02-17 14:16:37 +08007529 p += psk_len;
7530
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00007531 ssl->handshake->pmslen = (size_t) (p - ssl->handshake->premaster);
Jerry Yuce3dca42022-02-17 14:16:37 +08007532
Gilles Peskine449bd832023-01-11 14:50:10 +01007533 return 0;
Jerry Yuce3dca42022-02-17 14:16:37 +08007534}
Neil Armstrong80f6f322022-05-03 17:56:38 +02007535#endif /* !MBEDTLS_USE_PSA_CRYPTO && MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
Jerry Yuc2c673d2022-02-17 14:20:39 +08007536
7537#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007538MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007539static int ssl_write_hello_request(mbedtls_ssl_context *ssl);
Jerry Yuc2c673d2022-02-17 14:20:39 +08007540
7541#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01007542int mbedtls_ssl_resend_hello_request(mbedtls_ssl_context *ssl)
Jerry Yuc2c673d2022-02-17 14:20:39 +08007543{
7544 /* If renegotiation is not enforced, retransmit until we would reach max
7545 * timeout if we were using the usual handshake doubling scheme */
Gilles Peskine449bd832023-01-11 14:50:10 +01007546 if (ssl->conf->renego_max_records < 0) {
Jerry Yuc2c673d2022-02-17 14:20:39 +08007547 uint32_t ratio = ssl->conf->hs_timeout_max / ssl->conf->hs_timeout_min + 1;
7548 unsigned char doublings = 1;
7549
Gilles Peskine449bd832023-01-11 14:50:10 +01007550 while (ratio != 0) {
Jerry Yuc2c673d2022-02-17 14:20:39 +08007551 ++doublings;
7552 ratio >>= 1;
7553 }
7554
Gilles Peskine449bd832023-01-11 14:50:10 +01007555 if (++ssl->renego_records_seen > doublings) {
7556 MBEDTLS_SSL_DEBUG_MSG(2, ("no longer retransmitting hello request"));
7557 return 0;
Jerry Yuc2c673d2022-02-17 14:20:39 +08007558 }
7559 }
7560
Gilles Peskine449bd832023-01-11 14:50:10 +01007561 return ssl_write_hello_request(ssl);
Jerry Yuc2c673d2022-02-17 14:20:39 +08007562}
7563#endif
7564#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_RENEGOTIATION */
Jerry Yud9526692022-02-17 14:23:47 +08007565
Jerry Yud9526692022-02-17 14:23:47 +08007566/*
7567 * Handshake functions
7568 */
7569#if !defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
7570/* No certificate support -> dummy functions */
Gilles Peskine449bd832023-01-11 14:50:10 +01007571int mbedtls_ssl_write_certificate(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08007572{
7573 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
7574 ssl->handshake->ciphersuite_info;
7575
Gilles Peskine449bd832023-01-11 14:50:10 +01007576 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007577
Gilles Peskine449bd832023-01-11 14:50:10 +01007578 if (!mbedtls_ssl_ciphersuite_uses_srv_cert(ciphersuite_info)) {
7579 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007580 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01007581 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007582 }
7583
Gilles Peskine449bd832023-01-11 14:50:10 +01007584 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
7585 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007586}
7587
Gilles Peskine449bd832023-01-11 14:50:10 +01007588int mbedtls_ssl_parse_certificate(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08007589{
7590 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
7591 ssl->handshake->ciphersuite_info;
7592
Gilles Peskine449bd832023-01-11 14:50:10 +01007593 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007594
Gilles Peskine449bd832023-01-11 14:50:10 +01007595 if (!mbedtls_ssl_ciphersuite_uses_srv_cert(ciphersuite_info)) {
7596 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007597 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01007598 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007599 }
7600
Gilles Peskine449bd832023-01-11 14:50:10 +01007601 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
7602 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007603}
7604
7605#else /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
7606/* Some certificate support -> implement write and parse */
7607
Gilles Peskine449bd832023-01-11 14:50:10 +01007608int mbedtls_ssl_write_certificate(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08007609{
7610 int ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
7611 size_t i, n;
7612 const mbedtls_x509_crt *crt;
7613 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
7614 ssl->handshake->ciphersuite_info;
7615
Gilles Peskine449bd832023-01-11 14:50:10 +01007616 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007617
Gilles Peskine449bd832023-01-11 14:50:10 +01007618 if (!mbedtls_ssl_ciphersuite_uses_srv_cert(ciphersuite_info)) {
7619 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007620 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01007621 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007622 }
7623
7624#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007625 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
7626 if (ssl->handshake->client_auth == 0) {
7627 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007628 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01007629 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007630 }
7631 }
7632#endif /* MBEDTLS_SSL_CLI_C */
7633#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007634 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
7635 if (mbedtls_ssl_own_cert(ssl) == NULL) {
Jerry Yud9526692022-02-17 14:23:47 +08007636 /* Should never happen because we shouldn't have picked the
7637 * ciphersuite if we don't have a certificate. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007638 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007639 }
7640 }
7641#endif
7642
Gilles Peskine449bd832023-01-11 14:50:10 +01007643 MBEDTLS_SSL_DEBUG_CRT(3, "own certificate", mbedtls_ssl_own_cert(ssl));
Jerry Yud9526692022-02-17 14:23:47 +08007644
7645 /*
7646 * 0 . 0 handshake type
7647 * 1 . 3 handshake length
7648 * 4 . 6 length of all certs
7649 * 7 . 9 length of cert. 1
7650 * 10 . n-1 peer certificate
7651 * n . n+2 length of cert. 2
7652 * n+3 . ... upper level cert, etc.
7653 */
7654 i = 7;
Gilles Peskine449bd832023-01-11 14:50:10 +01007655 crt = mbedtls_ssl_own_cert(ssl);
Jerry Yud9526692022-02-17 14:23:47 +08007656
Gilles Peskine449bd832023-01-11 14:50:10 +01007657 while (crt != NULL) {
Jerry Yud9526692022-02-17 14:23:47 +08007658 n = crt->raw.len;
Gilles Peskine449bd832023-01-11 14:50:10 +01007659 if (n > MBEDTLS_SSL_OUT_CONTENT_LEN - 3 - i) {
7660 MBEDTLS_SSL_DEBUG_MSG(1, ("certificate too large, %" MBEDTLS_PRINTF_SIZET
7661 " > %" MBEDTLS_PRINTF_SIZET,
7662 i + 3 + n, (size_t) MBEDTLS_SSL_OUT_CONTENT_LEN));
7663 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
Jerry Yud9526692022-02-17 14:23:47 +08007664 }
7665
Gilles Peskine449bd832023-01-11 14:50:10 +01007666 ssl->out_msg[i] = MBEDTLS_BYTE_2(n);
7667 ssl->out_msg[i + 1] = MBEDTLS_BYTE_1(n);
7668 ssl->out_msg[i + 2] = MBEDTLS_BYTE_0(n);
Jerry Yud9526692022-02-17 14:23:47 +08007669
Gilles Peskine449bd832023-01-11 14:50:10 +01007670 i += 3; memcpy(ssl->out_msg + i, crt->raw.p, n);
Jerry Yud9526692022-02-17 14:23:47 +08007671 i += n; crt = crt->next;
7672 }
7673
Gilles Peskine449bd832023-01-11 14:50:10 +01007674 ssl->out_msg[4] = MBEDTLS_BYTE_2(i - 7);
7675 ssl->out_msg[5] = MBEDTLS_BYTE_1(i - 7);
7676 ssl->out_msg[6] = MBEDTLS_BYTE_0(i - 7);
Jerry Yud9526692022-02-17 14:23:47 +08007677
7678 ssl->out_msglen = i;
7679 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
7680 ssl->out_msg[0] = MBEDTLS_SSL_HS_CERTIFICATE;
7681
7682 ssl->state++;
7683
Gilles Peskine449bd832023-01-11 14:50:10 +01007684 if ((ret = mbedtls_ssl_write_handshake_msg(ssl)) != 0) {
7685 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_handshake_msg", ret);
7686 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007687 }
7688
Gilles Peskine449bd832023-01-11 14:50:10 +01007689 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007690
Gilles Peskine449bd832023-01-11 14:50:10 +01007691 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007692}
7693
7694#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
7695
7696#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007697MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007698static int ssl_check_peer_crt_unchanged(mbedtls_ssl_context *ssl,
7699 unsigned char *crt_buf,
7700 size_t crt_buf_len)
Jerry Yud9526692022-02-17 14:23:47 +08007701{
7702 mbedtls_x509_crt const * const peer_crt = ssl->session->peer_cert;
7703
Gilles Peskine449bd832023-01-11 14:50:10 +01007704 if (peer_crt == NULL) {
7705 return -1;
7706 }
Jerry Yud9526692022-02-17 14:23:47 +08007707
Gilles Peskine449bd832023-01-11 14:50:10 +01007708 if (peer_crt->raw.len != crt_buf_len) {
7709 return -1;
7710 }
Jerry Yud9526692022-02-17 14:23:47 +08007711
Gilles Peskine449bd832023-01-11 14:50:10 +01007712 return memcmp(peer_crt->raw.p, crt_buf, peer_crt->raw.len);
Jerry Yud9526692022-02-17 14:23:47 +08007713}
7714#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007715MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007716static int ssl_check_peer_crt_unchanged(mbedtls_ssl_context *ssl,
7717 unsigned char *crt_buf,
7718 size_t crt_buf_len)
Jerry Yud9526692022-02-17 14:23:47 +08007719{
7720 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7721 unsigned char const * const peer_cert_digest =
7722 ssl->session->peer_cert_digest;
7723 mbedtls_md_type_t const peer_cert_digest_type =
7724 ssl->session->peer_cert_digest_type;
7725 mbedtls_md_info_t const * const digest_info =
Gilles Peskine449bd832023-01-11 14:50:10 +01007726 mbedtls_md_info_from_type(peer_cert_digest_type);
Jerry Yud9526692022-02-17 14:23:47 +08007727 unsigned char tmp_digest[MBEDTLS_SSL_PEER_CERT_DIGEST_MAX_LEN];
7728 size_t digest_len;
7729
Gilles Peskine449bd832023-01-11 14:50:10 +01007730 if (peer_cert_digest == NULL || digest_info == NULL) {
7731 return -1;
7732 }
Jerry Yud9526692022-02-17 14:23:47 +08007733
Gilles Peskine449bd832023-01-11 14:50:10 +01007734 digest_len = mbedtls_md_get_size(digest_info);
7735 if (digest_len > MBEDTLS_SSL_PEER_CERT_DIGEST_MAX_LEN) {
7736 return -1;
7737 }
Jerry Yud9526692022-02-17 14:23:47 +08007738
Gilles Peskine449bd832023-01-11 14:50:10 +01007739 ret = mbedtls_md(digest_info, crt_buf, crt_buf_len, tmp_digest);
7740 if (ret != 0) {
7741 return -1;
7742 }
Jerry Yud9526692022-02-17 14:23:47 +08007743
Gilles Peskine449bd832023-01-11 14:50:10 +01007744 return memcmp(tmp_digest, peer_cert_digest, digest_len);
Jerry Yud9526692022-02-17 14:23:47 +08007745}
7746#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7747#endif /* MBEDTLS_SSL_RENEGOTIATION && MBEDTLS_SSL_CLI_C */
7748
7749/*
7750 * Once the certificate message is read, parse it into a cert chain and
7751 * perform basic checks, but leave actual verification to the caller
7752 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007753MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007754static int ssl_parse_certificate_chain(mbedtls_ssl_context *ssl,
7755 mbedtls_x509_crt *chain)
Jerry Yud9526692022-02-17 14:23:47 +08007756{
7757 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7758#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007759 int crt_cnt = 0;
Jerry Yud9526692022-02-17 14:23:47 +08007760#endif
7761 size_t i, n;
7762 uint8_t alert;
7763
Gilles Peskine449bd832023-01-11 14:50:10 +01007764 if (ssl->in_msgtype != MBEDTLS_SSL_MSG_HANDSHAKE) {
7765 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7766 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7767 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
7768 return MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
Jerry Yud9526692022-02-17 14:23:47 +08007769 }
7770
Gilles Peskine449bd832023-01-11 14:50:10 +01007771 if (ssl->in_msg[0] != MBEDTLS_SSL_HS_CERTIFICATE) {
7772 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7773 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
7774 return MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
Jerry Yud9526692022-02-17 14:23:47 +08007775 }
7776
Gilles Peskine449bd832023-01-11 14:50:10 +01007777 if (ssl->in_hslen < mbedtls_ssl_hs_hdr_len(ssl) + 3 + 3) {
7778 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7779 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7780 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
7781 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007782 }
7783
Gilles Peskine449bd832023-01-11 14:50:10 +01007784 i = mbedtls_ssl_hs_hdr_len(ssl);
Jerry Yud9526692022-02-17 14:23:47 +08007785
7786 /*
7787 * Same message structure as in mbedtls_ssl_write_certificate()
7788 */
Dave Rodgmana3d0f612023-11-03 23:34:02 +00007789 n = MBEDTLS_GET_UINT16_BE(ssl->in_msg, i + 1);
Jerry Yud9526692022-02-17 14:23:47 +08007790
Gilles Peskine449bd832023-01-11 14:50:10 +01007791 if (ssl->in_msg[i] != 0 ||
7792 ssl->in_hslen != n + 3 + mbedtls_ssl_hs_hdr_len(ssl)) {
7793 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7794 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7795 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
7796 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007797 }
7798
7799 /* Make &ssl->in_msg[i] point to the beginning of the CRT chain. */
7800 i += 3;
7801
7802 /* Iterate through and parse the CRTs in the provided chain. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007803 while (i < ssl->in_hslen) {
Jerry Yud9526692022-02-17 14:23:47 +08007804 /* Check that there's room for the next CRT's length fields. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007805 if (i + 3 > ssl->in_hslen) {
7806 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7807 mbedtls_ssl_send_alert_message(ssl,
7808 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7809 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
7810 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007811 }
7812 /* In theory, the CRT can be up to 2**24 Bytes, but we don't support
7813 * anything beyond 2**16 ~ 64K. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007814 if (ssl->in_msg[i] != 0) {
7815 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7816 mbedtls_ssl_send_alert_message(ssl,
7817 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7818 MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT);
7819 return MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
Jerry Yud9526692022-02-17 14:23:47 +08007820 }
7821
7822 /* Read length of the next CRT in the chain. */
Dave Rodgmana3d0f612023-11-03 23:34:02 +00007823 n = MBEDTLS_GET_UINT16_BE(ssl->in_msg, i + 1);
Jerry Yud9526692022-02-17 14:23:47 +08007824 i += 3;
7825
Gilles Peskine449bd832023-01-11 14:50:10 +01007826 if (n < 128 || i + n > ssl->in_hslen) {
7827 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7828 mbedtls_ssl_send_alert_message(ssl,
7829 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7830 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
7831 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007832 }
7833
7834 /* Check if we're handling the first CRT in the chain. */
7835#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007836 if (crt_cnt++ == 0 &&
Jerry Yud9526692022-02-17 14:23:47 +08007837 ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
Gilles Peskine449bd832023-01-11 14:50:10 +01007838 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS) {
Jerry Yud9526692022-02-17 14:23:47 +08007839 /* During client-side renegotiation, check that the server's
7840 * end-CRTs hasn't changed compared to the initial handshake,
7841 * mitigating the triple handshake attack. On success, reuse
7842 * the original end-CRT instead of parsing it again. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007843 MBEDTLS_SSL_DEBUG_MSG(3, ("Check that peer CRT hasn't changed during renegotiation"));
7844 if (ssl_check_peer_crt_unchanged(ssl,
7845 &ssl->in_msg[i],
7846 n) != 0) {
7847 MBEDTLS_SSL_DEBUG_MSG(1, ("new server cert during renegotiation"));
7848 mbedtls_ssl_send_alert_message(ssl,
7849 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7850 MBEDTLS_SSL_ALERT_MSG_ACCESS_DENIED);
7851 return MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
Jerry Yud9526692022-02-17 14:23:47 +08007852 }
7853
7854 /* Now we can safely free the original chain. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007855 ssl_clear_peer_cert(ssl->session);
Jerry Yud9526692022-02-17 14:23:47 +08007856 }
7857#endif /* MBEDTLS_SSL_RENEGOTIATION && MBEDTLS_SSL_CLI_C */
7858
7859 /* Parse the next certificate in the chain. */
7860#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01007861 ret = mbedtls_x509_crt_parse_der(chain, ssl->in_msg + i, n);
Jerry Yud9526692022-02-17 14:23:47 +08007862#else
7863 /* If we don't need to store the CRT chain permanently, parse
7864 * it in-place from the input buffer instead of making a copy. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007865 ret = mbedtls_x509_crt_parse_der_nocopy(chain, ssl->in_msg + i, n);
Jerry Yud9526692022-02-17 14:23:47 +08007866#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Gilles Peskine449bd832023-01-11 14:50:10 +01007867 switch (ret) {
Jerry Yud9526692022-02-17 14:23:47 +08007868 case 0: /*ok*/
7869 case MBEDTLS_ERR_X509_UNKNOWN_SIG_ALG + MBEDTLS_ERR_OID_NOT_FOUND:
7870 /* Ignore certificate with an unknown algorithm: maybe a
7871 prior certificate was already trusted. */
7872 break;
7873
7874 case MBEDTLS_ERR_X509_ALLOC_FAILED:
7875 alert = MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR;
7876 goto crt_parse_der_failed;
7877
7878 case MBEDTLS_ERR_X509_UNKNOWN_VERSION:
7879 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
7880 goto crt_parse_der_failed;
7881
7882 default:
7883 alert = MBEDTLS_SSL_ALERT_MSG_BAD_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01007884crt_parse_der_failed:
7885 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL, alert);
7886 MBEDTLS_SSL_DEBUG_RET(1, " mbedtls_x509_crt_parse_der", ret);
7887 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007888 }
7889
7890 i += n;
7891 }
7892
Gilles Peskine449bd832023-01-11 14:50:10 +01007893 MBEDTLS_SSL_DEBUG_CRT(3, "peer certificate", chain);
7894 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007895}
7896
7897#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007898MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007899static int ssl_srv_check_client_no_crt_notification(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08007900{
Gilles Peskine449bd832023-01-11 14:50:10 +01007901 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
7902 return -1;
7903 }
Jerry Yud9526692022-02-17 14:23:47 +08007904
Gilles Peskine449bd832023-01-11 14:50:10 +01007905 if (ssl->in_hslen == 3 + mbedtls_ssl_hs_hdr_len(ssl) &&
Jerry Yud9526692022-02-17 14:23:47 +08007906 ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
7907 ssl->in_msg[0] == MBEDTLS_SSL_HS_CERTIFICATE &&
Gilles Peskine449bd832023-01-11 14:50:10 +01007908 memcmp(ssl->in_msg + mbedtls_ssl_hs_hdr_len(ssl), "\0\0\0", 3) == 0) {
7909 MBEDTLS_SSL_DEBUG_MSG(1, ("peer has no certificate"));
7910 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007911 }
Gilles Peskine449bd832023-01-11 14:50:10 +01007912 return -1;
Jerry Yud9526692022-02-17 14:23:47 +08007913}
7914#endif /* MBEDTLS_SSL_SRV_C */
7915
7916/* Check if a certificate message is expected.
7917 * Return either
7918 * - SSL_CERTIFICATE_EXPECTED, or
7919 * - SSL_CERTIFICATE_SKIP
7920 * indicating whether a Certificate message is expected or not.
7921 */
7922#define SSL_CERTIFICATE_EXPECTED 0
7923#define SSL_CERTIFICATE_SKIP 1
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007924MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007925static int ssl_parse_certificate_coordinate(mbedtls_ssl_context *ssl,
7926 int authmode)
Jerry Yud9526692022-02-17 14:23:47 +08007927{
7928 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
7929 ssl->handshake->ciphersuite_info;
7930
Gilles Peskine449bd832023-01-11 14:50:10 +01007931 if (!mbedtls_ssl_ciphersuite_uses_srv_cert(ciphersuite_info)) {
7932 return SSL_CERTIFICATE_SKIP;
7933 }
Jerry Yud9526692022-02-17 14:23:47 +08007934
7935#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007936 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
7937 if (ciphersuite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_RSA_PSK) {
7938 return SSL_CERTIFICATE_SKIP;
7939 }
Jerry Yud9526692022-02-17 14:23:47 +08007940
Gilles Peskine449bd832023-01-11 14:50:10 +01007941 if (authmode == MBEDTLS_SSL_VERIFY_NONE) {
Jerry Yud9526692022-02-17 14:23:47 +08007942 ssl->session_negotiate->verify_result =
7943 MBEDTLS_X509_BADCERT_SKIP_VERIFY;
Gilles Peskine449bd832023-01-11 14:50:10 +01007944 return SSL_CERTIFICATE_SKIP;
Jerry Yud9526692022-02-17 14:23:47 +08007945 }
7946 }
7947#else
7948 ((void) authmode);
7949#endif /* MBEDTLS_SSL_SRV_C */
7950
Gilles Peskine449bd832023-01-11 14:50:10 +01007951 return SSL_CERTIFICATE_EXPECTED;
Jerry Yud9526692022-02-17 14:23:47 +08007952}
7953
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007954MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007955static int ssl_parse_certificate_verify(mbedtls_ssl_context *ssl,
7956 int authmode,
7957 mbedtls_x509_crt *chain,
7958 void *rs_ctx)
Jerry Yud9526692022-02-17 14:23:47 +08007959{
7960 int ret = 0;
7961 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
7962 ssl->handshake->ciphersuite_info;
7963 int have_ca_chain = 0;
7964
7965 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *);
7966 void *p_vrfy;
7967
Gilles Peskine449bd832023-01-11 14:50:10 +01007968 if (authmode == MBEDTLS_SSL_VERIFY_NONE) {
7969 return 0;
7970 }
Jerry Yud9526692022-02-17 14:23:47 +08007971
Gilles Peskine449bd832023-01-11 14:50:10 +01007972 if (ssl->f_vrfy != NULL) {
7973 MBEDTLS_SSL_DEBUG_MSG(3, ("Use context-specific verification callback"));
Jerry Yud9526692022-02-17 14:23:47 +08007974 f_vrfy = ssl->f_vrfy;
7975 p_vrfy = ssl->p_vrfy;
Gilles Peskine449bd832023-01-11 14:50:10 +01007976 } else {
7977 MBEDTLS_SSL_DEBUG_MSG(3, ("Use configuration-specific verification callback"));
Jerry Yud9526692022-02-17 14:23:47 +08007978 f_vrfy = ssl->conf->f_vrfy;
7979 p_vrfy = ssl->conf->p_vrfy;
7980 }
7981
7982 /*
7983 * Main check: verify certificate
7984 */
7985#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
Gilles Peskine449bd832023-01-11 14:50:10 +01007986 if (ssl->conf->f_ca_cb != NULL) {
Jerry Yud9526692022-02-17 14:23:47 +08007987 ((void) rs_ctx);
7988 have_ca_chain = 1;
7989
Gilles Peskine449bd832023-01-11 14:50:10 +01007990 MBEDTLS_SSL_DEBUG_MSG(3, ("use CA callback for X.509 CRT verification"));
Jerry Yud9526692022-02-17 14:23:47 +08007991 ret = mbedtls_x509_crt_verify_with_ca_cb(
7992 chain,
7993 ssl->conf->f_ca_cb,
7994 ssl->conf->p_ca_cb,
7995 ssl->conf->cert_profile,
7996 ssl->hostname,
7997 &ssl->session_negotiate->verify_result,
Gilles Peskine449bd832023-01-11 14:50:10 +01007998 f_vrfy, p_vrfy);
7999 } else
Jerry Yud9526692022-02-17 14:23:47 +08008000#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
8001 {
8002 mbedtls_x509_crt *ca_chain;
8003 mbedtls_x509_crl *ca_crl;
8004
8005#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01008006 if (ssl->handshake->sni_ca_chain != NULL) {
Jerry Yud9526692022-02-17 14:23:47 +08008007 ca_chain = ssl->handshake->sni_ca_chain;
8008 ca_crl = ssl->handshake->sni_ca_crl;
Gilles Peskine449bd832023-01-11 14:50:10 +01008009 } else
Jerry Yud9526692022-02-17 14:23:47 +08008010#endif
8011 {
8012 ca_chain = ssl->conf->ca_chain;
8013 ca_crl = ssl->conf->ca_crl;
8014 }
8015
Gilles Peskine449bd832023-01-11 14:50:10 +01008016 if (ca_chain != NULL) {
Jerry Yud9526692022-02-17 14:23:47 +08008017 have_ca_chain = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01008018 }
Jerry Yud9526692022-02-17 14:23:47 +08008019
8020 ret = mbedtls_x509_crt_verify_restartable(
8021 chain,
8022 ca_chain, ca_crl,
8023 ssl->conf->cert_profile,
8024 ssl->hostname,
8025 &ssl->session_negotiate->verify_result,
Gilles Peskine449bd832023-01-11 14:50:10 +01008026 f_vrfy, p_vrfy, rs_ctx);
Jerry Yud9526692022-02-17 14:23:47 +08008027 }
8028
Gilles Peskine449bd832023-01-11 14:50:10 +01008029 if (ret != 0) {
8030 MBEDTLS_SSL_DEBUG_RET(1, "x509_verify_cert", ret);
Jerry Yud9526692022-02-17 14:23:47 +08008031 }
8032
8033#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01008034 if (ret == MBEDTLS_ERR_ECP_IN_PROGRESS) {
8035 return MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS;
8036 }
Jerry Yud9526692022-02-17 14:23:47 +08008037#endif
8038
8039 /*
8040 * Secondary checks: always done, but change 'ret' only if it was 0
8041 */
8042
Valerio Settiacd32c02023-06-29 18:06:29 +02008043#if defined(MBEDTLS_PK_HAVE_ECC_KEYS)
Jerry Yud9526692022-02-17 14:23:47 +08008044 {
8045 const mbedtls_pk_context *pk = &chain->pk;
8046
Manuel Pégourié-Gonnard66b0d612022-06-17 10:49:29 +02008047 /* If certificate uses an EC key, make sure the curve is OK.
8048 * This is a public key, so it can't be opaque, so can_do() is a good
8049 * enough check to ensure pk_ec() is safe to use here. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008050 if (mbedtls_pk_can_do(pk, MBEDTLS_PK_ECKEY)) {
Leonid Rozenboim19e59732022-08-08 16:52:38 -07008051 /* and in the unlikely case the above assumption no longer holds
8052 * we are making sure that pk_ec() here does not return a NULL
8053 */
Valerio Settif9362b72023-11-29 08:42:27 +01008054 mbedtls_ecp_group_id grp_id = mbedtls_pk_get_ec_group_id(pk);
Valerio Settid0405092023-05-24 13:16:40 +02008055 if (grp_id == MBEDTLS_ECP_DP_NONE) {
8056 MBEDTLS_SSL_DEBUG_MSG(1, ("invalid group ID"));
Gilles Peskine449bd832023-01-11 14:50:10 +01008057 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Leonid Rozenboim19e59732022-08-08 16:52:38 -07008058 }
Valerio Setti97207782023-05-18 18:59:06 +02008059 if (mbedtls_ssl_check_curve(ssl, grp_id) != 0) {
Leonid Rozenboim19e59732022-08-08 16:52:38 -07008060 ssl->session_negotiate->verify_result |=
8061 MBEDTLS_X509_BADCERT_BAD_KEY;
8062
Gilles Peskine449bd832023-01-11 14:50:10 +01008063 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate (EC key curve)"));
8064 if (ret == 0) {
Leonid Rozenboim19e59732022-08-08 16:52:38 -07008065 ret = MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
Gilles Peskine449bd832023-01-11 14:50:10 +01008066 }
Leonid Rozenboim19e59732022-08-08 16:52:38 -07008067 }
Jerry Yud9526692022-02-17 14:23:47 +08008068 }
8069 }
Valerio Settiacd32c02023-06-29 18:06:29 +02008070#endif /* MBEDTLS_PK_HAVE_ECC_KEYS */
Jerry Yud9526692022-02-17 14:23:47 +08008071
Gilles Peskine449bd832023-01-11 14:50:10 +01008072 if (mbedtls_ssl_check_cert_usage(chain,
8073 ciphersuite_info,
8074 !ssl->conf->endpoint,
8075 &ssl->session_negotiate->verify_result) != 0) {
8076 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate (usage extensions)"));
8077 if (ret == 0) {
Jerry Yud9526692022-02-17 14:23:47 +08008078 ret = MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
Gilles Peskine449bd832023-01-11 14:50:10 +01008079 }
Jerry Yud9526692022-02-17 14:23:47 +08008080 }
8081
8082 /* mbedtls_x509_crt_verify_with_profile is supposed to report a
8083 * verification failure through MBEDTLS_ERR_X509_CERT_VERIFY_FAILED,
8084 * with details encoded in the verification flags. All other kinds
8085 * of error codes, including those from the user provided f_vrfy
8086 * functions, are treated as fatal and lead to a failure of
8087 * ssl_parse_certificate even if verification was optional. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008088 if (authmode == MBEDTLS_SSL_VERIFY_OPTIONAL &&
8089 (ret == MBEDTLS_ERR_X509_CERT_VERIFY_FAILED ||
8090 ret == MBEDTLS_ERR_SSL_BAD_CERTIFICATE)) {
Jerry Yud9526692022-02-17 14:23:47 +08008091 ret = 0;
8092 }
8093
Gilles Peskine449bd832023-01-11 14:50:10 +01008094 if (have_ca_chain == 0 && authmode == MBEDTLS_SSL_VERIFY_REQUIRED) {
8095 MBEDTLS_SSL_DEBUG_MSG(1, ("got no CA chain"));
Jerry Yud9526692022-02-17 14:23:47 +08008096 ret = MBEDTLS_ERR_SSL_CA_CHAIN_REQUIRED;
8097 }
8098
Gilles Peskine449bd832023-01-11 14:50:10 +01008099 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08008100 uint8_t alert;
8101
8102 /* The certificate may have been rejected for several reasons.
8103 Pick one and send the corresponding alert. Which alert to send
8104 may be a subject of debate in some cases. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008105 if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_OTHER) {
Jerry Yud9526692022-02-17 14:23:47 +08008106 alert = MBEDTLS_SSL_ALERT_MSG_ACCESS_DENIED;
Gilles Peskine449bd832023-01-11 14:50:10 +01008107 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_CN_MISMATCH) {
Jerry Yud9526692022-02-17 14:23:47 +08008108 alert = MBEDTLS_SSL_ALERT_MSG_BAD_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01008109 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_KEY_USAGE) {
Jerry Yud9526692022-02-17 14:23:47 +08008110 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01008111 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_EXT_KEY_USAGE) {
Jerry Yud9526692022-02-17 14:23:47 +08008112 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01008113 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_NS_CERT_TYPE) {
Jerry Yud9526692022-02-17 14:23:47 +08008114 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01008115 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_BAD_PK) {
Jerry Yud9526692022-02-17 14:23:47 +08008116 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01008117 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_BAD_KEY) {
Jerry Yud9526692022-02-17 14:23:47 +08008118 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01008119 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_EXPIRED) {
Jerry Yud9526692022-02-17 14:23:47 +08008120 alert = MBEDTLS_SSL_ALERT_MSG_CERT_EXPIRED;
Gilles Peskine449bd832023-01-11 14:50:10 +01008121 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_REVOKED) {
Jerry Yud9526692022-02-17 14:23:47 +08008122 alert = MBEDTLS_SSL_ALERT_MSG_CERT_REVOKED;
Gilles Peskine449bd832023-01-11 14:50:10 +01008123 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_NOT_TRUSTED) {
Jerry Yud9526692022-02-17 14:23:47 +08008124 alert = MBEDTLS_SSL_ALERT_MSG_UNKNOWN_CA;
Gilles Peskine449bd832023-01-11 14:50:10 +01008125 } else {
Jerry Yud9526692022-02-17 14:23:47 +08008126 alert = MBEDTLS_SSL_ALERT_MSG_CERT_UNKNOWN;
Gilles Peskine449bd832023-01-11 14:50:10 +01008127 }
8128 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8129 alert);
Jerry Yud9526692022-02-17 14:23:47 +08008130 }
8131
8132#if defined(MBEDTLS_DEBUG_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008133 if (ssl->session_negotiate->verify_result != 0) {
8134 MBEDTLS_SSL_DEBUG_MSG(3, ("! Certificate verification flags %08x",
8135 (unsigned int) ssl->session_negotiate->verify_result));
8136 } else {
8137 MBEDTLS_SSL_DEBUG_MSG(3, ("Certificate verification flags clear"));
Jerry Yud9526692022-02-17 14:23:47 +08008138 }
8139#endif /* MBEDTLS_DEBUG_C */
8140
Gilles Peskine449bd832023-01-11 14:50:10 +01008141 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08008142}
8143
8144#if !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02008145MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01008146static int ssl_remember_peer_crt_digest(mbedtls_ssl_context *ssl,
8147 unsigned char *start, size_t len)
Jerry Yud9526692022-02-17 14:23:47 +08008148{
8149 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
8150 /* Remember digest of the peer's end-CRT. */
8151 ssl->session_negotiate->peer_cert_digest =
Gilles Peskine449bd832023-01-11 14:50:10 +01008152 mbedtls_calloc(1, MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN);
8153 if (ssl->session_negotiate->peer_cert_digest == NULL) {
8154 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc(%d bytes) failed",
8155 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN));
8156 mbedtls_ssl_send_alert_message(ssl,
8157 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8158 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR);
Jerry Yud9526692022-02-17 14:23:47 +08008159
Gilles Peskine449bd832023-01-11 14:50:10 +01008160 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
Jerry Yud9526692022-02-17 14:23:47 +08008161 }
8162
Gilles Peskine449bd832023-01-11 14:50:10 +01008163 ret = mbedtls_md(mbedtls_md_info_from_type(
8164 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE),
8165 start, len,
8166 ssl->session_negotiate->peer_cert_digest);
Jerry Yud9526692022-02-17 14:23:47 +08008167
8168 ssl->session_negotiate->peer_cert_digest_type =
8169 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE;
8170 ssl->session_negotiate->peer_cert_digest_len =
8171 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN;
8172
Gilles Peskine449bd832023-01-11 14:50:10 +01008173 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08008174}
8175
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02008176MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01008177static int ssl_remember_peer_pubkey(mbedtls_ssl_context *ssl,
8178 unsigned char *start, size_t len)
Jerry Yud9526692022-02-17 14:23:47 +08008179{
8180 unsigned char *end = start + len;
8181 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
8182
8183 /* Make a copy of the peer's raw public key. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008184 mbedtls_pk_init(&ssl->handshake->peer_pubkey);
8185 ret = mbedtls_pk_parse_subpubkey(&start, end,
8186 &ssl->handshake->peer_pubkey);
8187 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08008188 /* We should have parsed the public key before. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008189 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08008190 }
8191
Gilles Peskine449bd832023-01-11 14:50:10 +01008192 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08008193}
8194#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
8195
Gilles Peskine449bd832023-01-11 14:50:10 +01008196int mbedtls_ssl_parse_certificate(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08008197{
8198 int ret = 0;
8199 int crt_expected;
8200#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
8201 const int authmode = ssl->handshake->sni_authmode != MBEDTLS_SSL_VERIFY_UNSET
8202 ? ssl->handshake->sni_authmode
8203 : ssl->conf->authmode;
8204#else
8205 const int authmode = ssl->conf->authmode;
8206#endif
8207 void *rs_ctx = NULL;
8208 mbedtls_x509_crt *chain = NULL;
8209
Gilles Peskine449bd832023-01-11 14:50:10 +01008210 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08008211
Gilles Peskine449bd832023-01-11 14:50:10 +01008212 crt_expected = ssl_parse_certificate_coordinate(ssl, authmode);
8213 if (crt_expected == SSL_CERTIFICATE_SKIP) {
8214 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08008215 goto exit;
8216 }
8217
8218#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01008219 if (ssl->handshake->ecrs_enabled &&
8220 ssl->handshake->ecrs_state == ssl_ecrs_crt_verify) {
Jerry Yud9526692022-02-17 14:23:47 +08008221 chain = ssl->handshake->ecrs_peer_cert;
8222 ssl->handshake->ecrs_peer_cert = NULL;
8223 goto crt_verify;
8224 }
8225#endif
8226
Gilles Peskine449bd832023-01-11 14:50:10 +01008227 if ((ret = mbedtls_ssl_read_record(ssl, 1)) != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08008228 /* mbedtls_ssl_read_record may have sent an alert already. We
8229 let it decide whether to alert. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008230 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_read_record", ret);
Jerry Yud9526692022-02-17 14:23:47 +08008231 goto exit;
8232 }
8233
8234#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008235 if (ssl_srv_check_client_no_crt_notification(ssl) == 0) {
Jerry Yud9526692022-02-17 14:23:47 +08008236 ssl->session_negotiate->verify_result = MBEDTLS_X509_BADCERT_MISSING;
8237
Gilles Peskine449bd832023-01-11 14:50:10 +01008238 if (authmode != MBEDTLS_SSL_VERIFY_OPTIONAL) {
Jerry Yud9526692022-02-17 14:23:47 +08008239 ret = MBEDTLS_ERR_SSL_NO_CLIENT_CERTIFICATE;
Gilles Peskine449bd832023-01-11 14:50:10 +01008240 }
Jerry Yud9526692022-02-17 14:23:47 +08008241
8242 goto exit;
8243 }
8244#endif /* MBEDTLS_SSL_SRV_C */
8245
8246 /* Clear existing peer CRT structure in case we tried to
8247 * reuse a session but it failed, and allocate a new one. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008248 ssl_clear_peer_cert(ssl->session_negotiate);
Jerry Yud9526692022-02-17 14:23:47 +08008249
Gilles Peskine449bd832023-01-11 14:50:10 +01008250 chain = mbedtls_calloc(1, sizeof(mbedtls_x509_crt));
8251 if (chain == NULL) {
8252 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc(%" MBEDTLS_PRINTF_SIZET " bytes) failed",
8253 sizeof(mbedtls_x509_crt)));
8254 mbedtls_ssl_send_alert_message(ssl,
8255 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8256 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR);
Jerry Yud9526692022-02-17 14:23:47 +08008257
8258 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
8259 goto exit;
8260 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008261 mbedtls_x509_crt_init(chain);
Jerry Yud9526692022-02-17 14:23:47 +08008262
Gilles Peskine449bd832023-01-11 14:50:10 +01008263 ret = ssl_parse_certificate_chain(ssl, chain);
8264 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08008265 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01008266 }
Jerry Yud9526692022-02-17 14:23:47 +08008267
8268#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01008269 if (ssl->handshake->ecrs_enabled) {
Jerry Yud9526692022-02-17 14:23:47 +08008270 ssl->handshake->ecrs_state = ssl_ecrs_crt_verify;
Gilles Peskine449bd832023-01-11 14:50:10 +01008271 }
Jerry Yud9526692022-02-17 14:23:47 +08008272
8273crt_verify:
Gilles Peskine449bd832023-01-11 14:50:10 +01008274 if (ssl->handshake->ecrs_enabled) {
Jerry Yud9526692022-02-17 14:23:47 +08008275 rs_ctx = &ssl->handshake->ecrs_ctx;
Gilles Peskine449bd832023-01-11 14:50:10 +01008276 }
Jerry Yud9526692022-02-17 14:23:47 +08008277#endif
8278
Gilles Peskine449bd832023-01-11 14:50:10 +01008279 ret = ssl_parse_certificate_verify(ssl, authmode,
8280 chain, rs_ctx);
8281 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08008282 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01008283 }
Jerry Yud9526692022-02-17 14:23:47 +08008284
8285#if !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
8286 {
8287 unsigned char *crt_start, *pk_start;
8288 size_t crt_len, pk_len;
8289
8290 /* We parse the CRT chain without copying, so
8291 * these pointers point into the input buffer,
8292 * and are hence still valid after freeing the
8293 * CRT chain. */
8294
8295 crt_start = chain->raw.p;
8296 crt_len = chain->raw.len;
8297
8298 pk_start = chain->pk_raw.p;
8299 pk_len = chain->pk_raw.len;
8300
8301 /* Free the CRT structures before computing
8302 * digest and copying the peer's public key. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008303 mbedtls_x509_crt_free(chain);
8304 mbedtls_free(chain);
Jerry Yud9526692022-02-17 14:23:47 +08008305 chain = NULL;
8306
Gilles Peskine449bd832023-01-11 14:50:10 +01008307 ret = ssl_remember_peer_crt_digest(ssl, crt_start, crt_len);
8308 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08008309 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01008310 }
Jerry Yud9526692022-02-17 14:23:47 +08008311
Gilles Peskine449bd832023-01-11 14:50:10 +01008312 ret = ssl_remember_peer_pubkey(ssl, pk_start, pk_len);
8313 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08008314 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01008315 }
Jerry Yud9526692022-02-17 14:23:47 +08008316 }
8317#else /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
8318 /* Pass ownership to session structure. */
8319 ssl->session_negotiate->peer_cert = chain;
8320 chain = NULL;
8321#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
8322
Gilles Peskine449bd832023-01-11 14:50:10 +01008323 MBEDTLS_SSL_DEBUG_MSG(2, ("<= parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08008324
8325exit:
8326
Gilles Peskine449bd832023-01-11 14:50:10 +01008327 if (ret == 0) {
Jerry Yud9526692022-02-17 14:23:47 +08008328 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01008329 }
Jerry Yud9526692022-02-17 14:23:47 +08008330
8331#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01008332 if (ret == MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS) {
Jerry Yud9526692022-02-17 14:23:47 +08008333 ssl->handshake->ecrs_peer_cert = chain;
8334 chain = NULL;
8335 }
8336#endif
8337
Gilles Peskine449bd832023-01-11 14:50:10 +01008338 if (chain != NULL) {
8339 mbedtls_x509_crt_free(chain);
8340 mbedtls_free(chain);
Jerry Yud9526692022-02-17 14:23:47 +08008341 }
8342
Gilles Peskine449bd832023-01-11 14:50:10 +01008343 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08008344}
8345#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
8346
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008347static int ssl_calc_finished_tls_generic(mbedtls_ssl_context *ssl, void *ctx,
8348 unsigned char *padbuf, size_t hlen,
8349 unsigned char *buf, int from)
Jerry Yu615bd6f2022-02-17 14:25:15 +08008350{
Dave Rodgmanc37ad442023-11-03 23:36:06 +00008351 unsigned int len = 12;
Jerry Yu615bd6f2022-02-17 14:25:15 +08008352 const char *sender;
Jerry Yu615bd6f2022-02-17 14:25:15 +08008353#if defined(MBEDTLS_USE_PSA_CRYPTO)
Jerry Yu615bd6f2022-02-17 14:25:15 +08008354 psa_status_t status;
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008355 psa_hash_operation_t *hs_op = ctx;
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02008356 psa_hash_operation_t cloned_op = PSA_HASH_OPERATION_INIT;
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008357 size_t hash_size;
Jerry Yu615bd6f2022-02-17 14:25:15 +08008358#else
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01008359 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008360 mbedtls_md_context_t *hs_ctx = ctx;
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02008361 mbedtls_md_context_t cloned_ctx;
8362 mbedtls_md_init(&cloned_ctx);
Jerry Yu615bd6f2022-02-17 14:25:15 +08008363#endif
8364
8365 mbedtls_ssl_session *session = ssl->session_negotiate;
Gilles Peskine449bd832023-01-11 14:50:10 +01008366 if (!session) {
Jerry Yu615bd6f2022-02-17 14:25:15 +08008367 session = ssl->session;
Gilles Peskine449bd832023-01-11 14:50:10 +01008368 }
Jerry Yu615bd6f2022-02-17 14:25:15 +08008369
Gilles Peskine449bd832023-01-11 14:50:10 +01008370 sender = (from == MBEDTLS_SSL_IS_CLIENT)
Jerry Yu615bd6f2022-02-17 14:25:15 +08008371 ? "client finished"
8372 : "server finished";
8373
8374#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008375 MBEDTLS_SSL_DEBUG_MSG(2, ("=> calc PSA finished tls"));
Jerry Yu615bd6f2022-02-17 14:25:15 +08008376
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02008377 status = psa_hash_clone(hs_op, &cloned_op);
Gilles Peskine449bd832023-01-11 14:50:10 +01008378 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01008379 goto exit;
Jerry Yu615bd6f2022-02-17 14:25:15 +08008380 }
8381
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02008382 status = psa_hash_finish(&cloned_op, padbuf, hlen, &hash_size);
Gilles Peskine449bd832023-01-11 14:50:10 +01008383 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01008384 goto exit;
Jerry Yu615bd6f2022-02-17 14:25:15 +08008385 }
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008386 MBEDTLS_SSL_DEBUG_BUF(3, "PSA calculated padbuf", padbuf, hlen);
Jerry Yu615bd6f2022-02-17 14:25:15 +08008387#else
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008388 MBEDTLS_SSL_DEBUG_MSG(2, ("=> calc finished tls"));
Jerry Yu615bd6f2022-02-17 14:25:15 +08008389
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02008390 ret = mbedtls_md_setup(&cloned_ctx, mbedtls_md_info_from_ctx(hs_ctx), 0);
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01008391 if (ret != 0) {
8392 goto exit;
8393 }
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02008394 ret = mbedtls_md_clone(&cloned_ctx, hs_ctx);
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01008395 if (ret != 0) {
8396 goto exit;
8397 }
Jerry Yu615bd6f2022-02-17 14:25:15 +08008398
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02008399 ret = mbedtls_md_finish(&cloned_ctx, padbuf);
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008400 if (ret != 0) {
8401 goto exit;
8402 }
8403#endif /* MBEDTLS_USE_PSA_CRYPTO */
8404
8405 MBEDTLS_SSL_DEBUG_BUF(4, "finished output", padbuf, hlen);
8406
Jerry Yu615bd6f2022-02-17 14:25:15 +08008407 /*
8408 * TLSv1.2:
8409 * hash = PRF( master, finished_label,
8410 * Hash( handshake ) )[0.11]
8411 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008412 ssl->handshake->tls_prf(session->master, 48, sender,
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008413 padbuf, hlen, buf, len);
Jerry Yu615bd6f2022-02-17 14:25:15 +08008414
Gilles Peskine449bd832023-01-11 14:50:10 +01008415 MBEDTLS_SSL_DEBUG_BUF(3, "calc finished result", buf, len);
Jerry Yu615bd6f2022-02-17 14:25:15 +08008416
Paul Elliottecb95be2023-08-11 16:41:04 +01008417 mbedtls_platform_zeroize(padbuf, hlen);
Jerry Yu615bd6f2022-02-17 14:25:15 +08008418
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008419 MBEDTLS_SSL_DEBUG_MSG(2, ("<= calc finished"));
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01008420
8421exit:
8422#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02008423 psa_hash_abort(&cloned_op);
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +02008424 return mbedtls_md_error_from_psa(status);
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01008425#else
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02008426 mbedtls_md_free(&cloned_ctx);
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01008427 return ret;
8428#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu615bd6f2022-02-17 14:25:15 +08008429}
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008430
8431#if defined(MBEDTLS_MD_CAN_SHA256)
8432static int ssl_calc_finished_tls_sha256(
8433 mbedtls_ssl_context *ssl, unsigned char *buf, int from)
8434{
8435 unsigned char padbuf[32];
8436 return ssl_calc_finished_tls_generic(ssl,
8437#if defined(MBEDTLS_USE_PSA_CRYPTO)
8438 &ssl->handshake->fin_sha256_psa,
8439#else
8440 &ssl->handshake->fin_sha256,
8441#endif
8442 padbuf, sizeof(padbuf),
8443 buf, from);
8444}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01008445#endif /* MBEDTLS_MD_CAN_SHA256*/
Jerry Yu615bd6f2022-02-17 14:25:15 +08008446
Jerry Yub7ba49e2022-02-17 14:25:53 +08008447
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01008448#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +01008449static int ssl_calc_finished_tls_sha384(
Gilles Peskine449bd832023-01-11 14:50:10 +01008450 mbedtls_ssl_context *ssl, unsigned char *buf, int from)
Jerry Yub7ba49e2022-02-17 14:25:53 +08008451{
Jerry Yub7ba49e2022-02-17 14:25:53 +08008452 unsigned char padbuf[48];
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008453 return ssl_calc_finished_tls_generic(ssl,
Jerry Yub7ba49e2022-02-17 14:25:53 +08008454#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008455 &ssl->handshake->fin_sha384_psa,
Jerry Yub7ba49e2022-02-17 14:25:53 +08008456#else
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008457 &ssl->handshake->fin_sha384,
Jerry Yub7ba49e2022-02-17 14:25:53 +08008458#endif
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008459 padbuf, sizeof(padbuf),
8460 buf, from);
Jerry Yub7ba49e2022-02-17 14:25:53 +08008461}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01008462#endif /* MBEDTLS_MD_CAN_SHA384*/
Jerry Yub7ba49e2022-02-17 14:25:53 +08008463
Gilles Peskine449bd832023-01-11 14:50:10 +01008464void mbedtls_ssl_handshake_wrapup_free_hs_transform(mbedtls_ssl_context *ssl)
Jerry Yuaef00152022-02-17 14:27:31 +08008465{
Gilles Peskine449bd832023-01-11 14:50:10 +01008466 MBEDTLS_SSL_DEBUG_MSG(3, ("=> handshake wrapup: final free"));
Jerry Yuaef00152022-02-17 14:27:31 +08008467
8468 /*
8469 * Free our handshake params
8470 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008471 mbedtls_ssl_handshake_free(ssl);
8472 mbedtls_free(ssl->handshake);
Jerry Yuaef00152022-02-17 14:27:31 +08008473 ssl->handshake = NULL;
8474
8475 /*
Shaun Case8b0ecbc2021-12-20 21:14:10 -08008476 * Free the previous transform and switch in the current one
Jerry Yuaef00152022-02-17 14:27:31 +08008477 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008478 if (ssl->transform) {
8479 mbedtls_ssl_transform_free(ssl->transform);
8480 mbedtls_free(ssl->transform);
Jerry Yuaef00152022-02-17 14:27:31 +08008481 }
8482 ssl->transform = ssl->transform_negotiate;
8483 ssl->transform_negotiate = NULL;
8484
Gilles Peskine449bd832023-01-11 14:50:10 +01008485 MBEDTLS_SSL_DEBUG_MSG(3, ("<= handshake wrapup: final free"));
Jerry Yuaef00152022-02-17 14:27:31 +08008486}
8487
Gilles Peskine449bd832023-01-11 14:50:10 +01008488void mbedtls_ssl_handshake_wrapup(mbedtls_ssl_context *ssl)
Jerry Yu2a9fff52022-02-17 14:28:51 +08008489{
8490 int resume = ssl->handshake->resume;
8491
Gilles Peskine449bd832023-01-11 14:50:10 +01008492 MBEDTLS_SSL_DEBUG_MSG(3, ("=> handshake wrapup"));
Jerry Yu2a9fff52022-02-17 14:28:51 +08008493
8494#if defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01008495 if (ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS) {
Jerry Yu2a9fff52022-02-17 14:28:51 +08008496 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_DONE;
8497 ssl->renego_records_seen = 0;
8498 }
8499#endif
8500
8501 /*
8502 * Free the previous session and switch in the current one
8503 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008504 if (ssl->session) {
Jerry Yu2a9fff52022-02-17 14:28:51 +08008505#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
8506 /* RFC 7366 3.1: keep the EtM state */
8507 ssl->session_negotiate->encrypt_then_mac =
Gilles Peskine449bd832023-01-11 14:50:10 +01008508 ssl->session->encrypt_then_mac;
Jerry Yu2a9fff52022-02-17 14:28:51 +08008509#endif
8510
Gilles Peskine449bd832023-01-11 14:50:10 +01008511 mbedtls_ssl_session_free(ssl->session);
8512 mbedtls_free(ssl->session);
Jerry Yu2a9fff52022-02-17 14:28:51 +08008513 }
8514 ssl->session = ssl->session_negotiate;
8515 ssl->session_negotiate = NULL;
8516
8517 /*
8518 * Add cache entry
8519 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008520 if (ssl->conf->f_set_cache != NULL &&
Jerry Yu2a9fff52022-02-17 14:28:51 +08008521 ssl->session->id_len != 0 &&
Gilles Peskine449bd832023-01-11 14:50:10 +01008522 resume == 0) {
8523 if (ssl->conf->f_set_cache(ssl->conf->p_cache,
8524 ssl->session->id,
8525 ssl->session->id_len,
8526 ssl->session) != 0) {
8527 MBEDTLS_SSL_DEBUG_MSG(1, ("cache did not store session"));
8528 }
Jerry Yu2a9fff52022-02-17 14:28:51 +08008529 }
8530
8531#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01008532 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
8533 ssl->handshake->flight != NULL) {
Jerry Yu2a9fff52022-02-17 14:28:51 +08008534 /* Cancel handshake timer */
Gilles Peskine449bd832023-01-11 14:50:10 +01008535 mbedtls_ssl_set_timer(ssl, 0);
Jerry Yu2a9fff52022-02-17 14:28:51 +08008536
8537 /* Keep last flight around in case we need to resend it:
8538 * we need the handshake and transform structures for that */
Gilles Peskine449bd832023-01-11 14:50:10 +01008539 MBEDTLS_SSL_DEBUG_MSG(3, ("skip freeing handshake and transform"));
8540 } else
Jerry Yu2a9fff52022-02-17 14:28:51 +08008541#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01008542 mbedtls_ssl_handshake_wrapup_free_hs_transform(ssl);
Jerry Yu2a9fff52022-02-17 14:28:51 +08008543
Jerry Yu5ed73ff2022-10-27 13:08:42 +08008544 ssl->state = MBEDTLS_SSL_HANDSHAKE_OVER;
Jerry Yu2a9fff52022-02-17 14:28:51 +08008545
Gilles Peskine449bd832023-01-11 14:50:10 +01008546 MBEDTLS_SSL_DEBUG_MSG(3, ("<= handshake wrapup"));
Jerry Yu2a9fff52022-02-17 14:28:51 +08008547}
8548
Gilles Peskine449bd832023-01-11 14:50:10 +01008549int mbedtls_ssl_write_finished(mbedtls_ssl_context *ssl)
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008550{
Dave Rodgmanc37ad442023-11-03 23:36:06 +00008551 int ret;
8552 unsigned int hash_len;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008553
Gilles Peskine449bd832023-01-11 14:50:10 +01008554 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write finished"));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008555
Gilles Peskine449bd832023-01-11 14:50:10 +01008556 mbedtls_ssl_update_out_pointers(ssl, ssl->transform_negotiate);
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008557
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01008558 ret = ssl->handshake->calc_finished(ssl, ssl->out_msg + 4, ssl->conf->endpoint);
8559 if (ret != 0) {
8560 MBEDTLS_SSL_DEBUG_RET(1, "calc_finished", ret);
8561 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008562
8563 /*
8564 * RFC 5246 7.4.9 (Page 63) says 12 is the default length and ciphersuites
8565 * may define some other value. Currently (early 2016), no defined
8566 * ciphersuite does this (and this is unlikely to change as activity has
8567 * moved to TLS 1.3 now) so we can keep the hardcoded 12 here.
8568 */
8569 hash_len = 12;
8570
8571#if defined(MBEDTLS_SSL_RENEGOTIATION)
8572 ssl->verify_data_len = hash_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01008573 memcpy(ssl->own_verify_data, ssl->out_msg + 4, hash_len);
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008574#endif
8575
8576 ssl->out_msglen = 4 + hash_len;
8577 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
8578 ssl->out_msg[0] = MBEDTLS_SSL_HS_FINISHED;
8579
8580 /*
8581 * In case of session resuming, invert the client and server
8582 * ChangeCipherSpec messages order.
8583 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008584 if (ssl->handshake->resume != 0) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008585#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008586 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008587 ssl->state = MBEDTLS_SSL_HANDSHAKE_WRAPUP;
Gilles Peskine449bd832023-01-11 14:50:10 +01008588 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008589#endif
8590#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008591 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008592 ssl->state = MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC;
Gilles Peskine449bd832023-01-11 14:50:10 +01008593 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008594#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01008595 } else {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008596 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01008597 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008598
8599 /*
8600 * Switch to our negotiated transform and session parameters for outbound
8601 * data.
8602 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008603 MBEDTLS_SSL_DEBUG_MSG(3, ("switching to new transform spec for outbound data"));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008604
8605#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01008606 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008607 unsigned char i;
8608
8609 /* Remember current epoch settings for resending */
8610 ssl->handshake->alt_transform_out = ssl->transform_out;
Gilles Peskine449bd832023-01-11 14:50:10 +01008611 memcpy(ssl->handshake->alt_out_ctr, ssl->cur_out_ctr,
8612 sizeof(ssl->handshake->alt_out_ctr));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008613
8614 /* Set sequence_number to zero */
Gilles Peskine449bd832023-01-11 14:50:10 +01008615 memset(&ssl->cur_out_ctr[2], 0, sizeof(ssl->cur_out_ctr) - 2);
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008616
8617
8618 /* Increment epoch */
Gilles Peskine449bd832023-01-11 14:50:10 +01008619 for (i = 2; i > 0; i--) {
8620 if (++ssl->cur_out_ctr[i - 1] != 0) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008621 break;
Gilles Peskine449bd832023-01-11 14:50:10 +01008622 }
8623 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008624
8625 /* The loop goes to its end iff the counter is wrapping */
Gilles Peskine449bd832023-01-11 14:50:10 +01008626 if (i == 0) {
8627 MBEDTLS_SSL_DEBUG_MSG(1, ("DTLS epoch would wrap"));
8628 return MBEDTLS_ERR_SSL_COUNTER_WRAPPING;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008629 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008630 } else
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008631#endif /* MBEDTLS_SSL_PROTO_DTLS */
Gilles Peskine449bd832023-01-11 14:50:10 +01008632 memset(ssl->cur_out_ctr, 0, sizeof(ssl->cur_out_ctr));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008633
8634 ssl->transform_out = ssl->transform_negotiate;
8635 ssl->session_out = ssl->session_negotiate;
8636
8637#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01008638 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
8639 mbedtls_ssl_send_flight_completed(ssl);
8640 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008641#endif
8642
Gilles Peskine449bd832023-01-11 14:50:10 +01008643 if ((ret = mbedtls_ssl_write_handshake_msg(ssl)) != 0) {
8644 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_handshake_msg", ret);
8645 return ret;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008646 }
8647
8648#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01008649 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
8650 (ret = mbedtls_ssl_flight_transmit(ssl)) != 0) {
8651 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_flight_transmit", ret);
8652 return ret;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008653 }
8654#endif
8655
Gilles Peskine449bd832023-01-11 14:50:10 +01008656 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write finished"));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008657
Gilles Peskine449bd832023-01-11 14:50:10 +01008658 return 0;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008659}
8660
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008661#define SSL_MAX_HASH_LEN 12
8662
Gilles Peskine449bd832023-01-11 14:50:10 +01008663int mbedtls_ssl_parse_finished(mbedtls_ssl_context *ssl)
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008664{
8665 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
8666 unsigned int hash_len = 12;
8667 unsigned char buf[SSL_MAX_HASH_LEN];
8668
Gilles Peskine449bd832023-01-11 14:50:10 +01008669 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse finished"));
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008670
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01008671 ret = ssl->handshake->calc_finished(ssl, buf, ssl->conf->endpoint ^ 1);
8672 if (ret != 0) {
8673 MBEDTLS_SSL_DEBUG_RET(1, "calc_finished", ret);
8674 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008675
Gilles Peskine449bd832023-01-11 14:50:10 +01008676 if ((ret = mbedtls_ssl_read_record(ssl, 1)) != 0) {
8677 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_read_record", ret);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008678 goto exit;
8679 }
8680
Gilles Peskine449bd832023-01-11 14:50:10 +01008681 if (ssl->in_msgtype != MBEDTLS_SSL_MSG_HANDSHAKE) {
8682 MBEDTLS_SSL_DEBUG_MSG(1, ("bad finished message"));
8683 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8684 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008685 ret = MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
8686 goto exit;
8687 }
8688
Gilles Peskine449bd832023-01-11 14:50:10 +01008689 if (ssl->in_msg[0] != MBEDTLS_SSL_HS_FINISHED) {
8690 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8691 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008692 ret = MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
8693 goto exit;
8694 }
8695
Gilles Peskine449bd832023-01-11 14:50:10 +01008696 if (ssl->in_hslen != mbedtls_ssl_hs_hdr_len(ssl) + hash_len) {
8697 MBEDTLS_SSL_DEBUG_MSG(1, ("bad finished message"));
8698 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8699 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008700 ret = MBEDTLS_ERR_SSL_DECODE_ERROR;
8701 goto exit;
8702 }
8703
Gilles Peskine449bd832023-01-11 14:50:10 +01008704 if (mbedtls_ct_memcmp(ssl->in_msg + mbedtls_ssl_hs_hdr_len(ssl),
8705 buf, hash_len) != 0) {
8706 MBEDTLS_SSL_DEBUG_MSG(1, ("bad finished message"));
8707 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8708 MBEDTLS_SSL_ALERT_MSG_DECRYPT_ERROR);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008709 ret = MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
8710 goto exit;
8711 }
8712
8713#if defined(MBEDTLS_SSL_RENEGOTIATION)
8714 ssl->verify_data_len = hash_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01008715 memcpy(ssl->peer_verify_data, buf, hash_len);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008716#endif
8717
Gilles Peskine449bd832023-01-11 14:50:10 +01008718 if (ssl->handshake->resume != 0) {
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008719#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008720 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008721 ssl->state = MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC;
Gilles Peskine449bd832023-01-11 14:50:10 +01008722 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008723#endif
8724#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008725 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008726 ssl->state = MBEDTLS_SSL_HANDSHAKE_WRAPUP;
Gilles Peskine449bd832023-01-11 14:50:10 +01008727 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008728#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01008729 } else {
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008730 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01008731 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008732
8733#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01008734 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
8735 mbedtls_ssl_recv_flight_completed(ssl);
8736 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008737#endif
8738
Gilles Peskine449bd832023-01-11 14:50:10 +01008739 MBEDTLS_SSL_DEBUG_MSG(2, ("<= parse finished"));
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008740
8741exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01008742 mbedtls_platform_zeroize(buf, hash_len);
8743 return ret;
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008744}
8745
Jerry Yu392112c2022-02-17 14:34:10 +08008746#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
8747/*
8748 * Helper to get TLS 1.2 PRF from ciphersuite
8749 * (Duplicates bits of logic from ssl_set_handshake_prfs().)
8750 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008751static tls_prf_fn ssl_tls12prf_from_cs(int ciphersuite_id)
Jerry Yu392112c2022-02-17 14:34:10 +08008752{
Jerry Yu392112c2022-02-17 14:34:10 +08008753 const mbedtls_ssl_ciphersuite_t * const ciphersuite_info =
Gilles Peskine449bd832023-01-11 14:50:10 +01008754 mbedtls_ssl_ciphersuite_from_id(ciphersuite_id);
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01008755#if defined(MBEDTLS_MD_CAN_SHA384)
Gilles Peskine449bd832023-01-11 14:50:10 +01008756 if (ciphersuite_info != NULL && ciphersuite_info->mac == MBEDTLS_MD_SHA384) {
8757 return tls_prf_sha384;
8758 } else
Jerry Yu392112c2022-02-17 14:34:10 +08008759#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01008760#if defined(MBEDTLS_MD_CAN_SHA256)
Andrzej Kurek894edde2022-09-29 06:31:14 -04008761 {
Gilles Peskine449bd832023-01-11 14:50:10 +01008762 if (ciphersuite_info != NULL && ciphersuite_info->mac == MBEDTLS_MD_SHA256) {
8763 return tls_prf_sha256;
8764 }
Andrzej Kurek894edde2022-09-29 06:31:14 -04008765 }
8766#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01008767#if !defined(MBEDTLS_MD_CAN_SHA384) && \
8768 !defined(MBEDTLS_MD_CAN_SHA256)
Andrzej Kurek894edde2022-09-29 06:31:14 -04008769 (void) ciphersuite_info;
8770#endif
Andrzej Kurekeabeb302022-10-17 07:52:51 -04008771
Gilles Peskine449bd832023-01-11 14:50:10 +01008772 return NULL;
Jerry Yu392112c2022-02-17 14:34:10 +08008773}
8774#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
Jerry Yue93ffcd2022-02-17 14:37:06 +08008775
Gilles Peskine449bd832023-01-11 14:50:10 +01008776static mbedtls_tls_prf_types tls_prf_get_type(mbedtls_ssl_tls_prf_cb *tls_prf)
Jerry Yue93ffcd2022-02-17 14:37:06 +08008777{
8778 ((void) tls_prf);
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01008779#if defined(MBEDTLS_MD_CAN_SHA384)
Gilles Peskine449bd832023-01-11 14:50:10 +01008780 if (tls_prf == tls_prf_sha384) {
8781 return MBEDTLS_SSL_TLS_PRF_SHA384;
8782 } else
Jerry Yue93ffcd2022-02-17 14:37:06 +08008783#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01008784#if defined(MBEDTLS_MD_CAN_SHA256)
Gilles Peskine449bd832023-01-11 14:50:10 +01008785 if (tls_prf == tls_prf_sha256) {
8786 return MBEDTLS_SSL_TLS_PRF_SHA256;
8787 } else
Jerry Yue93ffcd2022-02-17 14:37:06 +08008788#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01008789 return MBEDTLS_SSL_TLS_PRF_NONE;
Jerry Yue93ffcd2022-02-17 14:37:06 +08008790}
8791
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008792/*
8793 * Populate a transform structure with session keys and all the other
8794 * necessary information.
8795 *
8796 * Parameters:
8797 * - [in/out]: transform: structure to populate
8798 * [in] must be just initialised with mbedtls_ssl_transform_init()
8799 * [out] fully populated, ready for use by mbedtls_ssl_{en,de}crypt_buf()
8800 * - [in] ciphersuite
8801 * - [in] master
8802 * - [in] encrypt_then_mac
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008803 * - [in] tls_prf: pointer to PRF to use for key derivation
8804 * - [in] randbytes: buffer holding ServerHello.random + ClientHello.random
Glenn Strauss07c64162022-03-14 12:34:51 -04008805 * - [in] tls_version: TLS version
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008806 * - [in] endpoint: client or server
8807 * - [in] ssl: used for:
8808 * - ssl->conf->{f,p}_export_keys
8809 * [in] optionally used for:
8810 * - MBEDTLS_DEBUG_C: ssl->conf->{f,p}_dbg
8811 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02008812MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01008813static int ssl_tls12_populate_transform(mbedtls_ssl_transform *transform,
8814 int ciphersuite,
8815 const unsigned char master[48],
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008816#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01008817 int encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008818#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01008819 ssl_tls_prf_t tls_prf,
8820 const unsigned char randbytes[64],
8821 mbedtls_ssl_protocol_version tls_version,
8822 unsigned endpoint,
8823 const mbedtls_ssl_context *ssl)
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008824{
8825 int ret = 0;
8826 unsigned char keyblk[256];
8827 unsigned char *key1;
8828 unsigned char *key2;
8829 unsigned char *mac_enc;
8830 unsigned char *mac_dec;
8831 size_t mac_key_len = 0;
8832 size_t iv_copy_len;
8833 size_t keylen;
8834 const mbedtls_ssl_ciphersuite_t *ciphersuite_info;
Neil Armstrong7fea33e2022-04-01 15:40:25 +02008835 mbedtls_ssl_mode_t ssl_mode;
Neil Armstronge4512952022-03-08 09:08:22 +01008836#if !defined(MBEDTLS_USE_PSA_CRYPTO)
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008837 const mbedtls_cipher_info_t *cipher_info;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008838 const mbedtls_md_info_t *md_info;
Neil Armstronge4512952022-03-08 09:08:22 +01008839#endif /* !MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008840
8841#if defined(MBEDTLS_USE_PSA_CRYPTO)
8842 psa_key_type_t key_type;
8843 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
8844 psa_algorithm_t alg;
Neil Armstronge4512952022-03-08 09:08:22 +01008845 psa_algorithm_t mac_alg = 0;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008846 size_t key_bits;
8847 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
8848#endif
8849
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008850 /*
8851 * Some data just needs copying into the structure
8852 */
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008853#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008854 transform->encrypt_then_mac = encrypt_then_mac;
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008855#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Glenn Strauss07c64162022-03-14 12:34:51 -04008856 transform->tls_version = tls_version;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008857
8858#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01008859 memcpy(transform->randbytes, randbytes, sizeof(transform->randbytes));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008860#endif
8861
8862#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01008863 if (tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008864 /* At the moment, we keep TLS <= 1.2 and TLS 1.3 transform
8865 * generation separate. This should never happen. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008866 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008867 }
8868#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
8869
8870 /*
8871 * Get various info structures
8872 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008873 ciphersuite_info = mbedtls_ssl_ciphersuite_from_id(ciphersuite);
8874 if (ciphersuite_info == NULL) {
8875 MBEDTLS_SSL_DEBUG_MSG(1, ("ciphersuite info for %d not found",
8876 ciphersuite));
8877 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008878 }
8879
Neil Armstrongab555e02022-04-04 11:07:59 +02008880 ssl_mode = mbedtls_ssl_get_mode_from_ciphersuite(
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008881#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01008882 encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008883#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01008884 ciphersuite_info);
Neil Armstrong7fea33e2022-04-01 15:40:25 +02008885
Gilles Peskine449bd832023-01-11 14:50:10 +01008886 if (ssl_mode == MBEDTLS_SSL_MODE_AEAD) {
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008887 transform->taglen =
8888 ciphersuite_info->flags & MBEDTLS_CIPHERSUITE_SHORT_TAG ? 8 : 16;
Gilles Peskine449bd832023-01-11 14:50:10 +01008889 }
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008890
8891#if defined(MBEDTLS_USE_PSA_CRYPTO)
Dave Rodgman2eab4622023-10-05 13:30:37 +01008892 if ((status = mbedtls_ssl_cipher_to_psa((mbedtls_cipher_type_t) ciphersuite_info->cipher,
Gilles Peskine449bd832023-01-11 14:50:10 +01008893 transform->taglen,
8894 &alg,
8895 &key_type,
8896 &key_bits)) != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008897 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01008898 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_cipher_to_psa", ret);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008899 goto end;
8900 }
8901#else
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01008902 cipher_info = mbedtls_cipher_info_from_type((mbedtls_cipher_type_t) ciphersuite_info->cipher);
Gilles Peskine449bd832023-01-11 14:50:10 +01008903 if (cipher_info == NULL) {
8904 MBEDTLS_SSL_DEBUG_MSG(1, ("cipher info for %u not found",
8905 ciphersuite_info->cipher));
8906 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008907 }
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008908#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008909
Neil Armstronge4512952022-03-08 09:08:22 +01008910#if defined(MBEDTLS_USE_PSA_CRYPTO)
Dave Rodgman2eab4622023-10-05 13:30:37 +01008911 mac_alg = mbedtls_md_psa_alg_from_type((mbedtls_md_type_t) ciphersuite_info->mac);
Gilles Peskine449bd832023-01-11 14:50:10 +01008912 if (mac_alg == 0) {
Manuel Pégourié-Gonnard2d6d9932023-03-28 11:38:08 +02008913 MBEDTLS_SSL_DEBUG_MSG(1, ("mbedtls_md_psa_alg_from_type for %u not found",
Gilles Peskine449bd832023-01-11 14:50:10 +01008914 (unsigned) ciphersuite_info->mac));
8915 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Neil Armstronge4512952022-03-08 09:08:22 +01008916 }
8917#else
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01008918 md_info = mbedtls_md_info_from_type((mbedtls_md_type_t) ciphersuite_info->mac);
Gilles Peskine449bd832023-01-11 14:50:10 +01008919 if (md_info == NULL) {
8920 MBEDTLS_SSL_DEBUG_MSG(1, ("mbedtls_md info for %u not found",
8921 (unsigned) ciphersuite_info->mac));
8922 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008923 }
Neil Armstronge4512952022-03-08 09:08:22 +01008924#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008925
8926#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
8927 /* Copy own and peer's CID if the use of the CID
8928 * extension has been negotiated. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008929 if (ssl->handshake->cid_in_use == MBEDTLS_SSL_CID_ENABLED) {
8930 MBEDTLS_SSL_DEBUG_MSG(3, ("Copy CIDs into SSL transform"));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008931
8932 transform->in_cid_len = ssl->own_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01008933 memcpy(transform->in_cid, ssl->own_cid, ssl->own_cid_len);
8934 MBEDTLS_SSL_DEBUG_BUF(3, "Incoming CID", transform->in_cid,
8935 transform->in_cid_len);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008936
8937 transform->out_cid_len = ssl->handshake->peer_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01008938 memcpy(transform->out_cid, ssl->handshake->peer_cid,
8939 ssl->handshake->peer_cid_len);
8940 MBEDTLS_SSL_DEBUG_BUF(3, "Outgoing CID", transform->out_cid,
8941 transform->out_cid_len);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008942 }
8943#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
8944
8945 /*
8946 * Compute key block using the PRF
8947 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008948 ret = tls_prf(master, 48, "key expansion", randbytes, 64, keyblk, 256);
8949 if (ret != 0) {
8950 MBEDTLS_SSL_DEBUG_RET(1, "prf", ret);
8951 return ret;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008952 }
8953
Gilles Peskine449bd832023-01-11 14:50:10 +01008954 MBEDTLS_SSL_DEBUG_MSG(3, ("ciphersuite = %s",
8955 mbedtls_ssl_get_ciphersuite_name(ciphersuite)));
8956 MBEDTLS_SSL_DEBUG_BUF(3, "master secret", master, 48);
8957 MBEDTLS_SSL_DEBUG_BUF(4, "random bytes", randbytes, 64);
8958 MBEDTLS_SSL_DEBUG_BUF(4, "key block", keyblk, 256);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008959
8960 /*
8961 * Determine the appropriate key, IV and MAC length.
8962 */
8963
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008964#if defined(MBEDTLS_USE_PSA_CRYPTO)
8965 keylen = PSA_BITS_TO_BYTES(key_bits);
8966#else
Gilles Peskine449bd832023-01-11 14:50:10 +01008967 keylen = mbedtls_cipher_info_get_key_bitlen(cipher_info) / 8;
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008968#endif
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008969
Valerio Settie5707042023-10-11 11:54:42 +02008970#if defined(MBEDTLS_SSL_HAVE_AEAD)
Gilles Peskine449bd832023-01-11 14:50:10 +01008971 if (ssl_mode == MBEDTLS_SSL_MODE_AEAD) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008972 size_t explicit_ivlen;
8973
8974 transform->maclen = 0;
8975 mac_key_len = 0;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008976
8977 /* All modes haves 96-bit IVs, but the length of the static parts vary
8978 * with mode and version:
8979 * - For GCM and CCM in TLS 1.2, there's a static IV of 4 Bytes
8980 * (to be concatenated with a dynamically chosen IV of 8 Bytes)
8981 * - For ChaChaPoly in TLS 1.2, and all modes in TLS 1.3, there's
8982 * a static IV of 12 Bytes (to be XOR'ed with the 8 Byte record
8983 * sequence number).
8984 */
8985 transform->ivlen = 12;
David Horstmann3b2276a2022-10-06 14:49:08 +01008986
8987 int is_chachapoly = 0;
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008988#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01008989 is_chachapoly = (key_type == PSA_KEY_TYPE_CHACHA20);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008990#else
Gilles Peskine449bd832023-01-11 14:50:10 +01008991 is_chachapoly = (mbedtls_cipher_info_get_mode(cipher_info)
8992 == MBEDTLS_MODE_CHACHAPOLY);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008993#endif /* MBEDTLS_USE_PSA_CRYPTO */
David Horstmann3b2276a2022-10-06 14:49:08 +01008994
Gilles Peskine449bd832023-01-11 14:50:10 +01008995 if (is_chachapoly) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008996 transform->fixed_ivlen = 12;
Gilles Peskine449bd832023-01-11 14:50:10 +01008997 } else {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008998 transform->fixed_ivlen = 4;
Gilles Peskine449bd832023-01-11 14:50:10 +01008999 }
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009000
9001 /* Minimum length of encrypted record */
9002 explicit_ivlen = transform->ivlen - transform->fixed_ivlen;
9003 transform->minlen = explicit_ivlen + transform->taglen;
Gilles Peskine449bd832023-01-11 14:50:10 +01009004 } else
Valerio Settie5707042023-10-11 11:54:42 +02009005#endif /* MBEDTLS_SSL_HAVE_AEAD */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009006#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01009007 if (ssl_mode == MBEDTLS_SSL_MODE_STREAM ||
Neil Armstrong7fea33e2022-04-01 15:40:25 +02009008 ssl_mode == MBEDTLS_SSL_MODE_CBC ||
Gilles Peskine449bd832023-01-11 14:50:10 +01009009 ssl_mode == MBEDTLS_SSL_MODE_CBC_ETM) {
Neil Armstronge4512952022-03-08 09:08:22 +01009010#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01009011 size_t block_size = PSA_BLOCK_CIPHER_BLOCK_LENGTH(key_type);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02009012#else
Dave Rodgman85a88132023-06-24 11:41:50 +01009013 size_t block_size = mbedtls_cipher_info_get_block_size(cipher_info);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02009014#endif /* MBEDTLS_USE_PSA_CRYPTO */
9015
9016#if defined(MBEDTLS_USE_PSA_CRYPTO)
Neil Armstronge4512952022-03-08 09:08:22 +01009017 /* Get MAC length */
9018 mac_key_len = PSA_HASH_LENGTH(mac_alg);
9019#else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009020 /* Initialize HMAC contexts */
Gilles Peskine449bd832023-01-11 14:50:10 +01009021 if ((ret = mbedtls_md_setup(&transform->md_ctx_enc, md_info, 1)) != 0 ||
9022 (ret = mbedtls_md_setup(&transform->md_ctx_dec, md_info, 1)) != 0) {
9023 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_setup", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009024 goto end;
9025 }
9026
9027 /* Get MAC length */
Gilles Peskine449bd832023-01-11 14:50:10 +01009028 mac_key_len = mbedtls_md_get_size(md_info);
Neil Armstronge4512952022-03-08 09:08:22 +01009029#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009030 transform->maclen = mac_key_len;
9031
9032 /* IV length */
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02009033#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01009034 transform->ivlen = PSA_CIPHER_IV_LENGTH(key_type, alg);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02009035#else
Dave Rodgmanbb521fd2023-06-24 11:21:25 +01009036 transform->ivlen = mbedtls_cipher_info_get_iv_size(cipher_info);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02009037#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009038
9039 /* Minimum length */
Gilles Peskine449bd832023-01-11 14:50:10 +01009040 if (ssl_mode == MBEDTLS_SSL_MODE_STREAM) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009041 transform->minlen = transform->maclen;
Gilles Peskine449bd832023-01-11 14:50:10 +01009042 } else {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009043 /*
9044 * GenericBlockCipher:
9045 * 1. if EtM is in use: one block plus MAC
9046 * otherwise: * first multiple of blocklen greater than maclen
9047 * 2. IV
9048 */
9049#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01009050 if (ssl_mode == MBEDTLS_SSL_MODE_CBC_ETM) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009051 transform->minlen = transform->maclen
Gilles Peskine449bd832023-01-11 14:50:10 +01009052 + block_size;
9053 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009054#endif
9055 {
9056 transform->minlen = transform->maclen
Gilles Peskine449bd832023-01-11 14:50:10 +01009057 + block_size
9058 - transform->maclen % block_size;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009059 }
9060
Gilles Peskine449bd832023-01-11 14:50:10 +01009061 if (tls_version == MBEDTLS_SSL_VERSION_TLS1_2) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009062 transform->minlen += transform->ivlen;
Gilles Peskine449bd832023-01-11 14:50:10 +01009063 } else {
9064 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009065 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
9066 goto end;
9067 }
9068 }
Gilles Peskine449bd832023-01-11 14:50:10 +01009069 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009070#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
9071 {
Gilles Peskine449bd832023-01-11 14:50:10 +01009072 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
9073 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009074 }
9075
Gilles Peskine449bd832023-01-11 14:50:10 +01009076 MBEDTLS_SSL_DEBUG_MSG(3, ("keylen: %u, minlen: %u, ivlen: %u, maclen: %u",
9077 (unsigned) keylen,
9078 (unsigned) transform->minlen,
9079 (unsigned) transform->ivlen,
9080 (unsigned) transform->maclen));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009081
9082 /*
9083 * Finally setup the cipher contexts, IVs and MAC secrets.
9084 */
9085#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01009086 if (endpoint == MBEDTLS_SSL_IS_CLIENT) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009087 key1 = keyblk + mac_key_len * 2;
9088 key2 = keyblk + mac_key_len * 2 + keylen;
9089
9090 mac_enc = keyblk;
9091 mac_dec = keyblk + mac_key_len;
9092
Gilles Peskine449bd832023-01-11 14:50:10 +01009093 iv_copy_len = (transform->fixed_ivlen) ?
9094 transform->fixed_ivlen : transform->ivlen;
9095 memcpy(transform->iv_enc, key2 + keylen, iv_copy_len);
9096 memcpy(transform->iv_dec, key2 + keylen + iv_copy_len,
9097 iv_copy_len);
9098 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009099#endif /* MBEDTLS_SSL_CLI_C */
9100#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01009101 if (endpoint == MBEDTLS_SSL_IS_SERVER) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009102 key1 = keyblk + mac_key_len * 2 + keylen;
9103 key2 = keyblk + mac_key_len * 2;
9104
9105 mac_enc = keyblk + mac_key_len;
9106 mac_dec = keyblk;
9107
Gilles Peskine449bd832023-01-11 14:50:10 +01009108 iv_copy_len = (transform->fixed_ivlen) ?
9109 transform->fixed_ivlen : transform->ivlen;
9110 memcpy(transform->iv_dec, key1 + keylen, iv_copy_len);
9111 memcpy(transform->iv_enc, key1 + keylen + iv_copy_len,
9112 iv_copy_len);
9113 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009114#endif /* MBEDTLS_SSL_SRV_C */
9115 {
Gilles Peskine449bd832023-01-11 14:50:10 +01009116 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009117 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
9118 goto end;
9119 }
9120
Paul Elliott4fb19552023-10-18 12:15:30 +01009121 if (ssl->f_export_keys != NULL) {
Gilles Peskine449bd832023-01-11 14:50:10 +01009122 ssl->f_export_keys(ssl->p_export_keys,
9123 MBEDTLS_SSL_KEY_EXPORT_TLS12_MASTER_SECRET,
9124 master, 48,
9125 randbytes + 32,
9126 randbytes,
9127 tls_prf_get_type(tls_prf));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009128 }
9129
9130#if defined(MBEDTLS_USE_PSA_CRYPTO)
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009131 transform->psa_alg = alg;
9132
Gilles Peskine449bd832023-01-11 14:50:10 +01009133 if (alg != MBEDTLS_SSL_NULL_CIPHER) {
9134 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_ENCRYPT);
9135 psa_set_key_algorithm(&attributes, alg);
9136 psa_set_key_type(&attributes, key_type);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009137
Gilles Peskine449bd832023-01-11 14:50:10 +01009138 if ((status = psa_import_key(&attributes,
9139 key1,
9140 PSA_BITS_TO_BYTES(key_bits),
9141 &transform->psa_key_enc)) != PSA_SUCCESS) {
9142 MBEDTLS_SSL_DEBUG_RET(3, "psa_import_key", (int) status);
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05009143 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01009144 MBEDTLS_SSL_DEBUG_RET(1, "psa_import_key", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009145 goto end;
9146 }
9147
Gilles Peskine449bd832023-01-11 14:50:10 +01009148 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_DECRYPT);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009149
Gilles Peskine449bd832023-01-11 14:50:10 +01009150 if ((status = psa_import_key(&attributes,
9151 key2,
9152 PSA_BITS_TO_BYTES(key_bits),
9153 &transform->psa_key_dec)) != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05009154 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01009155 MBEDTLS_SSL_DEBUG_RET(1, "psa_import_key", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009156 goto end;
9157 }
9158 }
9159#else
Gilles Peskine449bd832023-01-11 14:50:10 +01009160 if ((ret = mbedtls_cipher_setup(&transform->cipher_ctx_enc,
9161 cipher_info)) != 0) {
9162 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_setup", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009163 goto end;
9164 }
9165
Gilles Peskine449bd832023-01-11 14:50:10 +01009166 if ((ret = mbedtls_cipher_setup(&transform->cipher_ctx_dec,
9167 cipher_info)) != 0) {
9168 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_setup", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009169 goto end;
9170 }
9171
Gilles Peskine449bd832023-01-11 14:50:10 +01009172 if ((ret = mbedtls_cipher_setkey(&transform->cipher_ctx_enc, key1,
9173 (int) mbedtls_cipher_info_get_key_bitlen(cipher_info),
9174 MBEDTLS_ENCRYPT)) != 0) {
9175 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_setkey", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009176 goto end;
9177 }
9178
Gilles Peskine449bd832023-01-11 14:50:10 +01009179 if ((ret = mbedtls_cipher_setkey(&transform->cipher_ctx_dec, key2,
9180 (int) mbedtls_cipher_info_get_key_bitlen(cipher_info),
9181 MBEDTLS_DECRYPT)) != 0) {
9182 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_setkey", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009183 goto end;
9184 }
9185
9186#if defined(MBEDTLS_CIPHER_MODE_CBC)
Gilles Peskine449bd832023-01-11 14:50:10 +01009187 if (mbedtls_cipher_info_get_mode(cipher_info) == MBEDTLS_MODE_CBC) {
9188 if ((ret = mbedtls_cipher_set_padding_mode(&transform->cipher_ctx_enc,
9189 MBEDTLS_PADDING_NONE)) != 0) {
9190 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_set_padding_mode", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009191 goto end;
9192 }
9193
Gilles Peskine449bd832023-01-11 14:50:10 +01009194 if ((ret = mbedtls_cipher_set_padding_mode(&transform->cipher_ctx_dec,
9195 MBEDTLS_PADDING_NONE)) != 0) {
9196 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_set_padding_mode", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009197 goto end;
9198 }
9199 }
9200#endif /* MBEDTLS_CIPHER_MODE_CBC */
9201#endif /* MBEDTLS_USE_PSA_CRYPTO */
9202
Neil Armstrong29c0c042022-03-17 17:47:28 +01009203#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
9204 /* For HMAC-based ciphersuites, initialize the HMAC transforms.
9205 For AEAD-based ciphersuites, there is nothing to do here. */
Gilles Peskine449bd832023-01-11 14:50:10 +01009206 if (mac_key_len != 0) {
Neil Armstrong29c0c042022-03-17 17:47:28 +01009207#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01009208 transform->psa_mac_alg = PSA_ALG_HMAC(mac_alg);
Neil Armstrong29c0c042022-03-17 17:47:28 +01009209
Gilles Peskine449bd832023-01-11 14:50:10 +01009210 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_SIGN_MESSAGE);
9211 psa_set_key_algorithm(&attributes, PSA_ALG_HMAC(mac_alg));
9212 psa_set_key_type(&attributes, PSA_KEY_TYPE_HMAC);
Neil Armstrong29c0c042022-03-17 17:47:28 +01009213
Gilles Peskine449bd832023-01-11 14:50:10 +01009214 if ((status = psa_import_key(&attributes,
9215 mac_enc, mac_key_len,
9216 &transform->psa_mac_enc)) != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05009217 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01009218 MBEDTLS_SSL_DEBUG_RET(1, "psa_import_mac_key", ret);
Neil Armstrong29c0c042022-03-17 17:47:28 +01009219 goto end;
9220 }
9221
Gilles Peskine449bd832023-01-11 14:50:10 +01009222 if ((transform->psa_alg == MBEDTLS_SSL_NULL_CIPHER) ||
9223 ((transform->psa_alg == PSA_ALG_CBC_NO_PADDING)
Andrzej Kurek8c95ac42022-08-17 16:17:00 -04009224#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01009225 && (transform->encrypt_then_mac == MBEDTLS_SSL_ETM_DISABLED)
Andrzej Kurek8c95ac42022-08-17 16:17:00 -04009226#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01009227 )) {
Neil Armstrong29c0c042022-03-17 17:47:28 +01009228 /* mbedtls_ct_hmac() requires the key to be exportable */
Gilles Peskine449bd832023-01-11 14:50:10 +01009229 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_EXPORT |
9230 PSA_KEY_USAGE_VERIFY_HASH);
9231 } else {
9232 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_VERIFY_HASH);
9233 }
Neil Armstrong29c0c042022-03-17 17:47:28 +01009234
Gilles Peskine449bd832023-01-11 14:50:10 +01009235 if ((status = psa_import_key(&attributes,
9236 mac_dec, mac_key_len,
9237 &transform->psa_mac_dec)) != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05009238 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01009239 MBEDTLS_SSL_DEBUG_RET(1, "psa_import_mac_key", ret);
Neil Armstrong29c0c042022-03-17 17:47:28 +01009240 goto end;
9241 }
9242#else
Gilles Peskine449bd832023-01-11 14:50:10 +01009243 ret = mbedtls_md_hmac_starts(&transform->md_ctx_enc, mac_enc, mac_key_len);
9244 if (ret != 0) {
Neil Armstrong29c0c042022-03-17 17:47:28 +01009245 goto end;
Gilles Peskine449bd832023-01-11 14:50:10 +01009246 }
9247 ret = mbedtls_md_hmac_starts(&transform->md_ctx_dec, mac_dec, mac_key_len);
9248 if (ret != 0) {
Neil Armstrong29c0c042022-03-17 17:47:28 +01009249 goto end;
Gilles Peskine449bd832023-01-11 14:50:10 +01009250 }
Neil Armstrong29c0c042022-03-17 17:47:28 +01009251#endif /* MBEDTLS_USE_PSA_CRYPTO */
9252 }
9253#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
9254
9255 ((void) mac_dec);
9256 ((void) mac_enc);
9257
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009258end:
Gilles Peskine449bd832023-01-11 14:50:10 +01009259 mbedtls_platform_zeroize(keyblk, sizeof(keyblk));
9260 return ret;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009261}
9262
Valerio Settia08b1a42022-11-17 15:10:02 +01009263#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED) && \
9264 defined(MBEDTLS_USE_PSA_CRYPTO)
Valerio Setti6b3dab02022-11-17 17:14:54 +01009265int mbedtls_psa_ecjpake_read_round(
Gilles Peskine449bd832023-01-11 14:50:10 +01009266 psa_pake_operation_t *pake_ctx,
9267 const unsigned char *buf,
9268 size_t len, mbedtls_ecjpake_rounds_t round)
Valerio Settia08b1a42022-11-17 15:10:02 +01009269{
9270 psa_status_t status;
9271 size_t input_offset = 0;
Valerio Setti819de862022-11-17 18:05:19 +01009272 /*
Valerio Setti6b3dab02022-11-17 17:14:54 +01009273 * At round one repeat the KEY_SHARE, ZK_PUBLIC & ZF_PROOF twice
9274 * At round two perform a single cycle
9275 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009276 unsigned int remaining_steps = (round == MBEDTLS_ECJPAKE_ROUND_ONE) ? 2 : 1;
Valerio Settia08b1a42022-11-17 15:10:02 +01009277
Gilles Peskine449bd832023-01-11 14:50:10 +01009278 for (; remaining_steps > 0; remaining_steps--) {
9279 for (psa_pake_step_t step = PSA_PAKE_STEP_KEY_SHARE;
Valerio Settia08b1a42022-11-17 15:10:02 +01009280 step <= PSA_PAKE_STEP_ZK_PROOF;
Gilles Peskine449bd832023-01-11 14:50:10 +01009281 ++step) {
Valerio Settia08b1a42022-11-17 15:10:02 +01009282 /* Length is stored at the first byte */
9283 size_t length = buf[input_offset];
9284 input_offset += 1;
9285
Gilles Peskine449bd832023-01-11 14:50:10 +01009286 if (input_offset + length > len) {
Valerio Settia08b1a42022-11-17 15:10:02 +01009287 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
9288 }
9289
Gilles Peskine449bd832023-01-11 14:50:10 +01009290 status = psa_pake_input(pake_ctx, step,
9291 buf + input_offset, length);
9292 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05009293 return PSA_TO_MBEDTLS_ERR(status);
Valerio Settia08b1a42022-11-17 15:10:02 +01009294 }
9295
9296 input_offset += length;
9297 }
9298 }
9299
Gilles Peskine449bd832023-01-11 14:50:10 +01009300 if (input_offset != len) {
Valerio Setti61ea17d2022-11-18 12:11:00 +01009301 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Gilles Peskine449bd832023-01-11 14:50:10 +01009302 }
Valerio Setti30ebe112022-11-17 16:23:34 +01009303
Gilles Peskine449bd832023-01-11 14:50:10 +01009304 return 0;
Valerio Settia08b1a42022-11-17 15:10:02 +01009305}
9306
Valerio Setti6b3dab02022-11-17 17:14:54 +01009307int mbedtls_psa_ecjpake_write_round(
Gilles Peskine449bd832023-01-11 14:50:10 +01009308 psa_pake_operation_t *pake_ctx,
9309 unsigned char *buf,
9310 size_t len, size_t *olen,
9311 mbedtls_ecjpake_rounds_t round)
Valerio Settia08b1a42022-11-17 15:10:02 +01009312{
9313 psa_status_t status;
9314 size_t output_offset = 0;
9315 size_t output_len;
Valerio Setti819de862022-11-17 18:05:19 +01009316 /*
Valerio Setti6b3dab02022-11-17 17:14:54 +01009317 * At round one repeat the KEY_SHARE, ZK_PUBLIC & ZF_PROOF twice
9318 * At round two perform a single cycle
9319 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009320 unsigned int remaining_steps = (round == MBEDTLS_ECJPAKE_ROUND_ONE) ? 2 : 1;
Valerio Settia08b1a42022-11-17 15:10:02 +01009321
Gilles Peskine449bd832023-01-11 14:50:10 +01009322 for (; remaining_steps > 0; remaining_steps--) {
9323 for (psa_pake_step_t step = PSA_PAKE_STEP_KEY_SHARE;
9324 step <= PSA_PAKE_STEP_ZK_PROOF;
9325 ++step) {
Valerio Setti79f6b6b2022-11-21 14:17:03 +01009326 /*
Valerio Settid4a9b1a2022-11-22 11:11:10 +01009327 * For each step, prepend 1 byte with the length of the data as
9328 * given by psa_pake_output().
Valerio Setti79f6b6b2022-11-21 14:17:03 +01009329 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009330 status = psa_pake_output(pake_ctx, step,
9331 buf + output_offset + 1,
9332 len - output_offset - 1,
9333 &output_len);
9334 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05009335 return PSA_TO_MBEDTLS_ERR(status);
Valerio Settia08b1a42022-11-17 15:10:02 +01009336 }
9337
Valerio Setti99d88c12022-11-22 16:03:43 +01009338 *(buf + output_offset) = (uint8_t) output_len;
Valerio Setti79f6b6b2022-11-21 14:17:03 +01009339
9340 output_offset += output_len + 1;
Valerio Settia08b1a42022-11-17 15:10:02 +01009341 }
9342 }
9343
9344 *olen = output_offset;
9345
Gilles Peskine449bd832023-01-11 14:50:10 +01009346 return 0;
Valerio Settia08b1a42022-11-17 15:10:02 +01009347}
Valerio Settia08b1a42022-11-17 15:10:02 +01009348#endif //MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED && MBEDTLS_USE_PSA_CRYPTO
9349
Jerry Yuee40f9d2022-02-17 14:55:16 +08009350#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01009351int mbedtls_ssl_get_key_exchange_md_tls1_2(mbedtls_ssl_context *ssl,
9352 unsigned char *hash, size_t *hashlen,
9353 unsigned char *data, size_t data_len,
9354 mbedtls_md_type_t md_alg)
Jerry Yuee40f9d2022-02-17 14:55:16 +08009355{
9356 psa_status_t status;
9357 psa_hash_operation_t hash_operation = PSA_HASH_OPERATION_INIT;
Manuel Pégourié-Gonnard2d6d9932023-03-28 11:38:08 +02009358 psa_algorithm_t hash_alg = mbedtls_md_psa_alg_from_type(md_alg);
Jerry Yuee40f9d2022-02-17 14:55:16 +08009359
Gilles Peskine449bd832023-01-11 14:50:10 +01009360 MBEDTLS_SSL_DEBUG_MSG(3, ("Perform PSA-based computation of digest of ServerKeyExchange"));
Jerry Yuee40f9d2022-02-17 14:55:16 +08009361
Gilles Peskine449bd832023-01-11 14:50:10 +01009362 if ((status = psa_hash_setup(&hash_operation,
9363 hash_alg)) != PSA_SUCCESS) {
9364 MBEDTLS_SSL_DEBUG_RET(1, "psa_hash_setup", status);
Jerry Yuee40f9d2022-02-17 14:55:16 +08009365 goto exit;
9366 }
9367
Gilles Peskine449bd832023-01-11 14:50:10 +01009368 if ((status = psa_hash_update(&hash_operation, ssl->handshake->randbytes,
9369 64)) != PSA_SUCCESS) {
9370 MBEDTLS_SSL_DEBUG_RET(1, "psa_hash_update", status);
Jerry Yuee40f9d2022-02-17 14:55:16 +08009371 goto exit;
9372 }
9373
Gilles Peskine449bd832023-01-11 14:50:10 +01009374 if ((status = psa_hash_update(&hash_operation,
9375 data, data_len)) != PSA_SUCCESS) {
9376 MBEDTLS_SSL_DEBUG_RET(1, "psa_hash_update", status);
Jerry Yuee40f9d2022-02-17 14:55:16 +08009377 goto exit;
9378 }
9379
Gilles Peskine449bd832023-01-11 14:50:10 +01009380 if ((status = psa_hash_finish(&hash_operation, hash, PSA_HASH_MAX_SIZE,
9381 hashlen)) != PSA_SUCCESS) {
9382 MBEDTLS_SSL_DEBUG_RET(1, "psa_hash_finish", status);
9383 goto exit;
Jerry Yuee40f9d2022-02-17 14:55:16 +08009384 }
9385
9386exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01009387 if (status != PSA_SUCCESS) {
9388 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
9389 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR);
9390 switch (status) {
Jerry Yuee40f9d2022-02-17 14:55:16 +08009391 case PSA_ERROR_NOT_SUPPORTED:
Gilles Peskine449bd832023-01-11 14:50:10 +01009392 return MBEDTLS_ERR_MD_FEATURE_UNAVAILABLE;
Jerry Yuee40f9d2022-02-17 14:55:16 +08009393 case PSA_ERROR_BAD_STATE: /* Intentional fallthrough */
9394 case PSA_ERROR_BUFFER_TOO_SMALL:
Gilles Peskine449bd832023-01-11 14:50:10 +01009395 return MBEDTLS_ERR_MD_BAD_INPUT_DATA;
Jerry Yuee40f9d2022-02-17 14:55:16 +08009396 case PSA_ERROR_INSUFFICIENT_MEMORY:
Gilles Peskine449bd832023-01-11 14:50:10 +01009397 return MBEDTLS_ERR_MD_ALLOC_FAILED;
Jerry Yuee40f9d2022-02-17 14:55:16 +08009398 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01009399 return MBEDTLS_ERR_PLATFORM_HW_ACCEL_FAILED;
Jerry Yuee40f9d2022-02-17 14:55:16 +08009400 }
9401 }
Gilles Peskine449bd832023-01-11 14:50:10 +01009402 return 0;
Jerry Yuee40f9d2022-02-17 14:55:16 +08009403}
9404
9405#else
9406
Gilles Peskine449bd832023-01-11 14:50:10 +01009407int mbedtls_ssl_get_key_exchange_md_tls1_2(mbedtls_ssl_context *ssl,
9408 unsigned char *hash, size_t *hashlen,
9409 unsigned char *data, size_t data_len,
9410 mbedtls_md_type_t md_alg)
Jerry Yuee40f9d2022-02-17 14:55:16 +08009411{
9412 int ret = 0;
9413 mbedtls_md_context_t ctx;
Gilles Peskine449bd832023-01-11 14:50:10 +01009414 const mbedtls_md_info_t *md_info = mbedtls_md_info_from_type(md_alg);
9415 *hashlen = mbedtls_md_get_size(md_info);
Jerry Yuee40f9d2022-02-17 14:55:16 +08009416
Gilles Peskine449bd832023-01-11 14:50:10 +01009417 MBEDTLS_SSL_DEBUG_MSG(3, ("Perform mbedtls-based computation of digest of ServerKeyExchange"));
Jerry Yuee40f9d2022-02-17 14:55:16 +08009418
Gilles Peskine449bd832023-01-11 14:50:10 +01009419 mbedtls_md_init(&ctx);
Jerry Yuee40f9d2022-02-17 14:55:16 +08009420
9421 /*
9422 * digitally-signed struct {
9423 * opaque client_random[32];
9424 * opaque server_random[32];
9425 * ServerDHParams params;
9426 * };
9427 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009428 if ((ret = mbedtls_md_setup(&ctx, md_info, 0)) != 0) {
9429 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_setup", ret);
Jerry Yuee40f9d2022-02-17 14:55:16 +08009430 goto exit;
9431 }
Gilles Peskine449bd832023-01-11 14:50:10 +01009432 if ((ret = mbedtls_md_starts(&ctx)) != 0) {
9433 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_starts", ret);
Jerry Yuee40f9d2022-02-17 14:55:16 +08009434 goto exit;
9435 }
Gilles Peskine449bd832023-01-11 14:50:10 +01009436 if ((ret = mbedtls_md_update(&ctx, ssl->handshake->randbytes, 64)) != 0) {
9437 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_update", ret);
Jerry Yuee40f9d2022-02-17 14:55:16 +08009438 goto exit;
9439 }
Gilles Peskine449bd832023-01-11 14:50:10 +01009440 if ((ret = mbedtls_md_update(&ctx, data, data_len)) != 0) {
9441 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_update", ret);
Jerry Yuee40f9d2022-02-17 14:55:16 +08009442 goto exit;
9443 }
Gilles Peskine449bd832023-01-11 14:50:10 +01009444 if ((ret = mbedtls_md_finish(&ctx, hash)) != 0) {
9445 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_finish", ret);
Jerry Yuee40f9d2022-02-17 14:55:16 +08009446 goto exit;
9447 }
9448
9449exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01009450 mbedtls_md_free(&ctx);
Jerry Yuee40f9d2022-02-17 14:55:16 +08009451
Gilles Peskine449bd832023-01-11 14:50:10 +01009452 if (ret != 0) {
9453 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
9454 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR);
9455 }
Jerry Yuee40f9d2022-02-17 14:55:16 +08009456
Gilles Peskine449bd832023-01-11 14:50:10 +01009457 return ret;
Jerry Yuee40f9d2022-02-17 14:55:16 +08009458}
9459#endif /* MBEDTLS_USE_PSA_CRYPTO */
9460
Jerry Yud9d91da2022-02-17 14:57:06 +08009461#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
9462
Gabor Mezeia3d016c2022-05-10 12:44:09 +02009463/* Find the preferred hash for a given signature algorithm. */
9464unsigned int mbedtls_ssl_tls12_get_preferred_hash_for_sig_alg(
Gilles Peskine449bd832023-01-11 14:50:10 +01009465 mbedtls_ssl_context *ssl,
9466 unsigned int sig_alg)
Jerry Yud9d91da2022-02-17 14:57:06 +08009467{
Gabor Mezei078e8032022-04-27 21:17:56 +02009468 unsigned int i;
Gabor Mezeia3d016c2022-05-10 12:44:09 +02009469 uint16_t *received_sig_algs = ssl->handshake->received_sig_algs;
Gabor Mezei078e8032022-04-27 21:17:56 +02009470
Gilles Peskine449bd832023-01-11 14:50:10 +01009471 if (sig_alg == MBEDTLS_SSL_SIG_ANON) {
9472 return MBEDTLS_SSL_HASH_NONE;
9473 }
Gabor Mezei078e8032022-04-27 21:17:56 +02009474
Gilles Peskine449bd832023-01-11 14:50:10 +01009475 for (i = 0; received_sig_algs[i] != MBEDTLS_TLS_SIG_NONE; i++) {
Neil Armstrong9f1176a2022-06-24 18:19:19 +02009476 unsigned int hash_alg_received =
Gilles Peskine449bd832023-01-11 14:50:10 +01009477 MBEDTLS_SSL_TLS12_HASH_ALG_FROM_SIG_AND_HASH_ALG(
9478 received_sig_algs[i]);
Neil Armstrong9f1176a2022-06-24 18:19:19 +02009479 unsigned int sig_alg_received =
Gilles Peskine449bd832023-01-11 14:50:10 +01009480 MBEDTLS_SSL_TLS12_SIG_ALG_FROM_SIG_AND_HASH_ALG(
9481 received_sig_algs[i]);
Neil Armstrong9f1176a2022-06-24 18:19:19 +02009482
Manuel Pégourié-Gonnard47bb3802023-06-05 12:40:32 +02009483 mbedtls_md_type_t md_alg =
9484 mbedtls_ssl_md_alg_from_hash((unsigned char) hash_alg_received);
9485 if (md_alg == MBEDTLS_MD_NONE) {
9486 continue;
9487 }
9488
Gilles Peskine449bd832023-01-11 14:50:10 +01009489 if (sig_alg == sig_alg_received) {
Neil Armstrong9f1176a2022-06-24 18:19:19 +02009490#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01009491 if (ssl->handshake->key_cert && ssl->handshake->key_cert->key) {
Neil Armstrong96eceb82022-06-30 18:05:05 +02009492 psa_algorithm_t psa_hash_alg =
Manuel Pégourié-Gonnard47bb3802023-06-05 12:40:32 +02009493 mbedtls_md_psa_alg_from_type(md_alg);
Neil Armstrong9f1176a2022-06-24 18:19:19 +02009494
Gilles Peskine449bd832023-01-11 14:50:10 +01009495 if (sig_alg_received == MBEDTLS_SSL_SIG_ECDSA &&
9496 !mbedtls_pk_can_do_ext(ssl->handshake->key_cert->key,
9497 PSA_ALG_ECDSA(psa_hash_alg),
9498 PSA_KEY_USAGE_SIGN_HASH)) {
Neil Armstrong9f1176a2022-06-24 18:19:19 +02009499 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01009500 }
Neil Armstrong9f1176a2022-06-24 18:19:19 +02009501
Gilles Peskine449bd832023-01-11 14:50:10 +01009502 if (sig_alg_received == MBEDTLS_SSL_SIG_RSA &&
9503 !mbedtls_pk_can_do_ext(ssl->handshake->key_cert->key,
9504 PSA_ALG_RSA_PKCS1V15_SIGN(
9505 psa_hash_alg),
9506 PSA_KEY_USAGE_SIGN_HASH)) {
Neil Armstrong9f1176a2022-06-24 18:19:19 +02009507 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01009508 }
Neil Armstrong9f1176a2022-06-24 18:19:19 +02009509 }
Neil Armstrong9f1176a2022-06-24 18:19:19 +02009510#endif /* MBEDTLS_USE_PSA_CRYPTO */
Neil Armstrong96eceb82022-06-30 18:05:05 +02009511
Gilles Peskine449bd832023-01-11 14:50:10 +01009512 return hash_alg_received;
Neil Armstrong9f1176a2022-06-24 18:19:19 +02009513 }
Jerry Yud9d91da2022-02-17 14:57:06 +08009514 }
Jerry Yud9d91da2022-02-17 14:57:06 +08009515
Gilles Peskine449bd832023-01-11 14:50:10 +01009516 return MBEDTLS_SSL_HASH_NONE;
Jerry Yud9d91da2022-02-17 14:57:06 +08009517}
9518
9519#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
9520
Jerry Yudc7bd172022-02-17 13:44:15 +08009521#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
9522
XiaokangQian75d40ef2022-04-20 11:05:24 +00009523int mbedtls_ssl_validate_ciphersuite(
9524 const mbedtls_ssl_context *ssl,
9525 const mbedtls_ssl_ciphersuite_t *suite_info,
9526 mbedtls_ssl_protocol_version min_tls_version,
Gilles Peskine449bd832023-01-11 14:50:10 +01009527 mbedtls_ssl_protocol_version max_tls_version)
XiaokangQian75d40ef2022-04-20 11:05:24 +00009528{
9529 (void) ssl;
9530
Gilles Peskine449bd832023-01-11 14:50:10 +01009531 if (suite_info == NULL) {
9532 return -1;
9533 }
XiaokangQian75d40ef2022-04-20 11:05:24 +00009534
Gilles Peskine449bd832023-01-11 14:50:10 +01009535 if ((suite_info->min_tls_version > max_tls_version) ||
9536 (suite_info->max_tls_version < min_tls_version)) {
9537 return -1;
XiaokangQian75d40ef2022-04-20 11:05:24 +00009538 }
9539
XiaokangQian060d8672022-04-21 09:24:56 +00009540#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_CLI_C)
XiaokangQian75d40ef2022-04-20 11:05:24 +00009541#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Neil Armstrongca7d5062022-05-31 14:43:23 +02009542#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01009543 if (suite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_ECJPAKE &&
9544 ssl->handshake->psa_pake_ctx_is_ok != 1)
Neil Armstrongca7d5062022-05-31 14:43:23 +02009545#else
Gilles Peskine449bd832023-01-11 14:50:10 +01009546 if (suite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_ECJPAKE &&
9547 mbedtls_ecjpake_check(&ssl->handshake->ecjpake_ctx) != 0)
Neil Armstrongca7d5062022-05-31 14:43:23 +02009548#endif /* MBEDTLS_USE_PSA_CRYPTO */
XiaokangQian75d40ef2022-04-20 11:05:24 +00009549 {
Gilles Peskine449bd832023-01-11 14:50:10 +01009550 return -1;
XiaokangQian75d40ef2022-04-20 11:05:24 +00009551 }
9552#endif
9553
9554 /* Don't suggest PSK-based ciphersuite if no PSK is available. */
9555#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01009556 if (mbedtls_ssl_ciphersuite_uses_psk(suite_info) &&
9557 mbedtls_ssl_conf_has_static_psk(ssl->conf) == 0) {
9558 return -1;
XiaokangQian75d40ef2022-04-20 11:05:24 +00009559 }
9560#endif /* MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
9561#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
9562
Gilles Peskine449bd832023-01-11 14:50:10 +01009563 return 0;
XiaokangQian75d40ef2022-04-20 11:05:24 +00009564}
9565
Ronald Crone68ab4f2022-10-05 12:46:29 +02009566#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
XiaokangQianeaf36512022-04-24 09:07:44 +00009567/*
9568 * Function for writing a signature algorithm extension.
9569 *
9570 * The `extension_data` field of signature algorithm contains a `SignatureSchemeList`
9571 * value (TLS 1.3 RFC8446):
9572 * enum {
9573 * ....
9574 * ecdsa_secp256r1_sha256( 0x0403 ),
9575 * ecdsa_secp384r1_sha384( 0x0503 ),
9576 * ecdsa_secp521r1_sha512( 0x0603 ),
9577 * ....
9578 * } SignatureScheme;
9579 *
9580 * struct {
9581 * SignatureScheme supported_signature_algorithms<2..2^16-2>;
9582 * } SignatureSchemeList;
9583 *
9584 * The `extension_data` field of signature algorithm contains a `SignatureAndHashAlgorithm`
9585 * value (TLS 1.2 RFC5246):
9586 * enum {
9587 * none(0), md5(1), sha1(2), sha224(3), sha256(4), sha384(5),
9588 * sha512(6), (255)
9589 * } HashAlgorithm;
9590 *
9591 * enum { anonymous(0), rsa(1), dsa(2), ecdsa(3), (255) }
9592 * SignatureAlgorithm;
9593 *
9594 * struct {
9595 * HashAlgorithm hash;
9596 * SignatureAlgorithm signature;
9597 * } SignatureAndHashAlgorithm;
9598 *
9599 * SignatureAndHashAlgorithm
9600 * supported_signature_algorithms<2..2^16-2>;
9601 *
9602 * The TLS 1.3 signature algorithm extension was defined to be a compatible
9603 * generalization of the TLS 1.2 signature algorithm extension.
9604 * `SignatureAndHashAlgorithm` field of TLS 1.2 can be represented by
9605 * `SignatureScheme` field of TLS 1.3
9606 *
9607 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009608int mbedtls_ssl_write_sig_alg_ext(mbedtls_ssl_context *ssl, unsigned char *buf,
9609 const unsigned char *end, size_t *out_len)
XiaokangQianeaf36512022-04-24 09:07:44 +00009610{
9611 unsigned char *p = buf;
9612 unsigned char *supported_sig_alg; /* Start of supported_signature_algorithms */
9613 size_t supported_sig_alg_len = 0; /* Length of supported_signature_algorithms */
9614
9615 *out_len = 0;
9616
Gilles Peskine449bd832023-01-11 14:50:10 +01009617 MBEDTLS_SSL_DEBUG_MSG(3, ("adding signature_algorithms extension"));
XiaokangQianeaf36512022-04-24 09:07:44 +00009618
9619 /* Check if we have space for header and length field:
9620 * - extension_type (2 bytes)
9621 * - extension_data_length (2 bytes)
9622 * - supported_signature_algorithms_length (2 bytes)
9623 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009624 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 6);
XiaokangQianeaf36512022-04-24 09:07:44 +00009625 p += 6;
9626
9627 /*
9628 * Write supported_signature_algorithms
9629 */
9630 supported_sig_alg = p;
Gilles Peskine449bd832023-01-11 14:50:10 +01009631 const uint16_t *sig_alg = mbedtls_ssl_get_sig_algs(ssl);
9632 if (sig_alg == NULL) {
9633 return MBEDTLS_ERR_SSL_BAD_CONFIG;
9634 }
XiaokangQianeaf36512022-04-24 09:07:44 +00009635
Gilles Peskine449bd832023-01-11 14:50:10 +01009636 for (; *sig_alg != MBEDTLS_TLS1_3_SIG_NONE; sig_alg++) {
9637 MBEDTLS_SSL_DEBUG_MSG(3, ("got signature scheme [%x] %s",
9638 *sig_alg,
9639 mbedtls_ssl_sig_alg_to_str(*sig_alg)));
9640 if (!mbedtls_ssl_sig_alg_is_supported(ssl, *sig_alg)) {
XiaokangQianeaf36512022-04-24 09:07:44 +00009641 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01009642 }
9643 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 2);
9644 MBEDTLS_PUT_UINT16_BE(*sig_alg, p, 0);
XiaokangQianeaf36512022-04-24 09:07:44 +00009645 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01009646 MBEDTLS_SSL_DEBUG_MSG(3, ("sent signature scheme [%x] %s",
9647 *sig_alg,
9648 mbedtls_ssl_sig_alg_to_str(*sig_alg)));
XiaokangQianeaf36512022-04-24 09:07:44 +00009649 }
9650
9651 /* Length of supported_signature_algorithms */
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00009652 supported_sig_alg_len = (size_t) (p - supported_sig_alg);
Gilles Peskine449bd832023-01-11 14:50:10 +01009653 if (supported_sig_alg_len == 0) {
9654 MBEDTLS_SSL_DEBUG_MSG(1, ("No signature algorithms defined."));
9655 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
XiaokangQianeaf36512022-04-24 09:07:44 +00009656 }
9657
Gilles Peskine449bd832023-01-11 14:50:10 +01009658 MBEDTLS_PUT_UINT16_BE(MBEDTLS_TLS_EXT_SIG_ALG, buf, 0);
9659 MBEDTLS_PUT_UINT16_BE(supported_sig_alg_len + 2, buf, 2);
9660 MBEDTLS_PUT_UINT16_BE(supported_sig_alg_len, buf, 4);
XiaokangQianeaf36512022-04-24 09:07:44 +00009661
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00009662 *out_len = (size_t) (p - buf);
XiaokangQianeaf36512022-04-24 09:07:44 +00009663
9664#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01009665 mbedtls_ssl_tls13_set_hs_sent_ext_mask(ssl, MBEDTLS_TLS_EXT_SIG_ALG);
XiaokangQianeaf36512022-04-24 09:07:44 +00009666#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yu0c354a22022-08-29 15:25:36 +08009667
Gilles Peskine449bd832023-01-11 14:50:10 +01009668 return 0;
XiaokangQianeaf36512022-04-24 09:07:44 +00009669}
Ronald Crone68ab4f2022-10-05 12:46:29 +02009670#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
XiaokangQianeaf36512022-04-24 09:07:44 +00009671
XiaokangQian40a35232022-05-07 09:02:40 +00009672#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
XiaokangQian9b2b7712022-05-17 02:57:00 +00009673/*
9674 * mbedtls_ssl_parse_server_name_ext
9675 *
9676 * Structure of server_name extension:
9677 *
9678 * enum {
9679 * host_name(0), (255)
9680 * } NameType;
9681 * opaque HostName<1..2^16-1>;
9682 *
9683 * struct {
9684 * NameType name_type;
9685 * select (name_type) {
9686 * case host_name: HostName;
9687 * } name;
9688 * } ServerName;
9689 * struct {
9690 * ServerName server_name_list<1..2^16-1>
9691 * } ServerNameList;
9692 */
Ronald Cronce7d76e2022-07-08 18:56:49 +02009693MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01009694int mbedtls_ssl_parse_server_name_ext(mbedtls_ssl_context *ssl,
9695 const unsigned char *buf,
9696 const unsigned char *end)
XiaokangQian40a35232022-05-07 09:02:40 +00009697{
9698 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
9699 const unsigned char *p = buf;
XiaokangQian9b2b7712022-05-17 02:57:00 +00009700 size_t server_name_list_len, hostname_len;
9701 const unsigned char *server_name_list_end;
XiaokangQian40a35232022-05-07 09:02:40 +00009702
Gilles Peskine449bd832023-01-11 14:50:10 +01009703 MBEDTLS_SSL_DEBUG_MSG(3, ("parse ServerName extension"));
XiaokangQian40a35232022-05-07 09:02:40 +00009704
Gilles Peskine449bd832023-01-11 14:50:10 +01009705 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
9706 server_name_list_len = MBEDTLS_GET_UINT16_BE(p, 0);
XiaokangQian40a35232022-05-07 09:02:40 +00009707 p += 2;
9708
Gilles Peskine449bd832023-01-11 14:50:10 +01009709 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, server_name_list_len);
XiaokangQian9b2b7712022-05-17 02:57:00 +00009710 server_name_list_end = p + server_name_list_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01009711 while (p < server_name_list_end) {
9712 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, server_name_list_end, 3);
9713 hostname_len = MBEDTLS_GET_UINT16_BE(p, 1);
9714 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, server_name_list_end,
9715 hostname_len + 3);
XiaokangQian40a35232022-05-07 09:02:40 +00009716
Gilles Peskine449bd832023-01-11 14:50:10 +01009717 if (p[0] == MBEDTLS_TLS_EXT_SERVERNAME_HOSTNAME) {
XiaokangQian75fe8c72022-06-15 09:42:45 +00009718 /* sni_name is intended to be used only during the parsing of the
9719 * ClientHello message (it is reset to NULL before the end of
9720 * the message parsing). Thus it is ok to just point to the
9721 * reception buffer and not make a copy of it.
9722 */
XiaokangQianf2a94202022-05-20 06:44:24 +00009723 ssl->handshake->sni_name = p + 3;
9724 ssl->handshake->sni_name_len = hostname_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01009725 if (ssl->conf->f_sni == NULL) {
9726 return 0;
XiaokangQian40a35232022-05-07 09:02:40 +00009727 }
Gilles Peskine449bd832023-01-11 14:50:10 +01009728 ret = ssl->conf->f_sni(ssl->conf->p_sni,
9729 ssl, p + 3, hostname_len);
9730 if (ret != 0) {
9731 MBEDTLS_SSL_DEBUG_RET(1, "ssl_sni_wrapper", ret);
9732 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_UNRECOGNIZED_NAME,
9733 MBEDTLS_ERR_SSL_UNRECOGNIZED_NAME);
9734 return MBEDTLS_ERR_SSL_UNRECOGNIZED_NAME;
9735 }
9736 return 0;
XiaokangQian40a35232022-05-07 09:02:40 +00009737 }
9738
9739 p += hostname_len + 3;
9740 }
9741
Gilles Peskine449bd832023-01-11 14:50:10 +01009742 return 0;
XiaokangQian40a35232022-05-07 09:02:40 +00009743}
9744#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
9745
XiaokangQianacb39922022-06-17 10:18:48 +00009746#if defined(MBEDTLS_SSL_ALPN)
Ronald Cronce7d76e2022-07-08 18:56:49 +02009747MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01009748int mbedtls_ssl_parse_alpn_ext(mbedtls_ssl_context *ssl,
9749 const unsigned char *buf,
9750 const unsigned char *end)
XiaokangQianacb39922022-06-17 10:18:48 +00009751{
9752 const unsigned char *p = buf;
XiaokangQianc7403452022-06-23 03:24:12 +00009753 size_t protocol_name_list_len;
XiaokangQian95d5f542022-06-24 02:29:26 +00009754 const unsigned char *protocol_name_list;
9755 const unsigned char *protocol_name_list_end;
XiaokangQianc7403452022-06-23 03:24:12 +00009756 size_t protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00009757
9758 /* If ALPN not configured, just ignore the extension */
Gilles Peskine449bd832023-01-11 14:50:10 +01009759 if (ssl->conf->alpn_list == NULL) {
9760 return 0;
9761 }
XiaokangQianacb39922022-06-17 10:18:48 +00009762
9763 /*
XiaokangQianc7403452022-06-23 03:24:12 +00009764 * RFC7301, section 3.1
9765 * opaque ProtocolName<1..2^8-1>;
XiaokangQianacb39922022-06-17 10:18:48 +00009766 *
XiaokangQianc7403452022-06-23 03:24:12 +00009767 * struct {
9768 * ProtocolName protocol_name_list<2..2^16-1>
9769 * } ProtocolNameList;
XiaokangQianacb39922022-06-17 10:18:48 +00009770 */
9771
XiaokangQianc7403452022-06-23 03:24:12 +00009772 /*
XiaokangQian0b776e22022-06-24 09:04:59 +00009773 * protocol_name_list_len 2 bytes
9774 * protocol_name_len 1 bytes
9775 * protocol_name >=1 byte
XiaokangQianc7403452022-06-23 03:24:12 +00009776 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009777 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 4);
XiaokangQianacb39922022-06-17 10:18:48 +00009778
Gilles Peskine449bd832023-01-11 14:50:10 +01009779 protocol_name_list_len = MBEDTLS_GET_UINT16_BE(p, 0);
XiaokangQianacb39922022-06-17 10:18:48 +00009780 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01009781 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, protocol_name_list_len);
XiaokangQian95d5f542022-06-24 02:29:26 +00009782 protocol_name_list = p;
9783 protocol_name_list_end = p + protocol_name_list_len;
XiaokangQianacb39922022-06-17 10:18:48 +00009784
9785 /* Validate peer's list (lengths) */
Gilles Peskine449bd832023-01-11 14:50:10 +01009786 while (p < protocol_name_list_end) {
XiaokangQian95d5f542022-06-24 02:29:26 +00009787 protocol_name_len = *p++;
Gilles Peskine449bd832023-01-11 14:50:10 +01009788 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, protocol_name_list_end,
9789 protocol_name_len);
9790 if (protocol_name_len == 0) {
XiaokangQian95d5f542022-06-24 02:29:26 +00009791 MBEDTLS_SSL_PEND_FATAL_ALERT(
9792 MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
Gilles Peskine449bd832023-01-11 14:50:10 +01009793 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
9794 return MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
XiaokangQian95d5f542022-06-24 02:29:26 +00009795 }
9796
9797 p += protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00009798 }
9799
9800 /* Use our order of preference */
Gilles Peskine449bd832023-01-11 14:50:10 +01009801 for (const char **alpn = ssl->conf->alpn_list; *alpn != NULL; alpn++) {
9802 size_t const alpn_len = strlen(*alpn);
XiaokangQian95d5f542022-06-24 02:29:26 +00009803 p = protocol_name_list;
Gilles Peskine449bd832023-01-11 14:50:10 +01009804 while (p < protocol_name_list_end) {
XiaokangQian95d5f542022-06-24 02:29:26 +00009805 protocol_name_len = *p++;
Gilles Peskine449bd832023-01-11 14:50:10 +01009806 if (protocol_name_len == alpn_len &&
9807 memcmp(p, *alpn, alpn_len) == 0) {
XiaokangQianacb39922022-06-17 10:18:48 +00009808 ssl->alpn_chosen = *alpn;
Gilles Peskine449bd832023-01-11 14:50:10 +01009809 return 0;
XiaokangQianacb39922022-06-17 10:18:48 +00009810 }
XiaokangQian95d5f542022-06-24 02:29:26 +00009811
9812 p += protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00009813 }
9814 }
9815
XiaokangQian95d5f542022-06-24 02:29:26 +00009816 /* If we get here, no match was found */
XiaokangQianacb39922022-06-17 10:18:48 +00009817 MBEDTLS_SSL_PEND_FATAL_ALERT(
Gilles Peskine449bd832023-01-11 14:50:10 +01009818 MBEDTLS_SSL_ALERT_MSG_NO_APPLICATION_PROTOCOL,
9819 MBEDTLS_ERR_SSL_NO_APPLICATION_PROTOCOL);
9820 return MBEDTLS_ERR_SSL_NO_APPLICATION_PROTOCOL;
XiaokangQianacb39922022-06-17 10:18:48 +00009821}
9822
Gilles Peskine449bd832023-01-11 14:50:10 +01009823int mbedtls_ssl_write_alpn_ext(mbedtls_ssl_context *ssl,
9824 unsigned char *buf,
9825 unsigned char *end,
9826 size_t *out_len)
XiaokangQianacb39922022-06-17 10:18:48 +00009827{
9828 unsigned char *p = buf;
XiaokangQian95d5f542022-06-24 02:29:26 +00009829 size_t protocol_name_len;
XiaokangQianc7403452022-06-23 03:24:12 +00009830 *out_len = 0;
XiaokangQianacb39922022-06-17 10:18:48 +00009831
Gilles Peskine449bd832023-01-11 14:50:10 +01009832 if (ssl->alpn_chosen == NULL) {
9833 return 0;
XiaokangQianacb39922022-06-17 10:18:48 +00009834 }
9835
Gilles Peskine449bd832023-01-11 14:50:10 +01009836 protocol_name_len = strlen(ssl->alpn_chosen);
9837 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 7 + protocol_name_len);
XiaokangQianacb39922022-06-17 10:18:48 +00009838
Gilles Peskine449bd832023-01-11 14:50:10 +01009839 MBEDTLS_SSL_DEBUG_MSG(3, ("server side, adding alpn extension"));
XiaokangQianacb39922022-06-17 10:18:48 +00009840 /*
9841 * 0 . 1 ext identifier
9842 * 2 . 3 ext length
9843 * 4 . 5 protocol list length
9844 * 6 . 6 protocol name length
9845 * 7 . 7+n protocol name
9846 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009847 MBEDTLS_PUT_UINT16_BE(MBEDTLS_TLS_EXT_ALPN, p, 0);
XiaokangQianacb39922022-06-17 10:18:48 +00009848
XiaokangQian95d5f542022-06-24 02:29:26 +00009849 *out_len = 7 + protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00009850
Gilles Peskine449bd832023-01-11 14:50:10 +01009851 MBEDTLS_PUT_UINT16_BE(protocol_name_len + 3, p, 2);
9852 MBEDTLS_PUT_UINT16_BE(protocol_name_len + 1, p, 4);
XiaokangQian0b776e22022-06-24 09:04:59 +00009853 /* Note: the length of the chosen protocol has been checked to be less
9854 * than 255 bytes in `mbedtls_ssl_conf_alpn_protocols`.
9855 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009856 p[6] = MBEDTLS_BYTE_0(protocol_name_len);
XiaokangQianacb39922022-06-17 10:18:48 +00009857
Gilles Peskine449bd832023-01-11 14:50:10 +01009858 memcpy(p + 7, ssl->alpn_chosen, protocol_name_len);
Jerry Yub95dd362022-11-08 21:19:34 +08009859
9860#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01009861 mbedtls_ssl_tls13_set_hs_sent_ext_mask(ssl, MBEDTLS_TLS_EXT_ALPN);
Jerry Yub95dd362022-11-08 21:19:34 +08009862#endif
9863
Gilles Peskine449bd832023-01-11 14:50:10 +01009864 return 0;
XiaokangQianacb39922022-06-17 10:18:48 +00009865}
9866#endif /* MBEDTLS_SSL_ALPN */
9867
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009868#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && \
Xiaokang Qian03409292022-10-12 02:49:52 +00009869 defined(MBEDTLS_SSL_SESSION_TICKETS) && \
Xiaokang Qianed0620c2022-10-12 06:58:13 +00009870 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION) && \
Xiaokang Qianed3afcd2022-10-12 08:31:11 +00009871 defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01009872int mbedtls_ssl_session_set_hostname(mbedtls_ssl_session *session,
9873 const char *hostname)
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009874{
9875 /* Initialize to suppress unnecessary compiler warning */
9876 size_t hostname_len = 0;
9877
9878 /* Check if new hostname is valid before
9879 * making any change to current one */
Gilles Peskine449bd832023-01-11 14:50:10 +01009880 if (hostname != NULL) {
9881 hostname_len = strlen(hostname);
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009882
Gilles Peskine449bd832023-01-11 14:50:10 +01009883 if (hostname_len > MBEDTLS_SSL_MAX_HOST_NAME_LEN) {
9884 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9885 }
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009886 }
9887
9888 /* Now it's clear that we will overwrite the old hostname,
9889 * so we can free it safely */
Gilles Peskine449bd832023-01-11 14:50:10 +01009890 if (session->hostname != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01009891 mbedtls_zeroize_and_free(session->hostname,
Gilles Peskine449bd832023-01-11 14:50:10 +01009892 strlen(session->hostname));
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009893 }
9894
9895 /* Passing NULL as hostname shall clear the old one */
Gilles Peskine449bd832023-01-11 14:50:10 +01009896 if (hostname == NULL) {
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009897 session->hostname = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01009898 } else {
9899 session->hostname = mbedtls_calloc(1, hostname_len + 1);
9900 if (session->hostname == NULL) {
9901 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
9902 }
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009903
Gilles Peskine449bd832023-01-11 14:50:10 +01009904 memcpy(session->hostname, hostname, hostname_len);
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009905 }
9906
Gilles Peskine449bd832023-01-11 14:50:10 +01009907 return 0;
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009908}
Xiaokang Qian03409292022-10-12 02:49:52 +00009909#endif /* MBEDTLS_SSL_PROTO_TLS1_3 &&
9910 MBEDTLS_SSL_SESSION_TICKETS &&
Xiaokang Qianed0620c2022-10-12 06:58:13 +00009911 MBEDTLS_SSL_SERVER_NAME_INDICATION &&
Xiaokang Qianed3afcd2022-10-12 08:31:11 +00009912 MBEDTLS_SSL_CLI_C */
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009913
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00009914#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_EARLY_DATA) && \
9915 defined(MBEDTLS_SSL_ALPN)
Waleed Elmelegy7dfba342024-03-12 16:22:39 +00009916int mbedtls_ssl_session_set_ticket_alpn(mbedtls_ssl_session *session,
9917 const char *alpn)
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00009918{
9919 size_t alpn_len = 0;
9920
9921 if (alpn != NULL) {
9922 alpn_len = strlen(alpn);
9923
9924 if (alpn_len > MBEDTLS_SSL_MAX_ALPN_NAME_LEN) {
9925 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9926 }
9927 }
9928
9929 if (session->ticket_alpn != NULL) {
9930 mbedtls_zeroize_and_free(session->ticket_alpn,
9931 strlen(session->ticket_alpn));
Waleed Elmelegy7dfba342024-03-12 16:22:39 +00009932 session->ticket_alpn = NULL;
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00009933 }
9934
Waleed Elmelegy7dfba342024-03-12 16:22:39 +00009935 if (alpn != NULL) {
9936 session->ticket_alpn = mbedtls_calloc(alpn_len + 1, 1);
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00009937 if (session->ticket_alpn == NULL) {
9938 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
9939 }
Waleed Elmelegy7dfba342024-03-12 16:22:39 +00009940 memcpy(session->ticket_alpn, alpn, alpn_len);
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00009941 }
9942
9943 return 0;
9944}
9945#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_EARLY_DATA && MBEDTLS_SSL_ALPN */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02009946#endif /* MBEDTLS_SSL_TLS_C */