blob: e2f583fa4e2d5d3905a4353312346a55d207f7c4 [file] [log] [blame]
Paul Bakker5121ce52009-01-03 21:22:43 +00001/*
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01002 * TLS shared functions
Paul Bakker5121ce52009-01-03 21:22:43 +00003 *
Bence Szépkúti1e148272020-08-07 13:07:28 +02004 * Copyright The Mbed TLS Contributors
Dave Rodgman16799db2023-11-02 19:47:20 +00005 * SPDX-License-Identifier: Apache-2.0 OR GPL-2.0-or-later
Paul Bakker5121ce52009-01-03 21:22:43 +00006 */
7/*
Paul Bakker5121ce52009-01-03 21:22:43 +00008 * http://www.ietf.org/rfc/rfc2246.txt
9 * http://www.ietf.org/rfc/rfc4346.txt
10 */
11
Gilles Peskinedb09ef62020-06-03 01:43:33 +020012#include "common.h"
Paul Bakker5121ce52009-01-03 21:22:43 +000013
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020014#if defined(MBEDTLS_SSL_TLS_C)
Paul Bakker5121ce52009-01-03 21:22:43 +000015
SimonBd5800b72016-04-26 07:43:27 +010016#include "mbedtls/platform.h"
SimonBd5800b72016-04-26 07:43:27 +010017
Manuel Pégourié-Gonnard7f809972015-03-09 17:05:11 +000018#include "mbedtls/ssl.h"
Ronald Cron9f0fba32022-02-10 16:45:15 +010019#include "ssl_client.h"
Ronald Cron27c85e72022-03-08 11:37:55 +010020#include "ssl_debug_helpers.h"
Chris Jones84a773f2021-03-05 18:38:47 +000021#include "ssl_misc.h"
Andrzej Kurek25f27152022-08-17 16:09:31 -040022
Valerio Settib4f50762024-01-17 10:24:52 +010023#include "debug_internal.h"
Janos Follath73c616b2019-12-18 15:07:04 +000024#include "mbedtls/error.h"
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -050025#include "mbedtls/platform_util.h"
Hanno Beckera835da52019-05-16 12:39:07 +010026#include "mbedtls/version.h"
Gabor Mezei765862c2021-10-19 12:22:25 +020027#include "mbedtls/constant_time.h"
Paul Bakker0be444a2013-08-27 21:55:01 +020028
Rich Evans00ab4702015-02-06 13:43:58 +000029#include <string.h>
30
Andrzej Kurekd6db9be2019-01-10 05:27:10 -050031#if defined(MBEDTLS_USE_PSA_CRYPTO)
Valerio Setti384fbde2024-01-02 13:26:40 +010032#include "mbedtls/psa_util.h"
Manuel Pégourié-Gonnard02b10d82023-03-28 12:33:20 +020033#include "md_psa.h"
Manuel Pégourié-Gonnard2be8c632023-06-07 13:07:21 +020034#include "psa_util_internal.h"
Andrzej Kurekd6db9be2019-01-10 05:27:10 -050035#include "psa/crypto.h"
36#endif
37
Janos Follath23bdca02016-10-07 14:47:14 +010038#if defined(MBEDTLS_X509_CRT_PARSE_C)
Manuel Pégourié-Gonnard7f809972015-03-09 17:05:11 +000039#include "mbedtls/oid.h"
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +020040#endif
41
Andrzej Kurek8a045ce2022-12-23 11:00:06 -050042#if defined(MBEDTLS_USE_PSA_CRYPTO)
Andrzej Kurek00644842023-05-30 05:45:00 -040043/* Define local translating functions to save code size by not using too many
44 * arguments in each translating place. */
45static int local_err_translation(psa_status_t status)
46{
47 return psa_status_to_mbedtls(status, psa_to_ssl_errors,
Andrzej Kurek1e4a0302023-05-30 09:45:17 -040048 ARRAY_LENGTH(psa_to_ssl_errors),
Andrzej Kurek00644842023-05-30 05:45:00 -040049 psa_generic_status_to_mbedtls);
50}
51#define PSA_TO_MBEDTLS_ERR(status) local_err_translation(status)
Andrzej Kurek8a045ce2022-12-23 11:00:06 -050052#endif
53
Ronald Cronad8c17b2022-06-10 17:18:09 +020054#if defined(MBEDTLS_TEST_HOOKS)
55static mbedtls_ssl_chk_buf_ptr_args chk_buf_ptr_fail_args;
56
57void mbedtls_ssl_set_chk_buf_ptr_fail_args(
Gilles Peskine449bd832023-01-11 14:50:10 +010058 const uint8_t *cur, const uint8_t *end, size_t need)
Ronald Cronad8c17b2022-06-10 17:18:09 +020059{
60 chk_buf_ptr_fail_args.cur = cur;
61 chk_buf_ptr_fail_args.end = end;
62 chk_buf_ptr_fail_args.need = need;
63}
64
Gilles Peskine449bd832023-01-11 14:50:10 +010065void mbedtls_ssl_reset_chk_buf_ptr_fail_args(void)
Ronald Cronad8c17b2022-06-10 17:18:09 +020066{
Gilles Peskine449bd832023-01-11 14:50:10 +010067 memset(&chk_buf_ptr_fail_args, 0, sizeof(chk_buf_ptr_fail_args));
Ronald Cronad8c17b2022-06-10 17:18:09 +020068}
69
Gilles Peskine449bd832023-01-11 14:50:10 +010070int mbedtls_ssl_cmp_chk_buf_ptr_fail_args(mbedtls_ssl_chk_buf_ptr_args *args)
Ronald Cronad8c17b2022-06-10 17:18:09 +020071{
Gilles Peskine449bd832023-01-11 14:50:10 +010072 return (chk_buf_ptr_fail_args.cur != args->cur) ||
73 (chk_buf_ptr_fail_args.end != args->end) ||
74 (chk_buf_ptr_fail_args.need != args->need);
Ronald Cronad8c17b2022-06-10 17:18:09 +020075}
76#endif /* MBEDTLS_TEST_HOOKS */
77
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +020078#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker2b1e3542018-08-06 11:19:13 +010079
Hanno Beckera0e20d02019-05-15 14:03:01 +010080#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckerf8542cf2019-04-09 15:22:03 +010081/* Top-level Connection ID API */
82
Gilles Peskine449bd832023-01-11 14:50:10 +010083int mbedtls_ssl_conf_cid(mbedtls_ssl_config *conf,
84 size_t len,
85 int ignore_other_cid)
Hanno Beckerad4a1372019-05-03 13:06:44 +010086{
Gilles Peskine449bd832023-01-11 14:50:10 +010087 if (len > MBEDTLS_SSL_CID_IN_LEN_MAX) {
88 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
89 }
Hanno Beckerad4a1372019-05-03 13:06:44 +010090
Gilles Peskine449bd832023-01-11 14:50:10 +010091 if (ignore_other_cid != MBEDTLS_SSL_UNEXPECTED_CID_FAIL &&
92 ignore_other_cid != MBEDTLS_SSL_UNEXPECTED_CID_IGNORE) {
93 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Becker611ac772019-05-14 11:45:26 +010094 }
95
96 conf->ignore_unexpected_cid = ignore_other_cid;
Hanno Beckerad4a1372019-05-03 13:06:44 +010097 conf->cid_len = len;
Gilles Peskine449bd832023-01-11 14:50:10 +010098 return 0;
Hanno Beckerad4a1372019-05-03 13:06:44 +010099}
100
Gilles Peskine449bd832023-01-11 14:50:10 +0100101int mbedtls_ssl_set_cid(mbedtls_ssl_context *ssl,
102 int enable,
103 unsigned char const *own_cid,
104 size_t own_cid_len)
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100105{
Gilles Peskine449bd832023-01-11 14:50:10 +0100106 if (ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
107 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
108 }
Hanno Becker76a79ab2019-05-03 14:38:32 +0100109
Hanno Beckerca092242019-04-25 16:01:49 +0100110 ssl->negotiate_cid = enable;
Gilles Peskine449bd832023-01-11 14:50:10 +0100111 if (enable == MBEDTLS_SSL_CID_DISABLED) {
112 MBEDTLS_SSL_DEBUG_MSG(3, ("Disable use of CID extension."));
113 return 0;
Hanno Beckerca092242019-04-25 16:01:49 +0100114 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100115 MBEDTLS_SSL_DEBUG_MSG(3, ("Enable use of CID extension."));
116 MBEDTLS_SSL_DEBUG_BUF(3, "Own CID", own_cid, own_cid_len);
Hanno Beckerca092242019-04-25 16:01:49 +0100117
Gilles Peskine449bd832023-01-11 14:50:10 +0100118 if (own_cid_len != ssl->conf->cid_len) {
119 MBEDTLS_SSL_DEBUG_MSG(3, ("CID length %u does not match CID length %u in config",
120 (unsigned) own_cid_len,
121 (unsigned) ssl->conf->cid_len));
122 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Beckerca092242019-04-25 16:01:49 +0100123 }
124
Gilles Peskine449bd832023-01-11 14:50:10 +0100125 memcpy(ssl->own_cid, own_cid, own_cid_len);
Hanno Beckerb7ee0cf2019-04-30 14:07:31 +0100126 /* Truncation is not an issue here because
127 * MBEDTLS_SSL_CID_IN_LEN_MAX at most 255. */
128 ssl->own_cid_len = (uint8_t) own_cid_len;
Hanno Beckerca092242019-04-25 16:01:49 +0100129
Gilles Peskine449bd832023-01-11 14:50:10 +0100130 return 0;
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100131}
132
Gilles Peskine449bd832023-01-11 14:50:10 +0100133int mbedtls_ssl_get_own_cid(mbedtls_ssl_context *ssl,
134 int *enabled,
Sam Berry3504c882024-06-11 14:34:17 +0100135 unsigned char own_cid[MBEDTLS_SSL_CID_IN_LEN_MAX],
Gilles Peskine449bd832023-01-11 14:50:10 +0100136 size_t *own_cid_len)
Paul Elliott0113cf12022-03-11 20:26:47 +0000137{
138 *enabled = MBEDTLS_SSL_CID_DISABLED;
139
Gilles Peskine449bd832023-01-11 14:50:10 +0100140 if (ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
141 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
142 }
Paul Elliott0113cf12022-03-11 20:26:47 +0000143
144 /* We report MBEDTLS_SSL_CID_DISABLED in case the CID length is
145 * zero as this is indistinguishable from not requesting to use
146 * the CID extension. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100147 if (ssl->own_cid_len == 0 || ssl->negotiate_cid == MBEDTLS_SSL_CID_DISABLED) {
148 return 0;
149 }
Paul Elliott0113cf12022-03-11 20:26:47 +0000150
Gilles Peskine449bd832023-01-11 14:50:10 +0100151 if (own_cid_len != NULL) {
Paul Elliott0113cf12022-03-11 20:26:47 +0000152 *own_cid_len = ssl->own_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +0100153 if (own_cid != NULL) {
154 memcpy(own_cid, ssl->own_cid, ssl->own_cid_len);
155 }
Paul Elliott0113cf12022-03-11 20:26:47 +0000156 }
157
158 *enabled = MBEDTLS_SSL_CID_ENABLED;
159
Gilles Peskine449bd832023-01-11 14:50:10 +0100160 return 0;
Paul Elliott0113cf12022-03-11 20:26:47 +0000161}
162
Gilles Peskine449bd832023-01-11 14:50:10 +0100163int mbedtls_ssl_get_peer_cid(mbedtls_ssl_context *ssl,
164 int *enabled,
165 unsigned char peer_cid[MBEDTLS_SSL_CID_OUT_LEN_MAX],
166 size_t *peer_cid_len)
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100167{
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100168 *enabled = MBEDTLS_SSL_CID_DISABLED;
Hanno Beckerb1f89cd2019-04-26 17:08:02 +0100169
Gilles Peskine449bd832023-01-11 14:50:10 +0100170 if (ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM ||
171 mbedtls_ssl_is_handshake_over(ssl) == 0) {
172 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Becker76a79ab2019-05-03 14:38:32 +0100173 }
Hanno Beckerb1f89cd2019-04-26 17:08:02 +0100174
Hanno Beckerc5f24222019-05-03 12:54:52 +0100175 /* We report MBEDTLS_SSL_CID_DISABLED in case the CID extensions
176 * were used, but client and server requested the empty CID.
177 * This is indistinguishable from not using the CID extension
178 * in the first place. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100179 if (ssl->transform_in->in_cid_len == 0 &&
180 ssl->transform_in->out_cid_len == 0) {
181 return 0;
Hanno Beckerb1f89cd2019-04-26 17:08:02 +0100182 }
183
Gilles Peskine449bd832023-01-11 14:50:10 +0100184 if (peer_cid_len != NULL) {
Hanno Becker615ef172019-05-22 16:50:35 +0100185 *peer_cid_len = ssl->transform_in->out_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +0100186 if (peer_cid != NULL) {
187 memcpy(peer_cid, ssl->transform_in->out_cid,
188 ssl->transform_in->out_cid_len);
Hanno Becker615ef172019-05-22 16:50:35 +0100189 }
190 }
Hanno Beckerb1f89cd2019-04-26 17:08:02 +0100191
192 *enabled = MBEDTLS_SSL_CID_ENABLED;
193
Gilles Peskine449bd832023-01-11 14:50:10 +0100194 return 0;
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100195}
Hanno Beckera0e20d02019-05-15 14:03:01 +0100196#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100197
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200198#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200199
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200200#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Manuel Pégourié-Gonnard581e6b62013-07-18 12:32:27 +0200201/*
202 * Convert max_fragment_length codes to length.
203 * RFC 6066 says:
204 * enum{
205 * 2^9(1), 2^10(2), 2^11(3), 2^12(4), (255)
206 * } MaxFragmentLength;
207 * and we add 0 -> extension unused
208 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100209static unsigned int ssl_mfl_code_to_length(int mfl)
Manuel Pégourié-Gonnard581e6b62013-07-18 12:32:27 +0200210{
Gilles Peskine449bd832023-01-11 14:50:10 +0100211 switch (mfl) {
212 case MBEDTLS_SSL_MAX_FRAG_LEN_NONE:
213 return MBEDTLS_TLS_EXT_ADV_CONTENT_LEN;
214 case MBEDTLS_SSL_MAX_FRAG_LEN_512:
215 return 512;
216 case MBEDTLS_SSL_MAX_FRAG_LEN_1024:
217 return 1024;
218 case MBEDTLS_SSL_MAX_FRAG_LEN_2048:
219 return 2048;
220 case MBEDTLS_SSL_MAX_FRAG_LEN_4096:
221 return 4096;
222 default:
223 return MBEDTLS_TLS_EXT_ADV_CONTENT_LEN;
Angus Grattond8213d02016-05-25 20:56:48 +1000224 }
225}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200226#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
Manuel Pégourié-Gonnard581e6b62013-07-18 12:32:27 +0200227
Gilles Peskine449bd832023-01-11 14:50:10 +0100228int mbedtls_ssl_session_copy(mbedtls_ssl_session *dst,
229 const mbedtls_ssl_session *src)
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200230{
Gilles Peskine449bd832023-01-11 14:50:10 +0100231 mbedtls_ssl_session_free(dst);
232 memcpy(dst, src, sizeof(mbedtls_ssl_session));
吴敬辉0b716112021-11-29 10:46:35 +0800233#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
234 dst->ticket = NULL;
Xiaokang Qian87306442022-10-12 09:47:38 +0000235#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && \
236 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Xiaokang Qian126bf8e2022-10-13 02:22:40 +0000237 dst->hostname = NULL;
吴敬辉0b716112021-11-29 10:46:35 +0800238#endif
Xiaokang Qian87306442022-10-12 09:47:38 +0000239#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
吴敬辉0b716112021-11-29 10:46:35 +0800240
Waleed Elmelegy4dfb0e72024-03-14 01:48:40 +0000241#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_ALPN) && \
242 defined(MBEDTLS_SSL_EARLY_DATA)
243 dst->ticket_alpn = NULL;
244#endif
245
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200246#if defined(MBEDTLS_X509_CRT_PARSE_C)
Hanno Becker6d1986e2019-02-07 12:27:42 +0000247
248#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +0100249 if (src->peer_cert != NULL) {
Janos Follath865b3eb2019-12-16 11:46:15 +0000250 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker2292d1f2013-09-15 17:06:49 +0200251
Gilles Peskine449bd832023-01-11 14:50:10 +0100252 dst->peer_cert = mbedtls_calloc(1, sizeof(mbedtls_x509_crt));
253 if (dst->peer_cert == NULL) {
254 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
255 }
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200256
Gilles Peskine449bd832023-01-11 14:50:10 +0100257 mbedtls_x509_crt_init(dst->peer_cert);
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200258
Gilles Peskine449bd832023-01-11 14:50:10 +0100259 if ((ret = mbedtls_x509_crt_parse_der(dst->peer_cert, src->peer_cert->raw.p,
260 src->peer_cert->raw.len)) != 0) {
261 mbedtls_free(dst->peer_cert);
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200262 dst->peer_cert = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +0100263 return ret;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200264 }
265 }
Hanno Becker6d1986e2019-02-07 12:27:42 +0000266#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Gilles Peskine449bd832023-01-11 14:50:10 +0100267 if (src->peer_cert_digest != NULL) {
Hanno Becker9198ad12019-02-05 17:00:50 +0000268 dst->peer_cert_digest =
Gilles Peskine449bd832023-01-11 14:50:10 +0100269 mbedtls_calloc(1, src->peer_cert_digest_len);
270 if (dst->peer_cert_digest == NULL) {
271 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
272 }
Hanno Becker9198ad12019-02-05 17:00:50 +0000273
Gilles Peskine449bd832023-01-11 14:50:10 +0100274 memcpy(dst->peer_cert_digest, src->peer_cert_digest,
275 src->peer_cert_digest_len);
Hanno Becker9198ad12019-02-05 17:00:50 +0000276 dst->peer_cert_digest_type = src->peer_cert_digest_type;
Hanno Beckeraccc5992019-02-25 10:06:59 +0000277 dst->peer_cert_digest_len = src->peer_cert_digest_len;
Hanno Becker9198ad12019-02-05 17:00:50 +0000278 }
279#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
280
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200281#endif /* MBEDTLS_X509_CRT_PARSE_C */
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200282
Waleed Elmelegy4dfb0e72024-03-14 01:48:40 +0000283#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_ALPN) && \
284 defined(MBEDTLS_SSL_EARLY_DATA)
285 {
286 int ret = mbedtls_ssl_session_set_ticket_alpn(dst, src->ticket_alpn);
287 if (ret != 0) {
288 return ret;
289 }
290 }
291#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_ALPN && MBEDTLS_SSL_EARLY_DATA */
292
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +0200293#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +0100294 if (src->ticket != NULL) {
295 dst->ticket = mbedtls_calloc(1, src->ticket_len);
296 if (dst->ticket == NULL) {
297 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
298 }
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200299
Gilles Peskine449bd832023-01-11 14:50:10 +0100300 memcpy(dst->ticket, src->ticket, src->ticket_len);
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200301 }
Xiaokang Qian126bf8e2022-10-13 02:22:40 +0000302
303#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && \
304 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +0100305 if (src->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Xiaokang Qian126bf8e2022-10-13 02:22:40 +0000306 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine449bd832023-01-11 14:50:10 +0100307 ret = mbedtls_ssl_session_set_hostname(dst, src->hostname);
308 if (ret != 0) {
309 return ret;
310 }
Xiaokang Qian126bf8e2022-10-13 02:22:40 +0000311 }
312#endif /* MBEDTLS_SSL_PROTO_TLS1_3 &&
313 MBEDTLS_SSL_SERVER_NAME_INDICATION */
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +0200314#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200315
Gilles Peskine449bd832023-01-11 14:50:10 +0100316 return 0;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200317}
318
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500319#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200320MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100321static int resize_buffer(unsigned char **buffer, size_t len_new, size_t *len_old)
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500322{
Gilles Peskine449bd832023-01-11 14:50:10 +0100323 unsigned char *resized_buffer = mbedtls_calloc(1, len_new);
324 if (resized_buffer == NULL) {
Yanray Wang365ee3e2023-11-22 10:28:28 +0800325 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
Gilles Peskine449bd832023-01-11 14:50:10 +0100326 }
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500327
328 /* We want to copy len_new bytes when downsizing the buffer, and
329 * len_old bytes when upsizing, so we choose the smaller of two sizes,
330 * to fit one buffer into another. Size checks, ensuring that no data is
331 * lost, are done outside of this function. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100332 memcpy(resized_buffer, *buffer,
333 (len_new < *len_old) ? len_new : *len_old);
Tom Cosgroveca8c61b2023-07-17 15:17:40 +0100334 mbedtls_zeroize_and_free(*buffer, *len_old);
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500335
336 *buffer = resized_buffer;
337 *len_old = len_new;
338
339 return 0;
340}
Andrzej Kurek4a063792020-10-21 15:08:44 +0200341
Gilles Peskine449bd832023-01-11 14:50:10 +0100342static void handle_buffer_resizing(mbedtls_ssl_context *ssl, int downsizing,
343 size_t in_buf_new_len,
344 size_t out_buf_new_len)
Andrzej Kurek4a063792020-10-21 15:08:44 +0200345{
346 int modified = 0;
347 size_t written_in = 0, iv_offset_in = 0, len_offset_in = 0;
348 size_t written_out = 0, iv_offset_out = 0, len_offset_out = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +0100349 if (ssl->in_buf != NULL) {
Andrzej Kurek4a063792020-10-21 15:08:44 +0200350 written_in = ssl->in_msg - ssl->in_buf;
351 iv_offset_in = ssl->in_iv - ssl->in_buf;
352 len_offset_in = ssl->in_len - ssl->in_buf;
Gilles Peskine449bd832023-01-11 14:50:10 +0100353 if (downsizing ?
Andrzej Kurek4a063792020-10-21 15:08:44 +0200354 ssl->in_buf_len > in_buf_new_len && ssl->in_left < in_buf_new_len :
Gilles Peskine449bd832023-01-11 14:50:10 +0100355 ssl->in_buf_len < in_buf_new_len) {
356 if (resize_buffer(&ssl->in_buf, in_buf_new_len, &ssl->in_buf_len) != 0) {
357 MBEDTLS_SSL_DEBUG_MSG(1, ("input buffer resizing failed - out of memory"));
358 } else {
359 MBEDTLS_SSL_DEBUG_MSG(2, ("Reallocating in_buf to %" MBEDTLS_PRINTF_SIZET,
360 in_buf_new_len));
Andrzej Kurek4a063792020-10-21 15:08:44 +0200361 modified = 1;
362 }
363 }
364 }
365
Gilles Peskine449bd832023-01-11 14:50:10 +0100366 if (ssl->out_buf != NULL) {
Andrzej Kurek4a063792020-10-21 15:08:44 +0200367 written_out = ssl->out_msg - ssl->out_buf;
368 iv_offset_out = ssl->out_iv - ssl->out_buf;
369 len_offset_out = ssl->out_len - ssl->out_buf;
Gilles Peskine449bd832023-01-11 14:50:10 +0100370 if (downsizing ?
Andrzej Kurek4a063792020-10-21 15:08:44 +0200371 ssl->out_buf_len > out_buf_new_len && ssl->out_left < out_buf_new_len :
Gilles Peskine449bd832023-01-11 14:50:10 +0100372 ssl->out_buf_len < out_buf_new_len) {
373 if (resize_buffer(&ssl->out_buf, out_buf_new_len, &ssl->out_buf_len) != 0) {
374 MBEDTLS_SSL_DEBUG_MSG(1, ("output buffer resizing failed - out of memory"));
375 } else {
376 MBEDTLS_SSL_DEBUG_MSG(2, ("Reallocating out_buf to %" MBEDTLS_PRINTF_SIZET,
377 out_buf_new_len));
Andrzej Kurek4a063792020-10-21 15:08:44 +0200378 modified = 1;
379 }
380 }
381 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100382 if (modified) {
Andrzej Kurek4a063792020-10-21 15:08:44 +0200383 /* Update pointers here to avoid doing it twice. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100384 mbedtls_ssl_reset_in_out_pointers(ssl);
Andrzej Kurek4a063792020-10-21 15:08:44 +0200385 /* Fields below might not be properly updated with record
386 * splitting or with CID, so they are manually updated here. */
387 ssl->out_msg = ssl->out_buf + written_out;
388 ssl->out_len = ssl->out_buf + len_offset_out;
389 ssl->out_iv = ssl->out_buf + iv_offset_out;
390
391 ssl->in_msg = ssl->in_buf + written_in;
392 ssl->in_len = ssl->in_buf + len_offset_in;
393 ssl->in_iv = ssl->in_buf + iv_offset_in;
394 }
395}
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500396#endif /* MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH */
397
Jerry Yudb8c48a2022-01-27 14:54:54 +0800398#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Jerry Yued14c932022-02-17 13:40:45 +0800399
400#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
Gilles Peskine449bd832023-01-11 14:50:10 +0100401typedef int (*tls_prf_fn)(const unsigned char *secret, size_t slen,
402 const char *label,
403 const unsigned char *random, size_t rlen,
404 unsigned char *dstbuf, size_t dlen);
Jerry Yued14c932022-02-17 13:40:45 +0800405
Gilles Peskine449bd832023-01-11 14:50:10 +0100406static tls_prf_fn ssl_tls12prf_from_cs(int ciphersuite_id);
Jerry Yued14c932022-02-17 13:40:45 +0800407
408#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
409
410/* Type for the TLS PRF */
411typedef int ssl_tls_prf_t(const unsigned char *, size_t, const char *,
412 const unsigned char *, size_t,
413 unsigned char *, size_t);
414
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200415MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100416static int ssl_tls12_populate_transform(mbedtls_ssl_transform *transform,
417 int ciphersuite,
418 const unsigned char master[48],
Neil Armstrongf2c82f02022-04-05 11:16:53 +0200419#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +0100420 int encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +0200421#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +0100422 ssl_tls_prf_t tls_prf,
423 const unsigned char randbytes[64],
424 mbedtls_ssl_protocol_version tls_version,
425 unsigned endpoint,
426 const mbedtls_ssl_context *ssl);
Jerry Yued14c932022-02-17 13:40:45 +0800427
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 Cron233fcaa2024-04-04 14:05:21 +02001763#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Jerry Yu21092062022-10-10 21:21:31 +08001764 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
Gilles Peskine449bd832023-01-11 14:50:10 +01001765 mbedtls_ssl_ciphersuite_from_id(session->ciphersuite);
Jerry Yu21092062022-10-10 21:21:31 +08001766
Gilles Peskine449bd832023-01-11 14:50:10 +01001767 if (mbedtls_ssl_validate_ciphersuite(
Jerry Yu21092062022-10-10 21:21:31 +08001768 ssl, ciphersuite_info, MBEDTLS_SSL_VERSION_TLS1_3,
Gilles Peskine449bd832023-01-11 14:50:10 +01001769 MBEDTLS_SSL_VERSION_TLS1_3) != 0) {
1770 MBEDTLS_SSL_DEBUG_MSG(4, ("%d is not a valid TLS 1.3 ciphersuite.",
1771 session->ciphersuite));
1772 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jerry Yu21092062022-10-10 21:21:31 +08001773 }
Ronald Cron233fcaa2024-04-04 14:05:21 +02001774#else
1775 /*
1776 * If session tickets are not enabled, it is not possible to resume a
1777 * TLS 1.3 session, thus do not make any change to the SSL context in
1778 * the first place.
1779 */
1780 return 0;
1781#endif
Jerry Yu40afab62022-10-08 10:42:13 +08001782 }
Jerry Yu21092062022-10-10 21:21:31 +08001783#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yu40afab62022-10-08 10:42:13 +08001784
Gilles Peskine449bd832023-01-11 14:50:10 +01001785 if ((ret = mbedtls_ssl_session_copy(ssl->session_negotiate,
1786 session)) != 0) {
1787 return ret;
1788 }
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001789
Paul Bakker0a597072012-09-25 21:55:46 +00001790 ssl->handshake->resume = 1;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001791
Gilles Peskine449bd832023-01-11 14:50:10 +01001792 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00001793}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001794#endif /* MBEDTLS_SSL_CLI_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00001795
Gilles Peskine449bd832023-01-11 14:50:10 +01001796void mbedtls_ssl_conf_ciphersuites(mbedtls_ssl_config *conf,
1797 const int *ciphersuites)
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001798{
Hanno Beckerd60b6c62021-04-29 12:04:11 +01001799 conf->ciphersuite_list = ciphersuites;
Paul Bakker5121ce52009-01-03 21:22:43 +00001800}
1801
Ronald Cron6f135e12021-12-08 16:57:54 +01001802#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01001803void mbedtls_ssl_conf_tls13_key_exchange_modes(mbedtls_ssl_config *conf,
1804 const int kex_modes)
Hanno Becker71f1ed62021-07-24 06:01:47 +01001805{
Xiaofei Bai746f9482021-11-12 08:53:56 +00001806 conf->tls13_kex_modes = kex_modes & MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_ALL;
Hanno Becker71f1ed62021-07-24 06:01:47 +01001807}
Xiaokang Qian72de95d2022-10-25 02:54:33 +00001808
1809#if defined(MBEDTLS_SSL_EARLY_DATA)
Yanray Wangd5ed36f2023-11-07 11:40:43 +08001810void mbedtls_ssl_conf_early_data(mbedtls_ssl_config *conf,
1811 int early_data_enabled)
Xiaokang Qian72de95d2022-10-25 02:54:33 +00001812{
1813 conf->early_data_enabled = early_data_enabled;
1814}
Jerry Yucc4e0072022-11-22 17:22:22 +08001815
1816#if defined(MBEDTLS_SSL_SRV_C)
Yanray Wang07517612023-11-07 11:47:36 +08001817void mbedtls_ssl_conf_max_early_data_size(
Gilles Peskine449bd832023-01-11 14:50:10 +01001818 mbedtls_ssl_config *conf, uint32_t max_early_data_size)
Jerry Yucc4e0072022-11-22 17:22:22 +08001819{
Jerry Yu39da9852022-12-06 16:58:36 +08001820 conf->max_early_data_size = max_early_data_size;
Jerry Yucc4e0072022-11-22 17:22:22 +08001821}
1822#endif /* MBEDTLS_SSL_SRV_C */
1823
Xiaokang Qian72de95d2022-10-25 02:54:33 +00001824#endif /* MBEDTLS_SSL_EARLY_DATA */
Ronald Cron6f135e12021-12-08 16:57:54 +01001825#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker71f1ed62021-07-24 06:01:47 +01001826
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001827#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001828void mbedtls_ssl_conf_cert_profile(mbedtls_ssl_config *conf,
1829 const mbedtls_x509_crt_profile *profile)
Manuel Pégourié-Gonnard6e3ee3a2015-06-17 10:58:20 +02001830{
1831 conf->cert_profile = profile;
1832}
1833
Gilles Peskine449bd832023-01-11 14:50:10 +01001834static void ssl_key_cert_free(mbedtls_ssl_key_cert *key_cert)
Glenn Strauss36872db2022-01-22 05:06:31 -05001835{
1836 mbedtls_ssl_key_cert *cur = key_cert, *next;
1837
Gilles Peskine449bd832023-01-11 14:50:10 +01001838 while (cur != NULL) {
Glenn Strauss36872db2022-01-22 05:06:31 -05001839 next = cur->next;
Gilles Peskine449bd832023-01-11 14:50:10 +01001840 mbedtls_free(cur);
Glenn Strauss36872db2022-01-22 05:06:31 -05001841 cur = next;
1842 }
1843}
1844
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001845/* Append a new keycert entry to a (possibly empty) list */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001846MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001847static int ssl_append_key_cert(mbedtls_ssl_key_cert **head,
1848 mbedtls_x509_crt *cert,
1849 mbedtls_pk_context *key)
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001850{
niisato8ee24222018-06-25 19:05:48 +09001851 mbedtls_ssl_key_cert *new_cert;
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001852
Gilles Peskine449bd832023-01-11 14:50:10 +01001853 if (cert == NULL) {
Glenn Strauss36872db2022-01-22 05:06:31 -05001854 /* Free list if cert is null */
Gilles Peskine449bd832023-01-11 14:50:10 +01001855 ssl_key_cert_free(*head);
Glenn Strauss36872db2022-01-22 05:06:31 -05001856 *head = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01001857 return 0;
Glenn Strauss36872db2022-01-22 05:06:31 -05001858 }
1859
Gilles Peskine449bd832023-01-11 14:50:10 +01001860 new_cert = mbedtls_calloc(1, sizeof(mbedtls_ssl_key_cert));
1861 if (new_cert == NULL) {
1862 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
1863 }
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001864
niisato8ee24222018-06-25 19:05:48 +09001865 new_cert->cert = cert;
1866 new_cert->key = key;
1867 new_cert->next = NULL;
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001868
Glenn Strauss36872db2022-01-22 05:06:31 -05001869 /* Update head if the list was null, else add to the end */
Gilles Peskine449bd832023-01-11 14:50:10 +01001870 if (*head == NULL) {
niisato8ee24222018-06-25 19:05:48 +09001871 *head = new_cert;
Gilles Peskine449bd832023-01-11 14:50:10 +01001872 } else {
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001873 mbedtls_ssl_key_cert *cur = *head;
Gilles Peskine449bd832023-01-11 14:50:10 +01001874 while (cur->next != NULL) {
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001875 cur = cur->next;
Gilles Peskine449bd832023-01-11 14:50:10 +01001876 }
niisato8ee24222018-06-25 19:05:48 +09001877 cur->next = new_cert;
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001878 }
1879
Gilles Peskine449bd832023-01-11 14:50:10 +01001880 return 0;
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001881}
1882
Gilles Peskine449bd832023-01-11 14:50:10 +01001883int mbedtls_ssl_conf_own_cert(mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001884 mbedtls_x509_crt *own_cert,
Gilles Peskine449bd832023-01-11 14:50:10 +01001885 mbedtls_pk_context *pk_key)
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001886{
Gilles Peskine449bd832023-01-11 14:50:10 +01001887 return ssl_append_key_cert(&conf->key_cert, own_cert, pk_key);
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001888}
1889
Gilles Peskine449bd832023-01-11 14:50:10 +01001890void mbedtls_ssl_conf_ca_chain(mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01001891 mbedtls_x509_crt *ca_chain,
Gilles Peskine449bd832023-01-11 14:50:10 +01001892 mbedtls_x509_crl *ca_crl)
Paul Bakker5121ce52009-01-03 21:22:43 +00001893{
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01001894 conf->ca_chain = ca_chain;
1895 conf->ca_crl = ca_crl;
Hanno Becker5adaad92019-03-27 16:54:37 +00001896
1897#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
1898 /* mbedtls_ssl_conf_ca_chain() and mbedtls_ssl_conf_ca_cb()
1899 * cannot be used together. */
1900 conf->f_ca_cb = NULL;
1901 conf->p_ca_cb = NULL;
1902#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
Paul Bakker5121ce52009-01-03 21:22:43 +00001903}
Hanno Becker5adaad92019-03-27 16:54:37 +00001904
1905#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
Gilles Peskine449bd832023-01-11 14:50:10 +01001906void mbedtls_ssl_conf_ca_cb(mbedtls_ssl_config *conf,
1907 mbedtls_x509_crt_ca_cb_t f_ca_cb,
1908 void *p_ca_cb)
Hanno Becker5adaad92019-03-27 16:54:37 +00001909{
1910 conf->f_ca_cb = f_ca_cb;
1911 conf->p_ca_cb = p_ca_cb;
1912
1913 /* mbedtls_ssl_conf_ca_chain() and mbedtls_ssl_conf_ca_cb()
1914 * cannot be used together. */
1915 conf->ca_chain = NULL;
1916 conf->ca_crl = NULL;
1917}
1918#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001919#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkereb2c6582012-09-27 19:15:01 +00001920
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001921#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01001922const unsigned char *mbedtls_ssl_get_hs_sni(mbedtls_ssl_context *ssl,
1923 size_t *name_len)
Glenn Strauss69894072022-01-24 12:58:00 -05001924{
1925 *name_len = ssl->handshake->sni_name_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01001926 return ssl->handshake->sni_name;
Glenn Strauss69894072022-01-24 12:58:00 -05001927}
1928
Gilles Peskine449bd832023-01-11 14:50:10 +01001929int mbedtls_ssl_set_hs_own_cert(mbedtls_ssl_context *ssl,
1930 mbedtls_x509_crt *own_cert,
1931 mbedtls_pk_context *pk_key)
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001932{
Gilles Peskine449bd832023-01-11 14:50:10 +01001933 return ssl_append_key_cert(&ssl->handshake->sni_key_cert,
1934 own_cert, pk_key);
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001935}
Manuel Pégourié-Gonnard22bfa4b2015-05-11 08:46:37 +02001936
Gilles Peskine449bd832023-01-11 14:50:10 +01001937void mbedtls_ssl_set_hs_ca_chain(mbedtls_ssl_context *ssl,
1938 mbedtls_x509_crt *ca_chain,
1939 mbedtls_x509_crl *ca_crl)
Manuel Pégourié-Gonnard22bfa4b2015-05-11 08:46:37 +02001940{
1941 ssl->handshake->sni_ca_chain = ca_chain;
1942 ssl->handshake->sni_ca_crl = ca_crl;
1943}
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +02001944
Glenn Strauss999ef702022-03-11 01:37:23 -05001945#if defined(MBEDTLS_KEY_EXCHANGE_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01001946void mbedtls_ssl_set_hs_dn_hints(mbedtls_ssl_context *ssl,
1947 const mbedtls_x509_crt *crt)
Glenn Strauss999ef702022-03-11 01:37:23 -05001948{
1949 ssl->handshake->dn_hints = crt;
1950}
1951#endif /* MBEDTLS_KEY_EXCHANGE_CERT_REQ_ALLOWED_ENABLED */
1952
Gilles Peskine449bd832023-01-11 14:50:10 +01001953void mbedtls_ssl_set_hs_authmode(mbedtls_ssl_context *ssl,
1954 int authmode)
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +02001955{
1956 ssl->handshake->sni_authmode = authmode;
1957}
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001958#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
1959
Hanno Becker8927c832019-04-03 12:52:50 +01001960#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001961void mbedtls_ssl_set_verify(mbedtls_ssl_context *ssl,
1962 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *),
1963 void *p_vrfy)
Hanno Becker8927c832019-04-03 12:52:50 +01001964{
1965 ssl->f_vrfy = f_vrfy;
1966 ssl->p_vrfy = p_vrfy;
1967}
1968#endif
1969
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02001970#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02001971
Valerio Setti016f6822022-12-09 14:17:50 +01001972#if defined(MBEDTLS_USE_PSA_CRYPTO)
Przemek Stekielfde11282023-03-13 16:06:09 +01001973static const uint8_t jpake_server_id[] = { 's', 'e', 'r', 'v', 'e', 'r' };
1974static const uint8_t jpake_client_id[] = { 'c', 'l', 'i', 'e', 'n', 't' };
1975
Valerio Setti016f6822022-12-09 14:17:50 +01001976static psa_status_t mbedtls_ssl_set_hs_ecjpake_password_common(
Gilles Peskine449bd832023-01-11 14:50:10 +01001977 mbedtls_ssl_context *ssl,
1978 mbedtls_svc_key_id_t pwd)
Valerio Setti016f6822022-12-09 14:17:50 +01001979{
1980 psa_status_t status;
Valerio Setti016f6822022-12-09 14:17:50 +01001981 psa_pake_cipher_suite_t cipher_suite = psa_pake_cipher_suite_init();
Przemek Stekielfde11282023-03-13 16:06:09 +01001982 const uint8_t *user = NULL;
Przemek Stekiel4cd20312023-03-01 11:11:28 +01001983 size_t user_len = 0;
Przemek Stekielfde11282023-03-13 16:06:09 +01001984 const uint8_t *peer = NULL;
Przemek Stekiel4cd20312023-03-01 11:11:28 +01001985 size_t peer_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01001986 psa_pake_cs_set_algorithm(&cipher_suite, PSA_ALG_JPAKE);
1987 psa_pake_cs_set_primitive(&cipher_suite,
1988 PSA_PAKE_PRIMITIVE(PSA_PAKE_PRIMITIVE_TYPE_ECC,
1989 PSA_ECC_FAMILY_SECP_R1,
1990 256));
1991 psa_pake_cs_set_hash(&cipher_suite, PSA_ALG_SHA_256);
Valerio Setti016f6822022-12-09 14:17:50 +01001992
Gilles Peskine449bd832023-01-11 14:50:10 +01001993 status = psa_pake_setup(&ssl->handshake->psa_pake_ctx, &cipher_suite);
1994 if (status != PSA_SUCCESS) {
Valerio Setti016f6822022-12-09 14:17:50 +01001995 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001996 }
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02001997
Gilles Peskine449bd832023-01-11 14:50:10 +01001998 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Przemek Stekielfde11282023-03-13 16:06:09 +01001999 user = jpake_server_id;
2000 user_len = sizeof(jpake_server_id);
2001 peer = jpake_client_id;
2002 peer_len = sizeof(jpake_client_id);
Gilles Peskine449bd832023-01-11 14:50:10 +01002003 } else {
Przemek Stekielfde11282023-03-13 16:06:09 +01002004 user = jpake_client_id;
2005 user_len = sizeof(jpake_client_id);
2006 peer = jpake_server_id;
2007 peer_len = sizeof(jpake_server_id);
Gilles Peskine449bd832023-01-11 14:50:10 +01002008 }
Neil Armstrongca7d5062022-05-31 14:43:23 +02002009
Przemek Stekiel4cd20312023-03-01 11:11:28 +01002010 status = psa_pake_set_user(&ssl->handshake->psa_pake_ctx, user, user_len);
2011 if (status != PSA_SUCCESS) {
2012 return status;
2013 }
2014
2015 status = psa_pake_set_peer(&ssl->handshake->psa_pake_ctx, peer, peer_len);
Gilles Peskine449bd832023-01-11 14:50:10 +01002016 if (status != PSA_SUCCESS) {
Valerio Setti016f6822022-12-09 14:17:50 +01002017 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01002018 }
Valerio Setti016f6822022-12-09 14:17:50 +01002019
Gilles Peskine449bd832023-01-11 14:50:10 +01002020 status = psa_pake_set_password_key(&ssl->handshake->psa_pake_ctx, pwd);
2021 if (status != PSA_SUCCESS) {
Valerio Setti016f6822022-12-09 14:17:50 +01002022 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01002023 }
Valerio Setti016f6822022-12-09 14:17:50 +01002024
2025 ssl->handshake->psa_pake_ctx_is_ok = 1;
2026
Gilles Peskine449bd832023-01-11 14:50:10 +01002027 return PSA_SUCCESS;
Valerio Setti016f6822022-12-09 14:17:50 +01002028}
2029
Gilles Peskine449bd832023-01-11 14:50:10 +01002030int mbedtls_ssl_set_hs_ecjpake_password(mbedtls_ssl_context *ssl,
2031 const unsigned char *pw,
2032 size_t pw_len)
Valerio Setti016f6822022-12-09 14:17:50 +01002033{
2034 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
2035 psa_status_t status;
2036
Gilles Peskine449bd832023-01-11 14:50:10 +01002037 if (ssl->handshake == NULL || ssl->conf == NULL) {
2038 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Neil Armstrongca7d5062022-05-31 14:43:23 +02002039 }
2040
Gilles Peskine449bd832023-01-11 14:50:10 +01002041 /* Empty password is not valid */
2042 if ((pw == NULL) || (pw_len == 0)) {
2043 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2044 }
2045
2046 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_DERIVE);
2047 psa_set_key_algorithm(&attributes, PSA_ALG_JPAKE);
2048 psa_set_key_type(&attributes, PSA_KEY_TYPE_PASSWORD);
2049
2050 status = psa_import_key(&attributes, pw, pw_len,
2051 &ssl->handshake->psa_pake_password);
2052 if (status != PSA_SUCCESS) {
2053 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
2054 }
2055
2056 status = mbedtls_ssl_set_hs_ecjpake_password_common(ssl,
2057 ssl->handshake->psa_pake_password);
2058 if (status != PSA_SUCCESS) {
2059 psa_destroy_key(ssl->handshake->psa_pake_password);
2060 psa_pake_abort(&ssl->handshake->psa_pake_ctx);
2061 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
2062 }
2063
2064 return 0;
Valerio Setti02c25b52022-11-15 14:08:42 +01002065}
Valerio Settia9a97dc2022-11-28 18:26:16 +01002066
Gilles Peskine449bd832023-01-11 14:50:10 +01002067int mbedtls_ssl_set_hs_ecjpake_password_opaque(mbedtls_ssl_context *ssl,
2068 mbedtls_svc_key_id_t pwd)
Valerio Settia9a97dc2022-11-28 18:26:16 +01002069{
Valerio Settia9a97dc2022-11-28 18:26:16 +01002070 psa_status_t status;
2071
Gilles Peskine449bd832023-01-11 14:50:10 +01002072 if (ssl->handshake == NULL || ssl->conf == NULL) {
2073 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Neil Armstrongca7d5062022-05-31 14:43:23 +02002074 }
2075
Gilles Peskine449bd832023-01-11 14:50:10 +01002076 if (mbedtls_svc_key_id_is_null(pwd)) {
2077 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2078 }
2079
2080 status = mbedtls_ssl_set_hs_ecjpake_password_common(ssl, pwd);
2081 if (status != PSA_SUCCESS) {
2082 psa_pake_abort(&ssl->handshake->psa_pake_ctx);
2083 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
2084 }
2085
2086 return 0;
Valerio Setti02c25b52022-11-15 14:08:42 +01002087}
2088#else /* MBEDTLS_USE_PSA_CRYPTO */
Gilles Peskine449bd832023-01-11 14:50:10 +01002089int mbedtls_ssl_set_hs_ecjpake_password(mbedtls_ssl_context *ssl,
2090 const unsigned char *pw,
2091 size_t pw_len)
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002092{
2093 mbedtls_ecjpake_role role;
2094
Gilles Peskine449bd832023-01-11 14:50:10 +01002095 if (ssl->handshake == NULL || ssl->conf == NULL) {
2096 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2097 }
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002098
Valerio Settic689ed82022-12-07 14:40:38 +01002099 /* Empty password is not valid */
Gilles Peskine449bd832023-01-11 14:50:10 +01002100 if ((pw == NULL) || (pw_len == 0)) {
2101 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2102 }
Valerio Settic689ed82022-12-07 14:40:38 +01002103
Gilles Peskine449bd832023-01-11 14:50:10 +01002104 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002105 role = MBEDTLS_ECJPAKE_SERVER;
Gilles Peskine449bd832023-01-11 14:50:10 +01002106 } else {
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002107 role = MBEDTLS_ECJPAKE_CLIENT;
Gilles Peskine449bd832023-01-11 14:50:10 +01002108 }
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002109
Gilles Peskine449bd832023-01-11 14:50:10 +01002110 return mbedtls_ecjpake_setup(&ssl->handshake->ecjpake_ctx,
2111 role,
2112 MBEDTLS_MD_SHA256,
2113 MBEDTLS_ECP_DP_SECP256R1,
2114 pw, pw_len);
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002115}
Valerio Setti02c25b52022-11-15 14:08:42 +01002116#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02002117#endif /* MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED */
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002118
Ronald Cron73fe8df2022-10-05 14:31:43 +02002119#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01002120int mbedtls_ssl_conf_has_static_psk(mbedtls_ssl_config const *conf)
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002121{
Gilles Peskine449bd832023-01-11 14:50:10 +01002122 if (conf->psk_identity == NULL ||
2123 conf->psk_identity_len == 0) {
2124 return 0;
Ronald Crond29e13e2022-10-19 10:33:48 +02002125 }
2126
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002127#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01002128 if (!mbedtls_svc_key_id_is_null(conf->psk_opaque)) {
2129 return 1;
2130 }
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002131#endif /* MBEDTLS_USE_PSA_CRYPTO */
Ronald Crond29e13e2022-10-19 10:33:48 +02002132
Gilles Peskine449bd832023-01-11 14:50:10 +01002133 if (conf->psk != NULL && conf->psk_len != 0) {
2134 return 1;
2135 }
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002136
Gilles Peskine449bd832023-01-11 14:50:10 +01002137 return 0;
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002138}
2139
Gilles Peskine449bd832023-01-11 14:50:10 +01002140static void ssl_conf_remove_psk(mbedtls_ssl_config *conf)
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002141{
2142 /* Remove reference to existing PSK, if any. */
2143#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01002144 if (!mbedtls_svc_key_id_is_null(conf->psk_opaque)) {
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002145 /* The maintenance of the PSK key slot is the
2146 * user's responsibility. */
Ronald Croncf56a0a2020-08-04 09:51:30 +02002147 conf->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002148 }
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002149#endif /* MBEDTLS_USE_PSA_CRYPTO */
Gilles Peskine449bd832023-01-11 14:50:10 +01002150 if (conf->psk != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01002151 mbedtls_zeroize_and_free(conf->psk, conf->psk_len);
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002152 conf->psk = NULL;
2153 conf->psk_len = 0;
2154 }
2155
2156 /* Remove reference to PSK identity, if any. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002157 if (conf->psk_identity != NULL) {
2158 mbedtls_free(conf->psk_identity);
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002159 conf->psk_identity = NULL;
2160 conf->psk_identity_len = 0;
2161 }
2162}
2163
Hanno Becker7390c712018-11-15 13:33:04 +00002164/* This function assumes that PSK identity in the SSL config is unset.
2165 * It checks that the provided identity is well-formed and attempts
2166 * to make a copy of it in the SSL config.
2167 * On failure, the PSK identity in the config remains unset. */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002168MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002169static int ssl_conf_set_psk_identity(mbedtls_ssl_config *conf,
2170 unsigned char const *psk_identity,
2171 size_t psk_identity_len)
Paul Bakkerd4a56ec2013-04-16 18:05:29 +02002172{
Manuel Pégourié-Gonnardc6b5d832015-08-27 16:37:35 +02002173 /* Identity len will be encoded on two bytes */
Gilles Peskine449bd832023-01-11 14:50:10 +01002174 if (psk_identity == NULL ||
Ronald Cron2a87e9b2022-10-19 10:55:26 +02002175 psk_identity_len == 0 ||
Gilles Peskine449bd832023-01-11 14:50:10 +01002176 (psk_identity_len >> 16) != 0 ||
2177 psk_identity_len > MBEDTLS_SSL_OUT_CONTENT_LEN) {
2178 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnardc6b5d832015-08-27 16:37:35 +02002179 }
2180
Gilles Peskine449bd832023-01-11 14:50:10 +01002181 conf->psk_identity = mbedtls_calloc(1, psk_identity_len);
2182 if (conf->psk_identity == NULL) {
2183 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
2184 }
Paul Bakker6db455e2013-09-18 17:29:31 +02002185
Manuel Pégourié-Gonnard120fdbd2015-05-07 17:07:50 +01002186 conf->psk_identity_len = psk_identity_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01002187 memcpy(conf->psk_identity, psk_identity, conf->psk_identity_len);
Paul Bakker5ad403f2013-09-18 21:21:30 +02002188
Gilles Peskine449bd832023-01-11 14:50:10 +01002189 return 0;
Paul Bakker6db455e2013-09-18 17:29:31 +02002190}
2191
Gilles Peskine449bd832023-01-11 14:50:10 +01002192int mbedtls_ssl_conf_psk(mbedtls_ssl_config *conf,
2193 const unsigned char *psk, size_t psk_len,
2194 const unsigned char *psk_identity, size_t psk_identity_len)
Hanno Becker7390c712018-11-15 13:33:04 +00002195{
Janos Follath865b3eb2019-12-16 11:46:15 +00002196 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002197
2198 /* We currently only support one PSK, raw or opaque. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002199 if (mbedtls_ssl_conf_has_static_psk(conf)) {
2200 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
2201 }
Hanno Becker7390c712018-11-15 13:33:04 +00002202
2203 /* Check and set raw PSK */
Gilles Peskine449bd832023-01-11 14:50:10 +01002204 if (psk == NULL) {
2205 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2206 }
2207 if (psk_len == 0) {
2208 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2209 }
2210 if (psk_len > MBEDTLS_PSK_MAX_LEN) {
2211 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2212 }
Piotr Nowicki9926eaf2019-11-20 14:54:36 +01002213
Gilles Peskine449bd832023-01-11 14:50:10 +01002214 if ((conf->psk = mbedtls_calloc(1, psk_len)) == NULL) {
2215 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
2216 }
Hanno Becker7390c712018-11-15 13:33:04 +00002217 conf->psk_len = psk_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01002218 memcpy(conf->psk, psk, conf->psk_len);
Hanno Becker7390c712018-11-15 13:33:04 +00002219
2220 /* Check and set PSK Identity */
Gilles Peskine449bd832023-01-11 14:50:10 +01002221 ret = ssl_conf_set_psk_identity(conf, psk_identity, psk_identity_len);
2222 if (ret != 0) {
2223 ssl_conf_remove_psk(conf);
2224 }
Hanno Becker7390c712018-11-15 13:33:04 +00002225
Gilles Peskine449bd832023-01-11 14:50:10 +01002226 return ret;
Hanno Becker7390c712018-11-15 13:33:04 +00002227}
2228
Gilles Peskine449bd832023-01-11 14:50:10 +01002229static void ssl_remove_psk(mbedtls_ssl_context *ssl)
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002230{
2231#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01002232 if (!mbedtls_svc_key_id_is_null(ssl->handshake->psk_opaque)) {
Neil Armstrong501c9322022-05-03 09:35:09 +02002233 /* The maintenance of the external PSK key slot is the
2234 * user's responsibility. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002235 if (ssl->handshake->psk_opaque_is_internal) {
2236 psa_destroy_key(ssl->handshake->psk_opaque);
Neil Armstrong501c9322022-05-03 09:35:09 +02002237 ssl->handshake->psk_opaque_is_internal = 0;
2238 }
Ronald Croncf56a0a2020-08-04 09:51:30 +02002239 ssl->handshake->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002240 }
Neil Armstronge952a302022-05-03 10:22:14 +02002241#else
Gilles Peskine449bd832023-01-11 14:50:10 +01002242 if (ssl->handshake->psk != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01002243 mbedtls_zeroize_and_free(ssl->handshake->psk,
Gilles Peskine449bd832023-01-11 14:50:10 +01002244 ssl->handshake->psk_len);
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002245 ssl->handshake->psk_len = 0;
2246 }
Neil Armstronge952a302022-05-03 10:22:14 +02002247#endif /* MBEDTLS_USE_PSA_CRYPTO */
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002248}
2249
Gilles Peskine449bd832023-01-11 14:50:10 +01002250int mbedtls_ssl_set_hs_psk(mbedtls_ssl_context *ssl,
2251 const unsigned char *psk, size_t psk_len)
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002252{
Neil Armstrong501c9322022-05-03 09:35:09 +02002253#if defined(MBEDTLS_USE_PSA_CRYPTO)
2254 psa_key_attributes_t key_attributes = psa_key_attributes_init();
Jerry Yu5d01c052022-08-17 10:18:10 +08002255 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Jerry Yu24b8c812022-08-20 19:06:56 +08002256 psa_algorithm_t alg = PSA_ALG_NONE;
Jerry Yu5d01c052022-08-17 10:18:10 +08002257 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Neil Armstrong501c9322022-05-03 09:35:09 +02002258#endif /* MBEDTLS_USE_PSA_CRYPTO */
2259
Gilles Peskine449bd832023-01-11 14:50:10 +01002260 if (psk == NULL || ssl->handshake == NULL) {
2261 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2262 }
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002263
Gilles Peskine449bd832023-01-11 14:50:10 +01002264 if (psk_len > MBEDTLS_PSK_MAX_LEN) {
2265 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2266 }
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002267
Gilles Peskine449bd832023-01-11 14:50:10 +01002268 ssl_remove_psk(ssl);
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002269
Neil Armstrong501c9322022-05-03 09:35:09 +02002270#if defined(MBEDTLS_USE_PSA_CRYPTO)
Jerry Yuccc68a42022-07-26 16:39:20 +08002271#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01002272 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_2) {
2273 if (ssl->handshake->ciphersuite_info->mac == MBEDTLS_MD_SHA384) {
2274 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_384);
2275 } else {
2276 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_256);
2277 }
2278 psa_set_key_usage_flags(&key_attributes, PSA_KEY_USAGE_DERIVE);
Jerry Yuccc68a42022-07-26 16:39:20 +08002279 }
2280#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Neil Armstrong501c9322022-05-03 09:35:09 +02002281
Jerry Yu568ec252022-07-22 21:27:34 +08002282#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01002283 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
2284 alg = PSA_ALG_HKDF_EXTRACT(PSA_ALG_ANY_HASH);
2285 psa_set_key_usage_flags(&key_attributes,
2286 PSA_KEY_USAGE_DERIVE | PSA_KEY_USAGE_EXPORT);
Jerry Yuccc68a42022-07-26 16:39:20 +08002287 }
2288#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
2289
Gilles Peskine449bd832023-01-11 14:50:10 +01002290 psa_set_key_algorithm(&key_attributes, alg);
2291 psa_set_key_type(&key_attributes, PSA_KEY_TYPE_DERIVE);
Neil Armstrong501c9322022-05-03 09:35:09 +02002292
Gilles Peskine449bd832023-01-11 14:50:10 +01002293 status = psa_import_key(&key_attributes, psk, psk_len, &key);
2294 if (status != PSA_SUCCESS) {
2295 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
2296 }
Neil Armstrong501c9322022-05-03 09:35:09 +02002297
2298 /* Allow calling psa_destroy_key() on psk remove */
2299 ssl->handshake->psk_opaque_is_internal = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01002300 return mbedtls_ssl_set_hs_psk_opaque(ssl, key);
Neil Armstrong501c9322022-05-03 09:35:09 +02002301#else
Gilles Peskine449bd832023-01-11 14:50:10 +01002302 if ((ssl->handshake->psk = mbedtls_calloc(1, psk_len)) == NULL) {
2303 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
2304 }
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002305
2306 ssl->handshake->psk_len = psk_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01002307 memcpy(ssl->handshake->psk, psk, ssl->handshake->psk_len);
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002308
Gilles Peskine449bd832023-01-11 14:50:10 +01002309 return 0;
Neil Armstrong501c9322022-05-03 09:35:09 +02002310#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002311}
2312
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002313#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01002314int mbedtls_ssl_conf_psk_opaque(mbedtls_ssl_config *conf,
2315 mbedtls_svc_key_id_t psk,
2316 const unsigned char *psk_identity,
2317 size_t psk_identity_len)
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002318{
Janos Follath865b3eb2019-12-16 11:46:15 +00002319 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002320
2321 /* We currently only support one PSK, raw or opaque. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002322 if (mbedtls_ssl_conf_has_static_psk(conf)) {
2323 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
2324 }
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002325
Hanno Becker7390c712018-11-15 13:33:04 +00002326 /* Check and set opaque PSK */
Gilles Peskine449bd832023-01-11 14:50:10 +01002327 if (mbedtls_svc_key_id_is_null(psk)) {
2328 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2329 }
Ronald Croncf56a0a2020-08-04 09:51:30 +02002330 conf->psk_opaque = psk;
Hanno Becker7390c712018-11-15 13:33:04 +00002331
2332 /* Check and set PSK Identity */
Gilles Peskine449bd832023-01-11 14:50:10 +01002333 ret = ssl_conf_set_psk_identity(conf, psk_identity,
2334 psk_identity_len);
2335 if (ret != 0) {
2336 ssl_conf_remove_psk(conf);
2337 }
Hanno Becker7390c712018-11-15 13:33:04 +00002338
Gilles Peskine449bd832023-01-11 14:50:10 +01002339 return ret;
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002340}
2341
Gilles Peskine449bd832023-01-11 14:50:10 +01002342int mbedtls_ssl_set_hs_psk_opaque(mbedtls_ssl_context *ssl,
2343 mbedtls_svc_key_id_t psk)
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002344{
Gilles Peskine449bd832023-01-11 14:50:10 +01002345 if ((mbedtls_svc_key_id_is_null(psk)) ||
2346 (ssl->handshake == NULL)) {
2347 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2348 }
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002349
Gilles Peskine449bd832023-01-11 14:50:10 +01002350 ssl_remove_psk(ssl);
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002351 ssl->handshake->psk_opaque = psk;
Gilles Peskine449bd832023-01-11 14:50:10 +01002352 return 0;
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002353}
2354#endif /* MBEDTLS_USE_PSA_CRYPTO */
2355
Jerry Yu8897c072022-08-12 13:56:53 +08002356#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002357void mbedtls_ssl_conf_psk_cb(mbedtls_ssl_config *conf,
2358 int (*f_psk)(void *, mbedtls_ssl_context *, const unsigned char *,
2359 size_t),
2360 void *p_psk)
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002361{
2362 conf->f_psk = f_psk;
2363 conf->p_psk = p_psk;
2364}
Jerry Yu8897c072022-08-12 13:56:53 +08002365#endif /* MBEDTLS_SSL_SRV_C */
2366
Ronald Cron73fe8df2022-10-05 14:31:43 +02002367#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED */
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002368
2369#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine301711e2022-04-26 16:57:05 +02002370static mbedtls_ssl_mode_t mbedtls_ssl_get_base_mode(
Gilles Peskine449bd832023-01-11 14:50:10 +01002371 psa_algorithm_t alg)
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002372{
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002373#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01002374 if (alg == PSA_ALG_CBC_NO_PADDING) {
2375 return MBEDTLS_SSL_MODE_CBC;
2376 }
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002377#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
Gilles Peskine449bd832023-01-11 14:50:10 +01002378 if (PSA_ALG_IS_AEAD(alg)) {
2379 return MBEDTLS_SSL_MODE_AEAD;
2380 }
2381 return MBEDTLS_SSL_MODE_STREAM;
Gilles Peskine301711e2022-04-26 16:57:05 +02002382}
2383
2384#else /* MBEDTLS_USE_PSA_CRYPTO */
2385
2386static mbedtls_ssl_mode_t mbedtls_ssl_get_base_mode(
Gilles Peskine449bd832023-01-11 14:50:10 +01002387 mbedtls_cipher_mode_t mode)
Gilles Peskine301711e2022-04-26 16:57:05 +02002388{
2389#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01002390 if (mode == MBEDTLS_MODE_CBC) {
2391 return MBEDTLS_SSL_MODE_CBC;
2392 }
Gilles Peskine301711e2022-04-26 16:57:05 +02002393#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
2394
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002395#if defined(MBEDTLS_GCM_C) || \
2396 defined(MBEDTLS_CCM_C) || \
2397 defined(MBEDTLS_CHACHAPOLY_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002398 if (mode == MBEDTLS_MODE_GCM ||
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002399 mode == MBEDTLS_MODE_CCM ||
Gilles Peskine449bd832023-01-11 14:50:10 +01002400 mode == MBEDTLS_MODE_CHACHAPOLY) {
2401 return MBEDTLS_SSL_MODE_AEAD;
2402 }
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002403#endif /* MBEDTLS_GCM_C || MBEDTLS_CCM_C || MBEDTLS_CHACHAPOLY_C */
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002404
Gilles Peskine449bd832023-01-11 14:50:10 +01002405 return MBEDTLS_SSL_MODE_STREAM;
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002406}
Gilles Peskine301711e2022-04-26 16:57:05 +02002407#endif /* MBEDTLS_USE_PSA_CRYPTO */
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002408
Gilles Peskinee108d982022-04-26 16:50:40 +02002409static mbedtls_ssl_mode_t mbedtls_ssl_get_actual_mode(
2410 mbedtls_ssl_mode_t base_mode,
Gilles Peskine449bd832023-01-11 14:50:10 +01002411 int encrypt_then_mac)
Gilles Peskinee108d982022-04-26 16:50:40 +02002412{
2413#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01002414 if (encrypt_then_mac == MBEDTLS_SSL_ETM_ENABLED &&
2415 base_mode == MBEDTLS_SSL_MODE_CBC) {
2416 return MBEDTLS_SSL_MODE_CBC_ETM;
Gilles Peskinee108d982022-04-26 16:50:40 +02002417 }
2418#else
2419 (void) encrypt_then_mac;
2420#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002421 return base_mode;
Gilles Peskinee108d982022-04-26 16:50:40 +02002422}
2423
Neil Armstrongab555e02022-04-04 11:07:59 +02002424mbedtls_ssl_mode_t mbedtls_ssl_get_mode_from_transform(
Gilles Peskine449bd832023-01-11 14:50:10 +01002425 const mbedtls_ssl_transform *transform)
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002426{
Gilles Peskinee108d982022-04-26 16:50:40 +02002427 mbedtls_ssl_mode_t base_mode = mbedtls_ssl_get_base_mode(
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002428#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01002429 transform->psa_alg
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002430#else
Gilles Peskine449bd832023-01-11 14:50:10 +01002431 mbedtls_cipher_get_cipher_mode(&transform->cipher_ctx_enc)
Gilles Peskinee108d982022-04-26 16:50:40 +02002432#endif
2433 );
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002434
Gilles Peskinee108d982022-04-26 16:50:40 +02002435 int encrypt_then_mac = 0;
Neil Armstrongf2c82f02022-04-05 11:16:53 +02002436#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskinee108d982022-04-26 16:50:40 +02002437 encrypt_then_mac = transform->encrypt_then_mac;
2438#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002439 return mbedtls_ssl_get_actual_mode(base_mode, encrypt_then_mac);
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002440}
2441
Neil Armstrongab555e02022-04-04 11:07:59 +02002442mbedtls_ssl_mode_t mbedtls_ssl_get_mode_from_ciphersuite(
Neil Armstrongf2c82f02022-04-05 11:16:53 +02002443#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01002444 int encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02002445#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01002446 const mbedtls_ssl_ciphersuite_t *suite)
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002447{
Gilles Peskinee108d982022-04-26 16:50:40 +02002448 mbedtls_ssl_mode_t base_mode = MBEDTLS_SSL_MODE_STREAM;
2449
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002450#if defined(MBEDTLS_USE_PSA_CRYPTO)
2451 psa_status_t status;
2452 psa_algorithm_t alg;
2453 psa_key_type_t type;
2454 size_t size;
Dave Rodgman2eab4622023-10-05 13:30:37 +01002455 status = mbedtls_ssl_cipher_to_psa((mbedtls_cipher_type_t) suite->cipher,
2456 0, &alg, &type, &size);
Gilles Peskine449bd832023-01-11 14:50:10 +01002457 if (status == PSA_SUCCESS) {
2458 base_mode = mbedtls_ssl_get_base_mode(alg);
2459 }
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002460#else
2461 const mbedtls_cipher_info_t *cipher =
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01002462 mbedtls_cipher_info_from_type((mbedtls_cipher_type_t) suite->cipher);
Gilles Peskine449bd832023-01-11 14:50:10 +01002463 if (cipher != NULL) {
Gilles Peskinee108d982022-04-26 16:50:40 +02002464 base_mode =
2465 mbedtls_ssl_get_base_mode(
Gilles Peskine449bd832023-01-11 14:50:10 +01002466 mbedtls_cipher_info_get_mode(cipher));
Gilles Peskinee108d982022-04-26 16:50:40 +02002467 }
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002468#endif /* MBEDTLS_USE_PSA_CRYPTO */
2469
Gilles Peskinee108d982022-04-26 16:50:40 +02002470#if !defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
2471 int encrypt_then_mac = 0;
2472#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002473 return mbedtls_ssl_get_actual_mode(base_mode, encrypt_then_mac);
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002474}
2475
Neil Armstrong8395d7a2022-05-18 11:44:56 +02002476#if defined(MBEDTLS_USE_PSA_CRYPTO) || defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yu251a12e2022-07-13 15:15:48 +08002477
Gilles Peskine449bd832023-01-11 14:50:10 +01002478psa_status_t mbedtls_ssl_cipher_to_psa(mbedtls_cipher_type_t mbedtls_cipher_type,
2479 size_t taglen,
2480 psa_algorithm_t *alg,
2481 psa_key_type_t *key_type,
2482 size_t *key_size)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002483{
Yanray Wang19e4dc82023-11-16 18:02:05 +08002484#if !defined(MBEDTLS_SSL_HAVE_CCM)
2485 (void) taglen;
2486#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002487 switch (mbedtls_cipher_type) {
Yanray Wang1a369d62023-11-16 15:17:31 +08002488#if defined(MBEDTLS_SSL_HAVE_AES) && defined(MBEDTLS_SSL_HAVE_CBC)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002489 case MBEDTLS_CIPHER_AES_128_CBC:
2490 *alg = PSA_ALG_CBC_NO_PADDING;
2491 *key_type = PSA_KEY_TYPE_AES;
2492 *key_size = 128;
2493 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002494#endif
2495#if defined(MBEDTLS_SSL_HAVE_AES) && defined(MBEDTLS_SSL_HAVE_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002496 case MBEDTLS_CIPHER_AES_128_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002497 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002498 *key_type = PSA_KEY_TYPE_AES;
2499 *key_size = 128;
2500 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002501#endif
2502#if defined(MBEDTLS_SSL_HAVE_AES) && defined(MBEDTLS_SSL_HAVE_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002503 case MBEDTLS_CIPHER_AES_128_GCM:
2504 *alg = PSA_ALG_GCM;
2505 *key_type = PSA_KEY_TYPE_AES;
2506 *key_size = 128;
2507 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002508#endif
2509#if defined(MBEDTLS_SSL_HAVE_AES) && defined(MBEDTLS_SSL_HAVE_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002510 case MBEDTLS_CIPHER_AES_192_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002511 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002512 *key_type = PSA_KEY_TYPE_AES;
2513 *key_size = 192;
2514 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002515#endif
2516#if defined(MBEDTLS_SSL_HAVE_AES) && defined(MBEDTLS_SSL_HAVE_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002517 case MBEDTLS_CIPHER_AES_192_GCM:
2518 *alg = PSA_ALG_GCM;
2519 *key_type = PSA_KEY_TYPE_AES;
2520 *key_size = 192;
2521 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002522#endif
2523#if defined(MBEDTLS_SSL_HAVE_AES) && defined(MBEDTLS_SSL_HAVE_CBC)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002524 case MBEDTLS_CIPHER_AES_256_CBC:
2525 *alg = PSA_ALG_CBC_NO_PADDING;
2526 *key_type = PSA_KEY_TYPE_AES;
2527 *key_size = 256;
2528 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002529#endif
2530#if defined(MBEDTLS_SSL_HAVE_AES) && defined(MBEDTLS_SSL_HAVE_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002531 case MBEDTLS_CIPHER_AES_256_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002532 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002533 *key_type = PSA_KEY_TYPE_AES;
2534 *key_size = 256;
2535 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002536#endif
2537#if defined(MBEDTLS_SSL_HAVE_AES) && defined(MBEDTLS_SSL_HAVE_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002538 case MBEDTLS_CIPHER_AES_256_GCM:
2539 *alg = PSA_ALG_GCM;
2540 *key_type = PSA_KEY_TYPE_AES;
2541 *key_size = 256;
2542 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002543#endif
2544#if defined(MBEDTLS_SSL_HAVE_ARIA) && defined(MBEDTLS_SSL_HAVE_CBC)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002545 case MBEDTLS_CIPHER_ARIA_128_CBC:
2546 *alg = PSA_ALG_CBC_NO_PADDING;
2547 *key_type = PSA_KEY_TYPE_ARIA;
2548 *key_size = 128;
2549 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002550#endif
2551#if defined(MBEDTLS_SSL_HAVE_ARIA) && defined(MBEDTLS_SSL_HAVE_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002552 case MBEDTLS_CIPHER_ARIA_128_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002553 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002554 *key_type = PSA_KEY_TYPE_ARIA;
2555 *key_size = 128;
2556 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002557#endif
2558#if defined(MBEDTLS_SSL_HAVE_ARIA) && defined(MBEDTLS_SSL_HAVE_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002559 case MBEDTLS_CIPHER_ARIA_128_GCM:
2560 *alg = PSA_ALG_GCM;
2561 *key_type = PSA_KEY_TYPE_ARIA;
2562 *key_size = 128;
2563 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002564#endif
2565#if defined(MBEDTLS_SSL_HAVE_ARIA) && defined(MBEDTLS_SSL_HAVE_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002566 case MBEDTLS_CIPHER_ARIA_192_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002567 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002568 *key_type = PSA_KEY_TYPE_ARIA;
2569 *key_size = 192;
2570 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002571#endif
2572#if defined(MBEDTLS_SSL_HAVE_ARIA) && defined(MBEDTLS_SSL_HAVE_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002573 case MBEDTLS_CIPHER_ARIA_192_GCM:
2574 *alg = PSA_ALG_GCM;
2575 *key_type = PSA_KEY_TYPE_ARIA;
2576 *key_size = 192;
2577 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002578#endif
2579#if defined(MBEDTLS_SSL_HAVE_ARIA) && defined(MBEDTLS_SSL_HAVE_CBC)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002580 case MBEDTLS_CIPHER_ARIA_256_CBC:
2581 *alg = PSA_ALG_CBC_NO_PADDING;
2582 *key_type = PSA_KEY_TYPE_ARIA;
2583 *key_size = 256;
2584 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002585#endif
2586#if defined(MBEDTLS_SSL_HAVE_ARIA) && defined(MBEDTLS_SSL_HAVE_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002587 case MBEDTLS_CIPHER_ARIA_256_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002588 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002589 *key_type = PSA_KEY_TYPE_ARIA;
2590 *key_size = 256;
2591 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002592#endif
2593#if defined(MBEDTLS_SSL_HAVE_ARIA) && defined(MBEDTLS_SSL_HAVE_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002594 case MBEDTLS_CIPHER_ARIA_256_GCM:
2595 *alg = PSA_ALG_GCM;
2596 *key_type = PSA_KEY_TYPE_ARIA;
2597 *key_size = 256;
2598 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002599#endif
2600#if defined(MBEDTLS_SSL_HAVE_CAMELLIA) && defined(MBEDTLS_SSL_HAVE_CBC)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002601 case MBEDTLS_CIPHER_CAMELLIA_128_CBC:
2602 *alg = PSA_ALG_CBC_NO_PADDING;
2603 *key_type = PSA_KEY_TYPE_CAMELLIA;
2604 *key_size = 128;
2605 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002606#endif
2607#if defined(MBEDTLS_SSL_HAVE_CAMELLIA) && defined(MBEDTLS_SSL_HAVE_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002608 case MBEDTLS_CIPHER_CAMELLIA_128_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002609 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002610 *key_type = PSA_KEY_TYPE_CAMELLIA;
2611 *key_size = 128;
2612 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002613#endif
2614#if defined(MBEDTLS_SSL_HAVE_CAMELLIA) && defined(MBEDTLS_SSL_HAVE_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002615 case MBEDTLS_CIPHER_CAMELLIA_128_GCM:
2616 *alg = PSA_ALG_GCM;
2617 *key_type = PSA_KEY_TYPE_CAMELLIA;
2618 *key_size = 128;
2619 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002620#endif
2621#if defined(MBEDTLS_SSL_HAVE_CAMELLIA) && defined(MBEDTLS_SSL_HAVE_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002622 case MBEDTLS_CIPHER_CAMELLIA_192_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002623 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002624 *key_type = PSA_KEY_TYPE_CAMELLIA;
2625 *key_size = 192;
2626 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002627#endif
2628#if defined(MBEDTLS_SSL_HAVE_CAMELLIA) && defined(MBEDTLS_SSL_HAVE_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002629 case MBEDTLS_CIPHER_CAMELLIA_192_GCM:
2630 *alg = PSA_ALG_GCM;
2631 *key_type = PSA_KEY_TYPE_CAMELLIA;
2632 *key_size = 192;
2633 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002634#endif
2635#if defined(MBEDTLS_SSL_HAVE_CAMELLIA) && defined(MBEDTLS_SSL_HAVE_CBC)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002636 case MBEDTLS_CIPHER_CAMELLIA_256_CBC:
2637 *alg = PSA_ALG_CBC_NO_PADDING;
2638 *key_type = PSA_KEY_TYPE_CAMELLIA;
2639 *key_size = 256;
2640 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002641#endif
2642#if defined(MBEDTLS_SSL_HAVE_CAMELLIA) && defined(MBEDTLS_SSL_HAVE_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002643 case MBEDTLS_CIPHER_CAMELLIA_256_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002644 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002645 *key_type = PSA_KEY_TYPE_CAMELLIA;
2646 *key_size = 256;
2647 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002648#endif
2649#if defined(MBEDTLS_SSL_HAVE_CAMELLIA) && defined(MBEDTLS_SSL_HAVE_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002650 case MBEDTLS_CIPHER_CAMELLIA_256_GCM:
2651 *alg = PSA_ALG_GCM;
2652 *key_type = PSA_KEY_TYPE_CAMELLIA;
2653 *key_size = 256;
2654 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002655#endif
2656#if defined(MBEDTLS_SSL_HAVE_CHACHAPOLY)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002657 case MBEDTLS_CIPHER_CHACHA20_POLY1305:
2658 *alg = PSA_ALG_CHACHA20_POLY1305;
2659 *key_type = PSA_KEY_TYPE_CHACHA20;
2660 *key_size = 256;
2661 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002662#endif
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002663 case MBEDTLS_CIPHER_NULL:
2664 *alg = MBEDTLS_SSL_NULL_CIPHER;
2665 *key_type = 0;
2666 *key_size = 0;
2667 break;
2668 default:
2669 return PSA_ERROR_NOT_SUPPORTED;
2670 }
2671
2672 return PSA_SUCCESS;
2673}
Neil Armstrong8395d7a2022-05-18 11:44:56 +02002674#endif /* MBEDTLS_USE_PSA_CRYPTO || MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002675
Manuel Pégourié-Gonnardcf141ca2015-05-20 10:35:51 +02002676#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002677int mbedtls_ssl_conf_dh_param_bin(mbedtls_ssl_config *conf,
2678 const unsigned char *dhm_P, size_t P_len,
2679 const unsigned char *dhm_G, size_t G_len)
Hanno Beckera90658f2017-10-04 15:29:08 +01002680{
Janos Follath865b3eb2019-12-16 11:46:15 +00002681 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Beckera90658f2017-10-04 15:29:08 +01002682
Gilles Peskine449bd832023-01-11 14:50:10 +01002683 mbedtls_mpi_free(&conf->dhm_P);
2684 mbedtls_mpi_free(&conf->dhm_G);
Glenn Strausscee11292021-12-20 01:43:17 -05002685
Gilles Peskine449bd832023-01-11 14:50:10 +01002686 if ((ret = mbedtls_mpi_read_binary(&conf->dhm_P, dhm_P, P_len)) != 0 ||
2687 (ret = mbedtls_mpi_read_binary(&conf->dhm_G, dhm_G, G_len)) != 0) {
2688 mbedtls_mpi_free(&conf->dhm_P);
2689 mbedtls_mpi_free(&conf->dhm_G);
2690 return ret;
Hanno Beckera90658f2017-10-04 15:29:08 +01002691 }
2692
Gilles Peskine449bd832023-01-11 14:50:10 +01002693 return 0;
Hanno Beckera90658f2017-10-04 15:29:08 +01002694}
Paul Bakker5121ce52009-01-03 21:22:43 +00002695
Gilles Peskine449bd832023-01-11 14:50:10 +01002696int mbedtls_ssl_conf_dh_param_ctx(mbedtls_ssl_config *conf, mbedtls_dhm_context *dhm_ctx)
Paul Bakker1b57b062011-01-06 15:48:19 +00002697{
Janos Follath865b3eb2019-12-16 11:46:15 +00002698 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker1b57b062011-01-06 15:48:19 +00002699
Gilles Peskine449bd832023-01-11 14:50:10 +01002700 mbedtls_mpi_free(&conf->dhm_P);
2701 mbedtls_mpi_free(&conf->dhm_G);
Glenn Strausscee11292021-12-20 01:43:17 -05002702
Gilles Peskine449bd832023-01-11 14:50:10 +01002703 if ((ret = mbedtls_dhm_get_value(dhm_ctx, MBEDTLS_DHM_PARAM_P,
2704 &conf->dhm_P)) != 0 ||
2705 (ret = mbedtls_dhm_get_value(dhm_ctx, MBEDTLS_DHM_PARAM_G,
2706 &conf->dhm_G)) != 0) {
2707 mbedtls_mpi_free(&conf->dhm_P);
2708 mbedtls_mpi_free(&conf->dhm_G);
2709 return ret;
Manuel Pégourié-Gonnard1028b742015-05-06 17:33:07 +01002710 }
Paul Bakker1b57b062011-01-06 15:48:19 +00002711
Gilles Peskine449bd832023-01-11 14:50:10 +01002712 return 0;
Paul Bakker1b57b062011-01-06 15:48:19 +00002713}
Manuel Pégourié-Gonnardcf141ca2015-05-20 10:35:51 +02002714#endif /* MBEDTLS_DHM_C && MBEDTLS_SSL_SRV_C */
Paul Bakker1b57b062011-01-06 15:48:19 +00002715
Manuel Pégourié-Gonnardbd990d62015-06-11 14:49:42 +02002716#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_CLI_C)
2717/*
2718 * Set the minimum length for Diffie-Hellman parameters
2719 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002720void mbedtls_ssl_conf_dhm_min_bitlen(mbedtls_ssl_config *conf,
2721 unsigned int bitlen)
Manuel Pégourié-Gonnardbd990d62015-06-11 14:49:42 +02002722{
2723 conf->dhm_min_bitlen = bitlen;
2724}
2725#endif /* MBEDTLS_DHM_C && MBEDTLS_SSL_CLI_C */
2726
Ronald Crone68ab4f2022-10-05 12:46:29 +02002727#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu7ddc38c2022-01-19 11:08:05 +08002728#if !defined(MBEDTLS_DEPRECATED_REMOVED) && defined(MBEDTLS_SSL_PROTO_TLS1_2)
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02002729/*
2730 * Set allowed/preferred hashes for handshake signatures
2731 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002732void mbedtls_ssl_conf_sig_hashes(mbedtls_ssl_config *conf,
2733 const int *hashes)
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02002734{
2735 conf->sig_hashes = hashes;
2736}
Jerry Yu7ddc38c2022-01-19 11:08:05 +08002737#endif /* !MBEDTLS_DEPRECATED_REMOVED && MBEDTLS_SSL_PROTO_TLS1_2 */
Hanno Becker1cd6e002021-08-10 13:27:10 +01002738
Jerry Yuf017ee42022-01-12 15:49:48 +08002739/* Configure allowed signature algorithms for handshake */
Gilles Peskine449bd832023-01-11 14:50:10 +01002740void mbedtls_ssl_conf_sig_algs(mbedtls_ssl_config *conf,
2741 const uint16_t *sig_algs)
Hanno Becker1cd6e002021-08-10 13:27:10 +01002742{
Jerry Yuf017ee42022-01-12 15:49:48 +08002743#if !defined(MBEDTLS_DEPRECATED_REMOVED)
2744 conf->sig_hashes = NULL;
2745#endif /* !MBEDTLS_DEPRECATED_REMOVED */
2746 conf->sig_algs = sig_algs;
Hanno Becker1cd6e002021-08-10 13:27:10 +01002747}
Ronald Crone68ab4f2022-10-05 12:46:29 +02002748#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02002749
Manuel Pégourié-Gonnardf07ce3b2023-09-22 11:53:41 +02002750#if defined(MBEDTLS_ECP_C)
Brett Warrene0edc842021-08-17 09:53:13 +01002751#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002752/*
2753 * Set the allowed elliptic curves
Brett Warrene0edc842021-08-17 09:53:13 +01002754 *
2755 * mbedtls_ssl_setup() takes the provided list
2756 * and translates it to a list of IANA TLS group identifiers,
2757 * stored in ssl->handshake->group_list.
2758 *
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002759 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002760void mbedtls_ssl_conf_curves(mbedtls_ssl_config *conf,
2761 const mbedtls_ecp_group_id *curve_list)
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002762{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002763 conf->curve_list = curve_list;
Brett Warrene0edc842021-08-17 09:53:13 +01002764 conf->group_list = NULL;
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002765}
Brett Warrene0edc842021-08-17 09:53:13 +01002766#endif /* MBEDTLS_DEPRECATED_REMOVED */
Manuel Pégourié-Gonnardf07ce3b2023-09-22 11:53:41 +02002767#endif /* MBEDTLS_ECP_C */
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002768
Brett Warrene0edc842021-08-17 09:53:13 +01002769/*
2770 * Set the allowed groups
2771 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002772void mbedtls_ssl_conf_groups(mbedtls_ssl_config *conf,
2773 const uint16_t *group_list)
Brett Warrene0edc842021-08-17 09:53:13 +01002774{
Manuel Pégourié-Gonnardf07ce3b2023-09-22 11:53:41 +02002775#if defined(MBEDTLS_ECP_C) && !defined(MBEDTLS_DEPRECATED_REMOVED)
Brett Warrene0edc842021-08-17 09:53:13 +01002776 conf->curve_list = NULL;
2777#endif
2778 conf->group_list = group_list;
2779}
2780
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01002781#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002782int mbedtls_ssl_set_hostname(mbedtls_ssl_context *ssl, const char *hostname)
Paul Bakker5121ce52009-01-03 21:22:43 +00002783{
Hanno Becker947194e2017-04-07 13:25:49 +01002784 /* Initialize to suppress unnecessary compiler warning */
2785 size_t hostname_len = 0;
2786
2787 /* Check if new hostname is valid before
2788 * making any change to current one */
Gilles Peskine449bd832023-01-11 14:50:10 +01002789 if (hostname != NULL) {
2790 hostname_len = strlen(hostname);
Hanno Becker947194e2017-04-07 13:25:49 +01002791
Gilles Peskine449bd832023-01-11 14:50:10 +01002792 if (hostname_len > MBEDTLS_SSL_MAX_HOST_NAME_LEN) {
2793 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2794 }
Hanno Becker947194e2017-04-07 13:25:49 +01002795 }
2796
2797 /* Now it's clear that we will overwrite the old hostname,
2798 * so we can free it safely */
2799
Gilles Peskine449bd832023-01-11 14:50:10 +01002800 if (ssl->hostname != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01002801 mbedtls_zeroize_and_free(ssl->hostname, strlen(ssl->hostname));
Hanno Becker947194e2017-04-07 13:25:49 +01002802 }
2803
2804 /* Passing NULL as hostname shall clear the old one */
Manuel Pégourié-Gonnardba26c242015-05-06 10:47:06 +01002805
Gilles Peskine449bd832023-01-11 14:50:10 +01002806 if (hostname == NULL) {
Hanno Becker947194e2017-04-07 13:25:49 +01002807 ssl->hostname = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01002808 } else {
2809 ssl->hostname = mbedtls_calloc(1, hostname_len + 1);
2810 if (ssl->hostname == NULL) {
2811 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
2812 }
Paul Bakker75c1a6f2013-08-19 14:25:29 +02002813
Gilles Peskine449bd832023-01-11 14:50:10 +01002814 memcpy(ssl->hostname, hostname, hostname_len);
Paul Bakker75c1a6f2013-08-19 14:25:29 +02002815
Hanno Becker947194e2017-04-07 13:25:49 +01002816 ssl->hostname[hostname_len] = '\0';
2817 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002818
Gilles Peskine449bd832023-01-11 14:50:10 +01002819 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00002820}
Hanno Becker1a9a51c2017-04-07 13:02:16 +01002821#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00002822
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01002823#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01002824void mbedtls_ssl_conf_sni(mbedtls_ssl_config *conf,
2825 int (*f_sni)(void *, mbedtls_ssl_context *,
2826 const unsigned char *, size_t),
2827 void *p_sni)
Paul Bakker5701cdc2012-09-27 21:49:42 +00002828{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002829 conf->f_sni = f_sni;
2830 conf->p_sni = p_sni;
Paul Bakker5701cdc2012-09-27 21:49:42 +00002831}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002832#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
Paul Bakker5701cdc2012-09-27 21:49:42 +00002833
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002834#if defined(MBEDTLS_SSL_ALPN)
Gilles Peskine449bd832023-01-11 14:50:10 +01002835int mbedtls_ssl_conf_alpn_protocols(mbedtls_ssl_config *conf, const char **protos)
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002836{
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002837 size_t cur_len, tot_len;
2838 const char **p;
2839
2840 /*
Brian J Murray1903fb32016-11-06 04:45:15 -08002841 * RFC 7301 3.1: "Empty strings MUST NOT be included and byte strings
2842 * MUST NOT be truncated."
2843 * We check lengths now rather than later.
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002844 */
2845 tot_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01002846 for (p = protos; *p != NULL; p++) {
2847 cur_len = strlen(*p);
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002848 tot_len += cur_len;
2849
Gilles Peskine449bd832023-01-11 14:50:10 +01002850 if ((cur_len == 0) ||
2851 (cur_len > MBEDTLS_SSL_MAX_ALPN_NAME_LEN) ||
2852 (tot_len > MBEDTLS_SSL_MAX_ALPN_LIST_LEN)) {
2853 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2854 }
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002855 }
2856
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002857 conf->alpn_list = protos;
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002858
Gilles Peskine449bd832023-01-11 14:50:10 +01002859 return 0;
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002860}
2861
Gilles Peskine449bd832023-01-11 14:50:10 +01002862const char *mbedtls_ssl_get_alpn_protocol(const mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002863{
Gilles Peskine449bd832023-01-11 14:50:10 +01002864 return ssl->alpn_chosen;
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002865}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002866#endif /* MBEDTLS_SSL_ALPN */
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002867
Johan Pascalb62bb512015-12-03 21:56:45 +01002868#if defined(MBEDTLS_SSL_DTLS_SRTP)
Gilles Peskine449bd832023-01-11 14:50:10 +01002869void mbedtls_ssl_conf_srtp_mki_value_supported(mbedtls_ssl_config *conf,
2870 int support_mki_value)
Ron Eldor591f1622018-01-22 12:30:04 +02002871{
2872 conf->dtls_srtp_mki_support = support_mki_value;
2873}
2874
Gilles Peskine449bd832023-01-11 14:50:10 +01002875int mbedtls_ssl_dtls_srtp_set_mki_value(mbedtls_ssl_context *ssl,
2876 unsigned char *mki_value,
2877 uint16_t mki_len)
Ron Eldor591f1622018-01-22 12:30:04 +02002878{
Gilles Peskine449bd832023-01-11 14:50:10 +01002879 if (mki_len > MBEDTLS_TLS_SRTP_MAX_MKI_LENGTH) {
2880 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Ron Eldora9788042018-12-05 11:04:31 +02002881 }
Ron Eldor591f1622018-01-22 12:30:04 +02002882
Gilles Peskine449bd832023-01-11 14:50:10 +01002883 if (ssl->conf->dtls_srtp_mki_support == MBEDTLS_SSL_DTLS_SRTP_MKI_UNSUPPORTED) {
2884 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Ron Eldora9788042018-12-05 11:04:31 +02002885 }
Ron Eldor591f1622018-01-22 12:30:04 +02002886
Gilles Peskine449bd832023-01-11 14:50:10 +01002887 memcpy(ssl->dtls_srtp_info.mki_value, mki_value, mki_len);
Ron Eldor591f1622018-01-22 12:30:04 +02002888 ssl->dtls_srtp_info.mki_len = mki_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01002889 return 0;
Ron Eldor591f1622018-01-22 12:30:04 +02002890}
2891
Gilles Peskine449bd832023-01-11 14:50:10 +01002892int mbedtls_ssl_conf_dtls_srtp_protection_profiles(mbedtls_ssl_config *conf,
2893 const mbedtls_ssl_srtp_profile *profiles)
Johan Pascalb62bb512015-12-03 21:56:45 +01002894{
Johan Pascal253d0262020-09-22 13:04:45 +02002895 const mbedtls_ssl_srtp_profile *p;
2896 size_t list_size = 0;
Johan Pascalb62bb512015-12-03 21:56:45 +01002897
Johan Pascal253d0262020-09-22 13:04:45 +02002898 /* check the profiles list: all entry must be valid,
2899 * its size cannot be more than the total number of supported profiles, currently 4 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002900 for (p = profiles; *p != MBEDTLS_TLS_SRTP_UNSET &&
2901 list_size <= MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH;
2902 p++) {
2903 if (mbedtls_ssl_check_srtp_profile_value(*p) != MBEDTLS_TLS_SRTP_UNSET) {
Johan Pascal76fdf1d2020-10-22 23:31:00 +02002904 list_size++;
Gilles Peskine449bd832023-01-11 14:50:10 +01002905 } else {
Johan Pascal76fdf1d2020-10-22 23:31:00 +02002906 /* unsupported value, stop parsing and set the size to an error value */
2907 list_size = MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH + 1;
Johan Pascalb62bb512015-12-03 21:56:45 +01002908 }
2909 }
2910
Gilles Peskine449bd832023-01-11 14:50:10 +01002911 if (list_size > MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH) {
2912 conf->dtls_srtp_profile_list = NULL;
2913 conf->dtls_srtp_profile_list_len = 0;
2914 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Johan Pascal253d0262020-09-22 13:04:45 +02002915 }
2916
Johan Pascal9bc97ca2020-09-21 23:44:45 +02002917 conf->dtls_srtp_profile_list = profiles;
Johan Pascal253d0262020-09-22 13:04:45 +02002918 conf->dtls_srtp_profile_list_len = list_size;
Johan Pascalb62bb512015-12-03 21:56:45 +01002919
Gilles Peskine449bd832023-01-11 14:50:10 +01002920 return 0;
Johan Pascalb62bb512015-12-03 21:56:45 +01002921}
2922
Gilles Peskine449bd832023-01-11 14:50:10 +01002923void mbedtls_ssl_get_dtls_srtp_negotiation_result(const mbedtls_ssl_context *ssl,
2924 mbedtls_dtls_srtp_info *dtls_srtp_info)
Johan Pascalb62bb512015-12-03 21:56:45 +01002925{
Johan Pascal2258a4f2020-10-28 13:53:09 +01002926 dtls_srtp_info->chosen_dtls_srtp_profile = ssl->dtls_srtp_info.chosen_dtls_srtp_profile;
2927 /* do not copy the mki value if there is no chosen profile */
Gilles Peskine449bd832023-01-11 14:50:10 +01002928 if (dtls_srtp_info->chosen_dtls_srtp_profile == MBEDTLS_TLS_SRTP_UNSET) {
Johan Pascal2258a4f2020-10-28 13:53:09 +01002929 dtls_srtp_info->mki_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01002930 } else {
Johan Pascal2258a4f2020-10-28 13:53:09 +01002931 dtls_srtp_info->mki_len = ssl->dtls_srtp_info.mki_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01002932 memcpy(dtls_srtp_info->mki_value, ssl->dtls_srtp_info.mki_value,
2933 ssl->dtls_srtp_info.mki_len);
Johan Pascal2258a4f2020-10-28 13:53:09 +01002934 }
Johan Pascalb62bb512015-12-03 21:56:45 +01002935}
Johan Pascalb62bb512015-12-03 21:56:45 +01002936#endif /* MBEDTLS_SSL_DTLS_SRTP */
2937
Aditya Patwardhan3096f332022-07-26 14:31:46 +05302938#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Gilles Peskine449bd832023-01-11 14:50:10 +01002939void mbedtls_ssl_conf_max_version(mbedtls_ssl_config *conf, int major, int minor)
Paul Bakker490ecc82011-10-06 13:04:09 +00002940{
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01002941 conf->max_tls_version = (mbedtls_ssl_protocol_version) ((major << 8) | minor);
Paul Bakker490ecc82011-10-06 13:04:09 +00002942}
2943
Gilles Peskine449bd832023-01-11 14:50:10 +01002944void mbedtls_ssl_conf_min_version(mbedtls_ssl_config *conf, int major, int minor)
Paul Bakker1d29fb52012-09-28 13:28:45 +00002945{
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01002946 conf->min_tls_version = (mbedtls_ssl_protocol_version) ((major << 8) | minor);
Paul Bakker1d29fb52012-09-28 13:28:45 +00002947}
Aditya Patwardhan3096f332022-07-26 14:31:46 +05302948#endif /* MBEDTLS_DEPRECATED_REMOVED */
Paul Bakker1d29fb52012-09-28 13:28:45 +00002949
Janos Follath088ce432017-04-10 12:42:31 +01002950#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002951void mbedtls_ssl_conf_cert_req_ca_list(mbedtls_ssl_config *conf,
2952 char cert_req_ca_list)
Janos Follath088ce432017-04-10 12:42:31 +01002953{
2954 conf->cert_req_ca_list = cert_req_ca_list;
2955}
2956#endif
2957
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002958#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01002959void mbedtls_ssl_conf_encrypt_then_mac(mbedtls_ssl_config *conf, char etm)
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01002960{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002961 conf->encrypt_then_mac = etm;
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01002962}
2963#endif
2964
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002965#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
Gilles Peskine449bd832023-01-11 14:50:10 +01002966void mbedtls_ssl_conf_extended_master_secret(mbedtls_ssl_config *conf, char ems)
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02002967{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002968 conf->extended_ms = ems;
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02002969}
2970#endif
2971
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002972#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01002973int mbedtls_ssl_conf_max_frag_len(mbedtls_ssl_config *conf, unsigned char mfl_code)
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002974{
Gilles Peskine449bd832023-01-11 14:50:10 +01002975 if (mfl_code >= MBEDTLS_SSL_MAX_FRAG_LEN_INVALID ||
2976 ssl_mfl_code_to_length(mfl_code) > MBEDTLS_TLS_EXT_ADV_CONTENT_LEN) {
2977 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002978 }
2979
Manuel Pégourié-Gonnard6bf89d62015-05-05 17:01:57 +01002980 conf->mfl_code = mfl_code;
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002981
Gilles Peskine449bd832023-01-11 14:50:10 +01002982 return 0;
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002983}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002984#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002985
Gilles Peskine449bd832023-01-11 14:50:10 +01002986void mbedtls_ssl_conf_legacy_renegotiation(mbedtls_ssl_config *conf, int allow_legacy)
Paul Bakker48916f92012-09-16 19:57:18 +00002987{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002988 conf->allow_legacy_renegotiation = allow_legacy;
Paul Bakker48916f92012-09-16 19:57:18 +00002989}
2990
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002991#if defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01002992void mbedtls_ssl_conf_renegotiation(mbedtls_ssl_config *conf, int renegotiation)
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01002993{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002994 conf->disable_renegotiation = renegotiation;
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01002995}
2996
Gilles Peskine449bd832023-01-11 14:50:10 +01002997void mbedtls_ssl_conf_renegotiation_enforced(mbedtls_ssl_config *conf, int max_records)
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02002998{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002999 conf->renego_max_records = max_records;
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02003000}
3001
Gilles Peskine449bd832023-01-11 14:50:10 +01003002void mbedtls_ssl_conf_renegotiation_period(mbedtls_ssl_config *conf,
3003 const unsigned char period[8])
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01003004{
Gilles Peskine449bd832023-01-11 14:50:10 +01003005 memcpy(conf->renego_period, period, 8);
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01003006}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003007#endif /* MBEDTLS_SSL_RENEGOTIATION */
Paul Bakker5121ce52009-01-03 21:22:43 +00003008
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003009#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02003010#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01003011void mbedtls_ssl_conf_session_tickets(mbedtls_ssl_config *conf, int use_tickets)
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02003012{
Manuel Pégourié-Gonnard2b494452015-05-06 10:05:11 +01003013 conf->session_tickets = use_tickets;
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02003014}
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02003015#endif
Paul Bakker606b4ba2013-08-14 16:52:14 +02003016
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02003017#if defined(MBEDTLS_SSL_SRV_C)
Jerry Yu1ad7ace2022-08-09 13:28:39 +08003018
Jerry Yud0766ec2022-09-22 10:46:57 +08003019#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003020void mbedtls_ssl_conf_new_session_tickets(mbedtls_ssl_config *conf,
3021 uint16_t num_tickets)
Jerry Yu1ad7ace2022-08-09 13:28:39 +08003022{
Jerry Yud0766ec2022-09-22 10:46:57 +08003023 conf->new_session_tickets_count = num_tickets;
Jerry Yu1ad7ace2022-08-09 13:28:39 +08003024}
3025#endif
3026
Gilles Peskine449bd832023-01-11 14:50:10 +01003027void mbedtls_ssl_conf_session_tickets_cb(mbedtls_ssl_config *conf,
3028 mbedtls_ssl_ticket_write_t *f_ticket_write,
3029 mbedtls_ssl_ticket_parse_t *f_ticket_parse,
3030 void *p_ticket)
Paul Bakker606b4ba2013-08-14 16:52:14 +02003031{
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02003032 conf->f_ticket_write = f_ticket_write;
3033 conf->f_ticket_parse = f_ticket_parse;
3034 conf->p_ticket = p_ticket;
Paul Bakker606b4ba2013-08-14 16:52:14 +02003035}
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02003036#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003037#endif /* MBEDTLS_SSL_SESSION_TICKETS */
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02003038
Gilles Peskine449bd832023-01-11 14:50:10 +01003039void mbedtls_ssl_set_export_keys_cb(mbedtls_ssl_context *ssl,
3040 mbedtls_ssl_export_keys_t *f_export_keys,
3041 void *p_export_keys)
Robert Cragie4feb7ae2015-10-02 13:33:37 +01003042{
Hanno Becker7e6c1782021-06-08 09:24:55 +01003043 ssl->f_export_keys = f_export_keys;
3044 ssl->p_export_keys = p_export_keys;
Ron Eldorf5cc10d2019-05-07 18:33:40 +03003045}
Robert Cragie4feb7ae2015-10-02 13:33:37 +01003046
Gilles Peskineb74a1c72018-04-24 13:09:22 +02003047#if defined(MBEDTLS_SSL_ASYNC_PRIVATE)
Gilles Peskine8bf79f62018-01-05 21:11:53 +01003048void mbedtls_ssl_conf_async_private_cb(
3049 mbedtls_ssl_config *conf,
3050 mbedtls_ssl_async_sign_t *f_async_sign,
3051 mbedtls_ssl_async_decrypt_t *f_async_decrypt,
3052 mbedtls_ssl_async_resume_t *f_async_resume,
3053 mbedtls_ssl_async_cancel_t *f_async_cancel,
Gilles Peskine449bd832023-01-11 14:50:10 +01003054 void *async_config_data)
Gilles Peskine8bf79f62018-01-05 21:11:53 +01003055{
3056 conf->f_async_sign_start = f_async_sign;
3057 conf->f_async_decrypt_start = f_async_decrypt;
3058 conf->f_async_resume = f_async_resume;
3059 conf->f_async_cancel = f_async_cancel;
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003060 conf->p_async_config_data = async_config_data;
3061}
3062
Gilles Peskine449bd832023-01-11 14:50:10 +01003063void *mbedtls_ssl_conf_get_async_config_data(const mbedtls_ssl_config *conf)
Gilles Peskine8f97af72018-04-26 11:46:10 +02003064{
Gilles Peskine449bd832023-01-11 14:50:10 +01003065 return conf->p_async_config_data;
Gilles Peskine8f97af72018-04-26 11:46:10 +02003066}
3067
Gilles Peskine449bd832023-01-11 14:50:10 +01003068void *mbedtls_ssl_get_async_operation_data(const mbedtls_ssl_context *ssl)
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003069{
Gilles Peskine449bd832023-01-11 14:50:10 +01003070 if (ssl->handshake == NULL) {
3071 return NULL;
3072 } else {
3073 return ssl->handshake->user_async_ctx;
3074 }
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003075}
3076
Gilles Peskine449bd832023-01-11 14:50:10 +01003077void mbedtls_ssl_set_async_operation_data(mbedtls_ssl_context *ssl,
3078 void *ctx)
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003079{
Gilles Peskine449bd832023-01-11 14:50:10 +01003080 if (ssl->handshake != NULL) {
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003081 ssl->handshake->user_async_ctx = ctx;
Gilles Peskine449bd832023-01-11 14:50:10 +01003082 }
Gilles Peskine8bf79f62018-01-05 21:11:53 +01003083}
Gilles Peskineb74a1c72018-04-24 13:09:22 +02003084#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
Gilles Peskine8bf79f62018-01-05 21:11:53 +01003085
Paul Bakker5121ce52009-01-03 21:22:43 +00003086/*
3087 * SSL get accessors
3088 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003089uint32_t mbedtls_ssl_get_verify_result(const mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00003090{
Gilles Peskine449bd832023-01-11 14:50:10 +01003091 if (ssl->session != NULL) {
3092 return ssl->session->verify_result;
3093 }
Manuel Pégourié-Gonnarde89163c2015-01-23 14:30:57 +00003094
Gilles Peskine449bd832023-01-11 14:50:10 +01003095 if (ssl->session_negotiate != NULL) {
3096 return ssl->session_negotiate->verify_result;
3097 }
Manuel Pégourié-Gonnarde89163c2015-01-23 14:30:57 +00003098
Gilles Peskine449bd832023-01-11 14:50:10 +01003099 return 0xFFFFFFFF;
Paul Bakker5121ce52009-01-03 21:22:43 +00003100}
3101
Gilles Peskine449bd832023-01-11 14:50:10 +01003102int mbedtls_ssl_get_ciphersuite_id_from_ssl(const mbedtls_ssl_context *ssl)
Glenn Strauss8f526902022-01-13 00:04:49 -05003103{
Gilles Peskine449bd832023-01-11 14:50:10 +01003104 if (ssl == NULL || ssl->session == NULL) {
3105 return 0;
3106 }
Glenn Strauss8f526902022-01-13 00:04:49 -05003107
Gilles Peskine449bd832023-01-11 14:50:10 +01003108 return ssl->session->ciphersuite;
Glenn Strauss8f526902022-01-13 00:04:49 -05003109}
3110
Gilles Peskine449bd832023-01-11 14:50:10 +01003111const char *mbedtls_ssl_get_ciphersuite(const mbedtls_ssl_context *ssl)
Paul Bakker72f62662011-01-16 21:27:44 +00003112{
Gilles Peskine449bd832023-01-11 14:50:10 +01003113 if (ssl == NULL || ssl->session == NULL) {
3114 return NULL;
3115 }
Paul Bakker926c8e42013-03-06 10:23:34 +01003116
Gilles Peskine449bd832023-01-11 14:50:10 +01003117 return mbedtls_ssl_get_ciphersuite_name(ssl->session->ciphersuite);
Paul Bakker72f62662011-01-16 21:27:44 +00003118}
3119
Gilles Peskine449bd832023-01-11 14:50:10 +01003120const char *mbedtls_ssl_get_version(const mbedtls_ssl_context *ssl)
Paul Bakker43ca69c2011-01-15 17:35:19 +00003121{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003122#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003123 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
3124 switch (ssl->tls_version) {
Glenn Strauss60bfe602022-03-14 19:04:24 -04003125 case MBEDTLS_SSL_VERSION_TLS1_2:
Gilles Peskine449bd832023-01-11 14:50:10 +01003126 return "DTLSv1.2";
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01003127 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01003128 return "unknown (DTLS)";
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01003129 }
3130 }
3131#endif
3132
Gilles Peskine449bd832023-01-11 14:50:10 +01003133 switch (ssl->tls_version) {
Glenn Strauss60bfe602022-03-14 19:04:24 -04003134 case MBEDTLS_SSL_VERSION_TLS1_2:
Gilles Peskine449bd832023-01-11 14:50:10 +01003135 return "TLSv1.2";
Glenn Strauss60bfe602022-03-14 19:04:24 -04003136 case MBEDTLS_SSL_VERSION_TLS1_3:
Gilles Peskine449bd832023-01-11 14:50:10 +01003137 return "TLSv1.3";
Paul Bakker43ca69c2011-01-15 17:35:19 +00003138 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01003139 return "unknown";
Paul Bakker43ca69c2011-01-15 17:35:19 +00003140 }
Paul Bakker43ca69c2011-01-15 17:35:19 +00003141}
3142
Waleed Elmelegy6a971fd2023-12-28 17:48:16 +00003143#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
3144
3145size_t mbedtls_ssl_get_output_record_size_limit(const mbedtls_ssl_context *ssl)
3146{
3147 const size_t max_len = MBEDTLS_SSL_OUT_CONTENT_LEN;
3148 size_t record_size_limit = max_len;
3149
3150 if (ssl->session != NULL &&
3151 ssl->session->record_size_limit >= MBEDTLS_SSL_RECORD_SIZE_LIMIT_MIN &&
3152 ssl->session->record_size_limit < max_len) {
3153 record_size_limit = ssl->session->record_size_limit;
3154 }
3155
3156 // TODO: this is currently untested
3157 /* During a handshake, use the value being negotiated */
3158 if (ssl->session_negotiate != NULL &&
3159 ssl->session_negotiate->record_size_limit >= MBEDTLS_SSL_RECORD_SIZE_LIMIT_MIN &&
3160 ssl->session_negotiate->record_size_limit < max_len) {
3161 record_size_limit = ssl->session_negotiate->record_size_limit;
3162 }
3163
3164 return record_size_limit;
3165}
3166#endif /* MBEDTLS_SSL_RECORD_SIZE_LIMIT */
3167
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02003168#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01003169size_t mbedtls_ssl_get_input_max_frag_len(const mbedtls_ssl_context *ssl)
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003170{
David Horstmann95d516f2021-05-04 18:36:56 +01003171 size_t max_len = MBEDTLS_SSL_IN_CONTENT_LEN;
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003172 size_t read_mfl;
3173
Jerry Yuddda0502022-12-01 19:43:12 +08003174#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003175 /* Use the configured MFL for the client if we're past SERVER_HELLO_DONE */
Gilles Peskine449bd832023-01-11 14:50:10 +01003176 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
3177 ssl->state >= MBEDTLS_SSL_SERVER_HELLO_DONE) {
3178 return ssl_mfl_code_to_length(ssl->conf->mfl_code);
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003179 }
Jerry Yuddda0502022-12-01 19:43:12 +08003180#endif
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003181
3182 /* Check if a smaller max length was negotiated */
Gilles Peskine449bd832023-01-11 14:50:10 +01003183 if (ssl->session_out != NULL) {
3184 read_mfl = ssl_mfl_code_to_length(ssl->session_out->mfl_code);
3185 if (read_mfl < max_len) {
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003186 max_len = read_mfl;
3187 }
3188 }
3189
Jerry Yuddda0502022-12-01 19:43:12 +08003190 /* During a handshake, use the value being negotiated */
Gilles Peskine449bd832023-01-11 14:50:10 +01003191 if (ssl->session_negotiate != NULL) {
3192 read_mfl = ssl_mfl_code_to_length(ssl->session_negotiate->mfl_code);
3193 if (read_mfl < max_len) {
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003194 max_len = read_mfl;
3195 }
3196 }
3197
Gilles Peskine449bd832023-01-11 14:50:10 +01003198 return max_len;
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003199}
3200
Gilles Peskine449bd832023-01-11 14:50:10 +01003201size_t mbedtls_ssl_get_output_max_frag_len(const mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02003202{
3203 size_t max_len;
3204
3205 /*
3206 * Assume mfl_code is correct since it was checked when set
3207 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003208 max_len = ssl_mfl_code_to_length(ssl->conf->mfl_code);
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02003209
Manuel Pégourié-Gonnard2cb17e22017-09-19 13:00:47 +02003210 /* Check if a smaller max length was negotiated */
Gilles Peskine449bd832023-01-11 14:50:10 +01003211 if (ssl->session_out != NULL &&
3212 ssl_mfl_code_to_length(ssl->session_out->mfl_code) < max_len) {
3213 max_len = ssl_mfl_code_to_length(ssl->session_out->mfl_code);
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02003214 }
3215
Manuel Pégourié-Gonnard2cb17e22017-09-19 13:00:47 +02003216 /* During a handshake, use the value being negotiated */
Gilles Peskine449bd832023-01-11 14:50:10 +01003217 if (ssl->session_negotiate != NULL &&
3218 ssl_mfl_code_to_length(ssl->session_negotiate->mfl_code) < max_len) {
3219 max_len = ssl_mfl_code_to_length(ssl->session_negotiate->mfl_code);
Manuel Pégourié-Gonnard2cb17e22017-09-19 13:00:47 +02003220 }
3221
Gilles Peskine449bd832023-01-11 14:50:10 +01003222 return max_len;
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02003223}
3224#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
3225
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003226#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003227size_t mbedtls_ssl_get_current_mtu(const mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003228{
Andrzej Kurekef43ce62018-10-09 08:24:12 -04003229 /* Return unlimited mtu for client hello messages to avoid fragmentation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01003230 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
3231 (ssl->state == MBEDTLS_SSL_CLIENT_HELLO ||
3232 ssl->state == MBEDTLS_SSL_SERVER_HELLO)) {
3233 return 0;
3234 }
Andrzej Kurekef43ce62018-10-09 08:24:12 -04003235
Gilles Peskine449bd832023-01-11 14:50:10 +01003236 if (ssl->handshake == NULL || ssl->handshake->mtu == 0) {
3237 return ssl->mtu;
3238 }
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003239
Gilles Peskine449bd832023-01-11 14:50:10 +01003240 if (ssl->mtu == 0) {
3241 return ssl->handshake->mtu;
3242 }
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003243
Gilles Peskine449bd832023-01-11 14:50:10 +01003244 return ssl->mtu < ssl->handshake->mtu ?
3245 ssl->mtu : ssl->handshake->mtu;
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003246}
3247#endif /* MBEDTLS_SSL_PROTO_DTLS */
3248
Gilles Peskine449bd832023-01-11 14:50:10 +01003249int mbedtls_ssl_get_max_out_record_payload(const mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003250{
3251 size_t max_len = MBEDTLS_SSL_OUT_CONTENT_LEN;
3252
Manuel Pégourié-Gonnard000281e2018-08-21 11:20:58 +02003253#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH) && \
Jan Brucknerf482dcc2023-03-15 09:09:06 +01003254 !defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT) && \
Manuel Pégourié-Gonnard000281e2018-08-21 11:20:58 +02003255 !defined(MBEDTLS_SSL_PROTO_DTLS)
3256 (void) ssl;
3257#endif
3258
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003259#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01003260 const size_t mfl = mbedtls_ssl_get_output_max_frag_len(ssl);
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003261
Gilles Peskine449bd832023-01-11 14:50:10 +01003262 if (max_len > mfl) {
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003263 max_len = mfl;
Gilles Peskine449bd832023-01-11 14:50:10 +01003264 }
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003265#endif
3266
Jan Brucknerf482dcc2023-03-15 09:09:06 +01003267#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
3268 const size_t record_size_limit = mbedtls_ssl_get_output_record_size_limit(ssl);
3269
3270 if (max_len > record_size_limit) {
3271 max_len = record_size_limit;
3272 }
3273#endif
3274
Waleed Elmelegy6a971fd2023-12-28 17:48:16 +00003275 if (ssl->transform_out != NULL &&
3276 ssl->transform_out->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Waleed Elmelegyf5017902024-01-09 14:18:34 +00003277 /*
3278 * In TLS 1.3 case, when records are protected, `max_len` as computed
3279 * above is the maximum length of the TLSInnerPlaintext structure that
3280 * along the plaintext payload contains the inner content type (one byte)
3281 * and some zero padding. Given the algorithm used for padding
3282 * in mbedtls_ssl_encrypt_buf(), compute the maximum length for
3283 * the plaintext payload. Round down to a multiple of
3284 * MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY and
3285 * subtract 1.
Waleed Elmelegy6a971fd2023-12-28 17:48:16 +00003286 */
3287 max_len = ((max_len / MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY) *
3288 MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY) - 1;
3289 }
3290
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003291#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003292 if (mbedtls_ssl_get_current_mtu(ssl) != 0) {
3293 const size_t mtu = mbedtls_ssl_get_current_mtu(ssl);
3294 const int ret = mbedtls_ssl_get_record_expansion(ssl);
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003295 const size_t overhead = (size_t) ret;
3296
Gilles Peskine449bd832023-01-11 14:50:10 +01003297 if (ret < 0) {
3298 return ret;
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003299 }
3300
Gilles Peskine449bd832023-01-11 14:50:10 +01003301 if (mtu <= overhead) {
3302 MBEDTLS_SSL_DEBUG_MSG(1, ("MTU too low for record expansion"));
3303 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
3304 }
3305
3306 if (max_len > mtu - overhead) {
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003307 max_len = mtu - overhead;
Gilles Peskine449bd832023-01-11 14:50:10 +01003308 }
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003309 }
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003310#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003311
Hanno Becker0defedb2018-08-10 12:35:02 +01003312#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH) && \
Waleed Elmelegy049cd302023-12-20 17:28:31 +00003313 !defined(MBEDTLS_SSL_PROTO_DTLS) && \
3314 !defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
Hanno Becker0defedb2018-08-10 12:35:02 +01003315 ((void) ssl);
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003316#endif
3317
Gilles Peskine449bd832023-01-11 14:50:10 +01003318 return (int) max_len;
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003319}
3320
Gilles Peskine449bd832023-01-11 14:50:10 +01003321int mbedtls_ssl_get_max_in_record_payload(const mbedtls_ssl_context *ssl)
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003322{
3323 size_t max_len = MBEDTLS_SSL_IN_CONTENT_LEN;
3324
3325#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
3326 (void) ssl;
3327#endif
3328
3329#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01003330 const size_t mfl = mbedtls_ssl_get_input_max_frag_len(ssl);
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003331
Gilles Peskine449bd832023-01-11 14:50:10 +01003332 if (max_len > mfl) {
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003333 max_len = mfl;
Gilles Peskine449bd832023-01-11 14:50:10 +01003334 }
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003335#endif
3336
Gilles Peskine449bd832023-01-11 14:50:10 +01003337 return (int) max_len;
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003338}
3339
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003340#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01003341const mbedtls_x509_crt *mbedtls_ssl_get_peer_cert(const mbedtls_ssl_context *ssl)
Paul Bakkerb0550d92012-10-30 07:51:03 +00003342{
Gilles Peskine449bd832023-01-11 14:50:10 +01003343 if (ssl == NULL || ssl->session == NULL) {
3344 return NULL;
3345 }
Paul Bakkerb0550d92012-10-30 07:51:03 +00003346
Hanno Beckere6824572019-02-07 13:18:46 +00003347#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01003348 return ssl->session->peer_cert;
Hanno Beckere6824572019-02-07 13:18:46 +00003349#else
Gilles Peskine449bd832023-01-11 14:50:10 +01003350 return NULL;
Hanno Beckere6824572019-02-07 13:18:46 +00003351#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Paul Bakkerb0550d92012-10-30 07:51:03 +00003352}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003353#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkerb0550d92012-10-30 07:51:03 +00003354
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003355#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01003356int mbedtls_ssl_get_session(const mbedtls_ssl_context *ssl,
3357 mbedtls_ssl_session *dst)
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003358{
Hanno Beckere810bbc2021-05-14 16:01:05 +01003359 int ret;
3360
Gilles Peskine449bd832023-01-11 14:50:10 +01003361 if (ssl == NULL ||
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003362 dst == NULL ||
3363 ssl->session == NULL ||
Gilles Peskine449bd832023-01-11 14:50:10 +01003364 ssl->conf->endpoint != MBEDTLS_SSL_IS_CLIENT) {
3365 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003366 }
3367
Hanno Beckere810bbc2021-05-14 16:01:05 +01003368 /* Since Mbed TLS 3.0, mbedtls_ssl_get_session() is no longer
3369 * idempotent: Each session can only be exported once.
3370 *
3371 * (This is in preparation for TLS 1.3 support where we will
3372 * need the ability to export multiple sessions (aka tickets),
3373 * which will be achieved by calling mbedtls_ssl_get_session()
3374 * multiple times until it fails.)
3375 *
3376 * Check whether we have already exported the current session,
3377 * and fail if so.
3378 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003379 if (ssl->session->exported == 1) {
3380 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
3381 }
Hanno Beckere810bbc2021-05-14 16:01:05 +01003382
Gilles Peskine449bd832023-01-11 14:50:10 +01003383 ret = mbedtls_ssl_session_copy(dst, ssl->session);
3384 if (ret != 0) {
3385 return ret;
3386 }
Hanno Beckere810bbc2021-05-14 16:01:05 +01003387
3388 /* Remember that we've exported the session. */
3389 ssl->session->exported = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01003390 return 0;
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003391}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003392#endif /* MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003393
David Horstmanncb01b362024-02-29 17:31:46 +00003394#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
3395
3396/* Serialization of TLS 1.2 sessions
David Horstmanne59f9702024-02-29 16:08:57 +00003397 *
David Horstmanncb01b362024-02-29 17:31:46 +00003398 * For more detail, see the description of ssl_session_save().
David Horstmanne59f9702024-02-29 16:08:57 +00003399 */
3400static size_t ssl_tls12_session_save(const mbedtls_ssl_session *session,
3401 unsigned char *buf,
3402 size_t buf_len)
3403{
3404 unsigned char *p = buf;
3405 size_t used = 0;
3406
3407#if defined(MBEDTLS_HAVE_TIME)
3408 uint64_t start;
3409#endif
3410#if defined(MBEDTLS_X509_CRT_PARSE_C)
3411#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
3412 size_t cert_len;
3413#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3414#endif /* MBEDTLS_X509_CRT_PARSE_C */
3415
3416 /*
3417 * Time
3418 */
3419#if defined(MBEDTLS_HAVE_TIME)
3420 used += 8;
3421
3422 if (used <= buf_len) {
3423 start = (uint64_t) session->start;
3424
3425 MBEDTLS_PUT_UINT64_BE(start, p, 0);
3426 p += 8;
3427 }
3428#endif /* MBEDTLS_HAVE_TIME */
3429
3430 /*
3431 * Basic mandatory fields
3432 */
3433 used += 1 /* id_len */
3434 + sizeof(session->id)
3435 + sizeof(session->master)
3436 + 4; /* verify_result */
3437
3438 if (used <= buf_len) {
3439 *p++ = MBEDTLS_BYTE_0(session->id_len);
3440 memcpy(p, session->id, 32);
3441 p += 32;
3442
3443 memcpy(p, session->master, 48);
3444 p += 48;
3445
3446 MBEDTLS_PUT_UINT32_BE(session->verify_result, p, 0);
3447 p += 4;
3448 }
3449
3450 /*
3451 * Peer's end-entity certificate
3452 */
3453#if defined(MBEDTLS_X509_CRT_PARSE_C)
3454#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
3455 if (session->peer_cert == NULL) {
3456 cert_len = 0;
3457 } else {
3458 cert_len = session->peer_cert->raw.len;
3459 }
3460
3461 used += 3 + cert_len;
3462
3463 if (used <= buf_len) {
3464 *p++ = MBEDTLS_BYTE_2(cert_len);
3465 *p++ = MBEDTLS_BYTE_1(cert_len);
3466 *p++ = MBEDTLS_BYTE_0(cert_len);
3467
3468 if (session->peer_cert != NULL) {
3469 memcpy(p, session->peer_cert->raw.p, cert_len);
3470 p += cert_len;
3471 }
3472 }
3473#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3474 if (session->peer_cert_digest != NULL) {
3475 used += 1 /* type */ + 1 /* length */ + session->peer_cert_digest_len;
3476 if (used <= buf_len) {
3477 *p++ = (unsigned char) session->peer_cert_digest_type;
3478 *p++ = (unsigned char) session->peer_cert_digest_len;
3479 memcpy(p, session->peer_cert_digest,
3480 session->peer_cert_digest_len);
3481 p += session->peer_cert_digest_len;
3482 }
3483 } else {
3484 used += 2;
3485 if (used <= buf_len) {
3486 *p++ = (unsigned char) MBEDTLS_MD_NONE;
3487 *p++ = 0;
3488 }
3489 }
3490#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3491#endif /* MBEDTLS_X509_CRT_PARSE_C */
3492
3493 /*
3494 * Session ticket if any, plus associated data
3495 */
3496#if defined(MBEDTLS_SSL_SESSION_TICKETS)
3497#if defined(MBEDTLS_SSL_CLI_C)
3498 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
3499 used += 3 + session->ticket_len + 4; /* len + ticket + lifetime */
3500
3501 if (used <= buf_len) {
3502 *p++ = MBEDTLS_BYTE_2(session->ticket_len);
3503 *p++ = MBEDTLS_BYTE_1(session->ticket_len);
3504 *p++ = MBEDTLS_BYTE_0(session->ticket_len);
3505
3506 if (session->ticket != NULL) {
3507 memcpy(p, session->ticket, session->ticket_len);
3508 p += session->ticket_len;
3509 }
3510
3511 MBEDTLS_PUT_UINT32_BE(session->ticket_lifetime, p, 0);
3512 p += 4;
3513 }
3514 }
3515#endif /* MBEDTLS_SSL_CLI_C */
3516#if defined(MBEDTLS_HAVE_TIME) && defined(MBEDTLS_SSL_SRV_C)
3517 if (session->endpoint == MBEDTLS_SSL_IS_SERVER) {
3518 used += 8;
3519
3520 if (used <= buf_len) {
3521 MBEDTLS_PUT_UINT64_BE((uint64_t) session->ticket_creation_time, p, 0);
3522 p += 8;
3523 }
3524 }
3525#endif /* MBEDTLS_HAVE_TIME && MBEDTLS_SSL_SRV_C */
3526#endif /* MBEDTLS_SSL_SESSION_TICKETS */
3527
3528 /*
3529 * Misc extension-related info
3530 */
3531#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
3532 used += 1;
3533
3534 if (used <= buf_len) {
3535 *p++ = session->mfl_code;
3536 }
3537#endif
3538
3539#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
3540 used += 1;
3541
3542 if (used <= buf_len) {
3543 *p++ = MBEDTLS_BYTE_0(session->encrypt_then_mac);
3544 }
3545#endif
3546
3547 return used;
3548}
3549
3550MBEDTLS_CHECK_RETURN_CRITICAL
3551static int ssl_tls12_session_load(mbedtls_ssl_session *session,
3552 const unsigned char *buf,
3553 size_t len)
3554{
3555#if defined(MBEDTLS_HAVE_TIME)
3556 uint64_t start;
3557#endif
3558#if defined(MBEDTLS_X509_CRT_PARSE_C)
3559#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
3560 size_t cert_len;
3561#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3562#endif /* MBEDTLS_X509_CRT_PARSE_C */
3563
3564 const unsigned char *p = buf;
3565 const unsigned char * const end = buf + len;
3566
3567 /*
3568 * Time
3569 */
3570#if defined(MBEDTLS_HAVE_TIME)
3571 if (8 > (size_t) (end - p)) {
3572 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3573 }
3574
3575 start = MBEDTLS_GET_UINT64_BE(p, 0);
3576 p += 8;
3577
3578 session->start = (time_t) start;
3579#endif /* MBEDTLS_HAVE_TIME */
3580
3581 /*
3582 * Basic mandatory fields
3583 */
3584 if (1 + 32 + 48 + 4 > (size_t) (end - p)) {
3585 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3586 }
3587
3588 session->id_len = *p++;
3589 memcpy(session->id, p, 32);
3590 p += 32;
3591
3592 memcpy(session->master, p, 48);
3593 p += 48;
3594
3595 session->verify_result = MBEDTLS_GET_UINT32_BE(p, 0);
3596 p += 4;
3597
3598 /* Immediately clear invalid pointer values that have been read, in case
3599 * we exit early before we replaced them with valid ones. */
3600#if defined(MBEDTLS_X509_CRT_PARSE_C)
3601#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
3602 session->peer_cert = NULL;
3603#else
3604 session->peer_cert_digest = NULL;
3605#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3606#endif /* MBEDTLS_X509_CRT_PARSE_C */
3607#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
3608 session->ticket = NULL;
3609#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
3610
3611 /*
3612 * Peer certificate
3613 */
3614#if defined(MBEDTLS_X509_CRT_PARSE_C)
3615#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
3616 /* Deserialize CRT from the end of the ticket. */
3617 if (3 > (size_t) (end - p)) {
3618 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3619 }
3620
3621 cert_len = MBEDTLS_GET_UINT24_BE(p, 0);
3622 p += 3;
3623
3624 if (cert_len != 0) {
3625 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
3626
3627 if (cert_len > (size_t) (end - p)) {
3628 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3629 }
3630
3631 session->peer_cert = mbedtls_calloc(1, sizeof(mbedtls_x509_crt));
3632
3633 if (session->peer_cert == NULL) {
3634 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
3635 }
3636
3637 mbedtls_x509_crt_init(session->peer_cert);
3638
3639 if ((ret = mbedtls_x509_crt_parse_der(session->peer_cert,
3640 p, cert_len)) != 0) {
3641 mbedtls_x509_crt_free(session->peer_cert);
3642 mbedtls_free(session->peer_cert);
3643 session->peer_cert = NULL;
3644 return ret;
3645 }
3646
3647 p += cert_len;
3648 }
3649#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3650 /* Deserialize CRT digest from the end of the ticket. */
3651 if (2 > (size_t) (end - p)) {
3652 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3653 }
3654
3655 session->peer_cert_digest_type = (mbedtls_md_type_t) *p++;
3656 session->peer_cert_digest_len = (size_t) *p++;
3657
3658 if (session->peer_cert_digest_len != 0) {
3659 const mbedtls_md_info_t *md_info =
3660 mbedtls_md_info_from_type(session->peer_cert_digest_type);
3661 if (md_info == NULL) {
3662 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3663 }
3664 if (session->peer_cert_digest_len != mbedtls_md_get_size(md_info)) {
3665 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3666 }
3667
3668 if (session->peer_cert_digest_len > (size_t) (end - p)) {
3669 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3670 }
3671
3672 session->peer_cert_digest =
3673 mbedtls_calloc(1, session->peer_cert_digest_len);
3674 if (session->peer_cert_digest == NULL) {
3675 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
3676 }
3677
3678 memcpy(session->peer_cert_digest, p,
3679 session->peer_cert_digest_len);
3680 p += session->peer_cert_digest_len;
3681 }
3682#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3683#endif /* MBEDTLS_X509_CRT_PARSE_C */
3684
3685 /*
3686 * Session ticket and associated data
3687 */
3688#if defined(MBEDTLS_SSL_SESSION_TICKETS)
3689#if defined(MBEDTLS_SSL_CLI_C)
3690 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
3691 if (3 > (size_t) (end - p)) {
3692 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3693 }
3694
3695 session->ticket_len = MBEDTLS_GET_UINT24_BE(p, 0);
3696 p += 3;
3697
3698 if (session->ticket_len != 0) {
3699 if (session->ticket_len > (size_t) (end - p)) {
3700 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3701 }
3702
3703 session->ticket = mbedtls_calloc(1, session->ticket_len);
3704 if (session->ticket == NULL) {
3705 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
3706 }
3707
3708 memcpy(session->ticket, p, session->ticket_len);
3709 p += session->ticket_len;
3710 }
3711
3712 if (4 > (size_t) (end - p)) {
3713 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3714 }
3715
3716 session->ticket_lifetime = MBEDTLS_GET_UINT32_BE(p, 0);
3717 p += 4;
3718 }
3719#endif /* MBEDTLS_SSL_CLI_C */
3720#if defined(MBEDTLS_HAVE_TIME) && defined(MBEDTLS_SSL_SRV_C)
3721 if (session->endpoint == MBEDTLS_SSL_IS_SERVER) {
3722 if (8 > (size_t) (end - p)) {
3723 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3724 }
3725 session->ticket_creation_time = MBEDTLS_GET_UINT64_BE(p, 0);
3726 p += 8;
3727 }
3728#endif /* MBEDTLS_HAVE_TIME && MBEDTLS_SSL_SRV_C */
3729#endif /* MBEDTLS_SSL_SESSION_TICKETS */
3730
3731 /*
3732 * Misc extension-related info
3733 */
3734#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
3735 if (1 > (size_t) (end - p)) {
3736 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3737 }
3738
3739 session->mfl_code = *p++;
3740#endif
3741
3742#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
3743 if (1 > (size_t) (end - p)) {
3744 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3745 }
3746
3747 session->encrypt_then_mac = *p++;
3748#endif
3749
3750 /* Done, should have consumed entire buffer */
3751 if (p != end) {
3752 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3753 }
3754
3755 return 0;
3756}
3757
3758#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
3759
3760#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
3761/* Serialization of TLS 1.3 sessions:
3762 *
David Horstmanncb01b362024-02-29 17:31:46 +00003763 * For more detail, see the description of ssl_session_save().
David Horstmanne59f9702024-02-29 16:08:57 +00003764 */
3765#if defined(MBEDTLS_SSL_SESSION_TICKETS)
3766MBEDTLS_CHECK_RETURN_CRITICAL
3767static int ssl_tls13_session_save(const mbedtls_ssl_session *session,
3768 unsigned char *buf,
3769 size_t buf_len,
3770 size_t *olen)
3771{
3772 unsigned char *p = buf;
3773#if defined(MBEDTLS_SSL_CLI_C) && \
3774 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
3775 size_t hostname_len = (session->hostname == NULL) ?
3776 0 : strlen(session->hostname) + 1;
3777#endif
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003778
3779#if defined(MBEDTLS_SSL_SRV_C) && \
3780 defined(MBEDTLS_SSL_EARLY_DATA) && defined(MBEDTLS_SSL_ALPN)
Waleed Elmelegydaa4da72024-03-13 16:25:34 +00003781 const size_t alpn_len = (session->ticket_alpn == NULL) ?
Waleed Elmelegyb28ab0a2024-03-13 16:48:28 +00003782 0 : strlen(session->ticket_alpn) + 1;
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003783#endif
David Horstmanne59f9702024-02-29 16:08:57 +00003784 size_t needed = 4 /* ticket_age_add */
3785 + 1 /* ticket_flags */
3786 + 1; /* resumption_key length */
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003787
David Horstmanne59f9702024-02-29 16:08:57 +00003788 *olen = 0;
3789
3790 if (session->resumption_key_len > MBEDTLS_SSL_TLS1_3_TICKET_RESUMPTION_KEY_LEN) {
3791 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3792 }
3793 needed += session->resumption_key_len; /* resumption_key */
3794
3795#if defined(MBEDTLS_SSL_EARLY_DATA)
3796 needed += 4; /* max_early_data_size */
3797#endif
3798#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
3799 needed += 2; /* record_size_limit */
3800#endif /* MBEDTLS_SSL_RECORD_SIZE_LIMIT */
3801
3802#if defined(MBEDTLS_HAVE_TIME)
3803 needed += 8; /* ticket_creation_time or ticket_reception_time */
3804#endif
3805
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003806#if defined(MBEDTLS_SSL_SRV_C)
3807 if (session->endpoint == MBEDTLS_SSL_IS_SERVER) {
3808#if defined(MBEDTLS_SSL_EARLY_DATA) && defined(MBEDTLS_SSL_ALPN)
Waleed Elmelegydaa4da72024-03-13 16:25:34 +00003809 needed += 2 /* alpn_len */
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003810 + alpn_len; /* alpn */
3811#endif
3812 }
3813#endif /* MBEDTLS_SSL_SRV_C */
3814
David Horstmanne59f9702024-02-29 16:08:57 +00003815#if defined(MBEDTLS_SSL_CLI_C)
3816 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
3817#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
3818 needed += 2 /* hostname_len */
3819 + hostname_len; /* hostname */
3820#endif
3821
3822 needed += 4 /* ticket_lifetime */
3823 + 2; /* ticket_len */
3824
3825 /* Check size_t overflow */
3826 if (session->ticket_len > SIZE_MAX - needed) {
3827 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3828 }
3829
3830 needed += session->ticket_len; /* ticket */
3831 }
3832#endif /* MBEDTLS_SSL_CLI_C */
3833
3834 *olen = needed;
3835 if (needed > buf_len) {
3836 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
3837 }
3838
3839 MBEDTLS_PUT_UINT32_BE(session->ticket_age_add, p, 0);
3840 p[4] = session->ticket_flags;
3841
3842 /* save resumption_key */
3843 p[5] = session->resumption_key_len;
3844 p += 6;
3845 memcpy(p, session->resumption_key, session->resumption_key_len);
3846 p += session->resumption_key_len;
3847
3848#if defined(MBEDTLS_SSL_EARLY_DATA)
3849 MBEDTLS_PUT_UINT32_BE(session->max_early_data_size, p, 0);
3850 p += 4;
3851#endif
3852#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
3853 MBEDTLS_PUT_UINT16_BE(session->record_size_limit, p, 0);
3854 p += 2;
3855#endif /* MBEDTLS_SSL_RECORD_SIZE_LIMIT */
3856
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003857#if defined(MBEDTLS_SSL_SRV_C)
David Horstmanne59f9702024-02-29 16:08:57 +00003858 if (session->endpoint == MBEDTLS_SSL_IS_SERVER) {
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003859#if defined(MBEDTLS_HAVE_TIME)
David Horstmanne59f9702024-02-29 16:08:57 +00003860 MBEDTLS_PUT_UINT64_BE((uint64_t) session->ticket_creation_time, p, 0);
3861 p += 8;
David Horstmanne59f9702024-02-29 16:08:57 +00003862#endif /* MBEDTLS_HAVE_TIME */
3863
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003864#if defined(MBEDTLS_SSL_EARLY_DATA) && defined(MBEDTLS_SSL_ALPN)
Waleed Elmelegydaa4da72024-03-13 16:25:34 +00003865 MBEDTLS_PUT_UINT16_BE(alpn_len, p, 0);
3866 p += 2;
3867
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003868 if (alpn_len > 0) {
3869 /* save chosen alpn */
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00003870 memcpy(p, session->ticket_alpn, alpn_len);
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003871 p += alpn_len;
3872 }
3873#endif /* MBEDTLS_SSL_EARLY_DATA && MBEDTLS_SSL_ALPN */
3874 }
3875#endif /* MBEDTLS_SSL_SRV_C */
3876
David Horstmanne59f9702024-02-29 16:08:57 +00003877#if defined(MBEDTLS_SSL_CLI_C)
3878 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
3879#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
3880 MBEDTLS_PUT_UINT16_BE(hostname_len, p, 0);
3881 p += 2;
3882 if (hostname_len > 0) {
3883 /* save host name */
3884 memcpy(p, session->hostname, hostname_len);
3885 p += hostname_len;
3886 }
3887#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
3888
3889#if defined(MBEDTLS_HAVE_TIME)
3890 MBEDTLS_PUT_UINT64_BE((uint64_t) session->ticket_reception_time, p, 0);
3891 p += 8;
3892#endif
3893 MBEDTLS_PUT_UINT32_BE(session->ticket_lifetime, p, 0);
3894 p += 4;
3895
3896 MBEDTLS_PUT_UINT16_BE(session->ticket_len, p, 0);
3897 p += 2;
3898
3899 if (session->ticket != NULL && session->ticket_len > 0) {
3900 memcpy(p, session->ticket, session->ticket_len);
3901 p += session->ticket_len;
3902 }
3903 }
3904#endif /* MBEDTLS_SSL_CLI_C */
3905 return 0;
3906}
3907
3908MBEDTLS_CHECK_RETURN_CRITICAL
3909static int ssl_tls13_session_load(mbedtls_ssl_session *session,
3910 const unsigned char *buf,
3911 size_t len)
3912{
3913 const unsigned char *p = buf;
3914 const unsigned char *end = buf + len;
3915
3916 if (end - p < 6) {
3917 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3918 }
3919 session->ticket_age_add = MBEDTLS_GET_UINT32_BE(p, 0);
3920 session->ticket_flags = p[4];
3921
3922 /* load resumption_key */
3923 session->resumption_key_len = p[5];
3924 p += 6;
3925
3926 if (end - p < session->resumption_key_len) {
3927 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3928 }
3929
3930 if (sizeof(session->resumption_key) < session->resumption_key_len) {
3931 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3932 }
3933 memcpy(session->resumption_key, p, session->resumption_key_len);
3934 p += session->resumption_key_len;
3935
3936#if defined(MBEDTLS_SSL_EARLY_DATA)
3937 if (end - p < 4) {
3938 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3939 }
3940 session->max_early_data_size = MBEDTLS_GET_UINT32_BE(p, 0);
3941 p += 4;
3942#endif
3943#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
3944 if (end - p < 2) {
3945 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3946 }
3947 session->record_size_limit = MBEDTLS_GET_UINT16_BE(p, 0);
3948 p += 2;
3949#endif /* MBEDTLS_SSL_RECORD_SIZE_LIMIT */
3950
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003951#if defined(MBEDTLS_SSL_SRV_C)
David Horstmanne59f9702024-02-29 16:08:57 +00003952 if (session->endpoint == MBEDTLS_SSL_IS_SERVER) {
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003953#if defined(MBEDTLS_HAVE_TIME)
David Horstmanne59f9702024-02-29 16:08:57 +00003954 if (end - p < 8) {
3955 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3956 }
3957 session->ticket_creation_time = MBEDTLS_GET_UINT64_BE(p, 0);
3958 p += 8;
David Horstmanne59f9702024-02-29 16:08:57 +00003959#endif /* MBEDTLS_HAVE_TIME */
3960
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003961#if defined(MBEDTLS_SSL_EARLY_DATA) && defined(MBEDTLS_SSL_ALPN)
Waleed Elmelegydaa4da72024-03-13 16:25:34 +00003962 size_t alpn_len;
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003963
Waleed Elmelegydaa4da72024-03-13 16:25:34 +00003964 if (end - p < 2) {
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003965 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3966 }
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00003967
Waleed Elmelegydaa4da72024-03-13 16:25:34 +00003968 alpn_len = MBEDTLS_GET_UINT16_BE(p, 0);
3969 p += 2;
3970
3971 if (end - p < (long int) alpn_len) {
Waleed Elmelegy7dfba342024-03-12 16:22:39 +00003972 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3973 }
3974
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003975 if (alpn_len > 0) {
Waleed Elmelegydaa4da72024-03-13 16:25:34 +00003976 int ret = mbedtls_ssl_session_set_ticket_alpn(session, (char *) p);
3977 if (ret != 0) {
3978 return ret;
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003979 }
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003980 p += alpn_len;
3981 }
3982#endif /* MBEDTLS_SSL_EARLY_DATA && MBEDTLS_SSL_ALPN */
3983 }
3984#endif /* MBEDTLS_SSL_SRV_C */
3985
David Horstmanne59f9702024-02-29 16:08:57 +00003986#if defined(MBEDTLS_SSL_CLI_C)
3987 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
3988#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
3989 size_t hostname_len;
3990 /* load host name */
3991 if (end - p < 2) {
3992 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3993 }
3994 hostname_len = MBEDTLS_GET_UINT16_BE(p, 0);
3995 p += 2;
3996
3997 if (end - p < (long int) hostname_len) {
3998 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3999 }
4000 if (hostname_len > 0) {
4001 session->hostname = mbedtls_calloc(1, hostname_len);
4002 if (session->hostname == NULL) {
4003 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
4004 }
4005 memcpy(session->hostname, p, hostname_len);
4006 p += hostname_len;
4007 }
4008#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
4009
4010#if defined(MBEDTLS_HAVE_TIME)
4011 if (end - p < 8) {
4012 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4013 }
4014 session->ticket_reception_time = MBEDTLS_GET_UINT64_BE(p, 0);
4015 p += 8;
4016#endif
4017 if (end - p < 4) {
4018 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4019 }
4020 session->ticket_lifetime = MBEDTLS_GET_UINT32_BE(p, 0);
4021 p += 4;
4022
4023 if (end - p < 2) {
4024 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4025 }
4026 session->ticket_len = MBEDTLS_GET_UINT16_BE(p, 0);
4027 p += 2;
4028
4029 if (end - p < (long int) session->ticket_len) {
4030 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4031 }
4032 if (session->ticket_len > 0) {
4033 session->ticket = mbedtls_calloc(1, session->ticket_len);
4034 if (session->ticket == NULL) {
4035 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
4036 }
4037 memcpy(session->ticket, p, session->ticket_len);
4038 p += session->ticket_len;
4039 }
4040 }
4041#endif /* MBEDTLS_SSL_CLI_C */
4042
4043 return 0;
4044
4045}
4046#else /* MBEDTLS_SSL_SESSION_TICKETS */
4047MBEDTLS_CHECK_RETURN_CRITICAL
4048static int ssl_tls13_session_save(const mbedtls_ssl_session *session,
4049 unsigned char *buf,
4050 size_t buf_len,
4051 size_t *olen)
4052{
4053 ((void) session);
4054 ((void) buf);
4055 ((void) buf_len);
4056 *olen = 0;
4057 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
4058}
4059
4060static int ssl_tls13_session_load(const mbedtls_ssl_session *session,
Norbert Fabritiusd36913a2023-01-24 17:48:29 +01004061 const unsigned char *buf,
David Horstmanne59f9702024-02-29 16:08:57 +00004062 size_t buf_len)
4063{
4064 ((void) session);
4065 ((void) buf);
4066 ((void) buf_len);
4067 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
4068}
4069#endif /* !MBEDTLS_SSL_SESSION_TICKETS */
4070#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
4071
Paul Bakker5121ce52009-01-03 21:22:43 +00004072/*
Hanno Beckera835da52019-05-16 12:39:07 +01004073 * Define ticket header determining Mbed TLS version
4074 * and structure of the ticket.
4075 */
4076
Hanno Becker94ef3b32019-05-16 12:50:45 +01004077/*
Hanno Becker50b59662019-05-28 14:30:45 +01004078 * Define bitflag determining compile-time settings influencing
4079 * structure of serialized SSL sessions.
Hanno Becker94ef3b32019-05-16 12:50:45 +01004080 */
4081
Hanno Becker50b59662019-05-28 14:30:45 +01004082#if defined(MBEDTLS_HAVE_TIME)
Hanno Becker3e088662019-05-29 11:10:18 +01004083#define SSL_SERIALIZED_SESSION_CONFIG_TIME 1
Hanno Becker50b59662019-05-28 14:30:45 +01004084#else
Hanno Becker3e088662019-05-29 11:10:18 +01004085#define SSL_SERIALIZED_SESSION_CONFIG_TIME 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01004086#endif /* MBEDTLS_HAVE_TIME */
4087
4088#if defined(MBEDTLS_X509_CRT_PARSE_C)
Hanno Becker3e088662019-05-29 11:10:18 +01004089#define SSL_SERIALIZED_SESSION_CONFIG_CRT 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01004090#else
Hanno Becker3e088662019-05-29 11:10:18 +01004091#define SSL_SERIALIZED_SESSION_CONFIG_CRT 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01004092#endif /* MBEDTLS_X509_CRT_PARSE_C */
4093
David Horstmann5c5a32f2024-02-13 17:53:35 +00004094#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
David Horstmannf686f1d2024-03-01 11:20:32 +00004095#define SSL_SERIALIZED_SESSION_CONFIG_KEEP_PEER_CRT 1
David Horstmann5c5a32f2024-02-13 17:53:35 +00004096#else
David Horstmannf686f1d2024-03-01 11:20:32 +00004097#define SSL_SERIALIZED_SESSION_CONFIG_KEEP_PEER_CRT 0
David Horstmann5c5a32f2024-02-13 17:53:35 +00004098#endif /* MBEDTLS_SSL_SESSION_TICKETS */
4099
Hanno Becker94ef3b32019-05-16 12:50:45 +01004100#if defined(MBEDTLS_SSL_CLI_C) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Hanno Becker3e088662019-05-29 11:10:18 +01004101#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01004102#else
Hanno Becker3e088662019-05-29 11:10:18 +01004103#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01004104#endif /* MBEDTLS_SSL_CLI_C && MBEDTLS_SSL_SESSION_TICKETS */
4105
4106#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Hanno Becker3e088662019-05-29 11:10:18 +01004107#define SSL_SERIALIZED_SESSION_CONFIG_MFL 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01004108#else
Hanno Becker3e088662019-05-29 11:10:18 +01004109#define SSL_SERIALIZED_SESSION_CONFIG_MFL 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01004110#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
4111
Hanno Becker94ef3b32019-05-16 12:50:45 +01004112#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Hanno Becker3e088662019-05-29 11:10:18 +01004113#define SSL_SERIALIZED_SESSION_CONFIG_ETM 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01004114#else
Hanno Becker3e088662019-05-29 11:10:18 +01004115#define SSL_SERIALIZED_SESSION_CONFIG_ETM 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01004116#endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC */
4117
Hanno Becker94ef3b32019-05-16 12:50:45 +01004118#if defined(MBEDTLS_SSL_SESSION_TICKETS)
4119#define SSL_SERIALIZED_SESSION_CONFIG_TICKET 1
4120#else
4121#define SSL_SERIALIZED_SESSION_CONFIG_TICKET 0
4122#endif /* MBEDTLS_SSL_SESSION_TICKETS */
4123
David Horstmann92b258b2024-02-13 17:23:34 +00004124#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
4125#define SSL_SERIALIZED_SESSION_CONFIG_SNI 1
4126#else
4127#define SSL_SERIALIZED_SESSION_CONFIG_SNI 0
4128#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
4129
4130#if defined(MBEDTLS_SSL_EARLY_DATA)
4131#define SSL_SERIALIZED_SESSION_CONFIG_EARLY_DATA 1
4132#else
4133#define SSL_SERIALIZED_SESSION_CONFIG_EARLY_DATA 0
4134#endif /* MBEDTLS_SSL_EARLY_DATA */
4135
4136#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
4137#define SSL_SERIALIZED_SESSION_CONFIG_RECORD_SIZE 1
4138#else
4139#define SSL_SERIALIZED_SESSION_CONFIG_RECORD_SIZE 0
4140#endif /* MBEDTLS_SSL_RECORD_SIZE_LIMIT */
4141
Waleed Elmelegy7dfba342024-03-12 16:22:39 +00004142#if defined(MBEDTLS_SSL_ALPN) && defined(MBEDTLS_SSL_SRV_C) && \
4143 defined(MBEDTLS_SSL_EARLY_DATA)
Waleed Elmelegy11025632024-03-07 15:25:52 +00004144#define SSL_SERIALIZED_SESSION_CONFIG_ALPN 1
4145#else
4146#define SSL_SERIALIZED_SESSION_CONFIG_ALPN 0
4147#endif /* MBEDTLS_SSL_ALPN */
4148
Hanno Becker3e088662019-05-29 11:10:18 +01004149#define SSL_SERIALIZED_SESSION_CONFIG_TIME_BIT 0
4150#define SSL_SERIALIZED_SESSION_CONFIG_CRT_BIT 1
4151#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET_BIT 2
4152#define SSL_SERIALIZED_SESSION_CONFIG_MFL_BIT 3
Hanno Becker37bdbe62021-08-01 05:38:58 +01004153#define SSL_SERIALIZED_SESSION_CONFIG_ETM_BIT 4
4154#define SSL_SERIALIZED_SESSION_CONFIG_TICKET_BIT 5
David Horstmannf686f1d2024-03-01 11:20:32 +00004155#define SSL_SERIALIZED_SESSION_CONFIG_KEEP_PEER_CRT_BIT 6
David Horstmann92b258b2024-02-13 17:23:34 +00004156#define SSL_SERIALIZED_SESSION_CONFIG_SNI_BIT 7
4157#define SSL_SERIALIZED_SESSION_CONFIG_EARLY_DATA_BIT 8
4158#define SSL_SERIALIZED_SESSION_CONFIG_RECORD_SIZE_BIT 9
Waleed Elmelegy11025632024-03-07 15:25:52 +00004159#define SSL_SERIALIZED_SESSION_CONFIG_ALPN_BIT 10
Hanno Becker3e088662019-05-29 11:10:18 +01004160
Hanno Becker50b59662019-05-28 14:30:45 +01004161#define SSL_SERIALIZED_SESSION_CONFIG_BITFLAG \
Gilles Peskine449bd832023-01-11 14:50:10 +01004162 ((uint16_t) ( \
4163 (SSL_SERIALIZED_SESSION_CONFIG_TIME << SSL_SERIALIZED_SESSION_CONFIG_TIME_BIT) | \
4164 (SSL_SERIALIZED_SESSION_CONFIG_CRT << SSL_SERIALIZED_SESSION_CONFIG_CRT_BIT) | \
4165 (SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET << \
4166 SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET_BIT) | \
4167 (SSL_SERIALIZED_SESSION_CONFIG_MFL << SSL_SERIALIZED_SESSION_CONFIG_MFL_BIT) | \
4168 (SSL_SERIALIZED_SESSION_CONFIG_ETM << SSL_SERIALIZED_SESSION_CONFIG_ETM_BIT) | \
David Horstmann5c5a32f2024-02-13 17:53:35 +00004169 (SSL_SERIALIZED_SESSION_CONFIG_TICKET << SSL_SERIALIZED_SESSION_CONFIG_TICKET_BIT) | \
David Horstmann71fa1a92024-03-01 12:32:18 +00004170 (SSL_SERIALIZED_SESSION_CONFIG_KEEP_PEER_CRT << \
4171 SSL_SERIALIZED_SESSION_CONFIG_KEEP_PEER_CRT_BIT) | \
David Horstmann92b258b2024-02-13 17:23:34 +00004172 (SSL_SERIALIZED_SESSION_CONFIG_SNI << SSL_SERIALIZED_SESSION_CONFIG_SNI_BIT) | \
4173 (SSL_SERIALIZED_SESSION_CONFIG_EARLY_DATA << \
4174 SSL_SERIALIZED_SESSION_CONFIG_EARLY_DATA_BIT) | \
4175 (SSL_SERIALIZED_SESSION_CONFIG_RECORD_SIZE << \
Waleed Elmelegy11025632024-03-07 15:25:52 +00004176 SSL_SERIALIZED_SESSION_CONFIG_RECORD_SIZE_BIT) | \
Waleed Elmelegy75e33fa2024-03-07 16:57:58 +00004177 (SSL_SERIALIZED_SESSION_CONFIG_ALPN << \
Waleed Elmelegy11025632024-03-07 15:25:52 +00004178 SSL_SERIALIZED_SESSION_CONFIG_ALPN_BIT)))
Hanno Becker94ef3b32019-05-16 12:50:45 +01004179
Chien Wong4e9683e2023-12-28 17:07:43 +08004180static const unsigned char ssl_serialized_session_header[] = {
Hanno Becker94ef3b32019-05-16 12:50:45 +01004181 MBEDTLS_VERSION_MAJOR,
4182 MBEDTLS_VERSION_MINOR,
4183 MBEDTLS_VERSION_PATCH,
Gilles Peskine449bd832023-01-11 14:50:10 +01004184 MBEDTLS_BYTE_1(SSL_SERIALIZED_SESSION_CONFIG_BITFLAG),
4185 MBEDTLS_BYTE_0(SSL_SERIALIZED_SESSION_CONFIG_BITFLAG),
Hanno Beckerf8787072019-05-16 12:41:07 +01004186};
Hanno Beckera835da52019-05-16 12:39:07 +01004187
4188/*
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004189 * Serialize a session in the following format:
Manuel Pégourié-Gonnard35eb8022019-05-16 11:11:08 +02004190 * (in the presentation language of TLS, RFC 8446 section 3)
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004191 *
David Horstmanncb01b362024-02-29 17:31:46 +00004192 * TLS 1.2 session:
4193 *
4194 * struct {
4195 * #if defined(MBEDTLS_SSL_SESSION_TICKETS)
4196 * opaque ticket<0..2^24-1>; // length 0 means no ticket
4197 * uint32 ticket_lifetime;
4198 * #endif
4199 * } ClientOnlyData;
4200 *
4201 * struct {
4202 * #if defined(MBEDTLS_HAVE_TIME)
4203 * uint64 start_time;
4204 * #endif
4205 * uint8 session_id_len; // at most 32
4206 * opaque session_id[32];
4207 * opaque master[48]; // fixed length in the standard
4208 * uint32 verify_result;
4209 * #if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
4210 * opaque peer_cert<0..2^24-1>; // length 0 means no peer cert
4211 * #else
David Horstmann76ba26a2024-03-01 12:03:35 +00004212 * uint8 peer_cert_digest_type;
David Horstmanncb01b362024-02-29 17:31:46 +00004213 * opaque peer_cert_digest<0..2^8-1>
4214 * #endif
4215 * select (endpoint) {
4216 * case client: ClientOnlyData;
4217 * case server: uint64 ticket_creation_time;
4218 * };
4219 * #if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
4220 * uint8 mfl_code; // up to 255 according to standard
4221 * #endif
4222 * #if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
4223 * uint8 encrypt_then_mac; // 0 or 1
4224 * #endif
4225 * } serialized_session_tls12;
4226 *
4227 *
4228 * TLS 1.3 Session:
4229 *
4230 * struct {
4231 * #if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
4232 * opaque hostname<0..2^16-1>;
4233 * #endif
4234 * #if defined(MBEDTLS_HAVE_TIME)
4235 * uint64 ticket_reception_time;
4236 * #endif
4237 * uint32 ticket_lifetime;
4238 * opaque ticket<1..2^16-1>;
4239 * } ClientOnlyData;
4240 *
4241 * struct {
4242 * uint32 ticket_age_add;
4243 * uint8 ticket_flags;
4244 * opaque resumption_key<0..255>;
4245 * #if defined(MBEDTLS_SSL_EARLY_DATA)
4246 * uint32 max_early_data_size;
4247 * #endif
4248 * #if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
4249 * uint16 record_size_limit;
4250 * #endif
4251 * select ( endpoint ) {
4252 * case client: ClientOnlyData;
Waleed Elmelegy7dfba342024-03-12 16:22:39 +00004253 * case server:
David Horstmanncb01b362024-02-29 17:31:46 +00004254 * #if defined(MBEDTLS_HAVE_TIME)
Waleed Elmelegy7dfba342024-03-12 16:22:39 +00004255 * uint64 ticket_creation_time;
David Horstmanncb01b362024-02-29 17:31:46 +00004256 * #endif
Waleed Elmelegyfe9ae082024-03-07 15:47:31 +00004257 * #if defined(MBEDTLS_SSL_EARLY_DATA) && defined(MBEDTLS_SSL_ALPN)
Waleed Elmelegydaa4da72024-03-13 16:25:34 +00004258 * opaque ticket_alpn<0..256>;
David Horstmanncb01b362024-02-29 17:31:46 +00004259 * #endif
4260 * };
4261 * } serialized_session_tls13;
4262 *
4263 *
4264 * SSL session:
4265 *
4266 * struct {
Hanno Beckerdc28b6c2019-05-29 11:08:00 +01004267 *
Hanno Beckerdce50972021-08-01 05:39:23 +01004268 * opaque mbedtls_version[3]; // library version: major, minor, patch
4269 * opaque session_format[2]; // library-version specific 16-bit field
4270 * // determining the format of the remaining
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004271 * // serialized data.
Hanno Beckerdc28b6c2019-05-29 11:08:00 +01004272 *
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004273 * Note: When updating the format, remember to keep
4274 * these version+format bytes.
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004275 *
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004276 * // In this version, `session_format` determines
4277 * // the setting of those compile-time
4278 * // configuration options which influence
4279 * // the structure of mbedtls_ssl_session.
4280 *
Glenn Straussda7851c2022-03-14 13:29:48 -04004281 * uint8_t minor_ver; // Protocol minor version. Possible values:
Jerry Yu0c2a7382022-12-06 13:27:25 +08004282 * // - TLS 1.2 (0x0303)
4283 * // - TLS 1.3 (0x0304)
David Horstmann531aca22024-02-29 18:14:28 +00004284 * uint8_t endpoint;
4285 * uint16_t ciphersuite;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004286 *
Glenn Straussda7851c2022-03-14 13:29:48 -04004287 * select (serialized_session.tls_version) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004288 *
Glenn Straussda7851c2022-03-14 13:29:48 -04004289 * case MBEDTLS_SSL_VERSION_TLS1_2:
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004290 * serialized_session_tls12 data;
Jerry Yu0c2a7382022-12-06 13:27:25 +08004291 * case MBEDTLS_SSL_VERSION_TLS1_3:
Jerry Yuddda0502022-12-01 19:43:12 +08004292 * serialized_session_tls13 data;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004293 *
4294 * };
4295 *
4296 * } serialized_session;
4297 *
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004298 */
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004299
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004300MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004301static int ssl_session_save(const mbedtls_ssl_session *session,
4302 unsigned char omit_header,
4303 unsigned char *buf,
4304 size_t buf_len,
4305 size_t *olen)
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004306{
4307 unsigned char *p = buf;
4308 size_t used = 0;
Jerry Yu251a12e2022-07-13 15:15:48 +08004309 size_t remaining_len;
Jerry Yue36fdd62022-08-17 21:31:36 +08004310#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
4311 size_t out_len;
4312 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
4313#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01004314 if (session == NULL) {
4315 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
4316 }
Jerry Yu438ddd82022-07-07 06:55:50 +00004317
Gilles Peskine449bd832023-01-11 14:50:10 +01004318 if (!omit_header) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004319 /*
4320 * Add Mbed TLS version identifier
4321 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004322 used += sizeof(ssl_serialized_session_header);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004323
Gilles Peskine449bd832023-01-11 14:50:10 +01004324 if (used <= buf_len) {
4325 memcpy(p, ssl_serialized_session_header,
4326 sizeof(ssl_serialized_session_header));
4327 p += sizeof(ssl_serialized_session_header);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004328 }
4329 }
4330
4331 /*
Ronald Cron40a4ab02024-01-15 10:21:30 +01004332 * TLS version identifier, endpoint, ciphersuite
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004333 */
Ronald Cron40a4ab02024-01-15 10:21:30 +01004334 used += 1 /* TLS version */
4335 + 1 /* endpoint */
4336 + 2; /* ciphersuite */
Gilles Peskine449bd832023-01-11 14:50:10 +01004337 if (used <= buf_len) {
4338 *p++ = MBEDTLS_BYTE_0(session->tls_version);
Ronald Cron40a4ab02024-01-15 10:21:30 +01004339 *p++ = session->endpoint;
4340 MBEDTLS_PUT_UINT16_BE(session->ciphersuite, p, 0);
4341 p += 2;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004342 }
4343
4344 /* Forward to version-specific serialization routine. */
Jerry Yufca4d572022-07-21 10:37:48 +08004345 remaining_len = (buf_len >= used) ? buf_len - used : 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01004346 switch (session->tls_version) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004347#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01004348 case MBEDTLS_SSL_VERSION_TLS1_2:
4349 used += ssl_tls12_session_save(session, p, remaining_len);
4350 break;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004351#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
4352
Jerry Yu251a12e2022-07-13 15:15:48 +08004353#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004354 case MBEDTLS_SSL_VERSION_TLS1_3:
4355 ret = ssl_tls13_session_save(session, p, remaining_len, &out_len);
4356 if (ret != 0 && ret != MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL) {
4357 return ret;
4358 }
4359 used += out_len;
4360 break;
Jerry Yu251a12e2022-07-13 15:15:48 +08004361#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
4362
Gilles Peskine449bd832023-01-11 14:50:10 +01004363 default:
4364 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004365 }
4366
4367 *olen = used;
Gilles Peskine449bd832023-01-11 14:50:10 +01004368 if (used > buf_len) {
4369 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
4370 }
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004371
Gilles Peskine449bd832023-01-11 14:50:10 +01004372 return 0;
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004373}
4374
4375/*
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02004376 * Public wrapper for ssl_session_save()
4377 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004378int mbedtls_ssl_session_save(const mbedtls_ssl_session *session,
4379 unsigned char *buf,
4380 size_t buf_len,
4381 size_t *olen)
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02004382{
Gilles Peskine449bd832023-01-11 14:50:10 +01004383 return ssl_session_save(session, 0, buf, buf_len, olen);
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02004384}
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004385
Jerry Yuf1b23ca2022-02-18 11:48:47 +08004386/*
4387 * Deserialize session, see mbedtls_ssl_session_save() for format.
4388 *
4389 * This internal version is wrapped by a public function that cleans up in
4390 * case of error, and has an extra option omit_header.
4391 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004392MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004393static int ssl_session_load(mbedtls_ssl_session *session,
4394 unsigned char omit_header,
4395 const unsigned char *buf,
4396 size_t len)
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004397{
4398 const unsigned char *p = buf;
4399 const unsigned char * const end = buf + len;
Jerry Yu438ddd82022-07-07 06:55:50 +00004400 size_t remaining_len;
4401
4402
Gilles Peskine449bd832023-01-11 14:50:10 +01004403 if (session == NULL) {
4404 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
4405 }
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004406
Gilles Peskine449bd832023-01-11 14:50:10 +01004407 if (!omit_header) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004408 /*
4409 * Check Mbed TLS version identifier
4410 */
4411
Gilles Peskine449bd832023-01-11 14:50:10 +01004412 if ((size_t) (end - p) < sizeof(ssl_serialized_session_header)) {
4413 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004414 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004415
4416 if (memcmp(p, ssl_serialized_session_header,
4417 sizeof(ssl_serialized_session_header)) != 0) {
4418 return MBEDTLS_ERR_SSL_VERSION_MISMATCH;
4419 }
4420 p += sizeof(ssl_serialized_session_header);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004421 }
4422
4423 /*
Ronald Cron40a4ab02024-01-15 10:21:30 +01004424 * TLS version identifier, endpoint, ciphersuite
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004425 */
Ronald Cron40a4ab02024-01-15 10:21:30 +01004426 if (4 > (size_t) (end - p)) {
Gilles Peskine449bd832023-01-11 14:50:10 +01004427 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4428 }
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01004429 session->tls_version = (mbedtls_ssl_protocol_version) (0x0300 | *p++);
Ronald Cron40a4ab02024-01-15 10:21:30 +01004430 session->endpoint = *p++;
4431 session->ciphersuite = MBEDTLS_GET_UINT16_BE(p, 0);
4432 p += 2;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004433
4434 /* Dispatch according to TLS version. */
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00004435 remaining_len = (size_t) (end - p);
Gilles Peskine449bd832023-01-11 14:50:10 +01004436 switch (session->tls_version) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004437#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01004438 case MBEDTLS_SSL_VERSION_TLS1_2:
4439 return ssl_tls12_session_load(session, p, remaining_len);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004440#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
4441
Jerry Yu438ddd82022-07-07 06:55:50 +00004442#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004443 case MBEDTLS_SSL_VERSION_TLS1_3:
4444 return ssl_tls13_session_load(session, p, remaining_len);
Jerry Yu438ddd82022-07-07 06:55:50 +00004445#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
4446
Gilles Peskine449bd832023-01-11 14:50:10 +01004447 default:
4448 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004449 }
4450}
4451
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004452/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02004453 * Deserialize session: public wrapper for error cleaning
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02004454 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004455int mbedtls_ssl_session_load(mbedtls_ssl_session *session,
4456 const unsigned char *buf,
4457 size_t len)
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02004458{
Gilles Peskine449bd832023-01-11 14:50:10 +01004459 int ret = ssl_session_load(session, 0, buf, len);
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02004460
Gilles Peskine449bd832023-01-11 14:50:10 +01004461 if (ret != 0) {
4462 mbedtls_ssl_session_free(session);
4463 }
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02004464
Gilles Peskine449bd832023-01-11 14:50:10 +01004465 return ret;
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02004466}
4467
4468/*
Paul Bakker1961b702013-01-25 14:49:24 +01004469 * Perform a single step of the SSL handshake
Paul Bakker5121ce52009-01-03 21:22:43 +00004470 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004471MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004472static int ssl_prepare_handshake_step(mbedtls_ssl_context *ssl)
Hanno Becker41934dd2021-08-07 19:13:43 +01004473{
4474 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
4475
Ronald Cron66dbf912022-02-02 15:33:46 +01004476 /*
4477 * We may have not been able to send to the peer all the handshake data
Ronald Cron3f20b772022-03-08 16:00:02 +01004478 * that were written into the output buffer by the previous handshake step,
4479 * if the write to the network callback returned with the
Ronald Cron66dbf912022-02-02 15:33:46 +01004480 * #MBEDTLS_ERR_SSL_WANT_WRITE error code.
4481 * We proceed to the next handshake step only when all data from the
4482 * previous one have been sent to the peer, thus we make sure that this is
4483 * the case here by calling `mbedtls_ssl_flush_output()`. The function may
4484 * return with the #MBEDTLS_ERR_SSL_WANT_WRITE error code in which case
4485 * we have to wait before to go ahead.
4486 * In the case of TLS 1.3, handshake step handlers do not send data to the
4487 * peer. Data are only sent here and through
4488 * `mbedtls_ssl_handle_pending_alert` in case an error that triggered an
Andrzej Kurek5c65c572022-04-13 14:28:52 -04004489 * alert occurred.
Ronald Cron66dbf912022-02-02 15:33:46 +01004490 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004491 if ((ret = mbedtls_ssl_flush_output(ssl)) != 0) {
4492 return ret;
4493 }
Hanno Becker41934dd2021-08-07 19:13:43 +01004494
4495#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004496 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
4497 ssl->handshake->retransmit_state == MBEDTLS_SSL_RETRANS_SENDING) {
4498 if ((ret = mbedtls_ssl_flight_transmit(ssl)) != 0) {
4499 return ret;
4500 }
Hanno Becker41934dd2021-08-07 19:13:43 +01004501 }
4502#endif /* MBEDTLS_SSL_PROTO_DTLS */
4503
Gilles Peskine449bd832023-01-11 14:50:10 +01004504 return ret;
Hanno Becker41934dd2021-08-07 19:13:43 +01004505}
4506
Gilles Peskine449bd832023-01-11 14:50:10 +01004507int mbedtls_ssl_handshake_step(mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00004508{
Hanno Becker41934dd2021-08-07 19:13:43 +01004509 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00004510
Gilles Peskine449bd832023-01-11 14:50:10 +01004511 if (ssl == NULL ||
Hanno Becker41934dd2021-08-07 19:13:43 +01004512 ssl->conf == NULL ||
4513 ssl->handshake == NULL ||
Gilles Peskine449bd832023-01-11 14:50:10 +01004514 ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER) {
4515 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Becker41934dd2021-08-07 19:13:43 +01004516 }
4517
Gilles Peskine449bd832023-01-11 14:50:10 +01004518 ret = ssl_prepare_handshake_step(ssl);
4519 if (ret != 0) {
4520 return ret;
4521 }
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02004522
Gilles Peskine449bd832023-01-11 14:50:10 +01004523 ret = mbedtls_ssl_handle_pending_alert(ssl);
4524 if (ret != 0) {
Jerry Yue7047812021-09-13 19:26:39 +08004525 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01004526 }
Jerry Yue7047812021-09-13 19:26:39 +08004527
Tom Cosgrove2fdc7b32022-09-21 12:33:17 +01004528 /* If ssl->conf->endpoint is not one of MBEDTLS_SSL_IS_CLIENT or
4529 * MBEDTLS_SSL_IS_SERVER, this is the return code we give */
4530 ret = MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4531
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004532#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004533 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
4534 MBEDTLS_SSL_DEBUG_MSG(2, ("client state: %s",
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01004535 mbedtls_ssl_states_str((mbedtls_ssl_states) ssl->state)));
Jerry Yub9930e72021-08-06 17:11:51 +08004536
Gilles Peskine449bd832023-01-11 14:50:10 +01004537 switch (ssl->state) {
Ronald Cron9f0fba32022-02-10 16:45:15 +01004538 case MBEDTLS_SSL_HELLO_REQUEST:
4539 ssl->state = MBEDTLS_SSL_CLIENT_HELLO;
Tom Cosgrove87d9c6c2022-09-22 09:27:56 +01004540 ret = 0;
Ronald Cron9f0fba32022-02-10 16:45:15 +01004541 break;
Jerry Yub9930e72021-08-06 17:11:51 +08004542
Ronald Cron9f0fba32022-02-10 16:45:15 +01004543 case MBEDTLS_SSL_CLIENT_HELLO:
Gilles Peskine449bd832023-01-11 14:50:10 +01004544 ret = mbedtls_ssl_write_client_hello(ssl);
Ronald Cron9f0fba32022-02-10 16:45:15 +01004545 break;
4546
4547 default:
4548#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004549 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
4550 ret = mbedtls_ssl_tls13_handshake_client_step(ssl);
4551 } else {
4552 ret = mbedtls_ssl_handshake_client_step(ssl);
4553 }
Ronald Cron9f0fba32022-02-10 16:45:15 +01004554#elif defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01004555 ret = mbedtls_ssl_handshake_client_step(ssl);
Ronald Cron9f0fba32022-02-10 16:45:15 +01004556#else
Gilles Peskine449bd832023-01-11 14:50:10 +01004557 ret = mbedtls_ssl_tls13_handshake_client_step(ssl);
Ronald Cron9f0fba32022-02-10 16:45:15 +01004558#endif
4559 }
Jerry Yub9930e72021-08-06 17:11:51 +08004560 }
Ronald Cron6291b232023-03-08 15:51:25 +01004561#endif /* MBEDTLS_SSL_CLI_C */
4562
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004563#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004564 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Ronald Cron6291b232023-03-08 15:51:25 +01004565#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
4566 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Gilles Peskine449bd832023-01-11 14:50:10 +01004567 ret = mbedtls_ssl_tls13_handshake_server_step(ssl);
Ronald Cron6291b232023-03-08 15:51:25 +01004568 } else {
Gilles Peskine449bd832023-01-11 14:50:10 +01004569 ret = mbedtls_ssl_handshake_server_step(ssl);
4570 }
Ronald Cron6291b232023-03-08 15:51:25 +01004571#elif defined(MBEDTLS_SSL_PROTO_TLS1_2)
4572 ret = mbedtls_ssl_handshake_server_step(ssl);
4573#else
4574 ret = mbedtls_ssl_tls13_handshake_server_step(ssl);
Paul Bakker5121ce52009-01-03 21:22:43 +00004575#endif
Ronald Cron6291b232023-03-08 15:51:25 +01004576 }
4577#endif /* MBEDTLS_SSL_SRV_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00004578
Gilles Peskine449bd832023-01-11 14:50:10 +01004579 if (ret != 0) {
Jerry Yubbd5a3f2021-09-18 20:50:22 +08004580 /* handshake_step return error. And it is same
4581 * with alert_reason.
4582 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004583 if (ssl->send_alert) {
4584 ret = mbedtls_ssl_handle_pending_alert(ssl);
Jerry Yue7047812021-09-13 19:26:39 +08004585 goto cleanup;
4586 }
4587 }
4588
4589cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +01004590 return ret;
Paul Bakker1961b702013-01-25 14:49:24 +01004591}
4592
4593/*
4594 * Perform the SSL handshake
4595 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004596int mbedtls_ssl_handshake(mbedtls_ssl_context *ssl)
Paul Bakker1961b702013-01-25 14:49:24 +01004597{
4598 int ret = 0;
4599
Hanno Beckera817ea42020-10-20 15:20:23 +01004600 /* Sanity checks */
4601
Gilles Peskine449bd832023-01-11 14:50:10 +01004602 if (ssl == NULL || ssl->conf == NULL) {
4603 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4604 }
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02004605
Hanno Beckera817ea42020-10-20 15:20:23 +01004606#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004607 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
4608 (ssl->f_set_timer == NULL || ssl->f_get_timer == NULL)) {
4609 MBEDTLS_SSL_DEBUG_MSG(1, ("You must use "
4610 "mbedtls_ssl_set_timer_cb() for DTLS"));
4611 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Beckera817ea42020-10-20 15:20:23 +01004612 }
4613#endif /* MBEDTLS_SSL_PROTO_DTLS */
4614
Gilles Peskine449bd832023-01-11 14:50:10 +01004615 MBEDTLS_SSL_DEBUG_MSG(2, ("=> handshake"));
Paul Bakker1961b702013-01-25 14:49:24 +01004616
Hanno Beckera817ea42020-10-20 15:20:23 +01004617 /* Main handshake loop */
Gilles Peskine449bd832023-01-11 14:50:10 +01004618 while (ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER) {
4619 ret = mbedtls_ssl_handshake_step(ssl);
Paul Bakker1961b702013-01-25 14:49:24 +01004620
Gilles Peskine449bd832023-01-11 14:50:10 +01004621 if (ret != 0) {
Paul Bakker1961b702013-01-25 14:49:24 +01004622 break;
Gilles Peskine449bd832023-01-11 14:50:10 +01004623 }
Paul Bakker1961b702013-01-25 14:49:24 +01004624 }
4625
Gilles Peskine449bd832023-01-11 14:50:10 +01004626 MBEDTLS_SSL_DEBUG_MSG(2, ("<= handshake"));
Paul Bakker5121ce52009-01-03 21:22:43 +00004627
Gilles Peskine449bd832023-01-11 14:50:10 +01004628 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00004629}
4630
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004631#if defined(MBEDTLS_SSL_RENEGOTIATION)
4632#if defined(MBEDTLS_SSL_SRV_C)
Paul Bakker5121ce52009-01-03 21:22:43 +00004633/*
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004634 * Write HelloRequest to request renegotiation on server
Paul Bakker48916f92012-09-16 19:57:18 +00004635 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004636MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004637static int ssl_write_hello_request(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004638{
Janos Follath865b3eb2019-12-16 11:46:15 +00004639 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004640
Gilles Peskine449bd832023-01-11 14:50:10 +01004641 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write hello request"));
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004642
4643 ssl->out_msglen = 4;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004644 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
4645 ssl->out_msg[0] = MBEDTLS_SSL_HS_HELLO_REQUEST;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004646
Gilles Peskine449bd832023-01-11 14:50:10 +01004647 if ((ret = mbedtls_ssl_write_handshake_msg(ssl)) != 0) {
4648 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_handshake_msg", ret);
4649 return ret;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004650 }
4651
Gilles Peskine449bd832023-01-11 14:50:10 +01004652 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write hello request"));
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004653
Gilles Peskine449bd832023-01-11 14:50:10 +01004654 return 0;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004655}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004656#endif /* MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004657
4658/*
4659 * Actually renegotiate current connection, triggered by either:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004660 * - any side: calling mbedtls_ssl_renegotiate(),
4661 * - client: receiving a HelloRequest during mbedtls_ssl_read(),
4662 * - server: receiving any handshake message on server during mbedtls_ssl_read() after
Manuel Pégourié-Gonnard55e4ff22014-08-19 11:16:35 +02004663 * the initial handshake is completed.
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004664 * If the handshake doesn't complete due to waiting for I/O, it will continue
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004665 * during the next calls to mbedtls_ssl_renegotiate() or mbedtls_ssl_read() respectively.
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004666 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004667int mbedtls_ssl_start_renegotiation(mbedtls_ssl_context *ssl)
Paul Bakker48916f92012-09-16 19:57:18 +00004668{
Janos Follath865b3eb2019-12-16 11:46:15 +00004669 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker48916f92012-09-16 19:57:18 +00004670
Gilles Peskine449bd832023-01-11 14:50:10 +01004671 MBEDTLS_SSL_DEBUG_MSG(2, ("=> renegotiate"));
Paul Bakker48916f92012-09-16 19:57:18 +00004672
Gilles Peskine449bd832023-01-11 14:50:10 +01004673 if ((ret = ssl_handshake_init(ssl)) != 0) {
4674 return ret;
4675 }
Paul Bakker48916f92012-09-16 19:57:18 +00004676
Manuel Pégourié-Gonnard0557bd52014-08-19 19:18:39 +02004677 /* RFC 6347 4.2.2: "[...] the HelloRequest will have message_seq = 0 and
4678 * the ServerHello will have message_seq = 1" */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004679#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004680 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
4681 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING) {
4682 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02004683 ssl->handshake->out_msg_seq = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004684 } else {
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02004685 ssl->handshake->in_msg_seq = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004686 }
Manuel Pégourié-Gonnard0557bd52014-08-19 19:18:39 +02004687 }
4688#endif
4689
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004690 ssl->state = MBEDTLS_SSL_HELLO_REQUEST;
4691 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS;
Paul Bakker48916f92012-09-16 19:57:18 +00004692
Gilles Peskine449bd832023-01-11 14:50:10 +01004693 if ((ret = mbedtls_ssl_handshake(ssl)) != 0) {
4694 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_handshake", ret);
4695 return ret;
Paul Bakker48916f92012-09-16 19:57:18 +00004696 }
4697
Gilles Peskine449bd832023-01-11 14:50:10 +01004698 MBEDTLS_SSL_DEBUG_MSG(2, ("<= renegotiate"));
Paul Bakker48916f92012-09-16 19:57:18 +00004699
Gilles Peskine449bd832023-01-11 14:50:10 +01004700 return 0;
Paul Bakker48916f92012-09-16 19:57:18 +00004701}
4702
4703/*
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004704 * Renegotiate current connection on client,
4705 * or request renegotiation on server
4706 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004707int mbedtls_ssl_renegotiate(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004708{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004709 int ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004710
Gilles Peskine449bd832023-01-11 14:50:10 +01004711 if (ssl == NULL || ssl->conf == NULL) {
4712 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4713 }
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02004714
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004715#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004716 /* On server, just send the request */
Gilles Peskine449bd832023-01-11 14:50:10 +01004717 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
4718 if (mbedtls_ssl_is_handshake_over(ssl) == 0) {
4719 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4720 }
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004721
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004722 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_PENDING;
Manuel Pégourié-Gonnardf07f4212014-08-15 19:04:47 +02004723
4724 /* Did we already try/start sending HelloRequest? */
Gilles Peskine449bd832023-01-11 14:50:10 +01004725 if (ssl->out_left != 0) {
4726 return mbedtls_ssl_flush_output(ssl);
4727 }
Manuel Pégourié-Gonnardf07f4212014-08-15 19:04:47 +02004728
Gilles Peskine449bd832023-01-11 14:50:10 +01004729 return ssl_write_hello_request(ssl);
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004730 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004731#endif /* MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004732
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004733#if defined(MBEDTLS_SSL_CLI_C)
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004734 /*
4735 * On client, either start the renegotiation process or,
4736 * if already in progress, continue the handshake
4737 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004738 if (ssl->renego_status != MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS) {
4739 if (mbedtls_ssl_is_handshake_over(ssl) == 0) {
4740 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004741 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004742
4743 if ((ret = mbedtls_ssl_start_renegotiation(ssl)) != 0) {
4744 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_start_renegotiation", ret);
4745 return ret;
4746 }
4747 } else {
4748 if ((ret = mbedtls_ssl_handshake(ssl)) != 0) {
4749 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_handshake", ret);
4750 return ret;
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004751 }
4752 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004753#endif /* MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004754
Gilles Peskine449bd832023-01-11 14:50:10 +01004755 return ret;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004756}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004757#endif /* MBEDTLS_SSL_RENEGOTIATION */
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004758
Gilles Peskine449bd832023-01-11 14:50:10 +01004759void mbedtls_ssl_handshake_free(mbedtls_ssl_context *ssl)
Paul Bakker48916f92012-09-16 19:57:18 +00004760{
Gilles Peskine9b562d52018-04-25 20:32:43 +02004761 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
4762
Gilles Peskine449bd832023-01-11 14:50:10 +01004763 if (handshake == NULL) {
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004764 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01004765 }
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004766
Valerio Setti6f0441d2023-07-03 12:11:36 +02004767#if defined(MBEDTLS_PK_HAVE_ECC_KEYS)
Brett Warrene0edc842021-08-17 09:53:13 +01004768#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004769 if (ssl->handshake->group_list_heap_allocated) {
4770 mbedtls_free((void *) handshake->group_list);
4771 }
Brett Warrene0edc842021-08-17 09:53:13 +01004772 handshake->group_list = NULL;
4773#endif /* MBEDTLS_DEPRECATED_REMOVED */
Valerio Setti6f0441d2023-07-03 12:11:36 +02004774#endif /* MBEDTLS_PK_HAVE_ECC_KEYS */
Brett Warrene0edc842021-08-17 09:53:13 +01004775
Ronald Crone68ab4f2022-10-05 12:46:29 +02004776#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yuf017ee42022-01-12 15:49:48 +08004777#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004778 if (ssl->handshake->sig_algs_heap_allocated) {
4779 mbedtls_free((void *) handshake->sig_algs);
4780 }
Jerry Yuf017ee42022-01-12 15:49:48 +08004781 handshake->sig_algs = NULL;
4782#endif /* MBEDTLS_DEPRECATED_REMOVED */
Xiaofei Baic234ecf2022-02-08 09:59:23 +00004783#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004784 if (ssl->handshake->certificate_request_context) {
4785 mbedtls_free((void *) handshake->certificate_request_context);
Xiaofei Baic234ecf2022-02-08 09:59:23 +00004786 }
4787#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Ronald Crone68ab4f2022-10-05 12:46:29 +02004788#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Jerry Yuf017ee42022-01-12 15:49:48 +08004789
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02004790#if defined(MBEDTLS_SSL_ASYNC_PRIVATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01004791 if (ssl->conf->f_async_cancel != NULL && handshake->async_in_progress != 0) {
4792 ssl->conf->f_async_cancel(ssl);
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02004793 handshake->async_in_progress = 0;
4794 }
4795#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
4796
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01004797#if defined(MBEDTLS_MD_CAN_SHA256)
Andrzej Kurekeb342242019-01-29 09:14:33 -05004798#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01004799 psa_hash_abort(&handshake->fin_sha256_psa);
Andrzej Kurekeb342242019-01-29 09:14:33 -05004800#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01004801 mbedtls_md_free(&handshake->fin_sha256);
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02004802#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -05004803#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01004804#if defined(MBEDTLS_MD_CAN_SHA384)
Andrzej Kurekeb342242019-01-29 09:14:33 -05004805#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01004806 psa_hash_abort(&handshake->fin_sha384_psa);
Andrzej Kurekeb342242019-01-29 09:14:33 -05004807#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01004808 mbedtls_md_free(&handshake->fin_sha384);
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02004809#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -05004810#endif
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02004811
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004812#if defined(MBEDTLS_DHM_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004813 mbedtls_dhm_free(&handshake->dhm_ctx);
Paul Bakker48916f92012-09-16 19:57:18 +00004814#endif
Valerio Setti7aeec542023-07-05 18:57:21 +02004815#if !defined(MBEDTLS_USE_PSA_CRYPTO) && \
Valerio Setti6eb00542023-07-07 17:04:24 +02004816 defined(MBEDTLS_KEY_EXCHANGE_SOME_ECDH_OR_ECDHE_1_2_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004817 mbedtls_ecdh_free(&handshake->ecdh_ctx);
Paul Bakker61d113b2013-07-04 11:51:43 +02004818#endif
Valerio Setti02c25b52022-11-15 14:08:42 +01004819
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02004820#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Neil Armstrongca7d5062022-05-31 14:43:23 +02004821#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01004822 psa_pake_abort(&handshake->psa_pake_ctx);
Valerio Settieb3f7882022-12-08 18:42:58 +01004823 /*
4824 * Opaque keys are not stored in the handshake's data and it's the user
4825 * responsibility to destroy them. Clear ones, instead, are created by
4826 * the TLS library and should be destroyed at the same level
4827 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004828 if (!mbedtls_svc_key_id_is_null(handshake->psa_pake_password)) {
4829 psa_destroy_key(handshake->psa_pake_password);
Valerio Settieb3f7882022-12-08 18:42:58 +01004830 }
Neil Armstrongca7d5062022-05-31 14:43:23 +02004831 handshake->psa_pake_password = MBEDTLS_SVC_KEY_ID_INIT;
4832#else
Gilles Peskine449bd832023-01-11 14:50:10 +01004833 mbedtls_ecjpake_free(&handshake->ecjpake_ctx);
Neil Armstrongca7d5062022-05-31 14:43:23 +02004834#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard77c06462015-09-17 13:59:49 +02004835#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004836 mbedtls_free(handshake->ecjpake_cache);
Manuel Pégourié-Gonnard77c06462015-09-17 13:59:49 +02004837 handshake->ecjpake_cache = NULL;
4838 handshake->ecjpake_cache_len = 0;
4839#endif
Manuel Pégourié-Gonnard76cfd3f2015-09-15 12:10:54 +02004840#endif
Paul Bakker61d113b2013-07-04 11:51:43 +02004841
Valerio Setti7aeec542023-07-05 18:57:21 +02004842#if defined(MBEDTLS_KEY_EXCHANGE_SOME_ECDH_OR_ECDHE_ANY_ENABLED) || \
Valerio Setti45d56f32023-07-13 17:23:20 +02004843 defined(MBEDTLS_KEY_EXCHANGE_WITH_ECDSA_ANY_ENABLED) || \
Janos Follath4ae5c292016-02-10 11:27:43 +00004844 defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Paul Bakker9af723c2014-05-01 13:03:14 +02004845 /* explicit void pointer cast for buggy MS compiler */
Gilles Peskine449bd832023-01-11 14:50:10 +01004846 mbedtls_free((void *) handshake->curves_tls_id);
Manuel Pégourié-Gonnardd09453c2013-09-23 19:11:32 +02004847#endif
4848
Ronald Cron73fe8df2022-10-05 14:31:43 +02004849#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED)
Neil Armstrong501c9322022-05-03 09:35:09 +02004850#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01004851 if (!mbedtls_svc_key_id_is_null(ssl->handshake->psk_opaque)) {
Neil Armstrong501c9322022-05-03 09:35:09 +02004852 /* The maintenance of the external PSK key slot is the
4853 * user's responsibility. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004854 if (ssl->handshake->psk_opaque_is_internal) {
4855 psa_destroy_key(ssl->handshake->psk_opaque);
Neil Armstrong501c9322022-05-03 09:35:09 +02004856 ssl->handshake->psk_opaque_is_internal = 0;
4857 }
4858 ssl->handshake->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
4859 }
Neil Armstronge952a302022-05-03 10:22:14 +02004860#else
Gilles Peskine449bd832023-01-11 14:50:10 +01004861 if (handshake->psk != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01004862 mbedtls_zeroize_and_free(handshake->psk, handshake->psk_len);
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01004863 }
Neil Armstronge952a302022-05-03 10:22:14 +02004864#endif /* MBEDTLS_USE_PSA_CRYPTO */
Ronald Cron73fe8df2022-10-05 14:31:43 +02004865#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED */
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01004866
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004867#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
4868 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Manuel Pégourié-Gonnard83724542013-09-24 22:30:56 +02004869 /*
4870 * Free only the linked list wrapper, not the keys themselves
4871 * since the belong to the SNI callback
4872 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004873 ssl_key_cert_free(handshake->sni_key_cert);
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004874#endif /* MBEDTLS_X509_CRT_PARSE_C && MBEDTLS_SSL_SERVER_NAME_INDICATION */
Manuel Pégourié-Gonnard705fcca2013-09-23 20:04:20 +02004875
Gilles Peskineeccd8882020-03-10 12:19:08 +01004876#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004877 mbedtls_x509_crt_restart_free(&handshake->ecrs_ctx);
4878 if (handshake->ecrs_peer_cert != NULL) {
4879 mbedtls_x509_crt_free(handshake->ecrs_peer_cert);
4880 mbedtls_free(handshake->ecrs_peer_cert);
Hanno Becker3dad3112019-02-05 17:19:52 +00004881 }
Manuel Pégourié-Gonnard862cde52017-05-17 11:56:15 +02004882#endif
4883
Hanno Becker75173122019-02-06 16:18:31 +00004884#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
4885 !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01004886 mbedtls_pk_free(&handshake->peer_pubkey);
Hanno Becker75173122019-02-06 16:18:31 +00004887#endif /* MBEDTLS_X509_CRT_PARSE_C && !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
4888
XiaokangQian9b93c0d2022-02-09 06:02:25 +00004889#if defined(MBEDTLS_SSL_CLI_C) && \
Gilles Peskine449bd832023-01-11 14:50:10 +01004890 (defined(MBEDTLS_SSL_PROTO_DTLS) || defined(MBEDTLS_SSL_PROTO_TLS1_3))
4891 mbedtls_free(handshake->cookie);
XiaokangQian9b93c0d2022-02-09 06:02:25 +00004892#endif /* MBEDTLS_SSL_CLI_C &&
4893 ( MBEDTLS_SSL_PROTO_DTLS || MBEDTLS_SSL_PROTO_TLS1_3 ) */
XiaokangQian8499b6c2022-01-27 09:00:11 +00004894
4895#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004896 mbedtls_ssl_flight_free(handshake->flight);
4897 mbedtls_ssl_buffering_free(ssl);
XiaokangQian8499b6c2022-01-27 09:00:11 +00004898#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard74848812014-07-11 02:43:49 +02004899
Valerio Settiea59c432023-07-25 11:14:03 +02004900#if defined(MBEDTLS_KEY_EXCHANGE_SOME_XXDH_PSA_ANY_ENABLED)
Przemek Stekiel7ac93be2023-07-04 10:02:38 +02004901 if (handshake->xxdh_psa_privkey_is_external == 0) {
4902 psa_destroy_key(handshake->xxdh_psa_privkey);
Gilles Peskine449bd832023-01-11 14:50:10 +01004903 }
Valerio Settiea59c432023-07-25 11:14:03 +02004904#endif /* MBEDTLS_KEY_EXCHANGE_SOME_XXDH_PSA_ANY_ENABLED */
Hanno Becker4a63ed42019-01-08 11:39:35 +00004905
Ronald Cron6f135e12021-12-08 16:57:54 +01004906#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004907 mbedtls_ssl_transform_free(handshake->transform_handshake);
4908 mbedtls_free(handshake->transform_handshake);
Jerry Yu3d9b5902022-11-04 14:07:25 +08004909#if defined(MBEDTLS_SSL_EARLY_DATA)
Gilles Peskine449bd832023-01-11 14:50:10 +01004910 mbedtls_ssl_transform_free(handshake->transform_earlydata);
4911 mbedtls_free(handshake->transform_earlydata);
Jerry Yu3d9b5902022-11-04 14:07:25 +08004912#endif
Ronald Cron6f135e12021-12-08 16:57:54 +01004913#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yuba9c7272021-10-30 11:54:10 +08004914
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05004915
4916#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
4917 /* If the buffers are too big - reallocate. Because of the way Mbed TLS
4918 * processes datagrams and the fact that a datagram is allowed to have
4919 * several records in it, it is possible that the I/O buffers are not
4920 * empty at this stage */
Gilles Peskine449bd832023-01-11 14:50:10 +01004921 handle_buffer_resizing(ssl, 1, mbedtls_ssl_get_input_buflen(ssl),
4922 mbedtls_ssl_get_output_buflen(ssl));
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05004923#endif
Hanno Becker3aa186f2021-08-10 09:24:19 +01004924
Jerry Yuba9c7272021-10-30 11:54:10 +08004925 /* mbedtls_platform_zeroize MUST be last one in this function */
Gilles Peskine449bd832023-01-11 14:50:10 +01004926 mbedtls_platform_zeroize(handshake,
4927 sizeof(mbedtls_ssl_handshake_params));
Paul Bakker48916f92012-09-16 19:57:18 +00004928}
4929
Gilles Peskine449bd832023-01-11 14:50:10 +01004930void mbedtls_ssl_session_free(mbedtls_ssl_session *session)
Paul Bakker48916f92012-09-16 19:57:18 +00004931{
Gilles Peskine449bd832023-01-11 14:50:10 +01004932 if (session == NULL) {
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004933 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01004934 }
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004935
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004936#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004937 ssl_clear_peer_cert(session);
Paul Bakkered27a042013-04-18 22:46:23 +02004938#endif
Paul Bakker0a597072012-09-25 21:55:46 +00004939
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02004940#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
Xiaokang Qianbc663a02022-10-09 11:14:39 +00004941#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && \
4942 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01004943 mbedtls_free(session->hostname);
Xiaokang Qian281fd1b2022-09-20 11:35:41 +00004944#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01004945 mbedtls_free(session->ticket);
Paul Bakkera503a632013-08-14 13:48:06 +02004946#endif
Manuel Pégourié-Gonnard75d44012013-08-02 14:44:04 +02004947
Waleed Elmelegy2824a202024-02-23 17:51:47 +00004948#if defined(MBEDTLS_SSL_EARLY_DATA) && defined(MBEDTLS_SSL_ALPN) && \
4949 defined(MBEDTLS_SSL_SRV_C)
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00004950 mbedtls_free(session->ticket_alpn);
Paul Bakker5121ce52009-01-03 21:22:43 +00004951#endif
4952
Gilles Peskine449bd832023-01-11 14:50:10 +01004953 mbedtls_platform_zeroize(session, sizeof(mbedtls_ssl_session));
Paul Bakker5121ce52009-01-03 21:22:43 +00004954}
4955
Manuel Pégourié-Gonnard5c0e3772019-07-23 16:13:17 +02004956#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004957
4958#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
4959#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID 1u
4960#else
4961#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID 0u
4962#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
4963
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004964#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT 1u
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004965
4966#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
4967#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY 1u
4968#else
4969#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY 0u
4970#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
4971
4972#if defined(MBEDTLS_SSL_ALPN)
4973#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN 1u
4974#else
4975#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN 0u
4976#endif /* MBEDTLS_SSL_ALPN */
4977
4978#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID_BIT 0
4979#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT_BIT 1
4980#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY_BIT 2
4981#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN_BIT 3
4982
4983#define SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG \
Gilles Peskine449bd832023-01-11 14:50:10 +01004984 ((uint32_t) ( \
4985 (SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID << \
4986 SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID_BIT) | \
4987 (SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT << \
4988 SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT_BIT) | \
4989 (SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY << \
4990 SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY_BIT) | \
4991 (SSL_SERIALIZED_CONTEXT_CONFIG_ALPN << SSL_SERIALIZED_CONTEXT_CONFIG_ALPN_BIT) | \
4992 0u))
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004993
Chien Wong4e9683e2023-12-28 17:07:43 +08004994static const unsigned char ssl_serialized_context_header[] = {
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004995 MBEDTLS_VERSION_MAJOR,
4996 MBEDTLS_VERSION_MINOR,
4997 MBEDTLS_VERSION_PATCH,
Gilles Peskine449bd832023-01-11 14:50:10 +01004998 MBEDTLS_BYTE_1(SSL_SERIALIZED_SESSION_CONFIG_BITFLAG),
4999 MBEDTLS_BYTE_0(SSL_SERIALIZED_SESSION_CONFIG_BITFLAG),
5000 MBEDTLS_BYTE_2(SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG),
5001 MBEDTLS_BYTE_1(SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG),
5002 MBEDTLS_BYTE_0(SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG),
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005003};
5004
Paul Bakker5121ce52009-01-03 21:22:43 +00005005/*
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005006 * Serialize a full SSL context
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02005007 *
5008 * The format of the serialized data is:
5009 * (in the presentation language of TLS, RFC 8446 section 3)
5010 *
5011 * // header
5012 * opaque mbedtls_version[3]; // major, minor, patch
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005013 * opaque context_format[5]; // version-specific field determining
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02005014 * // the format of the remaining
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005015 * // serialized data.
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02005016 * Note: When updating the format, remember to keep these
5017 * version+format bytes. (We may make their size part of the API.)
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02005018 *
5019 * // session sub-structure
5020 * opaque session<1..2^32-1>; // see mbedtls_ssl_session_save()
5021 * // transform sub-structure
5022 * uint8 random[64]; // ServerHello.random+ClientHello.random
5023 * uint8 in_cid<0..2^8-1> // Connection ID: expected incoming value
5024 * uint8 out_cid<0..2^8-1> // Connection ID: outgoing value to use
5025 * // fields from ssl_context
5026 * uint32 badmac_seen; // DTLS: number of records with failing MAC
5027 * uint64 in_window_top; // DTLS: last validated record seq_num
5028 * uint64 in_window; // DTLS: bitmask for replay protection
5029 * uint8 disable_datagram_packing; // DTLS: only one record per datagram
5030 * uint64 cur_out_ctr; // Record layer: outgoing sequence number
5031 * uint16 mtu; // DTLS: path mtu (max outgoing fragment size)
5032 * uint8 alpn_chosen<0..2^8-1> // ALPN: negotiated application protocol
5033 *
5034 * Note that many fields of the ssl_context or sub-structures are not
5035 * serialized, as they fall in one of the following categories:
5036 *
5037 * 1. forced value (eg in_left must be 0)
5038 * 2. pointer to dynamically-allocated memory (eg session, transform)
5039 * 3. value can be re-derived from other data (eg session keys from MS)
5040 * 4. value was temporary (eg content of input buffer)
5041 * 5. value will be provided by the user again (eg I/O callbacks and context)
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005042 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005043int mbedtls_ssl_context_save(mbedtls_ssl_context *ssl,
5044 unsigned char *buf,
5045 size_t buf_len,
5046 size_t *olen)
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005047{
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005048 unsigned char *p = buf;
5049 size_t used = 0;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005050 size_t session_len;
5051 int ret = 0;
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005052
Manuel Pégourié-Gonnard1aaf6692019-07-10 14:14:05 +02005053 /*
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02005054 * Enforce usage restrictions, see "return BAD_INPUT_DATA" in
5055 * this function's documentation.
5056 *
5057 * These are due to assumptions/limitations in the implementation. Some of
5058 * them are likely to stay (no handshake in progress) some might go away
5059 * (only DTLS) but are currently used to simplify the implementation.
Manuel Pégourié-Gonnard1aaf6692019-07-10 14:14:05 +02005060 */
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02005061 /* The initial handshake must be over */
Gilles Peskine449bd832023-01-11 14:50:10 +01005062 if (mbedtls_ssl_is_handshake_over(ssl) == 0) {
5063 MBEDTLS_SSL_DEBUG_MSG(1, ("Initial handshake isn't over"));
5064 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03005065 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005066 if (ssl->handshake != NULL) {
5067 MBEDTLS_SSL_DEBUG_MSG(1, ("Handshake isn't completed"));
5068 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03005069 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02005070 /* Double-check that sub-structures are indeed ready */
Gilles Peskine449bd832023-01-11 14:50:10 +01005071 if (ssl->transform == NULL || ssl->session == NULL) {
5072 MBEDTLS_SSL_DEBUG_MSG(1, ("Serialised structures aren't ready"));
5073 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03005074 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02005075 /* There must be no pending incoming or outgoing data */
Gilles Peskine449bd832023-01-11 14:50:10 +01005076 if (mbedtls_ssl_check_pending(ssl) != 0) {
5077 MBEDTLS_SSL_DEBUG_MSG(1, ("There is pending incoming data"));
5078 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03005079 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005080 if (ssl->out_left != 0) {
5081 MBEDTLS_SSL_DEBUG_MSG(1, ("There is pending outgoing data"));
5082 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03005083 }
Dave Rodgman556e8a32022-12-06 16:31:25 +00005084 /* Protocol must be DTLS, not TLS */
Gilles Peskine449bd832023-01-11 14:50:10 +01005085 if (ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
5086 MBEDTLS_SSL_DEBUG_MSG(1, ("Only DTLS is supported"));
5087 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03005088 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02005089 /* Version must be 1.2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005090 if (ssl->tls_version != MBEDTLS_SSL_VERSION_TLS1_2) {
5091 MBEDTLS_SSL_DEBUG_MSG(1, ("Only version 1.2 supported"));
5092 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03005093 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02005094 /* We must be using an AEAD ciphersuite */
Gilles Peskine449bd832023-01-11 14:50:10 +01005095 if (mbedtls_ssl_transform_uses_aead(ssl->transform) != 1) {
5096 MBEDTLS_SSL_DEBUG_MSG(1, ("Only AEAD ciphersuites supported"));
5097 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03005098 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02005099 /* Renegotiation must not be enabled */
5100#if defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01005101 if (ssl->conf->disable_renegotiation != MBEDTLS_SSL_RENEGOTIATION_DISABLED) {
5102 MBEDTLS_SSL_DEBUG_MSG(1, ("Renegotiation must not be enabled"));
5103 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03005104 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02005105#endif
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005106
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005107 /*
5108 * Version and format identifier
5109 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005110 used += sizeof(ssl_serialized_context_header);
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005111
Gilles Peskine449bd832023-01-11 14:50:10 +01005112 if (used <= buf_len) {
5113 memcpy(p, ssl_serialized_context_header,
5114 sizeof(ssl_serialized_context_header));
5115 p += sizeof(ssl_serialized_context_header);
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005116 }
5117
5118 /*
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005119 * Session (length + data)
5120 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005121 ret = ssl_session_save(ssl->session, 1, NULL, 0, &session_len);
5122 if (ret != MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL) {
5123 return ret;
5124 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005125
5126 used += 4 + session_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01005127 if (used <= buf_len) {
5128 MBEDTLS_PUT_UINT32_BE(session_len, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01005129 p += 4;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005130
Gilles Peskine449bd832023-01-11 14:50:10 +01005131 ret = ssl_session_save(ssl->session, 1,
5132 p, session_len, &session_len);
5133 if (ret != 0) {
5134 return ret;
5135 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005136
5137 p += session_len;
5138 }
5139
5140 /*
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005141 * Transform
5142 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005143 used += sizeof(ssl->transform->randbytes);
5144 if (used <= buf_len) {
5145 memcpy(p, ssl->transform->randbytes,
5146 sizeof(ssl->transform->randbytes));
5147 p += sizeof(ssl->transform->randbytes);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005148 }
5149
5150#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Dave Rodgmanc37ad442023-11-03 23:36:06 +00005151 used += 2U + ssl->transform->in_cid_len + ssl->transform->out_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01005152 if (used <= buf_len) {
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005153 *p++ = ssl->transform->in_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01005154 memcpy(p, ssl->transform->in_cid, ssl->transform->in_cid_len);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005155 p += ssl->transform->in_cid_len;
5156
5157 *p++ = ssl->transform->out_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01005158 memcpy(p, ssl->transform->out_cid, ssl->transform->out_cid_len);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005159 p += ssl->transform->out_cid_len;
5160 }
5161#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
5162
5163 /*
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005164 * Saved fields from top-level ssl_context structure
5165 */
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005166 used += 4;
Gilles Peskine449bd832023-01-11 14:50:10 +01005167 if (used <= buf_len) {
5168 MBEDTLS_PUT_UINT32_BE(ssl->badmac_seen, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01005169 p += 4;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005170 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005171
5172#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
5173 used += 16;
Gilles Peskine449bd832023-01-11 14:50:10 +01005174 if (used <= buf_len) {
5175 MBEDTLS_PUT_UINT64_BE(ssl->in_window_top, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01005176 p += 8;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005177
Gilles Peskine449bd832023-01-11 14:50:10 +01005178 MBEDTLS_PUT_UINT64_BE(ssl->in_window, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01005179 p += 8;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005180 }
5181#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
5182
5183#if defined(MBEDTLS_SSL_PROTO_DTLS)
5184 used += 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01005185 if (used <= buf_len) {
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005186 *p++ = ssl->disable_datagram_packing;
5187 }
5188#endif /* MBEDTLS_SSL_PROTO_DTLS */
5189
Jerry Yuae0b2e22021-10-08 15:21:19 +08005190 used += MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Gilles Peskine449bd832023-01-11 14:50:10 +01005191 if (used <= buf_len) {
5192 memcpy(p, ssl->cur_out_ctr, MBEDTLS_SSL_SEQUENCE_NUMBER_LEN);
Jerry Yuae0b2e22021-10-08 15:21:19 +08005193 p += MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005194 }
5195
5196#if defined(MBEDTLS_SSL_PROTO_DTLS)
5197 used += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01005198 if (used <= buf_len) {
5199 MBEDTLS_PUT_UINT16_BE(ssl->mtu, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01005200 p += 2;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005201 }
5202#endif /* MBEDTLS_SSL_PROTO_DTLS */
5203
5204#if defined(MBEDTLS_SSL_ALPN)
5205 {
5206 const uint8_t alpn_len = ssl->alpn_chosen
Gilles Peskine449bd832023-01-11 14:50:10 +01005207 ? (uint8_t) strlen(ssl->alpn_chosen)
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005208 : 0;
5209
5210 used += 1 + alpn_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01005211 if (used <= buf_len) {
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005212 *p++ = alpn_len;
5213
Gilles Peskine449bd832023-01-11 14:50:10 +01005214 if (ssl->alpn_chosen != NULL) {
5215 memcpy(p, ssl->alpn_chosen, alpn_len);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005216 p += alpn_len;
5217 }
5218 }
5219 }
5220#endif /* MBEDTLS_SSL_ALPN */
5221
5222 /*
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005223 * Done
5224 */
5225 *olen = used;
5226
Gilles Peskine449bd832023-01-11 14:50:10 +01005227 if (used > buf_len) {
5228 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
5229 }
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005230
Gilles Peskine449bd832023-01-11 14:50:10 +01005231 MBEDTLS_SSL_DEBUG_BUF(4, "saved context", buf, used);
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005232
Gilles Peskine449bd832023-01-11 14:50:10 +01005233 return mbedtls_ssl_session_reset_int(ssl, 0);
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005234}
5235
5236/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02005237 * Deserialize context, see mbedtls_ssl_context_save() for format.
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005238 *
5239 * This internal version is wrapped by a public function that cleans up in
5240 * case of error.
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005241 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005242MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01005243static int ssl_context_load(mbedtls_ssl_context *ssl,
5244 const unsigned char *buf,
5245 size_t len)
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005246{
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005247 const unsigned char *p = buf;
5248 const unsigned char * const end = buf + len;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005249 size_t session_len;
Janos Follath865b3eb2019-12-16 11:46:15 +00005250 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04005251#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Andrzej Kurek894edde2022-09-29 06:31:14 -04005252 tls_prf_fn prf_func = NULL;
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04005253#endif
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005254
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02005255 /*
5256 * The context should have been freshly setup or reset.
5257 * Give the user an error in case of obvious misuse.
Manuel Pégourié-Gonnard4ca930f2019-07-26 16:31:53 +02005258 * (Checking session is useful because it won't be NULL if we're
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02005259 * renegotiating, or if the user mistakenly loaded a session first.)
5260 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005261 if (ssl->state != MBEDTLS_SSL_HELLO_REQUEST ||
5262 ssl->session != NULL) {
5263 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02005264 }
5265
5266 /*
5267 * We can't check that the config matches the initial one, but we can at
5268 * least check it matches the requirements for serializing.
5269 */
Dave Rodgmane99b24d2023-09-14 15:45:03 +01005270 if (
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02005271#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard9a96fd72019-07-23 17:11:24 +02005272 ssl->conf->disable_renegotiation != MBEDTLS_SSL_RENEGOTIATION_DISABLED ||
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02005273#endif
Dave Rodgmane99b24d2023-09-14 15:45:03 +01005274 ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM ||
5275 ssl->conf->max_tls_version < MBEDTLS_SSL_VERSION_TLS1_2 ||
5276 ssl->conf->min_tls_version > MBEDTLS_SSL_VERSION_TLS1_2
5277 ) {
Gilles Peskine449bd832023-01-11 14:50:10 +01005278 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02005279 }
5280
Gilles Peskine449bd832023-01-11 14:50:10 +01005281 MBEDTLS_SSL_DEBUG_BUF(4, "context to load", buf, len);
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005282
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005283 /*
5284 * Check version identifier
5285 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005286 if ((size_t) (end - p) < sizeof(ssl_serialized_context_header)) {
5287 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005288 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005289
5290 if (memcmp(p, ssl_serialized_context_header,
5291 sizeof(ssl_serialized_context_header)) != 0) {
5292 return MBEDTLS_ERR_SSL_VERSION_MISMATCH;
5293 }
5294 p += sizeof(ssl_serialized_context_header);
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005295
5296 /*
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005297 * Session
5298 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005299 if ((size_t) (end - p) < 4) {
5300 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5301 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005302
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01005303 session_len = MBEDTLS_GET_UINT32_BE(p, 0);
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005304 p += 4;
5305
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02005306 /* This has been allocated by ssl_handshake_init(), called by
Hanno Becker43aefe22020-02-05 10:44:56 +00005307 * by either mbedtls_ssl_session_reset_int() or mbedtls_ssl_setup(). */
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02005308 ssl->session = ssl->session_negotiate;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005309 ssl->session_in = ssl->session;
5310 ssl->session_out = ssl->session;
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02005311 ssl->session_negotiate = NULL;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005312
Gilles Peskine449bd832023-01-11 14:50:10 +01005313 if ((size_t) (end - p) < session_len) {
5314 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5315 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005316
Gilles Peskine449bd832023-01-11 14:50:10 +01005317 ret = ssl_session_load(ssl->session, 1, p, session_len);
5318 if (ret != 0) {
5319 mbedtls_ssl_session_free(ssl->session);
5320 return ret;
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02005321 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005322
5323 p += session_len;
5324
5325 /*
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005326 * Transform
5327 */
5328
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02005329 /* This has been allocated by ssl_handshake_init(), called by
Hanno Becker43aefe22020-02-05 10:44:56 +00005330 * by either mbedtls_ssl_session_reset_int() or mbedtls_ssl_setup(). */
Jerry Yu2e199812022-12-01 18:57:19 +08005331#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02005332 ssl->transform = ssl->transform_negotiate;
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005333 ssl->transform_in = ssl->transform;
5334 ssl->transform_out = ssl->transform;
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02005335 ssl->transform_negotiate = NULL;
Jerry Yu2e199812022-12-01 18:57:19 +08005336#endif
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005337
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04005338#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005339 prf_func = ssl_tls12prf_from_cs(ssl->session->ciphersuite);
5340 if (prf_func == NULL) {
5341 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5342 }
Andrzej Kurek894edde2022-09-29 06:31:14 -04005343
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005344 /* Read random bytes and populate structure */
Gilles Peskine449bd832023-01-11 14:50:10 +01005345 if ((size_t) (end - p) < sizeof(ssl->transform->randbytes)) {
5346 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5347 }
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04005348
Gilles Peskine449bd832023-01-11 14:50:10 +01005349 ret = ssl_tls12_populate_transform(ssl->transform,
5350 ssl->session->ciphersuite,
5351 ssl->session->master,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02005352#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01005353 ssl->session->encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02005354#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01005355 prf_func,
5356 p, /* currently pointing to randbytes */
5357 MBEDTLS_SSL_VERSION_TLS1_2, /* (D)TLS 1.2 is forced */
5358 ssl->conf->endpoint,
5359 ssl);
5360 if (ret != 0) {
5361 return ret;
5362 }
Jerry Yu840fbb22022-02-17 14:59:29 +08005363#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005364 p += sizeof(ssl->transform->randbytes);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005365
5366#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
5367 /* Read connection IDs and store them */
Gilles Peskine449bd832023-01-11 14:50:10 +01005368 if ((size_t) (end - p) < 1) {
5369 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5370 }
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005371
5372 ssl->transform->in_cid_len = *p++;
5373
Gilles Peskine449bd832023-01-11 14:50:10 +01005374 if ((size_t) (end - p) < ssl->transform->in_cid_len + 1u) {
5375 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5376 }
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005377
Gilles Peskine449bd832023-01-11 14:50:10 +01005378 memcpy(ssl->transform->in_cid, p, ssl->transform->in_cid_len);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005379 p += ssl->transform->in_cid_len;
5380
5381 ssl->transform->out_cid_len = *p++;
5382
Gilles Peskine449bd832023-01-11 14:50:10 +01005383 if ((size_t) (end - p) < ssl->transform->out_cid_len) {
5384 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5385 }
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005386
Gilles Peskine449bd832023-01-11 14:50:10 +01005387 memcpy(ssl->transform->out_cid, p, ssl->transform->out_cid_len);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005388 p += ssl->transform->out_cid_len;
5389#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
5390
5391 /*
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005392 * Saved fields from top-level ssl_context structure
5393 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005394 if ((size_t) (end - p) < 4) {
5395 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5396 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005397
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01005398 ssl->badmac_seen = MBEDTLS_GET_UINT32_BE(p, 0);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005399 p += 4;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005400
5401#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Gilles Peskine449bd832023-01-11 14:50:10 +01005402 if ((size_t) (end - p) < 16) {
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->in_window_top = MBEDTLS_GET_UINT64_BE(p, 0);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005407 p += 8;
5408
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01005409 ssl->in_window = MBEDTLS_GET_UINT64_BE(p, 0);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005410 p += 8;
5411#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
5412
5413#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005414 if ((size_t) (end - p) < 1) {
5415 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5416 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005417
5418 ssl->disable_datagram_packing = *p++;
5419#endif /* MBEDTLS_SSL_PROTO_DTLS */
5420
Gilles Peskine449bd832023-01-11 14:50:10 +01005421 if ((size_t) (end - p) < sizeof(ssl->cur_out_ctr)) {
5422 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5423 }
5424 memcpy(ssl->cur_out_ctr, p, sizeof(ssl->cur_out_ctr));
5425 p += sizeof(ssl->cur_out_ctr);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005426
5427#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005428 if ((size_t) (end - p) < 2) {
5429 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5430 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005431
Dave Rodgmana3d0f612023-11-03 23:34:02 +00005432 ssl->mtu = MBEDTLS_GET_UINT16_BE(p, 0);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005433 p += 2;
5434#endif /* MBEDTLS_SSL_PROTO_DTLS */
5435
5436#if defined(MBEDTLS_SSL_ALPN)
5437 {
5438 uint8_t alpn_len;
5439 const char **cur;
5440
Gilles Peskine449bd832023-01-11 14:50:10 +01005441 if ((size_t) (end - p) < 1) {
5442 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5443 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005444
5445 alpn_len = *p++;
5446
Gilles Peskine449bd832023-01-11 14:50:10 +01005447 if (alpn_len != 0 && ssl->conf->alpn_list != NULL) {
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005448 /* alpn_chosen should point to an item in the configured list */
Gilles Peskine449bd832023-01-11 14:50:10 +01005449 for (cur = ssl->conf->alpn_list; *cur != NULL; cur++) {
5450 if (strlen(*cur) == alpn_len &&
Waleed Elmelegy131b2ff2024-03-14 01:39:39 +00005451 memcmp(p, *cur, alpn_len) == 0) {
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005452 ssl->alpn_chosen = *cur;
5453 break;
5454 }
5455 }
5456 }
5457
5458 /* can only happen on conf mismatch */
Gilles Peskine449bd832023-01-11 14:50:10 +01005459 if (alpn_len != 0 && ssl->alpn_chosen == NULL) {
5460 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5461 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005462
5463 p += alpn_len;
5464 }
5465#endif /* MBEDTLS_SSL_ALPN */
5466
5467 /*
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02005468 * Forced fields from top-level ssl_context structure
5469 *
5470 * Most of them already set to the correct value by mbedtls_ssl_init() and
5471 * mbedtls_ssl_reset(), so we only need to set the remaining ones.
5472 */
5473 ssl->state = MBEDTLS_SSL_HANDSHAKE_OVER;
Glenn Strauss60bfe602022-03-14 19:04:24 -04005474 ssl->tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02005475
Hanno Becker361b10d2019-08-30 10:42:49 +01005476 /* Adjust pointers for header fields of outgoing records to
5477 * the given transform, accounting for explicit IV and CID. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005478 mbedtls_ssl_update_out_pointers(ssl, ssl->transform);
Hanno Becker361b10d2019-08-30 10:42:49 +01005479
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02005480#if defined(MBEDTLS_SSL_PROTO_DTLS)
5481 ssl->in_epoch = 1;
5482#endif
5483
5484 /* mbedtls_ssl_reset() leaves the handshake sub-structure allocated,
5485 * which we don't want - otherwise we'd end up freeing the wrong transform
Hanno Beckerce5f5fd2020-02-05 10:47:44 +00005486 * by calling mbedtls_ssl_handshake_wrapup_free_hs_transform()
5487 * inappropriately. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005488 if (ssl->handshake != NULL) {
5489 mbedtls_ssl_handshake_free(ssl);
5490 mbedtls_free(ssl->handshake);
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02005491 ssl->handshake = NULL;
5492 }
5493
5494 /*
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005495 * Done - should have consumed entire buffer
5496 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005497 if (p != end) {
5498 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5499 }
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005500
Gilles Peskine449bd832023-01-11 14:50:10 +01005501 return 0;
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005502}
5503
5504/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02005505 * Deserialize context: public wrapper for error cleaning
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005506 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005507int mbedtls_ssl_context_load(mbedtls_ssl_context *context,
5508 const unsigned char *buf,
5509 size_t len)
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005510{
Gilles Peskine449bd832023-01-11 14:50:10 +01005511 int ret = ssl_context_load(context, buf, len);
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005512
Gilles Peskine449bd832023-01-11 14:50:10 +01005513 if (ret != 0) {
5514 mbedtls_ssl_free(context);
5515 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005516
Gilles Peskine449bd832023-01-11 14:50:10 +01005517 return ret;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005518}
Manuel Pégourié-Gonnard5c0e3772019-07-23 16:13:17 +02005519#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005520
5521/*
Paul Bakker5121ce52009-01-03 21:22:43 +00005522 * Free an SSL context
5523 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005524void mbedtls_ssl_free(mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00005525{
Gilles Peskine449bd832023-01-11 14:50:10 +01005526 if (ssl == NULL) {
Paul Bakkeraccaffe2014-06-26 13:37:14 +02005527 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01005528 }
Paul Bakkeraccaffe2014-06-26 13:37:14 +02005529
Gilles Peskine449bd832023-01-11 14:50:10 +01005530 MBEDTLS_SSL_DEBUG_MSG(2, ("=> free"));
Paul Bakker5121ce52009-01-03 21:22:43 +00005531
Gilles Peskine449bd832023-01-11 14:50:10 +01005532 if (ssl->out_buf != NULL) {
sander-visserb8aa2072020-05-06 22:05:13 +02005533#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
5534 size_t out_buf_len = ssl->out_buf_len;
5535#else
5536 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
5537#endif
5538
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005539 mbedtls_zeroize_and_free(ssl->out_buf, out_buf_len);
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05005540 ssl->out_buf = NULL;
Paul Bakker5121ce52009-01-03 21:22:43 +00005541 }
5542
Gilles Peskine449bd832023-01-11 14:50:10 +01005543 if (ssl->in_buf != NULL) {
sander-visserb8aa2072020-05-06 22:05:13 +02005544#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
5545 size_t in_buf_len = ssl->in_buf_len;
5546#else
5547 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
5548#endif
5549
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005550 mbedtls_zeroize_and_free(ssl->in_buf, in_buf_len);
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05005551 ssl->in_buf = NULL;
Paul Bakker5121ce52009-01-03 21:22:43 +00005552 }
5553
Gilles Peskine449bd832023-01-11 14:50:10 +01005554 if (ssl->transform) {
5555 mbedtls_ssl_transform_free(ssl->transform);
5556 mbedtls_free(ssl->transform);
Paul Bakker48916f92012-09-16 19:57:18 +00005557 }
5558
Gilles Peskine449bd832023-01-11 14:50:10 +01005559 if (ssl->handshake) {
5560 mbedtls_ssl_handshake_free(ssl);
5561 mbedtls_free(ssl->handshake);
Jerry Yu2e199812022-12-01 18:57:19 +08005562
5563#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005564 mbedtls_ssl_transform_free(ssl->transform_negotiate);
5565 mbedtls_free(ssl->transform_negotiate);
Jerry Yu2e199812022-12-01 18:57:19 +08005566#endif
5567
Gilles Peskine449bd832023-01-11 14:50:10 +01005568 mbedtls_ssl_session_free(ssl->session_negotiate);
5569 mbedtls_free(ssl->session_negotiate);
Paul Bakker48916f92012-09-16 19:57:18 +00005570 }
5571
Ronald Cron6f135e12021-12-08 16:57:54 +01005572#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01005573 mbedtls_ssl_transform_free(ssl->transform_application);
5574 mbedtls_free(ssl->transform_application);
Ronald Cron6f135e12021-12-08 16:57:54 +01005575#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker3aa186f2021-08-10 09:24:19 +01005576
Gilles Peskine449bd832023-01-11 14:50:10 +01005577 if (ssl->session) {
5578 mbedtls_ssl_session_free(ssl->session);
5579 mbedtls_free(ssl->session);
Paul Bakkerc0463502013-02-14 11:19:38 +01005580 }
5581
Manuel Pégourié-Gonnard55fab2d2015-05-11 16:15:19 +02005582#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005583 if (ssl->hostname != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005584 mbedtls_zeroize_and_free(ssl->hostname, strlen(ssl->hostname));
Paul Bakker5121ce52009-01-03 21:22:43 +00005585 }
Paul Bakker0be444a2013-08-27 21:55:01 +02005586#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00005587
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02005588#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005589 mbedtls_free(ssl->cli_id);
Manuel Pégourié-Gonnard43c02182014-07-22 17:32:01 +02005590#endif
5591
Gilles Peskine449bd832023-01-11 14:50:10 +01005592 MBEDTLS_SSL_DEBUG_MSG(2, ("<= free"));
Paul Bakker2da561c2009-02-05 18:00:28 +00005593
Paul Bakker86f04f42013-02-14 11:20:09 +01005594 /* Actually clear after last debug message */
Gilles Peskine449bd832023-01-11 14:50:10 +01005595 mbedtls_platform_zeroize(ssl, sizeof(mbedtls_ssl_context));
Paul Bakker5121ce52009-01-03 21:22:43 +00005596}
5597
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005598/*
Shaun Case8b0ecbc2021-12-20 21:14:10 -08005599 * Initialize mbedtls_ssl_config
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005600 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005601void mbedtls_ssl_config_init(mbedtls_ssl_config *conf)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005602{
Gilles Peskine449bd832023-01-11 14:50:10 +01005603 memset(conf, 0, sizeof(mbedtls_ssl_config));
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005604}
5605
Gilles Peskineae270bf2021-06-02 00:05:29 +02005606/* The selection should be the same as mbedtls_x509_crt_profile_default in
5607 * x509_crt.c, plus Montgomery curves for ECDHE. Here, the order matters:
Gilles Peskineb1940a72021-06-02 15:18:12 +02005608 * curves with a lower resource usage come first.
Gilles Peskineae270bf2021-06-02 00:05:29 +02005609 * See the documentation of mbedtls_ssl_conf_curves() for what we promise
Gilles Peskineb1940a72021-06-02 15:18:12 +02005610 * about this list.
5611 */
Chien Wong4e9683e2023-12-28 17:07:43 +08005612static const uint16_t ssl_preset_default_groups[] = {
Valerio Settidb6b4db2023-09-01 09:20:51 +02005613#if defined(MBEDTLS_ECP_HAVE_CURVE25519)
Brett Warrene0edc842021-08-17 09:53:13 +01005614 MBEDTLS_SSL_IANA_TLS_GROUP_X25519,
Gilles Peskineae270bf2021-06-02 00:05:29 +02005615#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005616#if defined(MBEDTLS_ECP_HAVE_SECP256R1)
Brett Warrene0edc842021-08-17 09:53:13 +01005617 MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1,
Gilles Peskineae270bf2021-06-02 00:05:29 +02005618#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005619#if defined(MBEDTLS_ECP_HAVE_SECP384R1)
Brett Warrene0edc842021-08-17 09:53:13 +01005620 MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02005621#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005622#if defined(MBEDTLS_ECP_HAVE_CURVE448)
Brett Warrene0edc842021-08-17 09:53:13 +01005623 MBEDTLS_SSL_IANA_TLS_GROUP_X448,
Gilles Peskineb1940a72021-06-02 15:18:12 +02005624#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005625#if defined(MBEDTLS_ECP_HAVE_SECP521R1)
Brett Warrene0edc842021-08-17 09:53:13 +01005626 MBEDTLS_SSL_IANA_TLS_GROUP_SECP521R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02005627#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005628#if defined(MBEDTLS_ECP_HAVE_BP256R1)
Brett Warrene0edc842021-08-17 09:53:13 +01005629 MBEDTLS_SSL_IANA_TLS_GROUP_BP256R1,
Gilles Peskineae270bf2021-06-02 00:05:29 +02005630#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005631#if defined(MBEDTLS_ECP_HAVE_BP384R1)
Brett Warrene0edc842021-08-17 09:53:13 +01005632 MBEDTLS_SSL_IANA_TLS_GROUP_BP384R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02005633#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005634#if defined(MBEDTLS_ECP_HAVE_BP512R1)
Brett Warrene0edc842021-08-17 09:53:13 +01005635 MBEDTLS_SSL_IANA_TLS_GROUP_BP512R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02005636#endif
Przemek Stekiel316c19e2023-05-31 15:25:11 +02005637#if defined(PSA_WANT_ALG_FFDH)
Przemek Stekiel383f4712022-12-12 14:48:57 +01005638 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE2048,
5639 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE3072,
5640 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE4096,
5641 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE6144,
5642 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE8192,
5643#endif
Brett Warrene0edc842021-08-17 09:53:13 +01005644 MBEDTLS_SSL_IANA_TLS_GROUP_NONE
Gilles Peskineae270bf2021-06-02 00:05:29 +02005645};
Gilles Peskineae270bf2021-06-02 00:05:29 +02005646
Alexey Tsvetkov2ca34372022-06-07 10:21:05 +03005647static const int ssl_preset_suiteb_ciphersuites[] = {
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005648 MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256,
5649 MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384,
5650 0
5651};
5652
Ronald Crone68ab4f2022-10-05 12:46:29 +02005653#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Hanno Becker9c6aa7b2021-08-10 13:50:43 +01005654
Jerry Yu909df7b2022-01-22 11:56:27 +08005655/* NOTICE:
Jerry Yu0b994b82022-01-25 17:22:12 +08005656 * For ssl_preset_*_sig_algs and ssl_tls12_preset_*_sig_algs, the following
Jerry Yu370e1462022-01-25 10:36:53 +08005657 * rules SHOULD be upheld.
5658 * - No duplicate entries.
5659 * - But if there is a good reason, do not change the order of the algorithms.
Jerry Yu09a99fc2022-07-28 14:22:17 +08005660 * - ssl_tls12_preset* is for TLS 1.2 use only.
Jerry Yu370e1462022-01-25 10:36:53 +08005661 * - ssl_preset_* is for TLS 1.3 only or hybrid TLS 1.3/1.2 handshakes.
Jerry Yu1a8b4812022-01-20 17:56:50 +08005662 */
Chien Wong4e9683e2023-12-28 17:07:43 +08005663static const uint16_t ssl_preset_default_sig_algs[] = {
Jerry Yu1a8b4812022-01-20 17:56:50 +08005664
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005665#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005666 defined(MBEDTLS_MD_CAN_SHA256) && \
Valerio Setticf29c5d2023-09-01 09:03:41 +02005667 defined(PSA_WANT_ECC_SECP_R1_256)
Jerry Yued5e9f42022-01-26 11:21:34 +08005668 MBEDTLS_TLS1_3_SIG_ECDSA_SECP256R1_SHA256,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005669 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256)
5670#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08005671
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005672#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005673 defined(MBEDTLS_MD_CAN_SHA384) && \
Valerio Setticf29c5d2023-09-01 09:03:41 +02005674 defined(PSA_WANT_ECC_SECP_R1_384)
Jerry Yu909df7b2022-01-22 11:56:27 +08005675 MBEDTLS_TLS1_3_SIG_ECDSA_SECP384R1_SHA384,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005676 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384)
5677#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08005678
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005679#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005680 defined(MBEDTLS_MD_CAN_SHA512) && \
Valerio Setticf29c5d2023-09-01 09:03:41 +02005681 defined(PSA_WANT_ECC_SECP_R1_521)
Jerry Yued5e9f42022-01-26 11:21:34 +08005682 MBEDTLS_TLS1_3_SIG_ECDSA_SECP521R1_SHA512,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005683 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA512)
5684#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08005685
Yanray Wang1136fad2023-11-22 16:54:31 +08005686#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && defined(MBEDTLS_MD_CAN_SHA512)
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005687 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA512,
Yanray Wang1136fad2023-11-22 16:54:31 +08005688#endif
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005689
Yanray Wang1136fad2023-11-22 16:54:31 +08005690#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && defined(MBEDTLS_MD_CAN_SHA384)
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005691 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA384,
Yanray Wang1136fad2023-11-22 16:54:31 +08005692#endif
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005693
Yanray Wang1136fad2023-11-22 16:54:31 +08005694#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && defined(MBEDTLS_MD_CAN_SHA256)
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005695 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256,
Yanray Wang1136fad2023-11-22 16:54:31 +08005696#endif
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005697
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005698#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_MD_CAN_SHA512)
Jerry Yu693a47a2022-06-23 14:02:28 +08005699 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA512,
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005700#endif /* MBEDTLS_RSA_C && MBEDTLS_MD_CAN_SHA512 */
Jerry Yu693a47a2022-06-23 14:02:28 +08005701
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005702#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_MD_CAN_SHA384)
Jerry Yu693a47a2022-06-23 14:02:28 +08005703 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA384,
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005704#endif /* MBEDTLS_RSA_C && MBEDTLS_MD_CAN_SHA384 */
Jerry Yu693a47a2022-06-23 14:02:28 +08005705
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005706#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_MD_CAN_SHA256)
Jerry Yu693a47a2022-06-23 14:02:28 +08005707 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA256,
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005708#endif /* MBEDTLS_RSA_C && MBEDTLS_MD_CAN_SHA256 */
Jerry Yu693a47a2022-06-23 14:02:28 +08005709
Gabor Mezei15b95a62022-05-09 16:37:58 +02005710 MBEDTLS_TLS_SIG_NONE
Jerry Yu909df7b2022-01-22 11:56:27 +08005711};
5712
5713/* NOTICE: see above */
5714#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
5715static uint16_t ssl_tls12_preset_default_sig_algs[] = {
Yanray Wang1136fad2023-11-22 16:54:31 +08005716
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005717#if defined(MBEDTLS_MD_CAN_SHA512)
Valerio Settie9646ec2023-08-02 20:02:28 +02005718#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005719 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA512),
Jerry Yu713013f2022-01-17 18:16:35 +08005720#endif
Jerry Yu09a99fc2022-07-28 14:22:17 +08005721#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT)
5722 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA512,
Yanray Wang1136fad2023-11-22 16:54:31 +08005723#endif
Gabor Mezeic1051b62022-05-10 13:13:58 +02005724#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005725 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA512),
Gabor Mezeic1051b62022-05-10 13:13:58 +02005726#endif
Yanray Wang1136fad2023-11-22 16:54:31 +08005727#endif /* MBEDTLS_MD_CAN_SHA512 */
5728
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005729#if defined(MBEDTLS_MD_CAN_SHA384)
Valerio Settie9646ec2023-08-02 20:02:28 +02005730#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005731 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384),
Jerry Yu11f0a9c2022-01-12 18:43:08 +08005732#endif
Jerry Yu09a99fc2022-07-28 14:22:17 +08005733#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT)
5734 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA384,
Yanray Wang1136fad2023-11-22 16:54:31 +08005735#endif
Gabor Mezeic1051b62022-05-10 13:13:58 +02005736#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005737 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA384),
Gabor Mezeic1051b62022-05-10 13:13:58 +02005738#endif
Yanray Wang1136fad2023-11-22 16:54:31 +08005739#endif /* MBEDTLS_MD_CAN_SHA384 */
5740
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005741#if defined(MBEDTLS_MD_CAN_SHA256)
Valerio Settie9646ec2023-08-02 20:02:28 +02005742#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005743 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256),
Jerry Yu11f0a9c2022-01-12 18:43:08 +08005744#endif
Jerry Yu09a99fc2022-07-28 14:22:17 +08005745#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT)
5746 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256,
Yanray Wang1136fad2023-11-22 16:54:31 +08005747#endif
Gabor Mezeic1051b62022-05-10 13:13:58 +02005748#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005749 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA256),
Gabor Mezeic1051b62022-05-10 13:13:58 +02005750#endif
Yanray Wang1136fad2023-11-22 16:54:31 +08005751#endif /* MBEDTLS_MD_CAN_SHA256 */
5752
Gabor Mezei15b95a62022-05-09 16:37:58 +02005753 MBEDTLS_TLS_SIG_NONE
Jerry Yu909df7b2022-01-22 11:56:27 +08005754};
5755#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Yanray Wang1136fad2023-11-22 16:54:31 +08005756
Jerry Yu909df7b2022-01-22 11:56:27 +08005757/* NOTICE: see above */
Chien Wong4e9683e2023-12-28 17:07:43 +08005758static const uint16_t ssl_preset_suiteb_sig_algs[] = {
Jerry Yu909df7b2022-01-22 11:56:27 +08005759
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005760#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Valerio Setti45d56f32023-07-13 17:23:20 +02005761 defined(MBEDTLS_MD_CAN_SHA256) && \
Valerio Settidb6b4db2023-09-01 09:20:51 +02005762 defined(MBEDTLS_ECP_HAVE_SECP256R1)
Jerry Yu909df7b2022-01-22 11:56:27 +08005763 MBEDTLS_TLS1_3_SIG_ECDSA_SECP256R1_SHA256,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005764 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256)
5765#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08005766
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005767#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Valerio Setti45d56f32023-07-13 17:23:20 +02005768 defined(MBEDTLS_MD_CAN_SHA384) && \
Valerio Settidb6b4db2023-09-01 09:20:51 +02005769 defined(MBEDTLS_ECP_HAVE_SECP384R1)
Jerry Yu53037892022-01-25 11:02:06 +08005770 MBEDTLS_TLS1_3_SIG_ECDSA_SECP384R1_SHA384,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005771 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384)
5772#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08005773
Gabor Mezei15b95a62022-05-09 16:37:58 +02005774 MBEDTLS_TLS_SIG_NONE
Jerry Yu713013f2022-01-17 18:16:35 +08005775};
Jerry Yu6106fdc2022-01-12 16:36:14 +08005776
Jerry Yu909df7b2022-01-22 11:56:27 +08005777/* NOTICE: see above */
5778#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
5779static uint16_t ssl_tls12_preset_suiteb_sig_algs[] = {
Yanray Wang1136fad2023-11-22 16:54:31 +08005780
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005781#if defined(MBEDTLS_MD_CAN_SHA256)
Valerio Settie9646ec2023-08-02 20:02:28 +02005782#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005783 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256),
Jerry Yu713013f2022-01-17 18:16:35 +08005784#endif
Yanray Wang1136fad2023-11-22 16:54:31 +08005785#endif /* MBEDTLS_MD_CAN_SHA256 */
Yanray Wang69ceb392023-11-22 16:32:39 +08005786
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005787#if defined(MBEDTLS_MD_CAN_SHA384)
Valerio Settie9646ec2023-08-02 20:02:28 +02005788#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005789 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384),
Jerry Yu18c833e2022-01-25 10:55:47 +08005790#endif
Yanray Wang1136fad2023-11-22 16:54:31 +08005791#endif /* MBEDTLS_MD_CAN_SHA384 */
5792
Gabor Mezei15b95a62022-05-09 16:37:58 +02005793 MBEDTLS_TLS_SIG_NONE
Hanno Becker9c6aa7b2021-08-10 13:50:43 +01005794};
Jerry Yu909df7b2022-01-22 11:56:27 +08005795#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
5796
Ronald Crone68ab4f2022-10-05 12:46:29 +02005797#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005798
Chien Wong4e9683e2023-12-28 17:07:43 +08005799static const uint16_t ssl_preset_suiteb_groups[] = {
Valerio Settidb6b4db2023-09-01 09:20:51 +02005800#if defined(MBEDTLS_ECP_HAVE_SECP256R1)
Brett Warrene0edc842021-08-17 09:53:13 +01005801 MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1,
Jaeden Amerod4311042019-06-03 08:27:16 +01005802#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005803#if defined(MBEDTLS_ECP_HAVE_SECP384R1)
Brett Warrene0edc842021-08-17 09:53:13 +01005804 MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1,
Jaeden Amerod4311042019-06-03 08:27:16 +01005805#endif
Brett Warrene0edc842021-08-17 09:53:13 +01005806 MBEDTLS_SSL_IANA_TLS_GROUP_NONE
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005807};
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005808
Ronald Crone68ab4f2022-10-05 12:46:29 +02005809#if defined(MBEDTLS_DEBUG_C) && defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu909df7b2022-01-22 11:56:27 +08005810/* Function for checking `ssl_preset_*_sig_algs` and `ssl_tls12_preset_*_sig_algs`
Jerry Yu370e1462022-01-25 10:36:53 +08005811 * to make sure there are no duplicated signature algorithm entries. */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005812MBEDTLS_CHECK_RETURN_CRITICAL
Chien Wong4e9683e2023-12-28 17:07:43 +08005813static int ssl_check_no_sig_alg_duplication(const uint16_t *sig_algs)
Jerry Yu1a8b4812022-01-20 17:56:50 +08005814{
5815 size_t i, j;
5816 int ret = 0;
Jerry Yu909df7b2022-01-22 11:56:27 +08005817
Gilles Peskine449bd832023-01-11 14:50:10 +01005818 for (i = 0; sig_algs[i] != MBEDTLS_TLS_SIG_NONE; i++) {
5819 for (j = 0; j < i; j++) {
5820 if (sig_algs[i] != sig_algs[j]) {
Jerry Yuf377d642022-01-25 10:43:59 +08005821 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01005822 }
5823 mbedtls_printf(" entry(%04x,%" MBEDTLS_PRINTF_SIZET
5824 ") is duplicated at %" MBEDTLS_PRINTF_SIZET "\n",
5825 sig_algs[i], j, i);
Jerry Yuf377d642022-01-25 10:43:59 +08005826 ret = -1;
Jerry Yu1a8b4812022-01-20 17:56:50 +08005827 }
5828 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005829 return ret;
Jerry Yu1a8b4812022-01-20 17:56:50 +08005830}
5831
Ronald Crone68ab4f2022-10-05 12:46:29 +02005832#endif /* MBEDTLS_DEBUG_C && MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Jerry Yu1a8b4812022-01-20 17:56:50 +08005833
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005834/*
Tillmann Karras588ad502015-09-25 04:27:22 +02005835 * Load default in mbedtls_ssl_config
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005836 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005837int mbedtls_ssl_config_defaults(mbedtls_ssl_config *conf,
5838 int endpoint, int transport, int preset)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005839{
Manuel Pégourié-Gonnard8b431fb2015-05-11 12:54:52 +02005840#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Janos Follath865b3eb2019-12-16 11:46:15 +00005841 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard8b431fb2015-05-11 12:54:52 +02005842#endif
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005843
Ronald Crone68ab4f2022-10-05 12:46:29 +02005844#if defined(MBEDTLS_DEBUG_C) && defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005845 if (ssl_check_no_sig_alg_duplication(ssl_preset_suiteb_sig_algs)) {
5846 mbedtls_printf("ssl_preset_suiteb_sig_algs has duplicated entries\n");
5847 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu1a8b4812022-01-20 17:56:50 +08005848 }
5849
Gilles Peskine449bd832023-01-11 14:50:10 +01005850 if (ssl_check_no_sig_alg_duplication(ssl_preset_default_sig_algs)) {
5851 mbedtls_printf("ssl_preset_default_sig_algs has duplicated entries\n");
5852 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu1a8b4812022-01-20 17:56:50 +08005853 }
Jerry Yu909df7b2022-01-22 11:56:27 +08005854
5855#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005856 if (ssl_check_no_sig_alg_duplication(ssl_tls12_preset_suiteb_sig_algs)) {
5857 mbedtls_printf("ssl_tls12_preset_suiteb_sig_algs has duplicated entries\n");
5858 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu909df7b2022-01-22 11:56:27 +08005859 }
5860
Gilles Peskine449bd832023-01-11 14:50:10 +01005861 if (ssl_check_no_sig_alg_duplication(ssl_tls12_preset_default_sig_algs)) {
5862 mbedtls_printf("ssl_tls12_preset_default_sig_algs has duplicated entries\n");
5863 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu909df7b2022-01-22 11:56:27 +08005864 }
5865#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Ronald Crone68ab4f2022-10-05 12:46:29 +02005866#endif /* MBEDTLS_DEBUG_C && MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Jerry Yu1a8b4812022-01-20 17:56:50 +08005867
Manuel Pégourié-Gonnard0de074f2015-05-14 12:58:01 +02005868 /* Use the functions here so that they are covered in tests,
5869 * but otherwise access member directly for efficiency */
Gilles Peskine449bd832023-01-11 14:50:10 +01005870 mbedtls_ssl_conf_endpoint(conf, endpoint);
5871 mbedtls_ssl_conf_transport(conf, transport);
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005872
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005873 /*
5874 * Things that are common to all presets
5875 */
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02005876#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005877 if (endpoint == MBEDTLS_SSL_IS_CLIENT) {
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02005878 conf->authmode = MBEDTLS_SSL_VERIFY_REQUIRED;
5879#if defined(MBEDTLS_SSL_SESSION_TICKETS)
5880 conf->session_tickets = MBEDTLS_SSL_SESSION_TICKETS_ENABLED;
5881#endif
5882 }
5883#endif
5884
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005885#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
5886 conf->encrypt_then_mac = MBEDTLS_SSL_ETM_ENABLED;
5887#endif
5888
5889#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
5890 conf->extended_ms = MBEDTLS_SSL_EXTENDED_MS_ENABLED;
5891#endif
5892
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02005893#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005894 conf->f_cookie_write = ssl_cookie_write_dummy;
5895 conf->f_cookie_check = ssl_cookie_check_dummy;
5896#endif
5897
5898#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
5899 conf->anti_replay = MBEDTLS_SSL_ANTI_REPLAY_ENABLED;
5900#endif
5901
Janos Follath088ce432017-04-10 12:42:31 +01005902#if defined(MBEDTLS_SSL_SRV_C)
5903 conf->cert_req_ca_list = MBEDTLS_SSL_CERT_REQ_CA_LIST_ENABLED;
TRodziewicz3946f792021-06-14 12:11:18 +02005904 conf->respect_cli_pref = MBEDTLS_SSL_SRV_CIPHERSUITE_ORDER_SERVER;
Janos Follath088ce432017-04-10 12:42:31 +01005905#endif
5906
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005907#if defined(MBEDTLS_SSL_PROTO_DTLS)
5908 conf->hs_timeout_min = MBEDTLS_SSL_DTLS_TIMEOUT_DFL_MIN;
5909 conf->hs_timeout_max = MBEDTLS_SSL_DTLS_TIMEOUT_DFL_MAX;
5910#endif
5911
5912#if defined(MBEDTLS_SSL_RENEGOTIATION)
5913 conf->renego_max_records = MBEDTLS_SSL_RENEGO_MAX_RECORDS_DEFAULT;
Gilles Peskine449bd832023-01-11 14:50:10 +01005914 memset(conf->renego_period, 0x00, 2);
5915 memset(conf->renego_period + 2, 0xFF, 6);
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005916#endif
5917
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005918#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005919 if (endpoint == MBEDTLS_SSL_IS_SERVER) {
Hanno Beckere2defad2021-07-24 05:59:17 +01005920 const unsigned char dhm_p[] =
5921 MBEDTLS_DHM_RFC3526_MODP_2048_P_BIN;
5922 const unsigned char dhm_g[] =
5923 MBEDTLS_DHM_RFC3526_MODP_2048_G_BIN;
Hanno Becker00d0a682017-10-04 13:14:29 +01005924
Gilles Peskine449bd832023-01-11 14:50:10 +01005925 if ((ret = mbedtls_ssl_conf_dh_param_bin(conf,
5926 dhm_p, sizeof(dhm_p),
5927 dhm_g, sizeof(dhm_g))) != 0) {
5928 return ret;
Hanno Beckere2defad2021-07-24 05:59:17 +01005929 }
5930 }
Manuel Pégourié-Gonnardbd990d62015-06-11 14:49:42 +02005931#endif
5932
Ronald Cron6f135e12021-12-08 16:57:54 +01005933#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yu6ee56aa2022-12-06 17:47:22 +08005934
5935#if defined(MBEDTLS_SSL_EARLY_DATA)
Yanray Wangd5ed36f2023-11-07 11:40:43 +08005936 mbedtls_ssl_conf_early_data(conf, MBEDTLS_SSL_EARLY_DATA_DISABLED);
Jerry Yu6ee56aa2022-12-06 17:47:22 +08005937#if defined(MBEDTLS_SSL_SRV_C)
Yanray Wang07517612023-11-07 11:47:36 +08005938 mbedtls_ssl_conf_max_early_data_size(conf, MBEDTLS_SSL_MAX_EARLY_DATA_SIZE);
Jerry Yu6ee56aa2022-12-06 17:47:22 +08005939#endif
5940#endif /* MBEDTLS_SSL_EARLY_DATA */
5941
Jerry Yud0766ec2022-09-22 10:46:57 +08005942#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Jerry Yu1ad7ace2022-08-09 13:28:39 +08005943 mbedtls_ssl_conf_new_session_tickets(
Gilles Peskine449bd832023-01-11 14:50:10 +01005944 conf, MBEDTLS_SSL_TLS1_3_DEFAULT_NEW_SESSION_TICKETS);
Jerry Yu1ad7ace2022-08-09 13:28:39 +08005945#endif
Hanno Becker71f1ed62021-07-24 06:01:47 +01005946 /*
5947 * Allow all TLS 1.3 key exchange modes by default.
5948 */
Xiaofei Bai746f9482021-11-12 08:53:56 +00005949 conf->tls13_kex_modes = MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_ALL;
Ronald Cron6f135e12021-12-08 16:57:54 +01005950#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker71f1ed62021-07-24 06:01:47 +01005951
Gilles Peskine449bd832023-01-11 14:50:10 +01005952 if (transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Glenn Strauss2dfcea22022-03-14 17:26:42 -04005953#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
XiaokangQian4d3a6042022-04-21 13:46:17 +00005954 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
XiaokangQian060d8672022-04-21 09:24:56 +00005955 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
XiaokangQian4d3a6042022-04-21 13:46:17 +00005956#else
Gilles Peskine449bd832023-01-11 14:50:10 +01005957 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
XiaokangQian060d8672022-04-21 09:24:56 +00005958#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01005959 } else {
XiaokangQian4d3a6042022-04-21 13:46:17 +00005960#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
Ronald Cron097ba142023-03-08 16:18:00 +01005961 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
5962 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
XiaokangQian4d3a6042022-04-21 13:46:17 +00005963#elif defined(MBEDTLS_SSL_PROTO_TLS1_3)
5964 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
5965 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
5966#elif defined(MBEDTLS_SSL_PROTO_TLS1_2)
5967 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
5968 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
5969#else
Gilles Peskine449bd832023-01-11 14:50:10 +01005970 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
XiaokangQian4d3a6042022-04-21 13:46:17 +00005971#endif
5972 }
Glenn Strauss2dfcea22022-03-14 17:26:42 -04005973
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005974 /*
5975 * Preset-specific defaults
5976 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005977 switch (preset) {
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005978 /*
5979 * NSA Suite B
5980 */
5981 case MBEDTLS_SSL_PRESET_SUITEB:
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005982
Hanno Beckerd60b6c62021-04-29 12:04:11 +01005983 conf->ciphersuite_list = ssl_preset_suiteb_ciphersuites;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005984
5985#if defined(MBEDTLS_X509_CRT_PARSE_C)
5986 conf->cert_profile = &mbedtls_x509_crt_profile_suiteb;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005987#endif
5988
Ronald Crone68ab4f2022-10-05 12:46:29 +02005989#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu909df7b2022-01-22 11:56:27 +08005990#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005991 if (mbedtls_ssl_conf_is_tls12_only(conf)) {
Jerry Yu909df7b2022-01-22 11:56:27 +08005992 conf->sig_algs = ssl_tls12_preset_suiteb_sig_algs;
Gilles Peskine449bd832023-01-11 14:50:10 +01005993 } else
Jerry Yu909df7b2022-01-22 11:56:27 +08005994#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005995 conf->sig_algs = ssl_preset_suiteb_sig_algs;
Ronald Crone68ab4f2022-10-05 12:46:29 +02005996#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005997
Manuel Pégourié-Gonnardf07ce3b2023-09-22 11:53:41 +02005998#if defined(MBEDTLS_ECP_C) && !defined(MBEDTLS_DEPRECATED_REMOVED)
Brett Warrene0edc842021-08-17 09:53:13 +01005999 conf->curve_list = NULL;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02006000#endif
Brett Warrene0edc842021-08-17 09:53:13 +01006001 conf->group_list = ssl_preset_suiteb_groups;
Manuel Pégourié-Gonnardc98204e2015-08-11 04:21:01 +02006002 break;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02006003
6004 /*
6005 * Default
6006 */
6007 default:
Ronald Cronf6606552022-03-15 11:23:25 +01006008
Hanno Beckerd60b6c62021-04-29 12:04:11 +01006009 conf->ciphersuite_list = mbedtls_ssl_list_ciphersuites();
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02006010
6011#if defined(MBEDTLS_X509_CRT_PARSE_C)
6012 conf->cert_profile = &mbedtls_x509_crt_profile_default;
6013#endif
6014
Ronald Crone68ab4f2022-10-05 12:46:29 +02006015#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu909df7b2022-01-22 11:56:27 +08006016#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01006017 if (mbedtls_ssl_conf_is_tls12_only(conf)) {
Jerry Yu909df7b2022-01-22 11:56:27 +08006018 conf->sig_algs = ssl_tls12_preset_default_sig_algs;
Gilles Peskine449bd832023-01-11 14:50:10 +01006019 } else
Jerry Yu909df7b2022-01-22 11:56:27 +08006020#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006021 conf->sig_algs = ssl_preset_default_sig_algs;
Ronald Crone68ab4f2022-10-05 12:46:29 +02006022#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02006023
Manuel Pégourié-Gonnardf07ce3b2023-09-22 11:53:41 +02006024#if defined(MBEDTLS_ECP_C) && !defined(MBEDTLS_DEPRECATED_REMOVED)
Brett Warrene0edc842021-08-17 09:53:13 +01006025 conf->curve_list = NULL;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02006026#endif
Brett Warrene0edc842021-08-17 09:53:13 +01006027 conf->group_list = ssl_preset_default_groups;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02006028
6029#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_CLI_C)
6030 conf->dhm_min_bitlen = 1024;
6031#endif
6032 }
6033
Gilles Peskine449bd832023-01-11 14:50:10 +01006034 return 0;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02006035}
6036
6037/*
6038 * Free mbedtls_ssl_config
6039 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006040void mbedtls_ssl_config_free(mbedtls_ssl_config *conf)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02006041{
6042#if defined(MBEDTLS_DHM_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01006043 mbedtls_mpi_free(&conf->dhm_P);
6044 mbedtls_mpi_free(&conf->dhm_G);
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02006045#endif
6046
Ronald Cron73fe8df2022-10-05 14:31:43 +02006047#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED)
Neil Armstrong501c9322022-05-03 09:35:09 +02006048#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01006049 if (!mbedtls_svc_key_id_is_null(conf->psk_opaque)) {
Neil Armstrong501c9322022-05-03 09:35:09 +02006050 conf->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
6051 }
Neil Armstrong8ecd6682022-05-05 11:40:35 +02006052#endif /* MBEDTLS_USE_PSA_CRYPTO */
Gilles Peskine449bd832023-01-11 14:50:10 +01006053 if (conf->psk != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01006054 mbedtls_zeroize_and_free(conf->psk, conf->psk_len);
Azim Khan27e8a122018-03-21 14:24:11 +00006055 conf->psk = NULL;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02006056 conf->psk_len = 0;
junyeonLEE316b1622017-12-20 16:29:30 +09006057 }
6058
Gilles Peskine449bd832023-01-11 14:50:10 +01006059 if (conf->psk_identity != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01006060 mbedtls_zeroize_and_free(conf->psk_identity, conf->psk_identity_len);
Azim Khan27e8a122018-03-21 14:24:11 +00006061 conf->psk_identity = NULL;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02006062 conf->psk_identity_len = 0;
6063 }
Ronald Cron73fe8df2022-10-05 14:31:43 +02006064#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED */
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02006065
6066#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01006067 ssl_key_cert_free(conf->key_cert);
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02006068#endif
6069
Gilles Peskine449bd832023-01-11 14:50:10 +01006070 mbedtls_platform_zeroize(conf, sizeof(mbedtls_ssl_config));
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02006071}
6072
Manuel Pégourié-Gonnard5674a972015-10-19 15:14:03 +02006073#if defined(MBEDTLS_PK_C) && \
Valerio Settie9646ec2023-08-02 20:02:28 +02006074 (defined(MBEDTLS_RSA_C) || defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED))
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02006075/*
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006076 * Convert between MBEDTLS_PK_XXX and SSL_SIG_XXX
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02006077 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006078unsigned char mbedtls_ssl_sig_from_pk(mbedtls_pk_context *pk)
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02006079{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006080#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01006081 if (mbedtls_pk_can_do(pk, MBEDTLS_PK_RSA)) {
6082 return MBEDTLS_SSL_SIG_RSA;
6083 }
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02006084#endif
Valerio Settie9646ec2023-08-02 20:02:28 +02006085#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01006086 if (mbedtls_pk_can_do(pk, MBEDTLS_PK_ECDSA)) {
6087 return MBEDTLS_SSL_SIG_ECDSA;
6088 }
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02006089#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01006090 return MBEDTLS_SSL_SIG_ANON;
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02006091}
6092
Gilles Peskine449bd832023-01-11 14:50:10 +01006093unsigned char mbedtls_ssl_sig_from_pk_alg(mbedtls_pk_type_t type)
Hanno Becker7e5437a2017-04-28 17:15:26 +01006094{
Gilles Peskine449bd832023-01-11 14:50:10 +01006095 switch (type) {
Hanno Becker7e5437a2017-04-28 17:15:26 +01006096 case MBEDTLS_PK_RSA:
Gilles Peskine449bd832023-01-11 14:50:10 +01006097 return MBEDTLS_SSL_SIG_RSA;
Hanno Becker7e5437a2017-04-28 17:15:26 +01006098 case MBEDTLS_PK_ECDSA:
6099 case MBEDTLS_PK_ECKEY:
Gilles Peskine449bd832023-01-11 14:50:10 +01006100 return MBEDTLS_SSL_SIG_ECDSA;
Hanno Becker7e5437a2017-04-28 17:15:26 +01006101 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006102 return MBEDTLS_SSL_SIG_ANON;
Hanno Becker7e5437a2017-04-28 17:15:26 +01006103 }
6104}
6105
Gilles Peskine449bd832023-01-11 14:50:10 +01006106mbedtls_pk_type_t mbedtls_ssl_pk_alg_from_sig(unsigned char sig)
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02006107{
Gilles Peskine449bd832023-01-11 14:50:10 +01006108 switch (sig) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006109#if defined(MBEDTLS_RSA_C)
6110 case MBEDTLS_SSL_SIG_RSA:
Gilles Peskine449bd832023-01-11 14:50:10 +01006111 return MBEDTLS_PK_RSA;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02006112#endif
Valerio Settie9646ec2023-08-02 20:02:28 +02006113#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006114 case MBEDTLS_SSL_SIG_ECDSA:
Gilles Peskine449bd832023-01-11 14:50:10 +01006115 return MBEDTLS_PK_ECDSA;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02006116#endif
6117 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006118 return MBEDTLS_PK_NONE;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02006119 }
6120}
Valerio Settie9646ec2023-08-02 20:02:28 +02006121#endif /* MBEDTLS_PK_C &&
6122 ( MBEDTLS_RSA_C || MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED ) */
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02006123
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02006124/*
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006125 * Convert from MBEDTLS_SSL_HASH_XXX to MBEDTLS_MD_XXX
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02006126 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006127mbedtls_md_type_t mbedtls_ssl_md_alg_from_hash(unsigned char hash)
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02006128{
Gilles Peskine449bd832023-01-11 14:50:10 +01006129 switch (hash) {
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006130#if defined(MBEDTLS_MD_CAN_MD5)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006131 case MBEDTLS_SSL_HASH_MD5:
Gilles Peskine449bd832023-01-11 14:50:10 +01006132 return MBEDTLS_MD_MD5;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02006133#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006134#if defined(MBEDTLS_MD_CAN_SHA1)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006135 case MBEDTLS_SSL_HASH_SHA1:
Gilles Peskine449bd832023-01-11 14:50:10 +01006136 return MBEDTLS_MD_SHA1;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02006137#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006138#if defined(MBEDTLS_MD_CAN_SHA224)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006139 case MBEDTLS_SSL_HASH_SHA224:
Gilles Peskine449bd832023-01-11 14:50:10 +01006140 return MBEDTLS_MD_SHA224;
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02006141#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006142#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006143 case MBEDTLS_SSL_HASH_SHA256:
Gilles Peskine449bd832023-01-11 14:50:10 +01006144 return MBEDTLS_MD_SHA256;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02006145#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006146#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006147 case MBEDTLS_SSL_HASH_SHA384:
Gilles Peskine449bd832023-01-11 14:50:10 +01006148 return MBEDTLS_MD_SHA384;
Mateusz Starzyk3352a532021-04-06 14:28:22 +02006149#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006150#if defined(MBEDTLS_MD_CAN_SHA512)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006151 case MBEDTLS_SSL_HASH_SHA512:
Gilles Peskine449bd832023-01-11 14:50:10 +01006152 return MBEDTLS_MD_SHA512;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02006153#endif
6154 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006155 return MBEDTLS_MD_NONE;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02006156 }
6157}
6158
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006159/*
6160 * Convert from MBEDTLS_MD_XXX to MBEDTLS_SSL_HASH_XXX
6161 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006162unsigned char mbedtls_ssl_hash_from_md_alg(int md)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006163{
Gilles Peskine449bd832023-01-11 14:50:10 +01006164 switch (md) {
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006165#if defined(MBEDTLS_MD_CAN_MD5)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006166 case MBEDTLS_MD_MD5:
Gilles Peskine449bd832023-01-11 14:50:10 +01006167 return MBEDTLS_SSL_HASH_MD5;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006168#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006169#if defined(MBEDTLS_MD_CAN_SHA1)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006170 case MBEDTLS_MD_SHA1:
Gilles Peskine449bd832023-01-11 14:50:10 +01006171 return MBEDTLS_SSL_HASH_SHA1;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006172#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006173#if defined(MBEDTLS_MD_CAN_SHA224)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006174 case MBEDTLS_MD_SHA224:
Gilles Peskine449bd832023-01-11 14:50:10 +01006175 return MBEDTLS_SSL_HASH_SHA224;
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02006176#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006177#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006178 case MBEDTLS_MD_SHA256:
Gilles Peskine449bd832023-01-11 14:50:10 +01006179 return MBEDTLS_SSL_HASH_SHA256;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006180#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006181#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006182 case MBEDTLS_MD_SHA384:
Gilles Peskine449bd832023-01-11 14:50:10 +01006183 return MBEDTLS_SSL_HASH_SHA384;
Mateusz Starzyk3352a532021-04-06 14:28:22 +02006184#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006185#if defined(MBEDTLS_MD_CAN_SHA512)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006186 case MBEDTLS_MD_SHA512:
Gilles Peskine449bd832023-01-11 14:50:10 +01006187 return MBEDTLS_SSL_HASH_SHA512;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006188#endif
6189 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006190 return MBEDTLS_SSL_HASH_NONE;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006191 }
6192}
6193
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01006194/*
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006195 * Check if a curve proposed by the peer is in our list.
Manuel Pégourié-Gonnard9d412d82015-06-17 12:10:46 +02006196 * Return 0 if we're willing to use it, -1 otherwise.
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01006197 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006198int mbedtls_ssl_check_curve_tls_id(const mbedtls_ssl_context *ssl, uint16_t tls_id)
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01006199{
Gilles Peskine449bd832023-01-11 14:50:10 +01006200 const uint16_t *group_list = mbedtls_ssl_get_groups(ssl);
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01006201
Gilles Peskine449bd832023-01-11 14:50:10 +01006202 if (group_list == NULL) {
6203 return -1;
Brett Warrene0edc842021-08-17 09:53:13 +01006204 }
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01006205
Gilles Peskine449bd832023-01-11 14:50:10 +01006206 for (; *group_list != 0; group_list++) {
6207 if (*group_list == tls_id) {
6208 return 0;
6209 }
6210 }
6211
6212 return -1;
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01006213}
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01006214
Valerio Setti49e69072023-06-27 17:27:51 +02006215#if defined(MBEDTLS_PK_HAVE_ECC_KEYS)
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01006216/*
6217 * Same as mbedtls_ssl_check_curve_tls_id() but with a mbedtls_ecp_group_id.
6218 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006219int mbedtls_ssl_check_curve(const mbedtls_ssl_context *ssl, mbedtls_ecp_group_id grp_id)
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01006220{
Gilles Peskine449bd832023-01-11 14:50:10 +01006221 uint16_t tls_id = mbedtls_ssl_get_tls_id_from_ecp_group_id(grp_id);
Leonid Rozenboim19e59732022-08-08 16:52:38 -07006222
Gilles Peskine449bd832023-01-11 14:50:10 +01006223 if (tls_id == 0) {
Leonid Rozenboim19e59732022-08-08 16:52:38 -07006224 return -1;
Gilles Peskine449bd832023-01-11 14:50:10 +01006225 }
Leonid Rozenboim19e59732022-08-08 16:52:38 -07006226
Gilles Peskine449bd832023-01-11 14:50:10 +01006227 return mbedtls_ssl_check_curve_tls_id(ssl, tls_id);
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01006228}
Valerio Setti49e69072023-06-27 17:27:51 +02006229#endif /* MBEDTLS_PK_HAVE_ECC_KEYS */
Valerio Setti67419f02023-01-04 16:12:42 +01006230
Valerio Setti18c9fed2022-12-30 17:44:24 +01006231static const struct {
6232 uint16_t tls_id;
6233 mbedtls_ecp_group_id ecp_group_id;
6234 psa_ecc_family_t psa_family;
6235 uint16_t bits;
Valerio Setti18c9fed2022-12-30 17:44:24 +01006236} tls_id_match_table[] =
6237{
Valerio Settidb6b4db2023-09-01 09:20:51 +02006238#if defined(MBEDTLS_ECP_HAVE_SECP521R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02006239 { 25, MBEDTLS_ECP_DP_SECP521R1, PSA_ECC_FAMILY_SECP_R1, 521 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006240#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02006241#if defined(MBEDTLS_ECP_HAVE_BP512R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02006242 { 28, MBEDTLS_ECP_DP_BP512R1, PSA_ECC_FAMILY_BRAINPOOL_P_R1, 512 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006243#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02006244#if defined(MBEDTLS_ECP_HAVE_SECP384R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02006245 { 24, MBEDTLS_ECP_DP_SECP384R1, PSA_ECC_FAMILY_SECP_R1, 384 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006246#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02006247#if defined(MBEDTLS_ECP_HAVE_BP384R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02006248 { 27, MBEDTLS_ECP_DP_BP384R1, PSA_ECC_FAMILY_BRAINPOOL_P_R1, 384 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006249#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02006250#if defined(MBEDTLS_ECP_HAVE_SECP256R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02006251 { 23, MBEDTLS_ECP_DP_SECP256R1, PSA_ECC_FAMILY_SECP_R1, 256 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006252#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02006253#if defined(MBEDTLS_ECP_HAVE_SECP256K1)
Valerio Settiacd32c02023-06-29 18:06:29 +02006254 { 22, MBEDTLS_ECP_DP_SECP256K1, PSA_ECC_FAMILY_SECP_K1, 256 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006255#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02006256#if defined(MBEDTLS_ECP_HAVE_BP256R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02006257 { 26, MBEDTLS_ECP_DP_BP256R1, PSA_ECC_FAMILY_BRAINPOOL_P_R1, 256 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006258#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02006259#if defined(MBEDTLS_ECP_HAVE_SECP224R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02006260 { 21, MBEDTLS_ECP_DP_SECP224R1, PSA_ECC_FAMILY_SECP_R1, 224 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006261#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02006262#if defined(MBEDTLS_ECP_HAVE_SECP224K1)
Valerio Settiacd32c02023-06-29 18:06:29 +02006263 { 20, MBEDTLS_ECP_DP_SECP224K1, PSA_ECC_FAMILY_SECP_K1, 224 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006264#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02006265#if defined(MBEDTLS_ECP_HAVE_SECP192R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02006266 { 19, MBEDTLS_ECP_DP_SECP192R1, PSA_ECC_FAMILY_SECP_R1, 192 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006267#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02006268#if defined(MBEDTLS_ECP_HAVE_SECP192K1)
Valerio Settiacd32c02023-06-29 18:06:29 +02006269 { 18, MBEDTLS_ECP_DP_SECP192K1, PSA_ECC_FAMILY_SECP_K1, 192 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006270#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02006271#if defined(MBEDTLS_ECP_HAVE_CURVE25519)
Valerio Settiacd32c02023-06-29 18:06:29 +02006272 { 29, MBEDTLS_ECP_DP_CURVE25519, PSA_ECC_FAMILY_MONTGOMERY, 255 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006273#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02006274#if defined(MBEDTLS_ECP_HAVE_CURVE448)
Valerio Settiacd32c02023-06-29 18:06:29 +02006275 { 30, MBEDTLS_ECP_DP_CURVE448, PSA_ECC_FAMILY_MONTGOMERY, 448 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006276#endif
Valerio Settiacd32c02023-06-29 18:06:29 +02006277 { 0, MBEDTLS_ECP_DP_NONE, 0, 0 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006278};
6279
Gilles Peskine449bd832023-01-11 14:50:10 +01006280int mbedtls_ssl_get_psa_curve_info_from_tls_id(uint16_t tls_id,
Przemek Stekielda4fba62023-06-02 14:52:28 +02006281 psa_key_type_t *type,
Gilles Peskine449bd832023-01-11 14:50:10 +01006282 size_t *bits)
Valerio Setti18c9fed2022-12-30 17:44:24 +01006283{
Gilles Peskine449bd832023-01-11 14:50:10 +01006284 for (int i = 0; tls_id_match_table[i].tls_id != 0; i++) {
6285 if (tls_id_match_table[i].tls_id == tls_id) {
Przemek Stekielda4fba62023-06-02 14:52:28 +02006286 if (type != NULL) {
6287 *type = PSA_KEY_TYPE_ECC_KEY_PAIR(tls_id_match_table[i].psa_family);
Gilles Peskine449bd832023-01-11 14:50:10 +01006288 }
6289 if (bits != NULL) {
Valerio Setti18c9fed2022-12-30 17:44:24 +01006290 *bits = tls_id_match_table[i].bits;
Gilles Peskine449bd832023-01-11 14:50:10 +01006291 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01006292 return PSA_SUCCESS;
6293 }
6294 }
6295
6296 return PSA_ERROR_NOT_SUPPORTED;
6297}
6298
Gilles Peskine449bd832023-01-11 14:50:10 +01006299mbedtls_ecp_group_id mbedtls_ssl_get_ecp_group_id_from_tls_id(uint16_t tls_id)
Valerio Setti18c9fed2022-12-30 17:44:24 +01006300{
Gilles Peskine449bd832023-01-11 14:50:10 +01006301 for (int i = 0; tls_id_match_table[i].tls_id != 0; i++) {
6302 if (tls_id_match_table[i].tls_id == tls_id) {
Valerio Setti18c9fed2022-12-30 17:44:24 +01006303 return tls_id_match_table[i].ecp_group_id;
Gilles Peskine449bd832023-01-11 14:50:10 +01006304 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01006305 }
6306
6307 return MBEDTLS_ECP_DP_NONE;
6308}
6309
Gilles Peskine449bd832023-01-11 14:50:10 +01006310uint16_t mbedtls_ssl_get_tls_id_from_ecp_group_id(mbedtls_ecp_group_id grp_id)
Valerio Setti18c9fed2022-12-30 17:44:24 +01006311{
Gilles Peskine449bd832023-01-11 14:50:10 +01006312 for (int i = 0; tls_id_match_table[i].ecp_group_id != MBEDTLS_ECP_DP_NONE;
6313 i++) {
6314 if (tls_id_match_table[i].ecp_group_id == grp_id) {
Valerio Setti18c9fed2022-12-30 17:44:24 +01006315 return tls_id_match_table[i].tls_id;
Gilles Peskine449bd832023-01-11 14:50:10 +01006316 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01006317 }
6318
6319 return 0;
6320}
6321
Valerio Setti67419f02023-01-04 16:12:42 +01006322#if defined(MBEDTLS_DEBUG_C)
Valerio Settiacd32c02023-06-29 18:06:29 +02006323static const struct {
6324 uint16_t tls_id;
6325 const char *name;
6326} tls_id_curve_name_table[] =
6327{
Valerio Setti54e23792023-07-07 10:49:27 +02006328 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP521R1, "secp521r1" },
6329 { MBEDTLS_SSL_IANA_TLS_GROUP_BP512R1, "brainpoolP512r1" },
6330 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1, "secp384r1" },
6331 { MBEDTLS_SSL_IANA_TLS_GROUP_BP384R1, "brainpoolP384r1" },
6332 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1, "secp256r1" },
6333 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP256K1, "secp256k1" },
6334 { MBEDTLS_SSL_IANA_TLS_GROUP_BP256R1, "brainpoolP256r1" },
6335 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP224R1, "secp224r1" },
6336 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP224K1, "secp224k1" },
6337 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP192R1, "secp192r1" },
6338 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP192K1, "secp192k1" },
6339 { MBEDTLS_SSL_IANA_TLS_GROUP_X25519, "x25519" },
6340 { MBEDTLS_SSL_IANA_TLS_GROUP_X448, "x448" },
Valerio Settiacd32c02023-06-29 18:06:29 +02006341 { 0, NULL },
6342};
6343
Gilles Peskine449bd832023-01-11 14:50:10 +01006344const char *mbedtls_ssl_get_curve_name_from_tls_id(uint16_t tls_id)
Valerio Setti18c9fed2022-12-30 17:44:24 +01006345{
Valerio Settiacd32c02023-06-29 18:06:29 +02006346 for (int i = 0; tls_id_curve_name_table[i].tls_id != 0; i++) {
6347 if (tls_id_curve_name_table[i].tls_id == tls_id) {
6348 return tls_id_curve_name_table[i].name;
Gilles Peskine449bd832023-01-11 14:50:10 +01006349 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01006350 }
6351
6352 return NULL;
6353}
Valerio Setti67419f02023-01-04 16:12:42 +01006354#endif
Valerio Setti18c9fed2022-12-30 17:44:24 +01006355
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006356#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01006357int mbedtls_ssl_check_cert_usage(const mbedtls_x509_crt *cert,
6358 const mbedtls_ssl_ciphersuite_t *ciphersuite,
6359 int cert_endpoint,
6360 uint32_t *flags)
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02006361{
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01006362 int ret = 0;
Dave Rodgmanc37ad442023-11-03 23:36:06 +00006363 unsigned int usage = 0;
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02006364 const char *ext_oid;
6365 size_t ext_len;
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02006366
Gilles Peskine449bd832023-01-11 14:50:10 +01006367 if (cert_endpoint == MBEDTLS_SSL_IS_SERVER) {
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02006368 /* Server part of the key exchange */
Gilles Peskine449bd832023-01-11 14:50:10 +01006369 switch (ciphersuite->key_exchange) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006370 case MBEDTLS_KEY_EXCHANGE_RSA:
6371 case MBEDTLS_KEY_EXCHANGE_RSA_PSK:
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01006372 usage = MBEDTLS_X509_KU_KEY_ENCIPHERMENT;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02006373 break;
6374
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006375 case MBEDTLS_KEY_EXCHANGE_DHE_RSA:
6376 case MBEDTLS_KEY_EXCHANGE_ECDHE_RSA:
6377 case MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA:
6378 usage = MBEDTLS_X509_KU_DIGITAL_SIGNATURE;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02006379 break;
6380
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006381 case MBEDTLS_KEY_EXCHANGE_ECDH_RSA:
6382 case MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA:
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01006383 usage = MBEDTLS_X509_KU_KEY_AGREEMENT;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02006384 break;
6385
6386 /* Don't use default: we want warnings when adding new values */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006387 case MBEDTLS_KEY_EXCHANGE_NONE:
6388 case MBEDTLS_KEY_EXCHANGE_PSK:
6389 case MBEDTLS_KEY_EXCHANGE_DHE_PSK:
6390 case MBEDTLS_KEY_EXCHANGE_ECDHE_PSK:
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +02006391 case MBEDTLS_KEY_EXCHANGE_ECJPAKE:
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02006392 usage = 0;
6393 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006394 } else {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006395 /* Client auth: we only implement rsa_sign and mbedtls_ecdsa_sign for now */
6396 usage = MBEDTLS_X509_KU_DIGITAL_SIGNATURE;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02006397 }
6398
Gilles Peskine449bd832023-01-11 14:50:10 +01006399 if (mbedtls_x509_crt_check_key_usage(cert, usage) != 0) {
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01006400 *flags |= MBEDTLS_X509_BADCERT_KEY_USAGE;
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01006401 ret = -1;
6402 }
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02006403
Gilles Peskine449bd832023-01-11 14:50:10 +01006404 if (cert_endpoint == MBEDTLS_SSL_IS_SERVER) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006405 ext_oid = MBEDTLS_OID_SERVER_AUTH;
Gilles Peskine449bd832023-01-11 14:50:10 +01006406 ext_len = MBEDTLS_OID_SIZE(MBEDTLS_OID_SERVER_AUTH);
6407 } else {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006408 ext_oid = MBEDTLS_OID_CLIENT_AUTH;
Gilles Peskine449bd832023-01-11 14:50:10 +01006409 ext_len = MBEDTLS_OID_SIZE(MBEDTLS_OID_CLIENT_AUTH);
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02006410 }
6411
Gilles Peskine449bd832023-01-11 14:50:10 +01006412 if (mbedtls_x509_crt_check_extended_key_usage(cert, ext_oid, ext_len) != 0) {
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01006413 *flags |= MBEDTLS_X509_BADCERT_EXT_KEY_USAGE;
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01006414 ret = -1;
6415 }
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02006416
Gilles Peskine449bd832023-01-11 14:50:10 +01006417 return ret;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02006418}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006419#endif /* MBEDTLS_X509_CRT_PARSE_C */
Manuel Pégourié-Gonnard3a306b92014-04-29 15:11:17 +02006420
Jerry Yu148165c2021-09-24 23:20:59 +08006421#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01006422int mbedtls_ssl_get_handshake_transcript(mbedtls_ssl_context *ssl,
6423 const mbedtls_md_type_t md,
6424 unsigned char *dst,
6425 size_t dst_len,
6426 size_t *olen)
Jerry Yu148165c2021-09-24 23:20:59 +08006427{
Ronald Cronf6893e12022-01-07 22:09:01 +01006428 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
6429 psa_hash_operation_t *hash_operation_to_clone;
6430 psa_hash_operation_t hash_operation = psa_hash_operation_init();
6431
Jerry Yu148165c2021-09-24 23:20:59 +08006432 *olen = 0;
Ronald Cronf6893e12022-01-07 22:09:01 +01006433
Gilles Peskine449bd832023-01-11 14:50:10 +01006434 switch (md) {
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006435#if defined(MBEDTLS_MD_CAN_SHA384)
Gilles Peskine449bd832023-01-11 14:50:10 +01006436 case MBEDTLS_MD_SHA384:
6437 hash_operation_to_clone = &ssl->handshake->fin_sha384_psa;
6438 break;
Ronald Cronf6893e12022-01-07 22:09:01 +01006439#endif
6440
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006441#if defined(MBEDTLS_MD_CAN_SHA256)
Gilles Peskine449bd832023-01-11 14:50:10 +01006442 case MBEDTLS_MD_SHA256:
6443 hash_operation_to_clone = &ssl->handshake->fin_sha256_psa;
6444 break;
Ronald Cronf6893e12022-01-07 22:09:01 +01006445#endif
6446
Gilles Peskine449bd832023-01-11 14:50:10 +01006447 default:
6448 goto exit;
6449 }
6450
6451 status = psa_hash_clone(hash_operation_to_clone, &hash_operation);
6452 if (status != PSA_SUCCESS) {
Ronald Cronf6893e12022-01-07 22:09:01 +01006453 goto exit;
6454 }
6455
Gilles Peskine449bd832023-01-11 14:50:10 +01006456 status = psa_hash_finish(&hash_operation, dst, dst_len, olen);
6457 if (status != PSA_SUCCESS) {
Ronald Cronf6893e12022-01-07 22:09:01 +01006458 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006459 }
Ronald Cronf6893e12022-01-07 22:09:01 +01006460
6461exit:
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006462#if !defined(MBEDTLS_MD_CAN_SHA384) && \
6463 !defined(MBEDTLS_MD_CAN_SHA256)
Andrzej Kurekeabeb302022-10-17 07:52:51 -04006464 (void) ssl;
6465#endif
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05006466 return PSA_TO_MBEDTLS_ERR(status);
Jerry Yu148165c2021-09-24 23:20:59 +08006467}
6468#else /* MBEDTLS_USE_PSA_CRYPTO */
6469
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006470#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006471MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006472static int ssl_get_handshake_transcript_sha384(mbedtls_ssl_context *ssl,
6473 unsigned char *dst,
6474 size_t dst_len,
6475 size_t *olen)
Jerry Yu24c0ec32021-09-09 14:21:07 +08006476{
Jerry Yu24c0ec32021-09-09 14:21:07 +08006477 int ret;
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01006478 mbedtls_md_context_t sha384;
Jerry Yu24c0ec32021-09-09 14:21:07 +08006479
Gilles Peskine449bd832023-01-11 14:50:10 +01006480 if (dst_len < 48) {
6481 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
6482 }
Jerry Yu24c0ec32021-09-09 14:21:07 +08006483
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01006484 mbedtls_md_init(&sha384);
6485 ret = mbedtls_md_setup(&sha384, mbedtls_md_info_from_type(MBEDTLS_MD_SHA384), 0);
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01006486 if (ret != 0) {
6487 goto exit;
6488 }
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01006489 ret = mbedtls_md_clone(&sha384, &ssl->handshake->fin_sha384);
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01006490 if (ret != 0) {
6491 goto exit;
6492 }
Jerry Yu24c0ec32021-09-09 14:21:07 +08006493
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01006494 if ((ret = mbedtls_md_finish(&sha384, dst)) != 0) {
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01006495 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_finish", ret);
Jerry Yu24c0ec32021-09-09 14:21:07 +08006496 goto exit;
6497 }
6498
6499 *olen = 48;
6500
6501exit:
6502
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01006503 mbedtls_md_free(&sha384);
Gilles Peskine449bd832023-01-11 14:50:10 +01006504 return ret;
Jerry Yu24c0ec32021-09-09 14:21:07 +08006505}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006506#endif /* MBEDTLS_MD_CAN_SHA384 */
Jerry Yu24c0ec32021-09-09 14:21:07 +08006507
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006508#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006509MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006510static int ssl_get_handshake_transcript_sha256(mbedtls_ssl_context *ssl,
6511 unsigned char *dst,
6512 size_t dst_len,
6513 size_t *olen)
Jerry Yu24c0ec32021-09-09 14:21:07 +08006514{
Jerry Yu24c0ec32021-09-09 14:21:07 +08006515 int ret;
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01006516 mbedtls_md_context_t sha256;
Jerry Yu24c0ec32021-09-09 14:21:07 +08006517
Gilles Peskine449bd832023-01-11 14:50:10 +01006518 if (dst_len < 32) {
6519 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
6520 }
Jerry Yu24c0ec32021-09-09 14:21:07 +08006521
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01006522 mbedtls_md_init(&sha256);
6523 ret = mbedtls_md_setup(&sha256, mbedtls_md_info_from_type(MBEDTLS_MD_SHA256), 0);
6524 if (ret != 0) {
6525 goto exit;
6526 }
6527 ret = mbedtls_md_clone(&sha256, &ssl->handshake->fin_sha256);
6528 if (ret != 0) {
6529 goto exit;
6530 }
Jerry Yuc5aef882021-12-23 20:15:02 +08006531
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01006532 if ((ret = mbedtls_md_finish(&sha256, dst)) != 0) {
6533 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_finish", ret);
Jerry Yu24c0ec32021-09-09 14:21:07 +08006534 goto exit;
6535 }
6536
6537 *olen = 32;
6538
6539exit:
6540
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01006541 mbedtls_md_free(&sha256);
Gilles Peskine449bd832023-01-11 14:50:10 +01006542 return ret;
Jerry Yu24c0ec32021-09-09 14:21:07 +08006543}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006544#endif /* MBEDTLS_MD_CAN_SHA256 */
Jerry Yu24c0ec32021-09-09 14:21:07 +08006545
Gilles Peskine449bd832023-01-11 14:50:10 +01006546int mbedtls_ssl_get_handshake_transcript(mbedtls_ssl_context *ssl,
6547 const mbedtls_md_type_t md,
6548 unsigned char *dst,
6549 size_t dst_len,
6550 size_t *olen)
Jerry Yu24c0ec32021-09-09 14:21:07 +08006551{
Gilles Peskine449bd832023-01-11 14:50:10 +01006552 switch (md) {
Jerry Yuc1ddeef2021-10-08 15:14:45 +08006553
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006554#if defined(MBEDTLS_MD_CAN_SHA384)
Gilles Peskine449bd832023-01-11 14:50:10 +01006555 case MBEDTLS_MD_SHA384:
6556 return ssl_get_handshake_transcript_sha384(ssl, dst, dst_len, olen);
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006557#endif /* MBEDTLS_MD_CAN_SHA384*/
Jerry Yuc1ddeef2021-10-08 15:14:45 +08006558
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006559#if defined(MBEDTLS_MD_CAN_SHA256)
Gilles Peskine449bd832023-01-11 14:50:10 +01006560 case MBEDTLS_MD_SHA256:
6561 return ssl_get_handshake_transcript_sha256(ssl, dst, dst_len, olen);
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006562#endif /* MBEDTLS_MD_CAN_SHA256*/
Jerry Yuc1ddeef2021-10-08 15:14:45 +08006563
Gilles Peskine449bd832023-01-11 14:50:10 +01006564 default:
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006565#if !defined(MBEDTLS_MD_CAN_SHA384) && \
6566 !defined(MBEDTLS_MD_CAN_SHA256)
Gilles Peskine449bd832023-01-11 14:50:10 +01006567 (void) ssl;
6568 (void) dst;
6569 (void) dst_len;
6570 (void) olen;
Andrzej Kurek409248a2022-10-24 10:33:21 -04006571#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01006572 break;
Jerry Yuc1ddeef2021-10-08 15:14:45 +08006573 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006574 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yu24c0ec32021-09-09 14:21:07 +08006575}
XiaokangQian647719a2021-12-07 09:16:29 +00006576
Jerry Yu148165c2021-09-24 23:20:59 +08006577#endif /* !MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu24c0ec32021-09-09 14:21:07 +08006578
Ronald Crone68ab4f2022-10-05 12:46:29 +02006579#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Gabor Mezei078e8032022-04-27 21:17:56 +02006580/* mbedtls_ssl_parse_sig_alg_ext()
6581 *
6582 * The `extension_data` field of signature algorithm contains a `SignatureSchemeList`
6583 * value (TLS 1.3 RFC8446):
6584 * enum {
6585 * ....
6586 * ecdsa_secp256r1_sha256( 0x0403 ),
6587 * ecdsa_secp384r1_sha384( 0x0503 ),
6588 * ecdsa_secp521r1_sha512( 0x0603 ),
6589 * ....
6590 * } SignatureScheme;
6591 *
6592 * struct {
6593 * SignatureScheme supported_signature_algorithms<2..2^16-2>;
6594 * } SignatureSchemeList;
6595 *
6596 * The `extension_data` field of signature algorithm contains a `SignatureAndHashAlgorithm`
6597 * value (TLS 1.2 RFC5246):
6598 * enum {
6599 * none(0), md5(1), sha1(2), sha224(3), sha256(4), sha384(5),
6600 * sha512(6), (255)
6601 * } HashAlgorithm;
6602 *
6603 * enum { anonymous(0), rsa(1), dsa(2), ecdsa(3), (255) }
6604 * SignatureAlgorithm;
6605 *
6606 * struct {
6607 * HashAlgorithm hash;
6608 * SignatureAlgorithm signature;
6609 * } SignatureAndHashAlgorithm;
6610 *
6611 * SignatureAndHashAlgorithm
6612 * supported_signature_algorithms<2..2^16-2>;
6613 *
6614 * The TLS 1.3 signature algorithm extension was defined to be a compatible
6615 * generalization of the TLS 1.2 signature algorithm extension.
6616 * `SignatureAndHashAlgorithm` field of TLS 1.2 can be represented by
6617 * `SignatureScheme` field of TLS 1.3
6618 *
6619 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006620int mbedtls_ssl_parse_sig_alg_ext(mbedtls_ssl_context *ssl,
6621 const unsigned char *buf,
6622 const unsigned char *end)
Gabor Mezei078e8032022-04-27 21:17:56 +02006623{
6624 const unsigned char *p = buf;
6625 size_t supported_sig_algs_len = 0;
6626 const unsigned char *supported_sig_algs_end;
6627 uint16_t sig_alg;
6628 uint32_t common_idx = 0;
6629
Gilles Peskine449bd832023-01-11 14:50:10 +01006630 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
6631 supported_sig_algs_len = MBEDTLS_GET_UINT16_BE(p, 0);
Gabor Mezei078e8032022-04-27 21:17:56 +02006632 p += 2;
6633
Gilles Peskine449bd832023-01-11 14:50:10 +01006634 memset(ssl->handshake->received_sig_algs, 0,
6635 sizeof(ssl->handshake->received_sig_algs));
Gabor Mezei078e8032022-04-27 21:17:56 +02006636
Gilles Peskine449bd832023-01-11 14:50:10 +01006637 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, supported_sig_algs_len);
Gabor Mezei078e8032022-04-27 21:17:56 +02006638 supported_sig_algs_end = p + supported_sig_algs_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01006639 while (p < supported_sig_algs_end) {
6640 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, supported_sig_algs_end, 2);
6641 sig_alg = MBEDTLS_GET_UINT16_BE(p, 0);
Gabor Mezei078e8032022-04-27 21:17:56 +02006642 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01006643 MBEDTLS_SSL_DEBUG_MSG(4, ("received signature algorithm: 0x%x %s",
6644 sig_alg,
6645 mbedtls_ssl_sig_alg_to_str(sig_alg)));
Jerry Yu2fe6c632022-06-29 10:02:38 +08006646#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01006647 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_2 &&
6648 (!(mbedtls_ssl_sig_alg_is_supported(ssl, sig_alg) &&
6649 mbedtls_ssl_sig_alg_is_offered(ssl, sig_alg)))) {
Gabor Mezei078e8032022-04-27 21:17:56 +02006650 continue;
Jerry Yu2fe6c632022-06-29 10:02:38 +08006651 }
6652#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gabor Mezei078e8032022-04-27 21:17:56 +02006653
Gilles Peskine449bd832023-01-11 14:50:10 +01006654 MBEDTLS_SSL_DEBUG_MSG(4, ("valid signature algorithm: %s",
6655 mbedtls_ssl_sig_alg_to_str(sig_alg)));
Gabor Mezei078e8032022-04-27 21:17:56 +02006656
Gilles Peskine449bd832023-01-11 14:50:10 +01006657 if (common_idx + 1 < MBEDTLS_RECEIVED_SIG_ALGS_SIZE) {
Gabor Mezei078e8032022-04-27 21:17:56 +02006658 ssl->handshake->received_sig_algs[common_idx] = sig_alg;
6659 common_idx += 1;
6660 }
6661 }
6662 /* Check that we consumed all the message. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006663 if (p != end) {
6664 MBEDTLS_SSL_DEBUG_MSG(1,
6665 ("Signature algorithms extension length misaligned"));
6666 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR,
6667 MBEDTLS_ERR_SSL_DECODE_ERROR);
6668 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Gabor Mezei078e8032022-04-27 21:17:56 +02006669 }
6670
Gilles Peskine449bd832023-01-11 14:50:10 +01006671 if (common_idx == 0) {
6672 MBEDTLS_SSL_DEBUG_MSG(3, ("no signature algorithm in common"));
6673 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE,
6674 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE);
6675 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Gabor Mezei078e8032022-04-27 21:17:56 +02006676 }
6677
Gabor Mezei15b95a62022-05-09 16:37:58 +02006678 ssl->handshake->received_sig_algs[common_idx] = MBEDTLS_TLS_SIG_NONE;
Gilles Peskine449bd832023-01-11 14:50:10 +01006679 return 0;
Gabor Mezei078e8032022-04-27 21:17:56 +02006680}
6681
Ronald Crone68ab4f2022-10-05 12:46:29 +02006682#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Gabor Mezei078e8032022-04-27 21:17:56 +02006683
Jerry Yudc7bd172022-02-17 13:44:15 +08006684#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
6685
6686#if defined(MBEDTLS_USE_PSA_CRYPTO)
6687
Gilles Peskine449bd832023-01-11 14:50:10 +01006688static psa_status_t setup_psa_key_derivation(psa_key_derivation_operation_t *derivation,
6689 mbedtls_svc_key_id_t key,
6690 psa_algorithm_t alg,
6691 const unsigned char *raw_psk, size_t raw_psk_length,
6692 const unsigned char *seed, size_t seed_length,
6693 const unsigned char *label, size_t label_length,
6694 const unsigned char *other_secret,
6695 size_t other_secret_length,
6696 size_t capacity)
Jerry Yudc7bd172022-02-17 13:44:15 +08006697{
6698 psa_status_t status;
6699
Gilles Peskine449bd832023-01-11 14:50:10 +01006700 status = psa_key_derivation_setup(derivation, alg);
6701 if (status != PSA_SUCCESS) {
6702 return status;
6703 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006704
Gilles Peskine449bd832023-01-11 14:50:10 +01006705 if (PSA_ALG_IS_TLS12_PRF(alg) || PSA_ALG_IS_TLS12_PSK_TO_MS(alg)) {
6706 status = psa_key_derivation_input_bytes(derivation,
6707 PSA_KEY_DERIVATION_INPUT_SEED,
6708 seed, seed_length);
6709 if (status != PSA_SUCCESS) {
6710 return status;
Przemek Stekiel1f027032022-04-05 17:12:11 +02006711 }
6712
Gilles Peskine449bd832023-01-11 14:50:10 +01006713 if (other_secret != NULL) {
6714 status = psa_key_derivation_input_bytes(derivation,
6715 PSA_KEY_DERIVATION_INPUT_OTHER_SECRET,
6716 other_secret, other_secret_length);
6717 if (status != PSA_SUCCESS) {
6718 return status;
6719 }
6720 }
6721
6722 if (mbedtls_svc_key_id_is_null(key)) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006723 status = psa_key_derivation_input_bytes(
6724 derivation, PSA_KEY_DERIVATION_INPUT_SECRET,
Gilles Peskine449bd832023-01-11 14:50:10 +01006725 raw_psk, raw_psk_length);
6726 } else {
Jerry Yudc7bd172022-02-17 13:44:15 +08006727 status = psa_key_derivation_input_key(
Gilles Peskine449bd832023-01-11 14:50:10 +01006728 derivation, PSA_KEY_DERIVATION_INPUT_SECRET, key);
Jerry Yudc7bd172022-02-17 13:44:15 +08006729 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006730 if (status != PSA_SUCCESS) {
6731 return status;
6732 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006733
Gilles Peskine449bd832023-01-11 14:50:10 +01006734 status = psa_key_derivation_input_bytes(derivation,
6735 PSA_KEY_DERIVATION_INPUT_LABEL,
6736 label, label_length);
6737 if (status != PSA_SUCCESS) {
6738 return status;
6739 }
6740 } else {
6741 return PSA_ERROR_NOT_SUPPORTED;
Jerry Yudc7bd172022-02-17 13:44:15 +08006742 }
6743
Gilles Peskine449bd832023-01-11 14:50:10 +01006744 status = psa_key_derivation_set_capacity(derivation, capacity);
6745 if (status != PSA_SUCCESS) {
6746 return status;
6747 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006748
Gilles Peskine449bd832023-01-11 14:50:10 +01006749 return PSA_SUCCESS;
Jerry Yudc7bd172022-02-17 13:44:15 +08006750}
6751
Andrzej Kurek57d10632022-10-24 10:32:01 -04006752#if defined(PSA_WANT_ALG_SHA_384) || \
6753 defined(PSA_WANT_ALG_SHA_256)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006754MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006755static int tls_prf_generic(mbedtls_md_type_t md_type,
6756 const unsigned char *secret, size_t slen,
6757 const char *label,
6758 const unsigned char *random, size_t rlen,
6759 unsigned char *dstbuf, size_t dlen)
Jerry Yudc7bd172022-02-17 13:44:15 +08006760{
6761 psa_status_t status;
6762 psa_algorithm_t alg;
6763 mbedtls_svc_key_id_t master_key = MBEDTLS_SVC_KEY_ID_INIT;
6764 psa_key_derivation_operation_t derivation =
6765 PSA_KEY_DERIVATION_OPERATION_INIT;
6766
Gilles Peskine449bd832023-01-11 14:50:10 +01006767 if (md_type == MBEDTLS_MD_SHA384) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006768 alg = PSA_ALG_TLS12_PRF(PSA_ALG_SHA_384);
Gilles Peskine449bd832023-01-11 14:50:10 +01006769 } else {
Jerry Yudc7bd172022-02-17 13:44:15 +08006770 alg = PSA_ALG_TLS12_PRF(PSA_ALG_SHA_256);
Gilles Peskine449bd832023-01-11 14:50:10 +01006771 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006772
6773 /* Normally a "secret" should be long enough to be impossible to
6774 * find by brute force, and in particular should not be empty. But
6775 * this PRF is also used to derive an IV, in particular in EAP-TLS,
6776 * and for this use case it makes sense to have a 0-length "secret".
6777 * Since the key API doesn't allow importing a key of length 0,
6778 * keep master_key=0, which setup_psa_key_derivation() understands
6779 * to mean a 0-length "secret" input. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006780 if (slen != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006781 psa_key_attributes_t key_attributes = psa_key_attributes_init();
Gilles Peskine449bd832023-01-11 14:50:10 +01006782 psa_set_key_usage_flags(&key_attributes, PSA_KEY_USAGE_DERIVE);
6783 psa_set_key_algorithm(&key_attributes, alg);
6784 psa_set_key_type(&key_attributes, PSA_KEY_TYPE_DERIVE);
Jerry Yudc7bd172022-02-17 13:44:15 +08006785
Gilles Peskine449bd832023-01-11 14:50:10 +01006786 status = psa_import_key(&key_attributes, secret, slen, &master_key);
6787 if (status != PSA_SUCCESS) {
6788 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
6789 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006790 }
6791
Gilles Peskine449bd832023-01-11 14:50:10 +01006792 status = setup_psa_key_derivation(&derivation,
6793 master_key, alg,
6794 NULL, 0,
6795 random, rlen,
6796 (unsigned char const *) label,
6797 (size_t) strlen(label),
6798 NULL, 0,
6799 dlen);
6800 if (status != PSA_SUCCESS) {
6801 psa_key_derivation_abort(&derivation);
6802 psa_destroy_key(master_key);
6803 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yudc7bd172022-02-17 13:44:15 +08006804 }
6805
Gilles Peskine449bd832023-01-11 14:50:10 +01006806 status = psa_key_derivation_output_bytes(&derivation, dstbuf, dlen);
6807 if (status != PSA_SUCCESS) {
6808 psa_key_derivation_abort(&derivation);
6809 psa_destroy_key(master_key);
6810 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yudc7bd172022-02-17 13:44:15 +08006811 }
6812
Gilles Peskine449bd832023-01-11 14:50:10 +01006813 status = psa_key_derivation_abort(&derivation);
6814 if (status != PSA_SUCCESS) {
6815 psa_destroy_key(master_key);
6816 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yudc7bd172022-02-17 13:44:15 +08006817 }
6818
Gilles Peskine449bd832023-01-11 14:50:10 +01006819 if (!mbedtls_svc_key_id_is_null(master_key)) {
6820 status = psa_destroy_key(master_key);
6821 }
6822 if (status != PSA_SUCCESS) {
6823 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
6824 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006825
Gilles Peskine449bd832023-01-11 14:50:10 +01006826 return 0;
Jerry Yudc7bd172022-02-17 13:44:15 +08006827}
Andrzej Kurek57d10632022-10-24 10:32:01 -04006828#endif /* PSA_WANT_ALG_SHA_256 || PSA_WANT_ALG_SHA_384 */
Jerry Yudc7bd172022-02-17 13:44:15 +08006829#else /* MBEDTLS_USE_PSA_CRYPTO */
6830
Andrzej Kurek57d10632022-10-24 10:32:01 -04006831#if defined(MBEDTLS_MD_C) && \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006832 (defined(MBEDTLS_MD_CAN_SHA256) || \
6833 defined(MBEDTLS_MD_CAN_SHA384))
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006834MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006835static int tls_prf_generic(mbedtls_md_type_t md_type,
6836 const unsigned char *secret, size_t slen,
6837 const char *label,
6838 const unsigned char *random, size_t rlen,
6839 unsigned char *dstbuf, size_t dlen)
Jerry Yudc7bd172022-02-17 13:44:15 +08006840{
6841 size_t nb;
6842 size_t i, j, k, md_len;
6843 unsigned char *tmp;
6844 size_t tmp_len = 0;
6845 unsigned char h_i[MBEDTLS_MD_MAX_SIZE];
6846 const mbedtls_md_info_t *md_info;
6847 mbedtls_md_context_t md_ctx;
6848 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6849
Gilles Peskine449bd832023-01-11 14:50:10 +01006850 mbedtls_md_init(&md_ctx);
Jerry Yudc7bd172022-02-17 13:44:15 +08006851
Gilles Peskine449bd832023-01-11 14:50:10 +01006852 if ((md_info = mbedtls_md_info_from_type(md_type)) == NULL) {
6853 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
6854 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006855
Gilles Peskine449bd832023-01-11 14:50:10 +01006856 md_len = mbedtls_md_get_size(md_info);
Jerry Yudc7bd172022-02-17 13:44:15 +08006857
Gilles Peskine449bd832023-01-11 14:50:10 +01006858 tmp_len = md_len + strlen(label) + rlen;
6859 tmp = mbedtls_calloc(1, tmp_len);
6860 if (tmp == NULL) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006861 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
6862 goto exit;
6863 }
6864
Gilles Peskine449bd832023-01-11 14:50:10 +01006865 nb = strlen(label);
6866 memcpy(tmp + md_len, label, nb);
6867 memcpy(tmp + md_len + nb, random, rlen);
Jerry Yudc7bd172022-02-17 13:44:15 +08006868 nb += rlen;
6869
6870 /*
6871 * Compute P_<hash>(secret, label + random)[0..dlen]
6872 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006873 if ((ret = mbedtls_md_setup(&md_ctx, md_info, 1)) != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006874 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006875 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006876
Gilles Peskine449bd832023-01-11 14:50:10 +01006877 ret = mbedtls_md_hmac_starts(&md_ctx, secret, slen);
6878 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006879 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006880 }
6881 ret = mbedtls_md_hmac_update(&md_ctx, tmp + md_len, nb);
6882 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006883 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006884 }
6885 ret = mbedtls_md_hmac_finish(&md_ctx, tmp);
6886 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006887 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006888 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006889
Gilles Peskine449bd832023-01-11 14:50:10 +01006890 for (i = 0; i < dlen; i += md_len) {
6891 ret = mbedtls_md_hmac_reset(&md_ctx);
6892 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006893 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006894 }
6895 ret = mbedtls_md_hmac_update(&md_ctx, tmp, md_len + nb);
6896 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006897 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006898 }
6899 ret = mbedtls_md_hmac_finish(&md_ctx, h_i);
6900 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006901 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006902 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006903
Gilles Peskine449bd832023-01-11 14:50:10 +01006904 ret = mbedtls_md_hmac_reset(&md_ctx);
6905 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006906 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006907 }
6908 ret = mbedtls_md_hmac_update(&md_ctx, tmp, md_len);
6909 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006910 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006911 }
6912 ret = mbedtls_md_hmac_finish(&md_ctx, tmp);
6913 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006914 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006915 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006916
Gilles Peskine449bd832023-01-11 14:50:10 +01006917 k = (i + md_len > dlen) ? dlen % md_len : md_len;
Jerry Yudc7bd172022-02-17 13:44:15 +08006918
Gilles Peskine449bd832023-01-11 14:50:10 +01006919 for (j = 0; j < k; j++) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006920 dstbuf[i + j] = h_i[j];
Gilles Peskine449bd832023-01-11 14:50:10 +01006921 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006922 }
6923
6924exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01006925 mbedtls_md_free(&md_ctx);
Jerry Yudc7bd172022-02-17 13:44:15 +08006926
Gilles Peskine449bd832023-01-11 14:50:10 +01006927 if (tmp != NULL) {
6928 mbedtls_platform_zeroize(tmp, tmp_len);
6929 }
Dave Rodgman29b9b2b2022-11-01 16:08:14 +00006930
Gilles Peskine449bd832023-01-11 14:50:10 +01006931 mbedtls_platform_zeroize(h_i, sizeof(h_i));
Jerry Yudc7bd172022-02-17 13:44:15 +08006932
Gilles Peskine449bd832023-01-11 14:50:10 +01006933 mbedtls_free(tmp);
Jerry Yudc7bd172022-02-17 13:44:15 +08006934
Gilles Peskine449bd832023-01-11 14:50:10 +01006935 return ret;
Jerry Yudc7bd172022-02-17 13:44:15 +08006936}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006937#endif /* MBEDTLS_MD_C && ( MBEDTLS_MD_CAN_SHA256 || MBEDTLS_MD_CAN_SHA384 ) */
Jerry Yudc7bd172022-02-17 13:44:15 +08006938#endif /* MBEDTLS_USE_PSA_CRYPTO */
6939
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006940#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006941MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006942static int tls_prf_sha256(const unsigned char *secret, size_t slen,
6943 const char *label,
6944 const unsigned char *random, size_t rlen,
6945 unsigned char *dstbuf, size_t dlen)
Jerry Yudc7bd172022-02-17 13:44:15 +08006946{
Gilles Peskine449bd832023-01-11 14:50:10 +01006947 return tls_prf_generic(MBEDTLS_MD_SHA256, secret, slen,
6948 label, random, rlen, dstbuf, dlen);
Jerry Yudc7bd172022-02-17 13:44:15 +08006949}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006950#endif /* MBEDTLS_MD_CAN_SHA256*/
Jerry Yudc7bd172022-02-17 13:44:15 +08006951
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006952#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006953MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006954static int tls_prf_sha384(const unsigned char *secret, size_t slen,
6955 const char *label,
6956 const unsigned char *random, size_t rlen,
6957 unsigned char *dstbuf, size_t dlen)
Jerry Yudc7bd172022-02-17 13:44:15 +08006958{
Gilles Peskine449bd832023-01-11 14:50:10 +01006959 return tls_prf_generic(MBEDTLS_MD_SHA384, secret, slen,
6960 label, random, rlen, dstbuf, dlen);
Jerry Yudc7bd172022-02-17 13:44:15 +08006961}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006962#endif /* MBEDTLS_MD_CAN_SHA384*/
Jerry Yudc7bd172022-02-17 13:44:15 +08006963
Jerry Yuf009d862022-02-17 14:01:37 +08006964/*
6965 * Set appropriate PRF function and other SSL / TLS1.2 functions
6966 *
6967 * Inputs:
Jerry Yuf009d862022-02-17 14:01:37 +08006968 * - hash associated with the ciphersuite (only used by TLS 1.2)
6969 *
6970 * Outputs:
6971 * - the tls_prf, calc_verify and calc_finished members of handshake structure
6972 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006973MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006974static int ssl_set_handshake_prfs(mbedtls_ssl_handshake_params *handshake,
6975 mbedtls_md_type_t hash)
Jerry Yuf009d862022-02-17 14:01:37 +08006976{
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006977#if defined(MBEDTLS_MD_CAN_SHA384)
Gilles Peskine449bd832023-01-11 14:50:10 +01006978 if (hash == MBEDTLS_MD_SHA384) {
Jerry Yuf009d862022-02-17 14:01:37 +08006979 handshake->tls_prf = tls_prf_sha384;
6980 handshake->calc_verify = ssl_calc_verify_tls_sha384;
6981 handshake->calc_finished = ssl_calc_finished_tls_sha384;
Gilles Peskine449bd832023-01-11 14:50:10 +01006982 } else
Jerry Yuf009d862022-02-17 14:01:37 +08006983#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006984#if defined(MBEDTLS_MD_CAN_SHA256)
Jerry Yuf009d862022-02-17 14:01:37 +08006985 {
Ronald Cron81591aa2022-03-07 09:05:51 +01006986 (void) hash;
Jerry Yuf009d862022-02-17 14:01:37 +08006987 handshake->tls_prf = tls_prf_sha256;
6988 handshake->calc_verify = ssl_calc_verify_tls_sha256;
6989 handshake->calc_finished = ssl_calc_finished_tls_sha256;
6990 }
Ronald Cron81591aa2022-03-07 09:05:51 +01006991#else
Jerry Yuf009d862022-02-17 14:01:37 +08006992 {
Jerry Yuf009d862022-02-17 14:01:37 +08006993 (void) handshake;
Ronald Cron81591aa2022-03-07 09:05:51 +01006994 (void) hash;
Gilles Peskine449bd832023-01-11 14:50:10 +01006995 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yuf009d862022-02-17 14:01:37 +08006996 }
Ronald Cron81591aa2022-03-07 09:05:51 +01006997#endif
Jerry Yuf009d862022-02-17 14:01:37 +08006998
Gilles Peskine449bd832023-01-11 14:50:10 +01006999 return 0;
Jerry Yuf009d862022-02-17 14:01:37 +08007000}
Jerry Yud6ab2352022-02-17 14:03:43 +08007001
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007002/*
7003 * Compute master secret if needed
7004 *
7005 * Parameters:
7006 * [in/out] handshake
7007 * [in] resume, premaster, extended_ms, calc_verify, tls_prf
7008 * (PSA-PSK) ciphersuite_info, psk_opaque
7009 * [out] premaster (cleared)
7010 * [out] master
7011 * [in] ssl: optionally used for debugging, EMS and PSA-PSK
7012 * debug: conf->f_dbg, conf->p_dbg
7013 * EMS: passed to calc_verify (debug + session_negotiate)
Ronald Crona25cf582022-03-07 11:10:36 +01007014 * PSA-PSA: conf
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007015 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007016MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007017static int ssl_compute_master(mbedtls_ssl_handshake_params *handshake,
7018 unsigned char *master,
7019 const mbedtls_ssl_context *ssl)
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007020{
7021 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7022
7023 /* cf. RFC 5246, Section 8.1:
7024 * "The master secret is always exactly 48 bytes in length." */
7025 size_t const master_secret_len = 48;
7026
7027#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
7028 unsigned char session_hash[48];
7029#endif /* MBEDTLS_SSL_EXTENDED_MASTER_SECRET */
7030
7031 /* The label for the KDF used for key expansion.
7032 * This is either "master secret" or "extended master secret"
7033 * depending on whether the Extended Master Secret extension
7034 * is used. */
7035 char const *lbl = "master secret";
7036
Przemek Stekielae4ed302022-04-05 17:15:55 +02007037 /* The seed for the KDF used for key expansion.
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007038 * - If the Extended Master Secret extension is not used,
7039 * this is ClientHello.Random + ServerHello.Random
7040 * (see Sect. 8.1 in RFC 5246).
7041 * - If the Extended Master Secret extension is used,
7042 * this is the transcript of the handshake so far.
7043 * (see Sect. 4 in RFC 7627). */
Przemek Stekielae4ed302022-04-05 17:15:55 +02007044 unsigned char const *seed = handshake->randbytes;
7045 size_t seed_len = 64;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007046
7047#if !defined(MBEDTLS_DEBUG_C) && \
7048 !defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET) && \
7049 !(defined(MBEDTLS_USE_PSA_CRYPTO) && \
Gilles Peskine449bd832023-01-11 14:50:10 +01007050 defined(MBEDTLS_KEY_EXCHANGE_PSK_ENABLED))
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007051 ssl = NULL; /* make sure we don't use it except for those cases */
7052 (void) ssl;
7053#endif
7054
Gilles Peskine449bd832023-01-11 14:50:10 +01007055 if (handshake->resume != 0) {
7056 MBEDTLS_SSL_DEBUG_MSG(3, ("no premaster (session resumed)"));
7057 return 0;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007058 }
7059
7060#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
Gilles Peskine449bd832023-01-11 14:50:10 +01007061 if (handshake->extended_ms == MBEDTLS_SSL_EXTENDED_MS_ENABLED) {
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007062 lbl = "extended master secret";
Przemek Stekielae4ed302022-04-05 17:15:55 +02007063 seed = session_hash;
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01007064 ret = handshake->calc_verify(ssl, session_hash, &seed_len);
7065 if (ret != 0) {
7066 MBEDTLS_SSL_DEBUG_RET(1, "calc_verify", ret);
7067 }
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007068
Gilles Peskine449bd832023-01-11 14:50:10 +01007069 MBEDTLS_SSL_DEBUG_BUF(3, "session hash for extended master secret",
7070 session_hash, seed_len);
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007071 }
Przemek Stekiel169bf0b2022-04-29 07:53:29 +02007072#endif /* MBEDTLS_SSL_EXTENDED_MASTER_SECRET */
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007073
Przemek Stekiel99114f32022-04-22 11:20:09 +02007074#if defined(MBEDTLS_USE_PSA_CRYPTO) && \
Przemek Stekiel8a4b7fd2022-04-28 09:22:22 +02007075 defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007076 if (mbedtls_ssl_ciphersuite_uses_psk(handshake->ciphersuite_info) == 1) {
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007077 /* Perform PSK-to-MS expansion in a single step. */
7078 psa_status_t status;
7079 psa_algorithm_t alg;
7080 mbedtls_svc_key_id_t psk;
7081 psa_key_derivation_operation_t derivation =
7082 PSA_KEY_DERIVATION_OPERATION_INIT;
Dave Rodgman2eab4622023-10-05 13:30:37 +01007083 mbedtls_md_type_t hash_alg = (mbedtls_md_type_t) handshake->ciphersuite_info->mac;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007084
Gilles Peskine449bd832023-01-11 14:50:10 +01007085 MBEDTLS_SSL_DEBUG_MSG(2, ("perform PSA-based PSK-to-MS expansion"));
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007086
Gilles Peskine449bd832023-01-11 14:50:10 +01007087 psk = mbedtls_ssl_get_opaque_psk(ssl);
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007088
Gilles Peskine449bd832023-01-11 14:50:10 +01007089 if (hash_alg == MBEDTLS_MD_SHA384) {
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007090 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_384);
Gilles Peskine449bd832023-01-11 14:50:10 +01007091 } else {
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007092 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_256);
Gilles Peskine449bd832023-01-11 14:50:10 +01007093 }
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007094
Przemek Stekiel51a1f362022-04-13 08:57:06 +02007095 size_t other_secret_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01007096 unsigned char *other_secret = NULL;
Przemek Stekielc2033402022-04-05 17:19:41 +02007097
Gilles Peskine449bd832023-01-11 14:50:10 +01007098 switch (handshake->ciphersuite_info->key_exchange) {
Przemek Stekiel19b80f82022-04-14 08:29:31 +02007099 /* Provide other secret.
Przemek Stekiel51a1f362022-04-13 08:57:06 +02007100 * Other secret is stored in premaster, where first 2 bytes hold the
Przemek Stekiel19b80f82022-04-14 08:29:31 +02007101 * length of the other key.
Przemek Stekielc2033402022-04-05 17:19:41 +02007102 */
Przemek Stekiel19b80f82022-04-14 08:29:31 +02007103 case MBEDTLS_KEY_EXCHANGE_RSA_PSK:
Przemek Stekiel8abcee92022-04-28 09:16:28 +02007104 /* For RSA-PSK other key length is always 48 bytes. */
Przemek Stekiel19b80f82022-04-14 08:29:31 +02007105 other_secret_len = 48;
7106 other_secret = handshake->premaster + 2;
7107 break;
7108 case MBEDTLS_KEY_EXCHANGE_ECDHE_PSK:
Przemek Stekielb293aaa2022-04-19 12:22:38 +02007109 case MBEDTLS_KEY_EXCHANGE_DHE_PSK:
Przemek Stekiel19b80f82022-04-14 08:29:31 +02007110 other_secret_len = MBEDTLS_GET_UINT16_BE(handshake->premaster, 0);
7111 other_secret = handshake->premaster + 2;
7112 break;
7113 default:
7114 break;
Przemek Stekielc2033402022-04-05 17:19:41 +02007115 }
7116
Gilles Peskine449bd832023-01-11 14:50:10 +01007117 status = setup_psa_key_derivation(&derivation, psk, alg,
7118 ssl->conf->psk, ssl->conf->psk_len,
7119 seed, seed_len,
7120 (unsigned char const *) lbl,
7121 (size_t) strlen(lbl),
7122 other_secret, other_secret_len,
7123 master_secret_len);
7124 if (status != PSA_SUCCESS) {
7125 psa_key_derivation_abort(&derivation);
7126 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007127 }
7128
Gilles Peskine449bd832023-01-11 14:50:10 +01007129 status = psa_key_derivation_output_bytes(&derivation,
7130 master,
7131 master_secret_len);
7132 if (status != PSA_SUCCESS) {
7133 psa_key_derivation_abort(&derivation);
7134 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007135 }
7136
Gilles Peskine449bd832023-01-11 14:50:10 +01007137 status = psa_key_derivation_abort(&derivation);
7138 if (status != PSA_SUCCESS) {
7139 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
7140 }
7141 } else
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007142#endif
7143 {
Neil Armstrongca7d5062022-05-31 14:43:23 +02007144#if defined(MBEDTLS_USE_PSA_CRYPTO) && \
Gilles Peskine449bd832023-01-11 14:50:10 +01007145 defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
7146 if (handshake->ciphersuite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_ECJPAKE) {
Neil Armstrongca7d5062022-05-31 14:43:23 +02007147 psa_status_t status;
7148 psa_algorithm_t alg = PSA_ALG_TLS12_ECJPAKE_TO_PMS;
7149 psa_key_derivation_operation_t derivation =
7150 PSA_KEY_DERIVATION_OPERATION_INIT;
7151
Gilles Peskine449bd832023-01-11 14:50:10 +01007152 MBEDTLS_SSL_DEBUG_MSG(2, ("perform PSA-based PMS KDF for ECJPAKE"));
Neil Armstrongca7d5062022-05-31 14:43:23 +02007153
7154 handshake->pmslen = PSA_TLS12_ECJPAKE_TO_PMS_DATA_SIZE;
7155
Gilles Peskine449bd832023-01-11 14:50:10 +01007156 status = psa_key_derivation_setup(&derivation, alg);
7157 if (status != PSA_SUCCESS) {
7158 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Neil Armstrongca7d5062022-05-31 14:43:23 +02007159 }
7160
Gilles Peskine449bd832023-01-11 14:50:10 +01007161 status = psa_key_derivation_set_capacity(&derivation,
7162 PSA_TLS12_ECJPAKE_TO_PMS_DATA_SIZE);
7163 if (status != PSA_SUCCESS) {
7164 psa_key_derivation_abort(&derivation);
7165 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Neil Armstrongca7d5062022-05-31 14:43:23 +02007166 }
7167
Gilles Peskine449bd832023-01-11 14:50:10 +01007168 status = psa_pake_get_implicit_key(&handshake->psa_pake_ctx,
7169 &derivation);
7170 if (status != PSA_SUCCESS) {
7171 psa_key_derivation_abort(&derivation);
7172 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Neil Armstrongca7d5062022-05-31 14:43:23 +02007173 }
7174
Gilles Peskine449bd832023-01-11 14:50:10 +01007175 status = psa_key_derivation_output_bytes(&derivation,
7176 handshake->premaster,
7177 handshake->pmslen);
7178 if (status != PSA_SUCCESS) {
7179 psa_key_derivation_abort(&derivation);
7180 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
7181 }
7182
7183 status = psa_key_derivation_abort(&derivation);
7184 if (status != PSA_SUCCESS) {
7185 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Neil Armstrongca7d5062022-05-31 14:43:23 +02007186 }
7187 }
7188#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01007189 ret = handshake->tls_prf(handshake->premaster, handshake->pmslen,
7190 lbl, seed, seed_len,
7191 master,
7192 master_secret_len);
7193 if (ret != 0) {
7194 MBEDTLS_SSL_DEBUG_RET(1, "prf", ret);
7195 return ret;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007196 }
7197
Gilles Peskine449bd832023-01-11 14:50:10 +01007198 MBEDTLS_SSL_DEBUG_BUF(3, "premaster secret",
7199 handshake->premaster,
7200 handshake->pmslen);
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007201
Gilles Peskine449bd832023-01-11 14:50:10 +01007202 mbedtls_platform_zeroize(handshake->premaster,
7203 sizeof(handshake->premaster));
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007204 }
7205
Gilles Peskine449bd832023-01-11 14:50:10 +01007206 return 0;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007207}
7208
Gilles Peskine449bd832023-01-11 14:50:10 +01007209int mbedtls_ssl_derive_keys(mbedtls_ssl_context *ssl)
Jerry Yud62f87e2022-02-17 14:09:02 +08007210{
7211 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7212 const mbedtls_ssl_ciphersuite_t * const ciphersuite_info =
7213 ssl->handshake->ciphersuite_info;
7214
Gilles Peskine449bd832023-01-11 14:50:10 +01007215 MBEDTLS_SSL_DEBUG_MSG(2, ("=> derive keys"));
Jerry Yud62f87e2022-02-17 14:09:02 +08007216
7217 /* Set PRF, calc_verify and calc_finished function pointers */
Gilles Peskine449bd832023-01-11 14:50:10 +01007218 ret = ssl_set_handshake_prfs(ssl->handshake,
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01007219 (mbedtls_md_type_t) ciphersuite_info->mac);
Gilles Peskine449bd832023-01-11 14:50:10 +01007220 if (ret != 0) {
7221 MBEDTLS_SSL_DEBUG_RET(1, "ssl_set_handshake_prfs", ret);
7222 return ret;
Jerry Yud62f87e2022-02-17 14:09:02 +08007223 }
7224
7225 /* Compute master secret if needed */
Gilles Peskine449bd832023-01-11 14:50:10 +01007226 ret = ssl_compute_master(ssl->handshake,
7227 ssl->session_negotiate->master,
7228 ssl);
7229 if (ret != 0) {
7230 MBEDTLS_SSL_DEBUG_RET(1, "ssl_compute_master", ret);
7231 return ret;
Jerry Yud62f87e2022-02-17 14:09:02 +08007232 }
7233
7234 /* Swap the client and server random values:
7235 * - MS derivation wanted client+server (RFC 5246 8.1)
7236 * - key derivation wants server+client (RFC 5246 6.3) */
7237 {
7238 unsigned char tmp[64];
Gilles Peskine449bd832023-01-11 14:50:10 +01007239 memcpy(tmp, ssl->handshake->randbytes, 64);
7240 memcpy(ssl->handshake->randbytes, tmp + 32, 32);
7241 memcpy(ssl->handshake->randbytes + 32, tmp, 32);
7242 mbedtls_platform_zeroize(tmp, sizeof(tmp));
Jerry Yud62f87e2022-02-17 14:09:02 +08007243 }
7244
7245 /* Populate transform structure */
Gilles Peskine449bd832023-01-11 14:50:10 +01007246 ret = ssl_tls12_populate_transform(ssl->transform_negotiate,
7247 ssl->session_negotiate->ciphersuite,
7248 ssl->session_negotiate->master,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02007249#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01007250 ssl->session_negotiate->encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02007251#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01007252 ssl->handshake->tls_prf,
7253 ssl->handshake->randbytes,
7254 ssl->tls_version,
7255 ssl->conf->endpoint,
7256 ssl);
7257 if (ret != 0) {
7258 MBEDTLS_SSL_DEBUG_RET(1, "ssl_tls12_populate_transform", ret);
7259 return ret;
Jerry Yud62f87e2022-02-17 14:09:02 +08007260 }
7261
7262 /* We no longer need Server/ClientHello.random values */
Gilles Peskine449bd832023-01-11 14:50:10 +01007263 mbedtls_platform_zeroize(ssl->handshake->randbytes,
7264 sizeof(ssl->handshake->randbytes));
Jerry Yud62f87e2022-02-17 14:09:02 +08007265
Gilles Peskine449bd832023-01-11 14:50:10 +01007266 MBEDTLS_SSL_DEBUG_MSG(2, ("<= derive keys"));
Jerry Yud62f87e2022-02-17 14:09:02 +08007267
Gilles Peskine449bd832023-01-11 14:50:10 +01007268 return 0;
Jerry Yud62f87e2022-02-17 14:09:02 +08007269}
Jerry Yu8392e0d2022-02-17 14:10:24 +08007270
Gilles Peskine449bd832023-01-11 14:50:10 +01007271int mbedtls_ssl_set_calc_verify_md(mbedtls_ssl_context *ssl, int md)
Ronald Cron4dcbca92022-03-07 10:21:40 +01007272{
Gilles Peskine449bd832023-01-11 14:50:10 +01007273 switch (md) {
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01007274#if defined(MBEDTLS_MD_CAN_SHA384)
Ronald Cron4dcbca92022-03-07 10:21:40 +01007275 case MBEDTLS_SSL_HASH_SHA384:
7276 ssl->handshake->calc_verify = ssl_calc_verify_tls_sha384;
7277 break;
7278#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01007279#if defined(MBEDTLS_MD_CAN_SHA256)
Ronald Cron4dcbca92022-03-07 10:21:40 +01007280 case MBEDTLS_SSL_HASH_SHA256:
7281 ssl->handshake->calc_verify = ssl_calc_verify_tls_sha256;
7282 break;
7283#endif
7284 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01007285 return -1;
Ronald Cron4dcbca92022-03-07 10:21:40 +01007286 }
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01007287#if !defined(MBEDTLS_MD_CAN_SHA384) && \
7288 !defined(MBEDTLS_MD_CAN_SHA256)
Andrzej Kurekeabeb302022-10-17 07:52:51 -04007289 (void) ssl;
7290#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01007291 return 0;
Ronald Cron4dcbca92022-03-07 10:21:40 +01007292}
7293
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007294#if defined(MBEDTLS_USE_PSA_CRYPTO)
7295static int ssl_calc_verify_tls_psa(const mbedtls_ssl_context *ssl,
7296 const psa_hash_operation_t *hs_op,
7297 size_t buffer_size,
7298 unsigned char *hash,
7299 size_t *hlen)
7300{
7301 psa_status_t status;
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007302 psa_hash_operation_t cloned_op = psa_hash_operation_init();
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007303
7304#if !defined(MBEDTLS_DEBUG_C)
7305 (void) ssl;
7306#endif
7307 MBEDTLS_SSL_DEBUG_MSG(2, ("=> PSA calc verify"));
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007308 status = psa_hash_clone(hs_op, &cloned_op);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007309 if (status != PSA_SUCCESS) {
7310 goto exit;
7311 }
7312
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007313 status = psa_hash_finish(&cloned_op, hash, buffer_size, hlen);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007314 if (status != PSA_SUCCESS) {
7315 goto exit;
7316 }
7317
7318 MBEDTLS_SSL_DEBUG_BUF(3, "PSA calculated verify result", hash, *hlen);
7319 MBEDTLS_SSL_DEBUG_MSG(2, ("<= PSA calc verify"));
7320
7321exit:
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007322 psa_hash_abort(&cloned_op);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007323 return mbedtls_md_error_from_psa(status);
7324}
7325#else
7326static int ssl_calc_verify_tls_legacy(const mbedtls_ssl_context *ssl,
7327 const mbedtls_md_context_t *hs_ctx,
7328 unsigned char *hash,
7329 size_t *hlen)
7330{
7331 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007332 mbedtls_md_context_t cloned_ctx;
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007333
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007334 mbedtls_md_init(&cloned_ctx);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007335
7336#if !defined(MBEDTLS_DEBUG_C)
7337 (void) ssl;
7338#endif
7339 MBEDTLS_SSL_DEBUG_MSG(2, ("=> calc verify"));
7340
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007341 ret = mbedtls_md_setup(&cloned_ctx, mbedtls_md_info_from_ctx(hs_ctx), 0);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007342 if (ret != 0) {
7343 goto exit;
7344 }
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007345 ret = mbedtls_md_clone(&cloned_ctx, hs_ctx);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007346 if (ret != 0) {
7347 goto exit;
7348 }
7349
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007350 ret = mbedtls_md_finish(&cloned_ctx, hash);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007351 if (ret != 0) {
7352 goto exit;
7353 }
7354
7355 *hlen = mbedtls_md_get_size(mbedtls_md_info_from_ctx(hs_ctx));
7356
7357 MBEDTLS_SSL_DEBUG_BUF(3, "calculated verify result", hash, *hlen);
7358 MBEDTLS_SSL_DEBUG_MSG(2, ("<= calc verify"));
7359
7360exit:
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007361 mbedtls_md_free(&cloned_ctx);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007362 return ret;
7363}
7364#endif /* MBEDTLS_USE_PSA_CRYPTO */
7365
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01007366#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +01007367int ssl_calc_verify_tls_sha256(const mbedtls_ssl_context *ssl,
7368 unsigned char *hash,
7369 size_t *hlen)
Jerry Yu8392e0d2022-02-17 14:10:24 +08007370{
7371#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007372 return ssl_calc_verify_tls_psa(ssl, &ssl->handshake->fin_sha256_psa, 32,
7373 hash, hlen);
Jerry Yu8392e0d2022-02-17 14:10:24 +08007374#else
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007375 return ssl_calc_verify_tls_legacy(ssl, &ssl->handshake->fin_sha256,
7376 hash, hlen);
Jerry Yu8392e0d2022-02-17 14:10:24 +08007377#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu8392e0d2022-02-17 14:10:24 +08007378}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01007379#endif /* MBEDTLS_MD_CAN_SHA256 */
Jerry Yu8392e0d2022-02-17 14:10:24 +08007380
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01007381#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +01007382int ssl_calc_verify_tls_sha384(const mbedtls_ssl_context *ssl,
7383 unsigned char *hash,
7384 size_t *hlen)
Jerry Yuc1cb3842022-02-17 14:13:48 +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_sha384_psa, 48,
7388 hash, hlen);
Jerry Yuc1cb3842022-02-17 14:13:48 +08007389#else
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007390 return ssl_calc_verify_tls_legacy(ssl, &ssl->handshake->fin_sha384,
7391 hash, hlen);
Jerry Yuc1cb3842022-02-17 14:13:48 +08007392#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yuc1cb3842022-02-17 14:13:48 +08007393}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01007394#endif /* MBEDTLS_MD_CAN_SHA384 */
Jerry Yuc1cb3842022-02-17 14:13:48 +08007395
Neil Armstrong80f6f322022-05-03 17:56:38 +02007396#if !defined(MBEDTLS_USE_PSA_CRYPTO) && \
7397 defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007398int mbedtls_ssl_psk_derive_premaster(mbedtls_ssl_context *ssl, mbedtls_key_exchange_type_t key_ex)
Jerry Yuce3dca42022-02-17 14:16:37 +08007399{
7400 unsigned char *p = ssl->handshake->premaster;
Gilles Peskine449bd832023-01-11 14:50:10 +01007401 unsigned char *end = p + sizeof(ssl->handshake->premaster);
Jerry Yuce3dca42022-02-17 14:16:37 +08007402 const unsigned char *psk = NULL;
7403 size_t psk_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01007404 int psk_ret = mbedtls_ssl_get_psk(ssl, &psk, &psk_len);
Jerry Yuce3dca42022-02-17 14:16:37 +08007405
Gilles Peskine449bd832023-01-11 14:50:10 +01007406 if (psk_ret == MBEDTLS_ERR_SSL_PRIVATE_KEY_REQUIRED) {
Jerry Yuce3dca42022-02-17 14:16:37 +08007407 /*
7408 * This should never happen because the existence of a PSK is always
Przemek Stekielb293aaa2022-04-19 12:22:38 +02007409 * checked before calling this function.
7410 *
7411 * The exception is opaque DHE-PSK. For DHE-PSK fill premaster with
Przemek Stekiel8abcee92022-04-28 09:16:28 +02007412 * the shared secret without PSK.
Jerry Yuce3dca42022-02-17 14:16:37 +08007413 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007414 if (key_ex != MBEDTLS_KEY_EXCHANGE_DHE_PSK) {
7415 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
7416 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Przemek Stekielb293aaa2022-04-19 12:22:38 +02007417 }
Jerry Yuce3dca42022-02-17 14:16:37 +08007418 }
7419
7420 /*
7421 * PMS = struct {
7422 * opaque other_secret<0..2^16-1>;
7423 * opaque psk<0..2^16-1>;
7424 * };
7425 * with "other_secret" depending on the particular key exchange
7426 */
7427#if defined(MBEDTLS_KEY_EXCHANGE_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007428 if (key_ex == MBEDTLS_KEY_EXCHANGE_PSK) {
7429 if (end - p < 2) {
7430 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
7431 }
Jerry Yuce3dca42022-02-17 14:16:37 +08007432
Gilles Peskine449bd832023-01-11 14:50:10 +01007433 MBEDTLS_PUT_UINT16_BE(psk_len, p, 0);
Jerry Yuce3dca42022-02-17 14:16:37 +08007434 p += 2;
7435
Gilles Peskine449bd832023-01-11 14:50:10 +01007436 if (end < p || (size_t) (end - p) < psk_len) {
7437 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
7438 }
Jerry Yuce3dca42022-02-17 14:16:37 +08007439
Gilles Peskine449bd832023-01-11 14:50:10 +01007440 memset(p, 0, psk_len);
Jerry Yuce3dca42022-02-17 14:16:37 +08007441 p += psk_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01007442 } else
Jerry Yuce3dca42022-02-17 14:16:37 +08007443#endif /* MBEDTLS_KEY_EXCHANGE_PSK_ENABLED */
7444#if defined(MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007445 if (key_ex == MBEDTLS_KEY_EXCHANGE_RSA_PSK) {
Jerry Yuce3dca42022-02-17 14:16:37 +08007446 /*
7447 * other_secret already set by the ClientKeyExchange message,
7448 * and is 48 bytes long
7449 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007450 if (end - p < 2) {
7451 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
7452 }
Jerry Yuce3dca42022-02-17 14:16:37 +08007453
7454 *p++ = 0;
7455 *p++ = 48;
7456 p += 48;
Gilles Peskine449bd832023-01-11 14:50:10 +01007457 } else
Jerry Yuce3dca42022-02-17 14:16:37 +08007458#endif /* MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED */
7459#if defined(MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007460 if (key_ex == MBEDTLS_KEY_EXCHANGE_DHE_PSK) {
Jerry Yuce3dca42022-02-17 14:16:37 +08007461 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7462 size_t len;
7463
7464 /* Write length only when we know the actual value */
Gilles Peskine449bd832023-01-11 14:50:10 +01007465 if ((ret = mbedtls_dhm_calc_secret(&ssl->handshake->dhm_ctx,
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00007466 p + 2, (size_t) (end - (p + 2)), &len,
Gilles Peskine449bd832023-01-11 14:50:10 +01007467 ssl->conf->f_rng, ssl->conf->p_rng)) != 0) {
7468 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_dhm_calc_secret", ret);
7469 return ret;
Jerry Yuce3dca42022-02-17 14:16:37 +08007470 }
Gilles Peskine449bd832023-01-11 14:50:10 +01007471 MBEDTLS_PUT_UINT16_BE(len, p, 0);
Jerry Yuce3dca42022-02-17 14:16:37 +08007472 p += 2 + len;
7473
Gilles Peskine449bd832023-01-11 14:50:10 +01007474 MBEDTLS_SSL_DEBUG_MPI(3, "DHM: K ", &ssl->handshake->dhm_ctx.K);
7475 } else
Jerry Yuce3dca42022-02-17 14:16:37 +08007476#endif /* MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED */
Neil Armstrong80f6f322022-05-03 17:56:38 +02007477#if defined(MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007478 if (key_ex == MBEDTLS_KEY_EXCHANGE_ECDHE_PSK) {
Jerry Yuce3dca42022-02-17 14:16:37 +08007479 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7480 size_t zlen;
7481
Gilles Peskine449bd832023-01-11 14:50:10 +01007482 if ((ret = mbedtls_ecdh_calc_secret(&ssl->handshake->ecdh_ctx, &zlen,
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00007483 p + 2, (size_t) (end - (p + 2)),
Gilles Peskine449bd832023-01-11 14:50:10 +01007484 ssl->conf->f_rng, ssl->conf->p_rng)) != 0) {
7485 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ecdh_calc_secret", ret);
7486 return ret;
Jerry Yuce3dca42022-02-17 14:16:37 +08007487 }
7488
Gilles Peskine449bd832023-01-11 14:50:10 +01007489 MBEDTLS_PUT_UINT16_BE(zlen, p, 0);
Jerry Yuce3dca42022-02-17 14:16:37 +08007490 p += 2 + zlen;
7491
Gilles Peskine449bd832023-01-11 14:50:10 +01007492 MBEDTLS_SSL_DEBUG_ECDH(3, &ssl->handshake->ecdh_ctx,
7493 MBEDTLS_DEBUG_ECDH_Z);
7494 } else
Neil Armstrong80f6f322022-05-03 17:56:38 +02007495#endif /* MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED */
Jerry Yuce3dca42022-02-17 14:16:37 +08007496 {
Gilles Peskine449bd832023-01-11 14:50:10 +01007497 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
7498 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yuce3dca42022-02-17 14:16:37 +08007499 }
7500
7501 /* opaque psk<0..2^16-1>; */
Gilles Peskine449bd832023-01-11 14:50:10 +01007502 if (end - p < 2) {
7503 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
7504 }
Jerry Yuce3dca42022-02-17 14:16:37 +08007505
Gilles Peskine449bd832023-01-11 14:50:10 +01007506 MBEDTLS_PUT_UINT16_BE(psk_len, p, 0);
Jerry Yuce3dca42022-02-17 14:16:37 +08007507 p += 2;
7508
Gilles Peskine449bd832023-01-11 14:50:10 +01007509 if (end < p || (size_t) (end - p) < psk_len) {
7510 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
7511 }
Jerry Yuce3dca42022-02-17 14:16:37 +08007512
Gilles Peskine449bd832023-01-11 14:50:10 +01007513 memcpy(p, psk, psk_len);
Jerry Yuce3dca42022-02-17 14:16:37 +08007514 p += psk_len;
7515
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00007516 ssl->handshake->pmslen = (size_t) (p - ssl->handshake->premaster);
Jerry Yuce3dca42022-02-17 14:16:37 +08007517
Gilles Peskine449bd832023-01-11 14:50:10 +01007518 return 0;
Jerry Yuce3dca42022-02-17 14:16:37 +08007519}
Neil Armstrong80f6f322022-05-03 17:56:38 +02007520#endif /* !MBEDTLS_USE_PSA_CRYPTO && MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
Jerry Yuc2c673d2022-02-17 14:20:39 +08007521
7522#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007523MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007524static int ssl_write_hello_request(mbedtls_ssl_context *ssl);
Jerry Yuc2c673d2022-02-17 14:20:39 +08007525
7526#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01007527int mbedtls_ssl_resend_hello_request(mbedtls_ssl_context *ssl)
Jerry Yuc2c673d2022-02-17 14:20:39 +08007528{
7529 /* If renegotiation is not enforced, retransmit until we would reach max
7530 * timeout if we were using the usual handshake doubling scheme */
Gilles Peskine449bd832023-01-11 14:50:10 +01007531 if (ssl->conf->renego_max_records < 0) {
Jerry Yuc2c673d2022-02-17 14:20:39 +08007532 uint32_t ratio = ssl->conf->hs_timeout_max / ssl->conf->hs_timeout_min + 1;
7533 unsigned char doublings = 1;
7534
Gilles Peskine449bd832023-01-11 14:50:10 +01007535 while (ratio != 0) {
Jerry Yuc2c673d2022-02-17 14:20:39 +08007536 ++doublings;
7537 ratio >>= 1;
7538 }
7539
Gilles Peskine449bd832023-01-11 14:50:10 +01007540 if (++ssl->renego_records_seen > doublings) {
7541 MBEDTLS_SSL_DEBUG_MSG(2, ("no longer retransmitting hello request"));
7542 return 0;
Jerry Yuc2c673d2022-02-17 14:20:39 +08007543 }
7544 }
7545
Gilles Peskine449bd832023-01-11 14:50:10 +01007546 return ssl_write_hello_request(ssl);
Jerry Yuc2c673d2022-02-17 14:20:39 +08007547}
7548#endif
7549#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_RENEGOTIATION */
Jerry Yud9526692022-02-17 14:23:47 +08007550
Jerry Yud9526692022-02-17 14:23:47 +08007551/*
7552 * Handshake functions
7553 */
7554#if !defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
7555/* No certificate support -> dummy functions */
Gilles Peskine449bd832023-01-11 14:50:10 +01007556int mbedtls_ssl_write_certificate(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08007557{
7558 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
7559 ssl->handshake->ciphersuite_info;
7560
Gilles Peskine449bd832023-01-11 14:50:10 +01007561 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007562
Gilles Peskine449bd832023-01-11 14:50:10 +01007563 if (!mbedtls_ssl_ciphersuite_uses_srv_cert(ciphersuite_info)) {
7564 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007565 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01007566 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007567 }
7568
Gilles Peskine449bd832023-01-11 14:50:10 +01007569 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
7570 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007571}
7572
Gilles Peskine449bd832023-01-11 14:50:10 +01007573int mbedtls_ssl_parse_certificate(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08007574{
7575 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
7576 ssl->handshake->ciphersuite_info;
7577
Gilles Peskine449bd832023-01-11 14:50:10 +01007578 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007579
Gilles Peskine449bd832023-01-11 14:50:10 +01007580 if (!mbedtls_ssl_ciphersuite_uses_srv_cert(ciphersuite_info)) {
7581 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007582 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01007583 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007584 }
7585
Gilles Peskine449bd832023-01-11 14:50:10 +01007586 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
7587 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007588}
7589
7590#else /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
7591/* Some certificate support -> implement write and parse */
7592
Gilles Peskine449bd832023-01-11 14:50:10 +01007593int mbedtls_ssl_write_certificate(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08007594{
7595 int ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
7596 size_t i, n;
7597 const mbedtls_x509_crt *crt;
7598 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
7599 ssl->handshake->ciphersuite_info;
7600
Gilles Peskine449bd832023-01-11 14:50:10 +01007601 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007602
Gilles Peskine449bd832023-01-11 14:50:10 +01007603 if (!mbedtls_ssl_ciphersuite_uses_srv_cert(ciphersuite_info)) {
7604 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007605 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01007606 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007607 }
7608
7609#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007610 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
7611 if (ssl->handshake->client_auth == 0) {
7612 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007613 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01007614 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007615 }
7616 }
7617#endif /* MBEDTLS_SSL_CLI_C */
7618#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007619 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
7620 if (mbedtls_ssl_own_cert(ssl) == NULL) {
Jerry Yud9526692022-02-17 14:23:47 +08007621 /* Should never happen because we shouldn't have picked the
7622 * ciphersuite if we don't have a certificate. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007623 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007624 }
7625 }
7626#endif
7627
Gilles Peskine449bd832023-01-11 14:50:10 +01007628 MBEDTLS_SSL_DEBUG_CRT(3, "own certificate", mbedtls_ssl_own_cert(ssl));
Jerry Yud9526692022-02-17 14:23:47 +08007629
7630 /*
7631 * 0 . 0 handshake type
7632 * 1 . 3 handshake length
7633 * 4 . 6 length of all certs
7634 * 7 . 9 length of cert. 1
7635 * 10 . n-1 peer certificate
7636 * n . n+2 length of cert. 2
7637 * n+3 . ... upper level cert, etc.
7638 */
7639 i = 7;
Gilles Peskine449bd832023-01-11 14:50:10 +01007640 crt = mbedtls_ssl_own_cert(ssl);
Jerry Yud9526692022-02-17 14:23:47 +08007641
Gilles Peskine449bd832023-01-11 14:50:10 +01007642 while (crt != NULL) {
Jerry Yud9526692022-02-17 14:23:47 +08007643 n = crt->raw.len;
Gilles Peskine449bd832023-01-11 14:50:10 +01007644 if (n > MBEDTLS_SSL_OUT_CONTENT_LEN - 3 - i) {
7645 MBEDTLS_SSL_DEBUG_MSG(1, ("certificate too large, %" MBEDTLS_PRINTF_SIZET
7646 " > %" MBEDTLS_PRINTF_SIZET,
7647 i + 3 + n, (size_t) MBEDTLS_SSL_OUT_CONTENT_LEN));
7648 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
Jerry Yud9526692022-02-17 14:23:47 +08007649 }
7650
Gilles Peskine449bd832023-01-11 14:50:10 +01007651 ssl->out_msg[i] = MBEDTLS_BYTE_2(n);
7652 ssl->out_msg[i + 1] = MBEDTLS_BYTE_1(n);
7653 ssl->out_msg[i + 2] = MBEDTLS_BYTE_0(n);
Jerry Yud9526692022-02-17 14:23:47 +08007654
Gilles Peskine449bd832023-01-11 14:50:10 +01007655 i += 3; memcpy(ssl->out_msg + i, crt->raw.p, n);
Jerry Yud9526692022-02-17 14:23:47 +08007656 i += n; crt = crt->next;
7657 }
7658
Gilles Peskine449bd832023-01-11 14:50:10 +01007659 ssl->out_msg[4] = MBEDTLS_BYTE_2(i - 7);
7660 ssl->out_msg[5] = MBEDTLS_BYTE_1(i - 7);
7661 ssl->out_msg[6] = MBEDTLS_BYTE_0(i - 7);
Jerry Yud9526692022-02-17 14:23:47 +08007662
7663 ssl->out_msglen = i;
7664 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
7665 ssl->out_msg[0] = MBEDTLS_SSL_HS_CERTIFICATE;
7666
7667 ssl->state++;
7668
Gilles Peskine449bd832023-01-11 14:50:10 +01007669 if ((ret = mbedtls_ssl_write_handshake_msg(ssl)) != 0) {
7670 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_handshake_msg", ret);
7671 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007672 }
7673
Gilles Peskine449bd832023-01-11 14:50:10 +01007674 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007675
Gilles Peskine449bd832023-01-11 14:50:10 +01007676 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007677}
7678
7679#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
7680
7681#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007682MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007683static int ssl_check_peer_crt_unchanged(mbedtls_ssl_context *ssl,
7684 unsigned char *crt_buf,
7685 size_t crt_buf_len)
Jerry Yud9526692022-02-17 14:23:47 +08007686{
7687 mbedtls_x509_crt const * const peer_crt = ssl->session->peer_cert;
7688
Gilles Peskine449bd832023-01-11 14:50:10 +01007689 if (peer_crt == NULL) {
7690 return -1;
7691 }
Jerry Yud9526692022-02-17 14:23:47 +08007692
Gilles Peskine449bd832023-01-11 14:50:10 +01007693 if (peer_crt->raw.len != crt_buf_len) {
7694 return -1;
7695 }
Jerry Yud9526692022-02-17 14:23:47 +08007696
Gilles Peskine449bd832023-01-11 14:50:10 +01007697 return memcmp(peer_crt->raw.p, crt_buf, peer_crt->raw.len);
Jerry Yud9526692022-02-17 14:23:47 +08007698}
7699#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007700MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007701static int ssl_check_peer_crt_unchanged(mbedtls_ssl_context *ssl,
7702 unsigned char *crt_buf,
7703 size_t crt_buf_len)
Jerry Yud9526692022-02-17 14:23:47 +08007704{
7705 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7706 unsigned char const * const peer_cert_digest =
7707 ssl->session->peer_cert_digest;
7708 mbedtls_md_type_t const peer_cert_digest_type =
7709 ssl->session->peer_cert_digest_type;
7710 mbedtls_md_info_t const * const digest_info =
Gilles Peskine449bd832023-01-11 14:50:10 +01007711 mbedtls_md_info_from_type(peer_cert_digest_type);
Jerry Yud9526692022-02-17 14:23:47 +08007712 unsigned char tmp_digest[MBEDTLS_SSL_PEER_CERT_DIGEST_MAX_LEN];
7713 size_t digest_len;
7714
Gilles Peskine449bd832023-01-11 14:50:10 +01007715 if (peer_cert_digest == NULL || digest_info == NULL) {
7716 return -1;
7717 }
Jerry Yud9526692022-02-17 14:23:47 +08007718
Gilles Peskine449bd832023-01-11 14:50:10 +01007719 digest_len = mbedtls_md_get_size(digest_info);
7720 if (digest_len > MBEDTLS_SSL_PEER_CERT_DIGEST_MAX_LEN) {
7721 return -1;
7722 }
Jerry Yud9526692022-02-17 14:23:47 +08007723
Gilles Peskine449bd832023-01-11 14:50:10 +01007724 ret = mbedtls_md(digest_info, crt_buf, crt_buf_len, tmp_digest);
7725 if (ret != 0) {
7726 return -1;
7727 }
Jerry Yud9526692022-02-17 14:23:47 +08007728
Gilles Peskine449bd832023-01-11 14:50:10 +01007729 return memcmp(tmp_digest, peer_cert_digest, digest_len);
Jerry Yud9526692022-02-17 14:23:47 +08007730}
7731#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7732#endif /* MBEDTLS_SSL_RENEGOTIATION && MBEDTLS_SSL_CLI_C */
7733
7734/*
7735 * Once the certificate message is read, parse it into a cert chain and
7736 * perform basic checks, but leave actual verification to the caller
7737 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007738MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007739static int ssl_parse_certificate_chain(mbedtls_ssl_context *ssl,
7740 mbedtls_x509_crt *chain)
Jerry Yud9526692022-02-17 14:23:47 +08007741{
7742 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7743#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007744 int crt_cnt = 0;
Jerry Yud9526692022-02-17 14:23:47 +08007745#endif
7746 size_t i, n;
7747 uint8_t alert;
7748
Gilles Peskine449bd832023-01-11 14:50:10 +01007749 if (ssl->in_msgtype != MBEDTLS_SSL_MSG_HANDSHAKE) {
7750 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7751 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7752 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
7753 return MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
Jerry Yud9526692022-02-17 14:23:47 +08007754 }
7755
Gilles Peskine449bd832023-01-11 14:50:10 +01007756 if (ssl->in_msg[0] != MBEDTLS_SSL_HS_CERTIFICATE) {
7757 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7758 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
7759 return MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
Jerry Yud9526692022-02-17 14:23:47 +08007760 }
7761
Gilles Peskine449bd832023-01-11 14:50:10 +01007762 if (ssl->in_hslen < mbedtls_ssl_hs_hdr_len(ssl) + 3 + 3) {
7763 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7764 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7765 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
7766 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007767 }
7768
Gilles Peskine449bd832023-01-11 14:50:10 +01007769 i = mbedtls_ssl_hs_hdr_len(ssl);
Jerry Yud9526692022-02-17 14:23:47 +08007770
7771 /*
7772 * Same message structure as in mbedtls_ssl_write_certificate()
7773 */
Dave Rodgmana3d0f612023-11-03 23:34:02 +00007774 n = MBEDTLS_GET_UINT16_BE(ssl->in_msg, i + 1);
Jerry Yud9526692022-02-17 14:23:47 +08007775
Gilles Peskine449bd832023-01-11 14:50:10 +01007776 if (ssl->in_msg[i] != 0 ||
7777 ssl->in_hslen != n + 3 + mbedtls_ssl_hs_hdr_len(ssl)) {
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
7784 /* Make &ssl->in_msg[i] point to the beginning of the CRT chain. */
7785 i += 3;
7786
7787 /* Iterate through and parse the CRTs in the provided chain. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007788 while (i < ssl->in_hslen) {
Jerry Yud9526692022-02-17 14:23:47 +08007789 /* Check that there's room for the next CRT's length fields. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007790 if (i + 3 > ssl->in_hslen) {
7791 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7792 mbedtls_ssl_send_alert_message(ssl,
7793 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7794 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
7795 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007796 }
7797 /* In theory, the CRT can be up to 2**24 Bytes, but we don't support
7798 * anything beyond 2**16 ~ 64K. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007799 if (ssl->in_msg[i] != 0) {
7800 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7801 mbedtls_ssl_send_alert_message(ssl,
7802 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7803 MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT);
7804 return MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
Jerry Yud9526692022-02-17 14:23:47 +08007805 }
7806
7807 /* Read length of the next CRT in the chain. */
Dave Rodgmana3d0f612023-11-03 23:34:02 +00007808 n = MBEDTLS_GET_UINT16_BE(ssl->in_msg, i + 1);
Jerry Yud9526692022-02-17 14:23:47 +08007809 i += 3;
7810
Gilles Peskine449bd832023-01-11 14:50:10 +01007811 if (n < 128 || i + n > ssl->in_hslen) {
7812 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7813 mbedtls_ssl_send_alert_message(ssl,
7814 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7815 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
7816 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007817 }
7818
7819 /* Check if we're handling the first CRT in the chain. */
7820#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007821 if (crt_cnt++ == 0 &&
Jerry Yud9526692022-02-17 14:23:47 +08007822 ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
Gilles Peskine449bd832023-01-11 14:50:10 +01007823 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS) {
Jerry Yud9526692022-02-17 14:23:47 +08007824 /* During client-side renegotiation, check that the server's
7825 * end-CRTs hasn't changed compared to the initial handshake,
7826 * mitigating the triple handshake attack. On success, reuse
7827 * the original end-CRT instead of parsing it again. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007828 MBEDTLS_SSL_DEBUG_MSG(3, ("Check that peer CRT hasn't changed during renegotiation"));
7829 if (ssl_check_peer_crt_unchanged(ssl,
7830 &ssl->in_msg[i],
7831 n) != 0) {
7832 MBEDTLS_SSL_DEBUG_MSG(1, ("new server cert during renegotiation"));
7833 mbedtls_ssl_send_alert_message(ssl,
7834 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7835 MBEDTLS_SSL_ALERT_MSG_ACCESS_DENIED);
7836 return MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
Jerry Yud9526692022-02-17 14:23:47 +08007837 }
7838
7839 /* Now we can safely free the original chain. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007840 ssl_clear_peer_cert(ssl->session);
Jerry Yud9526692022-02-17 14:23:47 +08007841 }
7842#endif /* MBEDTLS_SSL_RENEGOTIATION && MBEDTLS_SSL_CLI_C */
7843
7844 /* Parse the next certificate in the chain. */
7845#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01007846 ret = mbedtls_x509_crt_parse_der(chain, ssl->in_msg + i, n);
Jerry Yud9526692022-02-17 14:23:47 +08007847#else
7848 /* If we don't need to store the CRT chain permanently, parse
7849 * it in-place from the input buffer instead of making a copy. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007850 ret = mbedtls_x509_crt_parse_der_nocopy(chain, ssl->in_msg + i, n);
Jerry Yud9526692022-02-17 14:23:47 +08007851#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Gilles Peskine449bd832023-01-11 14:50:10 +01007852 switch (ret) {
Jerry Yud9526692022-02-17 14:23:47 +08007853 case 0: /*ok*/
7854 case MBEDTLS_ERR_X509_UNKNOWN_SIG_ALG + MBEDTLS_ERR_OID_NOT_FOUND:
7855 /* Ignore certificate with an unknown algorithm: maybe a
7856 prior certificate was already trusted. */
7857 break;
7858
7859 case MBEDTLS_ERR_X509_ALLOC_FAILED:
7860 alert = MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR;
7861 goto crt_parse_der_failed;
7862
7863 case MBEDTLS_ERR_X509_UNKNOWN_VERSION:
7864 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
7865 goto crt_parse_der_failed;
7866
7867 default:
7868 alert = MBEDTLS_SSL_ALERT_MSG_BAD_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01007869crt_parse_der_failed:
7870 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL, alert);
7871 MBEDTLS_SSL_DEBUG_RET(1, " mbedtls_x509_crt_parse_der", ret);
7872 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007873 }
7874
7875 i += n;
7876 }
7877
Gilles Peskine449bd832023-01-11 14:50:10 +01007878 MBEDTLS_SSL_DEBUG_CRT(3, "peer certificate", chain);
7879 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007880}
7881
7882#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007883MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007884static int ssl_srv_check_client_no_crt_notification(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08007885{
Gilles Peskine449bd832023-01-11 14:50:10 +01007886 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
7887 return -1;
7888 }
Jerry Yud9526692022-02-17 14:23:47 +08007889
Gilles Peskine449bd832023-01-11 14:50:10 +01007890 if (ssl->in_hslen == 3 + mbedtls_ssl_hs_hdr_len(ssl) &&
Jerry Yud9526692022-02-17 14:23:47 +08007891 ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
7892 ssl->in_msg[0] == MBEDTLS_SSL_HS_CERTIFICATE &&
Gilles Peskine449bd832023-01-11 14:50:10 +01007893 memcmp(ssl->in_msg + mbedtls_ssl_hs_hdr_len(ssl), "\0\0\0", 3) == 0) {
7894 MBEDTLS_SSL_DEBUG_MSG(1, ("peer has no certificate"));
7895 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007896 }
Gilles Peskine449bd832023-01-11 14:50:10 +01007897 return -1;
Jerry Yud9526692022-02-17 14:23:47 +08007898}
7899#endif /* MBEDTLS_SSL_SRV_C */
7900
7901/* Check if a certificate message is expected.
7902 * Return either
7903 * - SSL_CERTIFICATE_EXPECTED, or
7904 * - SSL_CERTIFICATE_SKIP
7905 * indicating whether a Certificate message is expected or not.
7906 */
7907#define SSL_CERTIFICATE_EXPECTED 0
7908#define SSL_CERTIFICATE_SKIP 1
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007909MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007910static int ssl_parse_certificate_coordinate(mbedtls_ssl_context *ssl,
7911 int authmode)
Jerry Yud9526692022-02-17 14:23:47 +08007912{
7913 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
7914 ssl->handshake->ciphersuite_info;
7915
Gilles Peskine449bd832023-01-11 14:50:10 +01007916 if (!mbedtls_ssl_ciphersuite_uses_srv_cert(ciphersuite_info)) {
7917 return SSL_CERTIFICATE_SKIP;
7918 }
Jerry Yud9526692022-02-17 14:23:47 +08007919
7920#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007921 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
7922 if (ciphersuite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_RSA_PSK) {
7923 return SSL_CERTIFICATE_SKIP;
7924 }
Jerry Yud9526692022-02-17 14:23:47 +08007925
Gilles Peskine449bd832023-01-11 14:50:10 +01007926 if (authmode == MBEDTLS_SSL_VERIFY_NONE) {
Jerry Yud9526692022-02-17 14:23:47 +08007927 ssl->session_negotiate->verify_result =
7928 MBEDTLS_X509_BADCERT_SKIP_VERIFY;
Gilles Peskine449bd832023-01-11 14:50:10 +01007929 return SSL_CERTIFICATE_SKIP;
Jerry Yud9526692022-02-17 14:23:47 +08007930 }
7931 }
7932#else
7933 ((void) authmode);
7934#endif /* MBEDTLS_SSL_SRV_C */
7935
Gilles Peskine449bd832023-01-11 14:50:10 +01007936 return SSL_CERTIFICATE_EXPECTED;
Jerry Yud9526692022-02-17 14:23:47 +08007937}
7938
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007939MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007940static int ssl_parse_certificate_verify(mbedtls_ssl_context *ssl,
7941 int authmode,
7942 mbedtls_x509_crt *chain,
7943 void *rs_ctx)
Jerry Yud9526692022-02-17 14:23:47 +08007944{
7945 int ret = 0;
7946 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
7947 ssl->handshake->ciphersuite_info;
7948 int have_ca_chain = 0;
7949
7950 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *);
7951 void *p_vrfy;
7952
Gilles Peskine449bd832023-01-11 14:50:10 +01007953 if (authmode == MBEDTLS_SSL_VERIFY_NONE) {
7954 return 0;
7955 }
Jerry Yud9526692022-02-17 14:23:47 +08007956
Gilles Peskine449bd832023-01-11 14:50:10 +01007957 if (ssl->f_vrfy != NULL) {
7958 MBEDTLS_SSL_DEBUG_MSG(3, ("Use context-specific verification callback"));
Jerry Yud9526692022-02-17 14:23:47 +08007959 f_vrfy = ssl->f_vrfy;
7960 p_vrfy = ssl->p_vrfy;
Gilles Peskine449bd832023-01-11 14:50:10 +01007961 } else {
7962 MBEDTLS_SSL_DEBUG_MSG(3, ("Use configuration-specific verification callback"));
Jerry Yud9526692022-02-17 14:23:47 +08007963 f_vrfy = ssl->conf->f_vrfy;
7964 p_vrfy = ssl->conf->p_vrfy;
7965 }
7966
7967 /*
7968 * Main check: verify certificate
7969 */
7970#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
Gilles Peskine449bd832023-01-11 14:50:10 +01007971 if (ssl->conf->f_ca_cb != NULL) {
Jerry Yud9526692022-02-17 14:23:47 +08007972 ((void) rs_ctx);
7973 have_ca_chain = 1;
7974
Gilles Peskine449bd832023-01-11 14:50:10 +01007975 MBEDTLS_SSL_DEBUG_MSG(3, ("use CA callback for X.509 CRT verification"));
Jerry Yud9526692022-02-17 14:23:47 +08007976 ret = mbedtls_x509_crt_verify_with_ca_cb(
7977 chain,
7978 ssl->conf->f_ca_cb,
7979 ssl->conf->p_ca_cb,
7980 ssl->conf->cert_profile,
7981 ssl->hostname,
7982 &ssl->session_negotiate->verify_result,
Gilles Peskine449bd832023-01-11 14:50:10 +01007983 f_vrfy, p_vrfy);
7984 } else
Jerry Yud9526692022-02-17 14:23:47 +08007985#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
7986 {
7987 mbedtls_x509_crt *ca_chain;
7988 mbedtls_x509_crl *ca_crl;
7989
7990#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01007991 if (ssl->handshake->sni_ca_chain != NULL) {
Jerry Yud9526692022-02-17 14:23:47 +08007992 ca_chain = ssl->handshake->sni_ca_chain;
7993 ca_crl = ssl->handshake->sni_ca_crl;
Gilles Peskine449bd832023-01-11 14:50:10 +01007994 } else
Jerry Yud9526692022-02-17 14:23:47 +08007995#endif
7996 {
7997 ca_chain = ssl->conf->ca_chain;
7998 ca_crl = ssl->conf->ca_crl;
7999 }
8000
Gilles Peskine449bd832023-01-11 14:50:10 +01008001 if (ca_chain != NULL) {
Jerry Yud9526692022-02-17 14:23:47 +08008002 have_ca_chain = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01008003 }
Jerry Yud9526692022-02-17 14:23:47 +08008004
8005 ret = mbedtls_x509_crt_verify_restartable(
8006 chain,
8007 ca_chain, ca_crl,
8008 ssl->conf->cert_profile,
8009 ssl->hostname,
8010 &ssl->session_negotiate->verify_result,
Gilles Peskine449bd832023-01-11 14:50:10 +01008011 f_vrfy, p_vrfy, rs_ctx);
Jerry Yud9526692022-02-17 14:23:47 +08008012 }
8013
Gilles Peskine449bd832023-01-11 14:50:10 +01008014 if (ret != 0) {
8015 MBEDTLS_SSL_DEBUG_RET(1, "x509_verify_cert", ret);
Jerry Yud9526692022-02-17 14:23:47 +08008016 }
8017
8018#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01008019 if (ret == MBEDTLS_ERR_ECP_IN_PROGRESS) {
8020 return MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS;
8021 }
Jerry Yud9526692022-02-17 14:23:47 +08008022#endif
8023
8024 /*
8025 * Secondary checks: always done, but change 'ret' only if it was 0
8026 */
8027
Valerio Settiacd32c02023-06-29 18:06:29 +02008028#if defined(MBEDTLS_PK_HAVE_ECC_KEYS)
Jerry Yud9526692022-02-17 14:23:47 +08008029 {
8030 const mbedtls_pk_context *pk = &chain->pk;
8031
Manuel Pégourié-Gonnard66b0d612022-06-17 10:49:29 +02008032 /* If certificate uses an EC key, make sure the curve is OK.
8033 * This is a public key, so it can't be opaque, so can_do() is a good
8034 * enough check to ensure pk_ec() is safe to use here. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008035 if (mbedtls_pk_can_do(pk, MBEDTLS_PK_ECKEY)) {
Leonid Rozenboim19e59732022-08-08 16:52:38 -07008036 /* and in the unlikely case the above assumption no longer holds
8037 * we are making sure that pk_ec() here does not return a NULL
8038 */
Valerio Settif9362b72023-11-29 08:42:27 +01008039 mbedtls_ecp_group_id grp_id = mbedtls_pk_get_ec_group_id(pk);
Valerio Settid0405092023-05-24 13:16:40 +02008040 if (grp_id == MBEDTLS_ECP_DP_NONE) {
8041 MBEDTLS_SSL_DEBUG_MSG(1, ("invalid group ID"));
Gilles Peskine449bd832023-01-11 14:50:10 +01008042 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Leonid Rozenboim19e59732022-08-08 16:52:38 -07008043 }
Valerio Setti97207782023-05-18 18:59:06 +02008044 if (mbedtls_ssl_check_curve(ssl, grp_id) != 0) {
Leonid Rozenboim19e59732022-08-08 16:52:38 -07008045 ssl->session_negotiate->verify_result |=
8046 MBEDTLS_X509_BADCERT_BAD_KEY;
8047
Gilles Peskine449bd832023-01-11 14:50:10 +01008048 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate (EC key curve)"));
8049 if (ret == 0) {
Leonid Rozenboim19e59732022-08-08 16:52:38 -07008050 ret = MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
Gilles Peskine449bd832023-01-11 14:50:10 +01008051 }
Leonid Rozenboim19e59732022-08-08 16:52:38 -07008052 }
Jerry Yud9526692022-02-17 14:23:47 +08008053 }
8054 }
Valerio Settiacd32c02023-06-29 18:06:29 +02008055#endif /* MBEDTLS_PK_HAVE_ECC_KEYS */
Jerry Yud9526692022-02-17 14:23:47 +08008056
Gilles Peskine449bd832023-01-11 14:50:10 +01008057 if (mbedtls_ssl_check_cert_usage(chain,
8058 ciphersuite_info,
8059 !ssl->conf->endpoint,
8060 &ssl->session_negotiate->verify_result) != 0) {
8061 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate (usage extensions)"));
8062 if (ret == 0) {
Jerry Yud9526692022-02-17 14:23:47 +08008063 ret = MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
Gilles Peskine449bd832023-01-11 14:50:10 +01008064 }
Jerry Yud9526692022-02-17 14:23:47 +08008065 }
8066
8067 /* mbedtls_x509_crt_verify_with_profile is supposed to report a
8068 * verification failure through MBEDTLS_ERR_X509_CERT_VERIFY_FAILED,
8069 * with details encoded in the verification flags. All other kinds
8070 * of error codes, including those from the user provided f_vrfy
8071 * functions, are treated as fatal and lead to a failure of
8072 * ssl_parse_certificate even if verification was optional. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008073 if (authmode == MBEDTLS_SSL_VERIFY_OPTIONAL &&
8074 (ret == MBEDTLS_ERR_X509_CERT_VERIFY_FAILED ||
8075 ret == MBEDTLS_ERR_SSL_BAD_CERTIFICATE)) {
Jerry Yud9526692022-02-17 14:23:47 +08008076 ret = 0;
8077 }
8078
Gilles Peskine449bd832023-01-11 14:50:10 +01008079 if (have_ca_chain == 0 && authmode == MBEDTLS_SSL_VERIFY_REQUIRED) {
8080 MBEDTLS_SSL_DEBUG_MSG(1, ("got no CA chain"));
Jerry Yud9526692022-02-17 14:23:47 +08008081 ret = MBEDTLS_ERR_SSL_CA_CHAIN_REQUIRED;
8082 }
8083
Gilles Peskine449bd832023-01-11 14:50:10 +01008084 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08008085 uint8_t alert;
8086
8087 /* The certificate may have been rejected for several reasons.
8088 Pick one and send the corresponding alert. Which alert to send
8089 may be a subject of debate in some cases. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008090 if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_OTHER) {
Jerry Yud9526692022-02-17 14:23:47 +08008091 alert = MBEDTLS_SSL_ALERT_MSG_ACCESS_DENIED;
Gilles Peskine449bd832023-01-11 14:50:10 +01008092 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_CN_MISMATCH) {
Jerry Yud9526692022-02-17 14:23:47 +08008093 alert = MBEDTLS_SSL_ALERT_MSG_BAD_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01008094 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_KEY_USAGE) {
Jerry Yud9526692022-02-17 14:23:47 +08008095 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01008096 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_EXT_KEY_USAGE) {
Jerry Yud9526692022-02-17 14:23:47 +08008097 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01008098 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_NS_CERT_TYPE) {
Jerry Yud9526692022-02-17 14:23:47 +08008099 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01008100 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_BAD_PK) {
Jerry Yud9526692022-02-17 14:23:47 +08008101 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01008102 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_BAD_KEY) {
Jerry Yud9526692022-02-17 14:23:47 +08008103 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01008104 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_EXPIRED) {
Jerry Yud9526692022-02-17 14:23:47 +08008105 alert = MBEDTLS_SSL_ALERT_MSG_CERT_EXPIRED;
Gilles Peskine449bd832023-01-11 14:50:10 +01008106 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_REVOKED) {
Jerry Yud9526692022-02-17 14:23:47 +08008107 alert = MBEDTLS_SSL_ALERT_MSG_CERT_REVOKED;
Gilles Peskine449bd832023-01-11 14:50:10 +01008108 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_NOT_TRUSTED) {
Jerry Yud9526692022-02-17 14:23:47 +08008109 alert = MBEDTLS_SSL_ALERT_MSG_UNKNOWN_CA;
Gilles Peskine449bd832023-01-11 14:50:10 +01008110 } else {
Jerry Yud9526692022-02-17 14:23:47 +08008111 alert = MBEDTLS_SSL_ALERT_MSG_CERT_UNKNOWN;
Gilles Peskine449bd832023-01-11 14:50:10 +01008112 }
8113 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8114 alert);
Jerry Yud9526692022-02-17 14:23:47 +08008115 }
8116
8117#if defined(MBEDTLS_DEBUG_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008118 if (ssl->session_negotiate->verify_result != 0) {
8119 MBEDTLS_SSL_DEBUG_MSG(3, ("! Certificate verification flags %08x",
8120 (unsigned int) ssl->session_negotiate->verify_result));
8121 } else {
8122 MBEDTLS_SSL_DEBUG_MSG(3, ("Certificate verification flags clear"));
Jerry Yud9526692022-02-17 14:23:47 +08008123 }
8124#endif /* MBEDTLS_DEBUG_C */
8125
Gilles Peskine449bd832023-01-11 14:50:10 +01008126 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08008127}
8128
8129#if !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02008130MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01008131static int ssl_remember_peer_crt_digest(mbedtls_ssl_context *ssl,
8132 unsigned char *start, size_t len)
Jerry Yud9526692022-02-17 14:23:47 +08008133{
8134 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
8135 /* Remember digest of the peer's end-CRT. */
8136 ssl->session_negotiate->peer_cert_digest =
Gilles Peskine449bd832023-01-11 14:50:10 +01008137 mbedtls_calloc(1, MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN);
8138 if (ssl->session_negotiate->peer_cert_digest == NULL) {
8139 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc(%d bytes) failed",
8140 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN));
8141 mbedtls_ssl_send_alert_message(ssl,
8142 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8143 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR);
Jerry Yud9526692022-02-17 14:23:47 +08008144
Gilles Peskine449bd832023-01-11 14:50:10 +01008145 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
Jerry Yud9526692022-02-17 14:23:47 +08008146 }
8147
Gilles Peskine449bd832023-01-11 14:50:10 +01008148 ret = mbedtls_md(mbedtls_md_info_from_type(
8149 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE),
8150 start, len,
8151 ssl->session_negotiate->peer_cert_digest);
Jerry Yud9526692022-02-17 14:23:47 +08008152
8153 ssl->session_negotiate->peer_cert_digest_type =
8154 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE;
8155 ssl->session_negotiate->peer_cert_digest_len =
8156 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN;
8157
Gilles Peskine449bd832023-01-11 14:50:10 +01008158 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08008159}
8160
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02008161MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01008162static int ssl_remember_peer_pubkey(mbedtls_ssl_context *ssl,
8163 unsigned char *start, size_t len)
Jerry Yud9526692022-02-17 14:23:47 +08008164{
8165 unsigned char *end = start + len;
8166 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
8167
8168 /* Make a copy of the peer's raw public key. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008169 mbedtls_pk_init(&ssl->handshake->peer_pubkey);
8170 ret = mbedtls_pk_parse_subpubkey(&start, end,
8171 &ssl->handshake->peer_pubkey);
8172 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08008173 /* We should have parsed the public key before. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008174 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08008175 }
8176
Gilles Peskine449bd832023-01-11 14:50:10 +01008177 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08008178}
8179#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
8180
Gilles Peskine449bd832023-01-11 14:50:10 +01008181int mbedtls_ssl_parse_certificate(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08008182{
8183 int ret = 0;
8184 int crt_expected;
8185#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
8186 const int authmode = ssl->handshake->sni_authmode != MBEDTLS_SSL_VERIFY_UNSET
8187 ? ssl->handshake->sni_authmode
8188 : ssl->conf->authmode;
8189#else
8190 const int authmode = ssl->conf->authmode;
8191#endif
8192 void *rs_ctx = NULL;
8193 mbedtls_x509_crt *chain = NULL;
8194
Gilles Peskine449bd832023-01-11 14:50:10 +01008195 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08008196
Gilles Peskine449bd832023-01-11 14:50:10 +01008197 crt_expected = ssl_parse_certificate_coordinate(ssl, authmode);
8198 if (crt_expected == SSL_CERTIFICATE_SKIP) {
8199 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08008200 goto exit;
8201 }
8202
8203#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01008204 if (ssl->handshake->ecrs_enabled &&
8205 ssl->handshake->ecrs_state == ssl_ecrs_crt_verify) {
Jerry Yud9526692022-02-17 14:23:47 +08008206 chain = ssl->handshake->ecrs_peer_cert;
8207 ssl->handshake->ecrs_peer_cert = NULL;
8208 goto crt_verify;
8209 }
8210#endif
8211
Gilles Peskine449bd832023-01-11 14:50:10 +01008212 if ((ret = mbedtls_ssl_read_record(ssl, 1)) != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08008213 /* mbedtls_ssl_read_record may have sent an alert already. We
8214 let it decide whether to alert. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008215 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_read_record", ret);
Jerry Yud9526692022-02-17 14:23:47 +08008216 goto exit;
8217 }
8218
8219#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008220 if (ssl_srv_check_client_no_crt_notification(ssl) == 0) {
Jerry Yud9526692022-02-17 14:23:47 +08008221 ssl->session_negotiate->verify_result = MBEDTLS_X509_BADCERT_MISSING;
8222
Gilles Peskine449bd832023-01-11 14:50:10 +01008223 if (authmode != MBEDTLS_SSL_VERIFY_OPTIONAL) {
Jerry Yud9526692022-02-17 14:23:47 +08008224 ret = MBEDTLS_ERR_SSL_NO_CLIENT_CERTIFICATE;
Gilles Peskine449bd832023-01-11 14:50:10 +01008225 }
Jerry Yud9526692022-02-17 14:23:47 +08008226
8227 goto exit;
8228 }
8229#endif /* MBEDTLS_SSL_SRV_C */
8230
8231 /* Clear existing peer CRT structure in case we tried to
8232 * reuse a session but it failed, and allocate a new one. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008233 ssl_clear_peer_cert(ssl->session_negotiate);
Jerry Yud9526692022-02-17 14:23:47 +08008234
Gilles Peskine449bd832023-01-11 14:50:10 +01008235 chain = mbedtls_calloc(1, sizeof(mbedtls_x509_crt));
8236 if (chain == NULL) {
8237 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc(%" MBEDTLS_PRINTF_SIZET " bytes) failed",
8238 sizeof(mbedtls_x509_crt)));
8239 mbedtls_ssl_send_alert_message(ssl,
8240 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8241 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR);
Jerry Yud9526692022-02-17 14:23:47 +08008242
8243 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
8244 goto exit;
8245 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008246 mbedtls_x509_crt_init(chain);
Jerry Yud9526692022-02-17 14:23:47 +08008247
Gilles Peskine449bd832023-01-11 14:50:10 +01008248 ret = ssl_parse_certificate_chain(ssl, chain);
8249 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08008250 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01008251 }
Jerry Yud9526692022-02-17 14:23:47 +08008252
8253#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01008254 if (ssl->handshake->ecrs_enabled) {
Jerry Yud9526692022-02-17 14:23:47 +08008255 ssl->handshake->ecrs_state = ssl_ecrs_crt_verify;
Gilles Peskine449bd832023-01-11 14:50:10 +01008256 }
Jerry Yud9526692022-02-17 14:23:47 +08008257
8258crt_verify:
Gilles Peskine449bd832023-01-11 14:50:10 +01008259 if (ssl->handshake->ecrs_enabled) {
Jerry Yud9526692022-02-17 14:23:47 +08008260 rs_ctx = &ssl->handshake->ecrs_ctx;
Gilles Peskine449bd832023-01-11 14:50:10 +01008261 }
Jerry Yud9526692022-02-17 14:23:47 +08008262#endif
8263
Gilles Peskine449bd832023-01-11 14:50:10 +01008264 ret = ssl_parse_certificate_verify(ssl, authmode,
8265 chain, rs_ctx);
8266 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08008267 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01008268 }
Jerry Yud9526692022-02-17 14:23:47 +08008269
8270#if !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
8271 {
8272 unsigned char *crt_start, *pk_start;
8273 size_t crt_len, pk_len;
8274
8275 /* We parse the CRT chain without copying, so
8276 * these pointers point into the input buffer,
8277 * and are hence still valid after freeing the
8278 * CRT chain. */
8279
8280 crt_start = chain->raw.p;
8281 crt_len = chain->raw.len;
8282
8283 pk_start = chain->pk_raw.p;
8284 pk_len = chain->pk_raw.len;
8285
8286 /* Free the CRT structures before computing
8287 * digest and copying the peer's public key. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008288 mbedtls_x509_crt_free(chain);
8289 mbedtls_free(chain);
Jerry Yud9526692022-02-17 14:23:47 +08008290 chain = NULL;
8291
Gilles Peskine449bd832023-01-11 14:50:10 +01008292 ret = ssl_remember_peer_crt_digest(ssl, crt_start, crt_len);
8293 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08008294 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01008295 }
Jerry Yud9526692022-02-17 14:23:47 +08008296
Gilles Peskine449bd832023-01-11 14:50:10 +01008297 ret = ssl_remember_peer_pubkey(ssl, pk_start, pk_len);
8298 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08008299 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01008300 }
Jerry Yud9526692022-02-17 14:23:47 +08008301 }
8302#else /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
8303 /* Pass ownership to session structure. */
8304 ssl->session_negotiate->peer_cert = chain;
8305 chain = NULL;
8306#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
8307
Gilles Peskine449bd832023-01-11 14:50:10 +01008308 MBEDTLS_SSL_DEBUG_MSG(2, ("<= parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08008309
8310exit:
8311
Gilles Peskine449bd832023-01-11 14:50:10 +01008312 if (ret == 0) {
Jerry Yud9526692022-02-17 14:23:47 +08008313 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01008314 }
Jerry Yud9526692022-02-17 14:23:47 +08008315
8316#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01008317 if (ret == MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS) {
Jerry Yud9526692022-02-17 14:23:47 +08008318 ssl->handshake->ecrs_peer_cert = chain;
8319 chain = NULL;
8320 }
8321#endif
8322
Gilles Peskine449bd832023-01-11 14:50:10 +01008323 if (chain != NULL) {
8324 mbedtls_x509_crt_free(chain);
8325 mbedtls_free(chain);
Jerry Yud9526692022-02-17 14:23:47 +08008326 }
8327
Gilles Peskine449bd832023-01-11 14:50:10 +01008328 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08008329}
8330#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
8331
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008332static int ssl_calc_finished_tls_generic(mbedtls_ssl_context *ssl, void *ctx,
8333 unsigned char *padbuf, size_t hlen,
8334 unsigned char *buf, int from)
Jerry Yu615bd6f2022-02-17 14:25:15 +08008335{
Dave Rodgmanc37ad442023-11-03 23:36:06 +00008336 unsigned int len = 12;
Jerry Yu615bd6f2022-02-17 14:25:15 +08008337 const char *sender;
Jerry Yu615bd6f2022-02-17 14:25:15 +08008338#if defined(MBEDTLS_USE_PSA_CRYPTO)
Jerry Yu615bd6f2022-02-17 14:25:15 +08008339 psa_status_t status;
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008340 psa_hash_operation_t *hs_op = ctx;
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02008341 psa_hash_operation_t cloned_op = PSA_HASH_OPERATION_INIT;
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008342 size_t hash_size;
Jerry Yu615bd6f2022-02-17 14:25:15 +08008343#else
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01008344 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008345 mbedtls_md_context_t *hs_ctx = ctx;
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02008346 mbedtls_md_context_t cloned_ctx;
8347 mbedtls_md_init(&cloned_ctx);
Jerry Yu615bd6f2022-02-17 14:25:15 +08008348#endif
8349
8350 mbedtls_ssl_session *session = ssl->session_negotiate;
Gilles Peskine449bd832023-01-11 14:50:10 +01008351 if (!session) {
Jerry Yu615bd6f2022-02-17 14:25:15 +08008352 session = ssl->session;
Gilles Peskine449bd832023-01-11 14:50:10 +01008353 }
Jerry Yu615bd6f2022-02-17 14:25:15 +08008354
Gilles Peskine449bd832023-01-11 14:50:10 +01008355 sender = (from == MBEDTLS_SSL_IS_CLIENT)
Jerry Yu615bd6f2022-02-17 14:25:15 +08008356 ? "client finished"
8357 : "server finished";
8358
8359#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008360 MBEDTLS_SSL_DEBUG_MSG(2, ("=> calc PSA finished tls"));
Jerry Yu615bd6f2022-02-17 14:25:15 +08008361
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02008362 status = psa_hash_clone(hs_op, &cloned_op);
Gilles Peskine449bd832023-01-11 14:50:10 +01008363 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01008364 goto exit;
Jerry Yu615bd6f2022-02-17 14:25:15 +08008365 }
8366
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02008367 status = psa_hash_finish(&cloned_op, padbuf, hlen, &hash_size);
Gilles Peskine449bd832023-01-11 14:50:10 +01008368 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01008369 goto exit;
Jerry Yu615bd6f2022-02-17 14:25:15 +08008370 }
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008371 MBEDTLS_SSL_DEBUG_BUF(3, "PSA calculated padbuf", padbuf, hlen);
Jerry Yu615bd6f2022-02-17 14:25:15 +08008372#else
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008373 MBEDTLS_SSL_DEBUG_MSG(2, ("=> calc finished tls"));
Jerry Yu615bd6f2022-02-17 14:25:15 +08008374
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02008375 ret = mbedtls_md_setup(&cloned_ctx, mbedtls_md_info_from_ctx(hs_ctx), 0);
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01008376 if (ret != 0) {
8377 goto exit;
8378 }
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02008379 ret = mbedtls_md_clone(&cloned_ctx, hs_ctx);
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01008380 if (ret != 0) {
8381 goto exit;
8382 }
Jerry Yu615bd6f2022-02-17 14:25:15 +08008383
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02008384 ret = mbedtls_md_finish(&cloned_ctx, padbuf);
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008385 if (ret != 0) {
8386 goto exit;
8387 }
8388#endif /* MBEDTLS_USE_PSA_CRYPTO */
8389
8390 MBEDTLS_SSL_DEBUG_BUF(4, "finished output", padbuf, hlen);
8391
Jerry Yu615bd6f2022-02-17 14:25:15 +08008392 /*
8393 * TLSv1.2:
8394 * hash = PRF( master, finished_label,
8395 * Hash( handshake ) )[0.11]
8396 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008397 ssl->handshake->tls_prf(session->master, 48, sender,
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008398 padbuf, hlen, buf, len);
Jerry Yu615bd6f2022-02-17 14:25:15 +08008399
Gilles Peskine449bd832023-01-11 14:50:10 +01008400 MBEDTLS_SSL_DEBUG_BUF(3, "calc finished result", buf, len);
Jerry Yu615bd6f2022-02-17 14:25:15 +08008401
Paul Elliottecb95be2023-08-11 16:41:04 +01008402 mbedtls_platform_zeroize(padbuf, hlen);
Jerry Yu615bd6f2022-02-17 14:25:15 +08008403
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008404 MBEDTLS_SSL_DEBUG_MSG(2, ("<= calc finished"));
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01008405
8406exit:
8407#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02008408 psa_hash_abort(&cloned_op);
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +02008409 return mbedtls_md_error_from_psa(status);
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01008410#else
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02008411 mbedtls_md_free(&cloned_ctx);
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01008412 return ret;
8413#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu615bd6f2022-02-17 14:25:15 +08008414}
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008415
8416#if defined(MBEDTLS_MD_CAN_SHA256)
8417static int ssl_calc_finished_tls_sha256(
8418 mbedtls_ssl_context *ssl, unsigned char *buf, int from)
8419{
8420 unsigned char padbuf[32];
8421 return ssl_calc_finished_tls_generic(ssl,
8422#if defined(MBEDTLS_USE_PSA_CRYPTO)
8423 &ssl->handshake->fin_sha256_psa,
8424#else
8425 &ssl->handshake->fin_sha256,
8426#endif
8427 padbuf, sizeof(padbuf),
8428 buf, from);
8429}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01008430#endif /* MBEDTLS_MD_CAN_SHA256*/
Jerry Yu615bd6f2022-02-17 14:25:15 +08008431
Jerry Yub7ba49e2022-02-17 14:25:53 +08008432
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01008433#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +01008434static int ssl_calc_finished_tls_sha384(
Gilles Peskine449bd832023-01-11 14:50:10 +01008435 mbedtls_ssl_context *ssl, unsigned char *buf, int from)
Jerry Yub7ba49e2022-02-17 14:25:53 +08008436{
Jerry Yub7ba49e2022-02-17 14:25:53 +08008437 unsigned char padbuf[48];
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008438 return ssl_calc_finished_tls_generic(ssl,
Jerry Yub7ba49e2022-02-17 14:25:53 +08008439#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008440 &ssl->handshake->fin_sha384_psa,
Jerry Yub7ba49e2022-02-17 14:25:53 +08008441#else
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008442 &ssl->handshake->fin_sha384,
Jerry Yub7ba49e2022-02-17 14:25:53 +08008443#endif
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008444 padbuf, sizeof(padbuf),
8445 buf, from);
Jerry Yub7ba49e2022-02-17 14:25:53 +08008446}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01008447#endif /* MBEDTLS_MD_CAN_SHA384*/
Jerry Yub7ba49e2022-02-17 14:25:53 +08008448
Gilles Peskine449bd832023-01-11 14:50:10 +01008449void mbedtls_ssl_handshake_wrapup_free_hs_transform(mbedtls_ssl_context *ssl)
Jerry Yuaef00152022-02-17 14:27:31 +08008450{
Gilles Peskine449bd832023-01-11 14:50:10 +01008451 MBEDTLS_SSL_DEBUG_MSG(3, ("=> handshake wrapup: final free"));
Jerry Yuaef00152022-02-17 14:27:31 +08008452
8453 /*
8454 * Free our handshake params
8455 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008456 mbedtls_ssl_handshake_free(ssl);
8457 mbedtls_free(ssl->handshake);
Jerry Yuaef00152022-02-17 14:27:31 +08008458 ssl->handshake = NULL;
8459
8460 /*
Shaun Case8b0ecbc2021-12-20 21:14:10 -08008461 * Free the previous transform and switch in the current one
Jerry Yuaef00152022-02-17 14:27:31 +08008462 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008463 if (ssl->transform) {
8464 mbedtls_ssl_transform_free(ssl->transform);
8465 mbedtls_free(ssl->transform);
Jerry Yuaef00152022-02-17 14:27:31 +08008466 }
8467 ssl->transform = ssl->transform_negotiate;
8468 ssl->transform_negotiate = NULL;
8469
Gilles Peskine449bd832023-01-11 14:50:10 +01008470 MBEDTLS_SSL_DEBUG_MSG(3, ("<= handshake wrapup: final free"));
Jerry Yuaef00152022-02-17 14:27:31 +08008471}
8472
Gilles Peskine449bd832023-01-11 14:50:10 +01008473void mbedtls_ssl_handshake_wrapup(mbedtls_ssl_context *ssl)
Jerry Yu2a9fff52022-02-17 14:28:51 +08008474{
8475 int resume = ssl->handshake->resume;
8476
Gilles Peskine449bd832023-01-11 14:50:10 +01008477 MBEDTLS_SSL_DEBUG_MSG(3, ("=> handshake wrapup"));
Jerry Yu2a9fff52022-02-17 14:28:51 +08008478
8479#if defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01008480 if (ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS) {
Jerry Yu2a9fff52022-02-17 14:28:51 +08008481 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_DONE;
8482 ssl->renego_records_seen = 0;
8483 }
8484#endif
8485
8486 /*
8487 * Free the previous session and switch in the current one
8488 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008489 if (ssl->session) {
Jerry Yu2a9fff52022-02-17 14:28:51 +08008490#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
8491 /* RFC 7366 3.1: keep the EtM state */
8492 ssl->session_negotiate->encrypt_then_mac =
Gilles Peskine449bd832023-01-11 14:50:10 +01008493 ssl->session->encrypt_then_mac;
Jerry Yu2a9fff52022-02-17 14:28:51 +08008494#endif
8495
Gilles Peskine449bd832023-01-11 14:50:10 +01008496 mbedtls_ssl_session_free(ssl->session);
8497 mbedtls_free(ssl->session);
Jerry Yu2a9fff52022-02-17 14:28:51 +08008498 }
8499 ssl->session = ssl->session_negotiate;
8500 ssl->session_negotiate = NULL;
8501
8502 /*
8503 * Add cache entry
8504 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008505 if (ssl->conf->f_set_cache != NULL &&
Jerry Yu2a9fff52022-02-17 14:28:51 +08008506 ssl->session->id_len != 0 &&
Gilles Peskine449bd832023-01-11 14:50:10 +01008507 resume == 0) {
8508 if (ssl->conf->f_set_cache(ssl->conf->p_cache,
8509 ssl->session->id,
8510 ssl->session->id_len,
8511 ssl->session) != 0) {
8512 MBEDTLS_SSL_DEBUG_MSG(1, ("cache did not store session"));
8513 }
Jerry Yu2a9fff52022-02-17 14:28:51 +08008514 }
8515
8516#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01008517 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
8518 ssl->handshake->flight != NULL) {
Jerry Yu2a9fff52022-02-17 14:28:51 +08008519 /* Cancel handshake timer */
Gilles Peskine449bd832023-01-11 14:50:10 +01008520 mbedtls_ssl_set_timer(ssl, 0);
Jerry Yu2a9fff52022-02-17 14:28:51 +08008521
8522 /* Keep last flight around in case we need to resend it:
8523 * we need the handshake and transform structures for that */
Gilles Peskine449bd832023-01-11 14:50:10 +01008524 MBEDTLS_SSL_DEBUG_MSG(3, ("skip freeing handshake and transform"));
8525 } else
Jerry Yu2a9fff52022-02-17 14:28:51 +08008526#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01008527 mbedtls_ssl_handshake_wrapup_free_hs_transform(ssl);
Jerry Yu2a9fff52022-02-17 14:28:51 +08008528
Jerry Yu5ed73ff2022-10-27 13:08:42 +08008529 ssl->state = MBEDTLS_SSL_HANDSHAKE_OVER;
Jerry Yu2a9fff52022-02-17 14:28:51 +08008530
Gilles Peskine449bd832023-01-11 14:50:10 +01008531 MBEDTLS_SSL_DEBUG_MSG(3, ("<= handshake wrapup"));
Jerry Yu2a9fff52022-02-17 14:28:51 +08008532}
8533
Gilles Peskine449bd832023-01-11 14:50:10 +01008534int mbedtls_ssl_write_finished(mbedtls_ssl_context *ssl)
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008535{
Dave Rodgmanc37ad442023-11-03 23:36:06 +00008536 int ret;
8537 unsigned int hash_len;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008538
Gilles Peskine449bd832023-01-11 14:50:10 +01008539 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write finished"));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008540
Gilles Peskine449bd832023-01-11 14:50:10 +01008541 mbedtls_ssl_update_out_pointers(ssl, ssl->transform_negotiate);
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008542
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01008543 ret = ssl->handshake->calc_finished(ssl, ssl->out_msg + 4, ssl->conf->endpoint);
8544 if (ret != 0) {
8545 MBEDTLS_SSL_DEBUG_RET(1, "calc_finished", ret);
8546 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008547
8548 /*
8549 * RFC 5246 7.4.9 (Page 63) says 12 is the default length and ciphersuites
8550 * may define some other value. Currently (early 2016), no defined
8551 * ciphersuite does this (and this is unlikely to change as activity has
8552 * moved to TLS 1.3 now) so we can keep the hardcoded 12 here.
8553 */
8554 hash_len = 12;
8555
8556#if defined(MBEDTLS_SSL_RENEGOTIATION)
8557 ssl->verify_data_len = hash_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01008558 memcpy(ssl->own_verify_data, ssl->out_msg + 4, hash_len);
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008559#endif
8560
8561 ssl->out_msglen = 4 + hash_len;
8562 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
8563 ssl->out_msg[0] = MBEDTLS_SSL_HS_FINISHED;
8564
8565 /*
8566 * In case of session resuming, invert the client and server
8567 * ChangeCipherSpec messages order.
8568 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008569 if (ssl->handshake->resume != 0) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008570#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008571 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008572 ssl->state = MBEDTLS_SSL_HANDSHAKE_WRAPUP;
Gilles Peskine449bd832023-01-11 14:50:10 +01008573 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008574#endif
8575#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008576 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008577 ssl->state = MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC;
Gilles Peskine449bd832023-01-11 14:50:10 +01008578 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008579#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01008580 } else {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008581 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01008582 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008583
8584 /*
8585 * Switch to our negotiated transform and session parameters for outbound
8586 * data.
8587 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008588 MBEDTLS_SSL_DEBUG_MSG(3, ("switching to new transform spec for outbound data"));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008589
8590#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01008591 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008592 unsigned char i;
8593
8594 /* Remember current epoch settings for resending */
8595 ssl->handshake->alt_transform_out = ssl->transform_out;
Gilles Peskine449bd832023-01-11 14:50:10 +01008596 memcpy(ssl->handshake->alt_out_ctr, ssl->cur_out_ctr,
8597 sizeof(ssl->handshake->alt_out_ctr));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008598
8599 /* Set sequence_number to zero */
Gilles Peskine449bd832023-01-11 14:50:10 +01008600 memset(&ssl->cur_out_ctr[2], 0, sizeof(ssl->cur_out_ctr) - 2);
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008601
8602
8603 /* Increment epoch */
Gilles Peskine449bd832023-01-11 14:50:10 +01008604 for (i = 2; i > 0; i--) {
8605 if (++ssl->cur_out_ctr[i - 1] != 0) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008606 break;
Gilles Peskine449bd832023-01-11 14:50:10 +01008607 }
8608 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008609
8610 /* The loop goes to its end iff the counter is wrapping */
Gilles Peskine449bd832023-01-11 14:50:10 +01008611 if (i == 0) {
8612 MBEDTLS_SSL_DEBUG_MSG(1, ("DTLS epoch would wrap"));
8613 return MBEDTLS_ERR_SSL_COUNTER_WRAPPING;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008614 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008615 } else
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008616#endif /* MBEDTLS_SSL_PROTO_DTLS */
Gilles Peskine449bd832023-01-11 14:50:10 +01008617 memset(ssl->cur_out_ctr, 0, sizeof(ssl->cur_out_ctr));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008618
8619 ssl->transform_out = ssl->transform_negotiate;
8620 ssl->session_out = ssl->session_negotiate;
8621
8622#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01008623 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
8624 mbedtls_ssl_send_flight_completed(ssl);
8625 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008626#endif
8627
Gilles Peskine449bd832023-01-11 14:50:10 +01008628 if ((ret = mbedtls_ssl_write_handshake_msg(ssl)) != 0) {
8629 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_handshake_msg", ret);
8630 return ret;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008631 }
8632
8633#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01008634 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
8635 (ret = mbedtls_ssl_flight_transmit(ssl)) != 0) {
8636 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_flight_transmit", ret);
8637 return ret;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008638 }
8639#endif
8640
Gilles Peskine449bd832023-01-11 14:50:10 +01008641 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write finished"));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008642
Gilles Peskine449bd832023-01-11 14:50:10 +01008643 return 0;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008644}
8645
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008646#define SSL_MAX_HASH_LEN 12
8647
Gilles Peskine449bd832023-01-11 14:50:10 +01008648int mbedtls_ssl_parse_finished(mbedtls_ssl_context *ssl)
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008649{
8650 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
8651 unsigned int hash_len = 12;
8652 unsigned char buf[SSL_MAX_HASH_LEN];
8653
Gilles Peskine449bd832023-01-11 14:50:10 +01008654 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse finished"));
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008655
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01008656 ret = ssl->handshake->calc_finished(ssl, buf, ssl->conf->endpoint ^ 1);
8657 if (ret != 0) {
8658 MBEDTLS_SSL_DEBUG_RET(1, "calc_finished", ret);
8659 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008660
Gilles Peskine449bd832023-01-11 14:50:10 +01008661 if ((ret = mbedtls_ssl_read_record(ssl, 1)) != 0) {
8662 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_read_record", ret);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008663 goto exit;
8664 }
8665
Gilles Peskine449bd832023-01-11 14:50:10 +01008666 if (ssl->in_msgtype != MBEDTLS_SSL_MSG_HANDSHAKE) {
8667 MBEDTLS_SSL_DEBUG_MSG(1, ("bad finished message"));
8668 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8669 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008670 ret = MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
8671 goto exit;
8672 }
8673
Gilles Peskine449bd832023-01-11 14:50:10 +01008674 if (ssl->in_msg[0] != MBEDTLS_SSL_HS_FINISHED) {
8675 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8676 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008677 ret = MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
8678 goto exit;
8679 }
8680
Gilles Peskine449bd832023-01-11 14:50:10 +01008681 if (ssl->in_hslen != mbedtls_ssl_hs_hdr_len(ssl) + hash_len) {
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_DECODE_ERROR);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008685 ret = MBEDTLS_ERR_SSL_DECODE_ERROR;
8686 goto exit;
8687 }
8688
Gilles Peskine449bd832023-01-11 14:50:10 +01008689 if (mbedtls_ct_memcmp(ssl->in_msg + mbedtls_ssl_hs_hdr_len(ssl),
8690 buf, hash_len) != 0) {
8691 MBEDTLS_SSL_DEBUG_MSG(1, ("bad finished message"));
8692 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8693 MBEDTLS_SSL_ALERT_MSG_DECRYPT_ERROR);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008694 ret = MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
8695 goto exit;
8696 }
8697
8698#if defined(MBEDTLS_SSL_RENEGOTIATION)
8699 ssl->verify_data_len = hash_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01008700 memcpy(ssl->peer_verify_data, buf, hash_len);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008701#endif
8702
Gilles Peskine449bd832023-01-11 14:50:10 +01008703 if (ssl->handshake->resume != 0) {
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008704#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008705 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008706 ssl->state = MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC;
Gilles Peskine449bd832023-01-11 14:50:10 +01008707 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008708#endif
8709#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008710 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008711 ssl->state = MBEDTLS_SSL_HANDSHAKE_WRAPUP;
Gilles Peskine449bd832023-01-11 14:50:10 +01008712 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008713#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01008714 } else {
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008715 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01008716 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008717
8718#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01008719 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
8720 mbedtls_ssl_recv_flight_completed(ssl);
8721 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008722#endif
8723
Gilles Peskine449bd832023-01-11 14:50:10 +01008724 MBEDTLS_SSL_DEBUG_MSG(2, ("<= parse finished"));
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008725
8726exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01008727 mbedtls_platform_zeroize(buf, hash_len);
8728 return ret;
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008729}
8730
Jerry Yu392112c2022-02-17 14:34:10 +08008731#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
8732/*
8733 * Helper to get TLS 1.2 PRF from ciphersuite
8734 * (Duplicates bits of logic from ssl_set_handshake_prfs().)
8735 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008736static tls_prf_fn ssl_tls12prf_from_cs(int ciphersuite_id)
Jerry Yu392112c2022-02-17 14:34:10 +08008737{
Jerry Yu392112c2022-02-17 14:34:10 +08008738 const mbedtls_ssl_ciphersuite_t * const ciphersuite_info =
Gilles Peskine449bd832023-01-11 14:50:10 +01008739 mbedtls_ssl_ciphersuite_from_id(ciphersuite_id);
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01008740#if defined(MBEDTLS_MD_CAN_SHA384)
Gilles Peskine449bd832023-01-11 14:50:10 +01008741 if (ciphersuite_info != NULL && ciphersuite_info->mac == MBEDTLS_MD_SHA384) {
8742 return tls_prf_sha384;
8743 } else
Jerry Yu392112c2022-02-17 14:34:10 +08008744#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01008745#if defined(MBEDTLS_MD_CAN_SHA256)
Andrzej Kurek894edde2022-09-29 06:31:14 -04008746 {
Gilles Peskine449bd832023-01-11 14:50:10 +01008747 if (ciphersuite_info != NULL && ciphersuite_info->mac == MBEDTLS_MD_SHA256) {
8748 return tls_prf_sha256;
8749 }
Andrzej Kurek894edde2022-09-29 06:31:14 -04008750 }
8751#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01008752#if !defined(MBEDTLS_MD_CAN_SHA384) && \
8753 !defined(MBEDTLS_MD_CAN_SHA256)
Andrzej Kurek894edde2022-09-29 06:31:14 -04008754 (void) ciphersuite_info;
8755#endif
Andrzej Kurekeabeb302022-10-17 07:52:51 -04008756
Gilles Peskine449bd832023-01-11 14:50:10 +01008757 return NULL;
Jerry Yu392112c2022-02-17 14:34:10 +08008758}
8759#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
Jerry Yue93ffcd2022-02-17 14:37:06 +08008760
Gilles Peskine449bd832023-01-11 14:50:10 +01008761static mbedtls_tls_prf_types tls_prf_get_type(mbedtls_ssl_tls_prf_cb *tls_prf)
Jerry Yue93ffcd2022-02-17 14:37:06 +08008762{
8763 ((void) tls_prf);
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01008764#if defined(MBEDTLS_MD_CAN_SHA384)
Gilles Peskine449bd832023-01-11 14:50:10 +01008765 if (tls_prf == tls_prf_sha384) {
8766 return MBEDTLS_SSL_TLS_PRF_SHA384;
8767 } else
Jerry Yue93ffcd2022-02-17 14:37:06 +08008768#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01008769#if defined(MBEDTLS_MD_CAN_SHA256)
Gilles Peskine449bd832023-01-11 14:50:10 +01008770 if (tls_prf == tls_prf_sha256) {
8771 return MBEDTLS_SSL_TLS_PRF_SHA256;
8772 } else
Jerry Yue93ffcd2022-02-17 14:37:06 +08008773#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01008774 return MBEDTLS_SSL_TLS_PRF_NONE;
Jerry Yue93ffcd2022-02-17 14:37:06 +08008775}
8776
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008777/*
8778 * Populate a transform structure with session keys and all the other
8779 * necessary information.
8780 *
8781 * Parameters:
8782 * - [in/out]: transform: structure to populate
8783 * [in] must be just initialised with mbedtls_ssl_transform_init()
8784 * [out] fully populated, ready for use by mbedtls_ssl_{en,de}crypt_buf()
8785 * - [in] ciphersuite
8786 * - [in] master
8787 * - [in] encrypt_then_mac
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008788 * - [in] tls_prf: pointer to PRF to use for key derivation
8789 * - [in] randbytes: buffer holding ServerHello.random + ClientHello.random
Glenn Strauss07c64162022-03-14 12:34:51 -04008790 * - [in] tls_version: TLS version
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008791 * - [in] endpoint: client or server
8792 * - [in] ssl: used for:
8793 * - ssl->conf->{f,p}_export_keys
8794 * [in] optionally used for:
8795 * - MBEDTLS_DEBUG_C: ssl->conf->{f,p}_dbg
8796 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02008797MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01008798static int ssl_tls12_populate_transform(mbedtls_ssl_transform *transform,
8799 int ciphersuite,
8800 const unsigned char master[48],
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008801#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01008802 int encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008803#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01008804 ssl_tls_prf_t tls_prf,
8805 const unsigned char randbytes[64],
8806 mbedtls_ssl_protocol_version tls_version,
8807 unsigned endpoint,
8808 const mbedtls_ssl_context *ssl)
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008809{
8810 int ret = 0;
8811 unsigned char keyblk[256];
8812 unsigned char *key1;
8813 unsigned char *key2;
8814 unsigned char *mac_enc;
8815 unsigned char *mac_dec;
8816 size_t mac_key_len = 0;
8817 size_t iv_copy_len;
8818 size_t keylen;
8819 const mbedtls_ssl_ciphersuite_t *ciphersuite_info;
Neil Armstrong7fea33e2022-04-01 15:40:25 +02008820 mbedtls_ssl_mode_t ssl_mode;
Neil Armstronge4512952022-03-08 09:08:22 +01008821#if !defined(MBEDTLS_USE_PSA_CRYPTO)
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008822 const mbedtls_cipher_info_t *cipher_info;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008823 const mbedtls_md_info_t *md_info;
Neil Armstronge4512952022-03-08 09:08:22 +01008824#endif /* !MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008825
8826#if defined(MBEDTLS_USE_PSA_CRYPTO)
8827 psa_key_type_t key_type;
8828 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
8829 psa_algorithm_t alg;
Neil Armstronge4512952022-03-08 09:08:22 +01008830 psa_algorithm_t mac_alg = 0;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008831 size_t key_bits;
8832 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
8833#endif
8834
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008835 /*
8836 * Some data just needs copying into the structure
8837 */
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008838#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008839 transform->encrypt_then_mac = encrypt_then_mac;
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008840#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Glenn Strauss07c64162022-03-14 12:34:51 -04008841 transform->tls_version = tls_version;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008842
8843#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01008844 memcpy(transform->randbytes, randbytes, sizeof(transform->randbytes));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008845#endif
8846
8847#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01008848 if (tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008849 /* At the moment, we keep TLS <= 1.2 and TLS 1.3 transform
8850 * generation separate. This should never happen. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008851 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008852 }
8853#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
8854
8855 /*
8856 * Get various info structures
8857 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008858 ciphersuite_info = mbedtls_ssl_ciphersuite_from_id(ciphersuite);
8859 if (ciphersuite_info == NULL) {
8860 MBEDTLS_SSL_DEBUG_MSG(1, ("ciphersuite info for %d not found",
8861 ciphersuite));
8862 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008863 }
8864
Neil Armstrongab555e02022-04-04 11:07:59 +02008865 ssl_mode = mbedtls_ssl_get_mode_from_ciphersuite(
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008866#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01008867 encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008868#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01008869 ciphersuite_info);
Neil Armstrong7fea33e2022-04-01 15:40:25 +02008870
Gilles Peskine449bd832023-01-11 14:50:10 +01008871 if (ssl_mode == MBEDTLS_SSL_MODE_AEAD) {
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008872 transform->taglen =
8873 ciphersuite_info->flags & MBEDTLS_CIPHERSUITE_SHORT_TAG ? 8 : 16;
Gilles Peskine449bd832023-01-11 14:50:10 +01008874 }
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008875
8876#if defined(MBEDTLS_USE_PSA_CRYPTO)
Dave Rodgman2eab4622023-10-05 13:30:37 +01008877 if ((status = mbedtls_ssl_cipher_to_psa((mbedtls_cipher_type_t) ciphersuite_info->cipher,
Gilles Peskine449bd832023-01-11 14:50:10 +01008878 transform->taglen,
8879 &alg,
8880 &key_type,
8881 &key_bits)) != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008882 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01008883 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_cipher_to_psa", ret);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008884 goto end;
8885 }
8886#else
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01008887 cipher_info = mbedtls_cipher_info_from_type((mbedtls_cipher_type_t) ciphersuite_info->cipher);
Gilles Peskine449bd832023-01-11 14:50:10 +01008888 if (cipher_info == NULL) {
8889 MBEDTLS_SSL_DEBUG_MSG(1, ("cipher info for %u not found",
8890 ciphersuite_info->cipher));
8891 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008892 }
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008893#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008894
Neil Armstronge4512952022-03-08 09:08:22 +01008895#if defined(MBEDTLS_USE_PSA_CRYPTO)
Dave Rodgman2eab4622023-10-05 13:30:37 +01008896 mac_alg = mbedtls_md_psa_alg_from_type((mbedtls_md_type_t) ciphersuite_info->mac);
Gilles Peskine449bd832023-01-11 14:50:10 +01008897 if (mac_alg == 0) {
Manuel Pégourié-Gonnard2d6d9932023-03-28 11:38:08 +02008898 MBEDTLS_SSL_DEBUG_MSG(1, ("mbedtls_md_psa_alg_from_type for %u not found",
Gilles Peskine449bd832023-01-11 14:50:10 +01008899 (unsigned) ciphersuite_info->mac));
8900 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Neil Armstronge4512952022-03-08 09:08:22 +01008901 }
8902#else
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01008903 md_info = mbedtls_md_info_from_type((mbedtls_md_type_t) ciphersuite_info->mac);
Gilles Peskine449bd832023-01-11 14:50:10 +01008904 if (md_info == NULL) {
8905 MBEDTLS_SSL_DEBUG_MSG(1, ("mbedtls_md info for %u not found",
8906 (unsigned) ciphersuite_info->mac));
8907 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008908 }
Neil Armstronge4512952022-03-08 09:08:22 +01008909#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008910
8911#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
8912 /* Copy own and peer's CID if the use of the CID
8913 * extension has been negotiated. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008914 if (ssl->handshake->cid_in_use == MBEDTLS_SSL_CID_ENABLED) {
8915 MBEDTLS_SSL_DEBUG_MSG(3, ("Copy CIDs into SSL transform"));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008916
8917 transform->in_cid_len = ssl->own_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01008918 memcpy(transform->in_cid, ssl->own_cid, ssl->own_cid_len);
8919 MBEDTLS_SSL_DEBUG_BUF(3, "Incoming CID", transform->in_cid,
8920 transform->in_cid_len);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008921
8922 transform->out_cid_len = ssl->handshake->peer_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01008923 memcpy(transform->out_cid, ssl->handshake->peer_cid,
8924 ssl->handshake->peer_cid_len);
8925 MBEDTLS_SSL_DEBUG_BUF(3, "Outgoing CID", transform->out_cid,
8926 transform->out_cid_len);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008927 }
8928#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
8929
8930 /*
8931 * Compute key block using the PRF
8932 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008933 ret = tls_prf(master, 48, "key expansion", randbytes, 64, keyblk, 256);
8934 if (ret != 0) {
8935 MBEDTLS_SSL_DEBUG_RET(1, "prf", ret);
8936 return ret;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008937 }
8938
Gilles Peskine449bd832023-01-11 14:50:10 +01008939 MBEDTLS_SSL_DEBUG_MSG(3, ("ciphersuite = %s",
8940 mbedtls_ssl_get_ciphersuite_name(ciphersuite)));
8941 MBEDTLS_SSL_DEBUG_BUF(3, "master secret", master, 48);
8942 MBEDTLS_SSL_DEBUG_BUF(4, "random bytes", randbytes, 64);
8943 MBEDTLS_SSL_DEBUG_BUF(4, "key block", keyblk, 256);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008944
8945 /*
8946 * Determine the appropriate key, IV and MAC length.
8947 */
8948
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008949#if defined(MBEDTLS_USE_PSA_CRYPTO)
8950 keylen = PSA_BITS_TO_BYTES(key_bits);
8951#else
Gilles Peskine449bd832023-01-11 14:50:10 +01008952 keylen = mbedtls_cipher_info_get_key_bitlen(cipher_info) / 8;
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008953#endif
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008954
Valerio Settie5707042023-10-11 11:54:42 +02008955#if defined(MBEDTLS_SSL_HAVE_AEAD)
Gilles Peskine449bd832023-01-11 14:50:10 +01008956 if (ssl_mode == MBEDTLS_SSL_MODE_AEAD) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008957 size_t explicit_ivlen;
8958
8959 transform->maclen = 0;
8960 mac_key_len = 0;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008961
8962 /* All modes haves 96-bit IVs, but the length of the static parts vary
8963 * with mode and version:
8964 * - For GCM and CCM in TLS 1.2, there's a static IV of 4 Bytes
8965 * (to be concatenated with a dynamically chosen IV of 8 Bytes)
8966 * - For ChaChaPoly in TLS 1.2, and all modes in TLS 1.3, there's
8967 * a static IV of 12 Bytes (to be XOR'ed with the 8 Byte record
8968 * sequence number).
8969 */
8970 transform->ivlen = 12;
David Horstmann3b2276a2022-10-06 14:49:08 +01008971
8972 int is_chachapoly = 0;
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008973#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01008974 is_chachapoly = (key_type == PSA_KEY_TYPE_CHACHA20);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008975#else
Gilles Peskine449bd832023-01-11 14:50:10 +01008976 is_chachapoly = (mbedtls_cipher_info_get_mode(cipher_info)
8977 == MBEDTLS_MODE_CHACHAPOLY);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008978#endif /* MBEDTLS_USE_PSA_CRYPTO */
David Horstmann3b2276a2022-10-06 14:49:08 +01008979
Gilles Peskine449bd832023-01-11 14:50:10 +01008980 if (is_chachapoly) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008981 transform->fixed_ivlen = 12;
Gilles Peskine449bd832023-01-11 14:50:10 +01008982 } else {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008983 transform->fixed_ivlen = 4;
Gilles Peskine449bd832023-01-11 14:50:10 +01008984 }
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008985
8986 /* Minimum length of encrypted record */
8987 explicit_ivlen = transform->ivlen - transform->fixed_ivlen;
8988 transform->minlen = explicit_ivlen + transform->taglen;
Gilles Peskine449bd832023-01-11 14:50:10 +01008989 } else
Valerio Settie5707042023-10-11 11:54:42 +02008990#endif /* MBEDTLS_SSL_HAVE_AEAD */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008991#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01008992 if (ssl_mode == MBEDTLS_SSL_MODE_STREAM ||
Neil Armstrong7fea33e2022-04-01 15:40:25 +02008993 ssl_mode == MBEDTLS_SSL_MODE_CBC ||
Gilles Peskine449bd832023-01-11 14:50:10 +01008994 ssl_mode == MBEDTLS_SSL_MODE_CBC_ETM) {
Neil Armstronge4512952022-03-08 09:08:22 +01008995#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01008996 size_t block_size = PSA_BLOCK_CIPHER_BLOCK_LENGTH(key_type);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008997#else
Dave Rodgman85a88132023-06-24 11:41:50 +01008998 size_t block_size = mbedtls_cipher_info_get_block_size(cipher_info);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008999#endif /* MBEDTLS_USE_PSA_CRYPTO */
9000
9001#if defined(MBEDTLS_USE_PSA_CRYPTO)
Neil Armstronge4512952022-03-08 09:08:22 +01009002 /* Get MAC length */
9003 mac_key_len = PSA_HASH_LENGTH(mac_alg);
9004#else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009005 /* Initialize HMAC contexts */
Gilles Peskine449bd832023-01-11 14:50:10 +01009006 if ((ret = mbedtls_md_setup(&transform->md_ctx_enc, md_info, 1)) != 0 ||
9007 (ret = mbedtls_md_setup(&transform->md_ctx_dec, md_info, 1)) != 0) {
9008 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_setup", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009009 goto end;
9010 }
9011
9012 /* Get MAC length */
Gilles Peskine449bd832023-01-11 14:50:10 +01009013 mac_key_len = mbedtls_md_get_size(md_info);
Neil Armstronge4512952022-03-08 09:08:22 +01009014#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009015 transform->maclen = mac_key_len;
9016
9017 /* IV length */
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02009018#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01009019 transform->ivlen = PSA_CIPHER_IV_LENGTH(key_type, alg);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02009020#else
Dave Rodgmanbb521fd2023-06-24 11:21:25 +01009021 transform->ivlen = mbedtls_cipher_info_get_iv_size(cipher_info);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02009022#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009023
9024 /* Minimum length */
Gilles Peskine449bd832023-01-11 14:50:10 +01009025 if (ssl_mode == MBEDTLS_SSL_MODE_STREAM) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009026 transform->minlen = transform->maclen;
Gilles Peskine449bd832023-01-11 14:50:10 +01009027 } else {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009028 /*
9029 * GenericBlockCipher:
9030 * 1. if EtM is in use: one block plus MAC
9031 * otherwise: * first multiple of blocklen greater than maclen
9032 * 2. IV
9033 */
9034#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01009035 if (ssl_mode == MBEDTLS_SSL_MODE_CBC_ETM) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009036 transform->minlen = transform->maclen
Gilles Peskine449bd832023-01-11 14:50:10 +01009037 + block_size;
9038 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009039#endif
9040 {
9041 transform->minlen = transform->maclen
Gilles Peskine449bd832023-01-11 14:50:10 +01009042 + block_size
9043 - transform->maclen % block_size;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009044 }
9045
Gilles Peskine449bd832023-01-11 14:50:10 +01009046 if (tls_version == MBEDTLS_SSL_VERSION_TLS1_2) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009047 transform->minlen += transform->ivlen;
Gilles Peskine449bd832023-01-11 14:50:10 +01009048 } else {
9049 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009050 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
9051 goto end;
9052 }
9053 }
Gilles Peskine449bd832023-01-11 14:50:10 +01009054 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009055#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
9056 {
Gilles Peskine449bd832023-01-11 14:50:10 +01009057 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
9058 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009059 }
9060
Gilles Peskine449bd832023-01-11 14:50:10 +01009061 MBEDTLS_SSL_DEBUG_MSG(3, ("keylen: %u, minlen: %u, ivlen: %u, maclen: %u",
9062 (unsigned) keylen,
9063 (unsigned) transform->minlen,
9064 (unsigned) transform->ivlen,
9065 (unsigned) transform->maclen));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009066
9067 /*
9068 * Finally setup the cipher contexts, IVs and MAC secrets.
9069 */
9070#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01009071 if (endpoint == MBEDTLS_SSL_IS_CLIENT) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009072 key1 = keyblk + mac_key_len * 2;
9073 key2 = keyblk + mac_key_len * 2 + keylen;
9074
9075 mac_enc = keyblk;
9076 mac_dec = keyblk + mac_key_len;
9077
Gilles Peskine449bd832023-01-11 14:50:10 +01009078 iv_copy_len = (transform->fixed_ivlen) ?
9079 transform->fixed_ivlen : transform->ivlen;
9080 memcpy(transform->iv_enc, key2 + keylen, iv_copy_len);
9081 memcpy(transform->iv_dec, key2 + keylen + iv_copy_len,
9082 iv_copy_len);
9083 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009084#endif /* MBEDTLS_SSL_CLI_C */
9085#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01009086 if (endpoint == MBEDTLS_SSL_IS_SERVER) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009087 key1 = keyblk + mac_key_len * 2 + keylen;
9088 key2 = keyblk + mac_key_len * 2;
9089
9090 mac_enc = keyblk + mac_key_len;
9091 mac_dec = keyblk;
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_dec, key1 + keylen, iv_copy_len);
9096 memcpy(transform->iv_enc, key1 + keylen + iv_copy_len,
9097 iv_copy_len);
9098 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009099#endif /* MBEDTLS_SSL_SRV_C */
9100 {
Gilles Peskine449bd832023-01-11 14:50:10 +01009101 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009102 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
9103 goto end;
9104 }
9105
Paul Elliott4fb19552023-10-18 12:15:30 +01009106 if (ssl->f_export_keys != NULL) {
Gilles Peskine449bd832023-01-11 14:50:10 +01009107 ssl->f_export_keys(ssl->p_export_keys,
9108 MBEDTLS_SSL_KEY_EXPORT_TLS12_MASTER_SECRET,
9109 master, 48,
9110 randbytes + 32,
9111 randbytes,
9112 tls_prf_get_type(tls_prf));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009113 }
9114
9115#if defined(MBEDTLS_USE_PSA_CRYPTO)
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009116 transform->psa_alg = alg;
9117
Gilles Peskine449bd832023-01-11 14:50:10 +01009118 if (alg != MBEDTLS_SSL_NULL_CIPHER) {
9119 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_ENCRYPT);
9120 psa_set_key_algorithm(&attributes, alg);
9121 psa_set_key_type(&attributes, key_type);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009122
Gilles Peskine449bd832023-01-11 14:50:10 +01009123 if ((status = psa_import_key(&attributes,
9124 key1,
9125 PSA_BITS_TO_BYTES(key_bits),
9126 &transform->psa_key_enc)) != PSA_SUCCESS) {
9127 MBEDTLS_SSL_DEBUG_RET(3, "psa_import_key", (int) status);
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05009128 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01009129 MBEDTLS_SSL_DEBUG_RET(1, "psa_import_key", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009130 goto end;
9131 }
9132
Gilles Peskine449bd832023-01-11 14:50:10 +01009133 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_DECRYPT);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009134
Gilles Peskine449bd832023-01-11 14:50:10 +01009135 if ((status = psa_import_key(&attributes,
9136 key2,
9137 PSA_BITS_TO_BYTES(key_bits),
9138 &transform->psa_key_dec)) != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05009139 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01009140 MBEDTLS_SSL_DEBUG_RET(1, "psa_import_key", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009141 goto end;
9142 }
9143 }
9144#else
Gilles Peskine449bd832023-01-11 14:50:10 +01009145 if ((ret = mbedtls_cipher_setup(&transform->cipher_ctx_enc,
9146 cipher_info)) != 0) {
9147 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_setup", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009148 goto end;
9149 }
9150
Gilles Peskine449bd832023-01-11 14:50:10 +01009151 if ((ret = mbedtls_cipher_setup(&transform->cipher_ctx_dec,
9152 cipher_info)) != 0) {
9153 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_setup", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009154 goto end;
9155 }
9156
Gilles Peskine449bd832023-01-11 14:50:10 +01009157 if ((ret = mbedtls_cipher_setkey(&transform->cipher_ctx_enc, key1,
9158 (int) mbedtls_cipher_info_get_key_bitlen(cipher_info),
9159 MBEDTLS_ENCRYPT)) != 0) {
9160 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_setkey", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009161 goto end;
9162 }
9163
Gilles Peskine449bd832023-01-11 14:50:10 +01009164 if ((ret = mbedtls_cipher_setkey(&transform->cipher_ctx_dec, key2,
9165 (int) mbedtls_cipher_info_get_key_bitlen(cipher_info),
9166 MBEDTLS_DECRYPT)) != 0) {
9167 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_setkey", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009168 goto end;
9169 }
9170
9171#if defined(MBEDTLS_CIPHER_MODE_CBC)
Gilles Peskine449bd832023-01-11 14:50:10 +01009172 if (mbedtls_cipher_info_get_mode(cipher_info) == MBEDTLS_MODE_CBC) {
9173 if ((ret = mbedtls_cipher_set_padding_mode(&transform->cipher_ctx_enc,
9174 MBEDTLS_PADDING_NONE)) != 0) {
9175 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_set_padding_mode", 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_set_padding_mode(&transform->cipher_ctx_dec,
9180 MBEDTLS_PADDING_NONE)) != 0) {
9181 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_set_padding_mode", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009182 goto end;
9183 }
9184 }
9185#endif /* MBEDTLS_CIPHER_MODE_CBC */
9186#endif /* MBEDTLS_USE_PSA_CRYPTO */
9187
Neil Armstrong29c0c042022-03-17 17:47:28 +01009188#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
9189 /* For HMAC-based ciphersuites, initialize the HMAC transforms.
9190 For AEAD-based ciphersuites, there is nothing to do here. */
Gilles Peskine449bd832023-01-11 14:50:10 +01009191 if (mac_key_len != 0) {
Neil Armstrong29c0c042022-03-17 17:47:28 +01009192#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01009193 transform->psa_mac_alg = PSA_ALG_HMAC(mac_alg);
Neil Armstrong29c0c042022-03-17 17:47:28 +01009194
Gilles Peskine449bd832023-01-11 14:50:10 +01009195 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_SIGN_MESSAGE);
9196 psa_set_key_algorithm(&attributes, PSA_ALG_HMAC(mac_alg));
9197 psa_set_key_type(&attributes, PSA_KEY_TYPE_HMAC);
Neil Armstrong29c0c042022-03-17 17:47:28 +01009198
Gilles Peskine449bd832023-01-11 14:50:10 +01009199 if ((status = psa_import_key(&attributes,
9200 mac_enc, mac_key_len,
9201 &transform->psa_mac_enc)) != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05009202 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01009203 MBEDTLS_SSL_DEBUG_RET(1, "psa_import_mac_key", ret);
Neil Armstrong29c0c042022-03-17 17:47:28 +01009204 goto end;
9205 }
9206
Gilles Peskine449bd832023-01-11 14:50:10 +01009207 if ((transform->psa_alg == MBEDTLS_SSL_NULL_CIPHER) ||
9208 ((transform->psa_alg == PSA_ALG_CBC_NO_PADDING)
Andrzej Kurek8c95ac42022-08-17 16:17:00 -04009209#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01009210 && (transform->encrypt_then_mac == MBEDTLS_SSL_ETM_DISABLED)
Andrzej Kurek8c95ac42022-08-17 16:17:00 -04009211#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01009212 )) {
Neil Armstrong29c0c042022-03-17 17:47:28 +01009213 /* mbedtls_ct_hmac() requires the key to be exportable */
Gilles Peskine449bd832023-01-11 14:50:10 +01009214 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_EXPORT |
9215 PSA_KEY_USAGE_VERIFY_HASH);
9216 } else {
9217 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_VERIFY_HASH);
9218 }
Neil Armstrong29c0c042022-03-17 17:47:28 +01009219
Gilles Peskine449bd832023-01-11 14:50:10 +01009220 if ((status = psa_import_key(&attributes,
9221 mac_dec, mac_key_len,
9222 &transform->psa_mac_dec)) != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05009223 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01009224 MBEDTLS_SSL_DEBUG_RET(1, "psa_import_mac_key", ret);
Neil Armstrong29c0c042022-03-17 17:47:28 +01009225 goto end;
9226 }
9227#else
Gilles Peskine449bd832023-01-11 14:50:10 +01009228 ret = mbedtls_md_hmac_starts(&transform->md_ctx_enc, mac_enc, mac_key_len);
9229 if (ret != 0) {
Neil Armstrong29c0c042022-03-17 17:47:28 +01009230 goto end;
Gilles Peskine449bd832023-01-11 14:50:10 +01009231 }
9232 ret = mbedtls_md_hmac_starts(&transform->md_ctx_dec, mac_dec, mac_key_len);
9233 if (ret != 0) {
Neil Armstrong29c0c042022-03-17 17:47:28 +01009234 goto end;
Gilles Peskine449bd832023-01-11 14:50:10 +01009235 }
Neil Armstrong29c0c042022-03-17 17:47:28 +01009236#endif /* MBEDTLS_USE_PSA_CRYPTO */
9237 }
9238#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
9239
9240 ((void) mac_dec);
9241 ((void) mac_enc);
9242
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009243end:
Gilles Peskine449bd832023-01-11 14:50:10 +01009244 mbedtls_platform_zeroize(keyblk, sizeof(keyblk));
9245 return ret;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009246}
9247
Valerio Settia08b1a42022-11-17 15:10:02 +01009248#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED) && \
9249 defined(MBEDTLS_USE_PSA_CRYPTO)
Valerio Setti6b3dab02022-11-17 17:14:54 +01009250int mbedtls_psa_ecjpake_read_round(
Gilles Peskine449bd832023-01-11 14:50:10 +01009251 psa_pake_operation_t *pake_ctx,
9252 const unsigned char *buf,
9253 size_t len, mbedtls_ecjpake_rounds_t round)
Valerio Settia08b1a42022-11-17 15:10:02 +01009254{
9255 psa_status_t status;
9256 size_t input_offset = 0;
Valerio Setti819de862022-11-17 18:05:19 +01009257 /*
Valerio Setti6b3dab02022-11-17 17:14:54 +01009258 * At round one repeat the KEY_SHARE, ZK_PUBLIC & ZF_PROOF twice
9259 * At round two perform a single cycle
9260 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009261 unsigned int remaining_steps = (round == MBEDTLS_ECJPAKE_ROUND_ONE) ? 2 : 1;
Valerio Settia08b1a42022-11-17 15:10:02 +01009262
Gilles Peskine449bd832023-01-11 14:50:10 +01009263 for (; remaining_steps > 0; remaining_steps--) {
9264 for (psa_pake_step_t step = PSA_PAKE_STEP_KEY_SHARE;
Valerio Settia08b1a42022-11-17 15:10:02 +01009265 step <= PSA_PAKE_STEP_ZK_PROOF;
Gilles Peskine449bd832023-01-11 14:50:10 +01009266 ++step) {
Valerio Settia08b1a42022-11-17 15:10:02 +01009267 /* Length is stored at the first byte */
9268 size_t length = buf[input_offset];
9269 input_offset += 1;
9270
Gilles Peskine449bd832023-01-11 14:50:10 +01009271 if (input_offset + length > len) {
Valerio Settia08b1a42022-11-17 15:10:02 +01009272 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
9273 }
9274
Gilles Peskine449bd832023-01-11 14:50:10 +01009275 status = psa_pake_input(pake_ctx, step,
9276 buf + input_offset, length);
9277 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05009278 return PSA_TO_MBEDTLS_ERR(status);
Valerio Settia08b1a42022-11-17 15:10:02 +01009279 }
9280
9281 input_offset += length;
9282 }
9283 }
9284
Gilles Peskine449bd832023-01-11 14:50:10 +01009285 if (input_offset != len) {
Valerio Setti61ea17d2022-11-18 12:11:00 +01009286 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Gilles Peskine449bd832023-01-11 14:50:10 +01009287 }
Valerio Setti30ebe112022-11-17 16:23:34 +01009288
Gilles Peskine449bd832023-01-11 14:50:10 +01009289 return 0;
Valerio Settia08b1a42022-11-17 15:10:02 +01009290}
9291
Valerio Setti6b3dab02022-11-17 17:14:54 +01009292int mbedtls_psa_ecjpake_write_round(
Gilles Peskine449bd832023-01-11 14:50:10 +01009293 psa_pake_operation_t *pake_ctx,
9294 unsigned char *buf,
9295 size_t len, size_t *olen,
9296 mbedtls_ecjpake_rounds_t round)
Valerio Settia08b1a42022-11-17 15:10:02 +01009297{
9298 psa_status_t status;
9299 size_t output_offset = 0;
9300 size_t output_len;
Valerio Setti819de862022-11-17 18:05:19 +01009301 /*
Valerio Setti6b3dab02022-11-17 17:14:54 +01009302 * At round one repeat the KEY_SHARE, ZK_PUBLIC & ZF_PROOF twice
9303 * At round two perform a single cycle
9304 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009305 unsigned int remaining_steps = (round == MBEDTLS_ECJPAKE_ROUND_ONE) ? 2 : 1;
Valerio Settia08b1a42022-11-17 15:10:02 +01009306
Gilles Peskine449bd832023-01-11 14:50:10 +01009307 for (; remaining_steps > 0; remaining_steps--) {
9308 for (psa_pake_step_t step = PSA_PAKE_STEP_KEY_SHARE;
9309 step <= PSA_PAKE_STEP_ZK_PROOF;
9310 ++step) {
Valerio Setti79f6b6b2022-11-21 14:17:03 +01009311 /*
Valerio Settid4a9b1a2022-11-22 11:11:10 +01009312 * For each step, prepend 1 byte with the length of the data as
9313 * given by psa_pake_output().
Valerio Setti79f6b6b2022-11-21 14:17:03 +01009314 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009315 status = psa_pake_output(pake_ctx, step,
9316 buf + output_offset + 1,
9317 len - output_offset - 1,
9318 &output_len);
9319 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05009320 return PSA_TO_MBEDTLS_ERR(status);
Valerio Settia08b1a42022-11-17 15:10:02 +01009321 }
9322
Valerio Setti99d88c12022-11-22 16:03:43 +01009323 *(buf + output_offset) = (uint8_t) output_len;
Valerio Setti79f6b6b2022-11-21 14:17:03 +01009324
9325 output_offset += output_len + 1;
Valerio Settia08b1a42022-11-17 15:10:02 +01009326 }
9327 }
9328
9329 *olen = output_offset;
9330
Gilles Peskine449bd832023-01-11 14:50:10 +01009331 return 0;
Valerio Settia08b1a42022-11-17 15:10:02 +01009332}
Valerio Settia08b1a42022-11-17 15:10:02 +01009333#endif //MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED && MBEDTLS_USE_PSA_CRYPTO
9334
Jerry Yuee40f9d2022-02-17 14:55:16 +08009335#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01009336int mbedtls_ssl_get_key_exchange_md_tls1_2(mbedtls_ssl_context *ssl,
9337 unsigned char *hash, size_t *hashlen,
9338 unsigned char *data, size_t data_len,
9339 mbedtls_md_type_t md_alg)
Jerry Yuee40f9d2022-02-17 14:55:16 +08009340{
9341 psa_status_t status;
9342 psa_hash_operation_t hash_operation = PSA_HASH_OPERATION_INIT;
Manuel Pégourié-Gonnard2d6d9932023-03-28 11:38:08 +02009343 psa_algorithm_t hash_alg = mbedtls_md_psa_alg_from_type(md_alg);
Jerry Yuee40f9d2022-02-17 14:55:16 +08009344
Gilles Peskine449bd832023-01-11 14:50:10 +01009345 MBEDTLS_SSL_DEBUG_MSG(3, ("Perform PSA-based computation of digest of ServerKeyExchange"));
Jerry Yuee40f9d2022-02-17 14:55:16 +08009346
Gilles Peskine449bd832023-01-11 14:50:10 +01009347 if ((status = psa_hash_setup(&hash_operation,
9348 hash_alg)) != PSA_SUCCESS) {
9349 MBEDTLS_SSL_DEBUG_RET(1, "psa_hash_setup", status);
Jerry Yuee40f9d2022-02-17 14:55:16 +08009350 goto exit;
9351 }
9352
Gilles Peskine449bd832023-01-11 14:50:10 +01009353 if ((status = psa_hash_update(&hash_operation, ssl->handshake->randbytes,
9354 64)) != PSA_SUCCESS) {
9355 MBEDTLS_SSL_DEBUG_RET(1, "psa_hash_update", status);
Jerry Yuee40f9d2022-02-17 14:55:16 +08009356 goto exit;
9357 }
9358
Gilles Peskine449bd832023-01-11 14:50:10 +01009359 if ((status = psa_hash_update(&hash_operation,
9360 data, data_len)) != PSA_SUCCESS) {
9361 MBEDTLS_SSL_DEBUG_RET(1, "psa_hash_update", status);
Jerry Yuee40f9d2022-02-17 14:55:16 +08009362 goto exit;
9363 }
9364
Gilles Peskine449bd832023-01-11 14:50:10 +01009365 if ((status = psa_hash_finish(&hash_operation, hash, PSA_HASH_MAX_SIZE,
9366 hashlen)) != PSA_SUCCESS) {
9367 MBEDTLS_SSL_DEBUG_RET(1, "psa_hash_finish", status);
9368 goto exit;
Jerry Yuee40f9d2022-02-17 14:55:16 +08009369 }
9370
9371exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01009372 if (status != PSA_SUCCESS) {
9373 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
9374 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR);
9375 switch (status) {
Jerry Yuee40f9d2022-02-17 14:55:16 +08009376 case PSA_ERROR_NOT_SUPPORTED:
Gilles Peskine449bd832023-01-11 14:50:10 +01009377 return MBEDTLS_ERR_MD_FEATURE_UNAVAILABLE;
Jerry Yuee40f9d2022-02-17 14:55:16 +08009378 case PSA_ERROR_BAD_STATE: /* Intentional fallthrough */
9379 case PSA_ERROR_BUFFER_TOO_SMALL:
Gilles Peskine449bd832023-01-11 14:50:10 +01009380 return MBEDTLS_ERR_MD_BAD_INPUT_DATA;
Jerry Yuee40f9d2022-02-17 14:55:16 +08009381 case PSA_ERROR_INSUFFICIENT_MEMORY:
Gilles Peskine449bd832023-01-11 14:50:10 +01009382 return MBEDTLS_ERR_MD_ALLOC_FAILED;
Jerry Yuee40f9d2022-02-17 14:55:16 +08009383 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01009384 return MBEDTLS_ERR_PLATFORM_HW_ACCEL_FAILED;
Jerry Yuee40f9d2022-02-17 14:55:16 +08009385 }
9386 }
Gilles Peskine449bd832023-01-11 14:50:10 +01009387 return 0;
Jerry Yuee40f9d2022-02-17 14:55:16 +08009388}
9389
9390#else
9391
Gilles Peskine449bd832023-01-11 14:50:10 +01009392int mbedtls_ssl_get_key_exchange_md_tls1_2(mbedtls_ssl_context *ssl,
9393 unsigned char *hash, size_t *hashlen,
9394 unsigned char *data, size_t data_len,
9395 mbedtls_md_type_t md_alg)
Jerry Yuee40f9d2022-02-17 14:55:16 +08009396{
9397 int ret = 0;
9398 mbedtls_md_context_t ctx;
Gilles Peskine449bd832023-01-11 14:50:10 +01009399 const mbedtls_md_info_t *md_info = mbedtls_md_info_from_type(md_alg);
9400 *hashlen = mbedtls_md_get_size(md_info);
Jerry Yuee40f9d2022-02-17 14:55:16 +08009401
Gilles Peskine449bd832023-01-11 14:50:10 +01009402 MBEDTLS_SSL_DEBUG_MSG(3, ("Perform mbedtls-based computation of digest of ServerKeyExchange"));
Jerry Yuee40f9d2022-02-17 14:55:16 +08009403
Gilles Peskine449bd832023-01-11 14:50:10 +01009404 mbedtls_md_init(&ctx);
Jerry Yuee40f9d2022-02-17 14:55:16 +08009405
9406 /*
9407 * digitally-signed struct {
9408 * opaque client_random[32];
9409 * opaque server_random[32];
9410 * ServerDHParams params;
9411 * };
9412 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009413 if ((ret = mbedtls_md_setup(&ctx, md_info, 0)) != 0) {
9414 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_setup", ret);
Jerry Yuee40f9d2022-02-17 14:55:16 +08009415 goto exit;
9416 }
Gilles Peskine449bd832023-01-11 14:50:10 +01009417 if ((ret = mbedtls_md_starts(&ctx)) != 0) {
9418 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_starts", ret);
Jerry Yuee40f9d2022-02-17 14:55:16 +08009419 goto exit;
9420 }
Gilles Peskine449bd832023-01-11 14:50:10 +01009421 if ((ret = mbedtls_md_update(&ctx, ssl->handshake->randbytes, 64)) != 0) {
9422 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_update", ret);
Jerry Yuee40f9d2022-02-17 14:55:16 +08009423 goto exit;
9424 }
Gilles Peskine449bd832023-01-11 14:50:10 +01009425 if ((ret = mbedtls_md_update(&ctx, data, data_len)) != 0) {
9426 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_update", ret);
Jerry Yuee40f9d2022-02-17 14:55:16 +08009427 goto exit;
9428 }
Gilles Peskine449bd832023-01-11 14:50:10 +01009429 if ((ret = mbedtls_md_finish(&ctx, hash)) != 0) {
9430 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_finish", ret);
Jerry Yuee40f9d2022-02-17 14:55:16 +08009431 goto exit;
9432 }
9433
9434exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01009435 mbedtls_md_free(&ctx);
Jerry Yuee40f9d2022-02-17 14:55:16 +08009436
Gilles Peskine449bd832023-01-11 14:50:10 +01009437 if (ret != 0) {
9438 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
9439 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR);
9440 }
Jerry Yuee40f9d2022-02-17 14:55:16 +08009441
Gilles Peskine449bd832023-01-11 14:50:10 +01009442 return ret;
Jerry Yuee40f9d2022-02-17 14:55:16 +08009443}
9444#endif /* MBEDTLS_USE_PSA_CRYPTO */
9445
Jerry Yud9d91da2022-02-17 14:57:06 +08009446#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
9447
Gabor Mezeia3d016c2022-05-10 12:44:09 +02009448/* Find the preferred hash for a given signature algorithm. */
9449unsigned int mbedtls_ssl_tls12_get_preferred_hash_for_sig_alg(
Gilles Peskine449bd832023-01-11 14:50:10 +01009450 mbedtls_ssl_context *ssl,
9451 unsigned int sig_alg)
Jerry Yud9d91da2022-02-17 14:57:06 +08009452{
Gabor Mezei078e8032022-04-27 21:17:56 +02009453 unsigned int i;
Gabor Mezeia3d016c2022-05-10 12:44:09 +02009454 uint16_t *received_sig_algs = ssl->handshake->received_sig_algs;
Gabor Mezei078e8032022-04-27 21:17:56 +02009455
Gilles Peskine449bd832023-01-11 14:50:10 +01009456 if (sig_alg == MBEDTLS_SSL_SIG_ANON) {
9457 return MBEDTLS_SSL_HASH_NONE;
9458 }
Gabor Mezei078e8032022-04-27 21:17:56 +02009459
Gilles Peskine449bd832023-01-11 14:50:10 +01009460 for (i = 0; received_sig_algs[i] != MBEDTLS_TLS_SIG_NONE; i++) {
Neil Armstrong9f1176a2022-06-24 18:19:19 +02009461 unsigned int hash_alg_received =
Gilles Peskine449bd832023-01-11 14:50:10 +01009462 MBEDTLS_SSL_TLS12_HASH_ALG_FROM_SIG_AND_HASH_ALG(
9463 received_sig_algs[i]);
Neil Armstrong9f1176a2022-06-24 18:19:19 +02009464 unsigned int sig_alg_received =
Gilles Peskine449bd832023-01-11 14:50:10 +01009465 MBEDTLS_SSL_TLS12_SIG_ALG_FROM_SIG_AND_HASH_ALG(
9466 received_sig_algs[i]);
Neil Armstrong9f1176a2022-06-24 18:19:19 +02009467
Manuel Pégourié-Gonnard47bb3802023-06-05 12:40:32 +02009468 mbedtls_md_type_t md_alg =
9469 mbedtls_ssl_md_alg_from_hash((unsigned char) hash_alg_received);
9470 if (md_alg == MBEDTLS_MD_NONE) {
9471 continue;
9472 }
9473
Gilles Peskine449bd832023-01-11 14:50:10 +01009474 if (sig_alg == sig_alg_received) {
Neil Armstrong9f1176a2022-06-24 18:19:19 +02009475#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01009476 if (ssl->handshake->key_cert && ssl->handshake->key_cert->key) {
Neil Armstrong96eceb82022-06-30 18:05:05 +02009477 psa_algorithm_t psa_hash_alg =
Manuel Pégourié-Gonnard47bb3802023-06-05 12:40:32 +02009478 mbedtls_md_psa_alg_from_type(md_alg);
Neil Armstrong9f1176a2022-06-24 18:19:19 +02009479
Gilles Peskine449bd832023-01-11 14:50:10 +01009480 if (sig_alg_received == MBEDTLS_SSL_SIG_ECDSA &&
9481 !mbedtls_pk_can_do_ext(ssl->handshake->key_cert->key,
9482 PSA_ALG_ECDSA(psa_hash_alg),
9483 PSA_KEY_USAGE_SIGN_HASH)) {
Neil Armstrong9f1176a2022-06-24 18:19:19 +02009484 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01009485 }
Neil Armstrong9f1176a2022-06-24 18:19:19 +02009486
Gilles Peskine449bd832023-01-11 14:50:10 +01009487 if (sig_alg_received == MBEDTLS_SSL_SIG_RSA &&
9488 !mbedtls_pk_can_do_ext(ssl->handshake->key_cert->key,
9489 PSA_ALG_RSA_PKCS1V15_SIGN(
9490 psa_hash_alg),
9491 PSA_KEY_USAGE_SIGN_HASH)) {
Neil Armstrong9f1176a2022-06-24 18:19:19 +02009492 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01009493 }
Neil Armstrong9f1176a2022-06-24 18:19:19 +02009494 }
Neil Armstrong9f1176a2022-06-24 18:19:19 +02009495#endif /* MBEDTLS_USE_PSA_CRYPTO */
Neil Armstrong96eceb82022-06-30 18:05:05 +02009496
Gilles Peskine449bd832023-01-11 14:50:10 +01009497 return hash_alg_received;
Neil Armstrong9f1176a2022-06-24 18:19:19 +02009498 }
Jerry Yud9d91da2022-02-17 14:57:06 +08009499 }
Jerry Yud9d91da2022-02-17 14:57:06 +08009500
Gilles Peskine449bd832023-01-11 14:50:10 +01009501 return MBEDTLS_SSL_HASH_NONE;
Jerry Yud9d91da2022-02-17 14:57:06 +08009502}
9503
9504#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
9505
Jerry Yudc7bd172022-02-17 13:44:15 +08009506#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
9507
XiaokangQian75d40ef2022-04-20 11:05:24 +00009508int mbedtls_ssl_validate_ciphersuite(
9509 const mbedtls_ssl_context *ssl,
9510 const mbedtls_ssl_ciphersuite_t *suite_info,
9511 mbedtls_ssl_protocol_version min_tls_version,
Gilles Peskine449bd832023-01-11 14:50:10 +01009512 mbedtls_ssl_protocol_version max_tls_version)
XiaokangQian75d40ef2022-04-20 11:05:24 +00009513{
9514 (void) ssl;
9515
Gilles Peskine449bd832023-01-11 14:50:10 +01009516 if (suite_info == NULL) {
9517 return -1;
9518 }
XiaokangQian75d40ef2022-04-20 11:05:24 +00009519
Gilles Peskine449bd832023-01-11 14:50:10 +01009520 if ((suite_info->min_tls_version > max_tls_version) ||
9521 (suite_info->max_tls_version < min_tls_version)) {
9522 return -1;
XiaokangQian75d40ef2022-04-20 11:05:24 +00009523 }
9524
XiaokangQian060d8672022-04-21 09:24:56 +00009525#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_CLI_C)
XiaokangQian75d40ef2022-04-20 11:05:24 +00009526#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Neil Armstrongca7d5062022-05-31 14:43:23 +02009527#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01009528 if (suite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_ECJPAKE &&
9529 ssl->handshake->psa_pake_ctx_is_ok != 1)
Neil Armstrongca7d5062022-05-31 14:43:23 +02009530#else
Gilles Peskine449bd832023-01-11 14:50:10 +01009531 if (suite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_ECJPAKE &&
9532 mbedtls_ecjpake_check(&ssl->handshake->ecjpake_ctx) != 0)
Neil Armstrongca7d5062022-05-31 14:43:23 +02009533#endif /* MBEDTLS_USE_PSA_CRYPTO */
XiaokangQian75d40ef2022-04-20 11:05:24 +00009534 {
Gilles Peskine449bd832023-01-11 14:50:10 +01009535 return -1;
XiaokangQian75d40ef2022-04-20 11:05:24 +00009536 }
9537#endif
9538
9539 /* Don't suggest PSK-based ciphersuite if no PSK is available. */
9540#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01009541 if (mbedtls_ssl_ciphersuite_uses_psk(suite_info) &&
9542 mbedtls_ssl_conf_has_static_psk(ssl->conf) == 0) {
9543 return -1;
XiaokangQian75d40ef2022-04-20 11:05:24 +00009544 }
9545#endif /* MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
9546#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
9547
Gilles Peskine449bd832023-01-11 14:50:10 +01009548 return 0;
XiaokangQian75d40ef2022-04-20 11:05:24 +00009549}
9550
Ronald Crone68ab4f2022-10-05 12:46:29 +02009551#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
XiaokangQianeaf36512022-04-24 09:07:44 +00009552/*
9553 * Function for writing a signature algorithm extension.
9554 *
9555 * The `extension_data` field of signature algorithm contains a `SignatureSchemeList`
9556 * value (TLS 1.3 RFC8446):
9557 * enum {
9558 * ....
9559 * ecdsa_secp256r1_sha256( 0x0403 ),
9560 * ecdsa_secp384r1_sha384( 0x0503 ),
9561 * ecdsa_secp521r1_sha512( 0x0603 ),
9562 * ....
9563 * } SignatureScheme;
9564 *
9565 * struct {
9566 * SignatureScheme supported_signature_algorithms<2..2^16-2>;
9567 * } SignatureSchemeList;
9568 *
9569 * The `extension_data` field of signature algorithm contains a `SignatureAndHashAlgorithm`
9570 * value (TLS 1.2 RFC5246):
9571 * enum {
9572 * none(0), md5(1), sha1(2), sha224(3), sha256(4), sha384(5),
9573 * sha512(6), (255)
9574 * } HashAlgorithm;
9575 *
9576 * enum { anonymous(0), rsa(1), dsa(2), ecdsa(3), (255) }
9577 * SignatureAlgorithm;
9578 *
9579 * struct {
9580 * HashAlgorithm hash;
9581 * SignatureAlgorithm signature;
9582 * } SignatureAndHashAlgorithm;
9583 *
9584 * SignatureAndHashAlgorithm
9585 * supported_signature_algorithms<2..2^16-2>;
9586 *
9587 * The TLS 1.3 signature algorithm extension was defined to be a compatible
9588 * generalization of the TLS 1.2 signature algorithm extension.
9589 * `SignatureAndHashAlgorithm` field of TLS 1.2 can be represented by
9590 * `SignatureScheme` field of TLS 1.3
9591 *
9592 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009593int mbedtls_ssl_write_sig_alg_ext(mbedtls_ssl_context *ssl, unsigned char *buf,
9594 const unsigned char *end, size_t *out_len)
XiaokangQianeaf36512022-04-24 09:07:44 +00009595{
9596 unsigned char *p = buf;
9597 unsigned char *supported_sig_alg; /* Start of supported_signature_algorithms */
9598 size_t supported_sig_alg_len = 0; /* Length of supported_signature_algorithms */
9599
9600 *out_len = 0;
9601
Gilles Peskine449bd832023-01-11 14:50:10 +01009602 MBEDTLS_SSL_DEBUG_MSG(3, ("adding signature_algorithms extension"));
XiaokangQianeaf36512022-04-24 09:07:44 +00009603
9604 /* Check if we have space for header and length field:
9605 * - extension_type (2 bytes)
9606 * - extension_data_length (2 bytes)
9607 * - supported_signature_algorithms_length (2 bytes)
9608 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009609 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 6);
XiaokangQianeaf36512022-04-24 09:07:44 +00009610 p += 6;
9611
9612 /*
9613 * Write supported_signature_algorithms
9614 */
9615 supported_sig_alg = p;
Gilles Peskine449bd832023-01-11 14:50:10 +01009616 const uint16_t *sig_alg = mbedtls_ssl_get_sig_algs(ssl);
9617 if (sig_alg == NULL) {
9618 return MBEDTLS_ERR_SSL_BAD_CONFIG;
9619 }
XiaokangQianeaf36512022-04-24 09:07:44 +00009620
Gilles Peskine449bd832023-01-11 14:50:10 +01009621 for (; *sig_alg != MBEDTLS_TLS1_3_SIG_NONE; sig_alg++) {
9622 MBEDTLS_SSL_DEBUG_MSG(3, ("got signature scheme [%x] %s",
9623 *sig_alg,
9624 mbedtls_ssl_sig_alg_to_str(*sig_alg)));
9625 if (!mbedtls_ssl_sig_alg_is_supported(ssl, *sig_alg)) {
XiaokangQianeaf36512022-04-24 09:07:44 +00009626 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01009627 }
9628 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 2);
9629 MBEDTLS_PUT_UINT16_BE(*sig_alg, p, 0);
XiaokangQianeaf36512022-04-24 09:07:44 +00009630 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01009631 MBEDTLS_SSL_DEBUG_MSG(3, ("sent signature scheme [%x] %s",
9632 *sig_alg,
9633 mbedtls_ssl_sig_alg_to_str(*sig_alg)));
XiaokangQianeaf36512022-04-24 09:07:44 +00009634 }
9635
9636 /* Length of supported_signature_algorithms */
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00009637 supported_sig_alg_len = (size_t) (p - supported_sig_alg);
Gilles Peskine449bd832023-01-11 14:50:10 +01009638 if (supported_sig_alg_len == 0) {
9639 MBEDTLS_SSL_DEBUG_MSG(1, ("No signature algorithms defined."));
9640 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
XiaokangQianeaf36512022-04-24 09:07:44 +00009641 }
9642
Gilles Peskine449bd832023-01-11 14:50:10 +01009643 MBEDTLS_PUT_UINT16_BE(MBEDTLS_TLS_EXT_SIG_ALG, buf, 0);
9644 MBEDTLS_PUT_UINT16_BE(supported_sig_alg_len + 2, buf, 2);
9645 MBEDTLS_PUT_UINT16_BE(supported_sig_alg_len, buf, 4);
XiaokangQianeaf36512022-04-24 09:07:44 +00009646
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00009647 *out_len = (size_t) (p - buf);
XiaokangQianeaf36512022-04-24 09:07:44 +00009648
9649#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01009650 mbedtls_ssl_tls13_set_hs_sent_ext_mask(ssl, MBEDTLS_TLS_EXT_SIG_ALG);
XiaokangQianeaf36512022-04-24 09:07:44 +00009651#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yu0c354a22022-08-29 15:25:36 +08009652
Gilles Peskine449bd832023-01-11 14:50:10 +01009653 return 0;
XiaokangQianeaf36512022-04-24 09:07:44 +00009654}
Ronald Crone68ab4f2022-10-05 12:46:29 +02009655#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
XiaokangQianeaf36512022-04-24 09:07:44 +00009656
XiaokangQian40a35232022-05-07 09:02:40 +00009657#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
XiaokangQian9b2b7712022-05-17 02:57:00 +00009658/*
9659 * mbedtls_ssl_parse_server_name_ext
9660 *
9661 * Structure of server_name extension:
9662 *
9663 * enum {
9664 * host_name(0), (255)
9665 * } NameType;
9666 * opaque HostName<1..2^16-1>;
9667 *
9668 * struct {
9669 * NameType name_type;
9670 * select (name_type) {
9671 * case host_name: HostName;
9672 * } name;
9673 * } ServerName;
9674 * struct {
9675 * ServerName server_name_list<1..2^16-1>
9676 * } ServerNameList;
9677 */
Ronald Cronce7d76e2022-07-08 18:56:49 +02009678MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01009679int mbedtls_ssl_parse_server_name_ext(mbedtls_ssl_context *ssl,
9680 const unsigned char *buf,
9681 const unsigned char *end)
XiaokangQian40a35232022-05-07 09:02:40 +00009682{
9683 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
9684 const unsigned char *p = buf;
XiaokangQian9b2b7712022-05-17 02:57:00 +00009685 size_t server_name_list_len, hostname_len;
9686 const unsigned char *server_name_list_end;
XiaokangQian40a35232022-05-07 09:02:40 +00009687
Gilles Peskine449bd832023-01-11 14:50:10 +01009688 MBEDTLS_SSL_DEBUG_MSG(3, ("parse ServerName extension"));
XiaokangQian40a35232022-05-07 09:02:40 +00009689
Gilles Peskine449bd832023-01-11 14:50:10 +01009690 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
9691 server_name_list_len = MBEDTLS_GET_UINT16_BE(p, 0);
XiaokangQian40a35232022-05-07 09:02:40 +00009692 p += 2;
9693
Gilles Peskine449bd832023-01-11 14:50:10 +01009694 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, server_name_list_len);
XiaokangQian9b2b7712022-05-17 02:57:00 +00009695 server_name_list_end = p + server_name_list_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01009696 while (p < server_name_list_end) {
9697 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, server_name_list_end, 3);
9698 hostname_len = MBEDTLS_GET_UINT16_BE(p, 1);
9699 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, server_name_list_end,
9700 hostname_len + 3);
XiaokangQian40a35232022-05-07 09:02:40 +00009701
Gilles Peskine449bd832023-01-11 14:50:10 +01009702 if (p[0] == MBEDTLS_TLS_EXT_SERVERNAME_HOSTNAME) {
XiaokangQian75fe8c72022-06-15 09:42:45 +00009703 /* sni_name is intended to be used only during the parsing of the
9704 * ClientHello message (it is reset to NULL before the end of
9705 * the message parsing). Thus it is ok to just point to the
9706 * reception buffer and not make a copy of it.
9707 */
XiaokangQianf2a94202022-05-20 06:44:24 +00009708 ssl->handshake->sni_name = p + 3;
9709 ssl->handshake->sni_name_len = hostname_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01009710 if (ssl->conf->f_sni == NULL) {
9711 return 0;
XiaokangQian40a35232022-05-07 09:02:40 +00009712 }
Gilles Peskine449bd832023-01-11 14:50:10 +01009713 ret = ssl->conf->f_sni(ssl->conf->p_sni,
9714 ssl, p + 3, hostname_len);
9715 if (ret != 0) {
9716 MBEDTLS_SSL_DEBUG_RET(1, "ssl_sni_wrapper", ret);
9717 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_UNRECOGNIZED_NAME,
9718 MBEDTLS_ERR_SSL_UNRECOGNIZED_NAME);
9719 return MBEDTLS_ERR_SSL_UNRECOGNIZED_NAME;
9720 }
9721 return 0;
XiaokangQian40a35232022-05-07 09:02:40 +00009722 }
9723
9724 p += hostname_len + 3;
9725 }
9726
Gilles Peskine449bd832023-01-11 14:50:10 +01009727 return 0;
XiaokangQian40a35232022-05-07 09:02:40 +00009728}
9729#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
9730
XiaokangQianacb39922022-06-17 10:18:48 +00009731#if defined(MBEDTLS_SSL_ALPN)
Ronald Cronce7d76e2022-07-08 18:56:49 +02009732MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01009733int mbedtls_ssl_parse_alpn_ext(mbedtls_ssl_context *ssl,
9734 const unsigned char *buf,
9735 const unsigned char *end)
XiaokangQianacb39922022-06-17 10:18:48 +00009736{
9737 const unsigned char *p = buf;
XiaokangQianc7403452022-06-23 03:24:12 +00009738 size_t protocol_name_list_len;
XiaokangQian95d5f542022-06-24 02:29:26 +00009739 const unsigned char *protocol_name_list;
9740 const unsigned char *protocol_name_list_end;
XiaokangQianc7403452022-06-23 03:24:12 +00009741 size_t protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00009742
9743 /* If ALPN not configured, just ignore the extension */
Gilles Peskine449bd832023-01-11 14:50:10 +01009744 if (ssl->conf->alpn_list == NULL) {
9745 return 0;
9746 }
XiaokangQianacb39922022-06-17 10:18:48 +00009747
9748 /*
XiaokangQianc7403452022-06-23 03:24:12 +00009749 * RFC7301, section 3.1
9750 * opaque ProtocolName<1..2^8-1>;
XiaokangQianacb39922022-06-17 10:18:48 +00009751 *
XiaokangQianc7403452022-06-23 03:24:12 +00009752 * struct {
9753 * ProtocolName protocol_name_list<2..2^16-1>
9754 * } ProtocolNameList;
XiaokangQianacb39922022-06-17 10:18:48 +00009755 */
9756
XiaokangQianc7403452022-06-23 03:24:12 +00009757 /*
XiaokangQian0b776e22022-06-24 09:04:59 +00009758 * protocol_name_list_len 2 bytes
9759 * protocol_name_len 1 bytes
9760 * protocol_name >=1 byte
XiaokangQianc7403452022-06-23 03:24:12 +00009761 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009762 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 4);
XiaokangQianacb39922022-06-17 10:18:48 +00009763
Gilles Peskine449bd832023-01-11 14:50:10 +01009764 protocol_name_list_len = MBEDTLS_GET_UINT16_BE(p, 0);
XiaokangQianacb39922022-06-17 10:18:48 +00009765 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01009766 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, protocol_name_list_len);
XiaokangQian95d5f542022-06-24 02:29:26 +00009767 protocol_name_list = p;
9768 protocol_name_list_end = p + protocol_name_list_len;
XiaokangQianacb39922022-06-17 10:18:48 +00009769
9770 /* Validate peer's list (lengths) */
Gilles Peskine449bd832023-01-11 14:50:10 +01009771 while (p < protocol_name_list_end) {
XiaokangQian95d5f542022-06-24 02:29:26 +00009772 protocol_name_len = *p++;
Gilles Peskine449bd832023-01-11 14:50:10 +01009773 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, protocol_name_list_end,
9774 protocol_name_len);
9775 if (protocol_name_len == 0) {
XiaokangQian95d5f542022-06-24 02:29:26 +00009776 MBEDTLS_SSL_PEND_FATAL_ALERT(
9777 MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
Gilles Peskine449bd832023-01-11 14:50:10 +01009778 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
9779 return MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
XiaokangQian95d5f542022-06-24 02:29:26 +00009780 }
9781
9782 p += protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00009783 }
9784
9785 /* Use our order of preference */
Gilles Peskine449bd832023-01-11 14:50:10 +01009786 for (const char **alpn = ssl->conf->alpn_list; *alpn != NULL; alpn++) {
9787 size_t const alpn_len = strlen(*alpn);
XiaokangQian95d5f542022-06-24 02:29:26 +00009788 p = protocol_name_list;
Gilles Peskine449bd832023-01-11 14:50:10 +01009789 while (p < protocol_name_list_end) {
XiaokangQian95d5f542022-06-24 02:29:26 +00009790 protocol_name_len = *p++;
Gilles Peskine449bd832023-01-11 14:50:10 +01009791 if (protocol_name_len == alpn_len &&
9792 memcmp(p, *alpn, alpn_len) == 0) {
XiaokangQianacb39922022-06-17 10:18:48 +00009793 ssl->alpn_chosen = *alpn;
Gilles Peskine449bd832023-01-11 14:50:10 +01009794 return 0;
XiaokangQianacb39922022-06-17 10:18:48 +00009795 }
XiaokangQian95d5f542022-06-24 02:29:26 +00009796
9797 p += protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00009798 }
9799 }
9800
XiaokangQian95d5f542022-06-24 02:29:26 +00009801 /* If we get here, no match was found */
XiaokangQianacb39922022-06-17 10:18:48 +00009802 MBEDTLS_SSL_PEND_FATAL_ALERT(
Gilles Peskine449bd832023-01-11 14:50:10 +01009803 MBEDTLS_SSL_ALERT_MSG_NO_APPLICATION_PROTOCOL,
9804 MBEDTLS_ERR_SSL_NO_APPLICATION_PROTOCOL);
9805 return MBEDTLS_ERR_SSL_NO_APPLICATION_PROTOCOL;
XiaokangQianacb39922022-06-17 10:18:48 +00009806}
9807
Gilles Peskine449bd832023-01-11 14:50:10 +01009808int mbedtls_ssl_write_alpn_ext(mbedtls_ssl_context *ssl,
9809 unsigned char *buf,
9810 unsigned char *end,
9811 size_t *out_len)
XiaokangQianacb39922022-06-17 10:18:48 +00009812{
9813 unsigned char *p = buf;
XiaokangQian95d5f542022-06-24 02:29:26 +00009814 size_t protocol_name_len;
XiaokangQianc7403452022-06-23 03:24:12 +00009815 *out_len = 0;
XiaokangQianacb39922022-06-17 10:18:48 +00009816
Gilles Peskine449bd832023-01-11 14:50:10 +01009817 if (ssl->alpn_chosen == NULL) {
9818 return 0;
XiaokangQianacb39922022-06-17 10:18:48 +00009819 }
9820
Gilles Peskine449bd832023-01-11 14:50:10 +01009821 protocol_name_len = strlen(ssl->alpn_chosen);
9822 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 7 + protocol_name_len);
XiaokangQianacb39922022-06-17 10:18:48 +00009823
Gilles Peskine449bd832023-01-11 14:50:10 +01009824 MBEDTLS_SSL_DEBUG_MSG(3, ("server side, adding alpn extension"));
XiaokangQianacb39922022-06-17 10:18:48 +00009825 /*
9826 * 0 . 1 ext identifier
9827 * 2 . 3 ext length
9828 * 4 . 5 protocol list length
9829 * 6 . 6 protocol name length
9830 * 7 . 7+n protocol name
9831 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009832 MBEDTLS_PUT_UINT16_BE(MBEDTLS_TLS_EXT_ALPN, p, 0);
XiaokangQianacb39922022-06-17 10:18:48 +00009833
XiaokangQian95d5f542022-06-24 02:29:26 +00009834 *out_len = 7 + protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00009835
Gilles Peskine449bd832023-01-11 14:50:10 +01009836 MBEDTLS_PUT_UINT16_BE(protocol_name_len + 3, p, 2);
9837 MBEDTLS_PUT_UINT16_BE(protocol_name_len + 1, p, 4);
XiaokangQian0b776e22022-06-24 09:04:59 +00009838 /* Note: the length of the chosen protocol has been checked to be less
9839 * than 255 bytes in `mbedtls_ssl_conf_alpn_protocols`.
9840 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009841 p[6] = MBEDTLS_BYTE_0(protocol_name_len);
XiaokangQianacb39922022-06-17 10:18:48 +00009842
Gilles Peskine449bd832023-01-11 14:50:10 +01009843 memcpy(p + 7, ssl->alpn_chosen, protocol_name_len);
Jerry Yub95dd362022-11-08 21:19:34 +08009844
9845#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01009846 mbedtls_ssl_tls13_set_hs_sent_ext_mask(ssl, MBEDTLS_TLS_EXT_ALPN);
Jerry Yub95dd362022-11-08 21:19:34 +08009847#endif
9848
Gilles Peskine449bd832023-01-11 14:50:10 +01009849 return 0;
XiaokangQianacb39922022-06-17 10:18:48 +00009850}
9851#endif /* MBEDTLS_SSL_ALPN */
9852
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009853#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && \
Xiaokang Qian03409292022-10-12 02:49:52 +00009854 defined(MBEDTLS_SSL_SESSION_TICKETS) && \
Xiaokang Qianed0620c2022-10-12 06:58:13 +00009855 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION) && \
Xiaokang Qianed3afcd2022-10-12 08:31:11 +00009856 defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01009857int mbedtls_ssl_session_set_hostname(mbedtls_ssl_session *session,
9858 const char *hostname)
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009859{
9860 /* Initialize to suppress unnecessary compiler warning */
9861 size_t hostname_len = 0;
9862
9863 /* Check if new hostname is valid before
9864 * making any change to current one */
Gilles Peskine449bd832023-01-11 14:50:10 +01009865 if (hostname != NULL) {
9866 hostname_len = strlen(hostname);
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009867
Gilles Peskine449bd832023-01-11 14:50:10 +01009868 if (hostname_len > MBEDTLS_SSL_MAX_HOST_NAME_LEN) {
9869 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9870 }
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009871 }
9872
9873 /* Now it's clear that we will overwrite the old hostname,
9874 * so we can free it safely */
Gilles Peskine449bd832023-01-11 14:50:10 +01009875 if (session->hostname != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01009876 mbedtls_zeroize_and_free(session->hostname,
Gilles Peskine449bd832023-01-11 14:50:10 +01009877 strlen(session->hostname));
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009878 }
9879
9880 /* Passing NULL as hostname shall clear the old one */
Gilles Peskine449bd832023-01-11 14:50:10 +01009881 if (hostname == NULL) {
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009882 session->hostname = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01009883 } else {
9884 session->hostname = mbedtls_calloc(1, hostname_len + 1);
9885 if (session->hostname == NULL) {
9886 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
9887 }
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009888
Gilles Peskine449bd832023-01-11 14:50:10 +01009889 memcpy(session->hostname, hostname, hostname_len);
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009890 }
9891
Gilles Peskine449bd832023-01-11 14:50:10 +01009892 return 0;
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009893}
Xiaokang Qian03409292022-10-12 02:49:52 +00009894#endif /* MBEDTLS_SSL_PROTO_TLS1_3 &&
9895 MBEDTLS_SSL_SESSION_TICKETS &&
Xiaokang Qianed0620c2022-10-12 06:58:13 +00009896 MBEDTLS_SSL_SERVER_NAME_INDICATION &&
Xiaokang Qianed3afcd2022-10-12 08:31:11 +00009897 MBEDTLS_SSL_CLI_C */
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009898
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00009899#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_EARLY_DATA) && \
9900 defined(MBEDTLS_SSL_ALPN)
Waleed Elmelegy7dfba342024-03-12 16:22:39 +00009901int mbedtls_ssl_session_set_ticket_alpn(mbedtls_ssl_session *session,
9902 const char *alpn)
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00009903{
9904 size_t alpn_len = 0;
9905
9906 if (alpn != NULL) {
9907 alpn_len = strlen(alpn);
9908
9909 if (alpn_len > MBEDTLS_SSL_MAX_ALPN_NAME_LEN) {
9910 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9911 }
9912 }
9913
9914 if (session->ticket_alpn != NULL) {
9915 mbedtls_zeroize_and_free(session->ticket_alpn,
9916 strlen(session->ticket_alpn));
Waleed Elmelegy7dfba342024-03-12 16:22:39 +00009917 session->ticket_alpn = NULL;
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00009918 }
9919
Waleed Elmelegy7dfba342024-03-12 16:22:39 +00009920 if (alpn != NULL) {
9921 session->ticket_alpn = mbedtls_calloc(alpn_len + 1, 1);
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00009922 if (session->ticket_alpn == NULL) {
9923 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
9924 }
Waleed Elmelegy7dfba342024-03-12 16:22:39 +00009925 memcpy(session->ticket_alpn, alpn, alpn_len);
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00009926 }
9927
9928 return 0;
9929}
9930#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_EARLY_DATA && MBEDTLS_SSL_ALPN */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02009931#endif /* MBEDTLS_SSL_TLS_C */