blob: ad8f3f0e35554b1c11d566d6926eef702d296cc7 [file] [log] [blame]
Paul Bakker5121ce52009-01-03 21:22:43 +00001/*
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01002 * TLS shared functions
Paul Bakker5121ce52009-01-03 21:22:43 +00003 *
Bence Szépkúti1e148272020-08-07 13:07:28 +02004 * Copyright The Mbed TLS Contributors
Dave Rodgman16799db2023-11-02 19:47:20 +00005 * SPDX-License-Identifier: Apache-2.0 OR GPL-2.0-or-later
Paul Bakker5121ce52009-01-03 21:22:43 +00006 */
7/*
Paul Bakker5121ce52009-01-03 21:22:43 +00008 * http://www.ietf.org/rfc/rfc2246.txt
9 * http://www.ietf.org/rfc/rfc4346.txt
10 */
11
Gilles Peskinedb09ef62020-06-03 01:43:33 +020012#include "common.h"
Paul Bakker5121ce52009-01-03 21:22:43 +000013
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020014#if defined(MBEDTLS_SSL_TLS_C)
Paul Bakker5121ce52009-01-03 21:22:43 +000015
SimonBd5800b72016-04-26 07:43:27 +010016#include "mbedtls/platform.h"
SimonBd5800b72016-04-26 07:43:27 +010017
Manuel Pégourié-Gonnard7f809972015-03-09 17:05:11 +000018#include "mbedtls/ssl.h"
Ronald Cron9f0fba32022-02-10 16:45:15 +010019#include "ssl_client.h"
Ronald Cron27c85e72022-03-08 11:37:55 +010020#include "ssl_debug_helpers.h"
Chris Jones84a773f2021-03-05 18:38:47 +000021#include "ssl_misc.h"
Andrzej Kurek25f27152022-08-17 16:09:31 -040022
Valerio Settib4f50762024-01-17 10:24:52 +010023#include "debug_internal.h"
Janos Follath73c616b2019-12-18 15:07:04 +000024#include "mbedtls/error.h"
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -050025#include "mbedtls/platform_util.h"
Hanno Beckera835da52019-05-16 12:39:07 +010026#include "mbedtls/version.h"
Gabor Mezei765862c2021-10-19 12:22:25 +020027#include "mbedtls/constant_time.h"
Paul Bakker0be444a2013-08-27 21:55:01 +020028
Rich Evans00ab4702015-02-06 13:43:58 +000029#include <string.h>
30
Andrzej Kurekd6db9be2019-01-10 05:27:10 -050031#if defined(MBEDTLS_USE_PSA_CRYPTO)
Valerio Setti384fbde2024-01-02 13:26:40 +010032#include "mbedtls/psa_util.h"
Manuel Pégourié-Gonnard02b10d82023-03-28 12:33:20 +020033#include "md_psa.h"
Manuel Pégourié-Gonnard2be8c632023-06-07 13:07:21 +020034#include "psa_util_internal.h"
Andrzej Kurekd6db9be2019-01-10 05:27:10 -050035#include "psa/crypto.h"
36#endif
37
Janos Follath23bdca02016-10-07 14:47:14 +010038#if defined(MBEDTLS_X509_CRT_PARSE_C)
Manuel Pégourié-Gonnard7f809972015-03-09 17:05:11 +000039#include "mbedtls/oid.h"
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +020040#endif
41
Andrzej Kurek8a045ce2022-12-23 11:00:06 -050042#if defined(MBEDTLS_USE_PSA_CRYPTO)
Andrzej Kurek00644842023-05-30 05:45:00 -040043/* Define local translating functions to save code size by not using too many
44 * arguments in each translating place. */
45static int local_err_translation(psa_status_t status)
46{
47 return psa_status_to_mbedtls(status, psa_to_ssl_errors,
Andrzej Kurek1e4a0302023-05-30 09:45:17 -040048 ARRAY_LENGTH(psa_to_ssl_errors),
Andrzej Kurek00644842023-05-30 05:45:00 -040049 psa_generic_status_to_mbedtls);
50}
51#define PSA_TO_MBEDTLS_ERR(status) local_err_translation(status)
Andrzej Kurek8a045ce2022-12-23 11:00:06 -050052#endif
53
Ronald Cronad8c17b2022-06-10 17:18:09 +020054#if defined(MBEDTLS_TEST_HOOKS)
55static mbedtls_ssl_chk_buf_ptr_args chk_buf_ptr_fail_args;
56
57void mbedtls_ssl_set_chk_buf_ptr_fail_args(
Gilles Peskine449bd832023-01-11 14:50:10 +010058 const uint8_t *cur, const uint8_t *end, size_t need)
Ronald Cronad8c17b2022-06-10 17:18:09 +020059{
60 chk_buf_ptr_fail_args.cur = cur;
61 chk_buf_ptr_fail_args.end = end;
62 chk_buf_ptr_fail_args.need = need;
63}
64
Gilles Peskine449bd832023-01-11 14:50:10 +010065void mbedtls_ssl_reset_chk_buf_ptr_fail_args(void)
Ronald Cronad8c17b2022-06-10 17:18:09 +020066{
Gilles Peskine449bd832023-01-11 14:50:10 +010067 memset(&chk_buf_ptr_fail_args, 0, sizeof(chk_buf_ptr_fail_args));
Ronald Cronad8c17b2022-06-10 17:18:09 +020068}
69
Gilles Peskine449bd832023-01-11 14:50:10 +010070int mbedtls_ssl_cmp_chk_buf_ptr_fail_args(mbedtls_ssl_chk_buf_ptr_args *args)
Ronald Cronad8c17b2022-06-10 17:18:09 +020071{
Gilles Peskine449bd832023-01-11 14:50:10 +010072 return (chk_buf_ptr_fail_args.cur != args->cur) ||
73 (chk_buf_ptr_fail_args.end != args->end) ||
74 (chk_buf_ptr_fail_args.need != args->need);
Ronald Cronad8c17b2022-06-10 17:18:09 +020075}
76#endif /* MBEDTLS_TEST_HOOKS */
77
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +020078#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker2b1e3542018-08-06 11:19:13 +010079
Hanno Beckera0e20d02019-05-15 14:03:01 +010080#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckerf8542cf2019-04-09 15:22:03 +010081/* Top-level Connection ID API */
82
Gilles Peskine449bd832023-01-11 14:50:10 +010083int mbedtls_ssl_conf_cid(mbedtls_ssl_config *conf,
84 size_t len,
85 int ignore_other_cid)
Hanno Beckerad4a1372019-05-03 13:06:44 +010086{
Gilles Peskine449bd832023-01-11 14:50:10 +010087 if (len > MBEDTLS_SSL_CID_IN_LEN_MAX) {
88 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
89 }
Hanno Beckerad4a1372019-05-03 13:06:44 +010090
Gilles Peskine449bd832023-01-11 14:50:10 +010091 if (ignore_other_cid != MBEDTLS_SSL_UNEXPECTED_CID_FAIL &&
92 ignore_other_cid != MBEDTLS_SSL_UNEXPECTED_CID_IGNORE) {
93 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Becker611ac772019-05-14 11:45:26 +010094 }
95
96 conf->ignore_unexpected_cid = ignore_other_cid;
Hanno Beckerad4a1372019-05-03 13:06:44 +010097 conf->cid_len = len;
Gilles Peskine449bd832023-01-11 14:50:10 +010098 return 0;
Hanno Beckerad4a1372019-05-03 13:06:44 +010099}
100
Gilles Peskine449bd832023-01-11 14:50:10 +0100101int mbedtls_ssl_set_cid(mbedtls_ssl_context *ssl,
102 int enable,
103 unsigned char const *own_cid,
104 size_t own_cid_len)
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100105{
Gilles Peskine449bd832023-01-11 14:50:10 +0100106 if (ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
107 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
108 }
Hanno Becker76a79ab2019-05-03 14:38:32 +0100109
Hanno Beckerca092242019-04-25 16:01:49 +0100110 ssl->negotiate_cid = enable;
Gilles Peskine449bd832023-01-11 14:50:10 +0100111 if (enable == MBEDTLS_SSL_CID_DISABLED) {
112 MBEDTLS_SSL_DEBUG_MSG(3, ("Disable use of CID extension."));
113 return 0;
Hanno Beckerca092242019-04-25 16:01:49 +0100114 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100115 MBEDTLS_SSL_DEBUG_MSG(3, ("Enable use of CID extension."));
116 MBEDTLS_SSL_DEBUG_BUF(3, "Own CID", own_cid, own_cid_len);
Hanno Beckerca092242019-04-25 16:01:49 +0100117
Gilles Peskine449bd832023-01-11 14:50:10 +0100118 if (own_cid_len != ssl->conf->cid_len) {
119 MBEDTLS_SSL_DEBUG_MSG(3, ("CID length %u does not match CID length %u in config",
120 (unsigned) own_cid_len,
121 (unsigned) ssl->conf->cid_len));
122 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Beckerca092242019-04-25 16:01:49 +0100123 }
124
Gilles Peskine449bd832023-01-11 14:50:10 +0100125 memcpy(ssl->own_cid, own_cid, own_cid_len);
Hanno Beckerb7ee0cf2019-04-30 14:07:31 +0100126 /* Truncation is not an issue here because
127 * MBEDTLS_SSL_CID_IN_LEN_MAX at most 255. */
128 ssl->own_cid_len = (uint8_t) own_cid_len;
Hanno Beckerca092242019-04-25 16:01:49 +0100129
Gilles Peskine449bd832023-01-11 14:50:10 +0100130 return 0;
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100131}
132
Gilles Peskine449bd832023-01-11 14:50:10 +0100133int mbedtls_ssl_get_own_cid(mbedtls_ssl_context *ssl,
134 int *enabled,
Sam Berry9722fd12024-06-11 14:34:17 +0100135 unsigned char own_cid[MBEDTLS_SSL_CID_IN_LEN_MAX],
Gilles Peskine449bd832023-01-11 14:50:10 +0100136 size_t *own_cid_len)
Paul Elliott0113cf12022-03-11 20:26:47 +0000137{
138 *enabled = MBEDTLS_SSL_CID_DISABLED;
139
Gilles Peskine449bd832023-01-11 14:50:10 +0100140 if (ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
141 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
142 }
Paul Elliott0113cf12022-03-11 20:26:47 +0000143
144 /* We report MBEDTLS_SSL_CID_DISABLED in case the CID length is
145 * zero as this is indistinguishable from not requesting to use
146 * the CID extension. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100147 if (ssl->own_cid_len == 0 || ssl->negotiate_cid == MBEDTLS_SSL_CID_DISABLED) {
148 return 0;
149 }
Paul Elliott0113cf12022-03-11 20:26:47 +0000150
Gilles Peskine449bd832023-01-11 14:50:10 +0100151 if (own_cid_len != NULL) {
Paul Elliott0113cf12022-03-11 20:26:47 +0000152 *own_cid_len = ssl->own_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +0100153 if (own_cid != NULL) {
154 memcpy(own_cid, ssl->own_cid, ssl->own_cid_len);
155 }
Paul Elliott0113cf12022-03-11 20:26:47 +0000156 }
157
158 *enabled = MBEDTLS_SSL_CID_ENABLED;
159
Gilles Peskine449bd832023-01-11 14:50:10 +0100160 return 0;
Paul Elliott0113cf12022-03-11 20:26:47 +0000161}
162
Gilles Peskine449bd832023-01-11 14:50:10 +0100163int mbedtls_ssl_get_peer_cid(mbedtls_ssl_context *ssl,
164 int *enabled,
165 unsigned char peer_cid[MBEDTLS_SSL_CID_OUT_LEN_MAX],
166 size_t *peer_cid_len)
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100167{
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100168 *enabled = MBEDTLS_SSL_CID_DISABLED;
Hanno Beckerb1f89cd2019-04-26 17:08:02 +0100169
Gilles Peskine449bd832023-01-11 14:50:10 +0100170 if (ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM ||
171 mbedtls_ssl_is_handshake_over(ssl) == 0) {
172 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Becker76a79ab2019-05-03 14:38:32 +0100173 }
Hanno Beckerb1f89cd2019-04-26 17:08:02 +0100174
Hanno Beckerc5f24222019-05-03 12:54:52 +0100175 /* We report MBEDTLS_SSL_CID_DISABLED in case the CID extensions
176 * were used, but client and server requested the empty CID.
177 * This is indistinguishable from not using the CID extension
178 * in the first place. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100179 if (ssl->transform_in->in_cid_len == 0 &&
180 ssl->transform_in->out_cid_len == 0) {
181 return 0;
Hanno Beckerb1f89cd2019-04-26 17:08:02 +0100182 }
183
Gilles Peskine449bd832023-01-11 14:50:10 +0100184 if (peer_cid_len != NULL) {
Hanno Becker615ef172019-05-22 16:50:35 +0100185 *peer_cid_len = ssl->transform_in->out_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +0100186 if (peer_cid != NULL) {
187 memcpy(peer_cid, ssl->transform_in->out_cid,
188 ssl->transform_in->out_cid_len);
Hanno Becker615ef172019-05-22 16:50:35 +0100189 }
190 }
Hanno Beckerb1f89cd2019-04-26 17:08:02 +0100191
192 *enabled = MBEDTLS_SSL_CID_ENABLED;
193
Gilles Peskine449bd832023-01-11 14:50:10 +0100194 return 0;
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100195}
Hanno Beckera0e20d02019-05-15 14:03:01 +0100196#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100197
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200198#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200199
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200200#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Manuel Pégourié-Gonnard581e6b62013-07-18 12:32:27 +0200201/*
202 * Convert max_fragment_length codes to length.
203 * RFC 6066 says:
204 * enum{
205 * 2^9(1), 2^10(2), 2^11(3), 2^12(4), (255)
206 * } MaxFragmentLength;
207 * and we add 0 -> extension unused
208 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100209static unsigned int ssl_mfl_code_to_length(int mfl)
Manuel Pégourié-Gonnard581e6b62013-07-18 12:32:27 +0200210{
Gilles Peskine449bd832023-01-11 14:50:10 +0100211 switch (mfl) {
212 case MBEDTLS_SSL_MAX_FRAG_LEN_NONE:
213 return MBEDTLS_TLS_EXT_ADV_CONTENT_LEN;
214 case MBEDTLS_SSL_MAX_FRAG_LEN_512:
215 return 512;
216 case MBEDTLS_SSL_MAX_FRAG_LEN_1024:
217 return 1024;
218 case MBEDTLS_SSL_MAX_FRAG_LEN_2048:
219 return 2048;
220 case MBEDTLS_SSL_MAX_FRAG_LEN_4096:
221 return 4096;
222 default:
223 return MBEDTLS_TLS_EXT_ADV_CONTENT_LEN;
Angus Grattond8213d02016-05-25 20:56:48 +1000224 }
225}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200226#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
Manuel Pégourié-Gonnard581e6b62013-07-18 12:32:27 +0200227
Gilles Peskine449bd832023-01-11 14:50:10 +0100228int mbedtls_ssl_session_copy(mbedtls_ssl_session *dst,
229 const mbedtls_ssl_session *src)
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200230{
Gilles Peskine449bd832023-01-11 14:50:10 +0100231 mbedtls_ssl_session_free(dst);
232 memcpy(dst, src, sizeof(mbedtls_ssl_session));
吴敬辉0b716112021-11-29 10:46:35 +0800233#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
234 dst->ticket = NULL;
Xiaokang Qian87306442022-10-12 09:47:38 +0000235#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && \
236 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Xiaokang Qian126bf8e2022-10-13 02:22:40 +0000237 dst->hostname = NULL;
吴敬辉0b716112021-11-29 10:46:35 +0800238#endif
Xiaokang Qian87306442022-10-12 09:47:38 +0000239#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
吴敬辉0b716112021-11-29 10:46:35 +0800240
Waleed Elmelegy4dfb0e72024-03-14 01:48:40 +0000241#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_ALPN) && \
242 defined(MBEDTLS_SSL_EARLY_DATA)
243 dst->ticket_alpn = NULL;
244#endif
245
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200246#if defined(MBEDTLS_X509_CRT_PARSE_C)
Hanno Becker6d1986e2019-02-07 12:27:42 +0000247
248#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +0100249 if (src->peer_cert != NULL) {
Janos Follath865b3eb2019-12-16 11:46:15 +0000250 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker2292d1f2013-09-15 17:06:49 +0200251
Gilles Peskine449bd832023-01-11 14:50:10 +0100252 dst->peer_cert = mbedtls_calloc(1, sizeof(mbedtls_x509_crt));
253 if (dst->peer_cert == NULL) {
254 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
255 }
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200256
Gilles Peskine449bd832023-01-11 14:50:10 +0100257 mbedtls_x509_crt_init(dst->peer_cert);
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200258
Gilles Peskine449bd832023-01-11 14:50:10 +0100259 if ((ret = mbedtls_x509_crt_parse_der(dst->peer_cert, src->peer_cert->raw.p,
260 src->peer_cert->raw.len)) != 0) {
261 mbedtls_free(dst->peer_cert);
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200262 dst->peer_cert = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +0100263 return ret;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200264 }
265 }
Hanno Becker6d1986e2019-02-07 12:27:42 +0000266#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Gilles Peskine449bd832023-01-11 14:50:10 +0100267 if (src->peer_cert_digest != NULL) {
Hanno Becker9198ad12019-02-05 17:00:50 +0000268 dst->peer_cert_digest =
Gilles Peskine449bd832023-01-11 14:50:10 +0100269 mbedtls_calloc(1, src->peer_cert_digest_len);
270 if (dst->peer_cert_digest == NULL) {
271 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
272 }
Hanno Becker9198ad12019-02-05 17:00:50 +0000273
Gilles Peskine449bd832023-01-11 14:50:10 +0100274 memcpy(dst->peer_cert_digest, src->peer_cert_digest,
275 src->peer_cert_digest_len);
Hanno Becker9198ad12019-02-05 17:00:50 +0000276 dst->peer_cert_digest_type = src->peer_cert_digest_type;
Hanno Beckeraccc5992019-02-25 10:06:59 +0000277 dst->peer_cert_digest_len = src->peer_cert_digest_len;
Hanno Becker9198ad12019-02-05 17:00:50 +0000278 }
279#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
280
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200281#endif /* MBEDTLS_X509_CRT_PARSE_C */
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200282
Waleed Elmelegy4dfb0e72024-03-14 01:48:40 +0000283#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_ALPN) && \
284 defined(MBEDTLS_SSL_EARLY_DATA)
285 {
286 int ret = mbedtls_ssl_session_set_ticket_alpn(dst, src->ticket_alpn);
287 if (ret != 0) {
288 return ret;
289 }
290 }
291#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_ALPN && MBEDTLS_SSL_EARLY_DATA */
292
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +0200293#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +0100294 if (src->ticket != NULL) {
295 dst->ticket = mbedtls_calloc(1, src->ticket_len);
296 if (dst->ticket == NULL) {
297 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
298 }
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200299
Gilles Peskine449bd832023-01-11 14:50:10 +0100300 memcpy(dst->ticket, src->ticket, src->ticket_len);
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200301 }
Xiaokang Qian126bf8e2022-10-13 02:22:40 +0000302
303#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && \
304 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +0100305 if (src->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Xiaokang Qian126bf8e2022-10-13 02:22:40 +0000306 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine449bd832023-01-11 14:50:10 +0100307 ret = mbedtls_ssl_session_set_hostname(dst, src->hostname);
308 if (ret != 0) {
309 return ret;
310 }
Xiaokang Qian126bf8e2022-10-13 02:22:40 +0000311 }
312#endif /* MBEDTLS_SSL_PROTO_TLS1_3 &&
313 MBEDTLS_SSL_SERVER_NAME_INDICATION */
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +0200314#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200315
Gilles Peskine449bd832023-01-11 14:50:10 +0100316 return 0;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200317}
318
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500319#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200320MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100321static int resize_buffer(unsigned char **buffer, size_t len_new, size_t *len_old)
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500322{
Gilles Peskine449bd832023-01-11 14:50:10 +0100323 unsigned char *resized_buffer = mbedtls_calloc(1, len_new);
324 if (resized_buffer == NULL) {
Yanray Wang365ee3e2023-11-22 10:28:28 +0800325 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
Gilles Peskine449bd832023-01-11 14:50:10 +0100326 }
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500327
328 /* We want to copy len_new bytes when downsizing the buffer, and
329 * len_old bytes when upsizing, so we choose the smaller of two sizes,
330 * to fit one buffer into another. Size checks, ensuring that no data is
331 * lost, are done outside of this function. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100332 memcpy(resized_buffer, *buffer,
333 (len_new < *len_old) ? len_new : *len_old);
Tom Cosgroveca8c61b2023-07-17 15:17:40 +0100334 mbedtls_zeroize_and_free(*buffer, *len_old);
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500335
336 *buffer = resized_buffer;
337 *len_old = len_new;
338
339 return 0;
340}
Andrzej Kurek4a063792020-10-21 15:08:44 +0200341
Gilles Peskine449bd832023-01-11 14:50:10 +0100342static void handle_buffer_resizing(mbedtls_ssl_context *ssl, int downsizing,
343 size_t in_buf_new_len,
344 size_t out_buf_new_len)
Andrzej Kurek4a063792020-10-21 15:08:44 +0200345{
346 int modified = 0;
347 size_t written_in = 0, iv_offset_in = 0, len_offset_in = 0;
348 size_t written_out = 0, iv_offset_out = 0, len_offset_out = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +0100349 if (ssl->in_buf != NULL) {
Andrzej Kurek4a063792020-10-21 15:08:44 +0200350 written_in = ssl->in_msg - ssl->in_buf;
351 iv_offset_in = ssl->in_iv - ssl->in_buf;
352 len_offset_in = ssl->in_len - ssl->in_buf;
Gilles Peskine449bd832023-01-11 14:50:10 +0100353 if (downsizing ?
Andrzej Kurek4a063792020-10-21 15:08:44 +0200354 ssl->in_buf_len > in_buf_new_len && ssl->in_left < in_buf_new_len :
Gilles Peskine449bd832023-01-11 14:50:10 +0100355 ssl->in_buf_len < in_buf_new_len) {
356 if (resize_buffer(&ssl->in_buf, in_buf_new_len, &ssl->in_buf_len) != 0) {
357 MBEDTLS_SSL_DEBUG_MSG(1, ("input buffer resizing failed - out of memory"));
358 } else {
359 MBEDTLS_SSL_DEBUG_MSG(2, ("Reallocating in_buf to %" MBEDTLS_PRINTF_SIZET,
360 in_buf_new_len));
Andrzej Kurek4a063792020-10-21 15:08:44 +0200361 modified = 1;
362 }
363 }
364 }
365
Gilles Peskine449bd832023-01-11 14:50:10 +0100366 if (ssl->out_buf != NULL) {
Andrzej Kurek4a063792020-10-21 15:08:44 +0200367 written_out = ssl->out_msg - ssl->out_buf;
368 iv_offset_out = ssl->out_iv - ssl->out_buf;
369 len_offset_out = ssl->out_len - ssl->out_buf;
Gilles Peskine449bd832023-01-11 14:50:10 +0100370 if (downsizing ?
Andrzej Kurek4a063792020-10-21 15:08:44 +0200371 ssl->out_buf_len > out_buf_new_len && ssl->out_left < out_buf_new_len :
Gilles Peskine449bd832023-01-11 14:50:10 +0100372 ssl->out_buf_len < out_buf_new_len) {
373 if (resize_buffer(&ssl->out_buf, out_buf_new_len, &ssl->out_buf_len) != 0) {
374 MBEDTLS_SSL_DEBUG_MSG(1, ("output buffer resizing failed - out of memory"));
375 } else {
376 MBEDTLS_SSL_DEBUG_MSG(2, ("Reallocating out_buf to %" MBEDTLS_PRINTF_SIZET,
377 out_buf_new_len));
Andrzej Kurek4a063792020-10-21 15:08:44 +0200378 modified = 1;
379 }
380 }
381 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100382 if (modified) {
Andrzej Kurek4a063792020-10-21 15:08:44 +0200383 /* Update pointers here to avoid doing it twice. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100384 mbedtls_ssl_reset_in_out_pointers(ssl);
Andrzej Kurek4a063792020-10-21 15:08:44 +0200385 /* Fields below might not be properly updated with record
386 * splitting or with CID, so they are manually updated here. */
387 ssl->out_msg = ssl->out_buf + written_out;
388 ssl->out_len = ssl->out_buf + len_offset_out;
389 ssl->out_iv = ssl->out_buf + iv_offset_out;
390
391 ssl->in_msg = ssl->in_buf + written_in;
392 ssl->in_len = ssl->in_buf + len_offset_in;
393 ssl->in_iv = ssl->in_buf + iv_offset_in;
394 }
395}
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500396#endif /* MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH */
397
Jerry Yudb8c48a2022-01-27 14:54:54 +0800398#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Jerry Yued14c932022-02-17 13:40:45 +0800399
400#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
Gilles Peskine449bd832023-01-11 14:50:10 +0100401typedef int (*tls_prf_fn)(const unsigned char *secret, size_t slen,
402 const char *label,
403 const unsigned char *random, size_t rlen,
404 unsigned char *dstbuf, size_t dlen);
Jerry Yued14c932022-02-17 13:40:45 +0800405
Gilles Peskine449bd832023-01-11 14:50:10 +0100406static tls_prf_fn ssl_tls12prf_from_cs(int ciphersuite_id);
Jerry Yued14c932022-02-17 13:40:45 +0800407
408#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
409
410/* Type for the TLS PRF */
411typedef int ssl_tls_prf_t(const unsigned char *, size_t, const char *,
412 const unsigned char *, size_t,
413 unsigned char *, size_t);
414
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200415MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100416static int ssl_tls12_populate_transform(mbedtls_ssl_transform *transform,
417 int ciphersuite,
418 const unsigned char master[48],
Neil Armstrongf2c82f02022-04-05 11:16:53 +0200419#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +0100420 int encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +0200421#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +0100422 ssl_tls_prf_t tls_prf,
423 const unsigned char randbytes[64],
424 mbedtls_ssl_protocol_version tls_version,
425 unsigned endpoint,
426 const mbedtls_ssl_context *ssl);
Jerry Yued14c932022-02-17 13:40:45 +0800427
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100428#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200429MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100430static int tls_prf_sha256(const unsigned char *secret, size_t slen,
Ron Eldor51d3ab52019-05-12 14:54:30 +0300431 const char *label,
432 const unsigned char *random, size_t rlen,
Gilles Peskine449bd832023-01-11 14:50:10 +0100433 unsigned char *dstbuf, size_t dlen);
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100434static int ssl_calc_verify_tls_sha256(const mbedtls_ssl_context *, unsigned char *, size_t *);
435static int ssl_calc_finished_tls_sha256(mbedtls_ssl_context *, unsigned char *, int);
Gilles Peskine449bd832023-01-11 14:50:10 +0100436
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100437#endif /* MBEDTLS_MD_CAN_SHA256*/
Gilles Peskine449bd832023-01-11 14:50:10 +0100438
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100439#if defined(MBEDTLS_MD_CAN_SHA384)
Gilles Peskine449bd832023-01-11 14:50:10 +0100440MBEDTLS_CHECK_RETURN_CRITICAL
441static int tls_prf_sha384(const unsigned char *secret, size_t slen,
442 const char *label,
443 const unsigned char *random, size_t rlen,
444 unsigned char *dstbuf, size_t dlen);
445
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100446static int ssl_calc_verify_tls_sha384(const mbedtls_ssl_context *, unsigned char *, size_t *);
447static int ssl_calc_finished_tls_sha384(mbedtls_ssl_context *, unsigned char *, int);
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100448#endif /* MBEDTLS_MD_CAN_SHA384*/
Gilles Peskine449bd832023-01-11 14:50:10 +0100449
Gilles Peskine449bd832023-01-11 14:50:10 +0100450MBEDTLS_CHECK_RETURN_CRITICAL
451static int ssl_tls12_session_load(mbedtls_ssl_session *session,
452 const unsigned char *buf,
453 size_t len);
454#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
455
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100456static int ssl_update_checksum_start(mbedtls_ssl_context *, const unsigned char *, size_t);
Gilles Peskine449bd832023-01-11 14:50:10 +0100457
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100458#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100459static int ssl_update_checksum_sha256(mbedtls_ssl_context *, const unsigned char *, size_t);
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100460#endif /* MBEDTLS_MD_CAN_SHA256*/
Gilles Peskine449bd832023-01-11 14:50:10 +0100461
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100462#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100463static int ssl_update_checksum_sha384(mbedtls_ssl_context *, const unsigned char *, size_t);
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100464#endif /* MBEDTLS_MD_CAN_SHA384*/
Gilles Peskine449bd832023-01-11 14:50:10 +0100465
466int mbedtls_ssl_tls_prf(const mbedtls_tls_prf_types prf,
467 const unsigned char *secret, size_t slen,
468 const char *label,
469 const unsigned char *random, size_t rlen,
470 unsigned char *dstbuf, size_t dlen)
Ron Eldor51d3ab52019-05-12 14:54:30 +0300471{
472 mbedtls_ssl_tls_prf_cb *tls_prf = NULL;
473
Gilles Peskine449bd832023-01-11 14:50:10 +0100474 switch (prf) {
Ron Eldord2f25f72019-05-15 14:54:22 +0300475#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100476#if defined(MBEDTLS_MD_CAN_SHA384)
Ron Eldor51d3ab52019-05-12 14:54:30 +0300477 case MBEDTLS_SSL_TLS_PRF_SHA384:
478 tls_prf = tls_prf_sha384;
Gilles Peskine449bd832023-01-11 14:50:10 +0100479 break;
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100480#endif /* MBEDTLS_MD_CAN_SHA384*/
481#if defined(MBEDTLS_MD_CAN_SHA256)
Ron Eldor51d3ab52019-05-12 14:54:30 +0300482 case MBEDTLS_SSL_TLS_PRF_SHA256:
483 tls_prf = tls_prf_sha256;
Gilles Peskine449bd832023-01-11 14:50:10 +0100484 break;
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100485#endif /* MBEDTLS_MD_CAN_SHA256*/
Ron Eldord2f25f72019-05-15 14:54:22 +0300486#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100487 default:
488 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Ron Eldor51d3ab52019-05-12 14:54:30 +0300489 }
490
Gilles Peskine449bd832023-01-11 14:50:10 +0100491 return tls_prf(secret, slen, label, random, rlen, dstbuf, dlen);
Ron Eldor51d3ab52019-05-12 14:54:30 +0300492}
493
Jerry Yuc73c6182022-02-08 20:29:25 +0800494#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +0100495static void ssl_clear_peer_cert(mbedtls_ssl_session *session)
Jerry Yuc73c6182022-02-08 20:29:25 +0800496{
497#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +0100498 if (session->peer_cert != NULL) {
499 mbedtls_x509_crt_free(session->peer_cert);
500 mbedtls_free(session->peer_cert);
Jerry Yuc73c6182022-02-08 20:29:25 +0800501 session->peer_cert = NULL;
502 }
503#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Gilles Peskine449bd832023-01-11 14:50:10 +0100504 if (session->peer_cert_digest != NULL) {
Jerry Yuc73c6182022-02-08 20:29:25 +0800505 /* Zeroization is not necessary. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100506 mbedtls_free(session->peer_cert_digest);
Jerry Yuc73c6182022-02-08 20:29:25 +0800507 session->peer_cert_digest = NULL;
508 session->peer_cert_digest_type = MBEDTLS_MD_NONE;
509 session->peer_cert_digest_len = 0;
510 }
511#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
512}
513#endif /* MBEDTLS_X509_CRT_PARSE_C */
514
Gilles Peskine449bd832023-01-11 14:50:10 +0100515uint32_t mbedtls_ssl_get_extension_id(unsigned int extension_type)
Jerry Yu7a485c12022-10-31 13:08:18 +0800516{
Gilles Peskine449bd832023-01-11 14:50:10 +0100517 switch (extension_type) {
Jerry Yu7a485c12022-10-31 13:08:18 +0800518 case MBEDTLS_TLS_EXT_SERVERNAME:
Gilles Peskine449bd832023-01-11 14:50:10 +0100519 return MBEDTLS_SSL_EXT_ID_SERVERNAME;
Jerry Yu7a485c12022-10-31 13:08:18 +0800520
521 case MBEDTLS_TLS_EXT_MAX_FRAGMENT_LENGTH:
Gilles Peskine449bd832023-01-11 14:50:10 +0100522 return MBEDTLS_SSL_EXT_ID_MAX_FRAGMENT_LENGTH;
Jerry Yu7a485c12022-10-31 13:08:18 +0800523
524 case MBEDTLS_TLS_EXT_STATUS_REQUEST:
Gilles Peskine449bd832023-01-11 14:50:10 +0100525 return MBEDTLS_SSL_EXT_ID_STATUS_REQUEST;
Jerry Yu7a485c12022-10-31 13:08:18 +0800526
527 case MBEDTLS_TLS_EXT_SUPPORTED_GROUPS:
Gilles Peskine449bd832023-01-11 14:50:10 +0100528 return MBEDTLS_SSL_EXT_ID_SUPPORTED_GROUPS;
Jerry Yu7a485c12022-10-31 13:08:18 +0800529
530 case MBEDTLS_TLS_EXT_SIG_ALG:
Gilles Peskine449bd832023-01-11 14:50:10 +0100531 return MBEDTLS_SSL_EXT_ID_SIG_ALG;
Jerry Yu7a485c12022-10-31 13:08:18 +0800532
533 case MBEDTLS_TLS_EXT_USE_SRTP:
Gilles Peskine449bd832023-01-11 14:50:10 +0100534 return MBEDTLS_SSL_EXT_ID_USE_SRTP;
Jerry Yu7a485c12022-10-31 13:08:18 +0800535
536 case MBEDTLS_TLS_EXT_HEARTBEAT:
Gilles Peskine449bd832023-01-11 14:50:10 +0100537 return MBEDTLS_SSL_EXT_ID_HEARTBEAT;
Jerry Yu7a485c12022-10-31 13:08:18 +0800538
539 case MBEDTLS_TLS_EXT_ALPN:
Gilles Peskine449bd832023-01-11 14:50:10 +0100540 return MBEDTLS_SSL_EXT_ID_ALPN;
Jerry Yu7a485c12022-10-31 13:08:18 +0800541
542 case MBEDTLS_TLS_EXT_SCT:
Gilles Peskine449bd832023-01-11 14:50:10 +0100543 return MBEDTLS_SSL_EXT_ID_SCT;
Jerry Yu7a485c12022-10-31 13:08:18 +0800544
545 case MBEDTLS_TLS_EXT_CLI_CERT_TYPE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100546 return MBEDTLS_SSL_EXT_ID_CLI_CERT_TYPE;
Jerry Yu7a485c12022-10-31 13:08:18 +0800547
548 case MBEDTLS_TLS_EXT_SERV_CERT_TYPE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100549 return MBEDTLS_SSL_EXT_ID_SERV_CERT_TYPE;
Jerry Yu7a485c12022-10-31 13:08:18 +0800550
551 case MBEDTLS_TLS_EXT_PADDING:
Gilles Peskine449bd832023-01-11 14:50:10 +0100552 return MBEDTLS_SSL_EXT_ID_PADDING;
Jerry Yu7a485c12022-10-31 13:08:18 +0800553
554 case MBEDTLS_TLS_EXT_PRE_SHARED_KEY:
Gilles Peskine449bd832023-01-11 14:50:10 +0100555 return MBEDTLS_SSL_EXT_ID_PRE_SHARED_KEY;
Jerry Yu7a485c12022-10-31 13:08:18 +0800556
557 case MBEDTLS_TLS_EXT_EARLY_DATA:
Gilles Peskine449bd832023-01-11 14:50:10 +0100558 return MBEDTLS_SSL_EXT_ID_EARLY_DATA;
Jerry Yu7a485c12022-10-31 13:08:18 +0800559
560 case MBEDTLS_TLS_EXT_SUPPORTED_VERSIONS:
Gilles Peskine449bd832023-01-11 14:50:10 +0100561 return MBEDTLS_SSL_EXT_ID_SUPPORTED_VERSIONS;
Jerry Yu7a485c12022-10-31 13:08:18 +0800562
563 case MBEDTLS_TLS_EXT_COOKIE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100564 return MBEDTLS_SSL_EXT_ID_COOKIE;
Jerry Yu7a485c12022-10-31 13:08:18 +0800565
566 case MBEDTLS_TLS_EXT_PSK_KEY_EXCHANGE_MODES:
Gilles Peskine449bd832023-01-11 14:50:10 +0100567 return MBEDTLS_SSL_EXT_ID_PSK_KEY_EXCHANGE_MODES;
Jerry Yu7a485c12022-10-31 13:08:18 +0800568
569 case MBEDTLS_TLS_EXT_CERT_AUTH:
Gilles Peskine449bd832023-01-11 14:50:10 +0100570 return MBEDTLS_SSL_EXT_ID_CERT_AUTH;
Jerry Yu7a485c12022-10-31 13:08:18 +0800571
572 case MBEDTLS_TLS_EXT_OID_FILTERS:
Gilles Peskine449bd832023-01-11 14:50:10 +0100573 return MBEDTLS_SSL_EXT_ID_OID_FILTERS;
Jerry Yu7a485c12022-10-31 13:08:18 +0800574
575 case MBEDTLS_TLS_EXT_POST_HANDSHAKE_AUTH:
Gilles Peskine449bd832023-01-11 14:50:10 +0100576 return MBEDTLS_SSL_EXT_ID_POST_HANDSHAKE_AUTH;
Jerry Yu7a485c12022-10-31 13:08:18 +0800577
578 case MBEDTLS_TLS_EXT_SIG_ALG_CERT:
Gilles Peskine449bd832023-01-11 14:50:10 +0100579 return MBEDTLS_SSL_EXT_ID_SIG_ALG_CERT;
Jerry Yu7a485c12022-10-31 13:08:18 +0800580
581 case MBEDTLS_TLS_EXT_KEY_SHARE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100582 return MBEDTLS_SSL_EXT_ID_KEY_SHARE;
Jerry Yu7a485c12022-10-31 13:08:18 +0800583
584 case MBEDTLS_TLS_EXT_TRUNCATED_HMAC:
Gilles Peskine449bd832023-01-11 14:50:10 +0100585 return MBEDTLS_SSL_EXT_ID_TRUNCATED_HMAC;
Jerry Yu7a485c12022-10-31 13:08:18 +0800586
587 case MBEDTLS_TLS_EXT_SUPPORTED_POINT_FORMATS:
Gilles Peskine449bd832023-01-11 14:50:10 +0100588 return MBEDTLS_SSL_EXT_ID_SUPPORTED_POINT_FORMATS;
Jerry Yu7a485c12022-10-31 13:08:18 +0800589
590 case MBEDTLS_TLS_EXT_ENCRYPT_THEN_MAC:
Gilles Peskine449bd832023-01-11 14:50:10 +0100591 return MBEDTLS_SSL_EXT_ID_ENCRYPT_THEN_MAC;
Jerry Yu7a485c12022-10-31 13:08:18 +0800592
593 case MBEDTLS_TLS_EXT_EXTENDED_MASTER_SECRET:
Gilles Peskine449bd832023-01-11 14:50:10 +0100594 return MBEDTLS_SSL_EXT_ID_EXTENDED_MASTER_SECRET;
Jerry Yu7a485c12022-10-31 13:08:18 +0800595
Jan Bruckner151f6422023-02-10 12:45:19 +0100596 case MBEDTLS_TLS_EXT_RECORD_SIZE_LIMIT:
597 return MBEDTLS_SSL_EXT_ID_RECORD_SIZE_LIMIT;
598
Jerry Yu7a485c12022-10-31 13:08:18 +0800599 case MBEDTLS_TLS_EXT_SESSION_TICKET:
Gilles Peskine449bd832023-01-11 14:50:10 +0100600 return MBEDTLS_SSL_EXT_ID_SESSION_TICKET;
Jerry Yu7a485c12022-10-31 13:08:18 +0800601
602 }
603
Gilles Peskine449bd832023-01-11 14:50:10 +0100604 return MBEDTLS_SSL_EXT_ID_UNRECOGNIZED;
Jerry Yu7a485c12022-10-31 13:08:18 +0800605}
606
Gilles Peskine449bd832023-01-11 14:50:10 +0100607uint32_t mbedtls_ssl_get_extension_mask(unsigned int extension_type)
Jerry Yu7a485c12022-10-31 13:08:18 +0800608{
Gilles Peskine449bd832023-01-11 14:50:10 +0100609 return 1 << mbedtls_ssl_get_extension_id(extension_type);
Jerry Yu7a485c12022-10-31 13:08:18 +0800610}
611
Jerry Yud25cab02022-10-31 12:48:30 +0800612#if defined(MBEDTLS_DEBUG_C)
613static const char *extension_name_table[] = {
Jerry Yuea52ed92022-11-08 21:01:17 +0800614 [MBEDTLS_SSL_EXT_ID_UNRECOGNIZED] = "unrecognized",
Jerry Yud25cab02022-10-31 12:48:30 +0800615 [MBEDTLS_SSL_EXT_ID_SERVERNAME] = "server_name",
616 [MBEDTLS_SSL_EXT_ID_MAX_FRAGMENT_LENGTH] = "max_fragment_length",
617 [MBEDTLS_SSL_EXT_ID_STATUS_REQUEST] = "status_request",
618 [MBEDTLS_SSL_EXT_ID_SUPPORTED_GROUPS] = "supported_groups",
619 [MBEDTLS_SSL_EXT_ID_SIG_ALG] = "signature_algorithms",
620 [MBEDTLS_SSL_EXT_ID_USE_SRTP] = "use_srtp",
621 [MBEDTLS_SSL_EXT_ID_HEARTBEAT] = "heartbeat",
622 [MBEDTLS_SSL_EXT_ID_ALPN] = "application_layer_protocol_negotiation",
623 [MBEDTLS_SSL_EXT_ID_SCT] = "signed_certificate_timestamp",
624 [MBEDTLS_SSL_EXT_ID_CLI_CERT_TYPE] = "client_certificate_type",
625 [MBEDTLS_SSL_EXT_ID_SERV_CERT_TYPE] = "server_certificate_type",
626 [MBEDTLS_SSL_EXT_ID_PADDING] = "padding",
627 [MBEDTLS_SSL_EXT_ID_PRE_SHARED_KEY] = "pre_shared_key",
628 [MBEDTLS_SSL_EXT_ID_EARLY_DATA] = "early_data",
629 [MBEDTLS_SSL_EXT_ID_SUPPORTED_VERSIONS] = "supported_versions",
630 [MBEDTLS_SSL_EXT_ID_COOKIE] = "cookie",
631 [MBEDTLS_SSL_EXT_ID_PSK_KEY_EXCHANGE_MODES] = "psk_key_exchange_modes",
632 [MBEDTLS_SSL_EXT_ID_CERT_AUTH] = "certificate_authorities",
633 [MBEDTLS_SSL_EXT_ID_OID_FILTERS] = "oid_filters",
634 [MBEDTLS_SSL_EXT_ID_POST_HANDSHAKE_AUTH] = "post_handshake_auth",
635 [MBEDTLS_SSL_EXT_ID_SIG_ALG_CERT] = "signature_algorithms_cert",
636 [MBEDTLS_SSL_EXT_ID_KEY_SHARE] = "key_share",
637 [MBEDTLS_SSL_EXT_ID_TRUNCATED_HMAC] = "truncated_hmac",
638 [MBEDTLS_SSL_EXT_ID_SUPPORTED_POINT_FORMATS] = "supported_point_formats",
639 [MBEDTLS_SSL_EXT_ID_ENCRYPT_THEN_MAC] = "encrypt_then_mac",
640 [MBEDTLS_SSL_EXT_ID_EXTENDED_MASTER_SECRET] = "extended_master_secret",
Jan Bruckner151f6422023-02-10 12:45:19 +0100641 [MBEDTLS_SSL_EXT_ID_SESSION_TICKET] = "session_ticket",
642 [MBEDTLS_SSL_EXT_ID_RECORD_SIZE_LIMIT] = "record_size_limit"
Jerry Yud25cab02022-10-31 12:48:30 +0800643};
644
Chien Wong4e9683e2023-12-28 17:07:43 +0800645static const unsigned int extension_type_table[] = {
Jerry Yud25cab02022-10-31 12:48:30 +0800646 [MBEDTLS_SSL_EXT_ID_UNRECOGNIZED] = 0xff,
647 [MBEDTLS_SSL_EXT_ID_SERVERNAME] = MBEDTLS_TLS_EXT_SERVERNAME,
648 [MBEDTLS_SSL_EXT_ID_MAX_FRAGMENT_LENGTH] = MBEDTLS_TLS_EXT_MAX_FRAGMENT_LENGTH,
649 [MBEDTLS_SSL_EXT_ID_STATUS_REQUEST] = MBEDTLS_TLS_EXT_STATUS_REQUEST,
650 [MBEDTLS_SSL_EXT_ID_SUPPORTED_GROUPS] = MBEDTLS_TLS_EXT_SUPPORTED_GROUPS,
651 [MBEDTLS_SSL_EXT_ID_SIG_ALG] = MBEDTLS_TLS_EXT_SIG_ALG,
652 [MBEDTLS_SSL_EXT_ID_USE_SRTP] = MBEDTLS_TLS_EXT_USE_SRTP,
653 [MBEDTLS_SSL_EXT_ID_HEARTBEAT] = MBEDTLS_TLS_EXT_HEARTBEAT,
654 [MBEDTLS_SSL_EXT_ID_ALPN] = MBEDTLS_TLS_EXT_ALPN,
655 [MBEDTLS_SSL_EXT_ID_SCT] = MBEDTLS_TLS_EXT_SCT,
656 [MBEDTLS_SSL_EXT_ID_CLI_CERT_TYPE] = MBEDTLS_TLS_EXT_CLI_CERT_TYPE,
657 [MBEDTLS_SSL_EXT_ID_SERV_CERT_TYPE] = MBEDTLS_TLS_EXT_SERV_CERT_TYPE,
658 [MBEDTLS_SSL_EXT_ID_PADDING] = MBEDTLS_TLS_EXT_PADDING,
659 [MBEDTLS_SSL_EXT_ID_PRE_SHARED_KEY] = MBEDTLS_TLS_EXT_PRE_SHARED_KEY,
660 [MBEDTLS_SSL_EXT_ID_EARLY_DATA] = MBEDTLS_TLS_EXT_EARLY_DATA,
661 [MBEDTLS_SSL_EXT_ID_SUPPORTED_VERSIONS] = MBEDTLS_TLS_EXT_SUPPORTED_VERSIONS,
662 [MBEDTLS_SSL_EXT_ID_COOKIE] = MBEDTLS_TLS_EXT_COOKIE,
663 [MBEDTLS_SSL_EXT_ID_PSK_KEY_EXCHANGE_MODES] = MBEDTLS_TLS_EXT_PSK_KEY_EXCHANGE_MODES,
664 [MBEDTLS_SSL_EXT_ID_CERT_AUTH] = MBEDTLS_TLS_EXT_CERT_AUTH,
665 [MBEDTLS_SSL_EXT_ID_OID_FILTERS] = MBEDTLS_TLS_EXT_OID_FILTERS,
666 [MBEDTLS_SSL_EXT_ID_POST_HANDSHAKE_AUTH] = MBEDTLS_TLS_EXT_POST_HANDSHAKE_AUTH,
667 [MBEDTLS_SSL_EXT_ID_SIG_ALG_CERT] = MBEDTLS_TLS_EXT_SIG_ALG_CERT,
668 [MBEDTLS_SSL_EXT_ID_KEY_SHARE] = MBEDTLS_TLS_EXT_KEY_SHARE,
669 [MBEDTLS_SSL_EXT_ID_TRUNCATED_HMAC] = MBEDTLS_TLS_EXT_TRUNCATED_HMAC,
670 [MBEDTLS_SSL_EXT_ID_SUPPORTED_POINT_FORMATS] = MBEDTLS_TLS_EXT_SUPPORTED_POINT_FORMATS,
671 [MBEDTLS_SSL_EXT_ID_ENCRYPT_THEN_MAC] = MBEDTLS_TLS_EXT_ENCRYPT_THEN_MAC,
672 [MBEDTLS_SSL_EXT_ID_EXTENDED_MASTER_SECRET] = MBEDTLS_TLS_EXT_EXTENDED_MASTER_SECRET,
Jan Bruckner151f6422023-02-10 12:45:19 +0100673 [MBEDTLS_SSL_EXT_ID_SESSION_TICKET] = MBEDTLS_TLS_EXT_SESSION_TICKET,
674 [MBEDTLS_SSL_EXT_ID_RECORD_SIZE_LIMIT] = MBEDTLS_TLS_EXT_RECORD_SIZE_LIMIT
Jerry Yud25cab02022-10-31 12:48:30 +0800675};
676
Gilles Peskine449bd832023-01-11 14:50:10 +0100677const char *mbedtls_ssl_get_extension_name(unsigned int extension_type)
Jerry Yud25cab02022-10-31 12:48:30 +0800678{
Gilles Peskine449bd832023-01-11 14:50:10 +0100679 return extension_name_table[
680 mbedtls_ssl_get_extension_id(extension_type)];
Jerry Yud25cab02022-10-31 12:48:30 +0800681}
682
Gilles Peskine449bd832023-01-11 14:50:10 +0100683static const char *ssl_tls13_get_hs_msg_name(int hs_msg_type)
Jerry Yud25cab02022-10-31 12:48:30 +0800684{
Gilles Peskine449bd832023-01-11 14:50:10 +0100685 switch (hs_msg_type) {
Jerry Yud25cab02022-10-31 12:48:30 +0800686 case MBEDTLS_SSL_HS_CLIENT_HELLO:
Gilles Peskine449bd832023-01-11 14:50:10 +0100687 return "ClientHello";
Jerry Yud25cab02022-10-31 12:48:30 +0800688 case MBEDTLS_SSL_HS_SERVER_HELLO:
Gilles Peskine449bd832023-01-11 14:50:10 +0100689 return "ServerHello";
Jerry Yud25cab02022-10-31 12:48:30 +0800690 case MBEDTLS_SSL_TLS1_3_HS_HELLO_RETRY_REQUEST:
Gilles Peskine449bd832023-01-11 14:50:10 +0100691 return "HelloRetryRequest";
Jerry Yud25cab02022-10-31 12:48:30 +0800692 case MBEDTLS_SSL_HS_NEW_SESSION_TICKET:
Gilles Peskine449bd832023-01-11 14:50:10 +0100693 return "NewSessionTicket";
Jerry Yud25cab02022-10-31 12:48:30 +0800694 case MBEDTLS_SSL_HS_ENCRYPTED_EXTENSIONS:
Gilles Peskine449bd832023-01-11 14:50:10 +0100695 return "EncryptedExtensions";
Jerry Yud25cab02022-10-31 12:48:30 +0800696 case MBEDTLS_SSL_HS_CERTIFICATE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100697 return "Certificate";
Jerry Yud25cab02022-10-31 12:48:30 +0800698 case MBEDTLS_SSL_HS_CERTIFICATE_REQUEST:
Gilles Peskine449bd832023-01-11 14:50:10 +0100699 return "CertificateRequest";
Jerry Yud25cab02022-10-31 12:48:30 +0800700 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100701 return "Unknown";
Jerry Yud25cab02022-10-31 12:48:30 +0800702}
703
Gilles Peskine449bd832023-01-11 14:50:10 +0100704void mbedtls_ssl_print_extension(const mbedtls_ssl_context *ssl,
705 int level, const char *file, int line,
706 int hs_msg_type, unsigned int extension_type,
707 const char *extra_msg0, const char *extra_msg1)
Jerry Yud25cab02022-10-31 12:48:30 +0800708{
709 const char *extra_msg;
Gilles Peskine449bd832023-01-11 14:50:10 +0100710 if (extra_msg0 && extra_msg1) {
Jerry Yud25cab02022-10-31 12:48:30 +0800711 mbedtls_debug_print_msg(
712 ssl, level, file, line,
713 "%s: %s(%u) extension %s %s.",
Gilles Peskine449bd832023-01-11 14:50:10 +0100714 ssl_tls13_get_hs_msg_name(hs_msg_type),
715 mbedtls_ssl_get_extension_name(extension_type),
Jerry Yud25cab02022-10-31 12:48:30 +0800716 extension_type,
Gilles Peskine449bd832023-01-11 14:50:10 +0100717 extra_msg0, extra_msg1);
Jerry Yud25cab02022-10-31 12:48:30 +0800718 return;
719 }
720
721 extra_msg = extra_msg0 ? extra_msg0 : extra_msg1;
Gilles Peskine449bd832023-01-11 14:50:10 +0100722 if (extra_msg) {
Jerry Yud25cab02022-10-31 12:48:30 +0800723 mbedtls_debug_print_msg(
724 ssl, level, file, line,
Gilles Peskine449bd832023-01-11 14:50:10 +0100725 "%s: %s(%u) extension %s.", ssl_tls13_get_hs_msg_name(hs_msg_type),
726 mbedtls_ssl_get_extension_name(extension_type), extension_type,
727 extra_msg);
Jerry Yud25cab02022-10-31 12:48:30 +0800728 return;
729 }
730
731 mbedtls_debug_print_msg(
732 ssl, level, file, line,
Gilles Peskine449bd832023-01-11 14:50:10 +0100733 "%s: %s(%u) extension.", ssl_tls13_get_hs_msg_name(hs_msg_type),
734 mbedtls_ssl_get_extension_name(extension_type), extension_type);
Jerry Yud25cab02022-10-31 12:48:30 +0800735}
736
Gilles Peskine449bd832023-01-11 14:50:10 +0100737void mbedtls_ssl_print_extensions(const mbedtls_ssl_context *ssl,
738 int level, const char *file, int line,
739 int hs_msg_type, uint32_t extensions_mask,
740 const char *extra)
Jerry Yud25cab02022-10-31 12:48:30 +0800741{
742
Gilles Peskine449bd832023-01-11 14:50:10 +0100743 for (unsigned i = 0;
744 i < sizeof(extension_name_table) / sizeof(extension_name_table[0]);
745 i++) {
Jerry Yu79aa7212022-11-08 21:30:21 +0800746 mbedtls_ssl_print_extension(
Jerry Yuea52ed92022-11-08 21:01:17 +0800747 ssl, level, file, line, hs_msg_type, extension_type_table[i],
Gilles Peskine449bd832023-01-11 14:50:10 +0100748 extensions_mask & (1 << i) ? "exists" : "does not exist", extra);
Jerry Yud25cab02022-10-31 12:48:30 +0800749 }
750}
751
Pengyu Lvee455c02023-01-12 14:37:24 +0800752#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Pengyu Lvee455c02023-01-12 14:37:24 +0800753static const char *ticket_flag_name_table[] =
754{
755 [0] = "ALLOW_PSK_RESUMPTION",
756 [2] = "ALLOW_PSK_EPHEMERAL_RESUMPTION",
757 [3] = "ALLOW_EARLY_DATA",
758};
759
Pengyu Lv4938a562023-01-16 11:28:49 +0800760void mbedtls_ssl_print_ticket_flags(const mbedtls_ssl_context *ssl,
761 int level, const char *file, int line,
762 unsigned int flags)
Pengyu Lvee455c02023-01-12 14:37:24 +0800763{
764 size_t i;
765
766 mbedtls_debug_print_msg(ssl, level, file, line,
Pengyu Lv4938a562023-01-16 11:28:49 +0800767 "print ticket_flags (0x%02x)", flags);
768
769 flags = flags & MBEDTLS_SSL_TLS1_3_TICKET_FLAGS_MASK;
Pengyu Lvee455c02023-01-12 14:37:24 +0800770
771 for (i = 0; i < ARRAY_LENGTH(ticket_flag_name_table); i++) {
Pengyu Lv4938a562023-01-16 11:28:49 +0800772 if ((flags & (1 << i))) {
Pengyu Lvee455c02023-01-12 14:37:24 +0800773 mbedtls_debug_print_msg(ssl, level, file, line, "- %s is set.",
774 ticket_flag_name_table[i]);
775 }
776 }
777}
778#endif /* MBEDTLS_SSL_PROTO_TLS1_3 && MBEDTLS_SSL_SESSION_TICKETS */
779
Jerry Yud25cab02022-10-31 12:48:30 +0800780#endif /* MBEDTLS_DEBUG_C */
781
Gilles Peskine449bd832023-01-11 14:50:10 +0100782void mbedtls_ssl_optimize_checksum(mbedtls_ssl_context *ssl,
783 const mbedtls_ssl_ciphersuite_t *ciphersuite_info)
Jerry Yuc73c6182022-02-08 20:29:25 +0800784{
785 ((void) ciphersuite_info);
786
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100787#if defined(MBEDTLS_MD_CAN_SHA384)
Gilles Peskine449bd832023-01-11 14:50:10 +0100788 if (ciphersuite_info->mac == MBEDTLS_MD_SHA384) {
Jerry Yuc73c6182022-02-08 20:29:25 +0800789 ssl->handshake->update_checksum = ssl_update_checksum_sha384;
Gilles Peskine449bd832023-01-11 14:50:10 +0100790 } else
Jerry Yuc73c6182022-02-08 20:29:25 +0800791#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100792#if defined(MBEDTLS_MD_CAN_SHA256)
Gilles Peskine449bd832023-01-11 14:50:10 +0100793 if (ciphersuite_info->mac != MBEDTLS_MD_SHA384) {
Jerry Yuc73c6182022-02-08 20:29:25 +0800794 ssl->handshake->update_checksum = ssl_update_checksum_sha256;
Gilles Peskine449bd832023-01-11 14:50:10 +0100795 } else
Jerry Yuc73c6182022-02-08 20:29:25 +0800796#endif
797 {
Gilles Peskine449bd832023-01-11 14:50:10 +0100798 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
Jerry Yuc73c6182022-02-08 20:29:25 +0800799 return;
800 }
801}
802
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100803int mbedtls_ssl_add_hs_hdr_to_checksum(mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100804 unsigned hs_type,
805 size_t total_hs_len)
Ronald Cron8f6d39a2022-03-10 18:56:50 +0100806{
807 unsigned char hs_hdr[4];
808
809 /* Build HS header for checksum update. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100810 hs_hdr[0] = MBEDTLS_BYTE_0(hs_type);
811 hs_hdr[1] = MBEDTLS_BYTE_2(total_hs_len);
812 hs_hdr[2] = MBEDTLS_BYTE_1(total_hs_len);
813 hs_hdr[3] = MBEDTLS_BYTE_0(total_hs_len);
Ronald Cron8f6d39a2022-03-10 18:56:50 +0100814
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100815 return ssl->handshake->update_checksum(ssl, hs_hdr, sizeof(hs_hdr));
Ronald Cron8f6d39a2022-03-10 18:56:50 +0100816}
817
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100818int mbedtls_ssl_add_hs_msg_to_checksum(mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100819 unsigned hs_type,
820 unsigned char const *msg,
821 size_t msg_len)
Ronald Cron8f6d39a2022-03-10 18:56:50 +0100822{
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100823 int ret;
824 ret = mbedtls_ssl_add_hs_hdr_to_checksum(ssl, hs_type, msg_len);
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100825 if (ret != 0) {
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100826 return ret;
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100827 }
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100828 return ssl->handshake->update_checksum(ssl, msg, msg_len);
Ronald Cron8f6d39a2022-03-10 18:56:50 +0100829}
830
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100831int mbedtls_ssl_reset_checksum(mbedtls_ssl_context *ssl)
Jerry Yuc73c6182022-02-08 20:29:25 +0800832{
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100833#if defined(MBEDTLS_MD_CAN_SHA256) || \
834 defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100835#if defined(MBEDTLS_USE_PSA_CRYPTO)
836 psa_status_t status;
837#else
838 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
839#endif
Manuel Pégourié-Gonnard626aaed2023-02-06 22:03:06 +0100840#else /* SHA-256 or SHA-384 */
Jerry Yuc73c6182022-02-08 20:29:25 +0800841 ((void) ssl);
Manuel Pégourié-Gonnard626aaed2023-02-06 22:03:06 +0100842#endif /* SHA-256 or SHA-384 */
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100843#if defined(MBEDTLS_MD_CAN_SHA256)
Jerry Yuc73c6182022-02-08 20:29:25 +0800844#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100845 status = psa_hash_abort(&ssl->handshake->fin_sha256_psa);
846 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200847 return mbedtls_md_error_from_psa(status);
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100848 }
849 status = psa_hash_setup(&ssl->handshake->fin_sha256_psa, PSA_ALG_SHA_256);
850 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200851 return mbedtls_md_error_from_psa(status);
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100852 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800853#else
Manuel Pégourié-Gonnard947cee12023-03-06 11:59:59 +0100854 mbedtls_md_free(&ssl->handshake->fin_sha256);
855 mbedtls_md_init(&ssl->handshake->fin_sha256);
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +0100856 ret = mbedtls_md_setup(&ssl->handshake->fin_sha256,
857 mbedtls_md_info_from_type(MBEDTLS_MD_SHA256),
858 0);
859 if (ret != 0) {
860 return ret;
861 }
862 ret = mbedtls_md_starts(&ssl->handshake->fin_sha256);
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100863 if (ret != 0) {
864 return ret;
865 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800866#endif
867#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100868#if defined(MBEDTLS_MD_CAN_SHA384)
Jerry Yuc73c6182022-02-08 20:29:25 +0800869#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100870 status = psa_hash_abort(&ssl->handshake->fin_sha384_psa);
871 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200872 return mbedtls_md_error_from_psa(status);
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100873 }
874 status = psa_hash_setup(&ssl->handshake->fin_sha384_psa, PSA_ALG_SHA_384);
875 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200876 return mbedtls_md_error_from_psa(status);
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100877 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800878#else
Manuel Pégourié-Gonnard947cee12023-03-06 11:59:59 +0100879 mbedtls_md_free(&ssl->handshake->fin_sha384);
880 mbedtls_md_init(&ssl->handshake->fin_sha384);
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +0100881 ret = mbedtls_md_setup(&ssl->handshake->fin_sha384,
882 mbedtls_md_info_from_type(MBEDTLS_MD_SHA384), 0);
883 if (ret != 0) {
884 return ret;
885 }
886 ret = mbedtls_md_starts(&ssl->handshake->fin_sha384);
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100887 if (ret != 0) {
888 return ret;
889 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800890#endif
891#endif
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100892 return 0;
Jerry Yuc73c6182022-02-08 20:29:25 +0800893}
894
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100895static int ssl_update_checksum_start(mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100896 const unsigned char *buf, size_t len)
Jerry Yuc73c6182022-02-08 20:29:25 +0800897{
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100898#if defined(MBEDTLS_MD_CAN_SHA256) || \
899 defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnarddf949012023-02-06 10:00:52 +0100900#if defined(MBEDTLS_USE_PSA_CRYPTO)
901 psa_status_t status;
902#else
903 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
904#endif
Manuel Pégourié-Gonnard626aaed2023-02-06 22:03:06 +0100905#else /* SHA-256 or SHA-384 */
906 ((void) ssl);
907 (void) buf;
908 (void) len;
909#endif /* SHA-256 or SHA-384 */
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100910#if defined(MBEDTLS_MD_CAN_SHA256)
Jerry Yuc73c6182022-02-08 20:29:25 +0800911#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnarddf949012023-02-06 10:00:52 +0100912 status = psa_hash_update(&ssl->handshake->fin_sha256_psa, buf, len);
913 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200914 return mbedtls_md_error_from_psa(status);
Manuel Pégourié-Gonnarddf949012023-02-06 10:00:52 +0100915 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800916#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +0100917 ret = mbedtls_md_update(&ssl->handshake->fin_sha256, buf, len);
Manuel Pégourié-Gonnarddf949012023-02-06 10:00:52 +0100918 if (ret != 0) {
919 return ret;
920 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800921#endif
922#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100923#if defined(MBEDTLS_MD_CAN_SHA384)
Jerry Yuc73c6182022-02-08 20:29:25 +0800924#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnarddf949012023-02-06 10:00:52 +0100925 status = psa_hash_update(&ssl->handshake->fin_sha384_psa, buf, len);
926 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200927 return mbedtls_md_error_from_psa(status);
Manuel Pégourié-Gonnarddf949012023-02-06 10:00:52 +0100928 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800929#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +0100930 ret = mbedtls_md_update(&ssl->handshake->fin_sha384, buf, len);
Manuel Pégourié-Gonnarddf949012023-02-06 10:00:52 +0100931 if (ret != 0) {
932 return ret;
933 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800934#endif
935#endif
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100936 return 0;
Jerry Yuc73c6182022-02-08 20:29:25 +0800937}
938
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100939#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100940static int ssl_update_checksum_sha256(mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100941 const unsigned char *buf, size_t len)
Jerry Yuc73c6182022-02-08 20:29:25 +0800942{
943#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200944 return mbedtls_md_error_from_psa(psa_hash_update(
945 &ssl->handshake->fin_sha256_psa, buf, len));
Jerry Yuc73c6182022-02-08 20:29:25 +0800946#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +0100947 return mbedtls_md_update(&ssl->handshake->fin_sha256, buf, len);
Jerry Yuc73c6182022-02-08 20:29:25 +0800948#endif
949}
950#endif
951
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100952#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100953static int ssl_update_checksum_sha384(mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100954 const unsigned char *buf, size_t len)
Jerry Yuc73c6182022-02-08 20:29:25 +0800955{
956#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200957 return mbedtls_md_error_from_psa(psa_hash_update(
958 &ssl->handshake->fin_sha384_psa, buf, len));
Jerry Yuc73c6182022-02-08 20:29:25 +0800959#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +0100960 return mbedtls_md_update(&ssl->handshake->fin_sha384, buf, len);
Jerry Yuc73c6182022-02-08 20:29:25 +0800961#endif
962}
963#endif
964
Gilles Peskine449bd832023-01-11 14:50:10 +0100965static void ssl_handshake_params_init(mbedtls_ssl_handshake_params *handshake)
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200966{
Gilles Peskine449bd832023-01-11 14:50:10 +0100967 memset(handshake, 0, sizeof(mbedtls_ssl_handshake_params));
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200968
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100969#if defined(MBEDTLS_MD_CAN_SHA256)
Andrzej Kurekeb342242019-01-29 09:14:33 -0500970#if defined(MBEDTLS_USE_PSA_CRYPTO)
971 handshake->fin_sha256_psa = psa_hash_operation_init();
Andrzej Kurekeb342242019-01-29 09:14:33 -0500972#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +0100973 mbedtls_md_init(&handshake->fin_sha256);
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200974#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -0500975#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100976#if defined(MBEDTLS_MD_CAN_SHA384)
Andrzej Kurekeb342242019-01-29 09:14:33 -0500977#if defined(MBEDTLS_USE_PSA_CRYPTO)
Andrzej Kurek972fba52019-01-30 03:29:12 -0500978 handshake->fin_sha384_psa = psa_hash_operation_init();
Andrzej Kurekeb342242019-01-29 09:14:33 -0500979#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +0100980 mbedtls_md_init(&handshake->fin_sha384);
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200981#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -0500982#endif
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200983
984 handshake->update_checksum = ssl_update_checksum_start;
Hanno Becker7e5437a2017-04-28 17:15:26 +0100985
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200986#if defined(MBEDTLS_DHM_C)
Gilles Peskine449bd832023-01-11 14:50:10 +0100987 mbedtls_dhm_init(&handshake->dhm_ctx);
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200988#endif
Valerio Setti7aeec542023-07-05 18:57:21 +0200989#if !defined(MBEDTLS_USE_PSA_CRYPTO) && \
Valerio Setti6eb00542023-07-07 17:04:24 +0200990 defined(MBEDTLS_KEY_EXCHANGE_SOME_ECDH_OR_ECDHE_1_2_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +0100991 mbedtls_ecdh_init(&handshake->ecdh_ctx);
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200992#endif
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +0200993#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Neil Armstrongca7d5062022-05-31 14:43:23 +0200994#if defined(MBEDTLS_USE_PSA_CRYPTO)
995 handshake->psa_pake_ctx = psa_pake_operation_init();
996 handshake->psa_pake_password = MBEDTLS_SVC_KEY_ID_INIT;
997#else
Gilles Peskine449bd832023-01-11 14:50:10 +0100998 mbedtls_ecjpake_init(&handshake->ecjpake_ctx);
Neil Armstrongca7d5062022-05-31 14:43:23 +0200999#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard77c06462015-09-17 13:59:49 +02001000#if defined(MBEDTLS_SSL_CLI_C)
1001 handshake->ecjpake_cache = NULL;
1002 handshake->ecjpake_cache_len = 0;
1003#endif
Manuel Pégourié-Gonnard76cfd3f2015-09-15 12:10:54 +02001004#endif
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +02001005
Gilles Peskineeccd8882020-03-10 12:19:08 +01001006#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01001007 mbedtls_x509_crt_restart_init(&handshake->ecrs_ctx);
Manuel Pégourié-Gonnard862cde52017-05-17 11:56:15 +02001008#endif
1009
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +02001010#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
1011 handshake->sni_authmode = MBEDTLS_SSL_VERIFY_UNSET;
1012#endif
Hanno Becker75173122019-02-06 16:18:31 +00001013
1014#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
1015 !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01001016 mbedtls_pk_init(&handshake->peer_pubkey);
Hanno Becker75173122019-02-06 16:18:31 +00001017#endif
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001018}
1019
Gilles Peskine449bd832023-01-11 14:50:10 +01001020void mbedtls_ssl_transform_init(mbedtls_ssl_transform *transform)
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001021{
Gilles Peskine449bd832023-01-11 14:50:10 +01001022 memset(transform, 0, sizeof(mbedtls_ssl_transform));
Paul Bakker84bbeb52014-07-01 14:53:22 +02001023
Przemyslaw Stekiel8f80fb92022-01-11 08:28:13 +01001024#if defined(MBEDTLS_USE_PSA_CRYPTO)
1025 transform->psa_key_enc = MBEDTLS_SVC_KEY_ID_INIT;
1026 transform->psa_key_dec = MBEDTLS_SVC_KEY_ID_INIT;
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01001027#else
Gilles Peskine449bd832023-01-11 14:50:10 +01001028 mbedtls_cipher_init(&transform->cipher_ctx_enc);
1029 mbedtls_cipher_init(&transform->cipher_ctx_dec);
Przemyslaw Stekiel8f80fb92022-01-11 08:28:13 +01001030#endif
1031
Hanno Beckerfd86ca82020-11-30 08:54:23 +00001032#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Neil Armstrong39b8e7d2022-02-23 09:24:45 +01001033#if defined(MBEDTLS_USE_PSA_CRYPTO)
1034 transform->psa_mac_enc = MBEDTLS_SVC_KEY_ID_INIT;
1035 transform->psa_mac_dec = MBEDTLS_SVC_KEY_ID_INIT;
Neil Armstrongcf8841a2022-02-24 11:17:45 +01001036#else
Gilles Peskine449bd832023-01-11 14:50:10 +01001037 mbedtls_md_init(&transform->md_ctx_enc);
1038 mbedtls_md_init(&transform->md_ctx_dec);
Hanno Beckerd56ed242018-01-03 15:32:51 +00001039#endif
Neil Armstrongcf8841a2022-02-24 11:17:45 +01001040#endif
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001041}
1042
Gilles Peskine449bd832023-01-11 14:50:10 +01001043void mbedtls_ssl_session_init(mbedtls_ssl_session *session)
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001044{
Gilles Peskine449bd832023-01-11 14:50:10 +01001045 memset(session, 0, sizeof(mbedtls_ssl_session));
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001046}
1047
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001048MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001049static int ssl_handshake_init(mbedtls_ssl_context *ssl)
Paul Bakker48916f92012-09-16 19:57:18 +00001050{
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01001051 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1052
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001053 /* Clear old handshake information if present */
Jerry Yu2e199812022-12-01 18:57:19 +08001054#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01001055 if (ssl->transform_negotiate) {
1056 mbedtls_ssl_transform_free(ssl->transform_negotiate);
1057 }
Jerry Yu2e199812022-12-01 18:57:19 +08001058#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001059 if (ssl->session_negotiate) {
1060 mbedtls_ssl_session_free(ssl->session_negotiate);
1061 }
1062 if (ssl->handshake) {
1063 mbedtls_ssl_handshake_free(ssl);
1064 }
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001065
Jerry Yu2e199812022-12-01 18:57:19 +08001066#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001067 /*
1068 * Either the pointers are now NULL or cleared properly and can be freed.
1069 * Now allocate missing structures.
1070 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001071 if (ssl->transform_negotiate == NULL) {
1072 ssl->transform_negotiate = mbedtls_calloc(1, sizeof(mbedtls_ssl_transform));
Paul Bakkerb9cfaa02013-10-11 18:58:55 +02001073 }
Jerry Yu2e199812022-12-01 18:57:19 +08001074#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Paul Bakker48916f92012-09-16 19:57:18 +00001075
Gilles Peskine449bd832023-01-11 14:50:10 +01001076 if (ssl->session_negotiate == NULL) {
1077 ssl->session_negotiate = mbedtls_calloc(1, sizeof(mbedtls_ssl_session));
Paul Bakkerb9cfaa02013-10-11 18:58:55 +02001078 }
Paul Bakker48916f92012-09-16 19:57:18 +00001079
Gilles Peskine449bd832023-01-11 14:50:10 +01001080 if (ssl->handshake == NULL) {
1081 ssl->handshake = mbedtls_calloc(1, sizeof(mbedtls_ssl_handshake_params));
Paul Bakkerb9cfaa02013-10-11 18:58:55 +02001082 }
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05001083#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1084 /* If the buffers are too small - reallocate */
Andrzej Kurek8ea68722020-04-03 06:40:47 -04001085
Gilles Peskine449bd832023-01-11 14:50:10 +01001086 handle_buffer_resizing(ssl, 0, MBEDTLS_SSL_IN_BUFFER_LEN,
1087 MBEDTLS_SSL_OUT_BUFFER_LEN);
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05001088#endif
Paul Bakker48916f92012-09-16 19:57:18 +00001089
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001090 /* All pointers should exist and can be directly freed without issue */
Gilles Peskine449bd832023-01-11 14:50:10 +01001091 if (ssl->handshake == NULL ||
Jerry Yu2e199812022-12-01 18:57:19 +08001092#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Paul Bakker48916f92012-09-16 19:57:18 +00001093 ssl->transform_negotiate == NULL ||
Jerry Yu2e199812022-12-01 18:57:19 +08001094#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001095 ssl->session_negotiate == NULL) {
1096 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc() of ssl sub-contexts failed"));
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001097
Gilles Peskine449bd832023-01-11 14:50:10 +01001098 mbedtls_free(ssl->handshake);
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001099 ssl->handshake = NULL;
Jerry Yu2e199812022-12-01 18:57:19 +08001100
1101#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01001102 mbedtls_free(ssl->transform_negotiate);
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001103 ssl->transform_negotiate = NULL;
Jerry Yu2e199812022-12-01 18:57:19 +08001104#endif
1105
Gilles Peskine449bd832023-01-11 14:50:10 +01001106 mbedtls_free(ssl->session_negotiate);
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001107 ssl->session_negotiate = NULL;
1108
Gilles Peskine449bd832023-01-11 14:50:10 +01001109 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
Paul Bakker48916f92012-09-16 19:57:18 +00001110 }
1111
Jerry Yu4caf3ca2023-11-15 16:13:47 +08001112#if defined(MBEDTLS_SSL_EARLY_DATA)
1113#if defined(MBEDTLS_SSL_CLI_C)
Ronald Cron05d7cfb2024-03-03 15:39:30 +01001114 ssl->early_data_state = MBEDTLS_SSL_EARLY_DATA_STATE_IDLE;
Ronald Cron5d0ae902024-01-05 14:20:35 +01001115#endif
Jerry Yu4caf3ca2023-11-15 16:13:47 +08001116#if defined(MBEDTLS_SSL_SRV_C)
1117 ssl->discard_early_data_record = MBEDTLS_SSL_EARLY_DATA_NO_DISCARD;
1118#endif
Ronald Cron19bfe0a2024-02-26 16:43:01 +01001119 ssl->total_early_data_size = 0;
Jerry Yu4caf3ca2023-11-15 16:13:47 +08001120#endif /* MBEDTLS_SSL_EARLY_DATA */
Ronald Cron5d0ae902024-01-05 14:20:35 +01001121
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001122 /* Initialize structures */
Gilles Peskine449bd832023-01-11 14:50:10 +01001123 mbedtls_ssl_session_init(ssl->session_negotiate);
1124 ssl_handshake_params_init(ssl->handshake);
Paul Bakker968afaa2014-07-09 11:09:24 +02001125
Jerry Yu2e199812022-12-01 18:57:19 +08001126#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01001127 mbedtls_ssl_transform_init(ssl->transform_negotiate);
Jerry Yu2e199812022-12-01 18:57:19 +08001128#endif
1129
Manuel Pégourié-Gonnard537f2312023-02-05 10:17:45 +01001130 /* Setup handshake checksums */
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01001131 ret = mbedtls_ssl_reset_checksum(ssl);
1132 if (ret != 0) {
1133 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_reset_checksum", ret);
1134 return ret;
1135 }
Manuel Pégourié-Gonnard537f2312023-02-05 10:17:45 +01001136
Jerry Yud0766ec2022-09-22 10:46:57 +08001137#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && \
1138 defined(MBEDTLS_SSL_SRV_C) && \
1139 defined(MBEDTLS_SSL_SESSION_TICKETS)
1140 ssl->handshake->new_session_tickets_count =
Gilles Peskine449bd832023-01-11 14:50:10 +01001141 ssl->conf->new_session_tickets_count;
Jerry Yud0766ec2022-09-22 10:46:57 +08001142#endif
1143
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001144#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01001145 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +02001146 ssl->handshake->alt_transform_out = ssl->transform_out;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02001147
Gilles Peskine449bd832023-01-11 14:50:10 +01001148 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +02001149 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_PREPARING;
Gilles Peskine449bd832023-01-11 14:50:10 +01001150 } else {
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +02001151 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_WAITING;
Gilles Peskine449bd832023-01-11 14:50:10 +01001152 }
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001153
Gilles Peskine449bd832023-01-11 14:50:10 +01001154 mbedtls_ssl_set_timer(ssl, 0);
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +02001155 }
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02001156#endif
1157
Brett Warrene0edc842021-08-17 09:53:13 +01001158/*
1159 * curve_list is translated to IANA TLS group identifiers here because
1160 * mbedtls_ssl_conf_curves returns void and so can't return
1161 * any error codes.
1162 */
Manuel Pégourié-Gonnardf07ce3b2023-09-22 11:53:41 +02001163#if defined(MBEDTLS_ECP_C)
Brett Warrene0edc842021-08-17 09:53:13 +01001164#if !defined(MBEDTLS_DEPRECATED_REMOVED)
1165 /* Heap allocate and translate curve_list from internal to IANA group ids */
Gilles Peskine449bd832023-01-11 14:50:10 +01001166 if (ssl->conf->curve_list != NULL) {
Brett Warrene0edc842021-08-17 09:53:13 +01001167 size_t length;
1168 const mbedtls_ecp_group_id *curve_list = ssl->conf->curve_list;
1169
Thomas Daubney850a0792023-05-22 12:05:03 +01001170 for (length = 0; (curve_list[length] != MBEDTLS_ECP_DP_NONE); length++) {
Gilles Peskine449bd832023-01-11 14:50:10 +01001171 }
Brett Warrene0edc842021-08-17 09:53:13 +01001172
1173 /* Leave room for zero termination */
Gilles Peskine449bd832023-01-11 14:50:10 +01001174 uint16_t *group_list = mbedtls_calloc(length + 1, sizeof(uint16_t));
1175 if (group_list == NULL) {
1176 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
1177 }
Brett Warrene0edc842021-08-17 09:53:13 +01001178
Gilles Peskine449bd832023-01-11 14:50:10 +01001179 for (size_t i = 0; i < length; i++) {
Valerio Setti18c9fed2022-12-30 17:44:24 +01001180 uint16_t tls_id = mbedtls_ssl_get_tls_id_from_ecp_group_id(
Gilles Peskine449bd832023-01-11 14:50:10 +01001181 curve_list[i]);
1182 if (tls_id == 0) {
1183 mbedtls_free(group_list);
1184 return MBEDTLS_ERR_SSL_BAD_CONFIG;
Brett Warrene0edc842021-08-17 09:53:13 +01001185 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01001186 group_list[i] = tls_id;
Brett Warrene0edc842021-08-17 09:53:13 +01001187 }
1188
1189 group_list[length] = 0;
1190
1191 ssl->handshake->group_list = group_list;
1192 ssl->handshake->group_list_heap_allocated = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01001193 } else {
Brett Warrene0edc842021-08-17 09:53:13 +01001194 ssl->handshake->group_list = ssl->conf->group_list;
1195 ssl->handshake->group_list_heap_allocated = 0;
1196 }
1197#endif /* MBEDTLS_DEPRECATED_REMOVED */
Manuel Pégourié-Gonnardf07ce3b2023-09-22 11:53:41 +02001198#endif /* MBEDTLS_ECP_C */
Brett Warrene0edc842021-08-17 09:53:13 +01001199
Ronald Crone68ab4f2022-10-05 12:46:29 +02001200#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yuf017ee42022-01-12 15:49:48 +08001201#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Jerry Yua69269a2022-01-17 21:06:01 +08001202#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Jerry Yu713013f2022-01-17 18:16:35 +08001203 /* Heap allocate and translate sig_hashes from internal hash identifiers to
1204 signature algorithms IANA identifiers. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001205 if (mbedtls_ssl_conf_is_tls12_only(ssl->conf) &&
1206 ssl->conf->sig_hashes != NULL) {
Jerry Yuf017ee42022-01-12 15:49:48 +08001207 const int *md;
1208 const int *sig_hashes = ssl->conf->sig_hashes;
Jerry Yub476a442022-01-21 18:14:45 +08001209 size_t sig_algs_len = 0;
Jerry Yuf017ee42022-01-12 15:49:48 +08001210 uint16_t *p;
1211
Tom Cosgrove6ef9bb32023-03-08 14:19:51 +00001212 MBEDTLS_STATIC_ASSERT(MBEDTLS_SSL_MAX_SIG_ALG_LIST_LEN
1213 <= (SIZE_MAX - (2 * sizeof(uint16_t))),
1214 "MBEDTLS_SSL_MAX_SIG_ALG_LIST_LEN too big");
Jerry Yua68dca22022-01-20 16:28:27 +08001215
Gilles Peskine449bd832023-01-11 14:50:10 +01001216 for (md = sig_hashes; *md != MBEDTLS_MD_NONE; md++) {
1217 if (mbedtls_ssl_hash_from_md_alg(*md) == MBEDTLS_SSL_HASH_NONE) {
Jerry Yuf017ee42022-01-12 15:49:48 +08001218 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01001219 }
Valerio Settie9646ec2023-08-02 20:02:28 +02001220#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01001221 sig_algs_len += sizeof(uint16_t);
Jerry Yub476a442022-01-21 18:14:45 +08001222#endif
Jerry Yua68dca22022-01-20 16:28:27 +08001223
Jerry Yub476a442022-01-21 18:14:45 +08001224#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001225 sig_algs_len += sizeof(uint16_t);
Jerry Yub476a442022-01-21 18:14:45 +08001226#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001227 if (sig_algs_len > MBEDTLS_SSL_MAX_SIG_ALG_LIST_LEN) {
1228 return MBEDTLS_ERR_SSL_BAD_CONFIG;
1229 }
Jerry Yuf017ee42022-01-12 15:49:48 +08001230 }
1231
Gilles Peskine449bd832023-01-11 14:50:10 +01001232 if (sig_algs_len < MBEDTLS_SSL_MIN_SIG_ALG_LIST_LEN) {
1233 return MBEDTLS_ERR_SSL_BAD_CONFIG;
1234 }
Jerry Yuf017ee42022-01-12 15:49:48 +08001235
Gilles Peskine449bd832023-01-11 14:50:10 +01001236 ssl->handshake->sig_algs = mbedtls_calloc(1, sig_algs_len +
1237 sizeof(uint16_t));
1238 if (ssl->handshake->sig_algs == NULL) {
1239 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
1240 }
Jerry Yuf017ee42022-01-12 15:49:48 +08001241
Gilles Peskine449bd832023-01-11 14:50:10 +01001242 p = (uint16_t *) ssl->handshake->sig_algs;
1243 for (md = sig_hashes; *md != MBEDTLS_MD_NONE; md++) {
1244 unsigned char hash = mbedtls_ssl_hash_from_md_alg(*md);
1245 if (hash == MBEDTLS_SSL_HASH_NONE) {
Jerry Yuf017ee42022-01-12 15:49:48 +08001246 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01001247 }
Valerio Settie9646ec2023-08-02 20:02:28 +02001248#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01001249 *p = ((hash << 8) | MBEDTLS_SSL_SIG_ECDSA);
Jerry Yuf017ee42022-01-12 15:49:48 +08001250 p++;
Jerry Yu6106fdc2022-01-12 16:36:14 +08001251#endif
1252#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001253 *p = ((hash << 8) | MBEDTLS_SSL_SIG_RSA);
Jerry Yuf017ee42022-01-12 15:49:48 +08001254 p++;
Jerry Yu6106fdc2022-01-12 16:36:14 +08001255#endif
Jerry Yuf017ee42022-01-12 15:49:48 +08001256 }
Gabor Mezei15b95a62022-05-09 16:37:58 +02001257 *p = MBEDTLS_TLS_SIG_NONE;
Jerry Yuf017ee42022-01-12 15:49:48 +08001258 ssl->handshake->sig_algs_heap_allocated = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01001259 } else
Jerry Yua69269a2022-01-17 21:06:01 +08001260#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Jerry Yuf017ee42022-01-12 15:49:48 +08001261 {
Jerry Yuf017ee42022-01-12 15:49:48 +08001262 ssl->handshake->sig_algs_heap_allocated = 0;
1263 }
Jerry Yucc539102022-06-27 16:27:35 +08001264#endif /* !MBEDTLS_DEPRECATED_REMOVED */
Ronald Crone68ab4f2022-10-05 12:46:29 +02001265#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Gilles Peskine449bd832023-01-11 14:50:10 +01001266 return 0;
Paul Bakker48916f92012-09-16 19:57:18 +00001267}
1268
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001269#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001270/* Dummy cookie callbacks for defaults */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001271MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001272static int ssl_cookie_write_dummy(void *ctx,
1273 unsigned char **p, unsigned char *end,
1274 const unsigned char *cli_id, size_t cli_id_len)
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001275{
1276 ((void) ctx);
1277 ((void) p);
1278 ((void) end);
1279 ((void) cli_id);
1280 ((void) cli_id_len);
1281
Gilles Peskine449bd832023-01-11 14:50:10 +01001282 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001283}
1284
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001285MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001286static int ssl_cookie_check_dummy(void *ctx,
1287 const unsigned char *cookie, size_t cookie_len,
1288 const unsigned char *cli_id, size_t cli_id_len)
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001289{
1290 ((void) ctx);
1291 ((void) cookie);
1292 ((void) cookie_len);
1293 ((void) cli_id);
1294 ((void) cli_id_len);
1295
Gilles Peskine449bd832023-01-11 14:50:10 +01001296 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001297}
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001298#endif /* MBEDTLS_SSL_DTLS_HELLO_VERIFY && MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001299
Paul Bakker5121ce52009-01-03 21:22:43 +00001300/*
1301 * Initialize an SSL context
1302 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001303void mbedtls_ssl_init(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +02001304{
Gilles Peskine449bd832023-01-11 14:50:10 +01001305 memset(ssl, 0, sizeof(mbedtls_ssl_context));
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +02001306}
1307
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001308MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001309static int ssl_conf_version_check(const mbedtls_ssl_context *ssl)
Jerry Yu60835a82021-08-04 10:13:52 +08001310{
Ronald Cron086ee0b2022-03-15 15:18:51 +01001311 const mbedtls_ssl_config *conf = ssl->conf;
1312
Ronald Cron6f135e12021-12-08 16:57:54 +01001313#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01001314 if (mbedtls_ssl_conf_is_tls13_only(conf)) {
1315 if (conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
1316 MBEDTLS_SSL_DEBUG_MSG(1, ("DTLS 1.3 is not yet supported."));
1317 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
XiaokangQianed582dd2022-04-13 08:21:05 +00001318 }
1319
Gilles Peskine449bd832023-01-11 14:50:10 +01001320 MBEDTLS_SSL_DEBUG_MSG(4, ("The SSL configuration is tls13 only."));
1321 return 0;
Jerry Yu60835a82021-08-04 10:13:52 +08001322 }
1323#endif
1324
1325#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01001326 if (mbedtls_ssl_conf_is_tls12_only(conf)) {
1327 MBEDTLS_SSL_DEBUG_MSG(4, ("The SSL configuration is tls12 only."));
1328 return 0;
Jerry Yu60835a82021-08-04 10:13:52 +08001329 }
1330#endif
1331
Ronald Cron6f135e12021-12-08 16:57:54 +01001332#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01001333 if (mbedtls_ssl_conf_is_hybrid_tls12_tls13(conf)) {
1334 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
1335 MBEDTLS_SSL_DEBUG_MSG(1, ("DTLS not yet supported in Hybrid TLS 1.3 + TLS 1.2"));
1336 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
XiaokangQianed582dd2022-04-13 08:21:05 +00001337 }
1338
Gilles Peskine449bd832023-01-11 14:50:10 +01001339 MBEDTLS_SSL_DEBUG_MSG(4, ("The SSL configuration is TLS 1.3 or TLS 1.2."));
1340 return 0;
Jerry Yu60835a82021-08-04 10:13:52 +08001341 }
1342#endif
1343
Gilles Peskine449bd832023-01-11 14:50:10 +01001344 MBEDTLS_SSL_DEBUG_MSG(1, ("The SSL configuration is invalid."));
1345 return MBEDTLS_ERR_SSL_BAD_CONFIG;
Jerry Yu60835a82021-08-04 10:13:52 +08001346}
1347
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001348MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu60835a82021-08-04 10:13:52 +08001349static int ssl_conf_check(const mbedtls_ssl_context *ssl)
1350{
1351 int ret;
Gilles Peskine449bd832023-01-11 14:50:10 +01001352 ret = ssl_conf_version_check(ssl);
1353 if (ret != 0) {
1354 return ret;
1355 }
Jerry Yu60835a82021-08-04 10:13:52 +08001356
Yanray Wangb422cab2023-12-01 16:18:10 +08001357 if (ssl->conf->f_rng == NULL) {
1358 MBEDTLS_SSL_DEBUG_MSG(1, ("no RNG provided"));
1359 return MBEDTLS_ERR_SSL_NO_RNG;
1360 }
1361
Jerry Yu60835a82021-08-04 10:13:52 +08001362 /* Space for further checks */
1363
Gilles Peskine449bd832023-01-11 14:50:10 +01001364 return 0;
Jerry Yu60835a82021-08-04 10:13:52 +08001365}
1366
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +02001367/*
1368 * Setup an SSL context
1369 */
Hanno Becker2a43f6f2018-08-10 11:12:52 +01001370
Gilles Peskine449bd832023-01-11 14:50:10 +01001371int mbedtls_ssl_setup(mbedtls_ssl_context *ssl,
1372 const mbedtls_ssl_config *conf)
Paul Bakker5121ce52009-01-03 21:22:43 +00001373{
Janos Follath865b3eb2019-12-16 11:46:15 +00001374 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Darryl Greenb33cc762019-11-28 14:29:44 +00001375 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
1376 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
Paul Bakker5121ce52009-01-03 21:22:43 +00001377
Manuel Pégourié-Gonnarddef0bbe2015-05-04 14:56:36 +02001378 ssl->conf = conf;
Paul Bakker62f2dee2012-09-28 07:31:51 +00001379
Gilles Peskine449bd832023-01-11 14:50:10 +01001380 if ((ret = ssl_conf_check(ssl)) != 0) {
1381 return ret;
1382 }
Ronald Cron8a12aee2023-03-08 15:30:43 +01001383 ssl->tls_version = ssl->conf->max_tls_version;
Jerry Yu60835a82021-08-04 10:13:52 +08001384
Paul Bakker62f2dee2012-09-28 07:31:51 +00001385 /*
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01001386 * Prepare base structures
Paul Bakker62f2dee2012-09-28 07:31:51 +00001387 */
k-stachowiakc9a5f022018-07-24 13:53:31 +02001388
1389 /* Set to NULL in case of an error condition */
1390 ssl->out_buf = NULL;
k-stachowiaka47911c2018-07-04 17:41:58 +02001391
Darryl Greenb33cc762019-11-28 14:29:44 +00001392#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1393 ssl->in_buf_len = in_buf_len;
1394#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001395 ssl->in_buf = mbedtls_calloc(1, in_buf_len);
1396 if (ssl->in_buf == NULL) {
1397 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc(%" MBEDTLS_PRINTF_SIZET " bytes) failed", in_buf_len));
k-stachowiak9f7798e2018-07-31 16:52:32 +02001398 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
k-stachowiaka47911c2018-07-04 17:41:58 +02001399 goto error;
Angus Grattond8213d02016-05-25 20:56:48 +10001400 }
1401
Darryl Greenb33cc762019-11-28 14:29:44 +00001402#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1403 ssl->out_buf_len = out_buf_len;
1404#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001405 ssl->out_buf = mbedtls_calloc(1, out_buf_len);
1406 if (ssl->out_buf == NULL) {
1407 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc(%" MBEDTLS_PRINTF_SIZET " bytes) failed", out_buf_len));
k-stachowiak9f7798e2018-07-31 16:52:32 +02001408 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
k-stachowiaka47911c2018-07-04 17:41:58 +02001409 goto error;
Paul Bakker5121ce52009-01-03 21:22:43 +00001410 }
1411
Gilles Peskine449bd832023-01-11 14:50:10 +01001412 mbedtls_ssl_reset_in_out_pointers(ssl);
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02001413
Johan Pascalb62bb512015-12-03 21:56:45 +01001414#if defined(MBEDTLS_SSL_DTLS_SRTP)
Gilles Peskine449bd832023-01-11 14:50:10 +01001415 memset(&ssl->dtls_srtp_info, 0, sizeof(ssl->dtls_srtp_info));
Johan Pascalb62bb512015-12-03 21:56:45 +01001416#endif
1417
Gilles Peskine449bd832023-01-11 14:50:10 +01001418 if ((ret = ssl_handshake_init(ssl)) != 0) {
k-stachowiaka47911c2018-07-04 17:41:58 +02001419 goto error;
Gilles Peskine449bd832023-01-11 14:50:10 +01001420 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001421
Gilles Peskine449bd832023-01-11 14:50:10 +01001422 return 0;
k-stachowiaka47911c2018-07-04 17:41:58 +02001423
1424error:
Gilles Peskine449bd832023-01-11 14:50:10 +01001425 mbedtls_free(ssl->in_buf);
1426 mbedtls_free(ssl->out_buf);
k-stachowiaka47911c2018-07-04 17:41:58 +02001427
1428 ssl->conf = NULL;
1429
Darryl Greenb33cc762019-11-28 14:29:44 +00001430#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1431 ssl->in_buf_len = 0;
1432 ssl->out_buf_len = 0;
1433#endif
k-stachowiaka47911c2018-07-04 17:41:58 +02001434 ssl->in_buf = NULL;
1435 ssl->out_buf = NULL;
1436
1437 ssl->in_hdr = NULL;
1438 ssl->in_ctr = NULL;
1439 ssl->in_len = NULL;
1440 ssl->in_iv = NULL;
1441 ssl->in_msg = NULL;
1442
1443 ssl->out_hdr = NULL;
1444 ssl->out_ctr = NULL;
1445 ssl->out_len = NULL;
1446 ssl->out_iv = NULL;
1447 ssl->out_msg = NULL;
1448
Gilles Peskine449bd832023-01-11 14:50:10 +01001449 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00001450}
1451
1452/*
Paul Bakker7eb013f2011-10-06 12:37:39 +00001453 * Reset an initialized and used SSL context for re-use while retaining
1454 * all application-set variables, function pointers and data.
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001455 *
1456 * If partial is non-zero, keep data in the input buffer and client ID.
1457 * (Use when a DTLS client reconnects from the same port.)
Paul Bakker7eb013f2011-10-06 12:37:39 +00001458 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001459void mbedtls_ssl_session_reset_msg_layer(mbedtls_ssl_context *ssl,
1460 int partial)
Paul Bakker7eb013f2011-10-06 12:37:39 +00001461{
Darryl Greenb33cc762019-11-28 14:29:44 +00001462#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1463 size_t in_buf_len = ssl->in_buf_len;
1464 size_t out_buf_len = ssl->out_buf_len;
1465#else
1466 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
1467 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
1468#endif
Paul Bakker48916f92012-09-16 19:57:18 +00001469
Hanno Beckerb0302c42021-08-03 09:39:42 +01001470#if !defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE) || !defined(MBEDTLS_SSL_SRV_C)
1471 partial = 0;
Hanno Becker7e772132018-08-10 12:38:21 +01001472#endif
1473
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001474 /* Cancel any possibly running timer */
Gilles Peskine449bd832023-01-11 14:50:10 +01001475 mbedtls_ssl_set_timer(ssl, 0);
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001476
Gilles Peskine449bd832023-01-11 14:50:10 +01001477 mbedtls_ssl_reset_in_out_pointers(ssl);
Hanno Beckerb0302c42021-08-03 09:39:42 +01001478
1479 /* Reset incoming message parsing */
1480 ssl->in_offt = NULL;
1481 ssl->nb_zero = 0;
1482 ssl->in_msgtype = 0;
1483 ssl->in_msglen = 0;
1484 ssl->in_hslen = 0;
1485 ssl->keep_current_message = 0;
1486 ssl->transform_in = NULL;
1487
1488#if defined(MBEDTLS_SSL_PROTO_DTLS)
1489 ssl->next_record_offset = 0;
1490 ssl->in_epoch = 0;
1491#endif
1492
1493 /* Keep current datagram if partial == 1 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001494 if (partial == 0) {
Hanno Beckerb0302c42021-08-03 09:39:42 +01001495 ssl->in_left = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01001496 memset(ssl->in_buf, 0, in_buf_len);
Hanno Beckerb0302c42021-08-03 09:39:42 +01001497 }
1498
Ronald Cronad8c17b2022-06-10 17:18:09 +02001499 ssl->send_alert = 0;
1500
Hanno Beckerb0302c42021-08-03 09:39:42 +01001501 /* Reset outgoing message writing */
1502 ssl->out_msgtype = 0;
1503 ssl->out_msglen = 0;
1504 ssl->out_left = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01001505 memset(ssl->out_buf, 0, out_buf_len);
1506 memset(ssl->cur_out_ctr, 0, sizeof(ssl->cur_out_ctr));
Hanno Beckerb0302c42021-08-03 09:39:42 +01001507 ssl->transform_out = NULL;
1508
1509#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Gilles Peskine449bd832023-01-11 14:50:10 +01001510 mbedtls_ssl_dtls_replay_reset(ssl);
Hanno Beckerb0302c42021-08-03 09:39:42 +01001511#endif
1512
XiaokangQian2b01dc32022-01-21 02:53:13 +00001513#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01001514 if (ssl->transform) {
1515 mbedtls_ssl_transform_free(ssl->transform);
1516 mbedtls_free(ssl->transform);
Hanno Beckerb0302c42021-08-03 09:39:42 +01001517 ssl->transform = NULL;
1518 }
XiaokangQian2b01dc32022-01-21 02:53:13 +00001519#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
1520
XiaokangQian2b01dc32022-01-21 02:53:13 +00001521#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01001522 mbedtls_ssl_transform_free(ssl->transform_application);
1523 mbedtls_free(ssl->transform_application);
XiaokangQian2b01dc32022-01-21 02:53:13 +00001524 ssl->transform_application = NULL;
1525
Gilles Peskine449bd832023-01-11 14:50:10 +01001526 if (ssl->handshake != NULL) {
Jerry Yu3d9b5902022-11-04 14:07:25 +08001527#if defined(MBEDTLS_SSL_EARLY_DATA)
Gilles Peskine449bd832023-01-11 14:50:10 +01001528 mbedtls_ssl_transform_free(ssl->handshake->transform_earlydata);
1529 mbedtls_free(ssl->handshake->transform_earlydata);
XiaokangQian2b01dc32022-01-21 02:53:13 +00001530 ssl->handshake->transform_earlydata = NULL;
Jerry Yu3d9b5902022-11-04 14:07:25 +08001531#endif
XiaokangQian2b01dc32022-01-21 02:53:13 +00001532
Gilles Peskine449bd832023-01-11 14:50:10 +01001533 mbedtls_ssl_transform_free(ssl->handshake->transform_handshake);
1534 mbedtls_free(ssl->handshake->transform_handshake);
XiaokangQian2b01dc32022-01-21 02:53:13 +00001535 ssl->handshake->transform_handshake = NULL;
1536 }
1537
XiaokangQian2b01dc32022-01-21 02:53:13 +00001538#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Beckerb0302c42021-08-03 09:39:42 +01001539}
1540
Gilles Peskine449bd832023-01-11 14:50:10 +01001541int mbedtls_ssl_session_reset_int(mbedtls_ssl_context *ssl, int partial)
Hanno Beckerb0302c42021-08-03 09:39:42 +01001542{
1543 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1544
1545 ssl->state = MBEDTLS_SSL_HELLO_REQUEST;
Ronald Cron195c0bc2024-02-08 08:51:20 +01001546 ssl->tls_version = ssl->conf->max_tls_version;
Hanno Beckerb0302c42021-08-03 09:39:42 +01001547
Gilles Peskine449bd832023-01-11 14:50:10 +01001548 mbedtls_ssl_session_reset_msg_layer(ssl, partial);
Hanno Beckerb0302c42021-08-03 09:39:42 +01001549
1550 /* Reset renegotiation state */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001551#if defined(MBEDTLS_SSL_RENEGOTIATION)
1552 ssl->renego_status = MBEDTLS_SSL_INITIAL_HANDSHAKE;
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001553 ssl->renego_records_seen = 0;
Paul Bakker48916f92012-09-16 19:57:18 +00001554
1555 ssl->verify_data_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01001556 memset(ssl->own_verify_data, 0, MBEDTLS_SSL_VERIFY_DATA_MAX_LEN);
1557 memset(ssl->peer_verify_data, 0, MBEDTLS_SSL_VERIFY_DATA_MAX_LEN);
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001558#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001559 ssl->secure_renegotiation = MBEDTLS_SSL_LEGACY_RENEGOTIATION;
Paul Bakker48916f92012-09-16 19:57:18 +00001560
Hanno Beckerb0302c42021-08-03 09:39:42 +01001561 ssl->session_in = NULL;
Hanno Becker78640902018-08-13 16:35:15 +01001562 ssl->session_out = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01001563 if (ssl->session) {
1564 mbedtls_ssl_session_free(ssl->session);
1565 mbedtls_free(ssl->session);
Paul Bakkerc0463502013-02-14 11:19:38 +01001566 ssl->session = NULL;
1567 }
1568
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001569#if defined(MBEDTLS_SSL_ALPN)
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001570 ssl->alpn_chosen = NULL;
1571#endif
1572
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001573#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
David Horstmann3b2276a2022-10-06 14:49:08 +01001574 int free_cli_id = 1;
Hanno Becker4ccbf062018-08-10 11:20:38 +01001575#if defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE)
Gilles Peskine449bd832023-01-11 14:50:10 +01001576 free_cli_id = (partial == 0);
Hanno Becker4ccbf062018-08-10 11:20:38 +01001577#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001578 if (free_cli_id) {
1579 mbedtls_free(ssl->cli_id);
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001580 ssl->cli_id = NULL;
1581 ssl->cli_id_len = 0;
1582 }
Manuel Pégourié-Gonnard43c02182014-07-22 17:32:01 +02001583#endif
1584
Gilles Peskine449bd832023-01-11 14:50:10 +01001585 if ((ret = ssl_handshake_init(ssl)) != 0) {
1586 return ret;
1587 }
Paul Bakker2770fbd2012-07-03 13:30:23 +00001588
Gilles Peskine449bd832023-01-11 14:50:10 +01001589 return 0;
Paul Bakker7eb013f2011-10-06 12:37:39 +00001590}
1591
Manuel Pégourié-Gonnard779e4292013-08-03 13:50:48 +02001592/*
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001593 * Reset an initialized and used SSL context for re-use while retaining
1594 * all application-set variables, function pointers and data.
1595 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001596int mbedtls_ssl_session_reset(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001597{
Gilles Peskine449bd832023-01-11 14:50:10 +01001598 return mbedtls_ssl_session_reset_int(ssl, 0);
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001599}
1600
1601/*
Paul Bakker5121ce52009-01-03 21:22:43 +00001602 * SSL set accessors
1603 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001604void mbedtls_ssl_conf_endpoint(mbedtls_ssl_config *conf, int endpoint)
Paul Bakker5121ce52009-01-03 21:22:43 +00001605{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001606 conf->endpoint = endpoint;
Paul Bakker5121ce52009-01-03 21:22:43 +00001607}
1608
Gilles Peskine449bd832023-01-11 14:50:10 +01001609void mbedtls_ssl_conf_transport(mbedtls_ssl_config *conf, int transport)
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001610{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001611 conf->transport = transport;
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001612}
1613
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001614#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Gilles Peskine449bd832023-01-11 14:50:10 +01001615void mbedtls_ssl_conf_dtls_anti_replay(mbedtls_ssl_config *conf, char mode)
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02001616{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001617 conf->anti_replay = mode;
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02001618}
1619#endif
1620
Gilles Peskine449bd832023-01-11 14:50:10 +01001621void mbedtls_ssl_conf_dtls_badmac_limit(mbedtls_ssl_config *conf, unsigned limit)
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001622{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001623 conf->badmac_limit = limit;
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001624}
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001625
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001626#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker04da1892018-08-14 13:22:10 +01001627
Gilles Peskine449bd832023-01-11 14:50:10 +01001628void mbedtls_ssl_set_datagram_packing(mbedtls_ssl_context *ssl,
1629 unsigned allow_packing)
Hanno Becker04da1892018-08-14 13:22:10 +01001630{
1631 ssl->disable_datagram_packing = !allow_packing;
1632}
1633
Gilles Peskine449bd832023-01-11 14:50:10 +01001634void mbedtls_ssl_conf_handshake_timeout(mbedtls_ssl_config *conf,
1635 uint32_t min, uint32_t max)
Manuel Pégourié-Gonnard905dd242014-10-01 12:03:55 +02001636{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001637 conf->hs_timeout_min = min;
1638 conf->hs_timeout_max = max;
Manuel Pégourié-Gonnard905dd242014-10-01 12:03:55 +02001639}
1640#endif
1641
Gilles Peskine449bd832023-01-11 14:50:10 +01001642void mbedtls_ssl_conf_authmode(mbedtls_ssl_config *conf, int authmode)
Paul Bakker5121ce52009-01-03 21:22:43 +00001643{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001644 conf->authmode = authmode;
Paul Bakker5121ce52009-01-03 21:22:43 +00001645}
1646
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001647#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001648void mbedtls_ssl_conf_verify(mbedtls_ssl_config *conf,
1649 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *),
1650 void *p_vrfy)
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001651{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001652 conf->f_vrfy = f_vrfy;
1653 conf->p_vrfy = p_vrfy;
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001654}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001655#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001656
Gilles Peskine449bd832023-01-11 14:50:10 +01001657void mbedtls_ssl_conf_rng(mbedtls_ssl_config *conf,
1658 int (*f_rng)(void *, unsigned char *, size_t),
1659 void *p_rng)
Paul Bakker5121ce52009-01-03 21:22:43 +00001660{
Manuel Pégourié-Gonnard750e4d72015-05-07 12:35:38 +01001661 conf->f_rng = f_rng;
1662 conf->p_rng = p_rng;
Paul Bakker5121ce52009-01-03 21:22:43 +00001663}
1664
Gilles Peskine449bd832023-01-11 14:50:10 +01001665void mbedtls_ssl_conf_dbg(mbedtls_ssl_config *conf,
1666 void (*f_dbg)(void *, int, const char *, int, const char *),
1667 void *p_dbg)
Paul Bakker5121ce52009-01-03 21:22:43 +00001668{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001669 conf->f_dbg = f_dbg;
1670 conf->p_dbg = p_dbg;
Paul Bakker5121ce52009-01-03 21:22:43 +00001671}
1672
Gilles Peskine449bd832023-01-11 14:50:10 +01001673void mbedtls_ssl_set_bio(mbedtls_ssl_context *ssl,
1674 void *p_bio,
1675 mbedtls_ssl_send_t *f_send,
1676 mbedtls_ssl_recv_t *f_recv,
1677 mbedtls_ssl_recv_timeout_t *f_recv_timeout)
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02001678{
1679 ssl->p_bio = p_bio;
1680 ssl->f_send = f_send;
1681 ssl->f_recv = f_recv;
1682 ssl->f_recv_timeout = f_recv_timeout;
Manuel Pégourié-Gonnard97fd52c2015-05-06 15:38:52 +01001683}
1684
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02001685#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01001686void mbedtls_ssl_set_mtu(mbedtls_ssl_context *ssl, uint16_t mtu)
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02001687{
1688 ssl->mtu = mtu;
1689}
1690#endif
1691
Gilles Peskine449bd832023-01-11 14:50:10 +01001692void mbedtls_ssl_conf_read_timeout(mbedtls_ssl_config *conf, uint32_t timeout)
Manuel Pégourié-Gonnard97fd52c2015-05-06 15:38:52 +01001693{
1694 conf->read_timeout = timeout;
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02001695}
1696
Gilles Peskine449bd832023-01-11 14:50:10 +01001697void mbedtls_ssl_set_timer_cb(mbedtls_ssl_context *ssl,
1698 void *p_timer,
1699 mbedtls_ssl_set_timer_t *f_set_timer,
1700 mbedtls_ssl_get_timer_t *f_get_timer)
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02001701{
1702 ssl->p_timer = p_timer;
1703 ssl->f_set_timer = f_set_timer;
1704 ssl->f_get_timer = f_get_timer;
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001705
1706 /* Make sure we start with no timer running */
Gilles Peskine449bd832023-01-11 14:50:10 +01001707 mbedtls_ssl_set_timer(ssl, 0);
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02001708}
1709
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001710#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001711void mbedtls_ssl_conf_session_cache(mbedtls_ssl_config *conf,
1712 void *p_cache,
1713 mbedtls_ssl_cache_get_t *f_get_cache,
1714 mbedtls_ssl_cache_set_t *f_set_cache)
Paul Bakker5121ce52009-01-03 21:22:43 +00001715{
Manuel Pégourié-Gonnard5cb33082015-05-06 18:06:26 +01001716 conf->p_cache = p_cache;
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001717 conf->f_get_cache = f_get_cache;
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001718 conf->f_set_cache = f_set_cache;
Paul Bakker5121ce52009-01-03 21:22:43 +00001719}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001720#endif /* MBEDTLS_SSL_SRV_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00001721
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001722#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001723int mbedtls_ssl_set_session(mbedtls_ssl_context *ssl, const mbedtls_ssl_session *session)
Paul Bakker5121ce52009-01-03 21:22:43 +00001724{
Janos Follath865b3eb2019-12-16 11:46:15 +00001725 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001726
Gilles Peskine449bd832023-01-11 14:50:10 +01001727 if (ssl == NULL ||
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001728 session == NULL ||
1729 ssl->session_negotiate == NULL ||
Gilles Peskine449bd832023-01-11 14:50:10 +01001730 ssl->conf->endpoint != MBEDTLS_SSL_IS_CLIENT) {
1731 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001732 }
1733
Gilles Peskine449bd832023-01-11 14:50:10 +01001734 if (ssl->handshake->resume == 1) {
1735 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
1736 }
Hanno Beckere810bbc2021-05-14 16:01:05 +01001737
Jerry Yu21092062022-10-10 21:21:31 +08001738#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01001739 if (session->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Ronald Cron8d630842024-04-04 14:05:21 +02001740#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Jerry Yu21092062022-10-10 21:21:31 +08001741 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
Gilles Peskine449bd832023-01-11 14:50:10 +01001742 mbedtls_ssl_ciphersuite_from_id(session->ciphersuite);
Jerry Yu21092062022-10-10 21:21:31 +08001743
Gilles Peskine449bd832023-01-11 14:50:10 +01001744 if (mbedtls_ssl_validate_ciphersuite(
Jerry Yu21092062022-10-10 21:21:31 +08001745 ssl, ciphersuite_info, MBEDTLS_SSL_VERSION_TLS1_3,
Gilles Peskine449bd832023-01-11 14:50:10 +01001746 MBEDTLS_SSL_VERSION_TLS1_3) != 0) {
1747 MBEDTLS_SSL_DEBUG_MSG(4, ("%d is not a valid TLS 1.3 ciphersuite.",
1748 session->ciphersuite));
1749 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jerry Yu21092062022-10-10 21:21:31 +08001750 }
Ronald Cron8d630842024-04-04 14:05:21 +02001751#else
1752 /*
1753 * If session tickets are not enabled, it is not possible to resume a
1754 * TLS 1.3 session, thus do not make any change to the SSL context in
1755 * the first place.
1756 */
1757 return 0;
1758#endif
Jerry Yu40afab62022-10-08 10:42:13 +08001759 }
Jerry Yu21092062022-10-10 21:21:31 +08001760#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yu40afab62022-10-08 10:42:13 +08001761
Gilles Peskine449bd832023-01-11 14:50:10 +01001762 if ((ret = mbedtls_ssl_session_copy(ssl->session_negotiate,
1763 session)) != 0) {
1764 return ret;
1765 }
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001766
Paul Bakker0a597072012-09-25 21:55:46 +00001767 ssl->handshake->resume = 1;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001768
Gilles Peskine449bd832023-01-11 14:50:10 +01001769 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00001770}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001771#endif /* MBEDTLS_SSL_CLI_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00001772
Gilles Peskine449bd832023-01-11 14:50:10 +01001773void mbedtls_ssl_conf_ciphersuites(mbedtls_ssl_config *conf,
1774 const int *ciphersuites)
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001775{
Hanno Beckerd60b6c62021-04-29 12:04:11 +01001776 conf->ciphersuite_list = ciphersuites;
Paul Bakker5121ce52009-01-03 21:22:43 +00001777}
1778
Ronald Cron6f135e12021-12-08 16:57:54 +01001779#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01001780void mbedtls_ssl_conf_tls13_key_exchange_modes(mbedtls_ssl_config *conf,
1781 const int kex_modes)
Hanno Becker71f1ed62021-07-24 06:01:47 +01001782{
Xiaofei Bai746f9482021-11-12 08:53:56 +00001783 conf->tls13_kex_modes = kex_modes & MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_ALL;
Hanno Becker71f1ed62021-07-24 06:01:47 +01001784}
Xiaokang Qian72de95d2022-10-25 02:54:33 +00001785
1786#if defined(MBEDTLS_SSL_EARLY_DATA)
Yanray Wangd5ed36f2023-11-07 11:40:43 +08001787void mbedtls_ssl_conf_early_data(mbedtls_ssl_config *conf,
1788 int early_data_enabled)
Xiaokang Qian72de95d2022-10-25 02:54:33 +00001789{
1790 conf->early_data_enabled = early_data_enabled;
1791}
Jerry Yucc4e0072022-11-22 17:22:22 +08001792
1793#if defined(MBEDTLS_SSL_SRV_C)
Yanray Wang07517612023-11-07 11:47:36 +08001794void mbedtls_ssl_conf_max_early_data_size(
Gilles Peskine449bd832023-01-11 14:50:10 +01001795 mbedtls_ssl_config *conf, uint32_t max_early_data_size)
Jerry Yucc4e0072022-11-22 17:22:22 +08001796{
Jerry Yu39da9852022-12-06 16:58:36 +08001797 conf->max_early_data_size = max_early_data_size;
Jerry Yucc4e0072022-11-22 17:22:22 +08001798}
1799#endif /* MBEDTLS_SSL_SRV_C */
1800
Xiaokang Qian72de95d2022-10-25 02:54:33 +00001801#endif /* MBEDTLS_SSL_EARLY_DATA */
Ronald Cron6f135e12021-12-08 16:57:54 +01001802#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker71f1ed62021-07-24 06:01:47 +01001803
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001804#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001805void mbedtls_ssl_conf_cert_profile(mbedtls_ssl_config *conf,
1806 const mbedtls_x509_crt_profile *profile)
Manuel Pégourié-Gonnard6e3ee3a2015-06-17 10:58:20 +02001807{
1808 conf->cert_profile = profile;
1809}
1810
Gilles Peskine449bd832023-01-11 14:50:10 +01001811static void ssl_key_cert_free(mbedtls_ssl_key_cert *key_cert)
Glenn Strauss36872db2022-01-22 05:06:31 -05001812{
1813 mbedtls_ssl_key_cert *cur = key_cert, *next;
1814
Gilles Peskine449bd832023-01-11 14:50:10 +01001815 while (cur != NULL) {
Glenn Strauss36872db2022-01-22 05:06:31 -05001816 next = cur->next;
Gilles Peskine449bd832023-01-11 14:50:10 +01001817 mbedtls_free(cur);
Glenn Strauss36872db2022-01-22 05:06:31 -05001818 cur = next;
1819 }
1820}
1821
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001822/* Append a new keycert entry to a (possibly empty) list */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001823MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001824static int ssl_append_key_cert(mbedtls_ssl_key_cert **head,
1825 mbedtls_x509_crt *cert,
1826 mbedtls_pk_context *key)
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001827{
niisato8ee24222018-06-25 19:05:48 +09001828 mbedtls_ssl_key_cert *new_cert;
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001829
Gilles Peskine449bd832023-01-11 14:50:10 +01001830 if (cert == NULL) {
Glenn Strauss36872db2022-01-22 05:06:31 -05001831 /* Free list if cert is null */
Gilles Peskine449bd832023-01-11 14:50:10 +01001832 ssl_key_cert_free(*head);
Glenn Strauss36872db2022-01-22 05:06:31 -05001833 *head = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01001834 return 0;
Glenn Strauss36872db2022-01-22 05:06:31 -05001835 }
1836
Gilles Peskine449bd832023-01-11 14:50:10 +01001837 new_cert = mbedtls_calloc(1, sizeof(mbedtls_ssl_key_cert));
1838 if (new_cert == NULL) {
1839 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
1840 }
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001841
niisato8ee24222018-06-25 19:05:48 +09001842 new_cert->cert = cert;
1843 new_cert->key = key;
1844 new_cert->next = NULL;
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001845
Glenn Strauss36872db2022-01-22 05:06:31 -05001846 /* Update head if the list was null, else add to the end */
Gilles Peskine449bd832023-01-11 14:50:10 +01001847 if (*head == NULL) {
niisato8ee24222018-06-25 19:05:48 +09001848 *head = new_cert;
Gilles Peskine449bd832023-01-11 14:50:10 +01001849 } else {
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001850 mbedtls_ssl_key_cert *cur = *head;
Gilles Peskine449bd832023-01-11 14:50:10 +01001851 while (cur->next != NULL) {
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001852 cur = cur->next;
Gilles Peskine449bd832023-01-11 14:50:10 +01001853 }
niisato8ee24222018-06-25 19:05:48 +09001854 cur->next = new_cert;
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001855 }
1856
Gilles Peskine449bd832023-01-11 14:50:10 +01001857 return 0;
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001858}
1859
Gilles Peskine449bd832023-01-11 14:50:10 +01001860int mbedtls_ssl_conf_own_cert(mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001861 mbedtls_x509_crt *own_cert,
Gilles Peskine449bd832023-01-11 14:50:10 +01001862 mbedtls_pk_context *pk_key)
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001863{
Gilles Peskine449bd832023-01-11 14:50:10 +01001864 return ssl_append_key_cert(&conf->key_cert, own_cert, pk_key);
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001865}
1866
Gilles Peskine449bd832023-01-11 14:50:10 +01001867void mbedtls_ssl_conf_ca_chain(mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01001868 mbedtls_x509_crt *ca_chain,
Gilles Peskine449bd832023-01-11 14:50:10 +01001869 mbedtls_x509_crl *ca_crl)
Paul Bakker5121ce52009-01-03 21:22:43 +00001870{
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01001871 conf->ca_chain = ca_chain;
1872 conf->ca_crl = ca_crl;
Hanno Becker5adaad92019-03-27 16:54:37 +00001873
1874#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
1875 /* mbedtls_ssl_conf_ca_chain() and mbedtls_ssl_conf_ca_cb()
1876 * cannot be used together. */
1877 conf->f_ca_cb = NULL;
1878 conf->p_ca_cb = NULL;
1879#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
Paul Bakker5121ce52009-01-03 21:22:43 +00001880}
Hanno Becker5adaad92019-03-27 16:54:37 +00001881
1882#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
Gilles Peskine449bd832023-01-11 14:50:10 +01001883void mbedtls_ssl_conf_ca_cb(mbedtls_ssl_config *conf,
1884 mbedtls_x509_crt_ca_cb_t f_ca_cb,
1885 void *p_ca_cb)
Hanno Becker5adaad92019-03-27 16:54:37 +00001886{
1887 conf->f_ca_cb = f_ca_cb;
1888 conf->p_ca_cb = p_ca_cb;
1889
1890 /* mbedtls_ssl_conf_ca_chain() and mbedtls_ssl_conf_ca_cb()
1891 * cannot be used together. */
1892 conf->ca_chain = NULL;
1893 conf->ca_crl = NULL;
1894}
1895#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001896#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkereb2c6582012-09-27 19:15:01 +00001897
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001898#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01001899const unsigned char *mbedtls_ssl_get_hs_sni(mbedtls_ssl_context *ssl,
1900 size_t *name_len)
Glenn Strauss69894072022-01-24 12:58:00 -05001901{
1902 *name_len = ssl->handshake->sni_name_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01001903 return ssl->handshake->sni_name;
Glenn Strauss69894072022-01-24 12:58:00 -05001904}
1905
Gilles Peskine449bd832023-01-11 14:50:10 +01001906int mbedtls_ssl_set_hs_own_cert(mbedtls_ssl_context *ssl,
1907 mbedtls_x509_crt *own_cert,
1908 mbedtls_pk_context *pk_key)
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001909{
Gilles Peskine449bd832023-01-11 14:50:10 +01001910 return ssl_append_key_cert(&ssl->handshake->sni_key_cert,
1911 own_cert, pk_key);
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001912}
Manuel Pégourié-Gonnard22bfa4b2015-05-11 08:46:37 +02001913
Gilles Peskine449bd832023-01-11 14:50:10 +01001914void mbedtls_ssl_set_hs_ca_chain(mbedtls_ssl_context *ssl,
1915 mbedtls_x509_crt *ca_chain,
1916 mbedtls_x509_crl *ca_crl)
Manuel Pégourié-Gonnard22bfa4b2015-05-11 08:46:37 +02001917{
1918 ssl->handshake->sni_ca_chain = ca_chain;
1919 ssl->handshake->sni_ca_crl = ca_crl;
1920}
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +02001921
Glenn Strauss999ef702022-03-11 01:37:23 -05001922#if defined(MBEDTLS_KEY_EXCHANGE_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01001923void mbedtls_ssl_set_hs_dn_hints(mbedtls_ssl_context *ssl,
1924 const mbedtls_x509_crt *crt)
Glenn Strauss999ef702022-03-11 01:37:23 -05001925{
1926 ssl->handshake->dn_hints = crt;
1927}
1928#endif /* MBEDTLS_KEY_EXCHANGE_CERT_REQ_ALLOWED_ENABLED */
1929
Gilles Peskine449bd832023-01-11 14:50:10 +01001930void mbedtls_ssl_set_hs_authmode(mbedtls_ssl_context *ssl,
1931 int authmode)
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +02001932{
1933 ssl->handshake->sni_authmode = authmode;
1934}
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001935#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
1936
Hanno Becker8927c832019-04-03 12:52:50 +01001937#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001938void mbedtls_ssl_set_verify(mbedtls_ssl_context *ssl,
1939 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *),
1940 void *p_vrfy)
Hanno Becker8927c832019-04-03 12:52:50 +01001941{
1942 ssl->f_vrfy = f_vrfy;
1943 ssl->p_vrfy = p_vrfy;
1944}
1945#endif
1946
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02001947#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02001948
Valerio Setti016f6822022-12-09 14:17:50 +01001949#if defined(MBEDTLS_USE_PSA_CRYPTO)
Przemek Stekielfde11282023-03-13 16:06:09 +01001950static const uint8_t jpake_server_id[] = { 's', 'e', 'r', 'v', 'e', 'r' };
1951static const uint8_t jpake_client_id[] = { 'c', 'l', 'i', 'e', 'n', 't' };
1952
Valerio Setti016f6822022-12-09 14:17:50 +01001953static psa_status_t mbedtls_ssl_set_hs_ecjpake_password_common(
Gilles Peskine449bd832023-01-11 14:50:10 +01001954 mbedtls_ssl_context *ssl,
1955 mbedtls_svc_key_id_t pwd)
Valerio Setti016f6822022-12-09 14:17:50 +01001956{
1957 psa_status_t status;
Valerio Setti016f6822022-12-09 14:17:50 +01001958 psa_pake_cipher_suite_t cipher_suite = psa_pake_cipher_suite_init();
Przemek Stekielfde11282023-03-13 16:06:09 +01001959 const uint8_t *user = NULL;
Przemek Stekiel4cd20312023-03-01 11:11:28 +01001960 size_t user_len = 0;
Przemek Stekielfde11282023-03-13 16:06:09 +01001961 const uint8_t *peer = NULL;
Przemek Stekiel4cd20312023-03-01 11:11:28 +01001962 size_t peer_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01001963 psa_pake_cs_set_algorithm(&cipher_suite, PSA_ALG_JPAKE);
1964 psa_pake_cs_set_primitive(&cipher_suite,
1965 PSA_PAKE_PRIMITIVE(PSA_PAKE_PRIMITIVE_TYPE_ECC,
1966 PSA_ECC_FAMILY_SECP_R1,
1967 256));
1968 psa_pake_cs_set_hash(&cipher_suite, PSA_ALG_SHA_256);
Valerio Setti016f6822022-12-09 14:17:50 +01001969
Gilles Peskine449bd832023-01-11 14:50:10 +01001970 status = psa_pake_setup(&ssl->handshake->psa_pake_ctx, &cipher_suite);
1971 if (status != PSA_SUCCESS) {
Valerio Setti016f6822022-12-09 14:17:50 +01001972 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001973 }
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02001974
Gilles Peskine449bd832023-01-11 14:50:10 +01001975 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Przemek Stekielfde11282023-03-13 16:06:09 +01001976 user = jpake_server_id;
1977 user_len = sizeof(jpake_server_id);
1978 peer = jpake_client_id;
1979 peer_len = sizeof(jpake_client_id);
Gilles Peskine449bd832023-01-11 14:50:10 +01001980 } else {
Przemek Stekielfde11282023-03-13 16:06:09 +01001981 user = jpake_client_id;
1982 user_len = sizeof(jpake_client_id);
1983 peer = jpake_server_id;
1984 peer_len = sizeof(jpake_server_id);
Gilles Peskine449bd832023-01-11 14:50:10 +01001985 }
Neil Armstrongca7d5062022-05-31 14:43:23 +02001986
Przemek Stekiel4cd20312023-03-01 11:11:28 +01001987 status = psa_pake_set_user(&ssl->handshake->psa_pake_ctx, user, user_len);
1988 if (status != PSA_SUCCESS) {
1989 return status;
1990 }
1991
1992 status = psa_pake_set_peer(&ssl->handshake->psa_pake_ctx, peer, peer_len);
Gilles Peskine449bd832023-01-11 14:50:10 +01001993 if (status != PSA_SUCCESS) {
Valerio Setti016f6822022-12-09 14:17:50 +01001994 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001995 }
Valerio Setti016f6822022-12-09 14:17:50 +01001996
Gilles Peskine449bd832023-01-11 14:50:10 +01001997 status = psa_pake_set_password_key(&ssl->handshake->psa_pake_ctx, pwd);
1998 if (status != PSA_SUCCESS) {
Valerio Setti016f6822022-12-09 14:17:50 +01001999 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01002000 }
Valerio Setti016f6822022-12-09 14:17:50 +01002001
2002 ssl->handshake->psa_pake_ctx_is_ok = 1;
2003
Gilles Peskine449bd832023-01-11 14:50:10 +01002004 return PSA_SUCCESS;
Valerio Setti016f6822022-12-09 14:17:50 +01002005}
2006
Gilles Peskine449bd832023-01-11 14:50:10 +01002007int mbedtls_ssl_set_hs_ecjpake_password(mbedtls_ssl_context *ssl,
2008 const unsigned char *pw,
2009 size_t pw_len)
Valerio Setti016f6822022-12-09 14:17:50 +01002010{
2011 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
2012 psa_status_t status;
2013
Gilles Peskine449bd832023-01-11 14:50:10 +01002014 if (ssl->handshake == NULL || ssl->conf == NULL) {
2015 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Neil Armstrongca7d5062022-05-31 14:43:23 +02002016 }
2017
Gilles Peskine449bd832023-01-11 14:50:10 +01002018 /* Empty password is not valid */
2019 if ((pw == NULL) || (pw_len == 0)) {
2020 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2021 }
2022
2023 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_DERIVE);
2024 psa_set_key_algorithm(&attributes, PSA_ALG_JPAKE);
2025 psa_set_key_type(&attributes, PSA_KEY_TYPE_PASSWORD);
2026
2027 status = psa_import_key(&attributes, pw, pw_len,
2028 &ssl->handshake->psa_pake_password);
2029 if (status != PSA_SUCCESS) {
2030 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
2031 }
2032
2033 status = mbedtls_ssl_set_hs_ecjpake_password_common(ssl,
2034 ssl->handshake->psa_pake_password);
2035 if (status != PSA_SUCCESS) {
2036 psa_destroy_key(ssl->handshake->psa_pake_password);
2037 psa_pake_abort(&ssl->handshake->psa_pake_ctx);
2038 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
2039 }
2040
2041 return 0;
Valerio Setti02c25b52022-11-15 14:08:42 +01002042}
Valerio Settia9a97dc2022-11-28 18:26:16 +01002043
Gilles Peskine449bd832023-01-11 14:50:10 +01002044int mbedtls_ssl_set_hs_ecjpake_password_opaque(mbedtls_ssl_context *ssl,
2045 mbedtls_svc_key_id_t pwd)
Valerio Settia9a97dc2022-11-28 18:26:16 +01002046{
Valerio Settia9a97dc2022-11-28 18:26:16 +01002047 psa_status_t status;
2048
Gilles Peskine449bd832023-01-11 14:50:10 +01002049 if (ssl->handshake == NULL || ssl->conf == NULL) {
2050 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Neil Armstrongca7d5062022-05-31 14:43:23 +02002051 }
2052
Gilles Peskine449bd832023-01-11 14:50:10 +01002053 if (mbedtls_svc_key_id_is_null(pwd)) {
2054 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2055 }
2056
2057 status = mbedtls_ssl_set_hs_ecjpake_password_common(ssl, pwd);
2058 if (status != PSA_SUCCESS) {
2059 psa_pake_abort(&ssl->handshake->psa_pake_ctx);
2060 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
2061 }
2062
2063 return 0;
Valerio Setti02c25b52022-11-15 14:08:42 +01002064}
2065#else /* MBEDTLS_USE_PSA_CRYPTO */
Gilles Peskine449bd832023-01-11 14:50:10 +01002066int mbedtls_ssl_set_hs_ecjpake_password(mbedtls_ssl_context *ssl,
2067 const unsigned char *pw,
2068 size_t pw_len)
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002069{
2070 mbedtls_ecjpake_role role;
2071
Gilles Peskine449bd832023-01-11 14:50:10 +01002072 if (ssl->handshake == NULL || ssl->conf == NULL) {
2073 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2074 }
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002075
Valerio Settic689ed82022-12-07 14:40:38 +01002076 /* Empty password is not valid */
Gilles Peskine449bd832023-01-11 14:50:10 +01002077 if ((pw == NULL) || (pw_len == 0)) {
2078 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2079 }
Valerio Settic689ed82022-12-07 14:40:38 +01002080
Gilles Peskine449bd832023-01-11 14:50:10 +01002081 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002082 role = MBEDTLS_ECJPAKE_SERVER;
Gilles Peskine449bd832023-01-11 14:50:10 +01002083 } else {
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002084 role = MBEDTLS_ECJPAKE_CLIENT;
Gilles Peskine449bd832023-01-11 14:50:10 +01002085 }
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002086
Gilles Peskine449bd832023-01-11 14:50:10 +01002087 return mbedtls_ecjpake_setup(&ssl->handshake->ecjpake_ctx,
2088 role,
2089 MBEDTLS_MD_SHA256,
2090 MBEDTLS_ECP_DP_SECP256R1,
2091 pw, pw_len);
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002092}
Valerio Setti02c25b52022-11-15 14:08:42 +01002093#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02002094#endif /* MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED */
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002095
Ronald Cron73fe8df2022-10-05 14:31:43 +02002096#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01002097int mbedtls_ssl_conf_has_static_psk(mbedtls_ssl_config const *conf)
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002098{
Gilles Peskine449bd832023-01-11 14:50:10 +01002099 if (conf->psk_identity == NULL ||
2100 conf->psk_identity_len == 0) {
2101 return 0;
Ronald Crond29e13e2022-10-19 10:33:48 +02002102 }
2103
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002104#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01002105 if (!mbedtls_svc_key_id_is_null(conf->psk_opaque)) {
2106 return 1;
2107 }
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002108#endif /* MBEDTLS_USE_PSA_CRYPTO */
Ronald Crond29e13e2022-10-19 10:33:48 +02002109
Gilles Peskine449bd832023-01-11 14:50:10 +01002110 if (conf->psk != NULL && conf->psk_len != 0) {
2111 return 1;
2112 }
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002113
Gilles Peskine449bd832023-01-11 14:50:10 +01002114 return 0;
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002115}
2116
Gilles Peskine449bd832023-01-11 14:50:10 +01002117static void ssl_conf_remove_psk(mbedtls_ssl_config *conf)
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002118{
2119 /* Remove reference to existing PSK, if any. */
2120#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01002121 if (!mbedtls_svc_key_id_is_null(conf->psk_opaque)) {
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002122 /* The maintenance of the PSK key slot is the
2123 * user's responsibility. */
Ronald Croncf56a0a2020-08-04 09:51:30 +02002124 conf->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002125 }
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002126#endif /* MBEDTLS_USE_PSA_CRYPTO */
Gilles Peskine449bd832023-01-11 14:50:10 +01002127 if (conf->psk != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01002128 mbedtls_zeroize_and_free(conf->psk, conf->psk_len);
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002129 conf->psk = NULL;
2130 conf->psk_len = 0;
2131 }
2132
2133 /* Remove reference to PSK identity, if any. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002134 if (conf->psk_identity != NULL) {
2135 mbedtls_free(conf->psk_identity);
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002136 conf->psk_identity = NULL;
2137 conf->psk_identity_len = 0;
2138 }
2139}
2140
Hanno Becker7390c712018-11-15 13:33:04 +00002141/* This function assumes that PSK identity in the SSL config is unset.
2142 * It checks that the provided identity is well-formed and attempts
2143 * to make a copy of it in the SSL config.
2144 * On failure, the PSK identity in the config remains unset. */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002145MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002146static int ssl_conf_set_psk_identity(mbedtls_ssl_config *conf,
2147 unsigned char const *psk_identity,
2148 size_t psk_identity_len)
Paul Bakkerd4a56ec2013-04-16 18:05:29 +02002149{
Manuel Pégourié-Gonnardc6b5d832015-08-27 16:37:35 +02002150 /* Identity len will be encoded on two bytes */
Gilles Peskine449bd832023-01-11 14:50:10 +01002151 if (psk_identity == NULL ||
Ronald Cron2a87e9b2022-10-19 10:55:26 +02002152 psk_identity_len == 0 ||
Gilles Peskine449bd832023-01-11 14:50:10 +01002153 (psk_identity_len >> 16) != 0 ||
2154 psk_identity_len > MBEDTLS_SSL_OUT_CONTENT_LEN) {
2155 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnardc6b5d832015-08-27 16:37:35 +02002156 }
2157
Gilles Peskine449bd832023-01-11 14:50:10 +01002158 conf->psk_identity = mbedtls_calloc(1, psk_identity_len);
2159 if (conf->psk_identity == NULL) {
2160 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
2161 }
Paul Bakker6db455e2013-09-18 17:29:31 +02002162
Manuel Pégourié-Gonnard120fdbd2015-05-07 17:07:50 +01002163 conf->psk_identity_len = psk_identity_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01002164 memcpy(conf->psk_identity, psk_identity, conf->psk_identity_len);
Paul Bakker5ad403f2013-09-18 21:21:30 +02002165
Gilles Peskine449bd832023-01-11 14:50:10 +01002166 return 0;
Paul Bakker6db455e2013-09-18 17:29:31 +02002167}
2168
Gilles Peskine449bd832023-01-11 14:50:10 +01002169int mbedtls_ssl_conf_psk(mbedtls_ssl_config *conf,
2170 const unsigned char *psk, size_t psk_len,
2171 const unsigned char *psk_identity, size_t psk_identity_len)
Hanno Becker7390c712018-11-15 13:33:04 +00002172{
Janos Follath865b3eb2019-12-16 11:46:15 +00002173 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002174
2175 /* We currently only support one PSK, raw or opaque. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002176 if (mbedtls_ssl_conf_has_static_psk(conf)) {
2177 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
2178 }
Hanno Becker7390c712018-11-15 13:33:04 +00002179
2180 /* Check and set raw PSK */
Gilles Peskine449bd832023-01-11 14:50:10 +01002181 if (psk == NULL) {
2182 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2183 }
2184 if (psk_len == 0) {
2185 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2186 }
2187 if (psk_len > MBEDTLS_PSK_MAX_LEN) {
2188 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2189 }
Piotr Nowicki9926eaf2019-11-20 14:54:36 +01002190
Gilles Peskine449bd832023-01-11 14:50:10 +01002191 if ((conf->psk = mbedtls_calloc(1, psk_len)) == NULL) {
2192 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
2193 }
Hanno Becker7390c712018-11-15 13:33:04 +00002194 conf->psk_len = psk_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01002195 memcpy(conf->psk, psk, conf->psk_len);
Hanno Becker7390c712018-11-15 13:33:04 +00002196
2197 /* Check and set PSK Identity */
Gilles Peskine449bd832023-01-11 14:50:10 +01002198 ret = ssl_conf_set_psk_identity(conf, psk_identity, psk_identity_len);
2199 if (ret != 0) {
2200 ssl_conf_remove_psk(conf);
2201 }
Hanno Becker7390c712018-11-15 13:33:04 +00002202
Gilles Peskine449bd832023-01-11 14:50:10 +01002203 return ret;
Hanno Becker7390c712018-11-15 13:33:04 +00002204}
2205
Gilles Peskine449bd832023-01-11 14:50:10 +01002206static void ssl_remove_psk(mbedtls_ssl_context *ssl)
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002207{
2208#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01002209 if (!mbedtls_svc_key_id_is_null(ssl->handshake->psk_opaque)) {
Neil Armstrong501c9322022-05-03 09:35:09 +02002210 /* The maintenance of the external PSK key slot is the
2211 * user's responsibility. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002212 if (ssl->handshake->psk_opaque_is_internal) {
2213 psa_destroy_key(ssl->handshake->psk_opaque);
Neil Armstrong501c9322022-05-03 09:35:09 +02002214 ssl->handshake->psk_opaque_is_internal = 0;
2215 }
Ronald Croncf56a0a2020-08-04 09:51:30 +02002216 ssl->handshake->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002217 }
Neil Armstronge952a302022-05-03 10:22:14 +02002218#else
Gilles Peskine449bd832023-01-11 14:50:10 +01002219 if (ssl->handshake->psk != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01002220 mbedtls_zeroize_and_free(ssl->handshake->psk,
Gilles Peskine449bd832023-01-11 14:50:10 +01002221 ssl->handshake->psk_len);
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002222 ssl->handshake->psk_len = 0;
lhuang046d4d94f2024-06-11 12:37:02 -07002223 ssl->handshake->psk = NULL;
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002224 }
Neil Armstronge952a302022-05-03 10:22:14 +02002225#endif /* MBEDTLS_USE_PSA_CRYPTO */
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002226}
2227
Gilles Peskine449bd832023-01-11 14:50:10 +01002228int mbedtls_ssl_set_hs_psk(mbedtls_ssl_context *ssl,
2229 const unsigned char *psk, size_t psk_len)
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002230{
Neil Armstrong501c9322022-05-03 09:35:09 +02002231#if defined(MBEDTLS_USE_PSA_CRYPTO)
2232 psa_key_attributes_t key_attributes = psa_key_attributes_init();
Jerry Yu5d01c052022-08-17 10:18:10 +08002233 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Jerry Yu24b8c812022-08-20 19:06:56 +08002234 psa_algorithm_t alg = PSA_ALG_NONE;
Jerry Yu5d01c052022-08-17 10:18:10 +08002235 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Neil Armstrong501c9322022-05-03 09:35:09 +02002236#endif /* MBEDTLS_USE_PSA_CRYPTO */
2237
Gilles Peskine449bd832023-01-11 14:50:10 +01002238 if (psk == NULL || ssl->handshake == NULL) {
2239 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2240 }
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002241
Gilles Peskine449bd832023-01-11 14:50:10 +01002242 if (psk_len > MBEDTLS_PSK_MAX_LEN) {
2243 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2244 }
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002245
Gilles Peskine449bd832023-01-11 14:50:10 +01002246 ssl_remove_psk(ssl);
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002247
Neil Armstrong501c9322022-05-03 09:35:09 +02002248#if defined(MBEDTLS_USE_PSA_CRYPTO)
Jerry Yuccc68a42022-07-26 16:39:20 +08002249#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01002250 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_2) {
2251 if (ssl->handshake->ciphersuite_info->mac == MBEDTLS_MD_SHA384) {
2252 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_384);
2253 } else {
2254 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_256);
2255 }
2256 psa_set_key_usage_flags(&key_attributes, PSA_KEY_USAGE_DERIVE);
Jerry Yuccc68a42022-07-26 16:39:20 +08002257 }
2258#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Neil Armstrong501c9322022-05-03 09:35:09 +02002259
Jerry Yu568ec252022-07-22 21:27:34 +08002260#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01002261 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
2262 alg = PSA_ALG_HKDF_EXTRACT(PSA_ALG_ANY_HASH);
2263 psa_set_key_usage_flags(&key_attributes,
2264 PSA_KEY_USAGE_DERIVE | PSA_KEY_USAGE_EXPORT);
Jerry Yuccc68a42022-07-26 16:39:20 +08002265 }
2266#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
2267
Gilles Peskine449bd832023-01-11 14:50:10 +01002268 psa_set_key_algorithm(&key_attributes, alg);
2269 psa_set_key_type(&key_attributes, PSA_KEY_TYPE_DERIVE);
Neil Armstrong501c9322022-05-03 09:35:09 +02002270
Gilles Peskine449bd832023-01-11 14:50:10 +01002271 status = psa_import_key(&key_attributes, psk, psk_len, &key);
2272 if (status != PSA_SUCCESS) {
2273 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
2274 }
Neil Armstrong501c9322022-05-03 09:35:09 +02002275
2276 /* Allow calling psa_destroy_key() on psk remove */
2277 ssl->handshake->psk_opaque_is_internal = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01002278 return mbedtls_ssl_set_hs_psk_opaque(ssl, key);
Neil Armstrong501c9322022-05-03 09:35:09 +02002279#else
Gilles Peskine449bd832023-01-11 14:50:10 +01002280 if ((ssl->handshake->psk = mbedtls_calloc(1, psk_len)) == NULL) {
2281 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
2282 }
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002283
2284 ssl->handshake->psk_len = psk_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01002285 memcpy(ssl->handshake->psk, psk, ssl->handshake->psk_len);
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002286
Gilles Peskine449bd832023-01-11 14:50:10 +01002287 return 0;
Neil Armstrong501c9322022-05-03 09:35:09 +02002288#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002289}
2290
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002291#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01002292int mbedtls_ssl_conf_psk_opaque(mbedtls_ssl_config *conf,
2293 mbedtls_svc_key_id_t psk,
2294 const unsigned char *psk_identity,
2295 size_t psk_identity_len)
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002296{
Janos Follath865b3eb2019-12-16 11:46:15 +00002297 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002298
2299 /* We currently only support one PSK, raw or opaque. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002300 if (mbedtls_ssl_conf_has_static_psk(conf)) {
2301 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
2302 }
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002303
Hanno Becker7390c712018-11-15 13:33:04 +00002304 /* Check and set opaque PSK */
Gilles Peskine449bd832023-01-11 14:50:10 +01002305 if (mbedtls_svc_key_id_is_null(psk)) {
2306 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2307 }
Ronald Croncf56a0a2020-08-04 09:51:30 +02002308 conf->psk_opaque = psk;
Hanno Becker7390c712018-11-15 13:33:04 +00002309
2310 /* Check and set PSK Identity */
Gilles Peskine449bd832023-01-11 14:50:10 +01002311 ret = ssl_conf_set_psk_identity(conf, psk_identity,
2312 psk_identity_len);
2313 if (ret != 0) {
2314 ssl_conf_remove_psk(conf);
2315 }
Hanno Becker7390c712018-11-15 13:33:04 +00002316
Gilles Peskine449bd832023-01-11 14:50:10 +01002317 return ret;
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002318}
2319
Gilles Peskine449bd832023-01-11 14:50:10 +01002320int mbedtls_ssl_set_hs_psk_opaque(mbedtls_ssl_context *ssl,
2321 mbedtls_svc_key_id_t psk)
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002322{
Gilles Peskine449bd832023-01-11 14:50:10 +01002323 if ((mbedtls_svc_key_id_is_null(psk)) ||
2324 (ssl->handshake == NULL)) {
2325 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2326 }
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002327
Gilles Peskine449bd832023-01-11 14:50:10 +01002328 ssl_remove_psk(ssl);
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002329 ssl->handshake->psk_opaque = psk;
Gilles Peskine449bd832023-01-11 14:50:10 +01002330 return 0;
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002331}
2332#endif /* MBEDTLS_USE_PSA_CRYPTO */
2333
Jerry Yu8897c072022-08-12 13:56:53 +08002334#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002335void mbedtls_ssl_conf_psk_cb(mbedtls_ssl_config *conf,
2336 int (*f_psk)(void *, mbedtls_ssl_context *, const unsigned char *,
2337 size_t),
2338 void *p_psk)
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002339{
2340 conf->f_psk = f_psk;
2341 conf->p_psk = p_psk;
2342}
Jerry Yu8897c072022-08-12 13:56:53 +08002343#endif /* MBEDTLS_SSL_SRV_C */
2344
Ronald Cron73fe8df2022-10-05 14:31:43 +02002345#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED */
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002346
2347#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine301711e2022-04-26 16:57:05 +02002348static mbedtls_ssl_mode_t mbedtls_ssl_get_base_mode(
Gilles Peskine449bd832023-01-11 14:50:10 +01002349 psa_algorithm_t alg)
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002350{
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002351#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01002352 if (alg == PSA_ALG_CBC_NO_PADDING) {
2353 return MBEDTLS_SSL_MODE_CBC;
2354 }
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002355#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
Gilles Peskine449bd832023-01-11 14:50:10 +01002356 if (PSA_ALG_IS_AEAD(alg)) {
2357 return MBEDTLS_SSL_MODE_AEAD;
2358 }
2359 return MBEDTLS_SSL_MODE_STREAM;
Gilles Peskine301711e2022-04-26 16:57:05 +02002360}
2361
2362#else /* MBEDTLS_USE_PSA_CRYPTO */
2363
2364static mbedtls_ssl_mode_t mbedtls_ssl_get_base_mode(
Gilles Peskine449bd832023-01-11 14:50:10 +01002365 mbedtls_cipher_mode_t mode)
Gilles Peskine301711e2022-04-26 16:57:05 +02002366{
2367#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01002368 if (mode == MBEDTLS_MODE_CBC) {
2369 return MBEDTLS_SSL_MODE_CBC;
2370 }
Gilles Peskine301711e2022-04-26 16:57:05 +02002371#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
2372
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002373#if defined(MBEDTLS_GCM_C) || \
2374 defined(MBEDTLS_CCM_C) || \
2375 defined(MBEDTLS_CHACHAPOLY_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002376 if (mode == MBEDTLS_MODE_GCM ||
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002377 mode == MBEDTLS_MODE_CCM ||
Gilles Peskine449bd832023-01-11 14:50:10 +01002378 mode == MBEDTLS_MODE_CHACHAPOLY) {
2379 return MBEDTLS_SSL_MODE_AEAD;
2380 }
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002381#endif /* MBEDTLS_GCM_C || MBEDTLS_CCM_C || MBEDTLS_CHACHAPOLY_C */
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002382
Gilles Peskine449bd832023-01-11 14:50:10 +01002383 return MBEDTLS_SSL_MODE_STREAM;
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002384}
Gilles Peskine301711e2022-04-26 16:57:05 +02002385#endif /* MBEDTLS_USE_PSA_CRYPTO */
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002386
Gilles Peskinee108d982022-04-26 16:50:40 +02002387static mbedtls_ssl_mode_t mbedtls_ssl_get_actual_mode(
2388 mbedtls_ssl_mode_t base_mode,
Gilles Peskine449bd832023-01-11 14:50:10 +01002389 int encrypt_then_mac)
Gilles Peskinee108d982022-04-26 16:50:40 +02002390{
2391#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01002392 if (encrypt_then_mac == MBEDTLS_SSL_ETM_ENABLED &&
2393 base_mode == MBEDTLS_SSL_MODE_CBC) {
2394 return MBEDTLS_SSL_MODE_CBC_ETM;
Gilles Peskinee108d982022-04-26 16:50:40 +02002395 }
2396#else
2397 (void) encrypt_then_mac;
2398#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002399 return base_mode;
Gilles Peskinee108d982022-04-26 16:50:40 +02002400}
2401
Neil Armstrongab555e02022-04-04 11:07:59 +02002402mbedtls_ssl_mode_t mbedtls_ssl_get_mode_from_transform(
Gilles Peskine449bd832023-01-11 14:50:10 +01002403 const mbedtls_ssl_transform *transform)
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002404{
Gilles Peskinee108d982022-04-26 16:50:40 +02002405 mbedtls_ssl_mode_t base_mode = mbedtls_ssl_get_base_mode(
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002406#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01002407 transform->psa_alg
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002408#else
Gilles Peskine449bd832023-01-11 14:50:10 +01002409 mbedtls_cipher_get_cipher_mode(&transform->cipher_ctx_enc)
Gilles Peskinee108d982022-04-26 16:50:40 +02002410#endif
2411 );
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002412
Gilles Peskinee108d982022-04-26 16:50:40 +02002413 int encrypt_then_mac = 0;
Neil Armstrongf2c82f02022-04-05 11:16:53 +02002414#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskinee108d982022-04-26 16:50:40 +02002415 encrypt_then_mac = transform->encrypt_then_mac;
2416#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002417 return mbedtls_ssl_get_actual_mode(base_mode, encrypt_then_mac);
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002418}
2419
Neil Armstrongab555e02022-04-04 11:07:59 +02002420mbedtls_ssl_mode_t mbedtls_ssl_get_mode_from_ciphersuite(
Neil Armstrongf2c82f02022-04-05 11:16:53 +02002421#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01002422 int encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02002423#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01002424 const mbedtls_ssl_ciphersuite_t *suite)
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002425{
Gilles Peskinee108d982022-04-26 16:50:40 +02002426 mbedtls_ssl_mode_t base_mode = MBEDTLS_SSL_MODE_STREAM;
2427
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002428#if defined(MBEDTLS_USE_PSA_CRYPTO)
2429 psa_status_t status;
2430 psa_algorithm_t alg;
2431 psa_key_type_t type;
2432 size_t size;
Dave Rodgman2eab4622023-10-05 13:30:37 +01002433 status = mbedtls_ssl_cipher_to_psa((mbedtls_cipher_type_t) suite->cipher,
2434 0, &alg, &type, &size);
Gilles Peskine449bd832023-01-11 14:50:10 +01002435 if (status == PSA_SUCCESS) {
2436 base_mode = mbedtls_ssl_get_base_mode(alg);
2437 }
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002438#else
2439 const mbedtls_cipher_info_t *cipher =
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01002440 mbedtls_cipher_info_from_type((mbedtls_cipher_type_t) suite->cipher);
Gilles Peskine449bd832023-01-11 14:50:10 +01002441 if (cipher != NULL) {
Gilles Peskinee108d982022-04-26 16:50:40 +02002442 base_mode =
2443 mbedtls_ssl_get_base_mode(
Gilles Peskine449bd832023-01-11 14:50:10 +01002444 mbedtls_cipher_info_get_mode(cipher));
Gilles Peskinee108d982022-04-26 16:50:40 +02002445 }
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002446#endif /* MBEDTLS_USE_PSA_CRYPTO */
2447
Gilles Peskinee108d982022-04-26 16:50:40 +02002448#if !defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
2449 int encrypt_then_mac = 0;
2450#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002451 return mbedtls_ssl_get_actual_mode(base_mode, encrypt_then_mac);
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002452}
2453
Neil Armstrong8395d7a2022-05-18 11:44:56 +02002454#if defined(MBEDTLS_USE_PSA_CRYPTO) || defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yu251a12e2022-07-13 15:15:48 +08002455
Gilles Peskine449bd832023-01-11 14:50:10 +01002456psa_status_t mbedtls_ssl_cipher_to_psa(mbedtls_cipher_type_t mbedtls_cipher_type,
2457 size_t taglen,
2458 psa_algorithm_t *alg,
2459 psa_key_type_t *key_type,
2460 size_t *key_size)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002461{
Yanray Wang19e4dc82023-11-16 18:02:05 +08002462#if !defined(MBEDTLS_SSL_HAVE_CCM)
2463 (void) taglen;
2464#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002465 switch (mbedtls_cipher_type) {
Yanray Wang1a369d62023-11-16 15:17:31 +08002466#if defined(MBEDTLS_SSL_HAVE_AES) && defined(MBEDTLS_SSL_HAVE_CBC)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002467 case MBEDTLS_CIPHER_AES_128_CBC:
2468 *alg = PSA_ALG_CBC_NO_PADDING;
2469 *key_type = PSA_KEY_TYPE_AES;
2470 *key_size = 128;
2471 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002472#endif
2473#if defined(MBEDTLS_SSL_HAVE_AES) && defined(MBEDTLS_SSL_HAVE_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002474 case MBEDTLS_CIPHER_AES_128_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002475 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002476 *key_type = PSA_KEY_TYPE_AES;
2477 *key_size = 128;
2478 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002479#endif
2480#if defined(MBEDTLS_SSL_HAVE_AES) && defined(MBEDTLS_SSL_HAVE_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002481 case MBEDTLS_CIPHER_AES_128_GCM:
2482 *alg = PSA_ALG_GCM;
2483 *key_type = PSA_KEY_TYPE_AES;
2484 *key_size = 128;
2485 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002486#endif
2487#if defined(MBEDTLS_SSL_HAVE_AES) && defined(MBEDTLS_SSL_HAVE_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002488 case MBEDTLS_CIPHER_AES_192_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002489 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002490 *key_type = PSA_KEY_TYPE_AES;
2491 *key_size = 192;
2492 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002493#endif
2494#if defined(MBEDTLS_SSL_HAVE_AES) && defined(MBEDTLS_SSL_HAVE_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002495 case MBEDTLS_CIPHER_AES_192_GCM:
2496 *alg = PSA_ALG_GCM;
2497 *key_type = PSA_KEY_TYPE_AES;
2498 *key_size = 192;
2499 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002500#endif
2501#if defined(MBEDTLS_SSL_HAVE_AES) && defined(MBEDTLS_SSL_HAVE_CBC)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002502 case MBEDTLS_CIPHER_AES_256_CBC:
2503 *alg = PSA_ALG_CBC_NO_PADDING;
2504 *key_type = PSA_KEY_TYPE_AES;
2505 *key_size = 256;
2506 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002507#endif
2508#if defined(MBEDTLS_SSL_HAVE_AES) && defined(MBEDTLS_SSL_HAVE_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002509 case MBEDTLS_CIPHER_AES_256_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002510 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002511 *key_type = PSA_KEY_TYPE_AES;
2512 *key_size = 256;
2513 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002514#endif
2515#if defined(MBEDTLS_SSL_HAVE_AES) && defined(MBEDTLS_SSL_HAVE_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002516 case MBEDTLS_CIPHER_AES_256_GCM:
2517 *alg = PSA_ALG_GCM;
2518 *key_type = PSA_KEY_TYPE_AES;
2519 *key_size = 256;
2520 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002521#endif
2522#if defined(MBEDTLS_SSL_HAVE_ARIA) && defined(MBEDTLS_SSL_HAVE_CBC)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002523 case MBEDTLS_CIPHER_ARIA_128_CBC:
2524 *alg = PSA_ALG_CBC_NO_PADDING;
2525 *key_type = PSA_KEY_TYPE_ARIA;
2526 *key_size = 128;
2527 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002528#endif
2529#if defined(MBEDTLS_SSL_HAVE_ARIA) && defined(MBEDTLS_SSL_HAVE_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002530 case MBEDTLS_CIPHER_ARIA_128_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002531 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002532 *key_type = PSA_KEY_TYPE_ARIA;
2533 *key_size = 128;
2534 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002535#endif
2536#if defined(MBEDTLS_SSL_HAVE_ARIA) && defined(MBEDTLS_SSL_HAVE_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002537 case MBEDTLS_CIPHER_ARIA_128_GCM:
2538 *alg = PSA_ALG_GCM;
2539 *key_type = PSA_KEY_TYPE_ARIA;
2540 *key_size = 128;
2541 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002542#endif
2543#if defined(MBEDTLS_SSL_HAVE_ARIA) && defined(MBEDTLS_SSL_HAVE_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002544 case MBEDTLS_CIPHER_ARIA_192_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002545 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002546 *key_type = PSA_KEY_TYPE_ARIA;
2547 *key_size = 192;
2548 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002549#endif
2550#if defined(MBEDTLS_SSL_HAVE_ARIA) && defined(MBEDTLS_SSL_HAVE_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002551 case MBEDTLS_CIPHER_ARIA_192_GCM:
2552 *alg = PSA_ALG_GCM;
2553 *key_type = PSA_KEY_TYPE_ARIA;
2554 *key_size = 192;
2555 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002556#endif
2557#if defined(MBEDTLS_SSL_HAVE_ARIA) && defined(MBEDTLS_SSL_HAVE_CBC)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002558 case MBEDTLS_CIPHER_ARIA_256_CBC:
2559 *alg = PSA_ALG_CBC_NO_PADDING;
2560 *key_type = PSA_KEY_TYPE_ARIA;
2561 *key_size = 256;
2562 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002563#endif
2564#if defined(MBEDTLS_SSL_HAVE_ARIA) && defined(MBEDTLS_SSL_HAVE_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002565 case MBEDTLS_CIPHER_ARIA_256_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002566 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002567 *key_type = PSA_KEY_TYPE_ARIA;
2568 *key_size = 256;
2569 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002570#endif
2571#if defined(MBEDTLS_SSL_HAVE_ARIA) && defined(MBEDTLS_SSL_HAVE_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002572 case MBEDTLS_CIPHER_ARIA_256_GCM:
2573 *alg = PSA_ALG_GCM;
2574 *key_type = PSA_KEY_TYPE_ARIA;
2575 *key_size = 256;
2576 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002577#endif
2578#if defined(MBEDTLS_SSL_HAVE_CAMELLIA) && defined(MBEDTLS_SSL_HAVE_CBC)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002579 case MBEDTLS_CIPHER_CAMELLIA_128_CBC:
2580 *alg = PSA_ALG_CBC_NO_PADDING;
2581 *key_type = PSA_KEY_TYPE_CAMELLIA;
2582 *key_size = 128;
2583 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002584#endif
2585#if defined(MBEDTLS_SSL_HAVE_CAMELLIA) && defined(MBEDTLS_SSL_HAVE_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002586 case MBEDTLS_CIPHER_CAMELLIA_128_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002587 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002588 *key_type = PSA_KEY_TYPE_CAMELLIA;
2589 *key_size = 128;
2590 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002591#endif
2592#if defined(MBEDTLS_SSL_HAVE_CAMELLIA) && defined(MBEDTLS_SSL_HAVE_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002593 case MBEDTLS_CIPHER_CAMELLIA_128_GCM:
2594 *alg = PSA_ALG_GCM;
2595 *key_type = PSA_KEY_TYPE_CAMELLIA;
2596 *key_size = 128;
2597 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002598#endif
2599#if defined(MBEDTLS_SSL_HAVE_CAMELLIA) && defined(MBEDTLS_SSL_HAVE_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002600 case MBEDTLS_CIPHER_CAMELLIA_192_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002601 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002602 *key_type = PSA_KEY_TYPE_CAMELLIA;
2603 *key_size = 192;
2604 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002605#endif
2606#if defined(MBEDTLS_SSL_HAVE_CAMELLIA) && defined(MBEDTLS_SSL_HAVE_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002607 case MBEDTLS_CIPHER_CAMELLIA_192_GCM:
2608 *alg = PSA_ALG_GCM;
2609 *key_type = PSA_KEY_TYPE_CAMELLIA;
2610 *key_size = 192;
2611 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002612#endif
2613#if defined(MBEDTLS_SSL_HAVE_CAMELLIA) && defined(MBEDTLS_SSL_HAVE_CBC)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002614 case MBEDTLS_CIPHER_CAMELLIA_256_CBC:
2615 *alg = PSA_ALG_CBC_NO_PADDING;
2616 *key_type = PSA_KEY_TYPE_CAMELLIA;
2617 *key_size = 256;
2618 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002619#endif
2620#if defined(MBEDTLS_SSL_HAVE_CAMELLIA) && defined(MBEDTLS_SSL_HAVE_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002621 case MBEDTLS_CIPHER_CAMELLIA_256_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002622 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002623 *key_type = PSA_KEY_TYPE_CAMELLIA;
2624 *key_size = 256;
2625 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002626#endif
2627#if defined(MBEDTLS_SSL_HAVE_CAMELLIA) && defined(MBEDTLS_SSL_HAVE_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002628 case MBEDTLS_CIPHER_CAMELLIA_256_GCM:
2629 *alg = PSA_ALG_GCM;
2630 *key_type = PSA_KEY_TYPE_CAMELLIA;
2631 *key_size = 256;
2632 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002633#endif
2634#if defined(MBEDTLS_SSL_HAVE_CHACHAPOLY)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002635 case MBEDTLS_CIPHER_CHACHA20_POLY1305:
2636 *alg = PSA_ALG_CHACHA20_POLY1305;
2637 *key_type = PSA_KEY_TYPE_CHACHA20;
2638 *key_size = 256;
2639 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002640#endif
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002641 case MBEDTLS_CIPHER_NULL:
2642 *alg = MBEDTLS_SSL_NULL_CIPHER;
2643 *key_type = 0;
2644 *key_size = 0;
2645 break;
2646 default:
2647 return PSA_ERROR_NOT_SUPPORTED;
2648 }
2649
2650 return PSA_SUCCESS;
2651}
Neil Armstrong8395d7a2022-05-18 11:44:56 +02002652#endif /* MBEDTLS_USE_PSA_CRYPTO || MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002653
Manuel Pégourié-Gonnardcf141ca2015-05-20 10:35:51 +02002654#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002655int mbedtls_ssl_conf_dh_param_bin(mbedtls_ssl_config *conf,
2656 const unsigned char *dhm_P, size_t P_len,
2657 const unsigned char *dhm_G, size_t G_len)
Hanno Beckera90658f2017-10-04 15:29:08 +01002658{
Janos Follath865b3eb2019-12-16 11:46:15 +00002659 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Beckera90658f2017-10-04 15:29:08 +01002660
Gilles Peskine449bd832023-01-11 14:50:10 +01002661 mbedtls_mpi_free(&conf->dhm_P);
2662 mbedtls_mpi_free(&conf->dhm_G);
Glenn Strausscee11292021-12-20 01:43:17 -05002663
Gilles Peskine449bd832023-01-11 14:50:10 +01002664 if ((ret = mbedtls_mpi_read_binary(&conf->dhm_P, dhm_P, P_len)) != 0 ||
2665 (ret = mbedtls_mpi_read_binary(&conf->dhm_G, dhm_G, G_len)) != 0) {
2666 mbedtls_mpi_free(&conf->dhm_P);
2667 mbedtls_mpi_free(&conf->dhm_G);
2668 return ret;
Hanno Beckera90658f2017-10-04 15:29:08 +01002669 }
2670
Gilles Peskine449bd832023-01-11 14:50:10 +01002671 return 0;
Hanno Beckera90658f2017-10-04 15:29:08 +01002672}
Paul Bakker5121ce52009-01-03 21:22:43 +00002673
Gilles Peskine449bd832023-01-11 14:50:10 +01002674int mbedtls_ssl_conf_dh_param_ctx(mbedtls_ssl_config *conf, mbedtls_dhm_context *dhm_ctx)
Paul Bakker1b57b062011-01-06 15:48:19 +00002675{
Janos Follath865b3eb2019-12-16 11:46:15 +00002676 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker1b57b062011-01-06 15:48:19 +00002677
Gilles Peskine449bd832023-01-11 14:50:10 +01002678 mbedtls_mpi_free(&conf->dhm_P);
2679 mbedtls_mpi_free(&conf->dhm_G);
Glenn Strausscee11292021-12-20 01:43:17 -05002680
Gilles Peskine449bd832023-01-11 14:50:10 +01002681 if ((ret = mbedtls_dhm_get_value(dhm_ctx, MBEDTLS_DHM_PARAM_P,
2682 &conf->dhm_P)) != 0 ||
2683 (ret = mbedtls_dhm_get_value(dhm_ctx, MBEDTLS_DHM_PARAM_G,
2684 &conf->dhm_G)) != 0) {
2685 mbedtls_mpi_free(&conf->dhm_P);
2686 mbedtls_mpi_free(&conf->dhm_G);
2687 return ret;
Manuel Pégourié-Gonnard1028b742015-05-06 17:33:07 +01002688 }
Paul Bakker1b57b062011-01-06 15:48:19 +00002689
Gilles Peskine449bd832023-01-11 14:50:10 +01002690 return 0;
Paul Bakker1b57b062011-01-06 15:48:19 +00002691}
Manuel Pégourié-Gonnardcf141ca2015-05-20 10:35:51 +02002692#endif /* MBEDTLS_DHM_C && MBEDTLS_SSL_SRV_C */
Paul Bakker1b57b062011-01-06 15:48:19 +00002693
Manuel Pégourié-Gonnardbd990d62015-06-11 14:49:42 +02002694#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_CLI_C)
2695/*
2696 * Set the minimum length for Diffie-Hellman parameters
2697 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002698void mbedtls_ssl_conf_dhm_min_bitlen(mbedtls_ssl_config *conf,
2699 unsigned int bitlen)
Manuel Pégourié-Gonnardbd990d62015-06-11 14:49:42 +02002700{
2701 conf->dhm_min_bitlen = bitlen;
2702}
2703#endif /* MBEDTLS_DHM_C && MBEDTLS_SSL_CLI_C */
2704
Ronald Crone68ab4f2022-10-05 12:46:29 +02002705#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu7ddc38c2022-01-19 11:08:05 +08002706#if !defined(MBEDTLS_DEPRECATED_REMOVED) && defined(MBEDTLS_SSL_PROTO_TLS1_2)
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02002707/*
2708 * Set allowed/preferred hashes for handshake signatures
2709 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002710void mbedtls_ssl_conf_sig_hashes(mbedtls_ssl_config *conf,
2711 const int *hashes)
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02002712{
2713 conf->sig_hashes = hashes;
2714}
Jerry Yu7ddc38c2022-01-19 11:08:05 +08002715#endif /* !MBEDTLS_DEPRECATED_REMOVED && MBEDTLS_SSL_PROTO_TLS1_2 */
Hanno Becker1cd6e002021-08-10 13:27:10 +01002716
Jerry Yuf017ee42022-01-12 15:49:48 +08002717/* Configure allowed signature algorithms for handshake */
Gilles Peskine449bd832023-01-11 14:50:10 +01002718void mbedtls_ssl_conf_sig_algs(mbedtls_ssl_config *conf,
2719 const uint16_t *sig_algs)
Hanno Becker1cd6e002021-08-10 13:27:10 +01002720{
Jerry Yuf017ee42022-01-12 15:49:48 +08002721#if !defined(MBEDTLS_DEPRECATED_REMOVED)
2722 conf->sig_hashes = NULL;
2723#endif /* !MBEDTLS_DEPRECATED_REMOVED */
2724 conf->sig_algs = sig_algs;
Hanno Becker1cd6e002021-08-10 13:27:10 +01002725}
Ronald Crone68ab4f2022-10-05 12:46:29 +02002726#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02002727
Manuel Pégourié-Gonnardf07ce3b2023-09-22 11:53:41 +02002728#if defined(MBEDTLS_ECP_C)
Brett Warrene0edc842021-08-17 09:53:13 +01002729#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002730/*
2731 * Set the allowed elliptic curves
Brett Warrene0edc842021-08-17 09:53:13 +01002732 *
2733 * mbedtls_ssl_setup() takes the provided list
2734 * and translates it to a list of IANA TLS group identifiers,
2735 * stored in ssl->handshake->group_list.
2736 *
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002737 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002738void mbedtls_ssl_conf_curves(mbedtls_ssl_config *conf,
2739 const mbedtls_ecp_group_id *curve_list)
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002740{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002741 conf->curve_list = curve_list;
Brett Warrene0edc842021-08-17 09:53:13 +01002742 conf->group_list = NULL;
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002743}
Brett Warrene0edc842021-08-17 09:53:13 +01002744#endif /* MBEDTLS_DEPRECATED_REMOVED */
Manuel Pégourié-Gonnardf07ce3b2023-09-22 11:53:41 +02002745#endif /* MBEDTLS_ECP_C */
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002746
Brett Warrene0edc842021-08-17 09:53:13 +01002747/*
2748 * Set the allowed groups
2749 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002750void mbedtls_ssl_conf_groups(mbedtls_ssl_config *conf,
2751 const uint16_t *group_list)
Brett Warrene0edc842021-08-17 09:53:13 +01002752{
Manuel Pégourié-Gonnardf07ce3b2023-09-22 11:53:41 +02002753#if defined(MBEDTLS_ECP_C) && !defined(MBEDTLS_DEPRECATED_REMOVED)
Brett Warrene0edc842021-08-17 09:53:13 +01002754 conf->curve_list = NULL;
2755#endif
2756 conf->group_list = group_list;
2757}
2758
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01002759#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002760int mbedtls_ssl_set_hostname(mbedtls_ssl_context *ssl, const char *hostname)
Paul Bakker5121ce52009-01-03 21:22:43 +00002761{
Hanno Becker947194e2017-04-07 13:25:49 +01002762 /* Initialize to suppress unnecessary compiler warning */
2763 size_t hostname_len = 0;
2764
2765 /* Check if new hostname is valid before
2766 * making any change to current one */
Gilles Peskine449bd832023-01-11 14:50:10 +01002767 if (hostname != NULL) {
2768 hostname_len = strlen(hostname);
Hanno Becker947194e2017-04-07 13:25:49 +01002769
Gilles Peskine449bd832023-01-11 14:50:10 +01002770 if (hostname_len > MBEDTLS_SSL_MAX_HOST_NAME_LEN) {
2771 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2772 }
Hanno Becker947194e2017-04-07 13:25:49 +01002773 }
2774
2775 /* Now it's clear that we will overwrite the old hostname,
2776 * so we can free it safely */
2777
Gilles Peskine449bd832023-01-11 14:50:10 +01002778 if (ssl->hostname != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01002779 mbedtls_zeroize_and_free(ssl->hostname, strlen(ssl->hostname));
Hanno Becker947194e2017-04-07 13:25:49 +01002780 }
2781
2782 /* Passing NULL as hostname shall clear the old one */
Manuel Pégourié-Gonnardba26c242015-05-06 10:47:06 +01002783
Gilles Peskine449bd832023-01-11 14:50:10 +01002784 if (hostname == NULL) {
Hanno Becker947194e2017-04-07 13:25:49 +01002785 ssl->hostname = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01002786 } else {
2787 ssl->hostname = mbedtls_calloc(1, hostname_len + 1);
2788 if (ssl->hostname == NULL) {
2789 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
2790 }
Paul Bakker75c1a6f2013-08-19 14:25:29 +02002791
Gilles Peskine449bd832023-01-11 14:50:10 +01002792 memcpy(ssl->hostname, hostname, hostname_len);
Paul Bakker75c1a6f2013-08-19 14:25:29 +02002793
Hanno Becker947194e2017-04-07 13:25:49 +01002794 ssl->hostname[hostname_len] = '\0';
2795 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002796
Gilles Peskine449bd832023-01-11 14:50:10 +01002797 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00002798}
Hanno Becker1a9a51c2017-04-07 13:02:16 +01002799#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00002800
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01002801#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01002802void mbedtls_ssl_conf_sni(mbedtls_ssl_config *conf,
2803 int (*f_sni)(void *, mbedtls_ssl_context *,
2804 const unsigned char *, size_t),
2805 void *p_sni)
Paul Bakker5701cdc2012-09-27 21:49:42 +00002806{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002807 conf->f_sni = f_sni;
2808 conf->p_sni = p_sni;
Paul Bakker5701cdc2012-09-27 21:49:42 +00002809}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002810#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
Paul Bakker5701cdc2012-09-27 21:49:42 +00002811
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002812#if defined(MBEDTLS_SSL_ALPN)
Gilles Peskine449bd832023-01-11 14:50:10 +01002813int mbedtls_ssl_conf_alpn_protocols(mbedtls_ssl_config *conf, const char **protos)
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002814{
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002815 size_t cur_len, tot_len;
2816 const char **p;
2817
2818 /*
Brian J Murray1903fb32016-11-06 04:45:15 -08002819 * RFC 7301 3.1: "Empty strings MUST NOT be included and byte strings
2820 * MUST NOT be truncated."
2821 * We check lengths now rather than later.
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002822 */
2823 tot_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01002824 for (p = protos; *p != NULL; p++) {
2825 cur_len = strlen(*p);
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002826 tot_len += cur_len;
2827
Gilles Peskine449bd832023-01-11 14:50:10 +01002828 if ((cur_len == 0) ||
2829 (cur_len > MBEDTLS_SSL_MAX_ALPN_NAME_LEN) ||
2830 (tot_len > MBEDTLS_SSL_MAX_ALPN_LIST_LEN)) {
2831 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2832 }
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002833 }
2834
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002835 conf->alpn_list = protos;
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002836
Gilles Peskine449bd832023-01-11 14:50:10 +01002837 return 0;
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002838}
2839
Gilles Peskine449bd832023-01-11 14:50:10 +01002840const char *mbedtls_ssl_get_alpn_protocol(const mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002841{
Gilles Peskine449bd832023-01-11 14:50:10 +01002842 return ssl->alpn_chosen;
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002843}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002844#endif /* MBEDTLS_SSL_ALPN */
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002845
Johan Pascalb62bb512015-12-03 21:56:45 +01002846#if defined(MBEDTLS_SSL_DTLS_SRTP)
Gilles Peskine449bd832023-01-11 14:50:10 +01002847void mbedtls_ssl_conf_srtp_mki_value_supported(mbedtls_ssl_config *conf,
2848 int support_mki_value)
Ron Eldor591f1622018-01-22 12:30:04 +02002849{
2850 conf->dtls_srtp_mki_support = support_mki_value;
2851}
2852
Gilles Peskine449bd832023-01-11 14:50:10 +01002853int mbedtls_ssl_dtls_srtp_set_mki_value(mbedtls_ssl_context *ssl,
2854 unsigned char *mki_value,
2855 uint16_t mki_len)
Ron Eldor591f1622018-01-22 12:30:04 +02002856{
Gilles Peskine449bd832023-01-11 14:50:10 +01002857 if (mki_len > MBEDTLS_TLS_SRTP_MAX_MKI_LENGTH) {
2858 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Ron Eldora9788042018-12-05 11:04:31 +02002859 }
Ron Eldor591f1622018-01-22 12:30:04 +02002860
Gilles Peskine449bd832023-01-11 14:50:10 +01002861 if (ssl->conf->dtls_srtp_mki_support == MBEDTLS_SSL_DTLS_SRTP_MKI_UNSUPPORTED) {
2862 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Ron Eldora9788042018-12-05 11:04:31 +02002863 }
Ron Eldor591f1622018-01-22 12:30:04 +02002864
Gilles Peskine449bd832023-01-11 14:50:10 +01002865 memcpy(ssl->dtls_srtp_info.mki_value, mki_value, mki_len);
Ron Eldor591f1622018-01-22 12:30:04 +02002866 ssl->dtls_srtp_info.mki_len = mki_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01002867 return 0;
Ron Eldor591f1622018-01-22 12:30:04 +02002868}
2869
Gilles Peskine449bd832023-01-11 14:50:10 +01002870int mbedtls_ssl_conf_dtls_srtp_protection_profiles(mbedtls_ssl_config *conf,
2871 const mbedtls_ssl_srtp_profile *profiles)
Johan Pascalb62bb512015-12-03 21:56:45 +01002872{
Johan Pascal253d0262020-09-22 13:04:45 +02002873 const mbedtls_ssl_srtp_profile *p;
2874 size_t list_size = 0;
Johan Pascalb62bb512015-12-03 21:56:45 +01002875
Johan Pascal253d0262020-09-22 13:04:45 +02002876 /* check the profiles list: all entry must be valid,
2877 * its size cannot be more than the total number of supported profiles, currently 4 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002878 for (p = profiles; *p != MBEDTLS_TLS_SRTP_UNSET &&
2879 list_size <= MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH;
2880 p++) {
2881 if (mbedtls_ssl_check_srtp_profile_value(*p) != MBEDTLS_TLS_SRTP_UNSET) {
Johan Pascal76fdf1d2020-10-22 23:31:00 +02002882 list_size++;
Gilles Peskine449bd832023-01-11 14:50:10 +01002883 } else {
Johan Pascal76fdf1d2020-10-22 23:31:00 +02002884 /* unsupported value, stop parsing and set the size to an error value */
2885 list_size = MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH + 1;
Johan Pascalb62bb512015-12-03 21:56:45 +01002886 }
2887 }
2888
Gilles Peskine449bd832023-01-11 14:50:10 +01002889 if (list_size > MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH) {
2890 conf->dtls_srtp_profile_list = NULL;
2891 conf->dtls_srtp_profile_list_len = 0;
2892 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Johan Pascal253d0262020-09-22 13:04:45 +02002893 }
2894
Johan Pascal9bc97ca2020-09-21 23:44:45 +02002895 conf->dtls_srtp_profile_list = profiles;
Johan Pascal253d0262020-09-22 13:04:45 +02002896 conf->dtls_srtp_profile_list_len = list_size;
Johan Pascalb62bb512015-12-03 21:56:45 +01002897
Gilles Peskine449bd832023-01-11 14:50:10 +01002898 return 0;
Johan Pascalb62bb512015-12-03 21:56:45 +01002899}
2900
Gilles Peskine449bd832023-01-11 14:50:10 +01002901void mbedtls_ssl_get_dtls_srtp_negotiation_result(const mbedtls_ssl_context *ssl,
2902 mbedtls_dtls_srtp_info *dtls_srtp_info)
Johan Pascalb62bb512015-12-03 21:56:45 +01002903{
Johan Pascal2258a4f2020-10-28 13:53:09 +01002904 dtls_srtp_info->chosen_dtls_srtp_profile = ssl->dtls_srtp_info.chosen_dtls_srtp_profile;
2905 /* do not copy the mki value if there is no chosen profile */
Gilles Peskine449bd832023-01-11 14:50:10 +01002906 if (dtls_srtp_info->chosen_dtls_srtp_profile == MBEDTLS_TLS_SRTP_UNSET) {
Johan Pascal2258a4f2020-10-28 13:53:09 +01002907 dtls_srtp_info->mki_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01002908 } else {
Johan Pascal2258a4f2020-10-28 13:53:09 +01002909 dtls_srtp_info->mki_len = ssl->dtls_srtp_info.mki_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01002910 memcpy(dtls_srtp_info->mki_value, ssl->dtls_srtp_info.mki_value,
2911 ssl->dtls_srtp_info.mki_len);
Johan Pascal2258a4f2020-10-28 13:53:09 +01002912 }
Johan Pascalb62bb512015-12-03 21:56:45 +01002913}
Johan Pascalb62bb512015-12-03 21:56:45 +01002914#endif /* MBEDTLS_SSL_DTLS_SRTP */
2915
Aditya Patwardhan3096f332022-07-26 14:31:46 +05302916#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Gilles Peskine449bd832023-01-11 14:50:10 +01002917void mbedtls_ssl_conf_max_version(mbedtls_ssl_config *conf, int major, int minor)
Paul Bakker490ecc82011-10-06 13:04:09 +00002918{
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01002919 conf->max_tls_version = (mbedtls_ssl_protocol_version) ((major << 8) | minor);
Paul Bakker490ecc82011-10-06 13:04:09 +00002920}
2921
Gilles Peskine449bd832023-01-11 14:50:10 +01002922void mbedtls_ssl_conf_min_version(mbedtls_ssl_config *conf, int major, int minor)
Paul Bakker1d29fb52012-09-28 13:28:45 +00002923{
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01002924 conf->min_tls_version = (mbedtls_ssl_protocol_version) ((major << 8) | minor);
Paul Bakker1d29fb52012-09-28 13:28:45 +00002925}
Aditya Patwardhan3096f332022-07-26 14:31:46 +05302926#endif /* MBEDTLS_DEPRECATED_REMOVED */
Paul Bakker1d29fb52012-09-28 13:28:45 +00002927
Janos Follath088ce432017-04-10 12:42:31 +01002928#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002929void mbedtls_ssl_conf_cert_req_ca_list(mbedtls_ssl_config *conf,
2930 char cert_req_ca_list)
Janos Follath088ce432017-04-10 12:42:31 +01002931{
2932 conf->cert_req_ca_list = cert_req_ca_list;
2933}
2934#endif
2935
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002936#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01002937void mbedtls_ssl_conf_encrypt_then_mac(mbedtls_ssl_config *conf, char etm)
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01002938{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002939 conf->encrypt_then_mac = etm;
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01002940}
2941#endif
2942
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002943#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
Gilles Peskine449bd832023-01-11 14:50:10 +01002944void mbedtls_ssl_conf_extended_master_secret(mbedtls_ssl_config *conf, char ems)
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02002945{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002946 conf->extended_ms = ems;
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02002947}
2948#endif
2949
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002950#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01002951int mbedtls_ssl_conf_max_frag_len(mbedtls_ssl_config *conf, unsigned char mfl_code)
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002952{
Gilles Peskine449bd832023-01-11 14:50:10 +01002953 if (mfl_code >= MBEDTLS_SSL_MAX_FRAG_LEN_INVALID ||
2954 ssl_mfl_code_to_length(mfl_code) > MBEDTLS_TLS_EXT_ADV_CONTENT_LEN) {
2955 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002956 }
2957
Manuel Pégourié-Gonnard6bf89d62015-05-05 17:01:57 +01002958 conf->mfl_code = mfl_code;
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002959
Gilles Peskine449bd832023-01-11 14:50:10 +01002960 return 0;
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002961}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002962#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002963
Gilles Peskine449bd832023-01-11 14:50:10 +01002964void mbedtls_ssl_conf_legacy_renegotiation(mbedtls_ssl_config *conf, int allow_legacy)
Paul Bakker48916f92012-09-16 19:57:18 +00002965{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002966 conf->allow_legacy_renegotiation = allow_legacy;
Paul Bakker48916f92012-09-16 19:57:18 +00002967}
2968
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002969#if defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01002970void mbedtls_ssl_conf_renegotiation(mbedtls_ssl_config *conf, int renegotiation)
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01002971{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002972 conf->disable_renegotiation = renegotiation;
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01002973}
2974
Gilles Peskine449bd832023-01-11 14:50:10 +01002975void mbedtls_ssl_conf_renegotiation_enforced(mbedtls_ssl_config *conf, int max_records)
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02002976{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002977 conf->renego_max_records = max_records;
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02002978}
2979
Gilles Peskine449bd832023-01-11 14:50:10 +01002980void mbedtls_ssl_conf_renegotiation_period(mbedtls_ssl_config *conf,
2981 const unsigned char period[8])
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01002982{
Gilles Peskine449bd832023-01-11 14:50:10 +01002983 memcpy(conf->renego_period, period, 8);
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01002984}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002985#endif /* MBEDTLS_SSL_RENEGOTIATION */
Paul Bakker5121ce52009-01-03 21:22:43 +00002986
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002987#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02002988#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002989void mbedtls_ssl_conf_session_tickets(mbedtls_ssl_config *conf, int use_tickets)
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02002990{
Manuel Pégourié-Gonnard2b494452015-05-06 10:05:11 +01002991 conf->session_tickets = use_tickets;
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02002992}
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02002993#endif
Paul Bakker606b4ba2013-08-14 16:52:14 +02002994
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02002995#if defined(MBEDTLS_SSL_SRV_C)
Jerry Yu1ad7ace2022-08-09 13:28:39 +08002996
Jerry Yud0766ec2022-09-22 10:46:57 +08002997#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Gilles Peskine449bd832023-01-11 14:50:10 +01002998void mbedtls_ssl_conf_new_session_tickets(mbedtls_ssl_config *conf,
2999 uint16_t num_tickets)
Jerry Yu1ad7ace2022-08-09 13:28:39 +08003000{
Jerry Yud0766ec2022-09-22 10:46:57 +08003001 conf->new_session_tickets_count = num_tickets;
Jerry Yu1ad7ace2022-08-09 13:28:39 +08003002}
3003#endif
3004
Gilles Peskine449bd832023-01-11 14:50:10 +01003005void mbedtls_ssl_conf_session_tickets_cb(mbedtls_ssl_config *conf,
3006 mbedtls_ssl_ticket_write_t *f_ticket_write,
3007 mbedtls_ssl_ticket_parse_t *f_ticket_parse,
3008 void *p_ticket)
Paul Bakker606b4ba2013-08-14 16:52:14 +02003009{
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02003010 conf->f_ticket_write = f_ticket_write;
3011 conf->f_ticket_parse = f_ticket_parse;
3012 conf->p_ticket = p_ticket;
Paul Bakker606b4ba2013-08-14 16:52:14 +02003013}
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02003014#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003015#endif /* MBEDTLS_SSL_SESSION_TICKETS */
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02003016
Gilles Peskine449bd832023-01-11 14:50:10 +01003017void mbedtls_ssl_set_export_keys_cb(mbedtls_ssl_context *ssl,
3018 mbedtls_ssl_export_keys_t *f_export_keys,
3019 void *p_export_keys)
Robert Cragie4feb7ae2015-10-02 13:33:37 +01003020{
Hanno Becker7e6c1782021-06-08 09:24:55 +01003021 ssl->f_export_keys = f_export_keys;
3022 ssl->p_export_keys = p_export_keys;
Ron Eldorf5cc10d2019-05-07 18:33:40 +03003023}
Robert Cragie4feb7ae2015-10-02 13:33:37 +01003024
Gilles Peskineb74a1c72018-04-24 13:09:22 +02003025#if defined(MBEDTLS_SSL_ASYNC_PRIVATE)
Gilles Peskine8bf79f62018-01-05 21:11:53 +01003026void mbedtls_ssl_conf_async_private_cb(
3027 mbedtls_ssl_config *conf,
3028 mbedtls_ssl_async_sign_t *f_async_sign,
3029 mbedtls_ssl_async_decrypt_t *f_async_decrypt,
3030 mbedtls_ssl_async_resume_t *f_async_resume,
3031 mbedtls_ssl_async_cancel_t *f_async_cancel,
Gilles Peskine449bd832023-01-11 14:50:10 +01003032 void *async_config_data)
Gilles Peskine8bf79f62018-01-05 21:11:53 +01003033{
3034 conf->f_async_sign_start = f_async_sign;
3035 conf->f_async_decrypt_start = f_async_decrypt;
3036 conf->f_async_resume = f_async_resume;
3037 conf->f_async_cancel = f_async_cancel;
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003038 conf->p_async_config_data = async_config_data;
3039}
3040
Gilles Peskine449bd832023-01-11 14:50:10 +01003041void *mbedtls_ssl_conf_get_async_config_data(const mbedtls_ssl_config *conf)
Gilles Peskine8f97af72018-04-26 11:46:10 +02003042{
Gilles Peskine449bd832023-01-11 14:50:10 +01003043 return conf->p_async_config_data;
Gilles Peskine8f97af72018-04-26 11:46:10 +02003044}
3045
Gilles Peskine449bd832023-01-11 14:50:10 +01003046void *mbedtls_ssl_get_async_operation_data(const mbedtls_ssl_context *ssl)
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003047{
Gilles Peskine449bd832023-01-11 14:50:10 +01003048 if (ssl->handshake == NULL) {
3049 return NULL;
3050 } else {
3051 return ssl->handshake->user_async_ctx;
3052 }
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003053}
3054
Gilles Peskine449bd832023-01-11 14:50:10 +01003055void mbedtls_ssl_set_async_operation_data(mbedtls_ssl_context *ssl,
3056 void *ctx)
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003057{
Gilles Peskine449bd832023-01-11 14:50:10 +01003058 if (ssl->handshake != NULL) {
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003059 ssl->handshake->user_async_ctx = ctx;
Gilles Peskine449bd832023-01-11 14:50:10 +01003060 }
Gilles Peskine8bf79f62018-01-05 21:11:53 +01003061}
Gilles Peskineb74a1c72018-04-24 13:09:22 +02003062#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
Gilles Peskine8bf79f62018-01-05 21:11:53 +01003063
Paul Bakker5121ce52009-01-03 21:22:43 +00003064/*
3065 * SSL get accessors
3066 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003067uint32_t mbedtls_ssl_get_verify_result(const mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00003068{
Gilles Peskine449bd832023-01-11 14:50:10 +01003069 if (ssl->session != NULL) {
3070 return ssl->session->verify_result;
3071 }
Manuel Pégourié-Gonnarde89163c2015-01-23 14:30:57 +00003072
Gilles Peskine449bd832023-01-11 14:50:10 +01003073 if (ssl->session_negotiate != NULL) {
3074 return ssl->session_negotiate->verify_result;
3075 }
Manuel Pégourié-Gonnarde89163c2015-01-23 14:30:57 +00003076
Gilles Peskine449bd832023-01-11 14:50:10 +01003077 return 0xFFFFFFFF;
Paul Bakker5121ce52009-01-03 21:22:43 +00003078}
3079
Gilles Peskine449bd832023-01-11 14:50:10 +01003080int mbedtls_ssl_get_ciphersuite_id_from_ssl(const mbedtls_ssl_context *ssl)
Glenn Strauss8f526902022-01-13 00:04:49 -05003081{
Gilles Peskine449bd832023-01-11 14:50:10 +01003082 if (ssl == NULL || ssl->session == NULL) {
3083 return 0;
3084 }
Glenn Strauss8f526902022-01-13 00:04:49 -05003085
Gilles Peskine449bd832023-01-11 14:50:10 +01003086 return ssl->session->ciphersuite;
Glenn Strauss8f526902022-01-13 00:04:49 -05003087}
3088
Gilles Peskine449bd832023-01-11 14:50:10 +01003089const char *mbedtls_ssl_get_ciphersuite(const mbedtls_ssl_context *ssl)
Paul Bakker72f62662011-01-16 21:27:44 +00003090{
Gilles Peskine449bd832023-01-11 14:50:10 +01003091 if (ssl == NULL || ssl->session == NULL) {
3092 return NULL;
3093 }
Paul Bakker926c8e42013-03-06 10:23:34 +01003094
Gilles Peskine449bd832023-01-11 14:50:10 +01003095 return mbedtls_ssl_get_ciphersuite_name(ssl->session->ciphersuite);
Paul Bakker72f62662011-01-16 21:27:44 +00003096}
3097
Gilles Peskine449bd832023-01-11 14:50:10 +01003098const char *mbedtls_ssl_get_version(const mbedtls_ssl_context *ssl)
Paul Bakker43ca69c2011-01-15 17:35:19 +00003099{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003100#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003101 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
3102 switch (ssl->tls_version) {
Glenn Strauss60bfe602022-03-14 19:04:24 -04003103 case MBEDTLS_SSL_VERSION_TLS1_2:
Gilles Peskine449bd832023-01-11 14:50:10 +01003104 return "DTLSv1.2";
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01003105 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01003106 return "unknown (DTLS)";
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01003107 }
3108 }
3109#endif
3110
Gilles Peskine449bd832023-01-11 14:50:10 +01003111 switch (ssl->tls_version) {
Glenn Strauss60bfe602022-03-14 19:04:24 -04003112 case MBEDTLS_SSL_VERSION_TLS1_2:
Gilles Peskine449bd832023-01-11 14:50:10 +01003113 return "TLSv1.2";
Glenn Strauss60bfe602022-03-14 19:04:24 -04003114 case MBEDTLS_SSL_VERSION_TLS1_3:
Gilles Peskine449bd832023-01-11 14:50:10 +01003115 return "TLSv1.3";
Paul Bakker43ca69c2011-01-15 17:35:19 +00003116 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01003117 return "unknown";
Paul Bakker43ca69c2011-01-15 17:35:19 +00003118 }
Paul Bakker43ca69c2011-01-15 17:35:19 +00003119}
3120
Waleed Elmelegy6a971fd2023-12-28 17:48:16 +00003121#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
3122
3123size_t mbedtls_ssl_get_output_record_size_limit(const mbedtls_ssl_context *ssl)
3124{
3125 const size_t max_len = MBEDTLS_SSL_OUT_CONTENT_LEN;
3126 size_t record_size_limit = max_len;
3127
3128 if (ssl->session != NULL &&
3129 ssl->session->record_size_limit >= MBEDTLS_SSL_RECORD_SIZE_LIMIT_MIN &&
3130 ssl->session->record_size_limit < max_len) {
3131 record_size_limit = ssl->session->record_size_limit;
3132 }
3133
3134 // TODO: this is currently untested
3135 /* During a handshake, use the value being negotiated */
3136 if (ssl->session_negotiate != NULL &&
3137 ssl->session_negotiate->record_size_limit >= MBEDTLS_SSL_RECORD_SIZE_LIMIT_MIN &&
3138 ssl->session_negotiate->record_size_limit < max_len) {
3139 record_size_limit = ssl->session_negotiate->record_size_limit;
3140 }
3141
3142 return record_size_limit;
3143}
3144#endif /* MBEDTLS_SSL_RECORD_SIZE_LIMIT */
3145
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02003146#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01003147size_t mbedtls_ssl_get_input_max_frag_len(const mbedtls_ssl_context *ssl)
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003148{
David Horstmann95d516f2021-05-04 18:36:56 +01003149 size_t max_len = MBEDTLS_SSL_IN_CONTENT_LEN;
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003150 size_t read_mfl;
3151
Jerry Yuddda0502022-12-01 19:43:12 +08003152#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003153 /* Use the configured MFL for the client if we're past SERVER_HELLO_DONE */
Gilles Peskine449bd832023-01-11 14:50:10 +01003154 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
3155 ssl->state >= MBEDTLS_SSL_SERVER_HELLO_DONE) {
3156 return ssl_mfl_code_to_length(ssl->conf->mfl_code);
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003157 }
Jerry Yuddda0502022-12-01 19:43:12 +08003158#endif
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003159
3160 /* Check if a smaller max length was negotiated */
Gilles Peskine449bd832023-01-11 14:50:10 +01003161 if (ssl->session_out != NULL) {
3162 read_mfl = ssl_mfl_code_to_length(ssl->session_out->mfl_code);
3163 if (read_mfl < max_len) {
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003164 max_len = read_mfl;
3165 }
3166 }
3167
Jerry Yuddda0502022-12-01 19:43:12 +08003168 /* During a handshake, use the value being negotiated */
Gilles Peskine449bd832023-01-11 14:50:10 +01003169 if (ssl->session_negotiate != NULL) {
3170 read_mfl = ssl_mfl_code_to_length(ssl->session_negotiate->mfl_code);
3171 if (read_mfl < max_len) {
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003172 max_len = read_mfl;
3173 }
3174 }
3175
Gilles Peskine449bd832023-01-11 14:50:10 +01003176 return max_len;
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003177}
3178
Gilles Peskine449bd832023-01-11 14:50:10 +01003179size_t mbedtls_ssl_get_output_max_frag_len(const mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02003180{
3181 size_t max_len;
3182
3183 /*
3184 * Assume mfl_code is correct since it was checked when set
3185 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003186 max_len = ssl_mfl_code_to_length(ssl->conf->mfl_code);
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02003187
Manuel Pégourié-Gonnard2cb17e22017-09-19 13:00:47 +02003188 /* Check if a smaller max length was negotiated */
Gilles Peskine449bd832023-01-11 14:50:10 +01003189 if (ssl->session_out != NULL &&
3190 ssl_mfl_code_to_length(ssl->session_out->mfl_code) < max_len) {
3191 max_len = ssl_mfl_code_to_length(ssl->session_out->mfl_code);
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02003192 }
3193
Manuel Pégourié-Gonnard2cb17e22017-09-19 13:00:47 +02003194 /* During a handshake, use the value being negotiated */
Gilles Peskine449bd832023-01-11 14:50:10 +01003195 if (ssl->session_negotiate != NULL &&
3196 ssl_mfl_code_to_length(ssl->session_negotiate->mfl_code) < max_len) {
3197 max_len = ssl_mfl_code_to_length(ssl->session_negotiate->mfl_code);
Manuel Pégourié-Gonnard2cb17e22017-09-19 13:00:47 +02003198 }
3199
Gilles Peskine449bd832023-01-11 14:50:10 +01003200 return max_len;
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02003201}
3202#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
3203
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003204#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003205size_t mbedtls_ssl_get_current_mtu(const mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003206{
Andrzej Kurekef43ce62018-10-09 08:24:12 -04003207 /* Return unlimited mtu for client hello messages to avoid fragmentation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01003208 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
3209 (ssl->state == MBEDTLS_SSL_CLIENT_HELLO ||
3210 ssl->state == MBEDTLS_SSL_SERVER_HELLO)) {
3211 return 0;
3212 }
Andrzej Kurekef43ce62018-10-09 08:24:12 -04003213
Gilles Peskine449bd832023-01-11 14:50:10 +01003214 if (ssl->handshake == NULL || ssl->handshake->mtu == 0) {
3215 return ssl->mtu;
3216 }
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003217
Gilles Peskine449bd832023-01-11 14:50:10 +01003218 if (ssl->mtu == 0) {
3219 return ssl->handshake->mtu;
3220 }
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003221
Gilles Peskine449bd832023-01-11 14:50:10 +01003222 return ssl->mtu < ssl->handshake->mtu ?
3223 ssl->mtu : ssl->handshake->mtu;
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003224}
3225#endif /* MBEDTLS_SSL_PROTO_DTLS */
3226
Gilles Peskine449bd832023-01-11 14:50:10 +01003227int mbedtls_ssl_get_max_out_record_payload(const mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003228{
3229 size_t max_len = MBEDTLS_SSL_OUT_CONTENT_LEN;
3230
Manuel Pégourié-Gonnard000281e2018-08-21 11:20:58 +02003231#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH) && \
Jan Brucknerf482dcc2023-03-15 09:09:06 +01003232 !defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT) && \
Manuel Pégourié-Gonnard000281e2018-08-21 11:20:58 +02003233 !defined(MBEDTLS_SSL_PROTO_DTLS)
3234 (void) ssl;
3235#endif
3236
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003237#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01003238 const size_t mfl = mbedtls_ssl_get_output_max_frag_len(ssl);
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003239
Gilles Peskine449bd832023-01-11 14:50:10 +01003240 if (max_len > mfl) {
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003241 max_len = mfl;
Gilles Peskine449bd832023-01-11 14:50:10 +01003242 }
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003243#endif
3244
Jan Brucknerf482dcc2023-03-15 09:09:06 +01003245#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
3246 const size_t record_size_limit = mbedtls_ssl_get_output_record_size_limit(ssl);
3247
3248 if (max_len > record_size_limit) {
3249 max_len = record_size_limit;
3250 }
3251#endif
3252
Waleed Elmelegy6a971fd2023-12-28 17:48:16 +00003253 if (ssl->transform_out != NULL &&
3254 ssl->transform_out->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Waleed Elmelegyf5017902024-01-09 14:18:34 +00003255 /*
3256 * In TLS 1.3 case, when records are protected, `max_len` as computed
3257 * above is the maximum length of the TLSInnerPlaintext structure that
3258 * along the plaintext payload contains the inner content type (one byte)
3259 * and some zero padding. Given the algorithm used for padding
3260 * in mbedtls_ssl_encrypt_buf(), compute the maximum length for
3261 * the plaintext payload. Round down to a multiple of
3262 * MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY and
3263 * subtract 1.
Waleed Elmelegy6a971fd2023-12-28 17:48:16 +00003264 */
3265 max_len = ((max_len / MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY) *
3266 MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY) - 1;
3267 }
3268
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003269#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003270 if (mbedtls_ssl_get_current_mtu(ssl) != 0) {
3271 const size_t mtu = mbedtls_ssl_get_current_mtu(ssl);
3272 const int ret = mbedtls_ssl_get_record_expansion(ssl);
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003273 const size_t overhead = (size_t) ret;
3274
Gilles Peskine449bd832023-01-11 14:50:10 +01003275 if (ret < 0) {
3276 return ret;
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003277 }
3278
Gilles Peskine449bd832023-01-11 14:50:10 +01003279 if (mtu <= overhead) {
3280 MBEDTLS_SSL_DEBUG_MSG(1, ("MTU too low for record expansion"));
3281 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
3282 }
3283
3284 if (max_len > mtu - overhead) {
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003285 max_len = mtu - overhead;
Gilles Peskine449bd832023-01-11 14:50:10 +01003286 }
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003287 }
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003288#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003289
Hanno Becker0defedb2018-08-10 12:35:02 +01003290#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH) && \
Waleed Elmelegy049cd302023-12-20 17:28:31 +00003291 !defined(MBEDTLS_SSL_PROTO_DTLS) && \
3292 !defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
Hanno Becker0defedb2018-08-10 12:35:02 +01003293 ((void) ssl);
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003294#endif
3295
Gilles Peskine449bd832023-01-11 14:50:10 +01003296 return (int) max_len;
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003297}
3298
Gilles Peskine449bd832023-01-11 14:50:10 +01003299int mbedtls_ssl_get_max_in_record_payload(const mbedtls_ssl_context *ssl)
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003300{
3301 size_t max_len = MBEDTLS_SSL_IN_CONTENT_LEN;
3302
3303#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
3304 (void) ssl;
3305#endif
3306
3307#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01003308 const size_t mfl = mbedtls_ssl_get_input_max_frag_len(ssl);
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003309
Gilles Peskine449bd832023-01-11 14:50:10 +01003310 if (max_len > mfl) {
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003311 max_len = mfl;
Gilles Peskine449bd832023-01-11 14:50:10 +01003312 }
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003313#endif
3314
Gilles Peskine449bd832023-01-11 14:50:10 +01003315 return (int) max_len;
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003316}
3317
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003318#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01003319const mbedtls_x509_crt *mbedtls_ssl_get_peer_cert(const mbedtls_ssl_context *ssl)
Paul Bakkerb0550d92012-10-30 07:51:03 +00003320{
Gilles Peskine449bd832023-01-11 14:50:10 +01003321 if (ssl == NULL || ssl->session == NULL) {
3322 return NULL;
3323 }
Paul Bakkerb0550d92012-10-30 07:51:03 +00003324
Hanno Beckere6824572019-02-07 13:18:46 +00003325#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01003326 return ssl->session->peer_cert;
Hanno Beckere6824572019-02-07 13:18:46 +00003327#else
Gilles Peskine449bd832023-01-11 14:50:10 +01003328 return NULL;
Hanno Beckere6824572019-02-07 13:18:46 +00003329#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Paul Bakkerb0550d92012-10-30 07:51:03 +00003330}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003331#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkerb0550d92012-10-30 07:51:03 +00003332
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003333#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01003334int mbedtls_ssl_get_session(const mbedtls_ssl_context *ssl,
3335 mbedtls_ssl_session *dst)
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003336{
Hanno Beckere810bbc2021-05-14 16:01:05 +01003337 int ret;
3338
Gilles Peskine449bd832023-01-11 14:50:10 +01003339 if (ssl == NULL ||
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003340 dst == NULL ||
3341 ssl->session == NULL ||
Gilles Peskine449bd832023-01-11 14:50:10 +01003342 ssl->conf->endpoint != MBEDTLS_SSL_IS_CLIENT) {
3343 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003344 }
3345
Hanno Beckere810bbc2021-05-14 16:01:05 +01003346 /* Since Mbed TLS 3.0, mbedtls_ssl_get_session() is no longer
3347 * idempotent: Each session can only be exported once.
3348 *
3349 * (This is in preparation for TLS 1.3 support where we will
3350 * need the ability to export multiple sessions (aka tickets),
3351 * which will be achieved by calling mbedtls_ssl_get_session()
3352 * multiple times until it fails.)
3353 *
3354 * Check whether we have already exported the current session,
3355 * and fail if so.
3356 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003357 if (ssl->session->exported == 1) {
3358 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
3359 }
Hanno Beckere810bbc2021-05-14 16:01:05 +01003360
Gilles Peskine449bd832023-01-11 14:50:10 +01003361 ret = mbedtls_ssl_session_copy(dst, ssl->session);
3362 if (ret != 0) {
3363 return ret;
3364 }
Hanno Beckere810bbc2021-05-14 16:01:05 +01003365
3366 /* Remember that we've exported the session. */
3367 ssl->session->exported = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01003368 return 0;
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003369}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003370#endif /* MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003371
David Horstmanncb01b362024-02-29 17:31:46 +00003372#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
3373
3374/* Serialization of TLS 1.2 sessions
David Horstmanne59f9702024-02-29 16:08:57 +00003375 *
David Horstmanncb01b362024-02-29 17:31:46 +00003376 * For more detail, see the description of ssl_session_save().
David Horstmanne59f9702024-02-29 16:08:57 +00003377 */
3378static size_t ssl_tls12_session_save(const mbedtls_ssl_session *session,
3379 unsigned char *buf,
3380 size_t buf_len)
3381{
3382 unsigned char *p = buf;
3383 size_t used = 0;
3384
3385#if defined(MBEDTLS_HAVE_TIME)
3386 uint64_t start;
3387#endif
3388#if defined(MBEDTLS_X509_CRT_PARSE_C)
3389#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
3390 size_t cert_len;
3391#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3392#endif /* MBEDTLS_X509_CRT_PARSE_C */
3393
3394 /*
3395 * Time
3396 */
3397#if defined(MBEDTLS_HAVE_TIME)
3398 used += 8;
3399
3400 if (used <= buf_len) {
3401 start = (uint64_t) session->start;
3402
3403 MBEDTLS_PUT_UINT64_BE(start, p, 0);
3404 p += 8;
3405 }
3406#endif /* MBEDTLS_HAVE_TIME */
3407
3408 /*
3409 * Basic mandatory fields
3410 */
3411 used += 1 /* id_len */
3412 + sizeof(session->id)
3413 + sizeof(session->master)
3414 + 4; /* verify_result */
3415
3416 if (used <= buf_len) {
3417 *p++ = MBEDTLS_BYTE_0(session->id_len);
3418 memcpy(p, session->id, 32);
3419 p += 32;
3420
3421 memcpy(p, session->master, 48);
3422 p += 48;
3423
3424 MBEDTLS_PUT_UINT32_BE(session->verify_result, p, 0);
3425 p += 4;
3426 }
3427
3428 /*
3429 * Peer's end-entity certificate
3430 */
3431#if defined(MBEDTLS_X509_CRT_PARSE_C)
3432#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
3433 if (session->peer_cert == NULL) {
3434 cert_len = 0;
3435 } else {
3436 cert_len = session->peer_cert->raw.len;
3437 }
3438
3439 used += 3 + cert_len;
3440
3441 if (used <= buf_len) {
3442 *p++ = MBEDTLS_BYTE_2(cert_len);
3443 *p++ = MBEDTLS_BYTE_1(cert_len);
3444 *p++ = MBEDTLS_BYTE_0(cert_len);
3445
3446 if (session->peer_cert != NULL) {
3447 memcpy(p, session->peer_cert->raw.p, cert_len);
3448 p += cert_len;
3449 }
3450 }
3451#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3452 if (session->peer_cert_digest != NULL) {
3453 used += 1 /* type */ + 1 /* length */ + session->peer_cert_digest_len;
3454 if (used <= buf_len) {
3455 *p++ = (unsigned char) session->peer_cert_digest_type;
3456 *p++ = (unsigned char) session->peer_cert_digest_len;
3457 memcpy(p, session->peer_cert_digest,
3458 session->peer_cert_digest_len);
3459 p += session->peer_cert_digest_len;
3460 }
3461 } else {
3462 used += 2;
3463 if (used <= buf_len) {
3464 *p++ = (unsigned char) MBEDTLS_MD_NONE;
3465 *p++ = 0;
3466 }
3467 }
3468#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3469#endif /* MBEDTLS_X509_CRT_PARSE_C */
3470
3471 /*
3472 * Session ticket if any, plus associated data
3473 */
3474#if defined(MBEDTLS_SSL_SESSION_TICKETS)
3475#if defined(MBEDTLS_SSL_CLI_C)
3476 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
3477 used += 3 + session->ticket_len + 4; /* len + ticket + lifetime */
3478
3479 if (used <= buf_len) {
3480 *p++ = MBEDTLS_BYTE_2(session->ticket_len);
3481 *p++ = MBEDTLS_BYTE_1(session->ticket_len);
3482 *p++ = MBEDTLS_BYTE_0(session->ticket_len);
3483
3484 if (session->ticket != NULL) {
3485 memcpy(p, session->ticket, session->ticket_len);
3486 p += session->ticket_len;
3487 }
3488
3489 MBEDTLS_PUT_UINT32_BE(session->ticket_lifetime, p, 0);
3490 p += 4;
3491 }
3492 }
3493#endif /* MBEDTLS_SSL_CLI_C */
3494#if defined(MBEDTLS_HAVE_TIME) && defined(MBEDTLS_SSL_SRV_C)
3495 if (session->endpoint == MBEDTLS_SSL_IS_SERVER) {
3496 used += 8;
3497
3498 if (used <= buf_len) {
3499 MBEDTLS_PUT_UINT64_BE((uint64_t) session->ticket_creation_time, p, 0);
3500 p += 8;
3501 }
3502 }
3503#endif /* MBEDTLS_HAVE_TIME && MBEDTLS_SSL_SRV_C */
3504#endif /* MBEDTLS_SSL_SESSION_TICKETS */
3505
3506 /*
3507 * Misc extension-related info
3508 */
3509#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
3510 used += 1;
3511
3512 if (used <= buf_len) {
3513 *p++ = session->mfl_code;
3514 }
3515#endif
3516
3517#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
3518 used += 1;
3519
3520 if (used <= buf_len) {
3521 *p++ = MBEDTLS_BYTE_0(session->encrypt_then_mac);
3522 }
3523#endif
3524
3525 return used;
3526}
3527
3528MBEDTLS_CHECK_RETURN_CRITICAL
3529static int ssl_tls12_session_load(mbedtls_ssl_session *session,
3530 const unsigned char *buf,
3531 size_t len)
3532{
3533#if defined(MBEDTLS_HAVE_TIME)
3534 uint64_t start;
3535#endif
3536#if defined(MBEDTLS_X509_CRT_PARSE_C)
3537#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
3538 size_t cert_len;
3539#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3540#endif /* MBEDTLS_X509_CRT_PARSE_C */
3541
3542 const unsigned char *p = buf;
3543 const unsigned char * const end = buf + len;
3544
3545 /*
3546 * Time
3547 */
3548#if defined(MBEDTLS_HAVE_TIME)
3549 if (8 > (size_t) (end - p)) {
3550 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3551 }
3552
3553 start = MBEDTLS_GET_UINT64_BE(p, 0);
3554 p += 8;
3555
3556 session->start = (time_t) start;
3557#endif /* MBEDTLS_HAVE_TIME */
3558
3559 /*
3560 * Basic mandatory fields
3561 */
3562 if (1 + 32 + 48 + 4 > (size_t) (end - p)) {
3563 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3564 }
3565
3566 session->id_len = *p++;
3567 memcpy(session->id, p, 32);
3568 p += 32;
3569
3570 memcpy(session->master, p, 48);
3571 p += 48;
3572
3573 session->verify_result = MBEDTLS_GET_UINT32_BE(p, 0);
3574 p += 4;
3575
3576 /* Immediately clear invalid pointer values that have been read, in case
3577 * we exit early before we replaced them with valid ones. */
3578#if defined(MBEDTLS_X509_CRT_PARSE_C)
3579#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
3580 session->peer_cert = NULL;
3581#else
3582 session->peer_cert_digest = NULL;
3583#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3584#endif /* MBEDTLS_X509_CRT_PARSE_C */
3585#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
3586 session->ticket = NULL;
3587#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
3588
3589 /*
3590 * Peer certificate
3591 */
3592#if defined(MBEDTLS_X509_CRT_PARSE_C)
3593#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
3594 /* Deserialize CRT from the end of the ticket. */
3595 if (3 > (size_t) (end - p)) {
3596 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3597 }
3598
3599 cert_len = MBEDTLS_GET_UINT24_BE(p, 0);
3600 p += 3;
3601
3602 if (cert_len != 0) {
3603 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
3604
3605 if (cert_len > (size_t) (end - p)) {
3606 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3607 }
3608
3609 session->peer_cert = mbedtls_calloc(1, sizeof(mbedtls_x509_crt));
3610
3611 if (session->peer_cert == NULL) {
3612 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
3613 }
3614
3615 mbedtls_x509_crt_init(session->peer_cert);
3616
3617 if ((ret = mbedtls_x509_crt_parse_der(session->peer_cert,
3618 p, cert_len)) != 0) {
3619 mbedtls_x509_crt_free(session->peer_cert);
3620 mbedtls_free(session->peer_cert);
3621 session->peer_cert = NULL;
3622 return ret;
3623 }
3624
3625 p += cert_len;
3626 }
3627#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3628 /* Deserialize CRT digest from the end of the ticket. */
3629 if (2 > (size_t) (end - p)) {
3630 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3631 }
3632
3633 session->peer_cert_digest_type = (mbedtls_md_type_t) *p++;
3634 session->peer_cert_digest_len = (size_t) *p++;
3635
3636 if (session->peer_cert_digest_len != 0) {
3637 const mbedtls_md_info_t *md_info =
3638 mbedtls_md_info_from_type(session->peer_cert_digest_type);
3639 if (md_info == NULL) {
3640 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3641 }
3642 if (session->peer_cert_digest_len != mbedtls_md_get_size(md_info)) {
3643 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3644 }
3645
3646 if (session->peer_cert_digest_len > (size_t) (end - p)) {
3647 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3648 }
3649
3650 session->peer_cert_digest =
3651 mbedtls_calloc(1, session->peer_cert_digest_len);
3652 if (session->peer_cert_digest == NULL) {
3653 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
3654 }
3655
3656 memcpy(session->peer_cert_digest, p,
3657 session->peer_cert_digest_len);
3658 p += session->peer_cert_digest_len;
3659 }
3660#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3661#endif /* MBEDTLS_X509_CRT_PARSE_C */
3662
3663 /*
3664 * Session ticket and associated data
3665 */
3666#if defined(MBEDTLS_SSL_SESSION_TICKETS)
3667#if defined(MBEDTLS_SSL_CLI_C)
3668 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
3669 if (3 > (size_t) (end - p)) {
3670 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3671 }
3672
3673 session->ticket_len = MBEDTLS_GET_UINT24_BE(p, 0);
3674 p += 3;
3675
3676 if (session->ticket_len != 0) {
3677 if (session->ticket_len > (size_t) (end - p)) {
3678 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3679 }
3680
3681 session->ticket = mbedtls_calloc(1, session->ticket_len);
3682 if (session->ticket == NULL) {
3683 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
3684 }
3685
3686 memcpy(session->ticket, p, session->ticket_len);
3687 p += session->ticket_len;
3688 }
3689
3690 if (4 > (size_t) (end - p)) {
3691 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3692 }
3693
3694 session->ticket_lifetime = MBEDTLS_GET_UINT32_BE(p, 0);
3695 p += 4;
3696 }
3697#endif /* MBEDTLS_SSL_CLI_C */
3698#if defined(MBEDTLS_HAVE_TIME) && defined(MBEDTLS_SSL_SRV_C)
3699 if (session->endpoint == MBEDTLS_SSL_IS_SERVER) {
3700 if (8 > (size_t) (end - p)) {
3701 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3702 }
3703 session->ticket_creation_time = MBEDTLS_GET_UINT64_BE(p, 0);
3704 p += 8;
3705 }
3706#endif /* MBEDTLS_HAVE_TIME && MBEDTLS_SSL_SRV_C */
3707#endif /* MBEDTLS_SSL_SESSION_TICKETS */
3708
3709 /*
3710 * Misc extension-related info
3711 */
3712#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
3713 if (1 > (size_t) (end - p)) {
3714 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3715 }
3716
3717 session->mfl_code = *p++;
3718#endif
3719
3720#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
3721 if (1 > (size_t) (end - p)) {
3722 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3723 }
3724
3725 session->encrypt_then_mac = *p++;
3726#endif
3727
3728 /* Done, should have consumed entire buffer */
3729 if (p != end) {
3730 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3731 }
3732
3733 return 0;
3734}
3735
3736#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
3737
3738#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
3739/* Serialization of TLS 1.3 sessions:
3740 *
David Horstmanncb01b362024-02-29 17:31:46 +00003741 * For more detail, see the description of ssl_session_save().
David Horstmanne59f9702024-02-29 16:08:57 +00003742 */
3743#if defined(MBEDTLS_SSL_SESSION_TICKETS)
3744MBEDTLS_CHECK_RETURN_CRITICAL
3745static int ssl_tls13_session_save(const mbedtls_ssl_session *session,
3746 unsigned char *buf,
3747 size_t buf_len,
3748 size_t *olen)
3749{
3750 unsigned char *p = buf;
3751#if defined(MBEDTLS_SSL_CLI_C) && \
3752 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
3753 size_t hostname_len = (session->hostname == NULL) ?
3754 0 : strlen(session->hostname) + 1;
3755#endif
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003756
3757#if defined(MBEDTLS_SSL_SRV_C) && \
3758 defined(MBEDTLS_SSL_EARLY_DATA) && defined(MBEDTLS_SSL_ALPN)
Waleed Elmelegydaa4da72024-03-13 16:25:34 +00003759 const size_t alpn_len = (session->ticket_alpn == NULL) ?
Waleed Elmelegyb28ab0a2024-03-13 16:48:28 +00003760 0 : strlen(session->ticket_alpn) + 1;
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003761#endif
David Horstmanne59f9702024-02-29 16:08:57 +00003762 size_t needed = 4 /* ticket_age_add */
3763 + 1 /* ticket_flags */
3764 + 1; /* resumption_key length */
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003765
David Horstmanne59f9702024-02-29 16:08:57 +00003766 *olen = 0;
3767
3768 if (session->resumption_key_len > MBEDTLS_SSL_TLS1_3_TICKET_RESUMPTION_KEY_LEN) {
3769 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3770 }
3771 needed += session->resumption_key_len; /* resumption_key */
3772
3773#if defined(MBEDTLS_SSL_EARLY_DATA)
3774 needed += 4; /* max_early_data_size */
3775#endif
3776#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
3777 needed += 2; /* record_size_limit */
3778#endif /* MBEDTLS_SSL_RECORD_SIZE_LIMIT */
3779
3780#if defined(MBEDTLS_HAVE_TIME)
3781 needed += 8; /* ticket_creation_time or ticket_reception_time */
3782#endif
3783
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003784#if defined(MBEDTLS_SSL_SRV_C)
3785 if (session->endpoint == MBEDTLS_SSL_IS_SERVER) {
3786#if defined(MBEDTLS_SSL_EARLY_DATA) && defined(MBEDTLS_SSL_ALPN)
Waleed Elmelegydaa4da72024-03-13 16:25:34 +00003787 needed += 2 /* alpn_len */
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003788 + alpn_len; /* alpn */
3789#endif
3790 }
3791#endif /* MBEDTLS_SSL_SRV_C */
3792
David Horstmanne59f9702024-02-29 16:08:57 +00003793#if defined(MBEDTLS_SSL_CLI_C)
3794 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
3795#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
3796 needed += 2 /* hostname_len */
3797 + hostname_len; /* hostname */
3798#endif
3799
3800 needed += 4 /* ticket_lifetime */
3801 + 2; /* ticket_len */
3802
3803 /* Check size_t overflow */
3804 if (session->ticket_len > SIZE_MAX - needed) {
3805 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3806 }
3807
3808 needed += session->ticket_len; /* ticket */
3809 }
3810#endif /* MBEDTLS_SSL_CLI_C */
3811
3812 *olen = needed;
3813 if (needed > buf_len) {
3814 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
3815 }
3816
3817 MBEDTLS_PUT_UINT32_BE(session->ticket_age_add, p, 0);
3818 p[4] = session->ticket_flags;
3819
3820 /* save resumption_key */
3821 p[5] = session->resumption_key_len;
3822 p += 6;
3823 memcpy(p, session->resumption_key, session->resumption_key_len);
3824 p += session->resumption_key_len;
3825
3826#if defined(MBEDTLS_SSL_EARLY_DATA)
3827 MBEDTLS_PUT_UINT32_BE(session->max_early_data_size, p, 0);
3828 p += 4;
3829#endif
3830#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
3831 MBEDTLS_PUT_UINT16_BE(session->record_size_limit, p, 0);
3832 p += 2;
3833#endif /* MBEDTLS_SSL_RECORD_SIZE_LIMIT */
3834
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003835#if defined(MBEDTLS_SSL_SRV_C)
David Horstmanne59f9702024-02-29 16:08:57 +00003836 if (session->endpoint == MBEDTLS_SSL_IS_SERVER) {
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003837#if defined(MBEDTLS_HAVE_TIME)
David Horstmanne59f9702024-02-29 16:08:57 +00003838 MBEDTLS_PUT_UINT64_BE((uint64_t) session->ticket_creation_time, p, 0);
3839 p += 8;
David Horstmanne59f9702024-02-29 16:08:57 +00003840#endif /* MBEDTLS_HAVE_TIME */
3841
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003842#if defined(MBEDTLS_SSL_EARLY_DATA) && defined(MBEDTLS_SSL_ALPN)
Waleed Elmelegydaa4da72024-03-13 16:25:34 +00003843 MBEDTLS_PUT_UINT16_BE(alpn_len, p, 0);
3844 p += 2;
3845
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003846 if (alpn_len > 0) {
3847 /* save chosen alpn */
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00003848 memcpy(p, session->ticket_alpn, alpn_len);
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003849 p += alpn_len;
3850 }
3851#endif /* MBEDTLS_SSL_EARLY_DATA && MBEDTLS_SSL_ALPN */
3852 }
3853#endif /* MBEDTLS_SSL_SRV_C */
3854
David Horstmanne59f9702024-02-29 16:08:57 +00003855#if defined(MBEDTLS_SSL_CLI_C)
3856 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
3857#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
3858 MBEDTLS_PUT_UINT16_BE(hostname_len, p, 0);
3859 p += 2;
3860 if (hostname_len > 0) {
3861 /* save host name */
3862 memcpy(p, session->hostname, hostname_len);
3863 p += hostname_len;
3864 }
3865#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
3866
3867#if defined(MBEDTLS_HAVE_TIME)
3868 MBEDTLS_PUT_UINT64_BE((uint64_t) session->ticket_reception_time, p, 0);
3869 p += 8;
3870#endif
3871 MBEDTLS_PUT_UINT32_BE(session->ticket_lifetime, p, 0);
3872 p += 4;
3873
3874 MBEDTLS_PUT_UINT16_BE(session->ticket_len, p, 0);
3875 p += 2;
3876
3877 if (session->ticket != NULL && session->ticket_len > 0) {
3878 memcpy(p, session->ticket, session->ticket_len);
3879 p += session->ticket_len;
3880 }
3881 }
3882#endif /* MBEDTLS_SSL_CLI_C */
3883 return 0;
3884}
3885
3886MBEDTLS_CHECK_RETURN_CRITICAL
3887static int ssl_tls13_session_load(mbedtls_ssl_session *session,
3888 const unsigned char *buf,
3889 size_t len)
3890{
3891 const unsigned char *p = buf;
3892 const unsigned char *end = buf + len;
3893
3894 if (end - p < 6) {
3895 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3896 }
3897 session->ticket_age_add = MBEDTLS_GET_UINT32_BE(p, 0);
3898 session->ticket_flags = p[4];
3899
3900 /* load resumption_key */
3901 session->resumption_key_len = p[5];
3902 p += 6;
3903
3904 if (end - p < session->resumption_key_len) {
3905 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3906 }
3907
3908 if (sizeof(session->resumption_key) < session->resumption_key_len) {
3909 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3910 }
3911 memcpy(session->resumption_key, p, session->resumption_key_len);
3912 p += session->resumption_key_len;
3913
3914#if defined(MBEDTLS_SSL_EARLY_DATA)
3915 if (end - p < 4) {
3916 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3917 }
3918 session->max_early_data_size = MBEDTLS_GET_UINT32_BE(p, 0);
3919 p += 4;
3920#endif
3921#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
3922 if (end - p < 2) {
3923 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3924 }
3925 session->record_size_limit = MBEDTLS_GET_UINT16_BE(p, 0);
3926 p += 2;
3927#endif /* MBEDTLS_SSL_RECORD_SIZE_LIMIT */
3928
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003929#if defined(MBEDTLS_SSL_SRV_C)
David Horstmanne59f9702024-02-29 16:08:57 +00003930 if (session->endpoint == MBEDTLS_SSL_IS_SERVER) {
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003931#if defined(MBEDTLS_HAVE_TIME)
David Horstmanne59f9702024-02-29 16:08:57 +00003932 if (end - p < 8) {
3933 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3934 }
3935 session->ticket_creation_time = MBEDTLS_GET_UINT64_BE(p, 0);
3936 p += 8;
David Horstmanne59f9702024-02-29 16:08:57 +00003937#endif /* MBEDTLS_HAVE_TIME */
3938
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003939#if defined(MBEDTLS_SSL_EARLY_DATA) && defined(MBEDTLS_SSL_ALPN)
Waleed Elmelegydaa4da72024-03-13 16:25:34 +00003940 size_t alpn_len;
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003941
Waleed Elmelegydaa4da72024-03-13 16:25:34 +00003942 if (end - p < 2) {
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003943 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3944 }
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00003945
Waleed Elmelegydaa4da72024-03-13 16:25:34 +00003946 alpn_len = MBEDTLS_GET_UINT16_BE(p, 0);
3947 p += 2;
3948
3949 if (end - p < (long int) alpn_len) {
Waleed Elmelegy7dfba342024-03-12 16:22:39 +00003950 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3951 }
3952
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003953 if (alpn_len > 0) {
Waleed Elmelegydaa4da72024-03-13 16:25:34 +00003954 int ret = mbedtls_ssl_session_set_ticket_alpn(session, (char *) p);
3955 if (ret != 0) {
3956 return ret;
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003957 }
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003958 p += alpn_len;
3959 }
3960#endif /* MBEDTLS_SSL_EARLY_DATA && MBEDTLS_SSL_ALPN */
3961 }
3962#endif /* MBEDTLS_SSL_SRV_C */
3963
David Horstmanne59f9702024-02-29 16:08:57 +00003964#if defined(MBEDTLS_SSL_CLI_C)
3965 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
3966#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
3967 size_t hostname_len;
3968 /* load host name */
3969 if (end - p < 2) {
3970 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3971 }
3972 hostname_len = MBEDTLS_GET_UINT16_BE(p, 0);
3973 p += 2;
3974
3975 if (end - p < (long int) hostname_len) {
3976 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3977 }
3978 if (hostname_len > 0) {
3979 session->hostname = mbedtls_calloc(1, hostname_len);
3980 if (session->hostname == NULL) {
3981 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
3982 }
3983 memcpy(session->hostname, p, hostname_len);
3984 p += hostname_len;
3985 }
3986#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
3987
3988#if defined(MBEDTLS_HAVE_TIME)
3989 if (end - p < 8) {
3990 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3991 }
3992 session->ticket_reception_time = MBEDTLS_GET_UINT64_BE(p, 0);
3993 p += 8;
3994#endif
3995 if (end - p < 4) {
3996 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3997 }
3998 session->ticket_lifetime = MBEDTLS_GET_UINT32_BE(p, 0);
3999 p += 4;
4000
4001 if (end - p < 2) {
4002 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4003 }
4004 session->ticket_len = MBEDTLS_GET_UINT16_BE(p, 0);
4005 p += 2;
4006
4007 if (end - p < (long int) session->ticket_len) {
4008 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4009 }
4010 if (session->ticket_len > 0) {
4011 session->ticket = mbedtls_calloc(1, session->ticket_len);
4012 if (session->ticket == NULL) {
4013 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
4014 }
4015 memcpy(session->ticket, p, session->ticket_len);
4016 p += session->ticket_len;
4017 }
4018 }
4019#endif /* MBEDTLS_SSL_CLI_C */
4020
4021 return 0;
4022
4023}
4024#else /* MBEDTLS_SSL_SESSION_TICKETS */
4025MBEDTLS_CHECK_RETURN_CRITICAL
4026static int ssl_tls13_session_save(const mbedtls_ssl_session *session,
4027 unsigned char *buf,
4028 size_t buf_len,
4029 size_t *olen)
4030{
4031 ((void) session);
4032 ((void) buf);
4033 ((void) buf_len);
4034 *olen = 0;
4035 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
4036}
4037
4038static int ssl_tls13_session_load(const mbedtls_ssl_session *session,
Norbert Fabritius93b2c322023-01-24 17:48:29 +01004039 const unsigned char *buf,
David Horstmanne59f9702024-02-29 16:08:57 +00004040 size_t buf_len)
4041{
4042 ((void) session);
4043 ((void) buf);
4044 ((void) buf_len);
4045 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
4046}
4047#endif /* !MBEDTLS_SSL_SESSION_TICKETS */
4048#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
4049
Paul Bakker5121ce52009-01-03 21:22:43 +00004050/*
Hanno Beckera835da52019-05-16 12:39:07 +01004051 * Define ticket header determining Mbed TLS version
4052 * and structure of the ticket.
4053 */
4054
Hanno Becker94ef3b32019-05-16 12:50:45 +01004055/*
Hanno Becker50b59662019-05-28 14:30:45 +01004056 * Define bitflag determining compile-time settings influencing
4057 * structure of serialized SSL sessions.
Hanno Becker94ef3b32019-05-16 12:50:45 +01004058 */
4059
Hanno Becker50b59662019-05-28 14:30:45 +01004060#if defined(MBEDTLS_HAVE_TIME)
Hanno Becker3e088662019-05-29 11:10:18 +01004061#define SSL_SERIALIZED_SESSION_CONFIG_TIME 1
Hanno Becker50b59662019-05-28 14:30:45 +01004062#else
Hanno Becker3e088662019-05-29 11:10:18 +01004063#define SSL_SERIALIZED_SESSION_CONFIG_TIME 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01004064#endif /* MBEDTLS_HAVE_TIME */
4065
4066#if defined(MBEDTLS_X509_CRT_PARSE_C)
Hanno Becker3e088662019-05-29 11:10:18 +01004067#define SSL_SERIALIZED_SESSION_CONFIG_CRT 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01004068#else
Hanno Becker3e088662019-05-29 11:10:18 +01004069#define SSL_SERIALIZED_SESSION_CONFIG_CRT 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01004070#endif /* MBEDTLS_X509_CRT_PARSE_C */
4071
David Horstmann5c5a32f2024-02-13 17:53:35 +00004072#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
David Horstmannf686f1d2024-03-01 11:20:32 +00004073#define SSL_SERIALIZED_SESSION_CONFIG_KEEP_PEER_CRT 1
David Horstmann5c5a32f2024-02-13 17:53:35 +00004074#else
David Horstmannf686f1d2024-03-01 11:20:32 +00004075#define SSL_SERIALIZED_SESSION_CONFIG_KEEP_PEER_CRT 0
David Horstmann5c5a32f2024-02-13 17:53:35 +00004076#endif /* MBEDTLS_SSL_SESSION_TICKETS */
4077
Hanno Becker94ef3b32019-05-16 12:50:45 +01004078#if defined(MBEDTLS_SSL_CLI_C) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Hanno Becker3e088662019-05-29 11:10:18 +01004079#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01004080#else
Hanno Becker3e088662019-05-29 11:10:18 +01004081#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01004082#endif /* MBEDTLS_SSL_CLI_C && MBEDTLS_SSL_SESSION_TICKETS */
4083
4084#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Hanno Becker3e088662019-05-29 11:10:18 +01004085#define SSL_SERIALIZED_SESSION_CONFIG_MFL 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01004086#else
Hanno Becker3e088662019-05-29 11:10:18 +01004087#define SSL_SERIALIZED_SESSION_CONFIG_MFL 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01004088#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
4089
Hanno Becker94ef3b32019-05-16 12:50:45 +01004090#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Hanno Becker3e088662019-05-29 11:10:18 +01004091#define SSL_SERIALIZED_SESSION_CONFIG_ETM 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01004092#else
Hanno Becker3e088662019-05-29 11:10:18 +01004093#define SSL_SERIALIZED_SESSION_CONFIG_ETM 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01004094#endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC */
4095
Hanno Becker94ef3b32019-05-16 12:50:45 +01004096#if defined(MBEDTLS_SSL_SESSION_TICKETS)
4097#define SSL_SERIALIZED_SESSION_CONFIG_TICKET 1
4098#else
4099#define SSL_SERIALIZED_SESSION_CONFIG_TICKET 0
4100#endif /* MBEDTLS_SSL_SESSION_TICKETS */
4101
David Horstmann92b258b2024-02-13 17:23:34 +00004102#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
4103#define SSL_SERIALIZED_SESSION_CONFIG_SNI 1
4104#else
4105#define SSL_SERIALIZED_SESSION_CONFIG_SNI 0
4106#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
4107
4108#if defined(MBEDTLS_SSL_EARLY_DATA)
4109#define SSL_SERIALIZED_SESSION_CONFIG_EARLY_DATA 1
4110#else
4111#define SSL_SERIALIZED_SESSION_CONFIG_EARLY_DATA 0
4112#endif /* MBEDTLS_SSL_EARLY_DATA */
4113
4114#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
4115#define SSL_SERIALIZED_SESSION_CONFIG_RECORD_SIZE 1
4116#else
4117#define SSL_SERIALIZED_SESSION_CONFIG_RECORD_SIZE 0
4118#endif /* MBEDTLS_SSL_RECORD_SIZE_LIMIT */
4119
Waleed Elmelegy7dfba342024-03-12 16:22:39 +00004120#if defined(MBEDTLS_SSL_ALPN) && defined(MBEDTLS_SSL_SRV_C) && \
4121 defined(MBEDTLS_SSL_EARLY_DATA)
Waleed Elmelegy11025632024-03-07 15:25:52 +00004122#define SSL_SERIALIZED_SESSION_CONFIG_ALPN 1
4123#else
4124#define SSL_SERIALIZED_SESSION_CONFIG_ALPN 0
4125#endif /* MBEDTLS_SSL_ALPN */
4126
Hanno Becker3e088662019-05-29 11:10:18 +01004127#define SSL_SERIALIZED_SESSION_CONFIG_TIME_BIT 0
4128#define SSL_SERIALIZED_SESSION_CONFIG_CRT_BIT 1
4129#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET_BIT 2
4130#define SSL_SERIALIZED_SESSION_CONFIG_MFL_BIT 3
Hanno Becker37bdbe62021-08-01 05:38:58 +01004131#define SSL_SERIALIZED_SESSION_CONFIG_ETM_BIT 4
4132#define SSL_SERIALIZED_SESSION_CONFIG_TICKET_BIT 5
David Horstmannf686f1d2024-03-01 11:20:32 +00004133#define SSL_SERIALIZED_SESSION_CONFIG_KEEP_PEER_CRT_BIT 6
David Horstmann92b258b2024-02-13 17:23:34 +00004134#define SSL_SERIALIZED_SESSION_CONFIG_SNI_BIT 7
4135#define SSL_SERIALIZED_SESSION_CONFIG_EARLY_DATA_BIT 8
4136#define SSL_SERIALIZED_SESSION_CONFIG_RECORD_SIZE_BIT 9
Waleed Elmelegy11025632024-03-07 15:25:52 +00004137#define SSL_SERIALIZED_SESSION_CONFIG_ALPN_BIT 10
Hanno Becker3e088662019-05-29 11:10:18 +01004138
Hanno Becker50b59662019-05-28 14:30:45 +01004139#define SSL_SERIALIZED_SESSION_CONFIG_BITFLAG \
Gilles Peskine449bd832023-01-11 14:50:10 +01004140 ((uint16_t) ( \
4141 (SSL_SERIALIZED_SESSION_CONFIG_TIME << SSL_SERIALIZED_SESSION_CONFIG_TIME_BIT) | \
4142 (SSL_SERIALIZED_SESSION_CONFIG_CRT << SSL_SERIALIZED_SESSION_CONFIG_CRT_BIT) | \
4143 (SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET << \
4144 SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET_BIT) | \
4145 (SSL_SERIALIZED_SESSION_CONFIG_MFL << SSL_SERIALIZED_SESSION_CONFIG_MFL_BIT) | \
4146 (SSL_SERIALIZED_SESSION_CONFIG_ETM << SSL_SERIALIZED_SESSION_CONFIG_ETM_BIT) | \
David Horstmann5c5a32f2024-02-13 17:53:35 +00004147 (SSL_SERIALIZED_SESSION_CONFIG_TICKET << SSL_SERIALIZED_SESSION_CONFIG_TICKET_BIT) | \
David Horstmann71fa1a92024-03-01 12:32:18 +00004148 (SSL_SERIALIZED_SESSION_CONFIG_KEEP_PEER_CRT << \
4149 SSL_SERIALIZED_SESSION_CONFIG_KEEP_PEER_CRT_BIT) | \
David Horstmann92b258b2024-02-13 17:23:34 +00004150 (SSL_SERIALIZED_SESSION_CONFIG_SNI << SSL_SERIALIZED_SESSION_CONFIG_SNI_BIT) | \
4151 (SSL_SERIALIZED_SESSION_CONFIG_EARLY_DATA << \
4152 SSL_SERIALIZED_SESSION_CONFIG_EARLY_DATA_BIT) | \
4153 (SSL_SERIALIZED_SESSION_CONFIG_RECORD_SIZE << \
Waleed Elmelegy11025632024-03-07 15:25:52 +00004154 SSL_SERIALIZED_SESSION_CONFIG_RECORD_SIZE_BIT) | \
Waleed Elmelegy75e33fa2024-03-07 16:57:58 +00004155 (SSL_SERIALIZED_SESSION_CONFIG_ALPN << \
Waleed Elmelegy11025632024-03-07 15:25:52 +00004156 SSL_SERIALIZED_SESSION_CONFIG_ALPN_BIT)))
Hanno Becker94ef3b32019-05-16 12:50:45 +01004157
Chien Wong4e9683e2023-12-28 17:07:43 +08004158static const unsigned char ssl_serialized_session_header[] = {
Hanno Becker94ef3b32019-05-16 12:50:45 +01004159 MBEDTLS_VERSION_MAJOR,
4160 MBEDTLS_VERSION_MINOR,
4161 MBEDTLS_VERSION_PATCH,
Gilles Peskine449bd832023-01-11 14:50:10 +01004162 MBEDTLS_BYTE_1(SSL_SERIALIZED_SESSION_CONFIG_BITFLAG),
4163 MBEDTLS_BYTE_0(SSL_SERIALIZED_SESSION_CONFIG_BITFLAG),
Hanno Beckerf8787072019-05-16 12:41:07 +01004164};
Hanno Beckera835da52019-05-16 12:39:07 +01004165
4166/*
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004167 * Serialize a session in the following format:
Manuel Pégourié-Gonnard35eb8022019-05-16 11:11:08 +02004168 * (in the presentation language of TLS, RFC 8446 section 3)
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004169 *
David Horstmanncb01b362024-02-29 17:31:46 +00004170 * TLS 1.2 session:
4171 *
4172 * struct {
4173 * #if defined(MBEDTLS_SSL_SESSION_TICKETS)
4174 * opaque ticket<0..2^24-1>; // length 0 means no ticket
4175 * uint32 ticket_lifetime;
4176 * #endif
4177 * } ClientOnlyData;
4178 *
4179 * struct {
4180 * #if defined(MBEDTLS_HAVE_TIME)
4181 * uint64 start_time;
4182 * #endif
4183 * uint8 session_id_len; // at most 32
4184 * opaque session_id[32];
4185 * opaque master[48]; // fixed length in the standard
4186 * uint32 verify_result;
4187 * #if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
4188 * opaque peer_cert<0..2^24-1>; // length 0 means no peer cert
4189 * #else
David Horstmann76ba26a2024-03-01 12:03:35 +00004190 * uint8 peer_cert_digest_type;
David Horstmanncb01b362024-02-29 17:31:46 +00004191 * opaque peer_cert_digest<0..2^8-1>
4192 * #endif
4193 * select (endpoint) {
4194 * case client: ClientOnlyData;
4195 * case server: uint64 ticket_creation_time;
4196 * };
4197 * #if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
4198 * uint8 mfl_code; // up to 255 according to standard
4199 * #endif
4200 * #if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
4201 * uint8 encrypt_then_mac; // 0 or 1
4202 * #endif
4203 * } serialized_session_tls12;
4204 *
4205 *
4206 * TLS 1.3 Session:
4207 *
4208 * struct {
4209 * #if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
4210 * opaque hostname<0..2^16-1>;
4211 * #endif
4212 * #if defined(MBEDTLS_HAVE_TIME)
4213 * uint64 ticket_reception_time;
4214 * #endif
4215 * uint32 ticket_lifetime;
4216 * opaque ticket<1..2^16-1>;
4217 * } ClientOnlyData;
4218 *
4219 * struct {
4220 * uint32 ticket_age_add;
4221 * uint8 ticket_flags;
4222 * opaque resumption_key<0..255>;
4223 * #if defined(MBEDTLS_SSL_EARLY_DATA)
4224 * uint32 max_early_data_size;
4225 * #endif
4226 * #if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
4227 * uint16 record_size_limit;
4228 * #endif
4229 * select ( endpoint ) {
4230 * case client: ClientOnlyData;
Waleed Elmelegy7dfba342024-03-12 16:22:39 +00004231 * case server:
David Horstmanncb01b362024-02-29 17:31:46 +00004232 * #if defined(MBEDTLS_HAVE_TIME)
Waleed Elmelegy7dfba342024-03-12 16:22:39 +00004233 * uint64 ticket_creation_time;
David Horstmanncb01b362024-02-29 17:31:46 +00004234 * #endif
Waleed Elmelegyfe9ae082024-03-07 15:47:31 +00004235 * #if defined(MBEDTLS_SSL_EARLY_DATA) && defined(MBEDTLS_SSL_ALPN)
Waleed Elmelegydaa4da72024-03-13 16:25:34 +00004236 * opaque ticket_alpn<0..256>;
David Horstmanncb01b362024-02-29 17:31:46 +00004237 * #endif
4238 * };
4239 * } serialized_session_tls13;
4240 *
4241 *
4242 * SSL session:
4243 *
4244 * struct {
Hanno Beckerdc28b6c2019-05-29 11:08:00 +01004245 *
Hanno Beckerdce50972021-08-01 05:39:23 +01004246 * opaque mbedtls_version[3]; // library version: major, minor, patch
4247 * opaque session_format[2]; // library-version specific 16-bit field
4248 * // determining the format of the remaining
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004249 * // serialized data.
Hanno Beckerdc28b6c2019-05-29 11:08:00 +01004250 *
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004251 * Note: When updating the format, remember to keep
4252 * these version+format bytes.
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004253 *
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004254 * // In this version, `session_format` determines
4255 * // the setting of those compile-time
4256 * // configuration options which influence
4257 * // the structure of mbedtls_ssl_session.
4258 *
Glenn Straussda7851c2022-03-14 13:29:48 -04004259 * uint8_t minor_ver; // Protocol minor version. Possible values:
Jerry Yu0c2a7382022-12-06 13:27:25 +08004260 * // - TLS 1.2 (0x0303)
4261 * // - TLS 1.3 (0x0304)
David Horstmann531aca22024-02-29 18:14:28 +00004262 * uint8_t endpoint;
4263 * uint16_t ciphersuite;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004264 *
Glenn Straussda7851c2022-03-14 13:29:48 -04004265 * select (serialized_session.tls_version) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004266 *
Glenn Straussda7851c2022-03-14 13:29:48 -04004267 * case MBEDTLS_SSL_VERSION_TLS1_2:
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004268 * serialized_session_tls12 data;
Jerry Yu0c2a7382022-12-06 13:27:25 +08004269 * case MBEDTLS_SSL_VERSION_TLS1_3:
Jerry Yuddda0502022-12-01 19:43:12 +08004270 * serialized_session_tls13 data;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004271 *
4272 * };
4273 *
4274 * } serialized_session;
4275 *
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004276 */
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004277
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004278MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004279static int ssl_session_save(const mbedtls_ssl_session *session,
4280 unsigned char omit_header,
4281 unsigned char *buf,
4282 size_t buf_len,
4283 size_t *olen)
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004284{
4285 unsigned char *p = buf;
4286 size_t used = 0;
Jerry Yu251a12e2022-07-13 15:15:48 +08004287 size_t remaining_len;
Jerry Yue36fdd62022-08-17 21:31:36 +08004288#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
4289 size_t out_len;
4290 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
4291#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01004292 if (session == NULL) {
4293 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
4294 }
Jerry Yu438ddd82022-07-07 06:55:50 +00004295
Gilles Peskine449bd832023-01-11 14:50:10 +01004296 if (!omit_header) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004297 /*
4298 * Add Mbed TLS version identifier
4299 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004300 used += sizeof(ssl_serialized_session_header);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004301
Gilles Peskine449bd832023-01-11 14:50:10 +01004302 if (used <= buf_len) {
4303 memcpy(p, ssl_serialized_session_header,
4304 sizeof(ssl_serialized_session_header));
4305 p += sizeof(ssl_serialized_session_header);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004306 }
4307 }
4308
4309 /*
Ronald Cron40a4ab02024-01-15 10:21:30 +01004310 * TLS version identifier, endpoint, ciphersuite
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004311 */
Ronald Cron40a4ab02024-01-15 10:21:30 +01004312 used += 1 /* TLS version */
4313 + 1 /* endpoint */
4314 + 2; /* ciphersuite */
Gilles Peskine449bd832023-01-11 14:50:10 +01004315 if (used <= buf_len) {
4316 *p++ = MBEDTLS_BYTE_0(session->tls_version);
Ronald Cron40a4ab02024-01-15 10:21:30 +01004317 *p++ = session->endpoint;
4318 MBEDTLS_PUT_UINT16_BE(session->ciphersuite, p, 0);
4319 p += 2;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004320 }
4321
4322 /* Forward to version-specific serialization routine. */
Jerry Yufca4d572022-07-21 10:37:48 +08004323 remaining_len = (buf_len >= used) ? buf_len - used : 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01004324 switch (session->tls_version) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004325#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01004326 case MBEDTLS_SSL_VERSION_TLS1_2:
4327 used += ssl_tls12_session_save(session, p, remaining_len);
4328 break;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004329#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
4330
Jerry Yu251a12e2022-07-13 15:15:48 +08004331#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004332 case MBEDTLS_SSL_VERSION_TLS1_3:
4333 ret = ssl_tls13_session_save(session, p, remaining_len, &out_len);
4334 if (ret != 0 && ret != MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL) {
4335 return ret;
4336 }
4337 used += out_len;
4338 break;
Jerry Yu251a12e2022-07-13 15:15:48 +08004339#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
4340
Gilles Peskine449bd832023-01-11 14:50:10 +01004341 default:
4342 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004343 }
4344
4345 *olen = used;
Gilles Peskine449bd832023-01-11 14:50:10 +01004346 if (used > buf_len) {
4347 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
4348 }
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004349
Gilles Peskine449bd832023-01-11 14:50:10 +01004350 return 0;
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004351}
4352
4353/*
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02004354 * Public wrapper for ssl_session_save()
4355 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004356int mbedtls_ssl_session_save(const mbedtls_ssl_session *session,
4357 unsigned char *buf,
4358 size_t buf_len,
4359 size_t *olen)
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02004360{
Gilles Peskine449bd832023-01-11 14:50:10 +01004361 return ssl_session_save(session, 0, buf, buf_len, olen);
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02004362}
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004363
Jerry Yuf1b23ca2022-02-18 11:48:47 +08004364/*
4365 * Deserialize session, see mbedtls_ssl_session_save() for format.
4366 *
4367 * This internal version is wrapped by a public function that cleans up in
4368 * case of error, and has an extra option omit_header.
4369 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004370MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004371static int ssl_session_load(mbedtls_ssl_session *session,
4372 unsigned char omit_header,
4373 const unsigned char *buf,
4374 size_t len)
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004375{
4376 const unsigned char *p = buf;
4377 const unsigned char * const end = buf + len;
Jerry Yu438ddd82022-07-07 06:55:50 +00004378 size_t remaining_len;
4379
4380
Gilles Peskine449bd832023-01-11 14:50:10 +01004381 if (session == NULL) {
4382 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
4383 }
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004384
Gilles Peskine449bd832023-01-11 14:50:10 +01004385 if (!omit_header) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004386 /*
4387 * Check Mbed TLS version identifier
4388 */
4389
Gilles Peskine449bd832023-01-11 14:50:10 +01004390 if ((size_t) (end - p) < sizeof(ssl_serialized_session_header)) {
4391 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004392 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004393
4394 if (memcmp(p, ssl_serialized_session_header,
4395 sizeof(ssl_serialized_session_header)) != 0) {
4396 return MBEDTLS_ERR_SSL_VERSION_MISMATCH;
4397 }
4398 p += sizeof(ssl_serialized_session_header);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004399 }
4400
4401 /*
Ronald Cron40a4ab02024-01-15 10:21:30 +01004402 * TLS version identifier, endpoint, ciphersuite
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004403 */
Ronald Cron40a4ab02024-01-15 10:21:30 +01004404 if (4 > (size_t) (end - p)) {
Gilles Peskine449bd832023-01-11 14:50:10 +01004405 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4406 }
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01004407 session->tls_version = (mbedtls_ssl_protocol_version) (0x0300 | *p++);
Ronald Cron40a4ab02024-01-15 10:21:30 +01004408 session->endpoint = *p++;
4409 session->ciphersuite = MBEDTLS_GET_UINT16_BE(p, 0);
4410 p += 2;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004411
4412 /* Dispatch according to TLS version. */
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00004413 remaining_len = (size_t) (end - p);
Gilles Peskine449bd832023-01-11 14:50:10 +01004414 switch (session->tls_version) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004415#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01004416 case MBEDTLS_SSL_VERSION_TLS1_2:
4417 return ssl_tls12_session_load(session, p, remaining_len);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004418#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
4419
Jerry Yu438ddd82022-07-07 06:55:50 +00004420#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004421 case MBEDTLS_SSL_VERSION_TLS1_3:
4422 return ssl_tls13_session_load(session, p, remaining_len);
Jerry Yu438ddd82022-07-07 06:55:50 +00004423#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
4424
Gilles Peskine449bd832023-01-11 14:50:10 +01004425 default:
4426 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004427 }
4428}
4429
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004430/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02004431 * Deserialize session: public wrapper for error cleaning
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02004432 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004433int mbedtls_ssl_session_load(mbedtls_ssl_session *session,
4434 const unsigned char *buf,
4435 size_t len)
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02004436{
Gilles Peskine449bd832023-01-11 14:50:10 +01004437 int ret = ssl_session_load(session, 0, buf, len);
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02004438
Gilles Peskine449bd832023-01-11 14:50:10 +01004439 if (ret != 0) {
4440 mbedtls_ssl_session_free(session);
4441 }
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02004442
Gilles Peskine449bd832023-01-11 14:50:10 +01004443 return ret;
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02004444}
4445
4446/*
Paul Bakker1961b702013-01-25 14:49:24 +01004447 * Perform a single step of the SSL handshake
Paul Bakker5121ce52009-01-03 21:22:43 +00004448 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004449MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004450static int ssl_prepare_handshake_step(mbedtls_ssl_context *ssl)
Hanno Becker41934dd2021-08-07 19:13:43 +01004451{
4452 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
4453
Ronald Cron66dbf912022-02-02 15:33:46 +01004454 /*
4455 * We may have not been able to send to the peer all the handshake data
Ronald Cron3f20b772022-03-08 16:00:02 +01004456 * that were written into the output buffer by the previous handshake step,
4457 * if the write to the network callback returned with the
Ronald Cron66dbf912022-02-02 15:33:46 +01004458 * #MBEDTLS_ERR_SSL_WANT_WRITE error code.
4459 * We proceed to the next handshake step only when all data from the
4460 * previous one have been sent to the peer, thus we make sure that this is
4461 * the case here by calling `mbedtls_ssl_flush_output()`. The function may
4462 * return with the #MBEDTLS_ERR_SSL_WANT_WRITE error code in which case
4463 * we have to wait before to go ahead.
4464 * In the case of TLS 1.3, handshake step handlers do not send data to the
4465 * peer. Data are only sent here and through
4466 * `mbedtls_ssl_handle_pending_alert` in case an error that triggered an
Andrzej Kurek5c65c572022-04-13 14:28:52 -04004467 * alert occurred.
Ronald Cron66dbf912022-02-02 15:33:46 +01004468 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004469 if ((ret = mbedtls_ssl_flush_output(ssl)) != 0) {
4470 return ret;
4471 }
Hanno Becker41934dd2021-08-07 19:13:43 +01004472
4473#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004474 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
4475 ssl->handshake->retransmit_state == MBEDTLS_SSL_RETRANS_SENDING) {
4476 if ((ret = mbedtls_ssl_flight_transmit(ssl)) != 0) {
4477 return ret;
4478 }
Hanno Becker41934dd2021-08-07 19:13:43 +01004479 }
4480#endif /* MBEDTLS_SSL_PROTO_DTLS */
4481
Gilles Peskine449bd832023-01-11 14:50:10 +01004482 return ret;
Hanno Becker41934dd2021-08-07 19:13:43 +01004483}
4484
Gilles Peskine449bd832023-01-11 14:50:10 +01004485int mbedtls_ssl_handshake_step(mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00004486{
Hanno Becker41934dd2021-08-07 19:13:43 +01004487 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00004488
Gilles Peskine449bd832023-01-11 14:50:10 +01004489 if (ssl == NULL ||
Hanno Becker41934dd2021-08-07 19:13:43 +01004490 ssl->conf == NULL ||
4491 ssl->handshake == NULL ||
Gilles Peskine449bd832023-01-11 14:50:10 +01004492 ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER) {
4493 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Becker41934dd2021-08-07 19:13:43 +01004494 }
4495
Gilles Peskine449bd832023-01-11 14:50:10 +01004496 ret = ssl_prepare_handshake_step(ssl);
4497 if (ret != 0) {
4498 return ret;
4499 }
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02004500
Gilles Peskine449bd832023-01-11 14:50:10 +01004501 ret = mbedtls_ssl_handle_pending_alert(ssl);
4502 if (ret != 0) {
Jerry Yue7047812021-09-13 19:26:39 +08004503 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01004504 }
Jerry Yue7047812021-09-13 19:26:39 +08004505
Tom Cosgrove2fdc7b32022-09-21 12:33:17 +01004506 /* If ssl->conf->endpoint is not one of MBEDTLS_SSL_IS_CLIENT or
4507 * MBEDTLS_SSL_IS_SERVER, this is the return code we give */
4508 ret = MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4509
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004510#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004511 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
4512 MBEDTLS_SSL_DEBUG_MSG(2, ("client state: %s",
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01004513 mbedtls_ssl_states_str((mbedtls_ssl_states) ssl->state)));
Jerry Yub9930e72021-08-06 17:11:51 +08004514
Gilles Peskine449bd832023-01-11 14:50:10 +01004515 switch (ssl->state) {
Ronald Cron9f0fba32022-02-10 16:45:15 +01004516 case MBEDTLS_SSL_HELLO_REQUEST:
4517 ssl->state = MBEDTLS_SSL_CLIENT_HELLO;
Tom Cosgrove87d9c6c2022-09-22 09:27:56 +01004518 ret = 0;
Ronald Cron9f0fba32022-02-10 16:45:15 +01004519 break;
Jerry Yub9930e72021-08-06 17:11:51 +08004520
Ronald Cron9f0fba32022-02-10 16:45:15 +01004521 case MBEDTLS_SSL_CLIENT_HELLO:
Gilles Peskine449bd832023-01-11 14:50:10 +01004522 ret = mbedtls_ssl_write_client_hello(ssl);
Ronald Cron9f0fba32022-02-10 16:45:15 +01004523 break;
4524
4525 default:
4526#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004527 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
4528 ret = mbedtls_ssl_tls13_handshake_client_step(ssl);
4529 } else {
4530 ret = mbedtls_ssl_handshake_client_step(ssl);
4531 }
Ronald Cron9f0fba32022-02-10 16:45:15 +01004532#elif defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01004533 ret = mbedtls_ssl_handshake_client_step(ssl);
Ronald Cron9f0fba32022-02-10 16:45:15 +01004534#else
Gilles Peskine449bd832023-01-11 14:50:10 +01004535 ret = mbedtls_ssl_tls13_handshake_client_step(ssl);
Ronald Cron9f0fba32022-02-10 16:45:15 +01004536#endif
4537 }
Jerry Yub9930e72021-08-06 17:11:51 +08004538 }
Ronald Cron6291b232023-03-08 15:51:25 +01004539#endif /* MBEDTLS_SSL_CLI_C */
4540
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004541#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004542 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Ronald Cron6291b232023-03-08 15:51:25 +01004543#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
4544 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Gilles Peskine449bd832023-01-11 14:50:10 +01004545 ret = mbedtls_ssl_tls13_handshake_server_step(ssl);
Ronald Cron6291b232023-03-08 15:51:25 +01004546 } else {
Gilles Peskine449bd832023-01-11 14:50:10 +01004547 ret = mbedtls_ssl_handshake_server_step(ssl);
4548 }
Ronald Cron6291b232023-03-08 15:51:25 +01004549#elif defined(MBEDTLS_SSL_PROTO_TLS1_2)
4550 ret = mbedtls_ssl_handshake_server_step(ssl);
4551#else
4552 ret = mbedtls_ssl_tls13_handshake_server_step(ssl);
Paul Bakker5121ce52009-01-03 21:22:43 +00004553#endif
Ronald Cron6291b232023-03-08 15:51:25 +01004554 }
4555#endif /* MBEDTLS_SSL_SRV_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00004556
Gilles Peskine449bd832023-01-11 14:50:10 +01004557 if (ret != 0) {
Jerry Yubbd5a3f2021-09-18 20:50:22 +08004558 /* handshake_step return error. And it is same
4559 * with alert_reason.
4560 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004561 if (ssl->send_alert) {
4562 ret = mbedtls_ssl_handle_pending_alert(ssl);
Jerry Yue7047812021-09-13 19:26:39 +08004563 goto cleanup;
4564 }
4565 }
4566
4567cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +01004568 return ret;
Paul Bakker1961b702013-01-25 14:49:24 +01004569}
4570
4571/*
4572 * Perform the SSL handshake
4573 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004574int mbedtls_ssl_handshake(mbedtls_ssl_context *ssl)
Paul Bakker1961b702013-01-25 14:49:24 +01004575{
4576 int ret = 0;
4577
Hanno Beckera817ea42020-10-20 15:20:23 +01004578 /* Sanity checks */
4579
Gilles Peskine449bd832023-01-11 14:50:10 +01004580 if (ssl == NULL || ssl->conf == NULL) {
4581 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4582 }
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02004583
Hanno Beckera817ea42020-10-20 15:20:23 +01004584#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004585 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
4586 (ssl->f_set_timer == NULL || ssl->f_get_timer == NULL)) {
4587 MBEDTLS_SSL_DEBUG_MSG(1, ("You must use "
4588 "mbedtls_ssl_set_timer_cb() for DTLS"));
4589 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Beckera817ea42020-10-20 15:20:23 +01004590 }
4591#endif /* MBEDTLS_SSL_PROTO_DTLS */
4592
Gilles Peskine449bd832023-01-11 14:50:10 +01004593 MBEDTLS_SSL_DEBUG_MSG(2, ("=> handshake"));
Paul Bakker1961b702013-01-25 14:49:24 +01004594
Hanno Beckera817ea42020-10-20 15:20:23 +01004595 /* Main handshake loop */
Gilles Peskine449bd832023-01-11 14:50:10 +01004596 while (ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER) {
4597 ret = mbedtls_ssl_handshake_step(ssl);
Paul Bakker1961b702013-01-25 14:49:24 +01004598
Gilles Peskine449bd832023-01-11 14:50:10 +01004599 if (ret != 0) {
Paul Bakker1961b702013-01-25 14:49:24 +01004600 break;
Gilles Peskine449bd832023-01-11 14:50:10 +01004601 }
Paul Bakker1961b702013-01-25 14:49:24 +01004602 }
4603
Gilles Peskine449bd832023-01-11 14:50:10 +01004604 MBEDTLS_SSL_DEBUG_MSG(2, ("<= handshake"));
Paul Bakker5121ce52009-01-03 21:22:43 +00004605
Gilles Peskine449bd832023-01-11 14:50:10 +01004606 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00004607}
4608
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004609#if defined(MBEDTLS_SSL_RENEGOTIATION)
4610#if defined(MBEDTLS_SSL_SRV_C)
Paul Bakker5121ce52009-01-03 21:22:43 +00004611/*
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004612 * Write HelloRequest to request renegotiation on server
Paul Bakker48916f92012-09-16 19:57:18 +00004613 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004614MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004615static int ssl_write_hello_request(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004616{
Janos Follath865b3eb2019-12-16 11:46:15 +00004617 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004618
Gilles Peskine449bd832023-01-11 14:50:10 +01004619 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write hello request"));
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004620
4621 ssl->out_msglen = 4;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004622 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
4623 ssl->out_msg[0] = MBEDTLS_SSL_HS_HELLO_REQUEST;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004624
Gilles Peskine449bd832023-01-11 14:50:10 +01004625 if ((ret = mbedtls_ssl_write_handshake_msg(ssl)) != 0) {
4626 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_handshake_msg", ret);
4627 return ret;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004628 }
4629
Gilles Peskine449bd832023-01-11 14:50:10 +01004630 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write hello request"));
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004631
Gilles Peskine449bd832023-01-11 14:50:10 +01004632 return 0;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004633}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004634#endif /* MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004635
4636/*
4637 * Actually renegotiate current connection, triggered by either:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004638 * - any side: calling mbedtls_ssl_renegotiate(),
4639 * - client: receiving a HelloRequest during mbedtls_ssl_read(),
4640 * - server: receiving any handshake message on server during mbedtls_ssl_read() after
Manuel Pégourié-Gonnard55e4ff22014-08-19 11:16:35 +02004641 * the initial handshake is completed.
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004642 * If the handshake doesn't complete due to waiting for I/O, it will continue
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004643 * during the next calls to mbedtls_ssl_renegotiate() or mbedtls_ssl_read() respectively.
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004644 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004645int mbedtls_ssl_start_renegotiation(mbedtls_ssl_context *ssl)
Paul Bakker48916f92012-09-16 19:57:18 +00004646{
Janos Follath865b3eb2019-12-16 11:46:15 +00004647 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker48916f92012-09-16 19:57:18 +00004648
Gilles Peskine449bd832023-01-11 14:50:10 +01004649 MBEDTLS_SSL_DEBUG_MSG(2, ("=> renegotiate"));
Paul Bakker48916f92012-09-16 19:57:18 +00004650
Gilles Peskine449bd832023-01-11 14:50:10 +01004651 if ((ret = ssl_handshake_init(ssl)) != 0) {
4652 return ret;
4653 }
Paul Bakker48916f92012-09-16 19:57:18 +00004654
Manuel Pégourié-Gonnard0557bd52014-08-19 19:18:39 +02004655 /* RFC 6347 4.2.2: "[...] the HelloRequest will have message_seq = 0 and
4656 * the ServerHello will have message_seq = 1" */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004657#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004658 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
4659 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING) {
4660 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02004661 ssl->handshake->out_msg_seq = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004662 } else {
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02004663 ssl->handshake->in_msg_seq = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004664 }
Manuel Pégourié-Gonnard0557bd52014-08-19 19:18:39 +02004665 }
4666#endif
4667
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004668 ssl->state = MBEDTLS_SSL_HELLO_REQUEST;
4669 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS;
Paul Bakker48916f92012-09-16 19:57:18 +00004670
Gilles Peskine449bd832023-01-11 14:50:10 +01004671 if ((ret = mbedtls_ssl_handshake(ssl)) != 0) {
4672 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_handshake", ret);
4673 return ret;
Paul Bakker48916f92012-09-16 19:57:18 +00004674 }
4675
Gilles Peskine449bd832023-01-11 14:50:10 +01004676 MBEDTLS_SSL_DEBUG_MSG(2, ("<= renegotiate"));
Paul Bakker48916f92012-09-16 19:57:18 +00004677
Gilles Peskine449bd832023-01-11 14:50:10 +01004678 return 0;
Paul Bakker48916f92012-09-16 19:57:18 +00004679}
4680
4681/*
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004682 * Renegotiate current connection on client,
4683 * or request renegotiation on server
4684 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004685int mbedtls_ssl_renegotiate(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004686{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004687 int ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004688
Gilles Peskine449bd832023-01-11 14:50:10 +01004689 if (ssl == NULL || ssl->conf == NULL) {
4690 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4691 }
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02004692
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004693#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004694 /* On server, just send the request */
Gilles Peskine449bd832023-01-11 14:50:10 +01004695 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
4696 if (mbedtls_ssl_is_handshake_over(ssl) == 0) {
4697 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4698 }
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004699
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004700 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_PENDING;
Manuel Pégourié-Gonnardf07f4212014-08-15 19:04:47 +02004701
4702 /* Did we already try/start sending HelloRequest? */
Gilles Peskine449bd832023-01-11 14:50:10 +01004703 if (ssl->out_left != 0) {
4704 return mbedtls_ssl_flush_output(ssl);
4705 }
Manuel Pégourié-Gonnardf07f4212014-08-15 19:04:47 +02004706
Gilles Peskine449bd832023-01-11 14:50:10 +01004707 return ssl_write_hello_request(ssl);
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004708 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004709#endif /* MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004710
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004711#if defined(MBEDTLS_SSL_CLI_C)
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004712 /*
4713 * On client, either start the renegotiation process or,
4714 * if already in progress, continue the handshake
4715 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004716 if (ssl->renego_status != MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS) {
4717 if (mbedtls_ssl_is_handshake_over(ssl) == 0) {
4718 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004719 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004720
4721 if ((ret = mbedtls_ssl_start_renegotiation(ssl)) != 0) {
4722 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_start_renegotiation", ret);
4723 return ret;
4724 }
4725 } else {
4726 if ((ret = mbedtls_ssl_handshake(ssl)) != 0) {
4727 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_handshake", ret);
4728 return ret;
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004729 }
4730 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004731#endif /* MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004732
Gilles Peskine449bd832023-01-11 14:50:10 +01004733 return ret;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004734}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004735#endif /* MBEDTLS_SSL_RENEGOTIATION */
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004736
Gilles Peskine449bd832023-01-11 14:50:10 +01004737void mbedtls_ssl_handshake_free(mbedtls_ssl_context *ssl)
Paul Bakker48916f92012-09-16 19:57:18 +00004738{
Gilles Peskine9b562d52018-04-25 20:32:43 +02004739 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
4740
Gilles Peskine449bd832023-01-11 14:50:10 +01004741 if (handshake == NULL) {
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004742 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01004743 }
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004744
Valerio Setti6f0441d2023-07-03 12:11:36 +02004745#if defined(MBEDTLS_PK_HAVE_ECC_KEYS)
Brett Warrene0edc842021-08-17 09:53:13 +01004746#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004747 if (ssl->handshake->group_list_heap_allocated) {
4748 mbedtls_free((void *) handshake->group_list);
4749 }
Brett Warrene0edc842021-08-17 09:53:13 +01004750 handshake->group_list = NULL;
4751#endif /* MBEDTLS_DEPRECATED_REMOVED */
Valerio Setti6f0441d2023-07-03 12:11:36 +02004752#endif /* MBEDTLS_PK_HAVE_ECC_KEYS */
Brett Warrene0edc842021-08-17 09:53:13 +01004753
Ronald Crone68ab4f2022-10-05 12:46:29 +02004754#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yuf017ee42022-01-12 15:49:48 +08004755#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004756 if (ssl->handshake->sig_algs_heap_allocated) {
4757 mbedtls_free((void *) handshake->sig_algs);
4758 }
Jerry Yuf017ee42022-01-12 15:49:48 +08004759 handshake->sig_algs = NULL;
4760#endif /* MBEDTLS_DEPRECATED_REMOVED */
Xiaofei Baic234ecf2022-02-08 09:59:23 +00004761#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004762 if (ssl->handshake->certificate_request_context) {
4763 mbedtls_free((void *) handshake->certificate_request_context);
Xiaofei Baic234ecf2022-02-08 09:59:23 +00004764 }
4765#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Ronald Crone68ab4f2022-10-05 12:46:29 +02004766#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Jerry Yuf017ee42022-01-12 15:49:48 +08004767
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02004768#if defined(MBEDTLS_SSL_ASYNC_PRIVATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01004769 if (ssl->conf->f_async_cancel != NULL && handshake->async_in_progress != 0) {
4770 ssl->conf->f_async_cancel(ssl);
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02004771 handshake->async_in_progress = 0;
4772 }
4773#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
4774
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01004775#if defined(MBEDTLS_MD_CAN_SHA256)
Andrzej Kurekeb342242019-01-29 09:14:33 -05004776#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01004777 psa_hash_abort(&handshake->fin_sha256_psa);
Andrzej Kurekeb342242019-01-29 09:14:33 -05004778#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01004779 mbedtls_md_free(&handshake->fin_sha256);
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02004780#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -05004781#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01004782#if defined(MBEDTLS_MD_CAN_SHA384)
Andrzej Kurekeb342242019-01-29 09:14:33 -05004783#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01004784 psa_hash_abort(&handshake->fin_sha384_psa);
Andrzej Kurekeb342242019-01-29 09:14:33 -05004785#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01004786 mbedtls_md_free(&handshake->fin_sha384);
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02004787#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -05004788#endif
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02004789
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004790#if defined(MBEDTLS_DHM_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004791 mbedtls_dhm_free(&handshake->dhm_ctx);
Paul Bakker48916f92012-09-16 19:57:18 +00004792#endif
Valerio Setti7aeec542023-07-05 18:57:21 +02004793#if !defined(MBEDTLS_USE_PSA_CRYPTO) && \
Valerio Setti6eb00542023-07-07 17:04:24 +02004794 defined(MBEDTLS_KEY_EXCHANGE_SOME_ECDH_OR_ECDHE_1_2_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004795 mbedtls_ecdh_free(&handshake->ecdh_ctx);
Paul Bakker61d113b2013-07-04 11:51:43 +02004796#endif
Valerio Setti02c25b52022-11-15 14:08:42 +01004797
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02004798#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Neil Armstrongca7d5062022-05-31 14:43:23 +02004799#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01004800 psa_pake_abort(&handshake->psa_pake_ctx);
Valerio Settieb3f7882022-12-08 18:42:58 +01004801 /*
4802 * Opaque keys are not stored in the handshake's data and it's the user
4803 * responsibility to destroy them. Clear ones, instead, are created by
4804 * the TLS library and should be destroyed at the same level
4805 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004806 if (!mbedtls_svc_key_id_is_null(handshake->psa_pake_password)) {
4807 psa_destroy_key(handshake->psa_pake_password);
Valerio Settieb3f7882022-12-08 18:42:58 +01004808 }
Neil Armstrongca7d5062022-05-31 14:43:23 +02004809 handshake->psa_pake_password = MBEDTLS_SVC_KEY_ID_INIT;
4810#else
Gilles Peskine449bd832023-01-11 14:50:10 +01004811 mbedtls_ecjpake_free(&handshake->ecjpake_ctx);
Neil Armstrongca7d5062022-05-31 14:43:23 +02004812#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard77c06462015-09-17 13:59:49 +02004813#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004814 mbedtls_free(handshake->ecjpake_cache);
Manuel Pégourié-Gonnard77c06462015-09-17 13:59:49 +02004815 handshake->ecjpake_cache = NULL;
4816 handshake->ecjpake_cache_len = 0;
4817#endif
Manuel Pégourié-Gonnard76cfd3f2015-09-15 12:10:54 +02004818#endif
Paul Bakker61d113b2013-07-04 11:51:43 +02004819
Valerio Setti7aeec542023-07-05 18:57:21 +02004820#if defined(MBEDTLS_KEY_EXCHANGE_SOME_ECDH_OR_ECDHE_ANY_ENABLED) || \
Valerio Setti45d56f32023-07-13 17:23:20 +02004821 defined(MBEDTLS_KEY_EXCHANGE_WITH_ECDSA_ANY_ENABLED) || \
Janos Follath4ae5c292016-02-10 11:27:43 +00004822 defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Paul Bakker9af723c2014-05-01 13:03:14 +02004823 /* explicit void pointer cast for buggy MS compiler */
Gilles Peskine449bd832023-01-11 14:50:10 +01004824 mbedtls_free((void *) handshake->curves_tls_id);
Manuel Pégourié-Gonnardd09453c2013-09-23 19:11:32 +02004825#endif
4826
Ronald Cron73fe8df2022-10-05 14:31:43 +02004827#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED)
Neil Armstrong501c9322022-05-03 09:35:09 +02004828#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01004829 if (!mbedtls_svc_key_id_is_null(ssl->handshake->psk_opaque)) {
Neil Armstrong501c9322022-05-03 09:35:09 +02004830 /* The maintenance of the external PSK key slot is the
4831 * user's responsibility. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004832 if (ssl->handshake->psk_opaque_is_internal) {
4833 psa_destroy_key(ssl->handshake->psk_opaque);
Neil Armstrong501c9322022-05-03 09:35:09 +02004834 ssl->handshake->psk_opaque_is_internal = 0;
4835 }
4836 ssl->handshake->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
4837 }
Neil Armstronge952a302022-05-03 10:22:14 +02004838#else
Gilles Peskine449bd832023-01-11 14:50:10 +01004839 if (handshake->psk != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01004840 mbedtls_zeroize_and_free(handshake->psk, handshake->psk_len);
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01004841 }
Neil Armstronge952a302022-05-03 10:22:14 +02004842#endif /* MBEDTLS_USE_PSA_CRYPTO */
Ronald Cron73fe8df2022-10-05 14:31:43 +02004843#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED */
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01004844
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004845#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
4846 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Manuel Pégourié-Gonnard83724542013-09-24 22:30:56 +02004847 /*
4848 * Free only the linked list wrapper, not the keys themselves
4849 * since the belong to the SNI callback
4850 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004851 ssl_key_cert_free(handshake->sni_key_cert);
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004852#endif /* MBEDTLS_X509_CRT_PARSE_C && MBEDTLS_SSL_SERVER_NAME_INDICATION */
Manuel Pégourié-Gonnard705fcca2013-09-23 20:04:20 +02004853
Gilles Peskineeccd8882020-03-10 12:19:08 +01004854#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004855 mbedtls_x509_crt_restart_free(&handshake->ecrs_ctx);
4856 if (handshake->ecrs_peer_cert != NULL) {
4857 mbedtls_x509_crt_free(handshake->ecrs_peer_cert);
4858 mbedtls_free(handshake->ecrs_peer_cert);
Hanno Becker3dad3112019-02-05 17:19:52 +00004859 }
Manuel Pégourié-Gonnard862cde52017-05-17 11:56:15 +02004860#endif
4861
Hanno Becker75173122019-02-06 16:18:31 +00004862#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
4863 !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01004864 mbedtls_pk_free(&handshake->peer_pubkey);
Hanno Becker75173122019-02-06 16:18:31 +00004865#endif /* MBEDTLS_X509_CRT_PARSE_C && !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
4866
XiaokangQian9b93c0d2022-02-09 06:02:25 +00004867#if defined(MBEDTLS_SSL_CLI_C) && \
Gilles Peskine449bd832023-01-11 14:50:10 +01004868 (defined(MBEDTLS_SSL_PROTO_DTLS) || defined(MBEDTLS_SSL_PROTO_TLS1_3))
4869 mbedtls_free(handshake->cookie);
XiaokangQian9b93c0d2022-02-09 06:02:25 +00004870#endif /* MBEDTLS_SSL_CLI_C &&
4871 ( MBEDTLS_SSL_PROTO_DTLS || MBEDTLS_SSL_PROTO_TLS1_3 ) */
XiaokangQian8499b6c2022-01-27 09:00:11 +00004872
4873#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004874 mbedtls_ssl_flight_free(handshake->flight);
4875 mbedtls_ssl_buffering_free(ssl);
XiaokangQian8499b6c2022-01-27 09:00:11 +00004876#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard74848812014-07-11 02:43:49 +02004877
Valerio Settiea59c432023-07-25 11:14:03 +02004878#if defined(MBEDTLS_KEY_EXCHANGE_SOME_XXDH_PSA_ANY_ENABLED)
Przemek Stekiel7ac93be2023-07-04 10:02:38 +02004879 if (handshake->xxdh_psa_privkey_is_external == 0) {
4880 psa_destroy_key(handshake->xxdh_psa_privkey);
Gilles Peskine449bd832023-01-11 14:50:10 +01004881 }
Valerio Settiea59c432023-07-25 11:14:03 +02004882#endif /* MBEDTLS_KEY_EXCHANGE_SOME_XXDH_PSA_ANY_ENABLED */
Hanno Becker4a63ed42019-01-08 11:39:35 +00004883
Ronald Cron6f135e12021-12-08 16:57:54 +01004884#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004885 mbedtls_ssl_transform_free(handshake->transform_handshake);
4886 mbedtls_free(handshake->transform_handshake);
Jerry Yu3d9b5902022-11-04 14:07:25 +08004887#if defined(MBEDTLS_SSL_EARLY_DATA)
Gilles Peskine449bd832023-01-11 14:50:10 +01004888 mbedtls_ssl_transform_free(handshake->transform_earlydata);
4889 mbedtls_free(handshake->transform_earlydata);
Jerry Yu3d9b5902022-11-04 14:07:25 +08004890#endif
Ronald Cron6f135e12021-12-08 16:57:54 +01004891#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yuba9c7272021-10-30 11:54:10 +08004892
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05004893
4894#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
4895 /* If the buffers are too big - reallocate. Because of the way Mbed TLS
4896 * processes datagrams and the fact that a datagram is allowed to have
4897 * several records in it, it is possible that the I/O buffers are not
4898 * empty at this stage */
Gilles Peskine449bd832023-01-11 14:50:10 +01004899 handle_buffer_resizing(ssl, 1, mbedtls_ssl_get_input_buflen(ssl),
4900 mbedtls_ssl_get_output_buflen(ssl));
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05004901#endif
Hanno Becker3aa186f2021-08-10 09:24:19 +01004902
Jerry Yuba9c7272021-10-30 11:54:10 +08004903 /* mbedtls_platform_zeroize MUST be last one in this function */
Gilles Peskine449bd832023-01-11 14:50:10 +01004904 mbedtls_platform_zeroize(handshake,
4905 sizeof(mbedtls_ssl_handshake_params));
Paul Bakker48916f92012-09-16 19:57:18 +00004906}
4907
Gilles Peskine449bd832023-01-11 14:50:10 +01004908void mbedtls_ssl_session_free(mbedtls_ssl_session *session)
Paul Bakker48916f92012-09-16 19:57:18 +00004909{
Gilles Peskine449bd832023-01-11 14:50:10 +01004910 if (session == NULL) {
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004911 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01004912 }
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004913
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004914#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004915 ssl_clear_peer_cert(session);
Paul Bakkered27a042013-04-18 22:46:23 +02004916#endif
Paul Bakker0a597072012-09-25 21:55:46 +00004917
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02004918#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
Xiaokang Qianbc663a02022-10-09 11:14:39 +00004919#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && \
4920 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01004921 mbedtls_free(session->hostname);
Xiaokang Qian281fd1b2022-09-20 11:35:41 +00004922#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01004923 mbedtls_free(session->ticket);
Paul Bakkera503a632013-08-14 13:48:06 +02004924#endif
Manuel Pégourié-Gonnard75d44012013-08-02 14:44:04 +02004925
Waleed Elmelegy2824a202024-02-23 17:51:47 +00004926#if defined(MBEDTLS_SSL_EARLY_DATA) && defined(MBEDTLS_SSL_ALPN) && \
4927 defined(MBEDTLS_SSL_SRV_C)
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00004928 mbedtls_free(session->ticket_alpn);
Paul Bakker5121ce52009-01-03 21:22:43 +00004929#endif
4930
Gilles Peskine449bd832023-01-11 14:50:10 +01004931 mbedtls_platform_zeroize(session, sizeof(mbedtls_ssl_session));
Paul Bakker5121ce52009-01-03 21:22:43 +00004932}
4933
Manuel Pégourié-Gonnard5c0e3772019-07-23 16:13:17 +02004934#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004935
4936#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
4937#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID 1u
4938#else
4939#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID 0u
4940#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
4941
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004942#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT 1u
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004943
4944#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
4945#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY 1u
4946#else
4947#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY 0u
4948#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
4949
4950#if defined(MBEDTLS_SSL_ALPN)
4951#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN 1u
4952#else
4953#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN 0u
4954#endif /* MBEDTLS_SSL_ALPN */
4955
4956#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID_BIT 0
4957#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT_BIT 1
4958#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY_BIT 2
4959#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN_BIT 3
4960
4961#define SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG \
Gilles Peskine449bd832023-01-11 14:50:10 +01004962 ((uint32_t) ( \
4963 (SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID << \
4964 SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID_BIT) | \
4965 (SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT << \
4966 SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT_BIT) | \
4967 (SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY << \
4968 SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY_BIT) | \
4969 (SSL_SERIALIZED_CONTEXT_CONFIG_ALPN << SSL_SERIALIZED_CONTEXT_CONFIG_ALPN_BIT) | \
4970 0u))
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004971
Chien Wong4e9683e2023-12-28 17:07:43 +08004972static const unsigned char ssl_serialized_context_header[] = {
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004973 MBEDTLS_VERSION_MAJOR,
4974 MBEDTLS_VERSION_MINOR,
4975 MBEDTLS_VERSION_PATCH,
Gilles Peskine449bd832023-01-11 14:50:10 +01004976 MBEDTLS_BYTE_1(SSL_SERIALIZED_SESSION_CONFIG_BITFLAG),
4977 MBEDTLS_BYTE_0(SSL_SERIALIZED_SESSION_CONFIG_BITFLAG),
4978 MBEDTLS_BYTE_2(SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG),
4979 MBEDTLS_BYTE_1(SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG),
4980 MBEDTLS_BYTE_0(SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG),
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004981};
4982
Paul Bakker5121ce52009-01-03 21:22:43 +00004983/*
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004984 * Serialize a full SSL context
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02004985 *
4986 * The format of the serialized data is:
4987 * (in the presentation language of TLS, RFC 8446 section 3)
4988 *
4989 * // header
4990 * opaque mbedtls_version[3]; // major, minor, patch
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004991 * opaque context_format[5]; // version-specific field determining
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02004992 * // the format of the remaining
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004993 * // serialized data.
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004994 * Note: When updating the format, remember to keep these
4995 * version+format bytes. (We may make their size part of the API.)
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02004996 *
4997 * // session sub-structure
4998 * opaque session<1..2^32-1>; // see mbedtls_ssl_session_save()
4999 * // transform sub-structure
5000 * uint8 random[64]; // ServerHello.random+ClientHello.random
5001 * uint8 in_cid<0..2^8-1> // Connection ID: expected incoming value
5002 * uint8 out_cid<0..2^8-1> // Connection ID: outgoing value to use
5003 * // fields from ssl_context
5004 * uint32 badmac_seen; // DTLS: number of records with failing MAC
5005 * uint64 in_window_top; // DTLS: last validated record seq_num
5006 * uint64 in_window; // DTLS: bitmask for replay protection
5007 * uint8 disable_datagram_packing; // DTLS: only one record per datagram
5008 * uint64 cur_out_ctr; // Record layer: outgoing sequence number
5009 * uint16 mtu; // DTLS: path mtu (max outgoing fragment size)
5010 * uint8 alpn_chosen<0..2^8-1> // ALPN: negotiated application protocol
5011 *
5012 * Note that many fields of the ssl_context or sub-structures are not
5013 * serialized, as they fall in one of the following categories:
5014 *
5015 * 1. forced value (eg in_left must be 0)
5016 * 2. pointer to dynamically-allocated memory (eg session, transform)
5017 * 3. value can be re-derived from other data (eg session keys from MS)
5018 * 4. value was temporary (eg content of input buffer)
5019 * 5. value will be provided by the user again (eg I/O callbacks and context)
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005020 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005021int mbedtls_ssl_context_save(mbedtls_ssl_context *ssl,
5022 unsigned char *buf,
5023 size_t buf_len,
5024 size_t *olen)
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005025{
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005026 unsigned char *p = buf;
5027 size_t used = 0;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005028 size_t session_len;
5029 int ret = 0;
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005030
Manuel Pégourié-Gonnard1aaf6692019-07-10 14:14:05 +02005031 /*
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02005032 * Enforce usage restrictions, see "return BAD_INPUT_DATA" in
5033 * this function's documentation.
5034 *
5035 * These are due to assumptions/limitations in the implementation. Some of
5036 * them are likely to stay (no handshake in progress) some might go away
5037 * (only DTLS) but are currently used to simplify the implementation.
Manuel Pégourié-Gonnard1aaf6692019-07-10 14:14:05 +02005038 */
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02005039 /* The initial handshake must be over */
Gilles Peskine449bd832023-01-11 14:50:10 +01005040 if (mbedtls_ssl_is_handshake_over(ssl) == 0) {
5041 MBEDTLS_SSL_DEBUG_MSG(1, ("Initial handshake isn't over"));
5042 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03005043 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005044 if (ssl->handshake != NULL) {
5045 MBEDTLS_SSL_DEBUG_MSG(1, ("Handshake isn't completed"));
5046 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03005047 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02005048 /* Double-check that sub-structures are indeed ready */
Gilles Peskine449bd832023-01-11 14:50:10 +01005049 if (ssl->transform == NULL || ssl->session == NULL) {
5050 MBEDTLS_SSL_DEBUG_MSG(1, ("Serialised structures aren't ready"));
5051 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03005052 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02005053 /* There must be no pending incoming or outgoing data */
Gilles Peskine449bd832023-01-11 14:50:10 +01005054 if (mbedtls_ssl_check_pending(ssl) != 0) {
5055 MBEDTLS_SSL_DEBUG_MSG(1, ("There is pending incoming data"));
5056 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03005057 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005058 if (ssl->out_left != 0) {
5059 MBEDTLS_SSL_DEBUG_MSG(1, ("There is pending outgoing data"));
5060 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03005061 }
Dave Rodgman556e8a32022-12-06 16:31:25 +00005062 /* Protocol must be DTLS, not TLS */
Gilles Peskine449bd832023-01-11 14:50:10 +01005063 if (ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
5064 MBEDTLS_SSL_DEBUG_MSG(1, ("Only DTLS is supported"));
5065 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03005066 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02005067 /* Version must be 1.2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005068 if (ssl->tls_version != MBEDTLS_SSL_VERSION_TLS1_2) {
5069 MBEDTLS_SSL_DEBUG_MSG(1, ("Only version 1.2 supported"));
5070 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03005071 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02005072 /* We must be using an AEAD ciphersuite */
Gilles Peskine449bd832023-01-11 14:50:10 +01005073 if (mbedtls_ssl_transform_uses_aead(ssl->transform) != 1) {
5074 MBEDTLS_SSL_DEBUG_MSG(1, ("Only AEAD ciphersuites supported"));
5075 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03005076 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02005077 /* Renegotiation must not be enabled */
5078#if defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01005079 if (ssl->conf->disable_renegotiation != MBEDTLS_SSL_RENEGOTIATION_DISABLED) {
5080 MBEDTLS_SSL_DEBUG_MSG(1, ("Renegotiation must not be enabled"));
5081 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03005082 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02005083#endif
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005084
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005085 /*
5086 * Version and format identifier
5087 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005088 used += sizeof(ssl_serialized_context_header);
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005089
Gilles Peskine449bd832023-01-11 14:50:10 +01005090 if (used <= buf_len) {
5091 memcpy(p, ssl_serialized_context_header,
5092 sizeof(ssl_serialized_context_header));
5093 p += sizeof(ssl_serialized_context_header);
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005094 }
5095
5096 /*
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005097 * Session (length + data)
5098 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005099 ret = ssl_session_save(ssl->session, 1, NULL, 0, &session_len);
5100 if (ret != MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL) {
5101 return ret;
5102 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005103
5104 used += 4 + session_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01005105 if (used <= buf_len) {
5106 MBEDTLS_PUT_UINT32_BE(session_len, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01005107 p += 4;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005108
Gilles Peskine449bd832023-01-11 14:50:10 +01005109 ret = ssl_session_save(ssl->session, 1,
5110 p, session_len, &session_len);
5111 if (ret != 0) {
5112 return ret;
5113 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005114
5115 p += session_len;
5116 }
5117
5118 /*
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005119 * Transform
5120 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005121 used += sizeof(ssl->transform->randbytes);
5122 if (used <= buf_len) {
5123 memcpy(p, ssl->transform->randbytes,
5124 sizeof(ssl->transform->randbytes));
5125 p += sizeof(ssl->transform->randbytes);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005126 }
5127
5128#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Dave Rodgmanc37ad442023-11-03 23:36:06 +00005129 used += 2U + ssl->transform->in_cid_len + ssl->transform->out_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01005130 if (used <= buf_len) {
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005131 *p++ = ssl->transform->in_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01005132 memcpy(p, ssl->transform->in_cid, ssl->transform->in_cid_len);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005133 p += ssl->transform->in_cid_len;
5134
5135 *p++ = ssl->transform->out_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01005136 memcpy(p, ssl->transform->out_cid, ssl->transform->out_cid_len);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005137 p += ssl->transform->out_cid_len;
5138 }
5139#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
5140
5141 /*
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005142 * Saved fields from top-level ssl_context structure
5143 */
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005144 used += 4;
Gilles Peskine449bd832023-01-11 14:50:10 +01005145 if (used <= buf_len) {
5146 MBEDTLS_PUT_UINT32_BE(ssl->badmac_seen, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01005147 p += 4;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005148 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005149
5150#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
5151 used += 16;
Gilles Peskine449bd832023-01-11 14:50:10 +01005152 if (used <= buf_len) {
5153 MBEDTLS_PUT_UINT64_BE(ssl->in_window_top, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01005154 p += 8;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005155
Gilles Peskine449bd832023-01-11 14:50:10 +01005156 MBEDTLS_PUT_UINT64_BE(ssl->in_window, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01005157 p += 8;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005158 }
5159#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
5160
5161#if defined(MBEDTLS_SSL_PROTO_DTLS)
5162 used += 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01005163 if (used <= buf_len) {
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005164 *p++ = ssl->disable_datagram_packing;
5165 }
5166#endif /* MBEDTLS_SSL_PROTO_DTLS */
5167
Jerry Yuae0b2e22021-10-08 15:21:19 +08005168 used += MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Gilles Peskine449bd832023-01-11 14:50:10 +01005169 if (used <= buf_len) {
5170 memcpy(p, ssl->cur_out_ctr, MBEDTLS_SSL_SEQUENCE_NUMBER_LEN);
Jerry Yuae0b2e22021-10-08 15:21:19 +08005171 p += MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005172 }
5173
5174#if defined(MBEDTLS_SSL_PROTO_DTLS)
5175 used += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01005176 if (used <= buf_len) {
5177 MBEDTLS_PUT_UINT16_BE(ssl->mtu, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01005178 p += 2;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005179 }
5180#endif /* MBEDTLS_SSL_PROTO_DTLS */
5181
5182#if defined(MBEDTLS_SSL_ALPN)
5183 {
5184 const uint8_t alpn_len = ssl->alpn_chosen
Gilles Peskine449bd832023-01-11 14:50:10 +01005185 ? (uint8_t) strlen(ssl->alpn_chosen)
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005186 : 0;
5187
5188 used += 1 + alpn_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01005189 if (used <= buf_len) {
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005190 *p++ = alpn_len;
5191
Gilles Peskine449bd832023-01-11 14:50:10 +01005192 if (ssl->alpn_chosen != NULL) {
5193 memcpy(p, ssl->alpn_chosen, alpn_len);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005194 p += alpn_len;
5195 }
5196 }
5197 }
5198#endif /* MBEDTLS_SSL_ALPN */
5199
5200 /*
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005201 * Done
5202 */
5203 *olen = used;
5204
Gilles Peskine449bd832023-01-11 14:50:10 +01005205 if (used > buf_len) {
5206 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
5207 }
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005208
Gilles Peskine449bd832023-01-11 14:50:10 +01005209 MBEDTLS_SSL_DEBUG_BUF(4, "saved context", buf, used);
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005210
Gilles Peskine449bd832023-01-11 14:50:10 +01005211 return mbedtls_ssl_session_reset_int(ssl, 0);
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005212}
5213
5214/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02005215 * Deserialize context, see mbedtls_ssl_context_save() for format.
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005216 *
5217 * This internal version is wrapped by a public function that cleans up in
5218 * case of error.
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005219 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005220MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01005221static int ssl_context_load(mbedtls_ssl_context *ssl,
5222 const unsigned char *buf,
5223 size_t len)
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005224{
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005225 const unsigned char *p = buf;
5226 const unsigned char * const end = buf + len;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005227 size_t session_len;
Janos Follath865b3eb2019-12-16 11:46:15 +00005228 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04005229#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Andrzej Kurek894edde2022-09-29 06:31:14 -04005230 tls_prf_fn prf_func = NULL;
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04005231#endif
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005232
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02005233 /*
5234 * The context should have been freshly setup or reset.
5235 * Give the user an error in case of obvious misuse.
Manuel Pégourié-Gonnard4ca930f2019-07-26 16:31:53 +02005236 * (Checking session is useful because it won't be NULL if we're
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02005237 * renegotiating, or if the user mistakenly loaded a session first.)
5238 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005239 if (ssl->state != MBEDTLS_SSL_HELLO_REQUEST ||
5240 ssl->session != NULL) {
5241 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02005242 }
5243
5244 /*
5245 * We can't check that the config matches the initial one, but we can at
5246 * least check it matches the requirements for serializing.
5247 */
Dave Rodgmane99b24d2023-09-14 15:45:03 +01005248 if (
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02005249#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard9a96fd72019-07-23 17:11:24 +02005250 ssl->conf->disable_renegotiation != MBEDTLS_SSL_RENEGOTIATION_DISABLED ||
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02005251#endif
Dave Rodgmane99b24d2023-09-14 15:45:03 +01005252 ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM ||
5253 ssl->conf->max_tls_version < MBEDTLS_SSL_VERSION_TLS1_2 ||
5254 ssl->conf->min_tls_version > MBEDTLS_SSL_VERSION_TLS1_2
5255 ) {
Gilles Peskine449bd832023-01-11 14:50:10 +01005256 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02005257 }
5258
Gilles Peskine449bd832023-01-11 14:50:10 +01005259 MBEDTLS_SSL_DEBUG_BUF(4, "context to load", buf, len);
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005260
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005261 /*
5262 * Check version identifier
5263 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005264 if ((size_t) (end - p) < sizeof(ssl_serialized_context_header)) {
5265 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005266 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005267
5268 if (memcmp(p, ssl_serialized_context_header,
5269 sizeof(ssl_serialized_context_header)) != 0) {
5270 return MBEDTLS_ERR_SSL_VERSION_MISMATCH;
5271 }
5272 p += sizeof(ssl_serialized_context_header);
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005273
5274 /*
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005275 * Session
5276 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005277 if ((size_t) (end - p) < 4) {
5278 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5279 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005280
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01005281 session_len = MBEDTLS_GET_UINT32_BE(p, 0);
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005282 p += 4;
5283
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02005284 /* This has been allocated by ssl_handshake_init(), called by
Hanno Becker43aefe22020-02-05 10:44:56 +00005285 * by either mbedtls_ssl_session_reset_int() or mbedtls_ssl_setup(). */
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02005286 ssl->session = ssl->session_negotiate;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005287 ssl->session_in = ssl->session;
5288 ssl->session_out = ssl->session;
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02005289 ssl->session_negotiate = NULL;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005290
Gilles Peskine449bd832023-01-11 14:50:10 +01005291 if ((size_t) (end - p) < session_len) {
5292 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5293 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005294
Gilles Peskine449bd832023-01-11 14:50:10 +01005295 ret = ssl_session_load(ssl->session, 1, p, session_len);
5296 if (ret != 0) {
5297 mbedtls_ssl_session_free(ssl->session);
5298 return ret;
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02005299 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005300
5301 p += session_len;
5302
5303 /*
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005304 * Transform
5305 */
5306
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02005307 /* This has been allocated by ssl_handshake_init(), called by
Hanno Becker43aefe22020-02-05 10:44:56 +00005308 * by either mbedtls_ssl_session_reset_int() or mbedtls_ssl_setup(). */
Jerry Yu2e199812022-12-01 18:57:19 +08005309#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02005310 ssl->transform = ssl->transform_negotiate;
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005311 ssl->transform_in = ssl->transform;
5312 ssl->transform_out = ssl->transform;
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02005313 ssl->transform_negotiate = NULL;
Jerry Yu2e199812022-12-01 18:57:19 +08005314#endif
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005315
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04005316#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005317 prf_func = ssl_tls12prf_from_cs(ssl->session->ciphersuite);
5318 if (prf_func == NULL) {
5319 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5320 }
Andrzej Kurek894edde2022-09-29 06:31:14 -04005321
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005322 /* Read random bytes and populate structure */
Gilles Peskine449bd832023-01-11 14:50:10 +01005323 if ((size_t) (end - p) < sizeof(ssl->transform->randbytes)) {
5324 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5325 }
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04005326
Gilles Peskine449bd832023-01-11 14:50:10 +01005327 ret = ssl_tls12_populate_transform(ssl->transform,
5328 ssl->session->ciphersuite,
5329 ssl->session->master,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02005330#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01005331 ssl->session->encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02005332#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01005333 prf_func,
5334 p, /* currently pointing to randbytes */
5335 MBEDTLS_SSL_VERSION_TLS1_2, /* (D)TLS 1.2 is forced */
5336 ssl->conf->endpoint,
5337 ssl);
5338 if (ret != 0) {
5339 return ret;
5340 }
Jerry Yu840fbb22022-02-17 14:59:29 +08005341#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005342 p += sizeof(ssl->transform->randbytes);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005343
5344#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
5345 /* Read connection IDs and store them */
Gilles Peskine449bd832023-01-11 14:50:10 +01005346 if ((size_t) (end - p) < 1) {
5347 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5348 }
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005349
5350 ssl->transform->in_cid_len = *p++;
5351
Gilles Peskine449bd832023-01-11 14:50:10 +01005352 if ((size_t) (end - p) < ssl->transform->in_cid_len + 1u) {
5353 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5354 }
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005355
Gilles Peskine449bd832023-01-11 14:50:10 +01005356 memcpy(ssl->transform->in_cid, p, ssl->transform->in_cid_len);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005357 p += ssl->transform->in_cid_len;
5358
5359 ssl->transform->out_cid_len = *p++;
5360
Gilles Peskine449bd832023-01-11 14:50:10 +01005361 if ((size_t) (end - p) < ssl->transform->out_cid_len) {
5362 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5363 }
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005364
Gilles Peskine449bd832023-01-11 14:50:10 +01005365 memcpy(ssl->transform->out_cid, p, ssl->transform->out_cid_len);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005366 p += ssl->transform->out_cid_len;
5367#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
5368
5369 /*
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005370 * Saved fields from top-level ssl_context structure
5371 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005372 if ((size_t) (end - p) < 4) {
5373 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5374 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005375
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01005376 ssl->badmac_seen = MBEDTLS_GET_UINT32_BE(p, 0);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005377 p += 4;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005378
5379#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Gilles Peskine449bd832023-01-11 14:50:10 +01005380 if ((size_t) (end - p) < 16) {
5381 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5382 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005383
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01005384 ssl->in_window_top = MBEDTLS_GET_UINT64_BE(p, 0);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005385 p += 8;
5386
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01005387 ssl->in_window = MBEDTLS_GET_UINT64_BE(p, 0);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005388 p += 8;
5389#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
5390
5391#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005392 if ((size_t) (end - p) < 1) {
5393 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5394 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005395
5396 ssl->disable_datagram_packing = *p++;
5397#endif /* MBEDTLS_SSL_PROTO_DTLS */
5398
Gilles Peskine449bd832023-01-11 14:50:10 +01005399 if ((size_t) (end - p) < sizeof(ssl->cur_out_ctr)) {
5400 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5401 }
5402 memcpy(ssl->cur_out_ctr, p, sizeof(ssl->cur_out_ctr));
5403 p += sizeof(ssl->cur_out_ctr);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005404
5405#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005406 if ((size_t) (end - p) < 2) {
5407 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5408 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005409
Dave Rodgmana3d0f612023-11-03 23:34:02 +00005410 ssl->mtu = MBEDTLS_GET_UINT16_BE(p, 0);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005411 p += 2;
5412#endif /* MBEDTLS_SSL_PROTO_DTLS */
5413
5414#if defined(MBEDTLS_SSL_ALPN)
5415 {
5416 uint8_t alpn_len;
5417 const char **cur;
5418
Gilles Peskine449bd832023-01-11 14:50:10 +01005419 if ((size_t) (end - p) < 1) {
5420 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5421 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005422
5423 alpn_len = *p++;
5424
Gilles Peskine449bd832023-01-11 14:50:10 +01005425 if (alpn_len != 0 && ssl->conf->alpn_list != NULL) {
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005426 /* alpn_chosen should point to an item in the configured list */
Gilles Peskine449bd832023-01-11 14:50:10 +01005427 for (cur = ssl->conf->alpn_list; *cur != NULL; cur++) {
5428 if (strlen(*cur) == alpn_len &&
Waleed Elmelegy131b2ff2024-03-14 01:39:39 +00005429 memcmp(p, *cur, alpn_len) == 0) {
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005430 ssl->alpn_chosen = *cur;
5431 break;
5432 }
5433 }
5434 }
5435
5436 /* can only happen on conf mismatch */
Gilles Peskine449bd832023-01-11 14:50:10 +01005437 if (alpn_len != 0 && ssl->alpn_chosen == NULL) {
5438 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5439 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005440
5441 p += alpn_len;
5442 }
5443#endif /* MBEDTLS_SSL_ALPN */
5444
5445 /*
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02005446 * Forced fields from top-level ssl_context structure
5447 *
5448 * Most of them already set to the correct value by mbedtls_ssl_init() and
5449 * mbedtls_ssl_reset(), so we only need to set the remaining ones.
5450 */
5451 ssl->state = MBEDTLS_SSL_HANDSHAKE_OVER;
Glenn Strauss60bfe602022-03-14 19:04:24 -04005452 ssl->tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02005453
Hanno Becker361b10d2019-08-30 10:42:49 +01005454 /* Adjust pointers for header fields of outgoing records to
5455 * the given transform, accounting for explicit IV and CID. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005456 mbedtls_ssl_update_out_pointers(ssl, ssl->transform);
Hanno Becker361b10d2019-08-30 10:42:49 +01005457
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02005458#if defined(MBEDTLS_SSL_PROTO_DTLS)
5459 ssl->in_epoch = 1;
5460#endif
5461
5462 /* mbedtls_ssl_reset() leaves the handshake sub-structure allocated,
5463 * which we don't want - otherwise we'd end up freeing the wrong transform
Hanno Beckerce5f5fd2020-02-05 10:47:44 +00005464 * by calling mbedtls_ssl_handshake_wrapup_free_hs_transform()
5465 * inappropriately. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005466 if (ssl->handshake != NULL) {
5467 mbedtls_ssl_handshake_free(ssl);
5468 mbedtls_free(ssl->handshake);
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02005469 ssl->handshake = NULL;
5470 }
5471
5472 /*
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005473 * Done - should have consumed entire buffer
5474 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005475 if (p != end) {
5476 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5477 }
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005478
Gilles Peskine449bd832023-01-11 14:50:10 +01005479 return 0;
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005480}
5481
5482/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02005483 * Deserialize context: public wrapper for error cleaning
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005484 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005485int mbedtls_ssl_context_load(mbedtls_ssl_context *context,
5486 const unsigned char *buf,
5487 size_t len)
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005488{
Gilles Peskine449bd832023-01-11 14:50:10 +01005489 int ret = ssl_context_load(context, buf, len);
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005490
Gilles Peskine449bd832023-01-11 14:50:10 +01005491 if (ret != 0) {
5492 mbedtls_ssl_free(context);
5493 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005494
Gilles Peskine449bd832023-01-11 14:50:10 +01005495 return ret;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005496}
Manuel Pégourié-Gonnard5c0e3772019-07-23 16:13:17 +02005497#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005498
5499/*
Paul Bakker5121ce52009-01-03 21:22:43 +00005500 * Free an SSL context
5501 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005502void mbedtls_ssl_free(mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00005503{
Gilles Peskine449bd832023-01-11 14:50:10 +01005504 if (ssl == NULL) {
Paul Bakkeraccaffe2014-06-26 13:37:14 +02005505 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01005506 }
Paul Bakkeraccaffe2014-06-26 13:37:14 +02005507
Gilles Peskine449bd832023-01-11 14:50:10 +01005508 MBEDTLS_SSL_DEBUG_MSG(2, ("=> free"));
Paul Bakker5121ce52009-01-03 21:22:43 +00005509
Gilles Peskine449bd832023-01-11 14:50:10 +01005510 if (ssl->out_buf != NULL) {
sander-visserb8aa2072020-05-06 22:05:13 +02005511#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
5512 size_t out_buf_len = ssl->out_buf_len;
5513#else
5514 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
5515#endif
5516
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005517 mbedtls_zeroize_and_free(ssl->out_buf, out_buf_len);
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05005518 ssl->out_buf = NULL;
Paul Bakker5121ce52009-01-03 21:22:43 +00005519 }
5520
Gilles Peskine449bd832023-01-11 14:50:10 +01005521 if (ssl->in_buf != NULL) {
sander-visserb8aa2072020-05-06 22:05:13 +02005522#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
5523 size_t in_buf_len = ssl->in_buf_len;
5524#else
5525 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
5526#endif
5527
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005528 mbedtls_zeroize_and_free(ssl->in_buf, in_buf_len);
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05005529 ssl->in_buf = NULL;
Paul Bakker5121ce52009-01-03 21:22:43 +00005530 }
5531
Gilles Peskine449bd832023-01-11 14:50:10 +01005532 if (ssl->transform) {
5533 mbedtls_ssl_transform_free(ssl->transform);
5534 mbedtls_free(ssl->transform);
Paul Bakker48916f92012-09-16 19:57:18 +00005535 }
5536
Gilles Peskine449bd832023-01-11 14:50:10 +01005537 if (ssl->handshake) {
5538 mbedtls_ssl_handshake_free(ssl);
5539 mbedtls_free(ssl->handshake);
Jerry Yu2e199812022-12-01 18:57:19 +08005540
5541#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005542 mbedtls_ssl_transform_free(ssl->transform_negotiate);
5543 mbedtls_free(ssl->transform_negotiate);
Jerry Yu2e199812022-12-01 18:57:19 +08005544#endif
5545
Gilles Peskine449bd832023-01-11 14:50:10 +01005546 mbedtls_ssl_session_free(ssl->session_negotiate);
5547 mbedtls_free(ssl->session_negotiate);
Paul Bakker48916f92012-09-16 19:57:18 +00005548 }
5549
Ronald Cron6f135e12021-12-08 16:57:54 +01005550#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01005551 mbedtls_ssl_transform_free(ssl->transform_application);
5552 mbedtls_free(ssl->transform_application);
Ronald Cron6f135e12021-12-08 16:57:54 +01005553#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker3aa186f2021-08-10 09:24:19 +01005554
Gilles Peskine449bd832023-01-11 14:50:10 +01005555 if (ssl->session) {
5556 mbedtls_ssl_session_free(ssl->session);
5557 mbedtls_free(ssl->session);
Paul Bakkerc0463502013-02-14 11:19:38 +01005558 }
5559
Manuel Pégourié-Gonnard55fab2d2015-05-11 16:15:19 +02005560#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005561 if (ssl->hostname != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005562 mbedtls_zeroize_and_free(ssl->hostname, strlen(ssl->hostname));
Paul Bakker5121ce52009-01-03 21:22:43 +00005563 }
Paul Bakker0be444a2013-08-27 21:55:01 +02005564#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00005565
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02005566#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005567 mbedtls_free(ssl->cli_id);
Manuel Pégourié-Gonnard43c02182014-07-22 17:32:01 +02005568#endif
5569
Gilles Peskine449bd832023-01-11 14:50:10 +01005570 MBEDTLS_SSL_DEBUG_MSG(2, ("<= free"));
Paul Bakker2da561c2009-02-05 18:00:28 +00005571
Paul Bakker86f04f42013-02-14 11:20:09 +01005572 /* Actually clear after last debug message */
Gilles Peskine449bd832023-01-11 14:50:10 +01005573 mbedtls_platform_zeroize(ssl, sizeof(mbedtls_ssl_context));
Paul Bakker5121ce52009-01-03 21:22:43 +00005574}
5575
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005576/*
Shaun Case8b0ecbc2021-12-20 21:14:10 -08005577 * Initialize mbedtls_ssl_config
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005578 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005579void mbedtls_ssl_config_init(mbedtls_ssl_config *conf)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005580{
Gilles Peskine449bd832023-01-11 14:50:10 +01005581 memset(conf, 0, sizeof(mbedtls_ssl_config));
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005582}
5583
Gilles Peskineae270bf2021-06-02 00:05:29 +02005584/* The selection should be the same as mbedtls_x509_crt_profile_default in
5585 * x509_crt.c, plus Montgomery curves for ECDHE. Here, the order matters:
Gilles Peskineb1940a72021-06-02 15:18:12 +02005586 * curves with a lower resource usage come first.
Gilles Peskineae270bf2021-06-02 00:05:29 +02005587 * See the documentation of mbedtls_ssl_conf_curves() for what we promise
Gilles Peskineb1940a72021-06-02 15:18:12 +02005588 * about this list.
5589 */
Chien Wong4e9683e2023-12-28 17:07:43 +08005590static const uint16_t ssl_preset_default_groups[] = {
Valerio Settidb6b4db2023-09-01 09:20:51 +02005591#if defined(MBEDTLS_ECP_HAVE_CURVE25519)
Brett Warrene0edc842021-08-17 09:53:13 +01005592 MBEDTLS_SSL_IANA_TLS_GROUP_X25519,
Gilles Peskineae270bf2021-06-02 00:05:29 +02005593#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005594#if defined(MBEDTLS_ECP_HAVE_SECP256R1)
Brett Warrene0edc842021-08-17 09:53:13 +01005595 MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1,
Gilles Peskineae270bf2021-06-02 00:05:29 +02005596#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005597#if defined(MBEDTLS_ECP_HAVE_SECP384R1)
Brett Warrene0edc842021-08-17 09:53:13 +01005598 MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02005599#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005600#if defined(MBEDTLS_ECP_HAVE_CURVE448)
Brett Warrene0edc842021-08-17 09:53:13 +01005601 MBEDTLS_SSL_IANA_TLS_GROUP_X448,
Gilles Peskineb1940a72021-06-02 15:18:12 +02005602#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005603#if defined(MBEDTLS_ECP_HAVE_SECP521R1)
Brett Warrene0edc842021-08-17 09:53:13 +01005604 MBEDTLS_SSL_IANA_TLS_GROUP_SECP521R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02005605#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005606#if defined(MBEDTLS_ECP_HAVE_BP256R1)
Brett Warrene0edc842021-08-17 09:53:13 +01005607 MBEDTLS_SSL_IANA_TLS_GROUP_BP256R1,
Gilles Peskineae270bf2021-06-02 00:05:29 +02005608#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005609#if defined(MBEDTLS_ECP_HAVE_BP384R1)
Brett Warrene0edc842021-08-17 09:53:13 +01005610 MBEDTLS_SSL_IANA_TLS_GROUP_BP384R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02005611#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005612#if defined(MBEDTLS_ECP_HAVE_BP512R1)
Brett Warrene0edc842021-08-17 09:53:13 +01005613 MBEDTLS_SSL_IANA_TLS_GROUP_BP512R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02005614#endif
Przemek Stekiel316c19e2023-05-31 15:25:11 +02005615#if defined(PSA_WANT_ALG_FFDH)
Przemek Stekiel383f4712022-12-12 14:48:57 +01005616 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE2048,
5617 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE3072,
5618 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE4096,
5619 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE6144,
5620 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE8192,
5621#endif
Brett Warrene0edc842021-08-17 09:53:13 +01005622 MBEDTLS_SSL_IANA_TLS_GROUP_NONE
Gilles Peskineae270bf2021-06-02 00:05:29 +02005623};
Gilles Peskineae270bf2021-06-02 00:05:29 +02005624
Alexey Tsvetkov2ca34372022-06-07 10:21:05 +03005625static const int ssl_preset_suiteb_ciphersuites[] = {
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005626 MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256,
5627 MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384,
5628 0
5629};
5630
Ronald Crone68ab4f2022-10-05 12:46:29 +02005631#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Hanno Becker9c6aa7b2021-08-10 13:50:43 +01005632
Jerry Yu909df7b2022-01-22 11:56:27 +08005633/* NOTICE:
Jerry Yu0b994b82022-01-25 17:22:12 +08005634 * For ssl_preset_*_sig_algs and ssl_tls12_preset_*_sig_algs, the following
Jerry Yu370e1462022-01-25 10:36:53 +08005635 * rules SHOULD be upheld.
5636 * - No duplicate entries.
5637 * - But if there is a good reason, do not change the order of the algorithms.
Jerry Yu09a99fc2022-07-28 14:22:17 +08005638 * - ssl_tls12_preset* is for TLS 1.2 use only.
Jerry Yu370e1462022-01-25 10:36:53 +08005639 * - ssl_preset_* is for TLS 1.3 only or hybrid TLS 1.3/1.2 handshakes.
Jerry Yu1a8b4812022-01-20 17:56:50 +08005640 */
Chien Wong4e9683e2023-12-28 17:07:43 +08005641static const uint16_t ssl_preset_default_sig_algs[] = {
Jerry Yu1a8b4812022-01-20 17:56:50 +08005642
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005643#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005644 defined(MBEDTLS_MD_CAN_SHA256) && \
Valerio Setticf29c5d2023-09-01 09:03:41 +02005645 defined(PSA_WANT_ECC_SECP_R1_256)
Jerry Yued5e9f42022-01-26 11:21:34 +08005646 MBEDTLS_TLS1_3_SIG_ECDSA_SECP256R1_SHA256,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005647 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256)
5648#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08005649
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005650#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005651 defined(MBEDTLS_MD_CAN_SHA384) && \
Valerio Setticf29c5d2023-09-01 09:03:41 +02005652 defined(PSA_WANT_ECC_SECP_R1_384)
Jerry Yu909df7b2022-01-22 11:56:27 +08005653 MBEDTLS_TLS1_3_SIG_ECDSA_SECP384R1_SHA384,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005654 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384)
5655#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08005656
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005657#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005658 defined(MBEDTLS_MD_CAN_SHA512) && \
Valerio Setticf29c5d2023-09-01 09:03:41 +02005659 defined(PSA_WANT_ECC_SECP_R1_521)
Jerry Yued5e9f42022-01-26 11:21:34 +08005660 MBEDTLS_TLS1_3_SIG_ECDSA_SECP521R1_SHA512,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005661 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA512)
5662#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08005663
Yanray Wang1136fad2023-11-22 16:54:31 +08005664#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && defined(MBEDTLS_MD_CAN_SHA512)
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005665 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA512,
Yanray Wang1136fad2023-11-22 16:54:31 +08005666#endif
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005667
Yanray Wang1136fad2023-11-22 16:54:31 +08005668#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && defined(MBEDTLS_MD_CAN_SHA384)
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005669 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA384,
Yanray Wang1136fad2023-11-22 16:54:31 +08005670#endif
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005671
Yanray Wang1136fad2023-11-22 16:54:31 +08005672#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && defined(MBEDTLS_MD_CAN_SHA256)
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005673 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256,
Yanray Wang1136fad2023-11-22 16:54:31 +08005674#endif
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005675
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005676#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_MD_CAN_SHA512)
Jerry Yu693a47a2022-06-23 14:02:28 +08005677 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA512,
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005678#endif /* MBEDTLS_RSA_C && MBEDTLS_MD_CAN_SHA512 */
Jerry Yu693a47a2022-06-23 14:02:28 +08005679
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005680#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_MD_CAN_SHA384)
Jerry Yu693a47a2022-06-23 14:02:28 +08005681 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA384,
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005682#endif /* MBEDTLS_RSA_C && MBEDTLS_MD_CAN_SHA384 */
Jerry Yu693a47a2022-06-23 14:02:28 +08005683
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005684#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_MD_CAN_SHA256)
Jerry Yu693a47a2022-06-23 14:02:28 +08005685 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA256,
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005686#endif /* MBEDTLS_RSA_C && MBEDTLS_MD_CAN_SHA256 */
Jerry Yu693a47a2022-06-23 14:02:28 +08005687
Gabor Mezei15b95a62022-05-09 16:37:58 +02005688 MBEDTLS_TLS_SIG_NONE
Jerry Yu909df7b2022-01-22 11:56:27 +08005689};
5690
5691/* NOTICE: see above */
5692#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
5693static uint16_t ssl_tls12_preset_default_sig_algs[] = {
Yanray Wang1136fad2023-11-22 16:54:31 +08005694
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005695#if defined(MBEDTLS_MD_CAN_SHA512)
Valerio Settie9646ec2023-08-02 20:02:28 +02005696#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005697 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA512),
Jerry Yu713013f2022-01-17 18:16:35 +08005698#endif
Jerry Yu09a99fc2022-07-28 14:22:17 +08005699#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT)
5700 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA512,
Yanray Wang1136fad2023-11-22 16:54:31 +08005701#endif
Gabor Mezeic1051b62022-05-10 13:13:58 +02005702#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005703 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA512),
Gabor Mezeic1051b62022-05-10 13:13:58 +02005704#endif
Yanray Wang1136fad2023-11-22 16:54:31 +08005705#endif /* MBEDTLS_MD_CAN_SHA512 */
5706
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005707#if defined(MBEDTLS_MD_CAN_SHA384)
Valerio Settie9646ec2023-08-02 20:02:28 +02005708#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005709 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384),
Jerry Yu11f0a9c2022-01-12 18:43:08 +08005710#endif
Jerry Yu09a99fc2022-07-28 14:22:17 +08005711#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT)
5712 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA384,
Yanray Wang1136fad2023-11-22 16:54:31 +08005713#endif
Gabor Mezeic1051b62022-05-10 13:13:58 +02005714#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005715 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA384),
Gabor Mezeic1051b62022-05-10 13:13:58 +02005716#endif
Yanray Wang1136fad2023-11-22 16:54:31 +08005717#endif /* MBEDTLS_MD_CAN_SHA384 */
5718
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005719#if defined(MBEDTLS_MD_CAN_SHA256)
Valerio Settie9646ec2023-08-02 20:02:28 +02005720#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005721 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256),
Jerry Yu11f0a9c2022-01-12 18:43:08 +08005722#endif
Jerry Yu09a99fc2022-07-28 14:22:17 +08005723#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT)
5724 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256,
Yanray Wang1136fad2023-11-22 16:54:31 +08005725#endif
Gabor Mezeic1051b62022-05-10 13:13:58 +02005726#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005727 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA256),
Gabor Mezeic1051b62022-05-10 13:13:58 +02005728#endif
Yanray Wang1136fad2023-11-22 16:54:31 +08005729#endif /* MBEDTLS_MD_CAN_SHA256 */
5730
Gabor Mezei15b95a62022-05-09 16:37:58 +02005731 MBEDTLS_TLS_SIG_NONE
Jerry Yu909df7b2022-01-22 11:56:27 +08005732};
5733#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Yanray Wang1136fad2023-11-22 16:54:31 +08005734
Jerry Yu909df7b2022-01-22 11:56:27 +08005735/* NOTICE: see above */
Chien Wong4e9683e2023-12-28 17:07:43 +08005736static const uint16_t ssl_preset_suiteb_sig_algs[] = {
Jerry Yu909df7b2022-01-22 11:56:27 +08005737
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005738#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Valerio Setti45d56f32023-07-13 17:23:20 +02005739 defined(MBEDTLS_MD_CAN_SHA256) && \
Valerio Settidb6b4db2023-09-01 09:20:51 +02005740 defined(MBEDTLS_ECP_HAVE_SECP256R1)
Jerry Yu909df7b2022-01-22 11:56:27 +08005741 MBEDTLS_TLS1_3_SIG_ECDSA_SECP256R1_SHA256,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005742 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256)
5743#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08005744
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005745#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Valerio Setti45d56f32023-07-13 17:23:20 +02005746 defined(MBEDTLS_MD_CAN_SHA384) && \
Valerio Settidb6b4db2023-09-01 09:20:51 +02005747 defined(MBEDTLS_ECP_HAVE_SECP384R1)
Jerry Yu53037892022-01-25 11:02:06 +08005748 MBEDTLS_TLS1_3_SIG_ECDSA_SECP384R1_SHA384,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005749 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384)
5750#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08005751
Gabor Mezei15b95a62022-05-09 16:37:58 +02005752 MBEDTLS_TLS_SIG_NONE
Jerry Yu713013f2022-01-17 18:16:35 +08005753};
Jerry Yu6106fdc2022-01-12 16:36:14 +08005754
Jerry Yu909df7b2022-01-22 11:56:27 +08005755/* NOTICE: see above */
5756#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
5757static uint16_t ssl_tls12_preset_suiteb_sig_algs[] = {
Yanray Wang1136fad2023-11-22 16:54:31 +08005758
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005759#if defined(MBEDTLS_MD_CAN_SHA256)
Valerio Settie9646ec2023-08-02 20:02:28 +02005760#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005761 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256),
Jerry Yu713013f2022-01-17 18:16:35 +08005762#endif
Yanray Wang1136fad2023-11-22 16:54:31 +08005763#endif /* MBEDTLS_MD_CAN_SHA256 */
Yanray Wang69ceb392023-11-22 16:32:39 +08005764
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005765#if defined(MBEDTLS_MD_CAN_SHA384)
Valerio Settie9646ec2023-08-02 20:02:28 +02005766#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005767 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384),
Jerry Yu18c833e2022-01-25 10:55:47 +08005768#endif
Yanray Wang1136fad2023-11-22 16:54:31 +08005769#endif /* MBEDTLS_MD_CAN_SHA384 */
5770
Gabor Mezei15b95a62022-05-09 16:37:58 +02005771 MBEDTLS_TLS_SIG_NONE
Hanno Becker9c6aa7b2021-08-10 13:50:43 +01005772};
Jerry Yu909df7b2022-01-22 11:56:27 +08005773#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
5774
Ronald Crone68ab4f2022-10-05 12:46:29 +02005775#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005776
Chien Wong4e9683e2023-12-28 17:07:43 +08005777static const uint16_t ssl_preset_suiteb_groups[] = {
Valerio Settidb6b4db2023-09-01 09:20:51 +02005778#if defined(MBEDTLS_ECP_HAVE_SECP256R1)
Brett Warrene0edc842021-08-17 09:53:13 +01005779 MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1,
Jaeden Amerod4311042019-06-03 08:27:16 +01005780#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005781#if defined(MBEDTLS_ECP_HAVE_SECP384R1)
Brett Warrene0edc842021-08-17 09:53:13 +01005782 MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1,
Jaeden Amerod4311042019-06-03 08:27:16 +01005783#endif
Brett Warrene0edc842021-08-17 09:53:13 +01005784 MBEDTLS_SSL_IANA_TLS_GROUP_NONE
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005785};
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005786
Ronald Crone68ab4f2022-10-05 12:46:29 +02005787#if defined(MBEDTLS_DEBUG_C) && defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu909df7b2022-01-22 11:56:27 +08005788/* Function for checking `ssl_preset_*_sig_algs` and `ssl_tls12_preset_*_sig_algs`
Jerry Yu370e1462022-01-25 10:36:53 +08005789 * to make sure there are no duplicated signature algorithm entries. */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005790MBEDTLS_CHECK_RETURN_CRITICAL
Chien Wong4e9683e2023-12-28 17:07:43 +08005791static int ssl_check_no_sig_alg_duplication(const uint16_t *sig_algs)
Jerry Yu1a8b4812022-01-20 17:56:50 +08005792{
5793 size_t i, j;
5794 int ret = 0;
Jerry Yu909df7b2022-01-22 11:56:27 +08005795
Gilles Peskine449bd832023-01-11 14:50:10 +01005796 for (i = 0; sig_algs[i] != MBEDTLS_TLS_SIG_NONE; i++) {
5797 for (j = 0; j < i; j++) {
5798 if (sig_algs[i] != sig_algs[j]) {
Jerry Yuf377d642022-01-25 10:43:59 +08005799 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01005800 }
5801 mbedtls_printf(" entry(%04x,%" MBEDTLS_PRINTF_SIZET
5802 ") is duplicated at %" MBEDTLS_PRINTF_SIZET "\n",
5803 sig_algs[i], j, i);
Jerry Yuf377d642022-01-25 10:43:59 +08005804 ret = -1;
Jerry Yu1a8b4812022-01-20 17:56:50 +08005805 }
5806 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005807 return ret;
Jerry Yu1a8b4812022-01-20 17:56:50 +08005808}
5809
Ronald Crone68ab4f2022-10-05 12:46:29 +02005810#endif /* MBEDTLS_DEBUG_C && MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Jerry Yu1a8b4812022-01-20 17:56:50 +08005811
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005812/*
Tillmann Karras588ad502015-09-25 04:27:22 +02005813 * Load default in mbedtls_ssl_config
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005814 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005815int mbedtls_ssl_config_defaults(mbedtls_ssl_config *conf,
5816 int endpoint, int transport, int preset)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005817{
Manuel Pégourié-Gonnard8b431fb2015-05-11 12:54:52 +02005818#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Janos Follath865b3eb2019-12-16 11:46:15 +00005819 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard8b431fb2015-05-11 12:54:52 +02005820#endif
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005821
Ronald Crone68ab4f2022-10-05 12:46:29 +02005822#if defined(MBEDTLS_DEBUG_C) && defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005823 if (ssl_check_no_sig_alg_duplication(ssl_preset_suiteb_sig_algs)) {
5824 mbedtls_printf("ssl_preset_suiteb_sig_algs has duplicated entries\n");
5825 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu1a8b4812022-01-20 17:56:50 +08005826 }
5827
Gilles Peskine449bd832023-01-11 14:50:10 +01005828 if (ssl_check_no_sig_alg_duplication(ssl_preset_default_sig_algs)) {
5829 mbedtls_printf("ssl_preset_default_sig_algs has duplicated entries\n");
5830 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu1a8b4812022-01-20 17:56:50 +08005831 }
Jerry Yu909df7b2022-01-22 11:56:27 +08005832
5833#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005834 if (ssl_check_no_sig_alg_duplication(ssl_tls12_preset_suiteb_sig_algs)) {
5835 mbedtls_printf("ssl_tls12_preset_suiteb_sig_algs has duplicated entries\n");
5836 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu909df7b2022-01-22 11:56:27 +08005837 }
5838
Gilles Peskine449bd832023-01-11 14:50:10 +01005839 if (ssl_check_no_sig_alg_duplication(ssl_tls12_preset_default_sig_algs)) {
5840 mbedtls_printf("ssl_tls12_preset_default_sig_algs has duplicated entries\n");
5841 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu909df7b2022-01-22 11:56:27 +08005842 }
5843#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Ronald Crone68ab4f2022-10-05 12:46:29 +02005844#endif /* MBEDTLS_DEBUG_C && MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Jerry Yu1a8b4812022-01-20 17:56:50 +08005845
Manuel Pégourié-Gonnard0de074f2015-05-14 12:58:01 +02005846 /* Use the functions here so that they are covered in tests,
5847 * but otherwise access member directly for efficiency */
Gilles Peskine449bd832023-01-11 14:50:10 +01005848 mbedtls_ssl_conf_endpoint(conf, endpoint);
5849 mbedtls_ssl_conf_transport(conf, transport);
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005850
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005851 /*
5852 * Things that are common to all presets
5853 */
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02005854#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005855 if (endpoint == MBEDTLS_SSL_IS_CLIENT) {
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02005856 conf->authmode = MBEDTLS_SSL_VERIFY_REQUIRED;
5857#if defined(MBEDTLS_SSL_SESSION_TICKETS)
5858 conf->session_tickets = MBEDTLS_SSL_SESSION_TICKETS_ENABLED;
5859#endif
5860 }
5861#endif
5862
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005863#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
5864 conf->encrypt_then_mac = MBEDTLS_SSL_ETM_ENABLED;
5865#endif
5866
5867#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
5868 conf->extended_ms = MBEDTLS_SSL_EXTENDED_MS_ENABLED;
5869#endif
5870
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02005871#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005872 conf->f_cookie_write = ssl_cookie_write_dummy;
5873 conf->f_cookie_check = ssl_cookie_check_dummy;
5874#endif
5875
5876#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
5877 conf->anti_replay = MBEDTLS_SSL_ANTI_REPLAY_ENABLED;
5878#endif
5879
Janos Follath088ce432017-04-10 12:42:31 +01005880#if defined(MBEDTLS_SSL_SRV_C)
5881 conf->cert_req_ca_list = MBEDTLS_SSL_CERT_REQ_CA_LIST_ENABLED;
TRodziewicz3946f792021-06-14 12:11:18 +02005882 conf->respect_cli_pref = MBEDTLS_SSL_SRV_CIPHERSUITE_ORDER_SERVER;
Janos Follath088ce432017-04-10 12:42:31 +01005883#endif
5884
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005885#if defined(MBEDTLS_SSL_PROTO_DTLS)
5886 conf->hs_timeout_min = MBEDTLS_SSL_DTLS_TIMEOUT_DFL_MIN;
5887 conf->hs_timeout_max = MBEDTLS_SSL_DTLS_TIMEOUT_DFL_MAX;
5888#endif
5889
5890#if defined(MBEDTLS_SSL_RENEGOTIATION)
5891 conf->renego_max_records = MBEDTLS_SSL_RENEGO_MAX_RECORDS_DEFAULT;
Gilles Peskine449bd832023-01-11 14:50:10 +01005892 memset(conf->renego_period, 0x00, 2);
5893 memset(conf->renego_period + 2, 0xFF, 6);
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005894#endif
5895
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005896#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005897 if (endpoint == MBEDTLS_SSL_IS_SERVER) {
Hanno Beckere2defad2021-07-24 05:59:17 +01005898 const unsigned char dhm_p[] =
5899 MBEDTLS_DHM_RFC3526_MODP_2048_P_BIN;
5900 const unsigned char dhm_g[] =
5901 MBEDTLS_DHM_RFC3526_MODP_2048_G_BIN;
Hanno Becker00d0a682017-10-04 13:14:29 +01005902
Gilles Peskine449bd832023-01-11 14:50:10 +01005903 if ((ret = mbedtls_ssl_conf_dh_param_bin(conf,
5904 dhm_p, sizeof(dhm_p),
5905 dhm_g, sizeof(dhm_g))) != 0) {
5906 return ret;
Hanno Beckere2defad2021-07-24 05:59:17 +01005907 }
5908 }
Manuel Pégourié-Gonnardbd990d62015-06-11 14:49:42 +02005909#endif
5910
Ronald Cron6f135e12021-12-08 16:57:54 +01005911#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yu6ee56aa2022-12-06 17:47:22 +08005912
5913#if defined(MBEDTLS_SSL_EARLY_DATA)
Yanray Wangd5ed36f2023-11-07 11:40:43 +08005914 mbedtls_ssl_conf_early_data(conf, MBEDTLS_SSL_EARLY_DATA_DISABLED);
Jerry Yu6ee56aa2022-12-06 17:47:22 +08005915#if defined(MBEDTLS_SSL_SRV_C)
Yanray Wang07517612023-11-07 11:47:36 +08005916 mbedtls_ssl_conf_max_early_data_size(conf, MBEDTLS_SSL_MAX_EARLY_DATA_SIZE);
Jerry Yu6ee56aa2022-12-06 17:47:22 +08005917#endif
5918#endif /* MBEDTLS_SSL_EARLY_DATA */
5919
Jerry Yud0766ec2022-09-22 10:46:57 +08005920#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Jerry Yu1ad7ace2022-08-09 13:28:39 +08005921 mbedtls_ssl_conf_new_session_tickets(
Gilles Peskine449bd832023-01-11 14:50:10 +01005922 conf, MBEDTLS_SSL_TLS1_3_DEFAULT_NEW_SESSION_TICKETS);
Jerry Yu1ad7ace2022-08-09 13:28:39 +08005923#endif
Hanno Becker71f1ed62021-07-24 06:01:47 +01005924 /*
5925 * Allow all TLS 1.3 key exchange modes by default.
5926 */
Xiaofei Bai746f9482021-11-12 08:53:56 +00005927 conf->tls13_kex_modes = MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_ALL;
Ronald Cron6f135e12021-12-08 16:57:54 +01005928#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker71f1ed62021-07-24 06:01:47 +01005929
Gilles Peskine449bd832023-01-11 14:50:10 +01005930 if (transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Glenn Strauss2dfcea22022-03-14 17:26:42 -04005931#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
XiaokangQian4d3a6042022-04-21 13:46:17 +00005932 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
XiaokangQian060d8672022-04-21 09:24:56 +00005933 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
XiaokangQian4d3a6042022-04-21 13:46:17 +00005934#else
Gilles Peskine449bd832023-01-11 14:50:10 +01005935 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
XiaokangQian060d8672022-04-21 09:24:56 +00005936#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01005937 } else {
XiaokangQian4d3a6042022-04-21 13:46:17 +00005938#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
Ronald Cron097ba142023-03-08 16:18:00 +01005939 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
5940 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
XiaokangQian4d3a6042022-04-21 13:46:17 +00005941#elif defined(MBEDTLS_SSL_PROTO_TLS1_3)
5942 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
5943 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
5944#elif defined(MBEDTLS_SSL_PROTO_TLS1_2)
5945 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
5946 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
5947#else
Gilles Peskine449bd832023-01-11 14:50:10 +01005948 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
XiaokangQian4d3a6042022-04-21 13:46:17 +00005949#endif
5950 }
Glenn Strauss2dfcea22022-03-14 17:26:42 -04005951
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005952 /*
5953 * Preset-specific defaults
5954 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005955 switch (preset) {
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005956 /*
5957 * NSA Suite B
5958 */
5959 case MBEDTLS_SSL_PRESET_SUITEB:
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005960
Hanno Beckerd60b6c62021-04-29 12:04:11 +01005961 conf->ciphersuite_list = ssl_preset_suiteb_ciphersuites;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005962
5963#if defined(MBEDTLS_X509_CRT_PARSE_C)
5964 conf->cert_profile = &mbedtls_x509_crt_profile_suiteb;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005965#endif
5966
Ronald Crone68ab4f2022-10-05 12:46:29 +02005967#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu909df7b2022-01-22 11:56:27 +08005968#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005969 if (mbedtls_ssl_conf_is_tls12_only(conf)) {
Jerry Yu909df7b2022-01-22 11:56:27 +08005970 conf->sig_algs = ssl_tls12_preset_suiteb_sig_algs;
Gilles Peskine449bd832023-01-11 14:50:10 +01005971 } else
Jerry Yu909df7b2022-01-22 11:56:27 +08005972#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005973 conf->sig_algs = ssl_preset_suiteb_sig_algs;
Ronald Crone68ab4f2022-10-05 12:46:29 +02005974#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005975
Manuel Pégourié-Gonnardf07ce3b2023-09-22 11:53:41 +02005976#if defined(MBEDTLS_ECP_C) && !defined(MBEDTLS_DEPRECATED_REMOVED)
Brett Warrene0edc842021-08-17 09:53:13 +01005977 conf->curve_list = NULL;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005978#endif
Brett Warrene0edc842021-08-17 09:53:13 +01005979 conf->group_list = ssl_preset_suiteb_groups;
Manuel Pégourié-Gonnardc98204e2015-08-11 04:21:01 +02005980 break;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005981
5982 /*
5983 * Default
5984 */
5985 default:
Ronald Cronf6606552022-03-15 11:23:25 +01005986
Hanno Beckerd60b6c62021-04-29 12:04:11 +01005987 conf->ciphersuite_list = mbedtls_ssl_list_ciphersuites();
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005988
5989#if defined(MBEDTLS_X509_CRT_PARSE_C)
5990 conf->cert_profile = &mbedtls_x509_crt_profile_default;
5991#endif
5992
Ronald Crone68ab4f2022-10-05 12:46:29 +02005993#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu909df7b2022-01-22 11:56:27 +08005994#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005995 if (mbedtls_ssl_conf_is_tls12_only(conf)) {
Jerry Yu909df7b2022-01-22 11:56:27 +08005996 conf->sig_algs = ssl_tls12_preset_default_sig_algs;
Gilles Peskine449bd832023-01-11 14:50:10 +01005997 } else
Jerry Yu909df7b2022-01-22 11:56:27 +08005998#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005999 conf->sig_algs = ssl_preset_default_sig_algs;
Ronald Crone68ab4f2022-10-05 12:46:29 +02006000#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02006001
Manuel Pégourié-Gonnardf07ce3b2023-09-22 11:53:41 +02006002#if defined(MBEDTLS_ECP_C) && !defined(MBEDTLS_DEPRECATED_REMOVED)
Brett Warrene0edc842021-08-17 09:53:13 +01006003 conf->curve_list = NULL;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02006004#endif
Brett Warrene0edc842021-08-17 09:53:13 +01006005 conf->group_list = ssl_preset_default_groups;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02006006
6007#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_CLI_C)
6008 conf->dhm_min_bitlen = 1024;
6009#endif
6010 }
6011
Gilles Peskine449bd832023-01-11 14:50:10 +01006012 return 0;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02006013}
6014
6015/*
6016 * Free mbedtls_ssl_config
6017 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006018void mbedtls_ssl_config_free(mbedtls_ssl_config *conf)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02006019{
Troy-Butlerda73abc2024-04-02 13:37:31 -04006020 if (conf == NULL) {
6021 return;
6022 }
6023
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02006024#if defined(MBEDTLS_DHM_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01006025 mbedtls_mpi_free(&conf->dhm_P);
6026 mbedtls_mpi_free(&conf->dhm_G);
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02006027#endif
6028
Ronald Cron73fe8df2022-10-05 14:31:43 +02006029#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED)
Neil Armstrong501c9322022-05-03 09:35:09 +02006030#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01006031 if (!mbedtls_svc_key_id_is_null(conf->psk_opaque)) {
Neil Armstrong501c9322022-05-03 09:35:09 +02006032 conf->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
6033 }
Neil Armstrong8ecd6682022-05-05 11:40:35 +02006034#endif /* MBEDTLS_USE_PSA_CRYPTO */
Gilles Peskine449bd832023-01-11 14:50:10 +01006035 if (conf->psk != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01006036 mbedtls_zeroize_and_free(conf->psk, conf->psk_len);
Azim Khan27e8a122018-03-21 14:24:11 +00006037 conf->psk = NULL;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02006038 conf->psk_len = 0;
junyeonLEE316b1622017-12-20 16:29:30 +09006039 }
6040
Gilles Peskine449bd832023-01-11 14:50:10 +01006041 if (conf->psk_identity != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01006042 mbedtls_zeroize_and_free(conf->psk_identity, conf->psk_identity_len);
Azim Khan27e8a122018-03-21 14:24:11 +00006043 conf->psk_identity = NULL;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02006044 conf->psk_identity_len = 0;
6045 }
Ronald Cron73fe8df2022-10-05 14:31:43 +02006046#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED */
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02006047
6048#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01006049 ssl_key_cert_free(conf->key_cert);
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02006050#endif
6051
Gilles Peskine449bd832023-01-11 14:50:10 +01006052 mbedtls_platform_zeroize(conf, sizeof(mbedtls_ssl_config));
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02006053}
6054
Manuel Pégourié-Gonnard5674a972015-10-19 15:14:03 +02006055#if defined(MBEDTLS_PK_C) && \
Valerio Settie9646ec2023-08-02 20:02:28 +02006056 (defined(MBEDTLS_RSA_C) || defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED))
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02006057/*
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006058 * Convert between MBEDTLS_PK_XXX and SSL_SIG_XXX
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02006059 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006060unsigned char mbedtls_ssl_sig_from_pk(mbedtls_pk_context *pk)
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02006061{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006062#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01006063 if (mbedtls_pk_can_do(pk, MBEDTLS_PK_RSA)) {
6064 return MBEDTLS_SSL_SIG_RSA;
6065 }
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02006066#endif
Valerio Settie9646ec2023-08-02 20:02:28 +02006067#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01006068 if (mbedtls_pk_can_do(pk, MBEDTLS_PK_ECDSA)) {
6069 return MBEDTLS_SSL_SIG_ECDSA;
6070 }
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02006071#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01006072 return MBEDTLS_SSL_SIG_ANON;
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02006073}
6074
Gilles Peskine449bd832023-01-11 14:50:10 +01006075unsigned char mbedtls_ssl_sig_from_pk_alg(mbedtls_pk_type_t type)
Hanno Becker7e5437a2017-04-28 17:15:26 +01006076{
Gilles Peskine449bd832023-01-11 14:50:10 +01006077 switch (type) {
Hanno Becker7e5437a2017-04-28 17:15:26 +01006078 case MBEDTLS_PK_RSA:
Gilles Peskine449bd832023-01-11 14:50:10 +01006079 return MBEDTLS_SSL_SIG_RSA;
Hanno Becker7e5437a2017-04-28 17:15:26 +01006080 case MBEDTLS_PK_ECDSA:
6081 case MBEDTLS_PK_ECKEY:
Gilles Peskine449bd832023-01-11 14:50:10 +01006082 return MBEDTLS_SSL_SIG_ECDSA;
Hanno Becker7e5437a2017-04-28 17:15:26 +01006083 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006084 return MBEDTLS_SSL_SIG_ANON;
Hanno Becker7e5437a2017-04-28 17:15:26 +01006085 }
6086}
6087
Gilles Peskine449bd832023-01-11 14:50:10 +01006088mbedtls_pk_type_t mbedtls_ssl_pk_alg_from_sig(unsigned char sig)
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02006089{
Gilles Peskine449bd832023-01-11 14:50:10 +01006090 switch (sig) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006091#if defined(MBEDTLS_RSA_C)
6092 case MBEDTLS_SSL_SIG_RSA:
Gilles Peskine449bd832023-01-11 14:50:10 +01006093 return MBEDTLS_PK_RSA;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02006094#endif
Valerio Settie9646ec2023-08-02 20:02:28 +02006095#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006096 case MBEDTLS_SSL_SIG_ECDSA:
Gilles Peskine449bd832023-01-11 14:50:10 +01006097 return MBEDTLS_PK_ECDSA;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02006098#endif
6099 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006100 return MBEDTLS_PK_NONE;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02006101 }
6102}
Valerio Settie9646ec2023-08-02 20:02:28 +02006103#endif /* MBEDTLS_PK_C &&
6104 ( MBEDTLS_RSA_C || MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED ) */
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02006105
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02006106/*
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006107 * Convert from MBEDTLS_SSL_HASH_XXX to MBEDTLS_MD_XXX
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02006108 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006109mbedtls_md_type_t mbedtls_ssl_md_alg_from_hash(unsigned char hash)
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02006110{
Gilles Peskine449bd832023-01-11 14:50:10 +01006111 switch (hash) {
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006112#if defined(MBEDTLS_MD_CAN_MD5)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006113 case MBEDTLS_SSL_HASH_MD5:
Gilles Peskine449bd832023-01-11 14:50:10 +01006114 return MBEDTLS_MD_MD5;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02006115#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006116#if defined(MBEDTLS_MD_CAN_SHA1)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006117 case MBEDTLS_SSL_HASH_SHA1:
Gilles Peskine449bd832023-01-11 14:50:10 +01006118 return MBEDTLS_MD_SHA1;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02006119#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006120#if defined(MBEDTLS_MD_CAN_SHA224)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006121 case MBEDTLS_SSL_HASH_SHA224:
Gilles Peskine449bd832023-01-11 14:50:10 +01006122 return MBEDTLS_MD_SHA224;
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02006123#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006124#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006125 case MBEDTLS_SSL_HASH_SHA256:
Gilles Peskine449bd832023-01-11 14:50:10 +01006126 return MBEDTLS_MD_SHA256;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02006127#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006128#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006129 case MBEDTLS_SSL_HASH_SHA384:
Gilles Peskine449bd832023-01-11 14:50:10 +01006130 return MBEDTLS_MD_SHA384;
Mateusz Starzyk3352a532021-04-06 14:28:22 +02006131#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006132#if defined(MBEDTLS_MD_CAN_SHA512)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006133 case MBEDTLS_SSL_HASH_SHA512:
Gilles Peskine449bd832023-01-11 14:50:10 +01006134 return MBEDTLS_MD_SHA512;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02006135#endif
6136 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006137 return MBEDTLS_MD_NONE;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02006138 }
6139}
6140
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006141/*
6142 * Convert from MBEDTLS_MD_XXX to MBEDTLS_SSL_HASH_XXX
6143 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006144unsigned char mbedtls_ssl_hash_from_md_alg(int md)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006145{
Gilles Peskine449bd832023-01-11 14:50:10 +01006146 switch (md) {
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006147#if defined(MBEDTLS_MD_CAN_MD5)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006148 case MBEDTLS_MD_MD5:
Gilles Peskine449bd832023-01-11 14:50:10 +01006149 return MBEDTLS_SSL_HASH_MD5;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006150#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006151#if defined(MBEDTLS_MD_CAN_SHA1)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006152 case MBEDTLS_MD_SHA1:
Gilles Peskine449bd832023-01-11 14:50:10 +01006153 return MBEDTLS_SSL_HASH_SHA1;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006154#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006155#if defined(MBEDTLS_MD_CAN_SHA224)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006156 case MBEDTLS_MD_SHA224:
Gilles Peskine449bd832023-01-11 14:50:10 +01006157 return MBEDTLS_SSL_HASH_SHA224;
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02006158#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006159#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006160 case MBEDTLS_MD_SHA256:
Gilles Peskine449bd832023-01-11 14:50:10 +01006161 return MBEDTLS_SSL_HASH_SHA256;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006162#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006163#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006164 case MBEDTLS_MD_SHA384:
Gilles Peskine449bd832023-01-11 14:50:10 +01006165 return MBEDTLS_SSL_HASH_SHA384;
Mateusz Starzyk3352a532021-04-06 14:28:22 +02006166#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006167#if defined(MBEDTLS_MD_CAN_SHA512)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006168 case MBEDTLS_MD_SHA512:
Gilles Peskine449bd832023-01-11 14:50:10 +01006169 return MBEDTLS_SSL_HASH_SHA512;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006170#endif
6171 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006172 return MBEDTLS_SSL_HASH_NONE;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006173 }
6174}
6175
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01006176/*
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006177 * Check if a curve proposed by the peer is in our list.
Manuel Pégourié-Gonnard9d412d82015-06-17 12:10:46 +02006178 * Return 0 if we're willing to use it, -1 otherwise.
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01006179 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006180int mbedtls_ssl_check_curve_tls_id(const mbedtls_ssl_context *ssl, uint16_t tls_id)
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01006181{
Gilles Peskine449bd832023-01-11 14:50:10 +01006182 const uint16_t *group_list = mbedtls_ssl_get_groups(ssl);
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01006183
Gilles Peskine449bd832023-01-11 14:50:10 +01006184 if (group_list == NULL) {
6185 return -1;
Brett Warrene0edc842021-08-17 09:53:13 +01006186 }
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01006187
Gilles Peskine449bd832023-01-11 14:50:10 +01006188 for (; *group_list != 0; group_list++) {
6189 if (*group_list == tls_id) {
6190 return 0;
6191 }
6192 }
6193
6194 return -1;
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01006195}
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01006196
Valerio Setti49e69072023-06-27 17:27:51 +02006197#if defined(MBEDTLS_PK_HAVE_ECC_KEYS)
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01006198/*
6199 * Same as mbedtls_ssl_check_curve_tls_id() but with a mbedtls_ecp_group_id.
6200 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006201int mbedtls_ssl_check_curve(const mbedtls_ssl_context *ssl, mbedtls_ecp_group_id grp_id)
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01006202{
Gilles Peskine449bd832023-01-11 14:50:10 +01006203 uint16_t tls_id = mbedtls_ssl_get_tls_id_from_ecp_group_id(grp_id);
Leonid Rozenboim19e59732022-08-08 16:52:38 -07006204
Gilles Peskine449bd832023-01-11 14:50:10 +01006205 if (tls_id == 0) {
Leonid Rozenboim19e59732022-08-08 16:52:38 -07006206 return -1;
Gilles Peskine449bd832023-01-11 14:50:10 +01006207 }
Leonid Rozenboim19e59732022-08-08 16:52:38 -07006208
Gilles Peskine449bd832023-01-11 14:50:10 +01006209 return mbedtls_ssl_check_curve_tls_id(ssl, tls_id);
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01006210}
Valerio Setti49e69072023-06-27 17:27:51 +02006211#endif /* MBEDTLS_PK_HAVE_ECC_KEYS */
Valerio Setti67419f02023-01-04 16:12:42 +01006212
Valerio Setti18c9fed2022-12-30 17:44:24 +01006213static const struct {
6214 uint16_t tls_id;
6215 mbedtls_ecp_group_id ecp_group_id;
6216 psa_ecc_family_t psa_family;
6217 uint16_t bits;
Valerio Setti18c9fed2022-12-30 17:44:24 +01006218} tls_id_match_table[] =
6219{
Valerio Settidb6b4db2023-09-01 09:20:51 +02006220#if defined(MBEDTLS_ECP_HAVE_SECP521R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02006221 { 25, MBEDTLS_ECP_DP_SECP521R1, PSA_ECC_FAMILY_SECP_R1, 521 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006222#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02006223#if defined(MBEDTLS_ECP_HAVE_BP512R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02006224 { 28, MBEDTLS_ECP_DP_BP512R1, PSA_ECC_FAMILY_BRAINPOOL_P_R1, 512 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006225#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02006226#if defined(MBEDTLS_ECP_HAVE_SECP384R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02006227 { 24, MBEDTLS_ECP_DP_SECP384R1, PSA_ECC_FAMILY_SECP_R1, 384 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006228#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02006229#if defined(MBEDTLS_ECP_HAVE_BP384R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02006230 { 27, MBEDTLS_ECP_DP_BP384R1, PSA_ECC_FAMILY_BRAINPOOL_P_R1, 384 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006231#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02006232#if defined(MBEDTLS_ECP_HAVE_SECP256R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02006233 { 23, MBEDTLS_ECP_DP_SECP256R1, PSA_ECC_FAMILY_SECP_R1, 256 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006234#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02006235#if defined(MBEDTLS_ECP_HAVE_SECP256K1)
Valerio Settiacd32c02023-06-29 18:06:29 +02006236 { 22, MBEDTLS_ECP_DP_SECP256K1, PSA_ECC_FAMILY_SECP_K1, 256 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006237#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02006238#if defined(MBEDTLS_ECP_HAVE_BP256R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02006239 { 26, MBEDTLS_ECP_DP_BP256R1, PSA_ECC_FAMILY_BRAINPOOL_P_R1, 256 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006240#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02006241#if defined(MBEDTLS_ECP_HAVE_SECP224R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02006242 { 21, MBEDTLS_ECP_DP_SECP224R1, PSA_ECC_FAMILY_SECP_R1, 224 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006243#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02006244#if defined(MBEDTLS_ECP_HAVE_SECP224K1)
Valerio Settiacd32c02023-06-29 18:06:29 +02006245 { 20, MBEDTLS_ECP_DP_SECP224K1, PSA_ECC_FAMILY_SECP_K1, 224 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006246#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02006247#if defined(MBEDTLS_ECP_HAVE_SECP192R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02006248 { 19, MBEDTLS_ECP_DP_SECP192R1, PSA_ECC_FAMILY_SECP_R1, 192 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006249#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02006250#if defined(MBEDTLS_ECP_HAVE_SECP192K1)
Valerio Settiacd32c02023-06-29 18:06:29 +02006251 { 18, MBEDTLS_ECP_DP_SECP192K1, PSA_ECC_FAMILY_SECP_K1, 192 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006252#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02006253#if defined(MBEDTLS_ECP_HAVE_CURVE25519)
Valerio Settiacd32c02023-06-29 18:06:29 +02006254 { 29, MBEDTLS_ECP_DP_CURVE25519, PSA_ECC_FAMILY_MONTGOMERY, 255 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006255#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02006256#if defined(MBEDTLS_ECP_HAVE_CURVE448)
Valerio Settiacd32c02023-06-29 18:06:29 +02006257 { 30, MBEDTLS_ECP_DP_CURVE448, PSA_ECC_FAMILY_MONTGOMERY, 448 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006258#endif
Valerio Settiacd32c02023-06-29 18:06:29 +02006259 { 0, MBEDTLS_ECP_DP_NONE, 0, 0 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006260};
6261
Gilles Peskine449bd832023-01-11 14:50:10 +01006262int mbedtls_ssl_get_psa_curve_info_from_tls_id(uint16_t tls_id,
Przemek Stekielda4fba62023-06-02 14:52:28 +02006263 psa_key_type_t *type,
Gilles Peskine449bd832023-01-11 14:50:10 +01006264 size_t *bits)
Valerio Setti18c9fed2022-12-30 17:44:24 +01006265{
Gilles Peskine449bd832023-01-11 14:50:10 +01006266 for (int i = 0; tls_id_match_table[i].tls_id != 0; i++) {
6267 if (tls_id_match_table[i].tls_id == tls_id) {
Przemek Stekielda4fba62023-06-02 14:52:28 +02006268 if (type != NULL) {
6269 *type = PSA_KEY_TYPE_ECC_KEY_PAIR(tls_id_match_table[i].psa_family);
Gilles Peskine449bd832023-01-11 14:50:10 +01006270 }
6271 if (bits != NULL) {
Valerio Setti18c9fed2022-12-30 17:44:24 +01006272 *bits = tls_id_match_table[i].bits;
Gilles Peskine449bd832023-01-11 14:50:10 +01006273 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01006274 return PSA_SUCCESS;
6275 }
6276 }
6277
6278 return PSA_ERROR_NOT_SUPPORTED;
6279}
6280
Gilles Peskine449bd832023-01-11 14:50:10 +01006281mbedtls_ecp_group_id mbedtls_ssl_get_ecp_group_id_from_tls_id(uint16_t tls_id)
Valerio Setti18c9fed2022-12-30 17:44:24 +01006282{
Gilles Peskine449bd832023-01-11 14:50:10 +01006283 for (int i = 0; tls_id_match_table[i].tls_id != 0; i++) {
6284 if (tls_id_match_table[i].tls_id == tls_id) {
Valerio Setti18c9fed2022-12-30 17:44:24 +01006285 return tls_id_match_table[i].ecp_group_id;
Gilles Peskine449bd832023-01-11 14:50:10 +01006286 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01006287 }
6288
6289 return MBEDTLS_ECP_DP_NONE;
6290}
6291
Gilles Peskine449bd832023-01-11 14:50:10 +01006292uint16_t mbedtls_ssl_get_tls_id_from_ecp_group_id(mbedtls_ecp_group_id grp_id)
Valerio Setti18c9fed2022-12-30 17:44:24 +01006293{
Gilles Peskine449bd832023-01-11 14:50:10 +01006294 for (int i = 0; tls_id_match_table[i].ecp_group_id != MBEDTLS_ECP_DP_NONE;
6295 i++) {
6296 if (tls_id_match_table[i].ecp_group_id == grp_id) {
Valerio Setti18c9fed2022-12-30 17:44:24 +01006297 return tls_id_match_table[i].tls_id;
Gilles Peskine449bd832023-01-11 14:50:10 +01006298 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01006299 }
6300
6301 return 0;
6302}
6303
Valerio Setti67419f02023-01-04 16:12:42 +01006304#if defined(MBEDTLS_DEBUG_C)
Valerio Settiacd32c02023-06-29 18:06:29 +02006305static const struct {
6306 uint16_t tls_id;
6307 const char *name;
6308} tls_id_curve_name_table[] =
6309{
Valerio Setti54e23792023-07-07 10:49:27 +02006310 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP521R1, "secp521r1" },
6311 { MBEDTLS_SSL_IANA_TLS_GROUP_BP512R1, "brainpoolP512r1" },
6312 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1, "secp384r1" },
6313 { MBEDTLS_SSL_IANA_TLS_GROUP_BP384R1, "brainpoolP384r1" },
6314 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1, "secp256r1" },
6315 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP256K1, "secp256k1" },
6316 { MBEDTLS_SSL_IANA_TLS_GROUP_BP256R1, "brainpoolP256r1" },
6317 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP224R1, "secp224r1" },
6318 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP224K1, "secp224k1" },
6319 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP192R1, "secp192r1" },
6320 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP192K1, "secp192k1" },
6321 { MBEDTLS_SSL_IANA_TLS_GROUP_X25519, "x25519" },
6322 { MBEDTLS_SSL_IANA_TLS_GROUP_X448, "x448" },
Valerio Settiacd32c02023-06-29 18:06:29 +02006323 { 0, NULL },
6324};
6325
Gilles Peskine449bd832023-01-11 14:50:10 +01006326const char *mbedtls_ssl_get_curve_name_from_tls_id(uint16_t tls_id)
Valerio Setti18c9fed2022-12-30 17:44:24 +01006327{
Valerio Settiacd32c02023-06-29 18:06:29 +02006328 for (int i = 0; tls_id_curve_name_table[i].tls_id != 0; i++) {
6329 if (tls_id_curve_name_table[i].tls_id == tls_id) {
6330 return tls_id_curve_name_table[i].name;
Gilles Peskine449bd832023-01-11 14:50:10 +01006331 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01006332 }
6333
6334 return NULL;
6335}
Valerio Setti67419f02023-01-04 16:12:42 +01006336#endif
Valerio Setti18c9fed2022-12-30 17:44:24 +01006337
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006338#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01006339int mbedtls_ssl_check_cert_usage(const mbedtls_x509_crt *cert,
6340 const mbedtls_ssl_ciphersuite_t *ciphersuite,
Manuel Pégourié-Gonnard96a0c5c2024-08-09 11:26:25 +02006341 int recv_endpoint,
Manuel Pégourié-Gonnard4938b692024-08-09 11:49:12 +02006342 mbedtls_ssl_protocol_version tls_version,
Gilles Peskine449bd832023-01-11 14:50:10 +01006343 uint32_t *flags)
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02006344{
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01006345 int ret = 0;
Dave Rodgmanc37ad442023-11-03 23:36:06 +00006346 unsigned int usage = 0;
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02006347 const char *ext_oid;
6348 size_t ext_len;
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02006349
Manuel Pégourié-Gonnard4938b692024-08-09 11:49:12 +02006350 /*
6351 * keyUsage
6352 */
6353
Manuel Pégourié-Gonnard96a0c5c2024-08-09 11:26:25 +02006354 /* Note: don't guard this with MBEDTLS_SSL_CLI_C because the server wants
6355 * to check what a compliant client will think while choosing which cert
6356 * to send to the client. */
Manuel Pégourié-Gonnard4938b692024-08-09 11:49:12 +02006357#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
6358 if (tls_version == MBEDTLS_SSL_VERSION_TLS1_2 &&
6359 recv_endpoint == MBEDTLS_SSL_IS_CLIENT) {
6360 /* TLS 1.2 server part of the key exchange */
Gilles Peskine449bd832023-01-11 14:50:10 +01006361 switch (ciphersuite->key_exchange) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006362 case MBEDTLS_KEY_EXCHANGE_RSA:
6363 case MBEDTLS_KEY_EXCHANGE_RSA_PSK:
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01006364 usage = MBEDTLS_X509_KU_KEY_ENCIPHERMENT;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02006365 break;
6366
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006367 case MBEDTLS_KEY_EXCHANGE_DHE_RSA:
6368 case MBEDTLS_KEY_EXCHANGE_ECDHE_RSA:
6369 case MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA:
6370 usage = MBEDTLS_X509_KU_DIGITAL_SIGNATURE;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02006371 break;
6372
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006373 case MBEDTLS_KEY_EXCHANGE_ECDH_RSA:
6374 case MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA:
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01006375 usage = MBEDTLS_X509_KU_KEY_AGREEMENT;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02006376 break;
6377
6378 /* Don't use default: we want warnings when adding new values */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006379 case MBEDTLS_KEY_EXCHANGE_NONE:
6380 case MBEDTLS_KEY_EXCHANGE_PSK:
6381 case MBEDTLS_KEY_EXCHANGE_DHE_PSK:
6382 case MBEDTLS_KEY_EXCHANGE_ECDHE_PSK:
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +02006383 case MBEDTLS_KEY_EXCHANGE_ECJPAKE:
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02006384 usage = 0;
6385 }
Manuel Pégourié-Gonnard4938b692024-08-09 11:49:12 +02006386 } else
6387#endif
6388 {
6389 /* This is either TLS 1.3 autentication, which always uses signatures,
6390 * or 1.2 client auth: rsa_sign and mbedtls_ecdsa_sign are the only
6391 * options we implement, both using signatures. */
6392 (void) tls_version;
6393 (void) ciphersuite;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006394 usage = MBEDTLS_X509_KU_DIGITAL_SIGNATURE;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02006395 }
6396
Gilles Peskine449bd832023-01-11 14:50:10 +01006397 if (mbedtls_x509_crt_check_key_usage(cert, usage) != 0) {
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01006398 *flags |= MBEDTLS_X509_BADCERT_KEY_USAGE;
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01006399 ret = -1;
6400 }
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02006401
Manuel Pégourié-Gonnard4938b692024-08-09 11:49:12 +02006402 /*
6403 * extKeyUsage
6404 */
6405
Manuel Pégourié-Gonnard96a0c5c2024-08-09 11:26:25 +02006406 if (recv_endpoint == MBEDTLS_SSL_IS_CLIENT) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006407 ext_oid = MBEDTLS_OID_SERVER_AUTH;
Gilles Peskine449bd832023-01-11 14:50:10 +01006408 ext_len = MBEDTLS_OID_SIZE(MBEDTLS_OID_SERVER_AUTH);
6409 } else {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006410 ext_oid = MBEDTLS_OID_CLIENT_AUTH;
Gilles Peskine449bd832023-01-11 14:50:10 +01006411 ext_len = MBEDTLS_OID_SIZE(MBEDTLS_OID_CLIENT_AUTH);
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02006412 }
6413
Gilles Peskine449bd832023-01-11 14:50:10 +01006414 if (mbedtls_x509_crt_check_extended_key_usage(cert, ext_oid, ext_len) != 0) {
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01006415 *flags |= MBEDTLS_X509_BADCERT_EXT_KEY_USAGE;
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01006416 ret = -1;
6417 }
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02006418
Gilles Peskine449bd832023-01-11 14:50:10 +01006419 return ret;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02006420}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006421#endif /* MBEDTLS_X509_CRT_PARSE_C */
Manuel Pégourié-Gonnard3a306b92014-04-29 15:11:17 +02006422
Jerry Yu148165c2021-09-24 23:20:59 +08006423#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01006424int mbedtls_ssl_get_handshake_transcript(mbedtls_ssl_context *ssl,
6425 const mbedtls_md_type_t md,
6426 unsigned char *dst,
6427 size_t dst_len,
6428 size_t *olen)
Jerry Yu148165c2021-09-24 23:20:59 +08006429{
Ronald Cronf6893e12022-01-07 22:09:01 +01006430 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
6431 psa_hash_operation_t *hash_operation_to_clone;
6432 psa_hash_operation_t hash_operation = psa_hash_operation_init();
6433
Jerry Yu148165c2021-09-24 23:20:59 +08006434 *olen = 0;
Ronald Cronf6893e12022-01-07 22:09:01 +01006435
Gilles Peskine449bd832023-01-11 14:50:10 +01006436 switch (md) {
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006437#if defined(MBEDTLS_MD_CAN_SHA384)
Gilles Peskine449bd832023-01-11 14:50:10 +01006438 case MBEDTLS_MD_SHA384:
6439 hash_operation_to_clone = &ssl->handshake->fin_sha384_psa;
6440 break;
Ronald Cronf6893e12022-01-07 22:09:01 +01006441#endif
6442
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006443#if defined(MBEDTLS_MD_CAN_SHA256)
Gilles Peskine449bd832023-01-11 14:50:10 +01006444 case MBEDTLS_MD_SHA256:
6445 hash_operation_to_clone = &ssl->handshake->fin_sha256_psa;
6446 break;
Ronald Cronf6893e12022-01-07 22:09:01 +01006447#endif
6448
Gilles Peskine449bd832023-01-11 14:50:10 +01006449 default:
6450 goto exit;
6451 }
6452
6453 status = psa_hash_clone(hash_operation_to_clone, &hash_operation);
6454 if (status != PSA_SUCCESS) {
Ronald Cronf6893e12022-01-07 22:09:01 +01006455 goto exit;
6456 }
6457
Gilles Peskine449bd832023-01-11 14:50:10 +01006458 status = psa_hash_finish(&hash_operation, dst, dst_len, olen);
6459 if (status != PSA_SUCCESS) {
Ronald Cronf6893e12022-01-07 22:09:01 +01006460 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006461 }
Ronald Cronf6893e12022-01-07 22:09:01 +01006462
6463exit:
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006464#if !defined(MBEDTLS_MD_CAN_SHA384) && \
6465 !defined(MBEDTLS_MD_CAN_SHA256)
Andrzej Kurekeabeb302022-10-17 07:52:51 -04006466 (void) ssl;
6467#endif
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05006468 return PSA_TO_MBEDTLS_ERR(status);
Jerry Yu148165c2021-09-24 23:20:59 +08006469}
6470#else /* MBEDTLS_USE_PSA_CRYPTO */
6471
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006472#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006473MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006474static int ssl_get_handshake_transcript_sha384(mbedtls_ssl_context *ssl,
6475 unsigned char *dst,
6476 size_t dst_len,
6477 size_t *olen)
Jerry Yu24c0ec32021-09-09 14:21:07 +08006478{
Jerry Yu24c0ec32021-09-09 14:21:07 +08006479 int ret;
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01006480 mbedtls_md_context_t sha384;
Jerry Yu24c0ec32021-09-09 14:21:07 +08006481
Gilles Peskine449bd832023-01-11 14:50:10 +01006482 if (dst_len < 48) {
6483 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
6484 }
Jerry Yu24c0ec32021-09-09 14:21:07 +08006485
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01006486 mbedtls_md_init(&sha384);
6487 ret = mbedtls_md_setup(&sha384, mbedtls_md_info_from_type(MBEDTLS_MD_SHA384), 0);
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01006488 if (ret != 0) {
6489 goto exit;
6490 }
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01006491 ret = mbedtls_md_clone(&sha384, &ssl->handshake->fin_sha384);
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01006492 if (ret != 0) {
6493 goto exit;
6494 }
Jerry Yu24c0ec32021-09-09 14:21:07 +08006495
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01006496 if ((ret = mbedtls_md_finish(&sha384, dst)) != 0) {
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01006497 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_finish", ret);
Jerry Yu24c0ec32021-09-09 14:21:07 +08006498 goto exit;
6499 }
6500
6501 *olen = 48;
6502
6503exit:
6504
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01006505 mbedtls_md_free(&sha384);
Gilles Peskine449bd832023-01-11 14:50:10 +01006506 return ret;
Jerry Yu24c0ec32021-09-09 14:21:07 +08006507}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006508#endif /* MBEDTLS_MD_CAN_SHA384 */
Jerry Yu24c0ec32021-09-09 14:21:07 +08006509
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006510#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006511MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006512static int ssl_get_handshake_transcript_sha256(mbedtls_ssl_context *ssl,
6513 unsigned char *dst,
6514 size_t dst_len,
6515 size_t *olen)
Jerry Yu24c0ec32021-09-09 14:21:07 +08006516{
Jerry Yu24c0ec32021-09-09 14:21:07 +08006517 int ret;
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01006518 mbedtls_md_context_t sha256;
Jerry Yu24c0ec32021-09-09 14:21:07 +08006519
Gilles Peskine449bd832023-01-11 14:50:10 +01006520 if (dst_len < 32) {
6521 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
6522 }
Jerry Yu24c0ec32021-09-09 14:21:07 +08006523
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01006524 mbedtls_md_init(&sha256);
6525 ret = mbedtls_md_setup(&sha256, mbedtls_md_info_from_type(MBEDTLS_MD_SHA256), 0);
6526 if (ret != 0) {
6527 goto exit;
6528 }
6529 ret = mbedtls_md_clone(&sha256, &ssl->handshake->fin_sha256);
6530 if (ret != 0) {
6531 goto exit;
6532 }
Jerry Yuc5aef882021-12-23 20:15:02 +08006533
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01006534 if ((ret = mbedtls_md_finish(&sha256, dst)) != 0) {
6535 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_finish", ret);
Jerry Yu24c0ec32021-09-09 14:21:07 +08006536 goto exit;
6537 }
6538
6539 *olen = 32;
6540
6541exit:
6542
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01006543 mbedtls_md_free(&sha256);
Gilles Peskine449bd832023-01-11 14:50:10 +01006544 return ret;
Jerry Yu24c0ec32021-09-09 14:21:07 +08006545}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006546#endif /* MBEDTLS_MD_CAN_SHA256 */
Jerry Yu24c0ec32021-09-09 14:21:07 +08006547
Gilles Peskine449bd832023-01-11 14:50:10 +01006548int mbedtls_ssl_get_handshake_transcript(mbedtls_ssl_context *ssl,
6549 const mbedtls_md_type_t md,
6550 unsigned char *dst,
6551 size_t dst_len,
6552 size_t *olen)
Jerry Yu24c0ec32021-09-09 14:21:07 +08006553{
Gilles Peskine449bd832023-01-11 14:50:10 +01006554 switch (md) {
Jerry Yuc1ddeef2021-10-08 15:14:45 +08006555
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006556#if defined(MBEDTLS_MD_CAN_SHA384)
Gilles Peskine449bd832023-01-11 14:50:10 +01006557 case MBEDTLS_MD_SHA384:
6558 return ssl_get_handshake_transcript_sha384(ssl, dst, dst_len, olen);
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006559#endif /* MBEDTLS_MD_CAN_SHA384*/
Jerry Yuc1ddeef2021-10-08 15:14:45 +08006560
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006561#if defined(MBEDTLS_MD_CAN_SHA256)
Gilles Peskine449bd832023-01-11 14:50:10 +01006562 case MBEDTLS_MD_SHA256:
6563 return ssl_get_handshake_transcript_sha256(ssl, dst, dst_len, olen);
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006564#endif /* MBEDTLS_MD_CAN_SHA256*/
Jerry Yuc1ddeef2021-10-08 15:14:45 +08006565
Gilles Peskine449bd832023-01-11 14:50:10 +01006566 default:
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006567#if !defined(MBEDTLS_MD_CAN_SHA384) && \
6568 !defined(MBEDTLS_MD_CAN_SHA256)
Gilles Peskine449bd832023-01-11 14:50:10 +01006569 (void) ssl;
6570 (void) dst;
6571 (void) dst_len;
6572 (void) olen;
Andrzej Kurek409248a2022-10-24 10:33:21 -04006573#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01006574 break;
Jerry Yuc1ddeef2021-10-08 15:14:45 +08006575 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006576 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yu24c0ec32021-09-09 14:21:07 +08006577}
XiaokangQian647719a2021-12-07 09:16:29 +00006578
Jerry Yu148165c2021-09-24 23:20:59 +08006579#endif /* !MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu24c0ec32021-09-09 14:21:07 +08006580
Ronald Crone68ab4f2022-10-05 12:46:29 +02006581#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Gabor Mezei078e8032022-04-27 21:17:56 +02006582/* mbedtls_ssl_parse_sig_alg_ext()
6583 *
6584 * The `extension_data` field of signature algorithm contains a `SignatureSchemeList`
6585 * value (TLS 1.3 RFC8446):
6586 * enum {
6587 * ....
6588 * ecdsa_secp256r1_sha256( 0x0403 ),
6589 * ecdsa_secp384r1_sha384( 0x0503 ),
6590 * ecdsa_secp521r1_sha512( 0x0603 ),
6591 * ....
6592 * } SignatureScheme;
6593 *
6594 * struct {
6595 * SignatureScheme supported_signature_algorithms<2..2^16-2>;
6596 * } SignatureSchemeList;
6597 *
6598 * The `extension_data` field of signature algorithm contains a `SignatureAndHashAlgorithm`
6599 * value (TLS 1.2 RFC5246):
6600 * enum {
6601 * none(0), md5(1), sha1(2), sha224(3), sha256(4), sha384(5),
6602 * sha512(6), (255)
6603 * } HashAlgorithm;
6604 *
6605 * enum { anonymous(0), rsa(1), dsa(2), ecdsa(3), (255) }
6606 * SignatureAlgorithm;
6607 *
6608 * struct {
6609 * HashAlgorithm hash;
6610 * SignatureAlgorithm signature;
6611 * } SignatureAndHashAlgorithm;
6612 *
6613 * SignatureAndHashAlgorithm
6614 * supported_signature_algorithms<2..2^16-2>;
6615 *
6616 * The TLS 1.3 signature algorithm extension was defined to be a compatible
6617 * generalization of the TLS 1.2 signature algorithm extension.
6618 * `SignatureAndHashAlgorithm` field of TLS 1.2 can be represented by
6619 * `SignatureScheme` field of TLS 1.3
6620 *
6621 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006622int mbedtls_ssl_parse_sig_alg_ext(mbedtls_ssl_context *ssl,
6623 const unsigned char *buf,
6624 const unsigned char *end)
Gabor Mezei078e8032022-04-27 21:17:56 +02006625{
6626 const unsigned char *p = buf;
6627 size_t supported_sig_algs_len = 0;
6628 const unsigned char *supported_sig_algs_end;
6629 uint16_t sig_alg;
6630 uint32_t common_idx = 0;
6631
Gilles Peskine449bd832023-01-11 14:50:10 +01006632 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
6633 supported_sig_algs_len = MBEDTLS_GET_UINT16_BE(p, 0);
Gabor Mezei078e8032022-04-27 21:17:56 +02006634 p += 2;
6635
Gilles Peskine449bd832023-01-11 14:50:10 +01006636 memset(ssl->handshake->received_sig_algs, 0,
6637 sizeof(ssl->handshake->received_sig_algs));
Gabor Mezei078e8032022-04-27 21:17:56 +02006638
Gilles Peskine449bd832023-01-11 14:50:10 +01006639 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, supported_sig_algs_len);
Gabor Mezei078e8032022-04-27 21:17:56 +02006640 supported_sig_algs_end = p + supported_sig_algs_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01006641 while (p < supported_sig_algs_end) {
6642 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, supported_sig_algs_end, 2);
6643 sig_alg = MBEDTLS_GET_UINT16_BE(p, 0);
Gabor Mezei078e8032022-04-27 21:17:56 +02006644 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01006645 MBEDTLS_SSL_DEBUG_MSG(4, ("received signature algorithm: 0x%x %s",
6646 sig_alg,
6647 mbedtls_ssl_sig_alg_to_str(sig_alg)));
Jerry Yu2fe6c632022-06-29 10:02:38 +08006648#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01006649 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_2 &&
6650 (!(mbedtls_ssl_sig_alg_is_supported(ssl, sig_alg) &&
6651 mbedtls_ssl_sig_alg_is_offered(ssl, sig_alg)))) {
Gabor Mezei078e8032022-04-27 21:17:56 +02006652 continue;
Jerry Yu2fe6c632022-06-29 10:02:38 +08006653 }
6654#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gabor Mezei078e8032022-04-27 21:17:56 +02006655
Gilles Peskine449bd832023-01-11 14:50:10 +01006656 MBEDTLS_SSL_DEBUG_MSG(4, ("valid signature algorithm: %s",
6657 mbedtls_ssl_sig_alg_to_str(sig_alg)));
Gabor Mezei078e8032022-04-27 21:17:56 +02006658
Gilles Peskine449bd832023-01-11 14:50:10 +01006659 if (common_idx + 1 < MBEDTLS_RECEIVED_SIG_ALGS_SIZE) {
Gabor Mezei078e8032022-04-27 21:17:56 +02006660 ssl->handshake->received_sig_algs[common_idx] = sig_alg;
6661 common_idx += 1;
6662 }
6663 }
6664 /* Check that we consumed all the message. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006665 if (p != end) {
6666 MBEDTLS_SSL_DEBUG_MSG(1,
6667 ("Signature algorithms extension length misaligned"));
6668 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR,
6669 MBEDTLS_ERR_SSL_DECODE_ERROR);
6670 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Gabor Mezei078e8032022-04-27 21:17:56 +02006671 }
6672
Gilles Peskine449bd832023-01-11 14:50:10 +01006673 if (common_idx == 0) {
6674 MBEDTLS_SSL_DEBUG_MSG(3, ("no signature algorithm in common"));
6675 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE,
6676 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE);
6677 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Gabor Mezei078e8032022-04-27 21:17:56 +02006678 }
6679
Gabor Mezei15b95a62022-05-09 16:37:58 +02006680 ssl->handshake->received_sig_algs[common_idx] = MBEDTLS_TLS_SIG_NONE;
Gilles Peskine449bd832023-01-11 14:50:10 +01006681 return 0;
Gabor Mezei078e8032022-04-27 21:17:56 +02006682}
6683
Ronald Crone68ab4f2022-10-05 12:46:29 +02006684#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Gabor Mezei078e8032022-04-27 21:17:56 +02006685
Jerry Yudc7bd172022-02-17 13:44:15 +08006686#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
6687
6688#if defined(MBEDTLS_USE_PSA_CRYPTO)
6689
Gilles Peskine449bd832023-01-11 14:50:10 +01006690static psa_status_t setup_psa_key_derivation(psa_key_derivation_operation_t *derivation,
6691 mbedtls_svc_key_id_t key,
6692 psa_algorithm_t alg,
6693 const unsigned char *raw_psk, size_t raw_psk_length,
6694 const unsigned char *seed, size_t seed_length,
6695 const unsigned char *label, size_t label_length,
6696 const unsigned char *other_secret,
6697 size_t other_secret_length,
6698 size_t capacity)
Jerry Yudc7bd172022-02-17 13:44:15 +08006699{
6700 psa_status_t status;
6701
Gilles Peskine449bd832023-01-11 14:50:10 +01006702 status = psa_key_derivation_setup(derivation, alg);
6703 if (status != PSA_SUCCESS) {
6704 return status;
6705 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006706
Gilles Peskine449bd832023-01-11 14:50:10 +01006707 if (PSA_ALG_IS_TLS12_PRF(alg) || PSA_ALG_IS_TLS12_PSK_TO_MS(alg)) {
6708 status = psa_key_derivation_input_bytes(derivation,
6709 PSA_KEY_DERIVATION_INPUT_SEED,
6710 seed, seed_length);
6711 if (status != PSA_SUCCESS) {
6712 return status;
Przemek Stekiel1f027032022-04-05 17:12:11 +02006713 }
6714
Gilles Peskine449bd832023-01-11 14:50:10 +01006715 if (other_secret != NULL) {
6716 status = psa_key_derivation_input_bytes(derivation,
6717 PSA_KEY_DERIVATION_INPUT_OTHER_SECRET,
6718 other_secret, other_secret_length);
6719 if (status != PSA_SUCCESS) {
6720 return status;
6721 }
6722 }
6723
6724 if (mbedtls_svc_key_id_is_null(key)) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006725 status = psa_key_derivation_input_bytes(
6726 derivation, PSA_KEY_DERIVATION_INPUT_SECRET,
Gilles Peskine449bd832023-01-11 14:50:10 +01006727 raw_psk, raw_psk_length);
6728 } else {
Jerry Yudc7bd172022-02-17 13:44:15 +08006729 status = psa_key_derivation_input_key(
Gilles Peskine449bd832023-01-11 14:50:10 +01006730 derivation, PSA_KEY_DERIVATION_INPUT_SECRET, key);
Jerry Yudc7bd172022-02-17 13:44:15 +08006731 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006732 if (status != PSA_SUCCESS) {
6733 return status;
6734 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006735
Gilles Peskine449bd832023-01-11 14:50:10 +01006736 status = psa_key_derivation_input_bytes(derivation,
6737 PSA_KEY_DERIVATION_INPUT_LABEL,
6738 label, label_length);
6739 if (status != PSA_SUCCESS) {
6740 return status;
6741 }
6742 } else {
6743 return PSA_ERROR_NOT_SUPPORTED;
Jerry Yudc7bd172022-02-17 13:44:15 +08006744 }
6745
Gilles Peskine449bd832023-01-11 14:50:10 +01006746 status = psa_key_derivation_set_capacity(derivation, capacity);
6747 if (status != PSA_SUCCESS) {
6748 return status;
6749 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006750
Gilles Peskine449bd832023-01-11 14:50:10 +01006751 return PSA_SUCCESS;
Jerry Yudc7bd172022-02-17 13:44:15 +08006752}
6753
Andrzej Kurek57d10632022-10-24 10:32:01 -04006754#if defined(PSA_WANT_ALG_SHA_384) || \
6755 defined(PSA_WANT_ALG_SHA_256)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006756MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006757static int tls_prf_generic(mbedtls_md_type_t md_type,
6758 const unsigned char *secret, size_t slen,
6759 const char *label,
6760 const unsigned char *random, size_t rlen,
6761 unsigned char *dstbuf, size_t dlen)
Jerry Yudc7bd172022-02-17 13:44:15 +08006762{
6763 psa_status_t status;
6764 psa_algorithm_t alg;
6765 mbedtls_svc_key_id_t master_key = MBEDTLS_SVC_KEY_ID_INIT;
6766 psa_key_derivation_operation_t derivation =
6767 PSA_KEY_DERIVATION_OPERATION_INIT;
6768
Gilles Peskine449bd832023-01-11 14:50:10 +01006769 if (md_type == MBEDTLS_MD_SHA384) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006770 alg = PSA_ALG_TLS12_PRF(PSA_ALG_SHA_384);
Gilles Peskine449bd832023-01-11 14:50:10 +01006771 } else {
Jerry Yudc7bd172022-02-17 13:44:15 +08006772 alg = PSA_ALG_TLS12_PRF(PSA_ALG_SHA_256);
Gilles Peskine449bd832023-01-11 14:50:10 +01006773 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006774
6775 /* Normally a "secret" should be long enough to be impossible to
6776 * find by brute force, and in particular should not be empty. But
6777 * this PRF is also used to derive an IV, in particular in EAP-TLS,
6778 * and for this use case it makes sense to have a 0-length "secret".
6779 * Since the key API doesn't allow importing a key of length 0,
6780 * keep master_key=0, which setup_psa_key_derivation() understands
6781 * to mean a 0-length "secret" input. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006782 if (slen != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006783 psa_key_attributes_t key_attributes = psa_key_attributes_init();
Gilles Peskine449bd832023-01-11 14:50:10 +01006784 psa_set_key_usage_flags(&key_attributes, PSA_KEY_USAGE_DERIVE);
6785 psa_set_key_algorithm(&key_attributes, alg);
6786 psa_set_key_type(&key_attributes, PSA_KEY_TYPE_DERIVE);
Jerry Yudc7bd172022-02-17 13:44:15 +08006787
Gilles Peskine449bd832023-01-11 14:50:10 +01006788 status = psa_import_key(&key_attributes, secret, slen, &master_key);
6789 if (status != PSA_SUCCESS) {
6790 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
6791 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006792 }
6793
Gilles Peskine449bd832023-01-11 14:50:10 +01006794 status = setup_psa_key_derivation(&derivation,
6795 master_key, alg,
6796 NULL, 0,
6797 random, rlen,
6798 (unsigned char const *) label,
6799 (size_t) strlen(label),
6800 NULL, 0,
6801 dlen);
6802 if (status != PSA_SUCCESS) {
6803 psa_key_derivation_abort(&derivation);
6804 psa_destroy_key(master_key);
6805 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yudc7bd172022-02-17 13:44:15 +08006806 }
6807
Gilles Peskine449bd832023-01-11 14:50:10 +01006808 status = psa_key_derivation_output_bytes(&derivation, dstbuf, dlen);
6809 if (status != PSA_SUCCESS) {
6810 psa_key_derivation_abort(&derivation);
6811 psa_destroy_key(master_key);
6812 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yudc7bd172022-02-17 13:44:15 +08006813 }
6814
Gilles Peskine449bd832023-01-11 14:50:10 +01006815 status = psa_key_derivation_abort(&derivation);
6816 if (status != PSA_SUCCESS) {
6817 psa_destroy_key(master_key);
6818 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yudc7bd172022-02-17 13:44:15 +08006819 }
6820
Gilles Peskine449bd832023-01-11 14:50:10 +01006821 if (!mbedtls_svc_key_id_is_null(master_key)) {
6822 status = psa_destroy_key(master_key);
6823 }
6824 if (status != PSA_SUCCESS) {
6825 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
6826 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006827
Gilles Peskine449bd832023-01-11 14:50:10 +01006828 return 0;
Jerry Yudc7bd172022-02-17 13:44:15 +08006829}
Andrzej Kurek57d10632022-10-24 10:32:01 -04006830#endif /* PSA_WANT_ALG_SHA_256 || PSA_WANT_ALG_SHA_384 */
Jerry Yudc7bd172022-02-17 13:44:15 +08006831#else /* MBEDTLS_USE_PSA_CRYPTO */
6832
Andrzej Kurek57d10632022-10-24 10:32:01 -04006833#if defined(MBEDTLS_MD_C) && \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006834 (defined(MBEDTLS_MD_CAN_SHA256) || \
6835 defined(MBEDTLS_MD_CAN_SHA384))
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006836MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006837static int tls_prf_generic(mbedtls_md_type_t md_type,
6838 const unsigned char *secret, size_t slen,
6839 const char *label,
6840 const unsigned char *random, size_t rlen,
6841 unsigned char *dstbuf, size_t dlen)
Jerry Yudc7bd172022-02-17 13:44:15 +08006842{
6843 size_t nb;
6844 size_t i, j, k, md_len;
6845 unsigned char *tmp;
6846 size_t tmp_len = 0;
6847 unsigned char h_i[MBEDTLS_MD_MAX_SIZE];
6848 const mbedtls_md_info_t *md_info;
6849 mbedtls_md_context_t md_ctx;
6850 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6851
Gilles Peskine449bd832023-01-11 14:50:10 +01006852 mbedtls_md_init(&md_ctx);
Jerry Yudc7bd172022-02-17 13:44:15 +08006853
Gilles Peskine449bd832023-01-11 14:50:10 +01006854 if ((md_info = mbedtls_md_info_from_type(md_type)) == NULL) {
6855 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
6856 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006857
Gilles Peskine449bd832023-01-11 14:50:10 +01006858 md_len = mbedtls_md_get_size(md_info);
Jerry Yudc7bd172022-02-17 13:44:15 +08006859
Gilles Peskine449bd832023-01-11 14:50:10 +01006860 tmp_len = md_len + strlen(label) + rlen;
6861 tmp = mbedtls_calloc(1, tmp_len);
6862 if (tmp == NULL) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006863 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
6864 goto exit;
6865 }
6866
Gilles Peskine449bd832023-01-11 14:50:10 +01006867 nb = strlen(label);
6868 memcpy(tmp + md_len, label, nb);
6869 memcpy(tmp + md_len + nb, random, rlen);
Jerry Yudc7bd172022-02-17 13:44:15 +08006870 nb += rlen;
6871
6872 /*
6873 * Compute P_<hash>(secret, label + random)[0..dlen]
6874 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006875 if ((ret = mbedtls_md_setup(&md_ctx, md_info, 1)) != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006876 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006877 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006878
Gilles Peskine449bd832023-01-11 14:50:10 +01006879 ret = mbedtls_md_hmac_starts(&md_ctx, secret, slen);
6880 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006881 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006882 }
6883 ret = mbedtls_md_hmac_update(&md_ctx, tmp + md_len, nb);
6884 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006885 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006886 }
6887 ret = mbedtls_md_hmac_finish(&md_ctx, tmp);
6888 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006889 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006890 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006891
Gilles Peskine449bd832023-01-11 14:50:10 +01006892 for (i = 0; i < dlen; i += md_len) {
6893 ret = mbedtls_md_hmac_reset(&md_ctx);
6894 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006895 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006896 }
6897 ret = mbedtls_md_hmac_update(&md_ctx, tmp, md_len + nb);
6898 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006899 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006900 }
6901 ret = mbedtls_md_hmac_finish(&md_ctx, h_i);
6902 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006903 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006904 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006905
Gilles Peskine449bd832023-01-11 14:50:10 +01006906 ret = mbedtls_md_hmac_reset(&md_ctx);
6907 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006908 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006909 }
6910 ret = mbedtls_md_hmac_update(&md_ctx, tmp, md_len);
6911 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006912 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006913 }
6914 ret = mbedtls_md_hmac_finish(&md_ctx, tmp);
6915 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006916 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006917 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006918
Gilles Peskine449bd832023-01-11 14:50:10 +01006919 k = (i + md_len > dlen) ? dlen % md_len : md_len;
Jerry Yudc7bd172022-02-17 13:44:15 +08006920
Gilles Peskine449bd832023-01-11 14:50:10 +01006921 for (j = 0; j < k; j++) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006922 dstbuf[i + j] = h_i[j];
Gilles Peskine449bd832023-01-11 14:50:10 +01006923 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006924 }
6925
6926exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01006927 mbedtls_md_free(&md_ctx);
Jerry Yudc7bd172022-02-17 13:44:15 +08006928
Gilles Peskine449bd832023-01-11 14:50:10 +01006929 if (tmp != NULL) {
6930 mbedtls_platform_zeroize(tmp, tmp_len);
6931 }
Dave Rodgman29b9b2b2022-11-01 16:08:14 +00006932
Gilles Peskine449bd832023-01-11 14:50:10 +01006933 mbedtls_platform_zeroize(h_i, sizeof(h_i));
Jerry Yudc7bd172022-02-17 13:44:15 +08006934
Gilles Peskine449bd832023-01-11 14:50:10 +01006935 mbedtls_free(tmp);
Jerry Yudc7bd172022-02-17 13:44:15 +08006936
Gilles Peskine449bd832023-01-11 14:50:10 +01006937 return ret;
Jerry Yudc7bd172022-02-17 13:44:15 +08006938}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006939#endif /* MBEDTLS_MD_C && ( MBEDTLS_MD_CAN_SHA256 || MBEDTLS_MD_CAN_SHA384 ) */
Jerry Yudc7bd172022-02-17 13:44:15 +08006940#endif /* MBEDTLS_USE_PSA_CRYPTO */
6941
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006942#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006943MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006944static int tls_prf_sha256(const unsigned char *secret, size_t slen,
6945 const char *label,
6946 const unsigned char *random, size_t rlen,
6947 unsigned char *dstbuf, size_t dlen)
Jerry Yudc7bd172022-02-17 13:44:15 +08006948{
Gilles Peskine449bd832023-01-11 14:50:10 +01006949 return tls_prf_generic(MBEDTLS_MD_SHA256, secret, slen,
6950 label, random, rlen, dstbuf, dlen);
Jerry Yudc7bd172022-02-17 13:44:15 +08006951}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006952#endif /* MBEDTLS_MD_CAN_SHA256*/
Jerry Yudc7bd172022-02-17 13:44:15 +08006953
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006954#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006955MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006956static int tls_prf_sha384(const unsigned char *secret, size_t slen,
6957 const char *label,
6958 const unsigned char *random, size_t rlen,
6959 unsigned char *dstbuf, size_t dlen)
Jerry Yudc7bd172022-02-17 13:44:15 +08006960{
Gilles Peskine449bd832023-01-11 14:50:10 +01006961 return tls_prf_generic(MBEDTLS_MD_SHA384, secret, slen,
6962 label, random, rlen, dstbuf, dlen);
Jerry Yudc7bd172022-02-17 13:44:15 +08006963}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006964#endif /* MBEDTLS_MD_CAN_SHA384*/
Jerry Yudc7bd172022-02-17 13:44:15 +08006965
Jerry Yuf009d862022-02-17 14:01:37 +08006966/*
6967 * Set appropriate PRF function and other SSL / TLS1.2 functions
6968 *
6969 * Inputs:
Jerry Yuf009d862022-02-17 14:01:37 +08006970 * - hash associated with the ciphersuite (only used by TLS 1.2)
6971 *
6972 * Outputs:
6973 * - the tls_prf, calc_verify and calc_finished members of handshake structure
6974 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006975MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006976static int ssl_set_handshake_prfs(mbedtls_ssl_handshake_params *handshake,
6977 mbedtls_md_type_t hash)
Jerry Yuf009d862022-02-17 14:01:37 +08006978{
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006979#if defined(MBEDTLS_MD_CAN_SHA384)
Gilles Peskine449bd832023-01-11 14:50:10 +01006980 if (hash == MBEDTLS_MD_SHA384) {
Jerry Yuf009d862022-02-17 14:01:37 +08006981 handshake->tls_prf = tls_prf_sha384;
6982 handshake->calc_verify = ssl_calc_verify_tls_sha384;
6983 handshake->calc_finished = ssl_calc_finished_tls_sha384;
Gilles Peskine449bd832023-01-11 14:50:10 +01006984 } else
Jerry Yuf009d862022-02-17 14:01:37 +08006985#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006986#if defined(MBEDTLS_MD_CAN_SHA256)
Jerry Yuf009d862022-02-17 14:01:37 +08006987 {
Ronald Cron81591aa2022-03-07 09:05:51 +01006988 (void) hash;
Jerry Yuf009d862022-02-17 14:01:37 +08006989 handshake->tls_prf = tls_prf_sha256;
6990 handshake->calc_verify = ssl_calc_verify_tls_sha256;
6991 handshake->calc_finished = ssl_calc_finished_tls_sha256;
6992 }
Ronald Cron81591aa2022-03-07 09:05:51 +01006993#else
Jerry Yuf009d862022-02-17 14:01:37 +08006994 {
Jerry Yuf009d862022-02-17 14:01:37 +08006995 (void) handshake;
Ronald Cron81591aa2022-03-07 09:05:51 +01006996 (void) hash;
Gilles Peskine449bd832023-01-11 14:50:10 +01006997 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yuf009d862022-02-17 14:01:37 +08006998 }
Ronald Cron81591aa2022-03-07 09:05:51 +01006999#endif
Jerry Yuf009d862022-02-17 14:01:37 +08007000
Gilles Peskine449bd832023-01-11 14:50:10 +01007001 return 0;
Jerry Yuf009d862022-02-17 14:01:37 +08007002}
Jerry Yud6ab2352022-02-17 14:03:43 +08007003
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007004/*
7005 * Compute master secret if needed
7006 *
7007 * Parameters:
7008 * [in/out] handshake
7009 * [in] resume, premaster, extended_ms, calc_verify, tls_prf
7010 * (PSA-PSK) ciphersuite_info, psk_opaque
7011 * [out] premaster (cleared)
7012 * [out] master
7013 * [in] ssl: optionally used for debugging, EMS and PSA-PSK
7014 * debug: conf->f_dbg, conf->p_dbg
7015 * EMS: passed to calc_verify (debug + session_negotiate)
Ronald Crona25cf582022-03-07 11:10:36 +01007016 * PSA-PSA: conf
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007017 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007018MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007019static int ssl_compute_master(mbedtls_ssl_handshake_params *handshake,
7020 unsigned char *master,
7021 const mbedtls_ssl_context *ssl)
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007022{
7023 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7024
7025 /* cf. RFC 5246, Section 8.1:
7026 * "The master secret is always exactly 48 bytes in length." */
7027 size_t const master_secret_len = 48;
7028
7029#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
7030 unsigned char session_hash[48];
7031#endif /* MBEDTLS_SSL_EXTENDED_MASTER_SECRET */
7032
7033 /* The label for the KDF used for key expansion.
7034 * This is either "master secret" or "extended master secret"
7035 * depending on whether the Extended Master Secret extension
7036 * is used. */
7037 char const *lbl = "master secret";
7038
Przemek Stekielae4ed302022-04-05 17:15:55 +02007039 /* The seed for the KDF used for key expansion.
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007040 * - If the Extended Master Secret extension is not used,
7041 * this is ClientHello.Random + ServerHello.Random
7042 * (see Sect. 8.1 in RFC 5246).
7043 * - If the Extended Master Secret extension is used,
7044 * this is the transcript of the handshake so far.
7045 * (see Sect. 4 in RFC 7627). */
Przemek Stekielae4ed302022-04-05 17:15:55 +02007046 unsigned char const *seed = handshake->randbytes;
7047 size_t seed_len = 64;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007048
7049#if !defined(MBEDTLS_DEBUG_C) && \
7050 !defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET) && \
7051 !(defined(MBEDTLS_USE_PSA_CRYPTO) && \
Gilles Peskine449bd832023-01-11 14:50:10 +01007052 defined(MBEDTLS_KEY_EXCHANGE_PSK_ENABLED))
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007053 ssl = NULL; /* make sure we don't use it except for those cases */
7054 (void) ssl;
7055#endif
7056
Gilles Peskine449bd832023-01-11 14:50:10 +01007057 if (handshake->resume != 0) {
7058 MBEDTLS_SSL_DEBUG_MSG(3, ("no premaster (session resumed)"));
7059 return 0;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007060 }
7061
7062#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
Gilles Peskine449bd832023-01-11 14:50:10 +01007063 if (handshake->extended_ms == MBEDTLS_SSL_EXTENDED_MS_ENABLED) {
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007064 lbl = "extended master secret";
Przemek Stekielae4ed302022-04-05 17:15:55 +02007065 seed = session_hash;
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01007066 ret = handshake->calc_verify(ssl, session_hash, &seed_len);
7067 if (ret != 0) {
7068 MBEDTLS_SSL_DEBUG_RET(1, "calc_verify", ret);
7069 }
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007070
Gilles Peskine449bd832023-01-11 14:50:10 +01007071 MBEDTLS_SSL_DEBUG_BUF(3, "session hash for extended master secret",
7072 session_hash, seed_len);
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007073 }
Przemek Stekiel169bf0b2022-04-29 07:53:29 +02007074#endif /* MBEDTLS_SSL_EXTENDED_MASTER_SECRET */
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007075
Przemek Stekiel99114f32022-04-22 11:20:09 +02007076#if defined(MBEDTLS_USE_PSA_CRYPTO) && \
Przemek Stekiel8a4b7fd2022-04-28 09:22:22 +02007077 defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007078 if (mbedtls_ssl_ciphersuite_uses_psk(handshake->ciphersuite_info) == 1) {
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007079 /* Perform PSK-to-MS expansion in a single step. */
7080 psa_status_t status;
7081 psa_algorithm_t alg;
7082 mbedtls_svc_key_id_t psk;
7083 psa_key_derivation_operation_t derivation =
7084 PSA_KEY_DERIVATION_OPERATION_INIT;
Dave Rodgman2eab4622023-10-05 13:30:37 +01007085 mbedtls_md_type_t hash_alg = (mbedtls_md_type_t) handshake->ciphersuite_info->mac;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007086
Gilles Peskine449bd832023-01-11 14:50:10 +01007087 MBEDTLS_SSL_DEBUG_MSG(2, ("perform PSA-based PSK-to-MS expansion"));
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007088
Gilles Peskine449bd832023-01-11 14:50:10 +01007089 psk = mbedtls_ssl_get_opaque_psk(ssl);
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007090
Gilles Peskine449bd832023-01-11 14:50:10 +01007091 if (hash_alg == MBEDTLS_MD_SHA384) {
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007092 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_384);
Gilles Peskine449bd832023-01-11 14:50:10 +01007093 } else {
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007094 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_256);
Gilles Peskine449bd832023-01-11 14:50:10 +01007095 }
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007096
Przemek Stekiel51a1f362022-04-13 08:57:06 +02007097 size_t other_secret_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01007098 unsigned char *other_secret = NULL;
Przemek Stekielc2033402022-04-05 17:19:41 +02007099
Gilles Peskine449bd832023-01-11 14:50:10 +01007100 switch (handshake->ciphersuite_info->key_exchange) {
Przemek Stekiel19b80f82022-04-14 08:29:31 +02007101 /* Provide other secret.
Przemek Stekiel51a1f362022-04-13 08:57:06 +02007102 * Other secret is stored in premaster, where first 2 bytes hold the
Przemek Stekiel19b80f82022-04-14 08:29:31 +02007103 * length of the other key.
Przemek Stekielc2033402022-04-05 17:19:41 +02007104 */
Przemek Stekiel19b80f82022-04-14 08:29:31 +02007105 case MBEDTLS_KEY_EXCHANGE_RSA_PSK:
Przemek Stekiel8abcee92022-04-28 09:16:28 +02007106 /* For RSA-PSK other key length is always 48 bytes. */
Przemek Stekiel19b80f82022-04-14 08:29:31 +02007107 other_secret_len = 48;
7108 other_secret = handshake->premaster + 2;
7109 break;
7110 case MBEDTLS_KEY_EXCHANGE_ECDHE_PSK:
Przemek Stekielb293aaa2022-04-19 12:22:38 +02007111 case MBEDTLS_KEY_EXCHANGE_DHE_PSK:
Przemek Stekiel19b80f82022-04-14 08:29:31 +02007112 other_secret_len = MBEDTLS_GET_UINT16_BE(handshake->premaster, 0);
7113 other_secret = handshake->premaster + 2;
7114 break;
7115 default:
7116 break;
Przemek Stekielc2033402022-04-05 17:19:41 +02007117 }
7118
Gilles Peskine449bd832023-01-11 14:50:10 +01007119 status = setup_psa_key_derivation(&derivation, psk, alg,
7120 ssl->conf->psk, ssl->conf->psk_len,
7121 seed, seed_len,
7122 (unsigned char const *) lbl,
7123 (size_t) strlen(lbl),
7124 other_secret, other_secret_len,
7125 master_secret_len);
7126 if (status != PSA_SUCCESS) {
7127 psa_key_derivation_abort(&derivation);
7128 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007129 }
7130
Gilles Peskine449bd832023-01-11 14:50:10 +01007131 status = psa_key_derivation_output_bytes(&derivation,
7132 master,
7133 master_secret_len);
7134 if (status != PSA_SUCCESS) {
7135 psa_key_derivation_abort(&derivation);
7136 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007137 }
7138
Gilles Peskine449bd832023-01-11 14:50:10 +01007139 status = psa_key_derivation_abort(&derivation);
7140 if (status != PSA_SUCCESS) {
7141 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
7142 }
7143 } else
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007144#endif
7145 {
Neil Armstrongca7d5062022-05-31 14:43:23 +02007146#if defined(MBEDTLS_USE_PSA_CRYPTO) && \
Gilles Peskine449bd832023-01-11 14:50:10 +01007147 defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
7148 if (handshake->ciphersuite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_ECJPAKE) {
Neil Armstrongca7d5062022-05-31 14:43:23 +02007149 psa_status_t status;
7150 psa_algorithm_t alg = PSA_ALG_TLS12_ECJPAKE_TO_PMS;
7151 psa_key_derivation_operation_t derivation =
7152 PSA_KEY_DERIVATION_OPERATION_INIT;
7153
Gilles Peskine449bd832023-01-11 14:50:10 +01007154 MBEDTLS_SSL_DEBUG_MSG(2, ("perform PSA-based PMS KDF for ECJPAKE"));
Neil Armstrongca7d5062022-05-31 14:43:23 +02007155
7156 handshake->pmslen = PSA_TLS12_ECJPAKE_TO_PMS_DATA_SIZE;
7157
Gilles Peskine449bd832023-01-11 14:50:10 +01007158 status = psa_key_derivation_setup(&derivation, alg);
7159 if (status != PSA_SUCCESS) {
7160 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Neil Armstrongca7d5062022-05-31 14:43:23 +02007161 }
7162
Gilles Peskine449bd832023-01-11 14:50:10 +01007163 status = psa_key_derivation_set_capacity(&derivation,
7164 PSA_TLS12_ECJPAKE_TO_PMS_DATA_SIZE);
7165 if (status != PSA_SUCCESS) {
7166 psa_key_derivation_abort(&derivation);
7167 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Neil Armstrongca7d5062022-05-31 14:43:23 +02007168 }
7169
Gilles Peskine449bd832023-01-11 14:50:10 +01007170 status = psa_pake_get_implicit_key(&handshake->psa_pake_ctx,
7171 &derivation);
7172 if (status != PSA_SUCCESS) {
7173 psa_key_derivation_abort(&derivation);
7174 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Neil Armstrongca7d5062022-05-31 14:43:23 +02007175 }
7176
Gilles Peskine449bd832023-01-11 14:50:10 +01007177 status = psa_key_derivation_output_bytes(&derivation,
7178 handshake->premaster,
7179 handshake->pmslen);
7180 if (status != PSA_SUCCESS) {
7181 psa_key_derivation_abort(&derivation);
7182 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
7183 }
7184
7185 status = psa_key_derivation_abort(&derivation);
7186 if (status != PSA_SUCCESS) {
7187 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Neil Armstrongca7d5062022-05-31 14:43:23 +02007188 }
7189 }
7190#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01007191 ret = handshake->tls_prf(handshake->premaster, handshake->pmslen,
7192 lbl, seed, seed_len,
7193 master,
7194 master_secret_len);
7195 if (ret != 0) {
7196 MBEDTLS_SSL_DEBUG_RET(1, "prf", ret);
7197 return ret;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007198 }
7199
Gilles Peskine449bd832023-01-11 14:50:10 +01007200 MBEDTLS_SSL_DEBUG_BUF(3, "premaster secret",
7201 handshake->premaster,
7202 handshake->pmslen);
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007203
Gilles Peskine449bd832023-01-11 14:50:10 +01007204 mbedtls_platform_zeroize(handshake->premaster,
7205 sizeof(handshake->premaster));
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007206 }
7207
Gilles Peskine449bd832023-01-11 14:50:10 +01007208 return 0;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007209}
7210
Gilles Peskine449bd832023-01-11 14:50:10 +01007211int mbedtls_ssl_derive_keys(mbedtls_ssl_context *ssl)
Jerry Yud62f87e2022-02-17 14:09:02 +08007212{
7213 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7214 const mbedtls_ssl_ciphersuite_t * const ciphersuite_info =
7215 ssl->handshake->ciphersuite_info;
7216
Gilles Peskine449bd832023-01-11 14:50:10 +01007217 MBEDTLS_SSL_DEBUG_MSG(2, ("=> derive keys"));
Jerry Yud62f87e2022-02-17 14:09:02 +08007218
7219 /* Set PRF, calc_verify and calc_finished function pointers */
Gilles Peskine449bd832023-01-11 14:50:10 +01007220 ret = ssl_set_handshake_prfs(ssl->handshake,
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01007221 (mbedtls_md_type_t) ciphersuite_info->mac);
Gilles Peskine449bd832023-01-11 14:50:10 +01007222 if (ret != 0) {
7223 MBEDTLS_SSL_DEBUG_RET(1, "ssl_set_handshake_prfs", ret);
7224 return ret;
Jerry Yud62f87e2022-02-17 14:09:02 +08007225 }
7226
7227 /* Compute master secret if needed */
Gilles Peskine449bd832023-01-11 14:50:10 +01007228 ret = ssl_compute_master(ssl->handshake,
7229 ssl->session_negotiate->master,
7230 ssl);
7231 if (ret != 0) {
7232 MBEDTLS_SSL_DEBUG_RET(1, "ssl_compute_master", ret);
7233 return ret;
Jerry Yud62f87e2022-02-17 14:09:02 +08007234 }
7235
7236 /* Swap the client and server random values:
7237 * - MS derivation wanted client+server (RFC 5246 8.1)
7238 * - key derivation wants server+client (RFC 5246 6.3) */
7239 {
7240 unsigned char tmp[64];
Gilles Peskine449bd832023-01-11 14:50:10 +01007241 memcpy(tmp, ssl->handshake->randbytes, 64);
7242 memcpy(ssl->handshake->randbytes, tmp + 32, 32);
7243 memcpy(ssl->handshake->randbytes + 32, tmp, 32);
7244 mbedtls_platform_zeroize(tmp, sizeof(tmp));
Jerry Yud62f87e2022-02-17 14:09:02 +08007245 }
7246
7247 /* Populate transform structure */
Gilles Peskine449bd832023-01-11 14:50:10 +01007248 ret = ssl_tls12_populate_transform(ssl->transform_negotiate,
7249 ssl->session_negotiate->ciphersuite,
7250 ssl->session_negotiate->master,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02007251#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01007252 ssl->session_negotiate->encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02007253#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01007254 ssl->handshake->tls_prf,
7255 ssl->handshake->randbytes,
7256 ssl->tls_version,
7257 ssl->conf->endpoint,
7258 ssl);
7259 if (ret != 0) {
7260 MBEDTLS_SSL_DEBUG_RET(1, "ssl_tls12_populate_transform", ret);
7261 return ret;
Jerry Yud62f87e2022-02-17 14:09:02 +08007262 }
7263
7264 /* We no longer need Server/ClientHello.random values */
Gilles Peskine449bd832023-01-11 14:50:10 +01007265 mbedtls_platform_zeroize(ssl->handshake->randbytes,
7266 sizeof(ssl->handshake->randbytes));
Jerry Yud62f87e2022-02-17 14:09:02 +08007267
Gilles Peskine449bd832023-01-11 14:50:10 +01007268 MBEDTLS_SSL_DEBUG_MSG(2, ("<= derive keys"));
Jerry Yud62f87e2022-02-17 14:09:02 +08007269
Gilles Peskine449bd832023-01-11 14:50:10 +01007270 return 0;
Jerry Yud62f87e2022-02-17 14:09:02 +08007271}
Jerry Yu8392e0d2022-02-17 14:10:24 +08007272
Gilles Peskine449bd832023-01-11 14:50:10 +01007273int mbedtls_ssl_set_calc_verify_md(mbedtls_ssl_context *ssl, int md)
Ronald Cron4dcbca92022-03-07 10:21:40 +01007274{
Gilles Peskine449bd832023-01-11 14:50:10 +01007275 switch (md) {
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01007276#if defined(MBEDTLS_MD_CAN_SHA384)
Ronald Cron4dcbca92022-03-07 10:21:40 +01007277 case MBEDTLS_SSL_HASH_SHA384:
7278 ssl->handshake->calc_verify = ssl_calc_verify_tls_sha384;
7279 break;
7280#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01007281#if defined(MBEDTLS_MD_CAN_SHA256)
Ronald Cron4dcbca92022-03-07 10:21:40 +01007282 case MBEDTLS_SSL_HASH_SHA256:
7283 ssl->handshake->calc_verify = ssl_calc_verify_tls_sha256;
7284 break;
7285#endif
7286 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01007287 return -1;
Ronald Cron4dcbca92022-03-07 10:21:40 +01007288 }
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01007289#if !defined(MBEDTLS_MD_CAN_SHA384) && \
7290 !defined(MBEDTLS_MD_CAN_SHA256)
Andrzej Kurekeabeb302022-10-17 07:52:51 -04007291 (void) ssl;
7292#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01007293 return 0;
Ronald Cron4dcbca92022-03-07 10:21:40 +01007294}
7295
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007296#if defined(MBEDTLS_USE_PSA_CRYPTO)
7297static int ssl_calc_verify_tls_psa(const mbedtls_ssl_context *ssl,
7298 const psa_hash_operation_t *hs_op,
7299 size_t buffer_size,
7300 unsigned char *hash,
7301 size_t *hlen)
7302{
7303 psa_status_t status;
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007304 psa_hash_operation_t cloned_op = psa_hash_operation_init();
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007305
7306#if !defined(MBEDTLS_DEBUG_C)
7307 (void) ssl;
7308#endif
7309 MBEDTLS_SSL_DEBUG_MSG(2, ("=> PSA calc verify"));
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007310 status = psa_hash_clone(hs_op, &cloned_op);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007311 if (status != PSA_SUCCESS) {
7312 goto exit;
7313 }
7314
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007315 status = psa_hash_finish(&cloned_op, hash, buffer_size, hlen);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007316 if (status != PSA_SUCCESS) {
7317 goto exit;
7318 }
7319
7320 MBEDTLS_SSL_DEBUG_BUF(3, "PSA calculated verify result", hash, *hlen);
7321 MBEDTLS_SSL_DEBUG_MSG(2, ("<= PSA calc verify"));
7322
7323exit:
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007324 psa_hash_abort(&cloned_op);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007325 return mbedtls_md_error_from_psa(status);
7326}
7327#else
7328static int ssl_calc_verify_tls_legacy(const mbedtls_ssl_context *ssl,
7329 const mbedtls_md_context_t *hs_ctx,
7330 unsigned char *hash,
7331 size_t *hlen)
7332{
7333 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007334 mbedtls_md_context_t cloned_ctx;
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007335
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007336 mbedtls_md_init(&cloned_ctx);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007337
7338#if !defined(MBEDTLS_DEBUG_C)
7339 (void) ssl;
7340#endif
7341 MBEDTLS_SSL_DEBUG_MSG(2, ("=> calc verify"));
7342
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007343 ret = mbedtls_md_setup(&cloned_ctx, mbedtls_md_info_from_ctx(hs_ctx), 0);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007344 if (ret != 0) {
7345 goto exit;
7346 }
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007347 ret = mbedtls_md_clone(&cloned_ctx, hs_ctx);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007348 if (ret != 0) {
7349 goto exit;
7350 }
7351
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007352 ret = mbedtls_md_finish(&cloned_ctx, hash);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007353 if (ret != 0) {
7354 goto exit;
7355 }
7356
7357 *hlen = mbedtls_md_get_size(mbedtls_md_info_from_ctx(hs_ctx));
7358
7359 MBEDTLS_SSL_DEBUG_BUF(3, "calculated verify result", hash, *hlen);
7360 MBEDTLS_SSL_DEBUG_MSG(2, ("<= calc verify"));
7361
7362exit:
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007363 mbedtls_md_free(&cloned_ctx);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007364 return ret;
7365}
7366#endif /* MBEDTLS_USE_PSA_CRYPTO */
7367
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01007368#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +01007369int ssl_calc_verify_tls_sha256(const mbedtls_ssl_context *ssl,
7370 unsigned char *hash,
7371 size_t *hlen)
Jerry Yu8392e0d2022-02-17 14:10:24 +08007372{
7373#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007374 return ssl_calc_verify_tls_psa(ssl, &ssl->handshake->fin_sha256_psa, 32,
7375 hash, hlen);
Jerry Yu8392e0d2022-02-17 14:10:24 +08007376#else
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007377 return ssl_calc_verify_tls_legacy(ssl, &ssl->handshake->fin_sha256,
7378 hash, hlen);
Jerry Yu8392e0d2022-02-17 14:10:24 +08007379#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu8392e0d2022-02-17 14:10:24 +08007380}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01007381#endif /* MBEDTLS_MD_CAN_SHA256 */
Jerry Yu8392e0d2022-02-17 14:10:24 +08007382
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01007383#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +01007384int ssl_calc_verify_tls_sha384(const mbedtls_ssl_context *ssl,
7385 unsigned char *hash,
7386 size_t *hlen)
Jerry Yuc1cb3842022-02-17 14:13:48 +08007387{
7388#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007389 return ssl_calc_verify_tls_psa(ssl, &ssl->handshake->fin_sha384_psa, 48,
7390 hash, hlen);
Jerry Yuc1cb3842022-02-17 14:13:48 +08007391#else
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007392 return ssl_calc_verify_tls_legacy(ssl, &ssl->handshake->fin_sha384,
7393 hash, hlen);
Jerry Yuc1cb3842022-02-17 14:13:48 +08007394#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yuc1cb3842022-02-17 14:13:48 +08007395}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01007396#endif /* MBEDTLS_MD_CAN_SHA384 */
Jerry Yuc1cb3842022-02-17 14:13:48 +08007397
Neil Armstrong80f6f322022-05-03 17:56:38 +02007398#if !defined(MBEDTLS_USE_PSA_CRYPTO) && \
7399 defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007400int mbedtls_ssl_psk_derive_premaster(mbedtls_ssl_context *ssl, mbedtls_key_exchange_type_t key_ex)
Jerry Yuce3dca42022-02-17 14:16:37 +08007401{
7402 unsigned char *p = ssl->handshake->premaster;
Gilles Peskine449bd832023-01-11 14:50:10 +01007403 unsigned char *end = p + sizeof(ssl->handshake->premaster);
Jerry Yuce3dca42022-02-17 14:16:37 +08007404 const unsigned char *psk = NULL;
7405 size_t psk_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01007406 int psk_ret = mbedtls_ssl_get_psk(ssl, &psk, &psk_len);
Jerry Yuce3dca42022-02-17 14:16:37 +08007407
Gilles Peskine449bd832023-01-11 14:50:10 +01007408 if (psk_ret == MBEDTLS_ERR_SSL_PRIVATE_KEY_REQUIRED) {
Jerry Yuce3dca42022-02-17 14:16:37 +08007409 /*
7410 * This should never happen because the existence of a PSK is always
Przemek Stekielb293aaa2022-04-19 12:22:38 +02007411 * checked before calling this function.
7412 *
7413 * The exception is opaque DHE-PSK. For DHE-PSK fill premaster with
Przemek Stekiel8abcee92022-04-28 09:16:28 +02007414 * the shared secret without PSK.
Jerry Yuce3dca42022-02-17 14:16:37 +08007415 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007416 if (key_ex != MBEDTLS_KEY_EXCHANGE_DHE_PSK) {
7417 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
7418 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Przemek Stekielb293aaa2022-04-19 12:22:38 +02007419 }
Jerry Yuce3dca42022-02-17 14:16:37 +08007420 }
7421
7422 /*
7423 * PMS = struct {
7424 * opaque other_secret<0..2^16-1>;
7425 * opaque psk<0..2^16-1>;
7426 * };
7427 * with "other_secret" depending on the particular key exchange
7428 */
7429#if defined(MBEDTLS_KEY_EXCHANGE_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007430 if (key_ex == MBEDTLS_KEY_EXCHANGE_PSK) {
7431 if (end - p < 2) {
7432 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
7433 }
Jerry Yuce3dca42022-02-17 14:16:37 +08007434
Gilles Peskine449bd832023-01-11 14:50:10 +01007435 MBEDTLS_PUT_UINT16_BE(psk_len, p, 0);
Jerry Yuce3dca42022-02-17 14:16:37 +08007436 p += 2;
7437
Gilles Peskine449bd832023-01-11 14:50:10 +01007438 if (end < p || (size_t) (end - p) < psk_len) {
7439 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
7440 }
Jerry Yuce3dca42022-02-17 14:16:37 +08007441
Gilles Peskine449bd832023-01-11 14:50:10 +01007442 memset(p, 0, psk_len);
Jerry Yuce3dca42022-02-17 14:16:37 +08007443 p += psk_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01007444 } else
Jerry Yuce3dca42022-02-17 14:16:37 +08007445#endif /* MBEDTLS_KEY_EXCHANGE_PSK_ENABLED */
7446#if defined(MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007447 if (key_ex == MBEDTLS_KEY_EXCHANGE_RSA_PSK) {
Jerry Yuce3dca42022-02-17 14:16:37 +08007448 /*
7449 * other_secret already set by the ClientKeyExchange message,
7450 * and is 48 bytes long
7451 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007452 if (end - p < 2) {
7453 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
7454 }
Jerry Yuce3dca42022-02-17 14:16:37 +08007455
7456 *p++ = 0;
7457 *p++ = 48;
7458 p += 48;
Gilles Peskine449bd832023-01-11 14:50:10 +01007459 } else
Jerry Yuce3dca42022-02-17 14:16:37 +08007460#endif /* MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED */
7461#if defined(MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007462 if (key_ex == MBEDTLS_KEY_EXCHANGE_DHE_PSK) {
Jerry Yuce3dca42022-02-17 14:16:37 +08007463 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7464 size_t len;
7465
7466 /* Write length only when we know the actual value */
Gilles Peskine449bd832023-01-11 14:50:10 +01007467 if ((ret = mbedtls_dhm_calc_secret(&ssl->handshake->dhm_ctx,
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00007468 p + 2, (size_t) (end - (p + 2)), &len,
Gilles Peskine449bd832023-01-11 14:50:10 +01007469 ssl->conf->f_rng, ssl->conf->p_rng)) != 0) {
7470 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_dhm_calc_secret", ret);
7471 return ret;
Jerry Yuce3dca42022-02-17 14:16:37 +08007472 }
Gilles Peskine449bd832023-01-11 14:50:10 +01007473 MBEDTLS_PUT_UINT16_BE(len, p, 0);
Jerry Yuce3dca42022-02-17 14:16:37 +08007474 p += 2 + len;
7475
Gilles Peskine449bd832023-01-11 14:50:10 +01007476 MBEDTLS_SSL_DEBUG_MPI(3, "DHM: K ", &ssl->handshake->dhm_ctx.K);
7477 } else
Jerry Yuce3dca42022-02-17 14:16:37 +08007478#endif /* MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED */
Neil Armstrong80f6f322022-05-03 17:56:38 +02007479#if defined(MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007480 if (key_ex == MBEDTLS_KEY_EXCHANGE_ECDHE_PSK) {
Jerry Yuce3dca42022-02-17 14:16:37 +08007481 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7482 size_t zlen;
7483
Gilles Peskine449bd832023-01-11 14:50:10 +01007484 if ((ret = mbedtls_ecdh_calc_secret(&ssl->handshake->ecdh_ctx, &zlen,
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00007485 p + 2, (size_t) (end - (p + 2)),
Gilles Peskine449bd832023-01-11 14:50:10 +01007486 ssl->conf->f_rng, ssl->conf->p_rng)) != 0) {
7487 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ecdh_calc_secret", ret);
7488 return ret;
Jerry Yuce3dca42022-02-17 14:16:37 +08007489 }
7490
Gilles Peskine449bd832023-01-11 14:50:10 +01007491 MBEDTLS_PUT_UINT16_BE(zlen, p, 0);
Jerry Yuce3dca42022-02-17 14:16:37 +08007492 p += 2 + zlen;
7493
Gilles Peskine449bd832023-01-11 14:50:10 +01007494 MBEDTLS_SSL_DEBUG_ECDH(3, &ssl->handshake->ecdh_ctx,
7495 MBEDTLS_DEBUG_ECDH_Z);
7496 } else
Neil Armstrong80f6f322022-05-03 17:56:38 +02007497#endif /* MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED */
Jerry Yuce3dca42022-02-17 14:16:37 +08007498 {
Gilles Peskine449bd832023-01-11 14:50:10 +01007499 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
7500 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yuce3dca42022-02-17 14:16:37 +08007501 }
7502
7503 /* opaque psk<0..2^16-1>; */
Gilles Peskine449bd832023-01-11 14:50:10 +01007504 if (end - p < 2) {
7505 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
7506 }
Jerry Yuce3dca42022-02-17 14:16:37 +08007507
Gilles Peskine449bd832023-01-11 14:50:10 +01007508 MBEDTLS_PUT_UINT16_BE(psk_len, p, 0);
Jerry Yuce3dca42022-02-17 14:16:37 +08007509 p += 2;
7510
Gilles Peskine449bd832023-01-11 14:50:10 +01007511 if (end < p || (size_t) (end - p) < psk_len) {
7512 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
7513 }
Jerry Yuce3dca42022-02-17 14:16:37 +08007514
Gilles Peskine449bd832023-01-11 14:50:10 +01007515 memcpy(p, psk, psk_len);
Jerry Yuce3dca42022-02-17 14:16:37 +08007516 p += psk_len;
7517
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00007518 ssl->handshake->pmslen = (size_t) (p - ssl->handshake->premaster);
Jerry Yuce3dca42022-02-17 14:16:37 +08007519
Gilles Peskine449bd832023-01-11 14:50:10 +01007520 return 0;
Jerry Yuce3dca42022-02-17 14:16:37 +08007521}
Neil Armstrong80f6f322022-05-03 17:56:38 +02007522#endif /* !MBEDTLS_USE_PSA_CRYPTO && MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
Jerry Yuc2c673d2022-02-17 14:20:39 +08007523
7524#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007525MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007526static int ssl_write_hello_request(mbedtls_ssl_context *ssl);
Jerry Yuc2c673d2022-02-17 14:20:39 +08007527
7528#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01007529int mbedtls_ssl_resend_hello_request(mbedtls_ssl_context *ssl)
Jerry Yuc2c673d2022-02-17 14:20:39 +08007530{
7531 /* If renegotiation is not enforced, retransmit until we would reach max
7532 * timeout if we were using the usual handshake doubling scheme */
Gilles Peskine449bd832023-01-11 14:50:10 +01007533 if (ssl->conf->renego_max_records < 0) {
Jerry Yuc2c673d2022-02-17 14:20:39 +08007534 uint32_t ratio = ssl->conf->hs_timeout_max / ssl->conf->hs_timeout_min + 1;
7535 unsigned char doublings = 1;
7536
Gilles Peskine449bd832023-01-11 14:50:10 +01007537 while (ratio != 0) {
Jerry Yuc2c673d2022-02-17 14:20:39 +08007538 ++doublings;
7539 ratio >>= 1;
7540 }
7541
Gilles Peskine449bd832023-01-11 14:50:10 +01007542 if (++ssl->renego_records_seen > doublings) {
7543 MBEDTLS_SSL_DEBUG_MSG(2, ("no longer retransmitting hello request"));
7544 return 0;
Jerry Yuc2c673d2022-02-17 14:20:39 +08007545 }
7546 }
7547
Gilles Peskine449bd832023-01-11 14:50:10 +01007548 return ssl_write_hello_request(ssl);
Jerry Yuc2c673d2022-02-17 14:20:39 +08007549}
7550#endif
7551#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_RENEGOTIATION */
Jerry Yud9526692022-02-17 14:23:47 +08007552
Jerry Yud9526692022-02-17 14:23:47 +08007553/*
7554 * Handshake functions
7555 */
7556#if !defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
7557/* No certificate support -> dummy functions */
Gilles Peskine449bd832023-01-11 14:50:10 +01007558int mbedtls_ssl_write_certificate(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08007559{
7560 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
7561 ssl->handshake->ciphersuite_info;
7562
Gilles Peskine449bd832023-01-11 14:50:10 +01007563 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007564
Gilles Peskine449bd832023-01-11 14:50:10 +01007565 if (!mbedtls_ssl_ciphersuite_uses_srv_cert(ciphersuite_info)) {
7566 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007567 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01007568 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007569 }
7570
Gilles Peskine449bd832023-01-11 14:50:10 +01007571 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
7572 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007573}
7574
Gilles Peskine449bd832023-01-11 14:50:10 +01007575int mbedtls_ssl_parse_certificate(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08007576{
7577 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
7578 ssl->handshake->ciphersuite_info;
7579
Gilles Peskine449bd832023-01-11 14:50:10 +01007580 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007581
Gilles Peskine449bd832023-01-11 14:50:10 +01007582 if (!mbedtls_ssl_ciphersuite_uses_srv_cert(ciphersuite_info)) {
7583 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007584 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01007585 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007586 }
7587
Gilles Peskine449bd832023-01-11 14:50:10 +01007588 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
7589 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007590}
7591
7592#else /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
7593/* Some certificate support -> implement write and parse */
7594
Gilles Peskine449bd832023-01-11 14:50:10 +01007595int mbedtls_ssl_write_certificate(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08007596{
7597 int ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
7598 size_t i, n;
7599 const mbedtls_x509_crt *crt;
7600 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
7601 ssl->handshake->ciphersuite_info;
7602
Gilles Peskine449bd832023-01-11 14:50:10 +01007603 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007604
Gilles Peskine449bd832023-01-11 14:50:10 +01007605 if (!mbedtls_ssl_ciphersuite_uses_srv_cert(ciphersuite_info)) {
7606 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007607 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01007608 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007609 }
7610
7611#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007612 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
7613 if (ssl->handshake->client_auth == 0) {
7614 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007615 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01007616 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007617 }
7618 }
7619#endif /* MBEDTLS_SSL_CLI_C */
7620#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007621 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
7622 if (mbedtls_ssl_own_cert(ssl) == NULL) {
Jerry Yud9526692022-02-17 14:23:47 +08007623 /* Should never happen because we shouldn't have picked the
7624 * ciphersuite if we don't have a certificate. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007625 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007626 }
7627 }
7628#endif
7629
Gilles Peskine449bd832023-01-11 14:50:10 +01007630 MBEDTLS_SSL_DEBUG_CRT(3, "own certificate", mbedtls_ssl_own_cert(ssl));
Jerry Yud9526692022-02-17 14:23:47 +08007631
7632 /*
7633 * 0 . 0 handshake type
7634 * 1 . 3 handshake length
7635 * 4 . 6 length of all certs
7636 * 7 . 9 length of cert. 1
7637 * 10 . n-1 peer certificate
7638 * n . n+2 length of cert. 2
7639 * n+3 . ... upper level cert, etc.
7640 */
7641 i = 7;
Gilles Peskine449bd832023-01-11 14:50:10 +01007642 crt = mbedtls_ssl_own_cert(ssl);
Jerry Yud9526692022-02-17 14:23:47 +08007643
Gilles Peskine449bd832023-01-11 14:50:10 +01007644 while (crt != NULL) {
Jerry Yud9526692022-02-17 14:23:47 +08007645 n = crt->raw.len;
Gilles Peskine449bd832023-01-11 14:50:10 +01007646 if (n > MBEDTLS_SSL_OUT_CONTENT_LEN - 3 - i) {
7647 MBEDTLS_SSL_DEBUG_MSG(1, ("certificate too large, %" MBEDTLS_PRINTF_SIZET
7648 " > %" MBEDTLS_PRINTF_SIZET,
7649 i + 3 + n, (size_t) MBEDTLS_SSL_OUT_CONTENT_LEN));
7650 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
Jerry Yud9526692022-02-17 14:23:47 +08007651 }
7652
Gilles Peskine449bd832023-01-11 14:50:10 +01007653 ssl->out_msg[i] = MBEDTLS_BYTE_2(n);
7654 ssl->out_msg[i + 1] = MBEDTLS_BYTE_1(n);
7655 ssl->out_msg[i + 2] = MBEDTLS_BYTE_0(n);
Jerry Yud9526692022-02-17 14:23:47 +08007656
Gilles Peskine449bd832023-01-11 14:50:10 +01007657 i += 3; memcpy(ssl->out_msg + i, crt->raw.p, n);
Jerry Yud9526692022-02-17 14:23:47 +08007658 i += n; crt = crt->next;
7659 }
7660
Gilles Peskine449bd832023-01-11 14:50:10 +01007661 ssl->out_msg[4] = MBEDTLS_BYTE_2(i - 7);
7662 ssl->out_msg[5] = MBEDTLS_BYTE_1(i - 7);
7663 ssl->out_msg[6] = MBEDTLS_BYTE_0(i - 7);
Jerry Yud9526692022-02-17 14:23:47 +08007664
7665 ssl->out_msglen = i;
7666 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
7667 ssl->out_msg[0] = MBEDTLS_SSL_HS_CERTIFICATE;
7668
7669 ssl->state++;
7670
Gilles Peskine449bd832023-01-11 14:50:10 +01007671 if ((ret = mbedtls_ssl_write_handshake_msg(ssl)) != 0) {
7672 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_handshake_msg", ret);
7673 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007674 }
7675
Gilles Peskine449bd832023-01-11 14:50:10 +01007676 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007677
Gilles Peskine449bd832023-01-11 14:50:10 +01007678 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007679}
7680
7681#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
7682
7683#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007684MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007685static int ssl_check_peer_crt_unchanged(mbedtls_ssl_context *ssl,
7686 unsigned char *crt_buf,
7687 size_t crt_buf_len)
Jerry Yud9526692022-02-17 14:23:47 +08007688{
7689 mbedtls_x509_crt const * const peer_crt = ssl->session->peer_cert;
7690
Gilles Peskine449bd832023-01-11 14:50:10 +01007691 if (peer_crt == NULL) {
7692 return -1;
7693 }
Jerry Yud9526692022-02-17 14:23:47 +08007694
Gilles Peskine449bd832023-01-11 14:50:10 +01007695 if (peer_crt->raw.len != crt_buf_len) {
7696 return -1;
7697 }
Jerry Yud9526692022-02-17 14:23:47 +08007698
Gilles Peskine449bd832023-01-11 14:50:10 +01007699 return memcmp(peer_crt->raw.p, crt_buf, peer_crt->raw.len);
Jerry Yud9526692022-02-17 14:23:47 +08007700}
7701#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007702MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007703static int ssl_check_peer_crt_unchanged(mbedtls_ssl_context *ssl,
7704 unsigned char *crt_buf,
7705 size_t crt_buf_len)
Jerry Yud9526692022-02-17 14:23:47 +08007706{
7707 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7708 unsigned char const * const peer_cert_digest =
7709 ssl->session->peer_cert_digest;
7710 mbedtls_md_type_t const peer_cert_digest_type =
7711 ssl->session->peer_cert_digest_type;
7712 mbedtls_md_info_t const * const digest_info =
Gilles Peskine449bd832023-01-11 14:50:10 +01007713 mbedtls_md_info_from_type(peer_cert_digest_type);
Jerry Yud9526692022-02-17 14:23:47 +08007714 unsigned char tmp_digest[MBEDTLS_SSL_PEER_CERT_DIGEST_MAX_LEN];
7715 size_t digest_len;
7716
Gilles Peskine449bd832023-01-11 14:50:10 +01007717 if (peer_cert_digest == NULL || digest_info == NULL) {
7718 return -1;
7719 }
Jerry Yud9526692022-02-17 14:23:47 +08007720
Gilles Peskine449bd832023-01-11 14:50:10 +01007721 digest_len = mbedtls_md_get_size(digest_info);
7722 if (digest_len > MBEDTLS_SSL_PEER_CERT_DIGEST_MAX_LEN) {
7723 return -1;
7724 }
Jerry Yud9526692022-02-17 14:23:47 +08007725
Gilles Peskine449bd832023-01-11 14:50:10 +01007726 ret = mbedtls_md(digest_info, crt_buf, crt_buf_len, tmp_digest);
7727 if (ret != 0) {
7728 return -1;
7729 }
Jerry Yud9526692022-02-17 14:23:47 +08007730
Gilles Peskine449bd832023-01-11 14:50:10 +01007731 return memcmp(tmp_digest, peer_cert_digest, digest_len);
Jerry Yud9526692022-02-17 14:23:47 +08007732}
7733#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7734#endif /* MBEDTLS_SSL_RENEGOTIATION && MBEDTLS_SSL_CLI_C */
7735
7736/*
7737 * Once the certificate message is read, parse it into a cert chain and
7738 * perform basic checks, but leave actual verification to the caller
7739 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007740MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007741static int ssl_parse_certificate_chain(mbedtls_ssl_context *ssl,
7742 mbedtls_x509_crt *chain)
Jerry Yud9526692022-02-17 14:23:47 +08007743{
7744 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7745#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007746 int crt_cnt = 0;
Jerry Yud9526692022-02-17 14:23:47 +08007747#endif
7748 size_t i, n;
7749 uint8_t alert;
7750
Gilles Peskine449bd832023-01-11 14:50:10 +01007751 if (ssl->in_msgtype != MBEDTLS_SSL_MSG_HANDSHAKE) {
7752 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7753 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7754 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
7755 return MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
Jerry Yud9526692022-02-17 14:23:47 +08007756 }
7757
Gilles Peskine449bd832023-01-11 14:50:10 +01007758 if (ssl->in_msg[0] != MBEDTLS_SSL_HS_CERTIFICATE) {
7759 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7760 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
7761 return MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
Jerry Yud9526692022-02-17 14:23:47 +08007762 }
7763
Gilles Peskine449bd832023-01-11 14:50:10 +01007764 if (ssl->in_hslen < mbedtls_ssl_hs_hdr_len(ssl) + 3 + 3) {
7765 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7766 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7767 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
7768 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007769 }
7770
Gilles Peskine449bd832023-01-11 14:50:10 +01007771 i = mbedtls_ssl_hs_hdr_len(ssl);
Jerry Yud9526692022-02-17 14:23:47 +08007772
7773 /*
7774 * Same message structure as in mbedtls_ssl_write_certificate()
7775 */
Dave Rodgmana3d0f612023-11-03 23:34:02 +00007776 n = MBEDTLS_GET_UINT16_BE(ssl->in_msg, i + 1);
Jerry Yud9526692022-02-17 14:23:47 +08007777
Gilles Peskine449bd832023-01-11 14:50:10 +01007778 if (ssl->in_msg[i] != 0 ||
7779 ssl->in_hslen != n + 3 + mbedtls_ssl_hs_hdr_len(ssl)) {
7780 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7781 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7782 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
7783 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007784 }
7785
7786 /* Make &ssl->in_msg[i] point to the beginning of the CRT chain. */
7787 i += 3;
7788
7789 /* Iterate through and parse the CRTs in the provided chain. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007790 while (i < ssl->in_hslen) {
Jerry Yud9526692022-02-17 14:23:47 +08007791 /* Check that there's room for the next CRT's length fields. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007792 if (i + 3 > ssl->in_hslen) {
7793 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7794 mbedtls_ssl_send_alert_message(ssl,
7795 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7796 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
7797 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007798 }
7799 /* In theory, the CRT can be up to 2**24 Bytes, but we don't support
7800 * anything beyond 2**16 ~ 64K. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007801 if (ssl->in_msg[i] != 0) {
7802 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7803 mbedtls_ssl_send_alert_message(ssl,
7804 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7805 MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT);
7806 return MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
Jerry Yud9526692022-02-17 14:23:47 +08007807 }
7808
7809 /* Read length of the next CRT in the chain. */
Dave Rodgmana3d0f612023-11-03 23:34:02 +00007810 n = MBEDTLS_GET_UINT16_BE(ssl->in_msg, i + 1);
Jerry Yud9526692022-02-17 14:23:47 +08007811 i += 3;
7812
Gilles Peskine449bd832023-01-11 14:50:10 +01007813 if (n < 128 || i + n > ssl->in_hslen) {
7814 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7815 mbedtls_ssl_send_alert_message(ssl,
7816 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7817 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
7818 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007819 }
7820
7821 /* Check if we're handling the first CRT in the chain. */
7822#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007823 if (crt_cnt++ == 0 &&
Jerry Yud9526692022-02-17 14:23:47 +08007824 ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
Gilles Peskine449bd832023-01-11 14:50:10 +01007825 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS) {
Jerry Yud9526692022-02-17 14:23:47 +08007826 /* During client-side renegotiation, check that the server's
7827 * end-CRTs hasn't changed compared to the initial handshake,
7828 * mitigating the triple handshake attack. On success, reuse
7829 * the original end-CRT instead of parsing it again. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007830 MBEDTLS_SSL_DEBUG_MSG(3, ("Check that peer CRT hasn't changed during renegotiation"));
7831 if (ssl_check_peer_crt_unchanged(ssl,
7832 &ssl->in_msg[i],
7833 n) != 0) {
7834 MBEDTLS_SSL_DEBUG_MSG(1, ("new server cert during renegotiation"));
7835 mbedtls_ssl_send_alert_message(ssl,
7836 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7837 MBEDTLS_SSL_ALERT_MSG_ACCESS_DENIED);
7838 return MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
Jerry Yud9526692022-02-17 14:23:47 +08007839 }
7840
7841 /* Now we can safely free the original chain. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007842 ssl_clear_peer_cert(ssl->session);
Jerry Yud9526692022-02-17 14:23:47 +08007843 }
7844#endif /* MBEDTLS_SSL_RENEGOTIATION && MBEDTLS_SSL_CLI_C */
7845
7846 /* Parse the next certificate in the chain. */
7847#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01007848 ret = mbedtls_x509_crt_parse_der(chain, ssl->in_msg + i, n);
Jerry Yud9526692022-02-17 14:23:47 +08007849#else
7850 /* If we don't need to store the CRT chain permanently, parse
7851 * it in-place from the input buffer instead of making a copy. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007852 ret = mbedtls_x509_crt_parse_der_nocopy(chain, ssl->in_msg + i, n);
Jerry Yud9526692022-02-17 14:23:47 +08007853#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Gilles Peskine449bd832023-01-11 14:50:10 +01007854 switch (ret) {
Jerry Yud9526692022-02-17 14:23:47 +08007855 case 0: /*ok*/
7856 case MBEDTLS_ERR_X509_UNKNOWN_SIG_ALG + MBEDTLS_ERR_OID_NOT_FOUND:
7857 /* Ignore certificate with an unknown algorithm: maybe a
7858 prior certificate was already trusted. */
7859 break;
7860
7861 case MBEDTLS_ERR_X509_ALLOC_FAILED:
7862 alert = MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR;
7863 goto crt_parse_der_failed;
7864
7865 case MBEDTLS_ERR_X509_UNKNOWN_VERSION:
7866 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
7867 goto crt_parse_der_failed;
7868
7869 default:
7870 alert = MBEDTLS_SSL_ALERT_MSG_BAD_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01007871crt_parse_der_failed:
7872 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL, alert);
7873 MBEDTLS_SSL_DEBUG_RET(1, " mbedtls_x509_crt_parse_der", ret);
7874 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007875 }
7876
7877 i += n;
7878 }
7879
Gilles Peskine449bd832023-01-11 14:50:10 +01007880 MBEDTLS_SSL_DEBUG_CRT(3, "peer certificate", chain);
7881 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007882}
7883
7884#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007885MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007886static int ssl_srv_check_client_no_crt_notification(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08007887{
Gilles Peskine449bd832023-01-11 14:50:10 +01007888 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
7889 return -1;
7890 }
Jerry Yud9526692022-02-17 14:23:47 +08007891
Gilles Peskine449bd832023-01-11 14:50:10 +01007892 if (ssl->in_hslen == 3 + mbedtls_ssl_hs_hdr_len(ssl) &&
Jerry Yud9526692022-02-17 14:23:47 +08007893 ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
7894 ssl->in_msg[0] == MBEDTLS_SSL_HS_CERTIFICATE &&
Gilles Peskine449bd832023-01-11 14:50:10 +01007895 memcmp(ssl->in_msg + mbedtls_ssl_hs_hdr_len(ssl), "\0\0\0", 3) == 0) {
7896 MBEDTLS_SSL_DEBUG_MSG(1, ("peer has no certificate"));
7897 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007898 }
Gilles Peskine449bd832023-01-11 14:50:10 +01007899 return -1;
Jerry Yud9526692022-02-17 14:23:47 +08007900}
7901#endif /* MBEDTLS_SSL_SRV_C */
7902
7903/* Check if a certificate message is expected.
7904 * Return either
7905 * - SSL_CERTIFICATE_EXPECTED, or
7906 * - SSL_CERTIFICATE_SKIP
7907 * indicating whether a Certificate message is expected or not.
7908 */
7909#define SSL_CERTIFICATE_EXPECTED 0
7910#define SSL_CERTIFICATE_SKIP 1
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007911MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007912static int ssl_parse_certificate_coordinate(mbedtls_ssl_context *ssl,
7913 int authmode)
Jerry Yud9526692022-02-17 14:23:47 +08007914{
7915 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
7916 ssl->handshake->ciphersuite_info;
7917
Gilles Peskine449bd832023-01-11 14:50:10 +01007918 if (!mbedtls_ssl_ciphersuite_uses_srv_cert(ciphersuite_info)) {
7919 return SSL_CERTIFICATE_SKIP;
7920 }
Jerry Yud9526692022-02-17 14:23:47 +08007921
7922#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007923 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
7924 if (ciphersuite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_RSA_PSK) {
7925 return SSL_CERTIFICATE_SKIP;
7926 }
Jerry Yud9526692022-02-17 14:23:47 +08007927
Gilles Peskine449bd832023-01-11 14:50:10 +01007928 if (authmode == MBEDTLS_SSL_VERIFY_NONE) {
Jerry Yud9526692022-02-17 14:23:47 +08007929 ssl->session_negotiate->verify_result =
7930 MBEDTLS_X509_BADCERT_SKIP_VERIFY;
Gilles Peskine449bd832023-01-11 14:50:10 +01007931 return SSL_CERTIFICATE_SKIP;
Jerry Yud9526692022-02-17 14:23:47 +08007932 }
7933 }
7934#else
7935 ((void) authmode);
7936#endif /* MBEDTLS_SSL_SRV_C */
7937
Gilles Peskine449bd832023-01-11 14:50:10 +01007938 return SSL_CERTIFICATE_EXPECTED;
Jerry Yud9526692022-02-17 14:23:47 +08007939}
7940
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007941MBEDTLS_CHECK_RETURN_CRITICAL
Manuel Pégourié-Gonnardd37054c2024-08-16 10:01:48 +02007942static int ssl_verify_certificate(mbedtls_ssl_context *ssl,
7943 int authmode,
7944 mbedtls_x509_crt *chain,
7945 const mbedtls_ssl_ciphersuite_t *ciphersuite_info,
7946 void *rs_ctx)
Jerry Yud9526692022-02-17 14:23:47 +08007947{
7948 int ret = 0;
Manuel Pégourié-Gonnarde910ac82024-08-14 12:52:59 +02007949 int have_ca_chain_or_callback = 0;
Jerry Yud9526692022-02-17 14:23:47 +08007950
Gilles Peskine449bd832023-01-11 14:50:10 +01007951 if (authmode == MBEDTLS_SSL_VERIFY_NONE) {
7952 return 0;
7953 }
Jerry Yud9526692022-02-17 14:23:47 +08007954
Manuel Pégourié-Gonnarddee6ffa2024-08-16 09:53:41 +02007955 /* Verify callback: precedence order is SSL context, else conf struct. */
Manuel Pégourié-Gonnard523a7e42024-08-14 12:51:00 +02007956 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *);
7957 void *p_vrfy;
Gilles Peskine449bd832023-01-11 14:50:10 +01007958 if (ssl->f_vrfy != NULL) {
7959 MBEDTLS_SSL_DEBUG_MSG(3, ("Use context-specific verification callback"));
Jerry Yud9526692022-02-17 14:23:47 +08007960 f_vrfy = ssl->f_vrfy;
7961 p_vrfy = ssl->p_vrfy;
Gilles Peskine449bd832023-01-11 14:50:10 +01007962 } else {
7963 MBEDTLS_SSL_DEBUG_MSG(3, ("Use configuration-specific verification callback"));
Jerry Yud9526692022-02-17 14:23:47 +08007964 f_vrfy = ssl->conf->f_vrfy;
7965 p_vrfy = ssl->conf->p_vrfy;
7966 }
7967
7968 /*
7969 * Main check: verify certificate
7970 */
7971#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
Gilles Peskine449bd832023-01-11 14:50:10 +01007972 if (ssl->conf->f_ca_cb != NULL) {
Jerry Yud9526692022-02-17 14:23:47 +08007973 ((void) rs_ctx);
Manuel Pégourié-Gonnarde910ac82024-08-14 12:52:59 +02007974 have_ca_chain_or_callback = 1;
Jerry Yud9526692022-02-17 14:23:47 +08007975
Gilles Peskine449bd832023-01-11 14:50:10 +01007976 MBEDTLS_SSL_DEBUG_MSG(3, ("use CA callback for X.509 CRT verification"));
Jerry Yud9526692022-02-17 14:23:47 +08007977 ret = mbedtls_x509_crt_verify_with_ca_cb(
7978 chain,
7979 ssl->conf->f_ca_cb,
7980 ssl->conf->p_ca_cb,
7981 ssl->conf->cert_profile,
7982 ssl->hostname,
7983 &ssl->session_negotiate->verify_result,
Gilles Peskine449bd832023-01-11 14:50:10 +01007984 f_vrfy, p_vrfy);
7985 } else
Jerry Yud9526692022-02-17 14:23:47 +08007986#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
7987 {
7988 mbedtls_x509_crt *ca_chain;
7989 mbedtls_x509_crl *ca_crl;
Jerry Yud9526692022-02-17 14:23:47 +08007990#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) {
Manuel Pégourié-Gonnarde910ac82024-08-14 12:52:59 +02008002 have_ca_chain_or_callback = 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
Manuel Pégourié-Gonnard8a14aaa2024-08-09 12:00:34 +02008028 /* Check curve for ECC certs */
Valerio Settiacd32c02023-06-29 18:06:29 +02008029#if defined(MBEDTLS_PK_HAVE_ECC_KEYS)
Manuel Pégourié-Gonnard8a14aaa2024-08-09 12:00:34 +02008030 if (mbedtls_pk_can_do(&chain->pk, MBEDTLS_PK_ECKEY) &&
8031 mbedtls_ssl_check_curve(ssl, mbedtls_pk_get_ec_group_id(&chain->pk)) != 0) {
8032 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate (EC key curve)"));
8033 ssl->session_negotiate->verify_result |= MBEDTLS_X509_BADCERT_BAD_KEY;
8034 if (ret == 0) {
8035 ret = MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
Jerry Yud9526692022-02-17 14:23:47 +08008036 }
8037 }
Valerio Settiacd32c02023-06-29 18:06:29 +02008038#endif /* MBEDTLS_PK_HAVE_ECC_KEYS */
Jerry Yud9526692022-02-17 14:23:47 +08008039
Manuel Pégourié-Gonnard8a14aaa2024-08-09 12:00:34 +02008040 /* Check X.509 usage extensions (keyUsage, extKeyUsage) */
Gilles Peskine449bd832023-01-11 14:50:10 +01008041 if (mbedtls_ssl_check_cert_usage(chain,
8042 ciphersuite_info,
Manuel Pégourié-Gonnard96a0c5c2024-08-09 11:26:25 +02008043 ssl->conf->endpoint,
Manuel Pégourié-Gonnard4938b692024-08-09 11:49:12 +02008044 MBEDTLS_SSL_VERSION_TLS1_2,
Gilles Peskine449bd832023-01-11 14:50:10 +01008045 &ssl->session_negotiate->verify_result) != 0) {
8046 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate (usage extensions)"));
8047 if (ret == 0) {
Jerry Yud9526692022-02-17 14:23:47 +08008048 ret = MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
Gilles Peskine449bd832023-01-11 14:50:10 +01008049 }
Jerry Yud9526692022-02-17 14:23:47 +08008050 }
8051
8052 /* mbedtls_x509_crt_verify_with_profile is supposed to report a
8053 * verification failure through MBEDTLS_ERR_X509_CERT_VERIFY_FAILED,
8054 * with details encoded in the verification flags. All other kinds
8055 * of error codes, including those from the user provided f_vrfy
8056 * functions, are treated as fatal and lead to a failure of
8057 * ssl_parse_certificate even if verification was optional. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008058 if (authmode == MBEDTLS_SSL_VERIFY_OPTIONAL &&
8059 (ret == MBEDTLS_ERR_X509_CERT_VERIFY_FAILED ||
8060 ret == MBEDTLS_ERR_SSL_BAD_CERTIFICATE)) {
Jerry Yud9526692022-02-17 14:23:47 +08008061 ret = 0;
8062 }
8063
Manuel Pégourié-Gonnarde910ac82024-08-14 12:52:59 +02008064 if (have_ca_chain_or_callback == 0 && authmode == MBEDTLS_SSL_VERIFY_REQUIRED) {
Gilles Peskine449bd832023-01-11 14:50:10 +01008065 MBEDTLS_SSL_DEBUG_MSG(1, ("got no CA chain"));
Jerry Yud9526692022-02-17 14:23:47 +08008066 ret = MBEDTLS_ERR_SSL_CA_CHAIN_REQUIRED;
8067 }
8068
Gilles Peskine449bd832023-01-11 14:50:10 +01008069 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08008070 uint8_t alert;
8071
8072 /* The certificate may have been rejected for several reasons.
8073 Pick one and send the corresponding alert. Which alert to send
8074 may be a subject of debate in some cases. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008075 if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_OTHER) {
Jerry Yud9526692022-02-17 14:23:47 +08008076 alert = MBEDTLS_SSL_ALERT_MSG_ACCESS_DENIED;
Gilles Peskine449bd832023-01-11 14:50:10 +01008077 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_CN_MISMATCH) {
Jerry Yud9526692022-02-17 14:23:47 +08008078 alert = MBEDTLS_SSL_ALERT_MSG_BAD_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01008079 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_KEY_USAGE) {
Jerry Yud9526692022-02-17 14:23:47 +08008080 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01008081 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_EXT_KEY_USAGE) {
Jerry Yud9526692022-02-17 14:23:47 +08008082 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01008083 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_BAD_PK) {
Jerry Yud9526692022-02-17 14:23:47 +08008084 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01008085 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_BAD_KEY) {
Jerry Yud9526692022-02-17 14:23:47 +08008086 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01008087 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_EXPIRED) {
Jerry Yud9526692022-02-17 14:23:47 +08008088 alert = MBEDTLS_SSL_ALERT_MSG_CERT_EXPIRED;
Gilles Peskine449bd832023-01-11 14:50:10 +01008089 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_REVOKED) {
Jerry Yud9526692022-02-17 14:23:47 +08008090 alert = MBEDTLS_SSL_ALERT_MSG_CERT_REVOKED;
Gilles Peskine449bd832023-01-11 14:50:10 +01008091 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_NOT_TRUSTED) {
Jerry Yud9526692022-02-17 14:23:47 +08008092 alert = MBEDTLS_SSL_ALERT_MSG_UNKNOWN_CA;
Gilles Peskine449bd832023-01-11 14:50:10 +01008093 } else {
Jerry Yud9526692022-02-17 14:23:47 +08008094 alert = MBEDTLS_SSL_ALERT_MSG_CERT_UNKNOWN;
Gilles Peskine449bd832023-01-11 14:50:10 +01008095 }
8096 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8097 alert);
Jerry Yud9526692022-02-17 14:23:47 +08008098 }
8099
8100#if defined(MBEDTLS_DEBUG_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008101 if (ssl->session_negotiate->verify_result != 0) {
8102 MBEDTLS_SSL_DEBUG_MSG(3, ("! Certificate verification flags %08x",
8103 (unsigned int) ssl->session_negotiate->verify_result));
8104 } else {
8105 MBEDTLS_SSL_DEBUG_MSG(3, ("Certificate verification flags clear"));
Jerry Yud9526692022-02-17 14:23:47 +08008106 }
8107#endif /* MBEDTLS_DEBUG_C */
8108
Gilles Peskine449bd832023-01-11 14:50:10 +01008109 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08008110}
8111
8112#if !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02008113MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01008114static int ssl_remember_peer_crt_digest(mbedtls_ssl_context *ssl,
8115 unsigned char *start, size_t len)
Jerry Yud9526692022-02-17 14:23:47 +08008116{
8117 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
8118 /* Remember digest of the peer's end-CRT. */
8119 ssl->session_negotiate->peer_cert_digest =
Gilles Peskine449bd832023-01-11 14:50:10 +01008120 mbedtls_calloc(1, MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN);
8121 if (ssl->session_negotiate->peer_cert_digest == NULL) {
8122 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc(%d bytes) failed",
8123 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN));
8124 mbedtls_ssl_send_alert_message(ssl,
8125 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8126 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR);
Jerry Yud9526692022-02-17 14:23:47 +08008127
Gilles Peskine449bd832023-01-11 14:50:10 +01008128 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
Jerry Yud9526692022-02-17 14:23:47 +08008129 }
8130
Gilles Peskine449bd832023-01-11 14:50:10 +01008131 ret = mbedtls_md(mbedtls_md_info_from_type(
8132 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE),
8133 start, len,
8134 ssl->session_negotiate->peer_cert_digest);
Jerry Yud9526692022-02-17 14:23:47 +08008135
8136 ssl->session_negotiate->peer_cert_digest_type =
8137 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE;
8138 ssl->session_negotiate->peer_cert_digest_len =
8139 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN;
8140
Gilles Peskine449bd832023-01-11 14:50:10 +01008141 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08008142}
8143
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02008144MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01008145static int ssl_remember_peer_pubkey(mbedtls_ssl_context *ssl,
8146 unsigned char *start, size_t len)
Jerry Yud9526692022-02-17 14:23:47 +08008147{
8148 unsigned char *end = start + len;
8149 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
8150
8151 /* Make a copy of the peer's raw public key. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008152 mbedtls_pk_init(&ssl->handshake->peer_pubkey);
8153 ret = mbedtls_pk_parse_subpubkey(&start, end,
8154 &ssl->handshake->peer_pubkey);
8155 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08008156 /* We should have parsed the public key before. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008157 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08008158 }
8159
Gilles Peskine449bd832023-01-11 14:50:10 +01008160 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08008161}
8162#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
8163
Gilles Peskine449bd832023-01-11 14:50:10 +01008164int mbedtls_ssl_parse_certificate(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08008165{
8166 int ret = 0;
8167 int crt_expected;
Manuel Pégourié-Gonnarde1cc9262024-08-14 09:47:38 +02008168 /* Authmode: precedence order is SNI if used else configuration */
Jerry Yud9526692022-02-17 14:23:47 +08008169#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
8170 const int authmode = ssl->handshake->sni_authmode != MBEDTLS_SSL_VERIFY_UNSET
8171 ? ssl->handshake->sni_authmode
8172 : ssl->conf->authmode;
8173#else
8174 const int authmode = ssl->conf->authmode;
8175#endif
8176 void *rs_ctx = NULL;
8177 mbedtls_x509_crt *chain = NULL;
8178
Gilles Peskine449bd832023-01-11 14:50:10 +01008179 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08008180
Gilles Peskine449bd832023-01-11 14:50:10 +01008181 crt_expected = ssl_parse_certificate_coordinate(ssl, authmode);
8182 if (crt_expected == SSL_CERTIFICATE_SKIP) {
8183 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08008184 goto exit;
8185 }
8186
8187#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01008188 if (ssl->handshake->ecrs_enabled &&
8189 ssl->handshake->ecrs_state == ssl_ecrs_crt_verify) {
Jerry Yud9526692022-02-17 14:23:47 +08008190 chain = ssl->handshake->ecrs_peer_cert;
8191 ssl->handshake->ecrs_peer_cert = NULL;
8192 goto crt_verify;
8193 }
8194#endif
8195
Gilles Peskine449bd832023-01-11 14:50:10 +01008196 if ((ret = mbedtls_ssl_read_record(ssl, 1)) != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08008197 /* mbedtls_ssl_read_record may have sent an alert already. We
8198 let it decide whether to alert. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008199 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_read_record", ret);
Jerry Yud9526692022-02-17 14:23:47 +08008200 goto exit;
8201 }
8202
8203#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008204 if (ssl_srv_check_client_no_crt_notification(ssl) == 0) {
Jerry Yud9526692022-02-17 14:23:47 +08008205 ssl->session_negotiate->verify_result = MBEDTLS_X509_BADCERT_MISSING;
8206
Gilles Peskine449bd832023-01-11 14:50:10 +01008207 if (authmode != MBEDTLS_SSL_VERIFY_OPTIONAL) {
Jerry Yud9526692022-02-17 14:23:47 +08008208 ret = MBEDTLS_ERR_SSL_NO_CLIENT_CERTIFICATE;
Gilles Peskine449bd832023-01-11 14:50:10 +01008209 }
Jerry Yud9526692022-02-17 14:23:47 +08008210
8211 goto exit;
8212 }
8213#endif /* MBEDTLS_SSL_SRV_C */
8214
8215 /* Clear existing peer CRT structure in case we tried to
8216 * reuse a session but it failed, and allocate a new one. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008217 ssl_clear_peer_cert(ssl->session_negotiate);
Jerry Yud9526692022-02-17 14:23:47 +08008218
Gilles Peskine449bd832023-01-11 14:50:10 +01008219 chain = mbedtls_calloc(1, sizeof(mbedtls_x509_crt));
8220 if (chain == NULL) {
8221 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc(%" MBEDTLS_PRINTF_SIZET " bytes) failed",
8222 sizeof(mbedtls_x509_crt)));
8223 mbedtls_ssl_send_alert_message(ssl,
8224 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8225 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR);
Jerry Yud9526692022-02-17 14:23:47 +08008226
8227 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
8228 goto exit;
8229 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008230 mbedtls_x509_crt_init(chain);
Jerry Yud9526692022-02-17 14:23:47 +08008231
Gilles Peskine449bd832023-01-11 14:50:10 +01008232 ret = ssl_parse_certificate_chain(ssl, chain);
8233 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08008234 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01008235 }
Jerry Yud9526692022-02-17 14:23:47 +08008236
8237#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01008238 if (ssl->handshake->ecrs_enabled) {
Jerry Yud9526692022-02-17 14:23:47 +08008239 ssl->handshake->ecrs_state = ssl_ecrs_crt_verify;
Gilles Peskine449bd832023-01-11 14:50:10 +01008240 }
Jerry Yud9526692022-02-17 14:23:47 +08008241
8242crt_verify:
Gilles Peskine449bd832023-01-11 14:50:10 +01008243 if (ssl->handshake->ecrs_enabled) {
Jerry Yud9526692022-02-17 14:23:47 +08008244 rs_ctx = &ssl->handshake->ecrs_ctx;
Gilles Peskine449bd832023-01-11 14:50:10 +01008245 }
Jerry Yud9526692022-02-17 14:23:47 +08008246#endif
8247
Manuel Pégourié-Gonnardd37054c2024-08-16 10:01:48 +02008248 ret = ssl_verify_certificate(ssl, authmode, chain,
8249 ssl->handshake->ciphersuite_info, rs_ctx);
Gilles Peskine449bd832023-01-11 14:50:10 +01008250 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08008251 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01008252 }
Jerry Yud9526692022-02-17 14:23:47 +08008253
8254#if !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
8255 {
8256 unsigned char *crt_start, *pk_start;
8257 size_t crt_len, pk_len;
8258
8259 /* We parse the CRT chain without copying, so
8260 * these pointers point into the input buffer,
8261 * and are hence still valid after freeing the
8262 * CRT chain. */
8263
8264 crt_start = chain->raw.p;
8265 crt_len = chain->raw.len;
8266
8267 pk_start = chain->pk_raw.p;
8268 pk_len = chain->pk_raw.len;
8269
8270 /* Free the CRT structures before computing
8271 * digest and copying the peer's public key. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008272 mbedtls_x509_crt_free(chain);
8273 mbedtls_free(chain);
Jerry Yud9526692022-02-17 14:23:47 +08008274 chain = NULL;
8275
Gilles Peskine449bd832023-01-11 14:50:10 +01008276 ret = ssl_remember_peer_crt_digest(ssl, crt_start, crt_len);
8277 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08008278 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01008279 }
Jerry Yud9526692022-02-17 14:23:47 +08008280
Gilles Peskine449bd832023-01-11 14:50:10 +01008281 ret = ssl_remember_peer_pubkey(ssl, pk_start, pk_len);
8282 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08008283 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01008284 }
Jerry Yud9526692022-02-17 14:23:47 +08008285 }
8286#else /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
8287 /* Pass ownership to session structure. */
8288 ssl->session_negotiate->peer_cert = chain;
8289 chain = NULL;
8290#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
8291
Gilles Peskine449bd832023-01-11 14:50:10 +01008292 MBEDTLS_SSL_DEBUG_MSG(2, ("<= parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08008293
8294exit:
8295
Gilles Peskine449bd832023-01-11 14:50:10 +01008296 if (ret == 0) {
Jerry Yud9526692022-02-17 14:23:47 +08008297 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01008298 }
Jerry Yud9526692022-02-17 14:23:47 +08008299
8300#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01008301 if (ret == MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS) {
Jerry Yud9526692022-02-17 14:23:47 +08008302 ssl->handshake->ecrs_peer_cert = chain;
8303 chain = NULL;
8304 }
8305#endif
8306
Gilles Peskine449bd832023-01-11 14:50:10 +01008307 if (chain != NULL) {
8308 mbedtls_x509_crt_free(chain);
8309 mbedtls_free(chain);
Jerry Yud9526692022-02-17 14:23:47 +08008310 }
8311
Gilles Peskine449bd832023-01-11 14:50:10 +01008312 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08008313}
8314#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
8315
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008316static int ssl_calc_finished_tls_generic(mbedtls_ssl_context *ssl, void *ctx,
8317 unsigned char *padbuf, size_t hlen,
8318 unsigned char *buf, int from)
Jerry Yu615bd6f2022-02-17 14:25:15 +08008319{
Dave Rodgmanc37ad442023-11-03 23:36:06 +00008320 unsigned int len = 12;
Jerry Yu615bd6f2022-02-17 14:25:15 +08008321 const char *sender;
Jerry Yu615bd6f2022-02-17 14:25:15 +08008322#if defined(MBEDTLS_USE_PSA_CRYPTO)
Jerry Yu615bd6f2022-02-17 14:25:15 +08008323 psa_status_t status;
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008324 psa_hash_operation_t *hs_op = ctx;
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02008325 psa_hash_operation_t cloned_op = PSA_HASH_OPERATION_INIT;
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008326 size_t hash_size;
Jerry Yu615bd6f2022-02-17 14:25:15 +08008327#else
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01008328 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008329 mbedtls_md_context_t *hs_ctx = ctx;
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02008330 mbedtls_md_context_t cloned_ctx;
8331 mbedtls_md_init(&cloned_ctx);
Jerry Yu615bd6f2022-02-17 14:25:15 +08008332#endif
8333
8334 mbedtls_ssl_session *session = ssl->session_negotiate;
Gilles Peskine449bd832023-01-11 14:50:10 +01008335 if (!session) {
Jerry Yu615bd6f2022-02-17 14:25:15 +08008336 session = ssl->session;
Gilles Peskine449bd832023-01-11 14:50:10 +01008337 }
Jerry Yu615bd6f2022-02-17 14:25:15 +08008338
Gilles Peskine449bd832023-01-11 14:50:10 +01008339 sender = (from == MBEDTLS_SSL_IS_CLIENT)
Jerry Yu615bd6f2022-02-17 14:25:15 +08008340 ? "client finished"
8341 : "server finished";
8342
8343#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008344 MBEDTLS_SSL_DEBUG_MSG(2, ("=> calc PSA finished tls"));
Jerry Yu615bd6f2022-02-17 14:25:15 +08008345
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02008346 status = psa_hash_clone(hs_op, &cloned_op);
Gilles Peskine449bd832023-01-11 14:50:10 +01008347 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01008348 goto exit;
Jerry Yu615bd6f2022-02-17 14:25:15 +08008349 }
8350
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02008351 status = psa_hash_finish(&cloned_op, padbuf, hlen, &hash_size);
Gilles Peskine449bd832023-01-11 14:50:10 +01008352 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01008353 goto exit;
Jerry Yu615bd6f2022-02-17 14:25:15 +08008354 }
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008355 MBEDTLS_SSL_DEBUG_BUF(3, "PSA calculated padbuf", padbuf, hlen);
Jerry Yu615bd6f2022-02-17 14:25:15 +08008356#else
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008357 MBEDTLS_SSL_DEBUG_MSG(2, ("=> calc finished tls"));
Jerry Yu615bd6f2022-02-17 14:25:15 +08008358
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02008359 ret = mbedtls_md_setup(&cloned_ctx, mbedtls_md_info_from_ctx(hs_ctx), 0);
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01008360 if (ret != 0) {
8361 goto exit;
8362 }
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02008363 ret = mbedtls_md_clone(&cloned_ctx, hs_ctx);
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01008364 if (ret != 0) {
8365 goto exit;
8366 }
Jerry Yu615bd6f2022-02-17 14:25:15 +08008367
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02008368 ret = mbedtls_md_finish(&cloned_ctx, padbuf);
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008369 if (ret != 0) {
8370 goto exit;
8371 }
8372#endif /* MBEDTLS_USE_PSA_CRYPTO */
8373
8374 MBEDTLS_SSL_DEBUG_BUF(4, "finished output", padbuf, hlen);
8375
Jerry Yu615bd6f2022-02-17 14:25:15 +08008376 /*
8377 * TLSv1.2:
8378 * hash = PRF( master, finished_label,
8379 * Hash( handshake ) )[0.11]
8380 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008381 ssl->handshake->tls_prf(session->master, 48, sender,
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008382 padbuf, hlen, buf, len);
Jerry Yu615bd6f2022-02-17 14:25:15 +08008383
Gilles Peskine449bd832023-01-11 14:50:10 +01008384 MBEDTLS_SSL_DEBUG_BUF(3, "calc finished result", buf, len);
Jerry Yu615bd6f2022-02-17 14:25:15 +08008385
Paul Elliottecb95be2023-08-11 16:41:04 +01008386 mbedtls_platform_zeroize(padbuf, hlen);
Jerry Yu615bd6f2022-02-17 14:25:15 +08008387
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008388 MBEDTLS_SSL_DEBUG_MSG(2, ("<= calc finished"));
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01008389
8390exit:
8391#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02008392 psa_hash_abort(&cloned_op);
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +02008393 return mbedtls_md_error_from_psa(status);
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01008394#else
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02008395 mbedtls_md_free(&cloned_ctx);
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01008396 return ret;
8397#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu615bd6f2022-02-17 14:25:15 +08008398}
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008399
8400#if defined(MBEDTLS_MD_CAN_SHA256)
8401static int ssl_calc_finished_tls_sha256(
8402 mbedtls_ssl_context *ssl, unsigned char *buf, int from)
8403{
8404 unsigned char padbuf[32];
8405 return ssl_calc_finished_tls_generic(ssl,
8406#if defined(MBEDTLS_USE_PSA_CRYPTO)
8407 &ssl->handshake->fin_sha256_psa,
8408#else
8409 &ssl->handshake->fin_sha256,
8410#endif
8411 padbuf, sizeof(padbuf),
8412 buf, from);
8413}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01008414#endif /* MBEDTLS_MD_CAN_SHA256*/
Jerry Yu615bd6f2022-02-17 14:25:15 +08008415
Jerry Yub7ba49e2022-02-17 14:25:53 +08008416
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01008417#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +01008418static int ssl_calc_finished_tls_sha384(
Gilles Peskine449bd832023-01-11 14:50:10 +01008419 mbedtls_ssl_context *ssl, unsigned char *buf, int from)
Jerry Yub7ba49e2022-02-17 14:25:53 +08008420{
Jerry Yub7ba49e2022-02-17 14:25:53 +08008421 unsigned char padbuf[48];
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008422 return ssl_calc_finished_tls_generic(ssl,
Jerry Yub7ba49e2022-02-17 14:25:53 +08008423#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008424 &ssl->handshake->fin_sha384_psa,
Jerry Yub7ba49e2022-02-17 14:25:53 +08008425#else
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008426 &ssl->handshake->fin_sha384,
Jerry Yub7ba49e2022-02-17 14:25:53 +08008427#endif
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008428 padbuf, sizeof(padbuf),
8429 buf, from);
Jerry Yub7ba49e2022-02-17 14:25:53 +08008430}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01008431#endif /* MBEDTLS_MD_CAN_SHA384*/
Jerry Yub7ba49e2022-02-17 14:25:53 +08008432
Gilles Peskine449bd832023-01-11 14:50:10 +01008433void mbedtls_ssl_handshake_wrapup_free_hs_transform(mbedtls_ssl_context *ssl)
Jerry Yuaef00152022-02-17 14:27:31 +08008434{
Gilles Peskine449bd832023-01-11 14:50:10 +01008435 MBEDTLS_SSL_DEBUG_MSG(3, ("=> handshake wrapup: final free"));
Jerry Yuaef00152022-02-17 14:27:31 +08008436
8437 /*
8438 * Free our handshake params
8439 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008440 mbedtls_ssl_handshake_free(ssl);
8441 mbedtls_free(ssl->handshake);
Jerry Yuaef00152022-02-17 14:27:31 +08008442 ssl->handshake = NULL;
8443
8444 /*
Shaun Case8b0ecbc2021-12-20 21:14:10 -08008445 * Free the previous transform and switch in the current one
Jerry Yuaef00152022-02-17 14:27:31 +08008446 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008447 if (ssl->transform) {
8448 mbedtls_ssl_transform_free(ssl->transform);
8449 mbedtls_free(ssl->transform);
Jerry Yuaef00152022-02-17 14:27:31 +08008450 }
8451 ssl->transform = ssl->transform_negotiate;
8452 ssl->transform_negotiate = NULL;
8453
Gilles Peskine449bd832023-01-11 14:50:10 +01008454 MBEDTLS_SSL_DEBUG_MSG(3, ("<= handshake wrapup: final free"));
Jerry Yuaef00152022-02-17 14:27:31 +08008455}
8456
Gilles Peskine449bd832023-01-11 14:50:10 +01008457void mbedtls_ssl_handshake_wrapup(mbedtls_ssl_context *ssl)
Jerry Yu2a9fff52022-02-17 14:28:51 +08008458{
8459 int resume = ssl->handshake->resume;
8460
Gilles Peskine449bd832023-01-11 14:50:10 +01008461 MBEDTLS_SSL_DEBUG_MSG(3, ("=> handshake wrapup"));
Jerry Yu2a9fff52022-02-17 14:28:51 +08008462
8463#if defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01008464 if (ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS) {
Jerry Yu2a9fff52022-02-17 14:28:51 +08008465 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_DONE;
8466 ssl->renego_records_seen = 0;
8467 }
8468#endif
8469
8470 /*
8471 * Free the previous session and switch in the current one
8472 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008473 if (ssl->session) {
Jerry Yu2a9fff52022-02-17 14:28:51 +08008474#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
8475 /* RFC 7366 3.1: keep the EtM state */
8476 ssl->session_negotiate->encrypt_then_mac =
Gilles Peskine449bd832023-01-11 14:50:10 +01008477 ssl->session->encrypt_then_mac;
Jerry Yu2a9fff52022-02-17 14:28:51 +08008478#endif
8479
Gilles Peskine449bd832023-01-11 14:50:10 +01008480 mbedtls_ssl_session_free(ssl->session);
8481 mbedtls_free(ssl->session);
Jerry Yu2a9fff52022-02-17 14:28:51 +08008482 }
8483 ssl->session = ssl->session_negotiate;
8484 ssl->session_negotiate = NULL;
8485
8486 /*
8487 * Add cache entry
8488 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008489 if (ssl->conf->f_set_cache != NULL &&
Jerry Yu2a9fff52022-02-17 14:28:51 +08008490 ssl->session->id_len != 0 &&
Gilles Peskine449bd832023-01-11 14:50:10 +01008491 resume == 0) {
8492 if (ssl->conf->f_set_cache(ssl->conf->p_cache,
8493 ssl->session->id,
8494 ssl->session->id_len,
8495 ssl->session) != 0) {
8496 MBEDTLS_SSL_DEBUG_MSG(1, ("cache did not store session"));
8497 }
Jerry Yu2a9fff52022-02-17 14:28:51 +08008498 }
8499
8500#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01008501 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
8502 ssl->handshake->flight != NULL) {
Jerry Yu2a9fff52022-02-17 14:28:51 +08008503 /* Cancel handshake timer */
Gilles Peskine449bd832023-01-11 14:50:10 +01008504 mbedtls_ssl_set_timer(ssl, 0);
Jerry Yu2a9fff52022-02-17 14:28:51 +08008505
8506 /* Keep last flight around in case we need to resend it:
8507 * we need the handshake and transform structures for that */
Gilles Peskine449bd832023-01-11 14:50:10 +01008508 MBEDTLS_SSL_DEBUG_MSG(3, ("skip freeing handshake and transform"));
8509 } else
Jerry Yu2a9fff52022-02-17 14:28:51 +08008510#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01008511 mbedtls_ssl_handshake_wrapup_free_hs_transform(ssl);
Jerry Yu2a9fff52022-02-17 14:28:51 +08008512
Jerry Yu5ed73ff2022-10-27 13:08:42 +08008513 ssl->state = MBEDTLS_SSL_HANDSHAKE_OVER;
Jerry Yu2a9fff52022-02-17 14:28:51 +08008514
Gilles Peskine449bd832023-01-11 14:50:10 +01008515 MBEDTLS_SSL_DEBUG_MSG(3, ("<= handshake wrapup"));
Jerry Yu2a9fff52022-02-17 14:28:51 +08008516}
8517
Gilles Peskine449bd832023-01-11 14:50:10 +01008518int mbedtls_ssl_write_finished(mbedtls_ssl_context *ssl)
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008519{
Dave Rodgmanc37ad442023-11-03 23:36:06 +00008520 int ret;
8521 unsigned int hash_len;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008522
Gilles Peskine449bd832023-01-11 14:50:10 +01008523 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write finished"));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008524
Gilles Peskine449bd832023-01-11 14:50:10 +01008525 mbedtls_ssl_update_out_pointers(ssl, ssl->transform_negotiate);
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008526
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01008527 ret = ssl->handshake->calc_finished(ssl, ssl->out_msg + 4, ssl->conf->endpoint);
8528 if (ret != 0) {
8529 MBEDTLS_SSL_DEBUG_RET(1, "calc_finished", ret);
8530 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008531
8532 /*
8533 * RFC 5246 7.4.9 (Page 63) says 12 is the default length and ciphersuites
8534 * may define some other value. Currently (early 2016), no defined
8535 * ciphersuite does this (and this is unlikely to change as activity has
8536 * moved to TLS 1.3 now) so we can keep the hardcoded 12 here.
8537 */
8538 hash_len = 12;
8539
8540#if defined(MBEDTLS_SSL_RENEGOTIATION)
8541 ssl->verify_data_len = hash_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01008542 memcpy(ssl->own_verify_data, ssl->out_msg + 4, hash_len);
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008543#endif
8544
8545 ssl->out_msglen = 4 + hash_len;
8546 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
8547 ssl->out_msg[0] = MBEDTLS_SSL_HS_FINISHED;
8548
8549 /*
8550 * In case of session resuming, invert the client and server
8551 * ChangeCipherSpec messages order.
8552 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008553 if (ssl->handshake->resume != 0) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008554#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008555 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008556 ssl->state = MBEDTLS_SSL_HANDSHAKE_WRAPUP;
Gilles Peskine449bd832023-01-11 14:50:10 +01008557 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008558#endif
8559#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008560 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008561 ssl->state = MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC;
Gilles Peskine449bd832023-01-11 14:50:10 +01008562 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008563#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01008564 } else {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008565 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01008566 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008567
8568 /*
8569 * Switch to our negotiated transform and session parameters for outbound
8570 * data.
8571 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008572 MBEDTLS_SSL_DEBUG_MSG(3, ("switching to new transform spec for outbound data"));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008573
8574#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01008575 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008576 unsigned char i;
8577
8578 /* Remember current epoch settings for resending */
8579 ssl->handshake->alt_transform_out = ssl->transform_out;
Gilles Peskine449bd832023-01-11 14:50:10 +01008580 memcpy(ssl->handshake->alt_out_ctr, ssl->cur_out_ctr,
8581 sizeof(ssl->handshake->alt_out_ctr));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008582
8583 /* Set sequence_number to zero */
Gilles Peskine449bd832023-01-11 14:50:10 +01008584 memset(&ssl->cur_out_ctr[2], 0, sizeof(ssl->cur_out_ctr) - 2);
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008585
8586
8587 /* Increment epoch */
Gilles Peskine449bd832023-01-11 14:50:10 +01008588 for (i = 2; i > 0; i--) {
8589 if (++ssl->cur_out_ctr[i - 1] != 0) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008590 break;
Gilles Peskine449bd832023-01-11 14:50:10 +01008591 }
8592 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008593
8594 /* The loop goes to its end iff the counter is wrapping */
Gilles Peskine449bd832023-01-11 14:50:10 +01008595 if (i == 0) {
8596 MBEDTLS_SSL_DEBUG_MSG(1, ("DTLS epoch would wrap"));
8597 return MBEDTLS_ERR_SSL_COUNTER_WRAPPING;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008598 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008599 } else
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008600#endif /* MBEDTLS_SSL_PROTO_DTLS */
Gilles Peskine449bd832023-01-11 14:50:10 +01008601 memset(ssl->cur_out_ctr, 0, sizeof(ssl->cur_out_ctr));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008602
8603 ssl->transform_out = ssl->transform_negotiate;
8604 ssl->session_out = ssl->session_negotiate;
8605
8606#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01008607 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
8608 mbedtls_ssl_send_flight_completed(ssl);
8609 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008610#endif
8611
Gilles Peskine449bd832023-01-11 14:50:10 +01008612 if ((ret = mbedtls_ssl_write_handshake_msg(ssl)) != 0) {
8613 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_handshake_msg", ret);
8614 return ret;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008615 }
8616
8617#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01008618 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
8619 (ret = mbedtls_ssl_flight_transmit(ssl)) != 0) {
8620 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_flight_transmit", ret);
8621 return ret;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008622 }
8623#endif
8624
Gilles Peskine449bd832023-01-11 14:50:10 +01008625 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write finished"));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008626
Gilles Peskine449bd832023-01-11 14:50:10 +01008627 return 0;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008628}
8629
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008630#define SSL_MAX_HASH_LEN 12
8631
Gilles Peskine449bd832023-01-11 14:50:10 +01008632int mbedtls_ssl_parse_finished(mbedtls_ssl_context *ssl)
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008633{
8634 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
8635 unsigned int hash_len = 12;
8636 unsigned char buf[SSL_MAX_HASH_LEN];
8637
Gilles Peskine449bd832023-01-11 14:50:10 +01008638 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse finished"));
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008639
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01008640 ret = ssl->handshake->calc_finished(ssl, buf, ssl->conf->endpoint ^ 1);
8641 if (ret != 0) {
8642 MBEDTLS_SSL_DEBUG_RET(1, "calc_finished", ret);
8643 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008644
Gilles Peskine449bd832023-01-11 14:50:10 +01008645 if ((ret = mbedtls_ssl_read_record(ssl, 1)) != 0) {
8646 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_read_record", ret);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008647 goto exit;
8648 }
8649
Gilles Peskine449bd832023-01-11 14:50:10 +01008650 if (ssl->in_msgtype != MBEDTLS_SSL_MSG_HANDSHAKE) {
8651 MBEDTLS_SSL_DEBUG_MSG(1, ("bad finished message"));
8652 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8653 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008654 ret = MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
8655 goto exit;
8656 }
8657
Gilles Peskine449bd832023-01-11 14:50:10 +01008658 if (ssl->in_msg[0] != MBEDTLS_SSL_HS_FINISHED) {
8659 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8660 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008661 ret = MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
8662 goto exit;
8663 }
8664
Gilles Peskine449bd832023-01-11 14:50:10 +01008665 if (ssl->in_hslen != mbedtls_ssl_hs_hdr_len(ssl) + hash_len) {
8666 MBEDTLS_SSL_DEBUG_MSG(1, ("bad finished message"));
8667 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8668 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008669 ret = MBEDTLS_ERR_SSL_DECODE_ERROR;
8670 goto exit;
8671 }
8672
Gilles Peskine449bd832023-01-11 14:50:10 +01008673 if (mbedtls_ct_memcmp(ssl->in_msg + mbedtls_ssl_hs_hdr_len(ssl),
8674 buf, hash_len) != 0) {
8675 MBEDTLS_SSL_DEBUG_MSG(1, ("bad finished message"));
8676 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8677 MBEDTLS_SSL_ALERT_MSG_DECRYPT_ERROR);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008678 ret = MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
8679 goto exit;
8680 }
8681
8682#if defined(MBEDTLS_SSL_RENEGOTIATION)
8683 ssl->verify_data_len = hash_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01008684 memcpy(ssl->peer_verify_data, buf, hash_len);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008685#endif
8686
Gilles Peskine449bd832023-01-11 14:50:10 +01008687 if (ssl->handshake->resume != 0) {
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008688#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008689 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008690 ssl->state = MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC;
Gilles Peskine449bd832023-01-11 14:50:10 +01008691 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008692#endif
8693#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008694 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008695 ssl->state = MBEDTLS_SSL_HANDSHAKE_WRAPUP;
Gilles Peskine449bd832023-01-11 14:50:10 +01008696 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008697#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01008698 } else {
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008699 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01008700 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008701
8702#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01008703 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
8704 mbedtls_ssl_recv_flight_completed(ssl);
8705 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008706#endif
8707
Gilles Peskine449bd832023-01-11 14:50:10 +01008708 MBEDTLS_SSL_DEBUG_MSG(2, ("<= parse finished"));
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008709
8710exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01008711 mbedtls_platform_zeroize(buf, hash_len);
8712 return ret;
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008713}
8714
Jerry Yu392112c2022-02-17 14:34:10 +08008715#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
8716/*
8717 * Helper to get TLS 1.2 PRF from ciphersuite
8718 * (Duplicates bits of logic from ssl_set_handshake_prfs().)
8719 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008720static tls_prf_fn ssl_tls12prf_from_cs(int ciphersuite_id)
Jerry Yu392112c2022-02-17 14:34:10 +08008721{
Jerry Yu392112c2022-02-17 14:34:10 +08008722 const mbedtls_ssl_ciphersuite_t * const ciphersuite_info =
Gilles Peskine449bd832023-01-11 14:50:10 +01008723 mbedtls_ssl_ciphersuite_from_id(ciphersuite_id);
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01008724#if defined(MBEDTLS_MD_CAN_SHA384)
Gilles Peskine449bd832023-01-11 14:50:10 +01008725 if (ciphersuite_info != NULL && ciphersuite_info->mac == MBEDTLS_MD_SHA384) {
8726 return tls_prf_sha384;
8727 } else
Jerry Yu392112c2022-02-17 14:34:10 +08008728#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01008729#if defined(MBEDTLS_MD_CAN_SHA256)
Andrzej Kurek894edde2022-09-29 06:31:14 -04008730 {
Gilles Peskine449bd832023-01-11 14:50:10 +01008731 if (ciphersuite_info != NULL && ciphersuite_info->mac == MBEDTLS_MD_SHA256) {
8732 return tls_prf_sha256;
8733 }
Andrzej Kurek894edde2022-09-29 06:31:14 -04008734 }
8735#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01008736#if !defined(MBEDTLS_MD_CAN_SHA384) && \
8737 !defined(MBEDTLS_MD_CAN_SHA256)
Andrzej Kurek894edde2022-09-29 06:31:14 -04008738 (void) ciphersuite_info;
8739#endif
Andrzej Kurekeabeb302022-10-17 07:52:51 -04008740
Gilles Peskine449bd832023-01-11 14:50:10 +01008741 return NULL;
Jerry Yu392112c2022-02-17 14:34:10 +08008742}
8743#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
Jerry Yue93ffcd2022-02-17 14:37:06 +08008744
Gilles Peskine449bd832023-01-11 14:50:10 +01008745static mbedtls_tls_prf_types tls_prf_get_type(mbedtls_ssl_tls_prf_cb *tls_prf)
Jerry Yue93ffcd2022-02-17 14:37:06 +08008746{
8747 ((void) tls_prf);
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01008748#if defined(MBEDTLS_MD_CAN_SHA384)
Gilles Peskine449bd832023-01-11 14:50:10 +01008749 if (tls_prf == tls_prf_sha384) {
8750 return MBEDTLS_SSL_TLS_PRF_SHA384;
8751 } else
Jerry Yue93ffcd2022-02-17 14:37:06 +08008752#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01008753#if defined(MBEDTLS_MD_CAN_SHA256)
Gilles Peskine449bd832023-01-11 14:50:10 +01008754 if (tls_prf == tls_prf_sha256) {
8755 return MBEDTLS_SSL_TLS_PRF_SHA256;
8756 } else
Jerry Yue93ffcd2022-02-17 14:37:06 +08008757#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01008758 return MBEDTLS_SSL_TLS_PRF_NONE;
Jerry Yue93ffcd2022-02-17 14:37:06 +08008759}
8760
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008761/*
8762 * Populate a transform structure with session keys and all the other
8763 * necessary information.
8764 *
8765 * Parameters:
8766 * - [in/out]: transform: structure to populate
8767 * [in] must be just initialised with mbedtls_ssl_transform_init()
8768 * [out] fully populated, ready for use by mbedtls_ssl_{en,de}crypt_buf()
8769 * - [in] ciphersuite
8770 * - [in] master
8771 * - [in] encrypt_then_mac
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008772 * - [in] tls_prf: pointer to PRF to use for key derivation
8773 * - [in] randbytes: buffer holding ServerHello.random + ClientHello.random
Glenn Strauss07c64162022-03-14 12:34:51 -04008774 * - [in] tls_version: TLS version
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008775 * - [in] endpoint: client or server
8776 * - [in] ssl: used for:
8777 * - ssl->conf->{f,p}_export_keys
8778 * [in] optionally used for:
8779 * - MBEDTLS_DEBUG_C: ssl->conf->{f,p}_dbg
8780 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02008781MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01008782static int ssl_tls12_populate_transform(mbedtls_ssl_transform *transform,
8783 int ciphersuite,
8784 const unsigned char master[48],
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008785#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01008786 int encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008787#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01008788 ssl_tls_prf_t tls_prf,
8789 const unsigned char randbytes[64],
8790 mbedtls_ssl_protocol_version tls_version,
8791 unsigned endpoint,
8792 const mbedtls_ssl_context *ssl)
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008793{
8794 int ret = 0;
8795 unsigned char keyblk[256];
8796 unsigned char *key1;
8797 unsigned char *key2;
8798 unsigned char *mac_enc;
8799 unsigned char *mac_dec;
8800 size_t mac_key_len = 0;
8801 size_t iv_copy_len;
8802 size_t keylen;
8803 const mbedtls_ssl_ciphersuite_t *ciphersuite_info;
Neil Armstrong7fea33e2022-04-01 15:40:25 +02008804 mbedtls_ssl_mode_t ssl_mode;
Neil Armstronge4512952022-03-08 09:08:22 +01008805#if !defined(MBEDTLS_USE_PSA_CRYPTO)
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008806 const mbedtls_cipher_info_t *cipher_info;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008807 const mbedtls_md_info_t *md_info;
Neil Armstronge4512952022-03-08 09:08:22 +01008808#endif /* !MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008809
8810#if defined(MBEDTLS_USE_PSA_CRYPTO)
8811 psa_key_type_t key_type;
8812 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
8813 psa_algorithm_t alg;
Neil Armstronge4512952022-03-08 09:08:22 +01008814 psa_algorithm_t mac_alg = 0;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008815 size_t key_bits;
8816 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
8817#endif
8818
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008819 /*
8820 * Some data just needs copying into the structure
8821 */
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008822#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008823 transform->encrypt_then_mac = encrypt_then_mac;
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008824#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Glenn Strauss07c64162022-03-14 12:34:51 -04008825 transform->tls_version = tls_version;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008826
8827#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01008828 memcpy(transform->randbytes, randbytes, sizeof(transform->randbytes));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008829#endif
8830
8831#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01008832 if (tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008833 /* At the moment, we keep TLS <= 1.2 and TLS 1.3 transform
8834 * generation separate. This should never happen. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008835 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008836 }
8837#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
8838
8839 /*
8840 * Get various info structures
8841 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008842 ciphersuite_info = mbedtls_ssl_ciphersuite_from_id(ciphersuite);
8843 if (ciphersuite_info == NULL) {
8844 MBEDTLS_SSL_DEBUG_MSG(1, ("ciphersuite info for %d not found",
8845 ciphersuite));
8846 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008847 }
8848
Neil Armstrongab555e02022-04-04 11:07:59 +02008849 ssl_mode = mbedtls_ssl_get_mode_from_ciphersuite(
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008850#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01008851 encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008852#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01008853 ciphersuite_info);
Neil Armstrong7fea33e2022-04-01 15:40:25 +02008854
Gilles Peskine449bd832023-01-11 14:50:10 +01008855 if (ssl_mode == MBEDTLS_SSL_MODE_AEAD) {
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008856 transform->taglen =
8857 ciphersuite_info->flags & MBEDTLS_CIPHERSUITE_SHORT_TAG ? 8 : 16;
Gilles Peskine449bd832023-01-11 14:50:10 +01008858 }
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008859
8860#if defined(MBEDTLS_USE_PSA_CRYPTO)
Dave Rodgman2eab4622023-10-05 13:30:37 +01008861 if ((status = mbedtls_ssl_cipher_to_psa((mbedtls_cipher_type_t) ciphersuite_info->cipher,
Gilles Peskine449bd832023-01-11 14:50:10 +01008862 transform->taglen,
8863 &alg,
8864 &key_type,
8865 &key_bits)) != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008866 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01008867 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_cipher_to_psa", ret);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008868 goto end;
8869 }
8870#else
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01008871 cipher_info = mbedtls_cipher_info_from_type((mbedtls_cipher_type_t) ciphersuite_info->cipher);
Gilles Peskine449bd832023-01-11 14:50:10 +01008872 if (cipher_info == NULL) {
8873 MBEDTLS_SSL_DEBUG_MSG(1, ("cipher info for %u not found",
8874 ciphersuite_info->cipher));
8875 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008876 }
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008877#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008878
Neil Armstronge4512952022-03-08 09:08:22 +01008879#if defined(MBEDTLS_USE_PSA_CRYPTO)
Dave Rodgman2eab4622023-10-05 13:30:37 +01008880 mac_alg = mbedtls_md_psa_alg_from_type((mbedtls_md_type_t) ciphersuite_info->mac);
Gilles Peskine449bd832023-01-11 14:50:10 +01008881 if (mac_alg == 0) {
Manuel Pégourié-Gonnard2d6d9932023-03-28 11:38:08 +02008882 MBEDTLS_SSL_DEBUG_MSG(1, ("mbedtls_md_psa_alg_from_type for %u not found",
Gilles Peskine449bd832023-01-11 14:50:10 +01008883 (unsigned) ciphersuite_info->mac));
8884 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Neil Armstronge4512952022-03-08 09:08:22 +01008885 }
8886#else
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01008887 md_info = mbedtls_md_info_from_type((mbedtls_md_type_t) ciphersuite_info->mac);
Gilles Peskine449bd832023-01-11 14:50:10 +01008888 if (md_info == NULL) {
8889 MBEDTLS_SSL_DEBUG_MSG(1, ("mbedtls_md info for %u not found",
8890 (unsigned) ciphersuite_info->mac));
8891 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008892 }
Neil Armstronge4512952022-03-08 09:08:22 +01008893#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008894
8895#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
8896 /* Copy own and peer's CID if the use of the CID
8897 * extension has been negotiated. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008898 if (ssl->handshake->cid_in_use == MBEDTLS_SSL_CID_ENABLED) {
8899 MBEDTLS_SSL_DEBUG_MSG(3, ("Copy CIDs into SSL transform"));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008900
8901 transform->in_cid_len = ssl->own_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01008902 memcpy(transform->in_cid, ssl->own_cid, ssl->own_cid_len);
8903 MBEDTLS_SSL_DEBUG_BUF(3, "Incoming CID", transform->in_cid,
8904 transform->in_cid_len);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008905
8906 transform->out_cid_len = ssl->handshake->peer_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01008907 memcpy(transform->out_cid, ssl->handshake->peer_cid,
8908 ssl->handshake->peer_cid_len);
8909 MBEDTLS_SSL_DEBUG_BUF(3, "Outgoing CID", transform->out_cid,
8910 transform->out_cid_len);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008911 }
8912#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
8913
8914 /*
8915 * Compute key block using the PRF
8916 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008917 ret = tls_prf(master, 48, "key expansion", randbytes, 64, keyblk, 256);
8918 if (ret != 0) {
8919 MBEDTLS_SSL_DEBUG_RET(1, "prf", ret);
8920 return ret;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008921 }
8922
Gilles Peskine449bd832023-01-11 14:50:10 +01008923 MBEDTLS_SSL_DEBUG_MSG(3, ("ciphersuite = %s",
8924 mbedtls_ssl_get_ciphersuite_name(ciphersuite)));
8925 MBEDTLS_SSL_DEBUG_BUF(3, "master secret", master, 48);
8926 MBEDTLS_SSL_DEBUG_BUF(4, "random bytes", randbytes, 64);
8927 MBEDTLS_SSL_DEBUG_BUF(4, "key block", keyblk, 256);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008928
8929 /*
8930 * Determine the appropriate key, IV and MAC length.
8931 */
8932
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008933#if defined(MBEDTLS_USE_PSA_CRYPTO)
8934 keylen = PSA_BITS_TO_BYTES(key_bits);
8935#else
Gilles Peskine449bd832023-01-11 14:50:10 +01008936 keylen = mbedtls_cipher_info_get_key_bitlen(cipher_info) / 8;
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008937#endif
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008938
Valerio Settie5707042023-10-11 11:54:42 +02008939#if defined(MBEDTLS_SSL_HAVE_AEAD)
Gilles Peskine449bd832023-01-11 14:50:10 +01008940 if (ssl_mode == MBEDTLS_SSL_MODE_AEAD) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008941 size_t explicit_ivlen;
8942
8943 transform->maclen = 0;
8944 mac_key_len = 0;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008945
8946 /* All modes haves 96-bit IVs, but the length of the static parts vary
8947 * with mode and version:
8948 * - For GCM and CCM in TLS 1.2, there's a static IV of 4 Bytes
8949 * (to be concatenated with a dynamically chosen IV of 8 Bytes)
8950 * - For ChaChaPoly in TLS 1.2, and all modes in TLS 1.3, there's
8951 * a static IV of 12 Bytes (to be XOR'ed with the 8 Byte record
8952 * sequence number).
8953 */
8954 transform->ivlen = 12;
David Horstmann3b2276a2022-10-06 14:49:08 +01008955
8956 int is_chachapoly = 0;
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008957#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01008958 is_chachapoly = (key_type == PSA_KEY_TYPE_CHACHA20);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008959#else
Gilles Peskine449bd832023-01-11 14:50:10 +01008960 is_chachapoly = (mbedtls_cipher_info_get_mode(cipher_info)
8961 == MBEDTLS_MODE_CHACHAPOLY);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008962#endif /* MBEDTLS_USE_PSA_CRYPTO */
David Horstmann3b2276a2022-10-06 14:49:08 +01008963
Gilles Peskine449bd832023-01-11 14:50:10 +01008964 if (is_chachapoly) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008965 transform->fixed_ivlen = 12;
Gilles Peskine449bd832023-01-11 14:50:10 +01008966 } else {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008967 transform->fixed_ivlen = 4;
Gilles Peskine449bd832023-01-11 14:50:10 +01008968 }
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008969
8970 /* Minimum length of encrypted record */
8971 explicit_ivlen = transform->ivlen - transform->fixed_ivlen;
8972 transform->minlen = explicit_ivlen + transform->taglen;
Gilles Peskine449bd832023-01-11 14:50:10 +01008973 } else
Valerio Settie5707042023-10-11 11:54:42 +02008974#endif /* MBEDTLS_SSL_HAVE_AEAD */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008975#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01008976 if (ssl_mode == MBEDTLS_SSL_MODE_STREAM ||
Neil Armstrong7fea33e2022-04-01 15:40:25 +02008977 ssl_mode == MBEDTLS_SSL_MODE_CBC ||
Gilles Peskine449bd832023-01-11 14:50:10 +01008978 ssl_mode == MBEDTLS_SSL_MODE_CBC_ETM) {
Neil Armstronge4512952022-03-08 09:08:22 +01008979#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01008980 size_t block_size = PSA_BLOCK_CIPHER_BLOCK_LENGTH(key_type);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008981#else
Dave Rodgman85a88132023-06-24 11:41:50 +01008982 size_t block_size = mbedtls_cipher_info_get_block_size(cipher_info);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008983#endif /* MBEDTLS_USE_PSA_CRYPTO */
8984
8985#if defined(MBEDTLS_USE_PSA_CRYPTO)
Neil Armstronge4512952022-03-08 09:08:22 +01008986 /* Get MAC length */
8987 mac_key_len = PSA_HASH_LENGTH(mac_alg);
8988#else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008989 /* Initialize HMAC contexts */
Gilles Peskine449bd832023-01-11 14:50:10 +01008990 if ((ret = mbedtls_md_setup(&transform->md_ctx_enc, md_info, 1)) != 0 ||
8991 (ret = mbedtls_md_setup(&transform->md_ctx_dec, md_info, 1)) != 0) {
8992 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_setup", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008993 goto end;
8994 }
8995
8996 /* Get MAC length */
Gilles Peskine449bd832023-01-11 14:50:10 +01008997 mac_key_len = mbedtls_md_get_size(md_info);
Neil Armstronge4512952022-03-08 09:08:22 +01008998#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008999 transform->maclen = mac_key_len;
9000
9001 /* IV length */
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02009002#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01009003 transform->ivlen = PSA_CIPHER_IV_LENGTH(key_type, alg);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02009004#else
Dave Rodgmanbb521fd2023-06-24 11:21:25 +01009005 transform->ivlen = mbedtls_cipher_info_get_iv_size(cipher_info);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02009006#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009007
9008 /* Minimum length */
Gilles Peskine449bd832023-01-11 14:50:10 +01009009 if (ssl_mode == MBEDTLS_SSL_MODE_STREAM) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009010 transform->minlen = transform->maclen;
Gilles Peskine449bd832023-01-11 14:50:10 +01009011 } else {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009012 /*
9013 * GenericBlockCipher:
9014 * 1. if EtM is in use: one block plus MAC
9015 * otherwise: * first multiple of blocklen greater than maclen
9016 * 2. IV
9017 */
9018#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01009019 if (ssl_mode == MBEDTLS_SSL_MODE_CBC_ETM) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009020 transform->minlen = transform->maclen
Gilles Peskine449bd832023-01-11 14:50:10 +01009021 + block_size;
9022 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009023#endif
9024 {
9025 transform->minlen = transform->maclen
Gilles Peskine449bd832023-01-11 14:50:10 +01009026 + block_size
9027 - transform->maclen % block_size;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009028 }
9029
Gilles Peskine449bd832023-01-11 14:50:10 +01009030 if (tls_version == MBEDTLS_SSL_VERSION_TLS1_2) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009031 transform->minlen += transform->ivlen;
Gilles Peskine449bd832023-01-11 14:50:10 +01009032 } else {
9033 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009034 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
9035 goto end;
9036 }
9037 }
Gilles Peskine449bd832023-01-11 14:50:10 +01009038 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009039#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
9040 {
Gilles Peskine449bd832023-01-11 14:50:10 +01009041 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
9042 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009043 }
9044
Gilles Peskine449bd832023-01-11 14:50:10 +01009045 MBEDTLS_SSL_DEBUG_MSG(3, ("keylen: %u, minlen: %u, ivlen: %u, maclen: %u",
9046 (unsigned) keylen,
9047 (unsigned) transform->minlen,
9048 (unsigned) transform->ivlen,
9049 (unsigned) transform->maclen));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009050
9051 /*
9052 * Finally setup the cipher contexts, IVs and MAC secrets.
9053 */
9054#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01009055 if (endpoint == MBEDTLS_SSL_IS_CLIENT) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009056 key1 = keyblk + mac_key_len * 2;
9057 key2 = keyblk + mac_key_len * 2 + keylen;
9058
9059 mac_enc = keyblk;
9060 mac_dec = keyblk + mac_key_len;
9061
Gilles Peskine449bd832023-01-11 14:50:10 +01009062 iv_copy_len = (transform->fixed_ivlen) ?
9063 transform->fixed_ivlen : transform->ivlen;
9064 memcpy(transform->iv_enc, key2 + keylen, iv_copy_len);
9065 memcpy(transform->iv_dec, key2 + keylen + iv_copy_len,
9066 iv_copy_len);
9067 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009068#endif /* MBEDTLS_SSL_CLI_C */
9069#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01009070 if (endpoint == MBEDTLS_SSL_IS_SERVER) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009071 key1 = keyblk + mac_key_len * 2 + keylen;
9072 key2 = keyblk + mac_key_len * 2;
9073
9074 mac_enc = keyblk + mac_key_len;
9075 mac_dec = keyblk;
9076
Gilles Peskine449bd832023-01-11 14:50:10 +01009077 iv_copy_len = (transform->fixed_ivlen) ?
9078 transform->fixed_ivlen : transform->ivlen;
9079 memcpy(transform->iv_dec, key1 + keylen, iv_copy_len);
9080 memcpy(transform->iv_enc, key1 + keylen + iv_copy_len,
9081 iv_copy_len);
9082 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009083#endif /* MBEDTLS_SSL_SRV_C */
9084 {
Gilles Peskine449bd832023-01-11 14:50:10 +01009085 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009086 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
9087 goto end;
9088 }
9089
Paul Elliott4fb19552023-10-18 12:15:30 +01009090 if (ssl->f_export_keys != NULL) {
Gilles Peskine449bd832023-01-11 14:50:10 +01009091 ssl->f_export_keys(ssl->p_export_keys,
9092 MBEDTLS_SSL_KEY_EXPORT_TLS12_MASTER_SECRET,
9093 master, 48,
9094 randbytes + 32,
9095 randbytes,
9096 tls_prf_get_type(tls_prf));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009097 }
9098
9099#if defined(MBEDTLS_USE_PSA_CRYPTO)
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009100 transform->psa_alg = alg;
9101
Gilles Peskine449bd832023-01-11 14:50:10 +01009102 if (alg != MBEDTLS_SSL_NULL_CIPHER) {
9103 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_ENCRYPT);
9104 psa_set_key_algorithm(&attributes, alg);
9105 psa_set_key_type(&attributes, key_type);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009106
Gilles Peskine449bd832023-01-11 14:50:10 +01009107 if ((status = psa_import_key(&attributes,
9108 key1,
9109 PSA_BITS_TO_BYTES(key_bits),
9110 &transform->psa_key_enc)) != PSA_SUCCESS) {
9111 MBEDTLS_SSL_DEBUG_RET(3, "psa_import_key", (int) status);
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05009112 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01009113 MBEDTLS_SSL_DEBUG_RET(1, "psa_import_key", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009114 goto end;
9115 }
9116
Gilles Peskine449bd832023-01-11 14:50:10 +01009117 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_DECRYPT);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009118
Gilles Peskine449bd832023-01-11 14:50:10 +01009119 if ((status = psa_import_key(&attributes,
9120 key2,
9121 PSA_BITS_TO_BYTES(key_bits),
9122 &transform->psa_key_dec)) != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05009123 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01009124 MBEDTLS_SSL_DEBUG_RET(1, "psa_import_key", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009125 goto end;
9126 }
9127 }
9128#else
Gilles Peskine449bd832023-01-11 14:50:10 +01009129 if ((ret = mbedtls_cipher_setup(&transform->cipher_ctx_enc,
9130 cipher_info)) != 0) {
9131 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_setup", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009132 goto end;
9133 }
9134
Gilles Peskine449bd832023-01-11 14:50:10 +01009135 if ((ret = mbedtls_cipher_setup(&transform->cipher_ctx_dec,
9136 cipher_info)) != 0) {
9137 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_setup", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009138 goto end;
9139 }
9140
Gilles Peskine449bd832023-01-11 14:50:10 +01009141 if ((ret = mbedtls_cipher_setkey(&transform->cipher_ctx_enc, key1,
9142 (int) mbedtls_cipher_info_get_key_bitlen(cipher_info),
9143 MBEDTLS_ENCRYPT)) != 0) {
9144 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_setkey", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009145 goto end;
9146 }
9147
Gilles Peskine449bd832023-01-11 14:50:10 +01009148 if ((ret = mbedtls_cipher_setkey(&transform->cipher_ctx_dec, key2,
9149 (int) mbedtls_cipher_info_get_key_bitlen(cipher_info),
9150 MBEDTLS_DECRYPT)) != 0) {
9151 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_setkey", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009152 goto end;
9153 }
9154
9155#if defined(MBEDTLS_CIPHER_MODE_CBC)
Gilles Peskine449bd832023-01-11 14:50:10 +01009156 if (mbedtls_cipher_info_get_mode(cipher_info) == MBEDTLS_MODE_CBC) {
9157 if ((ret = mbedtls_cipher_set_padding_mode(&transform->cipher_ctx_enc,
9158 MBEDTLS_PADDING_NONE)) != 0) {
9159 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_set_padding_mode", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009160 goto end;
9161 }
9162
Gilles Peskine449bd832023-01-11 14:50:10 +01009163 if ((ret = mbedtls_cipher_set_padding_mode(&transform->cipher_ctx_dec,
9164 MBEDTLS_PADDING_NONE)) != 0) {
9165 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_set_padding_mode", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009166 goto end;
9167 }
9168 }
9169#endif /* MBEDTLS_CIPHER_MODE_CBC */
9170#endif /* MBEDTLS_USE_PSA_CRYPTO */
9171
Neil Armstrong29c0c042022-03-17 17:47:28 +01009172#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
9173 /* For HMAC-based ciphersuites, initialize the HMAC transforms.
9174 For AEAD-based ciphersuites, there is nothing to do here. */
Gilles Peskine449bd832023-01-11 14:50:10 +01009175 if (mac_key_len != 0) {
Neil Armstrong29c0c042022-03-17 17:47:28 +01009176#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01009177 transform->psa_mac_alg = PSA_ALG_HMAC(mac_alg);
Neil Armstrong29c0c042022-03-17 17:47:28 +01009178
Gilles Peskine449bd832023-01-11 14:50:10 +01009179 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_SIGN_MESSAGE);
9180 psa_set_key_algorithm(&attributes, PSA_ALG_HMAC(mac_alg));
9181 psa_set_key_type(&attributes, PSA_KEY_TYPE_HMAC);
Neil Armstrong29c0c042022-03-17 17:47:28 +01009182
Gilles Peskine449bd832023-01-11 14:50:10 +01009183 if ((status = psa_import_key(&attributes,
9184 mac_enc, mac_key_len,
9185 &transform->psa_mac_enc)) != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05009186 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01009187 MBEDTLS_SSL_DEBUG_RET(1, "psa_import_mac_key", ret);
Neil Armstrong29c0c042022-03-17 17:47:28 +01009188 goto end;
9189 }
9190
Gilles Peskine449bd832023-01-11 14:50:10 +01009191 if ((transform->psa_alg == MBEDTLS_SSL_NULL_CIPHER) ||
9192 ((transform->psa_alg == PSA_ALG_CBC_NO_PADDING)
Andrzej Kurek8c95ac42022-08-17 16:17:00 -04009193#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01009194 && (transform->encrypt_then_mac == MBEDTLS_SSL_ETM_DISABLED)
Andrzej Kurek8c95ac42022-08-17 16:17:00 -04009195#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01009196 )) {
Neil Armstrong29c0c042022-03-17 17:47:28 +01009197 /* mbedtls_ct_hmac() requires the key to be exportable */
Gilles Peskine449bd832023-01-11 14:50:10 +01009198 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_EXPORT |
9199 PSA_KEY_USAGE_VERIFY_HASH);
9200 } else {
9201 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_VERIFY_HASH);
9202 }
Neil Armstrong29c0c042022-03-17 17:47:28 +01009203
Gilles Peskine449bd832023-01-11 14:50:10 +01009204 if ((status = psa_import_key(&attributes,
9205 mac_dec, mac_key_len,
9206 &transform->psa_mac_dec)) != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05009207 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01009208 MBEDTLS_SSL_DEBUG_RET(1, "psa_import_mac_key", ret);
Neil Armstrong29c0c042022-03-17 17:47:28 +01009209 goto end;
9210 }
9211#else
Gilles Peskine449bd832023-01-11 14:50:10 +01009212 ret = mbedtls_md_hmac_starts(&transform->md_ctx_enc, mac_enc, mac_key_len);
9213 if (ret != 0) {
Neil Armstrong29c0c042022-03-17 17:47:28 +01009214 goto end;
Gilles Peskine449bd832023-01-11 14:50:10 +01009215 }
9216 ret = mbedtls_md_hmac_starts(&transform->md_ctx_dec, mac_dec, mac_key_len);
9217 if (ret != 0) {
Neil Armstrong29c0c042022-03-17 17:47:28 +01009218 goto end;
Gilles Peskine449bd832023-01-11 14:50:10 +01009219 }
Neil Armstrong29c0c042022-03-17 17:47:28 +01009220#endif /* MBEDTLS_USE_PSA_CRYPTO */
9221 }
9222#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
9223
9224 ((void) mac_dec);
9225 ((void) mac_enc);
9226
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009227end:
Gilles Peskine449bd832023-01-11 14:50:10 +01009228 mbedtls_platform_zeroize(keyblk, sizeof(keyblk));
9229 return ret;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009230}
9231
Valerio Settia08b1a42022-11-17 15:10:02 +01009232#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED) && \
9233 defined(MBEDTLS_USE_PSA_CRYPTO)
Valerio Setti6b3dab02022-11-17 17:14:54 +01009234int mbedtls_psa_ecjpake_read_round(
Gilles Peskine449bd832023-01-11 14:50:10 +01009235 psa_pake_operation_t *pake_ctx,
9236 const unsigned char *buf,
9237 size_t len, mbedtls_ecjpake_rounds_t round)
Valerio Settia08b1a42022-11-17 15:10:02 +01009238{
9239 psa_status_t status;
9240 size_t input_offset = 0;
Valerio Setti819de862022-11-17 18:05:19 +01009241 /*
Valerio Setti6b3dab02022-11-17 17:14:54 +01009242 * At round one repeat the KEY_SHARE, ZK_PUBLIC & ZF_PROOF twice
9243 * At round two perform a single cycle
9244 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009245 unsigned int remaining_steps = (round == MBEDTLS_ECJPAKE_ROUND_ONE) ? 2 : 1;
Valerio Settia08b1a42022-11-17 15:10:02 +01009246
Gilles Peskine449bd832023-01-11 14:50:10 +01009247 for (; remaining_steps > 0; remaining_steps--) {
9248 for (psa_pake_step_t step = PSA_PAKE_STEP_KEY_SHARE;
Valerio Settia08b1a42022-11-17 15:10:02 +01009249 step <= PSA_PAKE_STEP_ZK_PROOF;
Gilles Peskine449bd832023-01-11 14:50:10 +01009250 ++step) {
Valerio Settia08b1a42022-11-17 15:10:02 +01009251 /* Length is stored at the first byte */
9252 size_t length = buf[input_offset];
9253 input_offset += 1;
9254
Gilles Peskine449bd832023-01-11 14:50:10 +01009255 if (input_offset + length > len) {
Valerio Settia08b1a42022-11-17 15:10:02 +01009256 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
9257 }
9258
Gilles Peskine449bd832023-01-11 14:50:10 +01009259 status = psa_pake_input(pake_ctx, step,
9260 buf + input_offset, length);
9261 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05009262 return PSA_TO_MBEDTLS_ERR(status);
Valerio Settia08b1a42022-11-17 15:10:02 +01009263 }
9264
9265 input_offset += length;
9266 }
9267 }
9268
Gilles Peskine449bd832023-01-11 14:50:10 +01009269 if (input_offset != len) {
Valerio Setti61ea17d2022-11-18 12:11:00 +01009270 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Gilles Peskine449bd832023-01-11 14:50:10 +01009271 }
Valerio Setti30ebe112022-11-17 16:23:34 +01009272
Gilles Peskine449bd832023-01-11 14:50:10 +01009273 return 0;
Valerio Settia08b1a42022-11-17 15:10:02 +01009274}
9275
Valerio Setti6b3dab02022-11-17 17:14:54 +01009276int mbedtls_psa_ecjpake_write_round(
Gilles Peskine449bd832023-01-11 14:50:10 +01009277 psa_pake_operation_t *pake_ctx,
9278 unsigned char *buf,
9279 size_t len, size_t *olen,
9280 mbedtls_ecjpake_rounds_t round)
Valerio Settia08b1a42022-11-17 15:10:02 +01009281{
9282 psa_status_t status;
9283 size_t output_offset = 0;
9284 size_t output_len;
Valerio Setti819de862022-11-17 18:05:19 +01009285 /*
Valerio Setti6b3dab02022-11-17 17:14:54 +01009286 * At round one repeat the KEY_SHARE, ZK_PUBLIC & ZF_PROOF twice
9287 * At round two perform a single cycle
9288 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009289 unsigned int remaining_steps = (round == MBEDTLS_ECJPAKE_ROUND_ONE) ? 2 : 1;
Valerio Settia08b1a42022-11-17 15:10:02 +01009290
Gilles Peskine449bd832023-01-11 14:50:10 +01009291 for (; remaining_steps > 0; remaining_steps--) {
9292 for (psa_pake_step_t step = PSA_PAKE_STEP_KEY_SHARE;
9293 step <= PSA_PAKE_STEP_ZK_PROOF;
9294 ++step) {
Valerio Setti79f6b6b2022-11-21 14:17:03 +01009295 /*
Valerio Settid4a9b1a2022-11-22 11:11:10 +01009296 * For each step, prepend 1 byte with the length of the data as
9297 * given by psa_pake_output().
Valerio Setti79f6b6b2022-11-21 14:17:03 +01009298 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009299 status = psa_pake_output(pake_ctx, step,
9300 buf + output_offset + 1,
9301 len - output_offset - 1,
9302 &output_len);
9303 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05009304 return PSA_TO_MBEDTLS_ERR(status);
Valerio Settia08b1a42022-11-17 15:10:02 +01009305 }
9306
Valerio Setti99d88c12022-11-22 16:03:43 +01009307 *(buf + output_offset) = (uint8_t) output_len;
Valerio Setti79f6b6b2022-11-21 14:17:03 +01009308
9309 output_offset += output_len + 1;
Valerio Settia08b1a42022-11-17 15:10:02 +01009310 }
9311 }
9312
9313 *olen = output_offset;
9314
Gilles Peskine449bd832023-01-11 14:50:10 +01009315 return 0;
Valerio Settia08b1a42022-11-17 15:10:02 +01009316}
Valerio Settia08b1a42022-11-17 15:10:02 +01009317#endif //MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED && MBEDTLS_USE_PSA_CRYPTO
9318
Jerry Yuee40f9d2022-02-17 14:55:16 +08009319#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01009320int mbedtls_ssl_get_key_exchange_md_tls1_2(mbedtls_ssl_context *ssl,
9321 unsigned char *hash, size_t *hashlen,
9322 unsigned char *data, size_t data_len,
9323 mbedtls_md_type_t md_alg)
Jerry Yuee40f9d2022-02-17 14:55:16 +08009324{
9325 psa_status_t status;
9326 psa_hash_operation_t hash_operation = PSA_HASH_OPERATION_INIT;
Manuel Pégourié-Gonnard2d6d9932023-03-28 11:38:08 +02009327 psa_algorithm_t hash_alg = mbedtls_md_psa_alg_from_type(md_alg);
Jerry Yuee40f9d2022-02-17 14:55:16 +08009328
Gilles Peskine449bd832023-01-11 14:50:10 +01009329 MBEDTLS_SSL_DEBUG_MSG(3, ("Perform PSA-based computation of digest of ServerKeyExchange"));
Jerry Yuee40f9d2022-02-17 14:55:16 +08009330
Gilles Peskine449bd832023-01-11 14:50:10 +01009331 if ((status = psa_hash_setup(&hash_operation,
9332 hash_alg)) != PSA_SUCCESS) {
9333 MBEDTLS_SSL_DEBUG_RET(1, "psa_hash_setup", status);
Jerry Yuee40f9d2022-02-17 14:55:16 +08009334 goto exit;
9335 }
9336
Gilles Peskine449bd832023-01-11 14:50:10 +01009337 if ((status = psa_hash_update(&hash_operation, ssl->handshake->randbytes,
9338 64)) != PSA_SUCCESS) {
9339 MBEDTLS_SSL_DEBUG_RET(1, "psa_hash_update", status);
Jerry Yuee40f9d2022-02-17 14:55:16 +08009340 goto exit;
9341 }
9342
Gilles Peskine449bd832023-01-11 14:50:10 +01009343 if ((status = psa_hash_update(&hash_operation,
9344 data, data_len)) != PSA_SUCCESS) {
9345 MBEDTLS_SSL_DEBUG_RET(1, "psa_hash_update", status);
Jerry Yuee40f9d2022-02-17 14:55:16 +08009346 goto exit;
9347 }
9348
Gilles Peskine449bd832023-01-11 14:50:10 +01009349 if ((status = psa_hash_finish(&hash_operation, hash, PSA_HASH_MAX_SIZE,
9350 hashlen)) != PSA_SUCCESS) {
9351 MBEDTLS_SSL_DEBUG_RET(1, "psa_hash_finish", status);
9352 goto exit;
Jerry Yuee40f9d2022-02-17 14:55:16 +08009353 }
9354
9355exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01009356 if (status != PSA_SUCCESS) {
9357 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
9358 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR);
9359 switch (status) {
Jerry Yuee40f9d2022-02-17 14:55:16 +08009360 case PSA_ERROR_NOT_SUPPORTED:
Gilles Peskine449bd832023-01-11 14:50:10 +01009361 return MBEDTLS_ERR_MD_FEATURE_UNAVAILABLE;
Jerry Yuee40f9d2022-02-17 14:55:16 +08009362 case PSA_ERROR_BAD_STATE: /* Intentional fallthrough */
9363 case PSA_ERROR_BUFFER_TOO_SMALL:
Gilles Peskine449bd832023-01-11 14:50:10 +01009364 return MBEDTLS_ERR_MD_BAD_INPUT_DATA;
Jerry Yuee40f9d2022-02-17 14:55:16 +08009365 case PSA_ERROR_INSUFFICIENT_MEMORY:
Gilles Peskine449bd832023-01-11 14:50:10 +01009366 return MBEDTLS_ERR_MD_ALLOC_FAILED;
Jerry Yuee40f9d2022-02-17 14:55:16 +08009367 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01009368 return MBEDTLS_ERR_PLATFORM_HW_ACCEL_FAILED;
Jerry Yuee40f9d2022-02-17 14:55:16 +08009369 }
9370 }
Gilles Peskine449bd832023-01-11 14:50:10 +01009371 return 0;
Jerry Yuee40f9d2022-02-17 14:55:16 +08009372}
9373
9374#else
9375
Gilles Peskine449bd832023-01-11 14:50:10 +01009376int mbedtls_ssl_get_key_exchange_md_tls1_2(mbedtls_ssl_context *ssl,
9377 unsigned char *hash, size_t *hashlen,
9378 unsigned char *data, size_t data_len,
9379 mbedtls_md_type_t md_alg)
Jerry Yuee40f9d2022-02-17 14:55:16 +08009380{
9381 int ret = 0;
9382 mbedtls_md_context_t ctx;
Gilles Peskine449bd832023-01-11 14:50:10 +01009383 const mbedtls_md_info_t *md_info = mbedtls_md_info_from_type(md_alg);
9384 *hashlen = mbedtls_md_get_size(md_info);
Jerry Yuee40f9d2022-02-17 14:55:16 +08009385
Gilles Peskine449bd832023-01-11 14:50:10 +01009386 MBEDTLS_SSL_DEBUG_MSG(3, ("Perform mbedtls-based computation of digest of ServerKeyExchange"));
Jerry Yuee40f9d2022-02-17 14:55:16 +08009387
Gilles Peskine449bd832023-01-11 14:50:10 +01009388 mbedtls_md_init(&ctx);
Jerry Yuee40f9d2022-02-17 14:55:16 +08009389
9390 /*
9391 * digitally-signed struct {
9392 * opaque client_random[32];
9393 * opaque server_random[32];
9394 * ServerDHParams params;
9395 * };
9396 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009397 if ((ret = mbedtls_md_setup(&ctx, md_info, 0)) != 0) {
9398 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_setup", ret);
Jerry Yuee40f9d2022-02-17 14:55:16 +08009399 goto exit;
9400 }
Gilles Peskine449bd832023-01-11 14:50:10 +01009401 if ((ret = mbedtls_md_starts(&ctx)) != 0) {
9402 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_starts", ret);
Jerry Yuee40f9d2022-02-17 14:55:16 +08009403 goto exit;
9404 }
Gilles Peskine449bd832023-01-11 14:50:10 +01009405 if ((ret = mbedtls_md_update(&ctx, ssl->handshake->randbytes, 64)) != 0) {
9406 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_update", ret);
Jerry Yuee40f9d2022-02-17 14:55:16 +08009407 goto exit;
9408 }
Gilles Peskine449bd832023-01-11 14:50:10 +01009409 if ((ret = mbedtls_md_update(&ctx, data, data_len)) != 0) {
9410 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_update", ret);
Jerry Yuee40f9d2022-02-17 14:55:16 +08009411 goto exit;
9412 }
Gilles Peskine449bd832023-01-11 14:50:10 +01009413 if ((ret = mbedtls_md_finish(&ctx, hash)) != 0) {
9414 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_finish", ret);
Jerry Yuee40f9d2022-02-17 14:55:16 +08009415 goto exit;
9416 }
9417
9418exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01009419 mbedtls_md_free(&ctx);
Jerry Yuee40f9d2022-02-17 14:55:16 +08009420
Gilles Peskine449bd832023-01-11 14:50:10 +01009421 if (ret != 0) {
9422 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
9423 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR);
9424 }
Jerry Yuee40f9d2022-02-17 14:55:16 +08009425
Gilles Peskine449bd832023-01-11 14:50:10 +01009426 return ret;
Jerry Yuee40f9d2022-02-17 14:55:16 +08009427}
9428#endif /* MBEDTLS_USE_PSA_CRYPTO */
9429
Jerry Yud9d91da2022-02-17 14:57:06 +08009430#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
9431
Gabor Mezeia3d016c2022-05-10 12:44:09 +02009432/* Find the preferred hash for a given signature algorithm. */
9433unsigned int mbedtls_ssl_tls12_get_preferred_hash_for_sig_alg(
Gilles Peskine449bd832023-01-11 14:50:10 +01009434 mbedtls_ssl_context *ssl,
9435 unsigned int sig_alg)
Jerry Yud9d91da2022-02-17 14:57:06 +08009436{
Gabor Mezei078e8032022-04-27 21:17:56 +02009437 unsigned int i;
Gabor Mezeia3d016c2022-05-10 12:44:09 +02009438 uint16_t *received_sig_algs = ssl->handshake->received_sig_algs;
Gabor Mezei078e8032022-04-27 21:17:56 +02009439
Gilles Peskine449bd832023-01-11 14:50:10 +01009440 if (sig_alg == MBEDTLS_SSL_SIG_ANON) {
9441 return MBEDTLS_SSL_HASH_NONE;
9442 }
Gabor Mezei078e8032022-04-27 21:17:56 +02009443
Gilles Peskine449bd832023-01-11 14:50:10 +01009444 for (i = 0; received_sig_algs[i] != MBEDTLS_TLS_SIG_NONE; i++) {
Neil Armstrong9f1176a2022-06-24 18:19:19 +02009445 unsigned int hash_alg_received =
Gilles Peskine449bd832023-01-11 14:50:10 +01009446 MBEDTLS_SSL_TLS12_HASH_ALG_FROM_SIG_AND_HASH_ALG(
9447 received_sig_algs[i]);
Neil Armstrong9f1176a2022-06-24 18:19:19 +02009448 unsigned int sig_alg_received =
Gilles Peskine449bd832023-01-11 14:50:10 +01009449 MBEDTLS_SSL_TLS12_SIG_ALG_FROM_SIG_AND_HASH_ALG(
9450 received_sig_algs[i]);
Neil Armstrong9f1176a2022-06-24 18:19:19 +02009451
Manuel Pégourié-Gonnard47bb3802023-06-05 12:40:32 +02009452 mbedtls_md_type_t md_alg =
9453 mbedtls_ssl_md_alg_from_hash((unsigned char) hash_alg_received);
9454 if (md_alg == MBEDTLS_MD_NONE) {
9455 continue;
9456 }
9457
Gilles Peskine449bd832023-01-11 14:50:10 +01009458 if (sig_alg == sig_alg_received) {
Neil Armstrong9f1176a2022-06-24 18:19:19 +02009459#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01009460 if (ssl->handshake->key_cert && ssl->handshake->key_cert->key) {
Neil Armstrong96eceb82022-06-30 18:05:05 +02009461 psa_algorithm_t psa_hash_alg =
Manuel Pégourié-Gonnard47bb3802023-06-05 12:40:32 +02009462 mbedtls_md_psa_alg_from_type(md_alg);
Neil Armstrong9f1176a2022-06-24 18:19:19 +02009463
Gilles Peskine449bd832023-01-11 14:50:10 +01009464 if (sig_alg_received == MBEDTLS_SSL_SIG_ECDSA &&
9465 !mbedtls_pk_can_do_ext(ssl->handshake->key_cert->key,
9466 PSA_ALG_ECDSA(psa_hash_alg),
9467 PSA_KEY_USAGE_SIGN_HASH)) {
Neil Armstrong9f1176a2022-06-24 18:19:19 +02009468 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01009469 }
Neil Armstrong9f1176a2022-06-24 18:19:19 +02009470
Gilles Peskine449bd832023-01-11 14:50:10 +01009471 if (sig_alg_received == MBEDTLS_SSL_SIG_RSA &&
9472 !mbedtls_pk_can_do_ext(ssl->handshake->key_cert->key,
9473 PSA_ALG_RSA_PKCS1V15_SIGN(
9474 psa_hash_alg),
9475 PSA_KEY_USAGE_SIGN_HASH)) {
Neil Armstrong9f1176a2022-06-24 18:19:19 +02009476 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01009477 }
Neil Armstrong9f1176a2022-06-24 18:19:19 +02009478 }
Neil Armstrong9f1176a2022-06-24 18:19:19 +02009479#endif /* MBEDTLS_USE_PSA_CRYPTO */
Neil Armstrong96eceb82022-06-30 18:05:05 +02009480
Gilles Peskine449bd832023-01-11 14:50:10 +01009481 return hash_alg_received;
Neil Armstrong9f1176a2022-06-24 18:19:19 +02009482 }
Jerry Yud9d91da2022-02-17 14:57:06 +08009483 }
Jerry Yud9d91da2022-02-17 14:57:06 +08009484
Gilles Peskine449bd832023-01-11 14:50:10 +01009485 return MBEDTLS_SSL_HASH_NONE;
Jerry Yud9d91da2022-02-17 14:57:06 +08009486}
9487
9488#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
9489
Jerry Yudc7bd172022-02-17 13:44:15 +08009490#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
9491
XiaokangQian75d40ef2022-04-20 11:05:24 +00009492int mbedtls_ssl_validate_ciphersuite(
9493 const mbedtls_ssl_context *ssl,
9494 const mbedtls_ssl_ciphersuite_t *suite_info,
9495 mbedtls_ssl_protocol_version min_tls_version,
Gilles Peskine449bd832023-01-11 14:50:10 +01009496 mbedtls_ssl_protocol_version max_tls_version)
XiaokangQian75d40ef2022-04-20 11:05:24 +00009497{
9498 (void) ssl;
9499
Gilles Peskine449bd832023-01-11 14:50:10 +01009500 if (suite_info == NULL) {
9501 return -1;
9502 }
XiaokangQian75d40ef2022-04-20 11:05:24 +00009503
Gilles Peskine449bd832023-01-11 14:50:10 +01009504 if ((suite_info->min_tls_version > max_tls_version) ||
9505 (suite_info->max_tls_version < min_tls_version)) {
9506 return -1;
XiaokangQian75d40ef2022-04-20 11:05:24 +00009507 }
9508
XiaokangQian060d8672022-04-21 09:24:56 +00009509#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_CLI_C)
XiaokangQian75d40ef2022-04-20 11:05:24 +00009510#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Neil Armstrongca7d5062022-05-31 14:43:23 +02009511#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01009512 if (suite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_ECJPAKE &&
9513 ssl->handshake->psa_pake_ctx_is_ok != 1)
Neil Armstrongca7d5062022-05-31 14:43:23 +02009514#else
Gilles Peskine449bd832023-01-11 14:50:10 +01009515 if (suite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_ECJPAKE &&
9516 mbedtls_ecjpake_check(&ssl->handshake->ecjpake_ctx) != 0)
Neil Armstrongca7d5062022-05-31 14:43:23 +02009517#endif /* MBEDTLS_USE_PSA_CRYPTO */
XiaokangQian75d40ef2022-04-20 11:05:24 +00009518 {
Gilles Peskine449bd832023-01-11 14:50:10 +01009519 return -1;
XiaokangQian75d40ef2022-04-20 11:05:24 +00009520 }
9521#endif
9522
9523 /* Don't suggest PSK-based ciphersuite if no PSK is available. */
9524#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01009525 if (mbedtls_ssl_ciphersuite_uses_psk(suite_info) &&
9526 mbedtls_ssl_conf_has_static_psk(ssl->conf) == 0) {
9527 return -1;
XiaokangQian75d40ef2022-04-20 11:05:24 +00009528 }
9529#endif /* MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
9530#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
9531
Gilles Peskine449bd832023-01-11 14:50:10 +01009532 return 0;
XiaokangQian75d40ef2022-04-20 11:05:24 +00009533}
9534
Ronald Crone68ab4f2022-10-05 12:46:29 +02009535#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
XiaokangQianeaf36512022-04-24 09:07:44 +00009536/*
9537 * Function for writing a signature algorithm extension.
9538 *
9539 * The `extension_data` field of signature algorithm contains a `SignatureSchemeList`
9540 * value (TLS 1.3 RFC8446):
9541 * enum {
9542 * ....
9543 * ecdsa_secp256r1_sha256( 0x0403 ),
9544 * ecdsa_secp384r1_sha384( 0x0503 ),
9545 * ecdsa_secp521r1_sha512( 0x0603 ),
9546 * ....
9547 * } SignatureScheme;
9548 *
9549 * struct {
9550 * SignatureScheme supported_signature_algorithms<2..2^16-2>;
9551 * } SignatureSchemeList;
9552 *
9553 * The `extension_data` field of signature algorithm contains a `SignatureAndHashAlgorithm`
9554 * value (TLS 1.2 RFC5246):
9555 * enum {
9556 * none(0), md5(1), sha1(2), sha224(3), sha256(4), sha384(5),
9557 * sha512(6), (255)
9558 * } HashAlgorithm;
9559 *
9560 * enum { anonymous(0), rsa(1), dsa(2), ecdsa(3), (255) }
9561 * SignatureAlgorithm;
9562 *
9563 * struct {
9564 * HashAlgorithm hash;
9565 * SignatureAlgorithm signature;
9566 * } SignatureAndHashAlgorithm;
9567 *
9568 * SignatureAndHashAlgorithm
9569 * supported_signature_algorithms<2..2^16-2>;
9570 *
9571 * The TLS 1.3 signature algorithm extension was defined to be a compatible
9572 * generalization of the TLS 1.2 signature algorithm extension.
9573 * `SignatureAndHashAlgorithm` field of TLS 1.2 can be represented by
9574 * `SignatureScheme` field of TLS 1.3
9575 *
9576 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009577int mbedtls_ssl_write_sig_alg_ext(mbedtls_ssl_context *ssl, unsigned char *buf,
9578 const unsigned char *end, size_t *out_len)
XiaokangQianeaf36512022-04-24 09:07:44 +00009579{
9580 unsigned char *p = buf;
9581 unsigned char *supported_sig_alg; /* Start of supported_signature_algorithms */
9582 size_t supported_sig_alg_len = 0; /* Length of supported_signature_algorithms */
9583
9584 *out_len = 0;
9585
Gilles Peskine449bd832023-01-11 14:50:10 +01009586 MBEDTLS_SSL_DEBUG_MSG(3, ("adding signature_algorithms extension"));
XiaokangQianeaf36512022-04-24 09:07:44 +00009587
9588 /* Check if we have space for header and length field:
9589 * - extension_type (2 bytes)
9590 * - extension_data_length (2 bytes)
9591 * - supported_signature_algorithms_length (2 bytes)
9592 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009593 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 6);
XiaokangQianeaf36512022-04-24 09:07:44 +00009594 p += 6;
9595
9596 /*
9597 * Write supported_signature_algorithms
9598 */
9599 supported_sig_alg = p;
Gilles Peskine449bd832023-01-11 14:50:10 +01009600 const uint16_t *sig_alg = mbedtls_ssl_get_sig_algs(ssl);
9601 if (sig_alg == NULL) {
9602 return MBEDTLS_ERR_SSL_BAD_CONFIG;
9603 }
XiaokangQianeaf36512022-04-24 09:07:44 +00009604
Gilles Peskine449bd832023-01-11 14:50:10 +01009605 for (; *sig_alg != MBEDTLS_TLS1_3_SIG_NONE; sig_alg++) {
9606 MBEDTLS_SSL_DEBUG_MSG(3, ("got signature scheme [%x] %s",
9607 *sig_alg,
9608 mbedtls_ssl_sig_alg_to_str(*sig_alg)));
9609 if (!mbedtls_ssl_sig_alg_is_supported(ssl, *sig_alg)) {
XiaokangQianeaf36512022-04-24 09:07:44 +00009610 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01009611 }
9612 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 2);
9613 MBEDTLS_PUT_UINT16_BE(*sig_alg, p, 0);
XiaokangQianeaf36512022-04-24 09:07:44 +00009614 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01009615 MBEDTLS_SSL_DEBUG_MSG(3, ("sent signature scheme [%x] %s",
9616 *sig_alg,
9617 mbedtls_ssl_sig_alg_to_str(*sig_alg)));
XiaokangQianeaf36512022-04-24 09:07:44 +00009618 }
9619
9620 /* Length of supported_signature_algorithms */
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00009621 supported_sig_alg_len = (size_t) (p - supported_sig_alg);
Gilles Peskine449bd832023-01-11 14:50:10 +01009622 if (supported_sig_alg_len == 0) {
9623 MBEDTLS_SSL_DEBUG_MSG(1, ("No signature algorithms defined."));
9624 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
XiaokangQianeaf36512022-04-24 09:07:44 +00009625 }
9626
Gilles Peskine449bd832023-01-11 14:50:10 +01009627 MBEDTLS_PUT_UINT16_BE(MBEDTLS_TLS_EXT_SIG_ALG, buf, 0);
9628 MBEDTLS_PUT_UINT16_BE(supported_sig_alg_len + 2, buf, 2);
9629 MBEDTLS_PUT_UINT16_BE(supported_sig_alg_len, buf, 4);
XiaokangQianeaf36512022-04-24 09:07:44 +00009630
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00009631 *out_len = (size_t) (p - buf);
XiaokangQianeaf36512022-04-24 09:07:44 +00009632
9633#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01009634 mbedtls_ssl_tls13_set_hs_sent_ext_mask(ssl, MBEDTLS_TLS_EXT_SIG_ALG);
XiaokangQianeaf36512022-04-24 09:07:44 +00009635#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yu0c354a22022-08-29 15:25:36 +08009636
Gilles Peskine449bd832023-01-11 14:50:10 +01009637 return 0;
XiaokangQianeaf36512022-04-24 09:07:44 +00009638}
Ronald Crone68ab4f2022-10-05 12:46:29 +02009639#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
XiaokangQianeaf36512022-04-24 09:07:44 +00009640
XiaokangQian40a35232022-05-07 09:02:40 +00009641#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
XiaokangQian9b2b7712022-05-17 02:57:00 +00009642/*
9643 * mbedtls_ssl_parse_server_name_ext
9644 *
9645 * Structure of server_name extension:
9646 *
9647 * enum {
9648 * host_name(0), (255)
9649 * } NameType;
9650 * opaque HostName<1..2^16-1>;
9651 *
9652 * struct {
9653 * NameType name_type;
9654 * select (name_type) {
9655 * case host_name: HostName;
9656 * } name;
9657 * } ServerName;
9658 * struct {
9659 * ServerName server_name_list<1..2^16-1>
9660 * } ServerNameList;
9661 */
Ronald Cronce7d76e2022-07-08 18:56:49 +02009662MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01009663int mbedtls_ssl_parse_server_name_ext(mbedtls_ssl_context *ssl,
9664 const unsigned char *buf,
9665 const unsigned char *end)
XiaokangQian40a35232022-05-07 09:02:40 +00009666{
9667 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
9668 const unsigned char *p = buf;
XiaokangQian9b2b7712022-05-17 02:57:00 +00009669 size_t server_name_list_len, hostname_len;
9670 const unsigned char *server_name_list_end;
XiaokangQian40a35232022-05-07 09:02:40 +00009671
Gilles Peskine449bd832023-01-11 14:50:10 +01009672 MBEDTLS_SSL_DEBUG_MSG(3, ("parse ServerName extension"));
XiaokangQian40a35232022-05-07 09:02:40 +00009673
Gilles Peskine449bd832023-01-11 14:50:10 +01009674 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
9675 server_name_list_len = MBEDTLS_GET_UINT16_BE(p, 0);
XiaokangQian40a35232022-05-07 09:02:40 +00009676 p += 2;
9677
Gilles Peskine449bd832023-01-11 14:50:10 +01009678 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, server_name_list_len);
XiaokangQian9b2b7712022-05-17 02:57:00 +00009679 server_name_list_end = p + server_name_list_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01009680 while (p < server_name_list_end) {
9681 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, server_name_list_end, 3);
9682 hostname_len = MBEDTLS_GET_UINT16_BE(p, 1);
9683 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, server_name_list_end,
9684 hostname_len + 3);
XiaokangQian40a35232022-05-07 09:02:40 +00009685
Gilles Peskine449bd832023-01-11 14:50:10 +01009686 if (p[0] == MBEDTLS_TLS_EXT_SERVERNAME_HOSTNAME) {
XiaokangQian75fe8c72022-06-15 09:42:45 +00009687 /* sni_name is intended to be used only during the parsing of the
9688 * ClientHello message (it is reset to NULL before the end of
9689 * the message parsing). Thus it is ok to just point to the
9690 * reception buffer and not make a copy of it.
9691 */
XiaokangQianf2a94202022-05-20 06:44:24 +00009692 ssl->handshake->sni_name = p + 3;
9693 ssl->handshake->sni_name_len = hostname_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01009694 if (ssl->conf->f_sni == NULL) {
9695 return 0;
XiaokangQian40a35232022-05-07 09:02:40 +00009696 }
Gilles Peskine449bd832023-01-11 14:50:10 +01009697 ret = ssl->conf->f_sni(ssl->conf->p_sni,
9698 ssl, p + 3, hostname_len);
9699 if (ret != 0) {
9700 MBEDTLS_SSL_DEBUG_RET(1, "ssl_sni_wrapper", ret);
9701 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_UNRECOGNIZED_NAME,
9702 MBEDTLS_ERR_SSL_UNRECOGNIZED_NAME);
9703 return MBEDTLS_ERR_SSL_UNRECOGNIZED_NAME;
9704 }
9705 return 0;
XiaokangQian40a35232022-05-07 09:02:40 +00009706 }
9707
9708 p += hostname_len + 3;
9709 }
9710
Gilles Peskine449bd832023-01-11 14:50:10 +01009711 return 0;
XiaokangQian40a35232022-05-07 09:02:40 +00009712}
9713#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
9714
XiaokangQianacb39922022-06-17 10:18:48 +00009715#if defined(MBEDTLS_SSL_ALPN)
Ronald Cronce7d76e2022-07-08 18:56:49 +02009716MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01009717int mbedtls_ssl_parse_alpn_ext(mbedtls_ssl_context *ssl,
9718 const unsigned char *buf,
9719 const unsigned char *end)
XiaokangQianacb39922022-06-17 10:18:48 +00009720{
9721 const unsigned char *p = buf;
XiaokangQianc7403452022-06-23 03:24:12 +00009722 size_t protocol_name_list_len;
XiaokangQian95d5f542022-06-24 02:29:26 +00009723 const unsigned char *protocol_name_list;
9724 const unsigned char *protocol_name_list_end;
XiaokangQianc7403452022-06-23 03:24:12 +00009725 size_t protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00009726
9727 /* If ALPN not configured, just ignore the extension */
Gilles Peskine449bd832023-01-11 14:50:10 +01009728 if (ssl->conf->alpn_list == NULL) {
9729 return 0;
9730 }
XiaokangQianacb39922022-06-17 10:18:48 +00009731
9732 /*
XiaokangQianc7403452022-06-23 03:24:12 +00009733 * RFC7301, section 3.1
9734 * opaque ProtocolName<1..2^8-1>;
XiaokangQianacb39922022-06-17 10:18:48 +00009735 *
XiaokangQianc7403452022-06-23 03:24:12 +00009736 * struct {
9737 * ProtocolName protocol_name_list<2..2^16-1>
9738 * } ProtocolNameList;
XiaokangQianacb39922022-06-17 10:18:48 +00009739 */
9740
XiaokangQianc7403452022-06-23 03:24:12 +00009741 /*
XiaokangQian0b776e22022-06-24 09:04:59 +00009742 * protocol_name_list_len 2 bytes
9743 * protocol_name_len 1 bytes
9744 * protocol_name >=1 byte
XiaokangQianc7403452022-06-23 03:24:12 +00009745 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009746 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 4);
XiaokangQianacb39922022-06-17 10:18:48 +00009747
Gilles Peskine449bd832023-01-11 14:50:10 +01009748 protocol_name_list_len = MBEDTLS_GET_UINT16_BE(p, 0);
XiaokangQianacb39922022-06-17 10:18:48 +00009749 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01009750 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, protocol_name_list_len);
XiaokangQian95d5f542022-06-24 02:29:26 +00009751 protocol_name_list = p;
9752 protocol_name_list_end = p + protocol_name_list_len;
XiaokangQianacb39922022-06-17 10:18:48 +00009753
9754 /* Validate peer's list (lengths) */
Gilles Peskine449bd832023-01-11 14:50:10 +01009755 while (p < protocol_name_list_end) {
XiaokangQian95d5f542022-06-24 02:29:26 +00009756 protocol_name_len = *p++;
Gilles Peskine449bd832023-01-11 14:50:10 +01009757 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, protocol_name_list_end,
9758 protocol_name_len);
9759 if (protocol_name_len == 0) {
XiaokangQian95d5f542022-06-24 02:29:26 +00009760 MBEDTLS_SSL_PEND_FATAL_ALERT(
9761 MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
Gilles Peskine449bd832023-01-11 14:50:10 +01009762 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
9763 return MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
XiaokangQian95d5f542022-06-24 02:29:26 +00009764 }
9765
9766 p += protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00009767 }
9768
9769 /* Use our order of preference */
Gilles Peskine449bd832023-01-11 14:50:10 +01009770 for (const char **alpn = ssl->conf->alpn_list; *alpn != NULL; alpn++) {
9771 size_t const alpn_len = strlen(*alpn);
XiaokangQian95d5f542022-06-24 02:29:26 +00009772 p = protocol_name_list;
Gilles Peskine449bd832023-01-11 14:50:10 +01009773 while (p < protocol_name_list_end) {
XiaokangQian95d5f542022-06-24 02:29:26 +00009774 protocol_name_len = *p++;
Gilles Peskine449bd832023-01-11 14:50:10 +01009775 if (protocol_name_len == alpn_len &&
9776 memcmp(p, *alpn, alpn_len) == 0) {
XiaokangQianacb39922022-06-17 10:18:48 +00009777 ssl->alpn_chosen = *alpn;
Gilles Peskine449bd832023-01-11 14:50:10 +01009778 return 0;
XiaokangQianacb39922022-06-17 10:18:48 +00009779 }
XiaokangQian95d5f542022-06-24 02:29:26 +00009780
9781 p += protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00009782 }
9783 }
9784
XiaokangQian95d5f542022-06-24 02:29:26 +00009785 /* If we get here, no match was found */
XiaokangQianacb39922022-06-17 10:18:48 +00009786 MBEDTLS_SSL_PEND_FATAL_ALERT(
Gilles Peskine449bd832023-01-11 14:50:10 +01009787 MBEDTLS_SSL_ALERT_MSG_NO_APPLICATION_PROTOCOL,
9788 MBEDTLS_ERR_SSL_NO_APPLICATION_PROTOCOL);
9789 return MBEDTLS_ERR_SSL_NO_APPLICATION_PROTOCOL;
XiaokangQianacb39922022-06-17 10:18:48 +00009790}
9791
Gilles Peskine449bd832023-01-11 14:50:10 +01009792int mbedtls_ssl_write_alpn_ext(mbedtls_ssl_context *ssl,
9793 unsigned char *buf,
9794 unsigned char *end,
9795 size_t *out_len)
XiaokangQianacb39922022-06-17 10:18:48 +00009796{
9797 unsigned char *p = buf;
XiaokangQian95d5f542022-06-24 02:29:26 +00009798 size_t protocol_name_len;
XiaokangQianc7403452022-06-23 03:24:12 +00009799 *out_len = 0;
XiaokangQianacb39922022-06-17 10:18:48 +00009800
Gilles Peskine449bd832023-01-11 14:50:10 +01009801 if (ssl->alpn_chosen == NULL) {
9802 return 0;
XiaokangQianacb39922022-06-17 10:18:48 +00009803 }
9804
Gilles Peskine449bd832023-01-11 14:50:10 +01009805 protocol_name_len = strlen(ssl->alpn_chosen);
9806 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 7 + protocol_name_len);
XiaokangQianacb39922022-06-17 10:18:48 +00009807
Gilles Peskine449bd832023-01-11 14:50:10 +01009808 MBEDTLS_SSL_DEBUG_MSG(3, ("server side, adding alpn extension"));
XiaokangQianacb39922022-06-17 10:18:48 +00009809 /*
9810 * 0 . 1 ext identifier
9811 * 2 . 3 ext length
9812 * 4 . 5 protocol list length
9813 * 6 . 6 protocol name length
9814 * 7 . 7+n protocol name
9815 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009816 MBEDTLS_PUT_UINT16_BE(MBEDTLS_TLS_EXT_ALPN, p, 0);
XiaokangQianacb39922022-06-17 10:18:48 +00009817
XiaokangQian95d5f542022-06-24 02:29:26 +00009818 *out_len = 7 + protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00009819
Gilles Peskine449bd832023-01-11 14:50:10 +01009820 MBEDTLS_PUT_UINT16_BE(protocol_name_len + 3, p, 2);
9821 MBEDTLS_PUT_UINT16_BE(protocol_name_len + 1, p, 4);
XiaokangQian0b776e22022-06-24 09:04:59 +00009822 /* Note: the length of the chosen protocol has been checked to be less
9823 * than 255 bytes in `mbedtls_ssl_conf_alpn_protocols`.
9824 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009825 p[6] = MBEDTLS_BYTE_0(protocol_name_len);
XiaokangQianacb39922022-06-17 10:18:48 +00009826
Gilles Peskine449bd832023-01-11 14:50:10 +01009827 memcpy(p + 7, ssl->alpn_chosen, protocol_name_len);
Jerry Yub95dd362022-11-08 21:19:34 +08009828
9829#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01009830 mbedtls_ssl_tls13_set_hs_sent_ext_mask(ssl, MBEDTLS_TLS_EXT_ALPN);
Jerry Yub95dd362022-11-08 21:19:34 +08009831#endif
9832
Gilles Peskine449bd832023-01-11 14:50:10 +01009833 return 0;
XiaokangQianacb39922022-06-17 10:18:48 +00009834}
9835#endif /* MBEDTLS_SSL_ALPN */
9836
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009837#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && \
Xiaokang Qian03409292022-10-12 02:49:52 +00009838 defined(MBEDTLS_SSL_SESSION_TICKETS) && \
Xiaokang Qianed0620c2022-10-12 06:58:13 +00009839 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION) && \
Xiaokang Qianed3afcd2022-10-12 08:31:11 +00009840 defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01009841int mbedtls_ssl_session_set_hostname(mbedtls_ssl_session *session,
9842 const char *hostname)
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009843{
9844 /* Initialize to suppress unnecessary compiler warning */
9845 size_t hostname_len = 0;
9846
9847 /* Check if new hostname is valid before
9848 * making any change to current one */
Gilles Peskine449bd832023-01-11 14:50:10 +01009849 if (hostname != NULL) {
9850 hostname_len = strlen(hostname);
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009851
Gilles Peskine449bd832023-01-11 14:50:10 +01009852 if (hostname_len > MBEDTLS_SSL_MAX_HOST_NAME_LEN) {
9853 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9854 }
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009855 }
9856
9857 /* Now it's clear that we will overwrite the old hostname,
9858 * so we can free it safely */
Gilles Peskine449bd832023-01-11 14:50:10 +01009859 if (session->hostname != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01009860 mbedtls_zeroize_and_free(session->hostname,
Gilles Peskine449bd832023-01-11 14:50:10 +01009861 strlen(session->hostname));
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009862 }
9863
9864 /* Passing NULL as hostname shall clear the old one */
Gilles Peskine449bd832023-01-11 14:50:10 +01009865 if (hostname == NULL) {
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009866 session->hostname = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01009867 } else {
9868 session->hostname = mbedtls_calloc(1, hostname_len + 1);
9869 if (session->hostname == NULL) {
9870 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
9871 }
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009872
Gilles Peskine449bd832023-01-11 14:50:10 +01009873 memcpy(session->hostname, hostname, hostname_len);
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009874 }
9875
Gilles Peskine449bd832023-01-11 14:50:10 +01009876 return 0;
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009877}
Xiaokang Qian03409292022-10-12 02:49:52 +00009878#endif /* MBEDTLS_SSL_PROTO_TLS1_3 &&
9879 MBEDTLS_SSL_SESSION_TICKETS &&
Xiaokang Qianed0620c2022-10-12 06:58:13 +00009880 MBEDTLS_SSL_SERVER_NAME_INDICATION &&
Xiaokang Qianed3afcd2022-10-12 08:31:11 +00009881 MBEDTLS_SSL_CLI_C */
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009882
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00009883#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_EARLY_DATA) && \
9884 defined(MBEDTLS_SSL_ALPN)
Waleed Elmelegy7dfba342024-03-12 16:22:39 +00009885int mbedtls_ssl_session_set_ticket_alpn(mbedtls_ssl_session *session,
9886 const char *alpn)
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00009887{
9888 size_t alpn_len = 0;
9889
9890 if (alpn != NULL) {
9891 alpn_len = strlen(alpn);
9892
9893 if (alpn_len > MBEDTLS_SSL_MAX_ALPN_NAME_LEN) {
9894 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9895 }
9896 }
9897
9898 if (session->ticket_alpn != NULL) {
9899 mbedtls_zeroize_and_free(session->ticket_alpn,
9900 strlen(session->ticket_alpn));
Waleed Elmelegy7dfba342024-03-12 16:22:39 +00009901 session->ticket_alpn = NULL;
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00009902 }
9903
Waleed Elmelegy7dfba342024-03-12 16:22:39 +00009904 if (alpn != NULL) {
9905 session->ticket_alpn = mbedtls_calloc(alpn_len + 1, 1);
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00009906 if (session->ticket_alpn == NULL) {
9907 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
9908 }
Waleed Elmelegy7dfba342024-03-12 16:22:39 +00009909 memcpy(session->ticket_alpn, alpn, alpn_len);
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00009910 }
9911
9912 return 0;
9913}
9914#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_EARLY_DATA && MBEDTLS_SSL_ALPN */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02009915#endif /* MBEDTLS_SSL_TLS_C */