blob: 62e9c954e9717a84c59de6c3463c5fb9235ba236 [file] [log] [blame]
Paul Bakker5121ce52009-01-03 21:22:43 +00001/*
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01002 * TLS shared functions
Paul Bakker5121ce52009-01-03 21:22:43 +00003 *
Bence Szépkúti1e148272020-08-07 13:07:28 +02004 * Copyright The Mbed TLS Contributors
Dave Rodgman16799db2023-11-02 19:47:20 +00005 * SPDX-License-Identifier: Apache-2.0 OR GPL-2.0-or-later
Paul Bakker5121ce52009-01-03 21:22:43 +00006 */
7/*
Paul Bakker5121ce52009-01-03 21:22:43 +00008 * http://www.ietf.org/rfc/rfc2246.txt
9 * http://www.ietf.org/rfc/rfc4346.txt
10 */
11
Gilles Peskinedb09ef62020-06-03 01:43:33 +020012#include "common.h"
Paul Bakker5121ce52009-01-03 21:22:43 +000013
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020014#if defined(MBEDTLS_SSL_TLS_C)
Paul Bakker5121ce52009-01-03 21:22:43 +000015
SimonBd5800b72016-04-26 07:43:27 +010016#include "mbedtls/platform.h"
SimonBd5800b72016-04-26 07:43:27 +010017
Manuel Pégourié-Gonnard7f809972015-03-09 17:05:11 +000018#include "mbedtls/ssl.h"
Ronald Cron9f0fba32022-02-10 16:45:15 +010019#include "ssl_client.h"
Ronald Cron27c85e72022-03-08 11:37:55 +010020#include "ssl_debug_helpers.h"
Chris Jones84a773f2021-03-05 18:38:47 +000021#include "ssl_misc.h"
Andrzej Kurek25f27152022-08-17 16:09:31 -040022
Valerio Settib4f50762024-01-17 10:24:52 +010023#include "debug_internal.h"
Janos Follath73c616b2019-12-18 15:07:04 +000024#include "mbedtls/error.h"
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -050025#include "mbedtls/platform_util.h"
Hanno Beckera835da52019-05-16 12:39:07 +010026#include "mbedtls/version.h"
Gabor Mezei765862c2021-10-19 12:22:25 +020027#include "mbedtls/constant_time.h"
Paul Bakker0be444a2013-08-27 21:55:01 +020028
Rich Evans00ab4702015-02-06 13:43:58 +000029#include <string.h>
30
Andrzej Kurekd6db9be2019-01-10 05:27:10 -050031#if defined(MBEDTLS_USE_PSA_CRYPTO)
Valerio Setti384fbde2024-01-02 13:26:40 +010032#include "mbedtls/psa_util.h"
Manuel Pégourié-Gonnard02b10d82023-03-28 12:33:20 +020033#include "md_psa.h"
Manuel Pégourié-Gonnard2be8c632023-06-07 13:07:21 +020034#include "psa_util_internal.h"
Andrzej Kurekd6db9be2019-01-10 05:27:10 -050035#include "psa/crypto.h"
36#endif
37
Janos Follath23bdca02016-10-07 14:47:14 +010038#if defined(MBEDTLS_X509_CRT_PARSE_C)
Manuel Pégourié-Gonnard7f809972015-03-09 17:05:11 +000039#include "mbedtls/oid.h"
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +020040#endif
41
Andrzej Kurek8a045ce2022-12-23 11:00:06 -050042#if defined(MBEDTLS_USE_PSA_CRYPTO)
Andrzej Kurek00644842023-05-30 05:45:00 -040043/* Define local translating functions to save code size by not using too many
44 * arguments in each translating place. */
45static int local_err_translation(psa_status_t status)
46{
47 return psa_status_to_mbedtls(status, psa_to_ssl_errors,
Andrzej Kurek1e4a0302023-05-30 09:45:17 -040048 ARRAY_LENGTH(psa_to_ssl_errors),
Andrzej Kurek00644842023-05-30 05:45:00 -040049 psa_generic_status_to_mbedtls);
50}
51#define PSA_TO_MBEDTLS_ERR(status) local_err_translation(status)
Andrzej Kurek8a045ce2022-12-23 11:00:06 -050052#endif
53
Ronald Cronad8c17b2022-06-10 17:18:09 +020054#if defined(MBEDTLS_TEST_HOOKS)
55static mbedtls_ssl_chk_buf_ptr_args chk_buf_ptr_fail_args;
56
57void mbedtls_ssl_set_chk_buf_ptr_fail_args(
Gilles Peskine449bd832023-01-11 14:50:10 +010058 const uint8_t *cur, const uint8_t *end, size_t need)
Ronald Cronad8c17b2022-06-10 17:18:09 +020059{
60 chk_buf_ptr_fail_args.cur = cur;
61 chk_buf_ptr_fail_args.end = end;
62 chk_buf_ptr_fail_args.need = need;
63}
64
Gilles Peskine449bd832023-01-11 14:50:10 +010065void mbedtls_ssl_reset_chk_buf_ptr_fail_args(void)
Ronald Cronad8c17b2022-06-10 17:18:09 +020066{
Gilles Peskine449bd832023-01-11 14:50:10 +010067 memset(&chk_buf_ptr_fail_args, 0, sizeof(chk_buf_ptr_fail_args));
Ronald Cronad8c17b2022-06-10 17:18:09 +020068}
69
Gilles Peskine449bd832023-01-11 14:50:10 +010070int mbedtls_ssl_cmp_chk_buf_ptr_fail_args(mbedtls_ssl_chk_buf_ptr_args *args)
Ronald Cronad8c17b2022-06-10 17:18:09 +020071{
Gilles Peskine449bd832023-01-11 14:50:10 +010072 return (chk_buf_ptr_fail_args.cur != args->cur) ||
73 (chk_buf_ptr_fail_args.end != args->end) ||
74 (chk_buf_ptr_fail_args.need != args->need);
Ronald Cronad8c17b2022-06-10 17:18:09 +020075}
76#endif /* MBEDTLS_TEST_HOOKS */
77
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +020078#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker2b1e3542018-08-06 11:19:13 +010079
Hanno Beckera0e20d02019-05-15 14:03:01 +010080#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckerf8542cf2019-04-09 15:22:03 +010081/* Top-level Connection ID API */
82
Gilles Peskine449bd832023-01-11 14:50:10 +010083int mbedtls_ssl_conf_cid(mbedtls_ssl_config *conf,
84 size_t len,
85 int ignore_other_cid)
Hanno Beckerad4a1372019-05-03 13:06:44 +010086{
Gilles Peskine449bd832023-01-11 14:50:10 +010087 if (len > MBEDTLS_SSL_CID_IN_LEN_MAX) {
88 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
89 }
Hanno Beckerad4a1372019-05-03 13:06:44 +010090
Gilles Peskine449bd832023-01-11 14:50:10 +010091 if (ignore_other_cid != MBEDTLS_SSL_UNEXPECTED_CID_FAIL &&
92 ignore_other_cid != MBEDTLS_SSL_UNEXPECTED_CID_IGNORE) {
93 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Becker611ac772019-05-14 11:45:26 +010094 }
95
96 conf->ignore_unexpected_cid = ignore_other_cid;
Hanno Beckerad4a1372019-05-03 13:06:44 +010097 conf->cid_len = len;
Gilles Peskine449bd832023-01-11 14:50:10 +010098 return 0;
Hanno Beckerad4a1372019-05-03 13:06:44 +010099}
100
Gilles Peskine449bd832023-01-11 14:50:10 +0100101int mbedtls_ssl_set_cid(mbedtls_ssl_context *ssl,
102 int enable,
103 unsigned char const *own_cid,
104 size_t own_cid_len)
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100105{
Gilles Peskine449bd832023-01-11 14:50:10 +0100106 if (ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
107 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
108 }
Hanno Becker76a79ab2019-05-03 14:38:32 +0100109
Hanno Beckerca092242019-04-25 16:01:49 +0100110 ssl->negotiate_cid = enable;
Gilles Peskine449bd832023-01-11 14:50:10 +0100111 if (enable == MBEDTLS_SSL_CID_DISABLED) {
112 MBEDTLS_SSL_DEBUG_MSG(3, ("Disable use of CID extension."));
113 return 0;
Hanno Beckerca092242019-04-25 16:01:49 +0100114 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100115 MBEDTLS_SSL_DEBUG_MSG(3, ("Enable use of CID extension."));
116 MBEDTLS_SSL_DEBUG_BUF(3, "Own CID", own_cid, own_cid_len);
Hanno Beckerca092242019-04-25 16:01:49 +0100117
Gilles Peskine449bd832023-01-11 14:50:10 +0100118 if (own_cid_len != ssl->conf->cid_len) {
119 MBEDTLS_SSL_DEBUG_MSG(3, ("CID length %u does not match CID length %u in config",
120 (unsigned) own_cid_len,
121 (unsigned) ssl->conf->cid_len));
122 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Beckerca092242019-04-25 16:01:49 +0100123 }
124
Gilles Peskine449bd832023-01-11 14:50:10 +0100125 memcpy(ssl->own_cid, own_cid, own_cid_len);
Hanno Beckerb7ee0cf2019-04-30 14:07:31 +0100126 /* Truncation is not an issue here because
127 * MBEDTLS_SSL_CID_IN_LEN_MAX at most 255. */
128 ssl->own_cid_len = (uint8_t) own_cid_len;
Hanno Beckerca092242019-04-25 16:01:49 +0100129
Gilles Peskine449bd832023-01-11 14:50:10 +0100130 return 0;
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100131}
132
Gilles Peskine449bd832023-01-11 14:50:10 +0100133int mbedtls_ssl_get_own_cid(mbedtls_ssl_context *ssl,
134 int *enabled,
Sam Berry9722fd12024-06-11 14:34:17 +0100135 unsigned char own_cid[MBEDTLS_SSL_CID_IN_LEN_MAX],
Gilles Peskine449bd832023-01-11 14:50:10 +0100136 size_t *own_cid_len)
Paul Elliott0113cf12022-03-11 20:26:47 +0000137{
138 *enabled = MBEDTLS_SSL_CID_DISABLED;
139
Gilles Peskine449bd832023-01-11 14:50:10 +0100140 if (ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
141 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
142 }
Paul Elliott0113cf12022-03-11 20:26:47 +0000143
144 /* We report MBEDTLS_SSL_CID_DISABLED in case the CID length is
145 * zero as this is indistinguishable from not requesting to use
146 * the CID extension. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100147 if (ssl->own_cid_len == 0 || ssl->negotiate_cid == MBEDTLS_SSL_CID_DISABLED) {
148 return 0;
149 }
Paul Elliott0113cf12022-03-11 20:26:47 +0000150
Gilles Peskine449bd832023-01-11 14:50:10 +0100151 if (own_cid_len != NULL) {
Paul Elliott0113cf12022-03-11 20:26:47 +0000152 *own_cid_len = ssl->own_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +0100153 if (own_cid != NULL) {
154 memcpy(own_cid, ssl->own_cid, ssl->own_cid_len);
155 }
Paul Elliott0113cf12022-03-11 20:26:47 +0000156 }
157
158 *enabled = MBEDTLS_SSL_CID_ENABLED;
159
Gilles Peskine449bd832023-01-11 14:50:10 +0100160 return 0;
Paul Elliott0113cf12022-03-11 20:26:47 +0000161}
162
Gilles Peskine449bd832023-01-11 14:50:10 +0100163int mbedtls_ssl_get_peer_cid(mbedtls_ssl_context *ssl,
164 int *enabled,
165 unsigned char peer_cid[MBEDTLS_SSL_CID_OUT_LEN_MAX],
166 size_t *peer_cid_len)
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100167{
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100168 *enabled = MBEDTLS_SSL_CID_DISABLED;
Hanno Beckerb1f89cd2019-04-26 17:08:02 +0100169
Gilles Peskine449bd832023-01-11 14:50:10 +0100170 if (ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM ||
171 mbedtls_ssl_is_handshake_over(ssl) == 0) {
172 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Becker76a79ab2019-05-03 14:38:32 +0100173 }
Hanno Beckerb1f89cd2019-04-26 17:08:02 +0100174
Hanno Beckerc5f24222019-05-03 12:54:52 +0100175 /* We report MBEDTLS_SSL_CID_DISABLED in case the CID extensions
176 * were used, but client and server requested the empty CID.
177 * This is indistinguishable from not using the CID extension
178 * in the first place. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100179 if (ssl->transform_in->in_cid_len == 0 &&
180 ssl->transform_in->out_cid_len == 0) {
181 return 0;
Hanno Beckerb1f89cd2019-04-26 17:08:02 +0100182 }
183
Gilles Peskine449bd832023-01-11 14:50:10 +0100184 if (peer_cid_len != NULL) {
Hanno Becker615ef172019-05-22 16:50:35 +0100185 *peer_cid_len = ssl->transform_in->out_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +0100186 if (peer_cid != NULL) {
187 memcpy(peer_cid, ssl->transform_in->out_cid,
188 ssl->transform_in->out_cid_len);
Hanno Becker615ef172019-05-22 16:50:35 +0100189 }
190 }
Hanno Beckerb1f89cd2019-04-26 17:08:02 +0100191
192 *enabled = MBEDTLS_SSL_CID_ENABLED;
193
Gilles Peskine449bd832023-01-11 14:50:10 +0100194 return 0;
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100195}
Hanno Beckera0e20d02019-05-15 14:03:01 +0100196#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100197
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200198#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200199
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200200#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Manuel Pégourié-Gonnard581e6b62013-07-18 12:32:27 +0200201/*
202 * Convert max_fragment_length codes to length.
203 * RFC 6066 says:
204 * enum{
205 * 2^9(1), 2^10(2), 2^11(3), 2^12(4), (255)
206 * } MaxFragmentLength;
207 * and we add 0 -> extension unused
208 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100209static unsigned int ssl_mfl_code_to_length(int mfl)
Manuel Pégourié-Gonnard581e6b62013-07-18 12:32:27 +0200210{
Gilles Peskine449bd832023-01-11 14:50:10 +0100211 switch (mfl) {
212 case MBEDTLS_SSL_MAX_FRAG_LEN_NONE:
213 return MBEDTLS_TLS_EXT_ADV_CONTENT_LEN;
214 case MBEDTLS_SSL_MAX_FRAG_LEN_512:
215 return 512;
216 case MBEDTLS_SSL_MAX_FRAG_LEN_1024:
217 return 1024;
218 case MBEDTLS_SSL_MAX_FRAG_LEN_2048:
219 return 2048;
220 case MBEDTLS_SSL_MAX_FRAG_LEN_4096:
221 return 4096;
222 default:
223 return MBEDTLS_TLS_EXT_ADV_CONTENT_LEN;
Angus Grattond8213d02016-05-25 20:56:48 +1000224 }
225}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200226#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
Manuel Pégourié-Gonnard581e6b62013-07-18 12:32:27 +0200227
Gilles Peskine449bd832023-01-11 14:50:10 +0100228int mbedtls_ssl_session_copy(mbedtls_ssl_session *dst,
229 const mbedtls_ssl_session *src)
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200230{
Gilles Peskine449bd832023-01-11 14:50:10 +0100231 mbedtls_ssl_session_free(dst);
232 memcpy(dst, src, sizeof(mbedtls_ssl_session));
吴敬辉0b716112021-11-29 10:46:35 +0800233#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
234 dst->ticket = NULL;
Xiaokang Qian87306442022-10-12 09:47:38 +0000235#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && \
236 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Xiaokang Qian126bf8e2022-10-13 02:22:40 +0000237 dst->hostname = NULL;
吴敬辉0b716112021-11-29 10:46:35 +0800238#endif
Xiaokang Qian87306442022-10-12 09:47:38 +0000239#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
吴敬辉0b716112021-11-29 10:46:35 +0800240
Waleed Elmelegy4dfb0e72024-03-14 01:48:40 +0000241#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_ALPN) && \
242 defined(MBEDTLS_SSL_EARLY_DATA)
243 dst->ticket_alpn = NULL;
244#endif
245
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200246#if defined(MBEDTLS_X509_CRT_PARSE_C)
Hanno Becker6d1986e2019-02-07 12:27:42 +0000247
248#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +0100249 if (src->peer_cert != NULL) {
Janos Follath865b3eb2019-12-16 11:46:15 +0000250 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker2292d1f2013-09-15 17:06:49 +0200251
Gilles Peskine449bd832023-01-11 14:50:10 +0100252 dst->peer_cert = mbedtls_calloc(1, sizeof(mbedtls_x509_crt));
253 if (dst->peer_cert == NULL) {
254 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
255 }
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200256
Gilles Peskine449bd832023-01-11 14:50:10 +0100257 mbedtls_x509_crt_init(dst->peer_cert);
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200258
Gilles Peskine449bd832023-01-11 14:50:10 +0100259 if ((ret = mbedtls_x509_crt_parse_der(dst->peer_cert, src->peer_cert->raw.p,
260 src->peer_cert->raw.len)) != 0) {
261 mbedtls_free(dst->peer_cert);
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200262 dst->peer_cert = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +0100263 return ret;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200264 }
265 }
Hanno Becker6d1986e2019-02-07 12:27:42 +0000266#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Gilles Peskine449bd832023-01-11 14:50:10 +0100267 if (src->peer_cert_digest != NULL) {
Hanno Becker9198ad12019-02-05 17:00:50 +0000268 dst->peer_cert_digest =
Gilles Peskine449bd832023-01-11 14:50:10 +0100269 mbedtls_calloc(1, src->peer_cert_digest_len);
270 if (dst->peer_cert_digest == NULL) {
271 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
272 }
Hanno Becker9198ad12019-02-05 17:00:50 +0000273
Gilles Peskine449bd832023-01-11 14:50:10 +0100274 memcpy(dst->peer_cert_digest, src->peer_cert_digest,
275 src->peer_cert_digest_len);
Hanno Becker9198ad12019-02-05 17:00:50 +0000276 dst->peer_cert_digest_type = src->peer_cert_digest_type;
Hanno Beckeraccc5992019-02-25 10:06:59 +0000277 dst->peer_cert_digest_len = src->peer_cert_digest_len;
Hanno Becker9198ad12019-02-05 17:00:50 +0000278 }
279#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
280
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200281#endif /* MBEDTLS_X509_CRT_PARSE_C */
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200282
Waleed Elmelegy4dfb0e72024-03-14 01:48:40 +0000283#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_ALPN) && \
284 defined(MBEDTLS_SSL_EARLY_DATA)
285 {
286 int ret = mbedtls_ssl_session_set_ticket_alpn(dst, src->ticket_alpn);
287 if (ret != 0) {
288 return ret;
289 }
290 }
291#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_ALPN && MBEDTLS_SSL_EARLY_DATA */
292
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +0200293#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +0100294 if (src->ticket != NULL) {
295 dst->ticket = mbedtls_calloc(1, src->ticket_len);
296 if (dst->ticket == NULL) {
297 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
298 }
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200299
Gilles Peskine449bd832023-01-11 14:50:10 +0100300 memcpy(dst->ticket, src->ticket, src->ticket_len);
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200301 }
Xiaokang Qian126bf8e2022-10-13 02:22:40 +0000302
303#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && \
304 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +0100305 if (src->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Xiaokang Qian126bf8e2022-10-13 02:22:40 +0000306 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine449bd832023-01-11 14:50:10 +0100307 ret = mbedtls_ssl_session_set_hostname(dst, src->hostname);
308 if (ret != 0) {
309 return ret;
310 }
Xiaokang Qian126bf8e2022-10-13 02:22:40 +0000311 }
312#endif /* MBEDTLS_SSL_PROTO_TLS1_3 &&
313 MBEDTLS_SSL_SERVER_NAME_INDICATION */
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +0200314#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200315
Gilles Peskine449bd832023-01-11 14:50:10 +0100316 return 0;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200317}
318
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500319#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200320MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100321static int resize_buffer(unsigned char **buffer, size_t len_new, size_t *len_old)
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500322{
Gilles Peskine449bd832023-01-11 14:50:10 +0100323 unsigned char *resized_buffer = mbedtls_calloc(1, len_new);
324 if (resized_buffer == NULL) {
Yanray Wang365ee3e2023-11-22 10:28:28 +0800325 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
Gilles Peskine449bd832023-01-11 14:50:10 +0100326 }
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500327
328 /* We want to copy len_new bytes when downsizing the buffer, and
329 * len_old bytes when upsizing, so we choose the smaller of two sizes,
330 * to fit one buffer into another. Size checks, ensuring that no data is
331 * lost, are done outside of this function. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100332 memcpy(resized_buffer, *buffer,
333 (len_new < *len_old) ? len_new : *len_old);
Tom Cosgroveca8c61b2023-07-17 15:17:40 +0100334 mbedtls_zeroize_and_free(*buffer, *len_old);
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500335
336 *buffer = resized_buffer;
337 *len_old = len_new;
338
339 return 0;
340}
Andrzej Kurek4a063792020-10-21 15:08:44 +0200341
Gilles Peskine449bd832023-01-11 14:50:10 +0100342static void handle_buffer_resizing(mbedtls_ssl_context *ssl, int downsizing,
343 size_t in_buf_new_len,
344 size_t out_buf_new_len)
Andrzej Kurek4a063792020-10-21 15:08:44 +0200345{
346 int modified = 0;
347 size_t written_in = 0, iv_offset_in = 0, len_offset_in = 0;
348 size_t written_out = 0, iv_offset_out = 0, len_offset_out = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +0100349 if (ssl->in_buf != NULL) {
Andrzej Kurek4a063792020-10-21 15:08:44 +0200350 written_in = ssl->in_msg - ssl->in_buf;
351 iv_offset_in = ssl->in_iv - ssl->in_buf;
352 len_offset_in = ssl->in_len - ssl->in_buf;
Gilles Peskine449bd832023-01-11 14:50:10 +0100353 if (downsizing ?
Andrzej Kurek4a063792020-10-21 15:08:44 +0200354 ssl->in_buf_len > in_buf_new_len && ssl->in_left < in_buf_new_len :
Gilles Peskine449bd832023-01-11 14:50:10 +0100355 ssl->in_buf_len < in_buf_new_len) {
356 if (resize_buffer(&ssl->in_buf, in_buf_new_len, &ssl->in_buf_len) != 0) {
357 MBEDTLS_SSL_DEBUG_MSG(1, ("input buffer resizing failed - out of memory"));
358 } else {
359 MBEDTLS_SSL_DEBUG_MSG(2, ("Reallocating in_buf to %" MBEDTLS_PRINTF_SIZET,
360 in_buf_new_len));
Andrzej Kurek4a063792020-10-21 15:08:44 +0200361 modified = 1;
362 }
363 }
364 }
365
Gilles Peskine449bd832023-01-11 14:50:10 +0100366 if (ssl->out_buf != NULL) {
Andrzej Kurek4a063792020-10-21 15:08:44 +0200367 written_out = ssl->out_msg - ssl->out_buf;
368 iv_offset_out = ssl->out_iv - ssl->out_buf;
369 len_offset_out = ssl->out_len - ssl->out_buf;
Gilles Peskine449bd832023-01-11 14:50:10 +0100370 if (downsizing ?
Andrzej Kurek4a063792020-10-21 15:08:44 +0200371 ssl->out_buf_len > out_buf_new_len && ssl->out_left < out_buf_new_len :
Gilles Peskine449bd832023-01-11 14:50:10 +0100372 ssl->out_buf_len < out_buf_new_len) {
373 if (resize_buffer(&ssl->out_buf, out_buf_new_len, &ssl->out_buf_len) != 0) {
374 MBEDTLS_SSL_DEBUG_MSG(1, ("output buffer resizing failed - out of memory"));
375 } else {
376 MBEDTLS_SSL_DEBUG_MSG(2, ("Reallocating out_buf to %" MBEDTLS_PRINTF_SIZET,
377 out_buf_new_len));
Andrzej Kurek4a063792020-10-21 15:08:44 +0200378 modified = 1;
379 }
380 }
381 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100382 if (modified) {
Andrzej Kurek4a063792020-10-21 15:08:44 +0200383 /* Update pointers here to avoid doing it twice. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100384 mbedtls_ssl_reset_in_out_pointers(ssl);
Andrzej Kurek4a063792020-10-21 15:08:44 +0200385 /* Fields below might not be properly updated with record
386 * splitting or with CID, so they are manually updated here. */
387 ssl->out_msg = ssl->out_buf + written_out;
388 ssl->out_len = ssl->out_buf + len_offset_out;
389 ssl->out_iv = ssl->out_buf + iv_offset_out;
390
391 ssl->in_msg = ssl->in_buf + written_in;
392 ssl->in_len = ssl->in_buf + len_offset_in;
393 ssl->in_iv = ssl->in_buf + iv_offset_in;
394 }
395}
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500396#endif /* MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH */
397
Jerry Yudb8c48a2022-01-27 14:54:54 +0800398#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Jerry Yued14c932022-02-17 13:40:45 +0800399
400#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
Gilles Peskine449bd832023-01-11 14:50:10 +0100401typedef int (*tls_prf_fn)(const unsigned char *secret, size_t slen,
402 const char *label,
403 const unsigned char *random, size_t rlen,
404 unsigned char *dstbuf, size_t dlen);
Jerry Yued14c932022-02-17 13:40:45 +0800405
Gilles Peskine449bd832023-01-11 14:50:10 +0100406static tls_prf_fn ssl_tls12prf_from_cs(int ciphersuite_id);
Jerry Yued14c932022-02-17 13:40:45 +0800407
408#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
409
410/* Type for the TLS PRF */
411typedef int ssl_tls_prf_t(const unsigned char *, size_t, const char *,
412 const unsigned char *, size_t,
413 unsigned char *, size_t);
414
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200415MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100416static int ssl_tls12_populate_transform(mbedtls_ssl_transform *transform,
417 int ciphersuite,
418 const unsigned char master[48],
Neil Armstrongf2c82f02022-04-05 11:16:53 +0200419#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +0100420 int encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +0200421#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +0100422 ssl_tls_prf_t tls_prf,
423 const unsigned char randbytes[64],
424 mbedtls_ssl_protocol_version tls_version,
425 unsigned endpoint,
426 const mbedtls_ssl_context *ssl);
Jerry Yued14c932022-02-17 13:40:45 +0800427
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100428#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200429MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100430static int tls_prf_sha256(const unsigned char *secret, size_t slen,
Ron Eldor51d3ab52019-05-12 14:54:30 +0300431 const char *label,
432 const unsigned char *random, size_t rlen,
Gilles Peskine449bd832023-01-11 14:50:10 +0100433 unsigned char *dstbuf, size_t dlen);
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100434static int ssl_calc_verify_tls_sha256(const mbedtls_ssl_context *, unsigned char *, size_t *);
435static int ssl_calc_finished_tls_sha256(mbedtls_ssl_context *, unsigned char *, int);
Gilles Peskine449bd832023-01-11 14:50:10 +0100436
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100437#endif /* MBEDTLS_MD_CAN_SHA256*/
Gilles Peskine449bd832023-01-11 14:50:10 +0100438
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100439#if defined(MBEDTLS_MD_CAN_SHA384)
Gilles Peskine449bd832023-01-11 14:50:10 +0100440MBEDTLS_CHECK_RETURN_CRITICAL
441static int tls_prf_sha384(const unsigned char *secret, size_t slen,
442 const char *label,
443 const unsigned char *random, size_t rlen,
444 unsigned char *dstbuf, size_t dlen);
445
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100446static int ssl_calc_verify_tls_sha384(const mbedtls_ssl_context *, unsigned char *, size_t *);
447static int ssl_calc_finished_tls_sha384(mbedtls_ssl_context *, unsigned char *, int);
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100448#endif /* MBEDTLS_MD_CAN_SHA384*/
Gilles Peskine449bd832023-01-11 14:50:10 +0100449
Gilles Peskine449bd832023-01-11 14:50:10 +0100450MBEDTLS_CHECK_RETURN_CRITICAL
451static int ssl_tls12_session_load(mbedtls_ssl_session *session,
452 const unsigned char *buf,
453 size_t len);
454#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
455
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100456static int ssl_update_checksum_start(mbedtls_ssl_context *, const unsigned char *, size_t);
Gilles Peskine449bd832023-01-11 14:50:10 +0100457
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100458#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100459static int ssl_update_checksum_sha256(mbedtls_ssl_context *, const unsigned char *, size_t);
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100460#endif /* MBEDTLS_MD_CAN_SHA256*/
Gilles Peskine449bd832023-01-11 14:50:10 +0100461
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100462#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100463static int ssl_update_checksum_sha384(mbedtls_ssl_context *, const unsigned char *, size_t);
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100464#endif /* MBEDTLS_MD_CAN_SHA384*/
Gilles Peskine449bd832023-01-11 14:50:10 +0100465
466int mbedtls_ssl_tls_prf(const mbedtls_tls_prf_types prf,
467 const unsigned char *secret, size_t slen,
468 const char *label,
469 const unsigned char *random, size_t rlen,
470 unsigned char *dstbuf, size_t dlen)
Ron Eldor51d3ab52019-05-12 14:54:30 +0300471{
472 mbedtls_ssl_tls_prf_cb *tls_prf = NULL;
473
Gilles Peskine449bd832023-01-11 14:50:10 +0100474 switch (prf) {
Ron Eldord2f25f72019-05-15 14:54:22 +0300475#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100476#if defined(MBEDTLS_MD_CAN_SHA384)
Ron Eldor51d3ab52019-05-12 14:54:30 +0300477 case MBEDTLS_SSL_TLS_PRF_SHA384:
478 tls_prf = tls_prf_sha384;
Gilles Peskine449bd832023-01-11 14:50:10 +0100479 break;
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100480#endif /* MBEDTLS_MD_CAN_SHA384*/
481#if defined(MBEDTLS_MD_CAN_SHA256)
Ron Eldor51d3ab52019-05-12 14:54:30 +0300482 case MBEDTLS_SSL_TLS_PRF_SHA256:
483 tls_prf = tls_prf_sha256;
Gilles Peskine449bd832023-01-11 14:50:10 +0100484 break;
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100485#endif /* MBEDTLS_MD_CAN_SHA256*/
Ron Eldord2f25f72019-05-15 14:54:22 +0300486#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100487 default:
488 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Ron Eldor51d3ab52019-05-12 14:54:30 +0300489 }
490
Gilles Peskine449bd832023-01-11 14:50:10 +0100491 return tls_prf(secret, slen, label, random, rlen, dstbuf, dlen);
Ron Eldor51d3ab52019-05-12 14:54:30 +0300492}
493
Jerry Yuc73c6182022-02-08 20:29:25 +0800494#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +0100495static void ssl_clear_peer_cert(mbedtls_ssl_session *session)
Jerry Yuc73c6182022-02-08 20:29:25 +0800496{
497#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +0100498 if (session->peer_cert != NULL) {
499 mbedtls_x509_crt_free(session->peer_cert);
500 mbedtls_free(session->peer_cert);
Jerry Yuc73c6182022-02-08 20:29:25 +0800501 session->peer_cert = NULL;
502 }
503#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Gilles Peskine449bd832023-01-11 14:50:10 +0100504 if (session->peer_cert_digest != NULL) {
Jerry Yuc73c6182022-02-08 20:29:25 +0800505 /* Zeroization is not necessary. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100506 mbedtls_free(session->peer_cert_digest);
Jerry Yuc73c6182022-02-08 20:29:25 +0800507 session->peer_cert_digest = NULL;
508 session->peer_cert_digest_type = MBEDTLS_MD_NONE;
509 session->peer_cert_digest_len = 0;
510 }
511#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
512}
513#endif /* MBEDTLS_X509_CRT_PARSE_C */
514
Gilles Peskine449bd832023-01-11 14:50:10 +0100515uint32_t mbedtls_ssl_get_extension_id(unsigned int extension_type)
Jerry Yu7a485c12022-10-31 13:08:18 +0800516{
Gilles Peskine449bd832023-01-11 14:50:10 +0100517 switch (extension_type) {
Jerry Yu7a485c12022-10-31 13:08:18 +0800518 case MBEDTLS_TLS_EXT_SERVERNAME:
Gilles Peskine449bd832023-01-11 14:50:10 +0100519 return MBEDTLS_SSL_EXT_ID_SERVERNAME;
Jerry Yu7a485c12022-10-31 13:08:18 +0800520
521 case MBEDTLS_TLS_EXT_MAX_FRAGMENT_LENGTH:
Gilles Peskine449bd832023-01-11 14:50:10 +0100522 return MBEDTLS_SSL_EXT_ID_MAX_FRAGMENT_LENGTH;
Jerry Yu7a485c12022-10-31 13:08:18 +0800523
524 case MBEDTLS_TLS_EXT_STATUS_REQUEST:
Gilles Peskine449bd832023-01-11 14:50:10 +0100525 return MBEDTLS_SSL_EXT_ID_STATUS_REQUEST;
Jerry Yu7a485c12022-10-31 13:08:18 +0800526
527 case MBEDTLS_TLS_EXT_SUPPORTED_GROUPS:
Gilles Peskine449bd832023-01-11 14:50:10 +0100528 return MBEDTLS_SSL_EXT_ID_SUPPORTED_GROUPS;
Jerry Yu7a485c12022-10-31 13:08:18 +0800529
530 case MBEDTLS_TLS_EXT_SIG_ALG:
Gilles Peskine449bd832023-01-11 14:50:10 +0100531 return MBEDTLS_SSL_EXT_ID_SIG_ALG;
Jerry Yu7a485c12022-10-31 13:08:18 +0800532
533 case MBEDTLS_TLS_EXT_USE_SRTP:
Gilles Peskine449bd832023-01-11 14:50:10 +0100534 return MBEDTLS_SSL_EXT_ID_USE_SRTP;
Jerry Yu7a485c12022-10-31 13:08:18 +0800535
536 case MBEDTLS_TLS_EXT_HEARTBEAT:
Gilles Peskine449bd832023-01-11 14:50:10 +0100537 return MBEDTLS_SSL_EXT_ID_HEARTBEAT;
Jerry Yu7a485c12022-10-31 13:08:18 +0800538
539 case MBEDTLS_TLS_EXT_ALPN:
Gilles Peskine449bd832023-01-11 14:50:10 +0100540 return MBEDTLS_SSL_EXT_ID_ALPN;
Jerry Yu7a485c12022-10-31 13:08:18 +0800541
542 case MBEDTLS_TLS_EXT_SCT:
Gilles Peskine449bd832023-01-11 14:50:10 +0100543 return MBEDTLS_SSL_EXT_ID_SCT;
Jerry Yu7a485c12022-10-31 13:08:18 +0800544
545 case MBEDTLS_TLS_EXT_CLI_CERT_TYPE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100546 return MBEDTLS_SSL_EXT_ID_CLI_CERT_TYPE;
Jerry Yu7a485c12022-10-31 13:08:18 +0800547
548 case MBEDTLS_TLS_EXT_SERV_CERT_TYPE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100549 return MBEDTLS_SSL_EXT_ID_SERV_CERT_TYPE;
Jerry Yu7a485c12022-10-31 13:08:18 +0800550
551 case MBEDTLS_TLS_EXT_PADDING:
Gilles Peskine449bd832023-01-11 14:50:10 +0100552 return MBEDTLS_SSL_EXT_ID_PADDING;
Jerry Yu7a485c12022-10-31 13:08:18 +0800553
554 case MBEDTLS_TLS_EXT_PRE_SHARED_KEY:
Gilles Peskine449bd832023-01-11 14:50:10 +0100555 return MBEDTLS_SSL_EXT_ID_PRE_SHARED_KEY;
Jerry Yu7a485c12022-10-31 13:08:18 +0800556
557 case MBEDTLS_TLS_EXT_EARLY_DATA:
Gilles Peskine449bd832023-01-11 14:50:10 +0100558 return MBEDTLS_SSL_EXT_ID_EARLY_DATA;
Jerry Yu7a485c12022-10-31 13:08:18 +0800559
560 case MBEDTLS_TLS_EXT_SUPPORTED_VERSIONS:
Gilles Peskine449bd832023-01-11 14:50:10 +0100561 return MBEDTLS_SSL_EXT_ID_SUPPORTED_VERSIONS;
Jerry Yu7a485c12022-10-31 13:08:18 +0800562
563 case MBEDTLS_TLS_EXT_COOKIE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100564 return MBEDTLS_SSL_EXT_ID_COOKIE;
Jerry Yu7a485c12022-10-31 13:08:18 +0800565
566 case MBEDTLS_TLS_EXT_PSK_KEY_EXCHANGE_MODES:
Gilles Peskine449bd832023-01-11 14:50:10 +0100567 return MBEDTLS_SSL_EXT_ID_PSK_KEY_EXCHANGE_MODES;
Jerry Yu7a485c12022-10-31 13:08:18 +0800568
569 case MBEDTLS_TLS_EXT_CERT_AUTH:
Gilles Peskine449bd832023-01-11 14:50:10 +0100570 return MBEDTLS_SSL_EXT_ID_CERT_AUTH;
Jerry Yu7a485c12022-10-31 13:08:18 +0800571
572 case MBEDTLS_TLS_EXT_OID_FILTERS:
Gilles Peskine449bd832023-01-11 14:50:10 +0100573 return MBEDTLS_SSL_EXT_ID_OID_FILTERS;
Jerry Yu7a485c12022-10-31 13:08:18 +0800574
575 case MBEDTLS_TLS_EXT_POST_HANDSHAKE_AUTH:
Gilles Peskine449bd832023-01-11 14:50:10 +0100576 return MBEDTLS_SSL_EXT_ID_POST_HANDSHAKE_AUTH;
Jerry Yu7a485c12022-10-31 13:08:18 +0800577
578 case MBEDTLS_TLS_EXT_SIG_ALG_CERT:
Gilles Peskine449bd832023-01-11 14:50:10 +0100579 return MBEDTLS_SSL_EXT_ID_SIG_ALG_CERT;
Jerry Yu7a485c12022-10-31 13:08:18 +0800580
581 case MBEDTLS_TLS_EXT_KEY_SHARE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100582 return MBEDTLS_SSL_EXT_ID_KEY_SHARE;
Jerry Yu7a485c12022-10-31 13:08:18 +0800583
584 case MBEDTLS_TLS_EXT_TRUNCATED_HMAC:
Gilles Peskine449bd832023-01-11 14:50:10 +0100585 return MBEDTLS_SSL_EXT_ID_TRUNCATED_HMAC;
Jerry Yu7a485c12022-10-31 13:08:18 +0800586
587 case MBEDTLS_TLS_EXT_SUPPORTED_POINT_FORMATS:
Gilles Peskine449bd832023-01-11 14:50:10 +0100588 return MBEDTLS_SSL_EXT_ID_SUPPORTED_POINT_FORMATS;
Jerry Yu7a485c12022-10-31 13:08:18 +0800589
590 case MBEDTLS_TLS_EXT_ENCRYPT_THEN_MAC:
Gilles Peskine449bd832023-01-11 14:50:10 +0100591 return MBEDTLS_SSL_EXT_ID_ENCRYPT_THEN_MAC;
Jerry Yu7a485c12022-10-31 13:08:18 +0800592
593 case MBEDTLS_TLS_EXT_EXTENDED_MASTER_SECRET:
Gilles Peskine449bd832023-01-11 14:50:10 +0100594 return MBEDTLS_SSL_EXT_ID_EXTENDED_MASTER_SECRET;
Jerry Yu7a485c12022-10-31 13:08:18 +0800595
Jan Bruckner151f6422023-02-10 12:45:19 +0100596 case MBEDTLS_TLS_EXT_RECORD_SIZE_LIMIT:
597 return MBEDTLS_SSL_EXT_ID_RECORD_SIZE_LIMIT;
598
Jerry Yu7a485c12022-10-31 13:08:18 +0800599 case MBEDTLS_TLS_EXT_SESSION_TICKET:
Gilles Peskine449bd832023-01-11 14:50:10 +0100600 return MBEDTLS_SSL_EXT_ID_SESSION_TICKET;
Jerry Yu7a485c12022-10-31 13:08:18 +0800601
602 }
603
Gilles Peskine449bd832023-01-11 14:50:10 +0100604 return MBEDTLS_SSL_EXT_ID_UNRECOGNIZED;
Jerry Yu7a485c12022-10-31 13:08:18 +0800605}
606
Gilles Peskine449bd832023-01-11 14:50:10 +0100607uint32_t mbedtls_ssl_get_extension_mask(unsigned int extension_type)
Jerry Yu7a485c12022-10-31 13:08:18 +0800608{
Gilles Peskine449bd832023-01-11 14:50:10 +0100609 return 1 << mbedtls_ssl_get_extension_id(extension_type);
Jerry Yu7a485c12022-10-31 13:08:18 +0800610}
611
Jerry Yud25cab02022-10-31 12:48:30 +0800612#if defined(MBEDTLS_DEBUG_C)
613static const char *extension_name_table[] = {
Jerry Yuea52ed92022-11-08 21:01:17 +0800614 [MBEDTLS_SSL_EXT_ID_UNRECOGNIZED] = "unrecognized",
Jerry Yud25cab02022-10-31 12:48:30 +0800615 [MBEDTLS_SSL_EXT_ID_SERVERNAME] = "server_name",
616 [MBEDTLS_SSL_EXT_ID_MAX_FRAGMENT_LENGTH] = "max_fragment_length",
617 [MBEDTLS_SSL_EXT_ID_STATUS_REQUEST] = "status_request",
618 [MBEDTLS_SSL_EXT_ID_SUPPORTED_GROUPS] = "supported_groups",
619 [MBEDTLS_SSL_EXT_ID_SIG_ALG] = "signature_algorithms",
620 [MBEDTLS_SSL_EXT_ID_USE_SRTP] = "use_srtp",
621 [MBEDTLS_SSL_EXT_ID_HEARTBEAT] = "heartbeat",
622 [MBEDTLS_SSL_EXT_ID_ALPN] = "application_layer_protocol_negotiation",
623 [MBEDTLS_SSL_EXT_ID_SCT] = "signed_certificate_timestamp",
624 [MBEDTLS_SSL_EXT_ID_CLI_CERT_TYPE] = "client_certificate_type",
625 [MBEDTLS_SSL_EXT_ID_SERV_CERT_TYPE] = "server_certificate_type",
626 [MBEDTLS_SSL_EXT_ID_PADDING] = "padding",
627 [MBEDTLS_SSL_EXT_ID_PRE_SHARED_KEY] = "pre_shared_key",
628 [MBEDTLS_SSL_EXT_ID_EARLY_DATA] = "early_data",
629 [MBEDTLS_SSL_EXT_ID_SUPPORTED_VERSIONS] = "supported_versions",
630 [MBEDTLS_SSL_EXT_ID_COOKIE] = "cookie",
631 [MBEDTLS_SSL_EXT_ID_PSK_KEY_EXCHANGE_MODES] = "psk_key_exchange_modes",
632 [MBEDTLS_SSL_EXT_ID_CERT_AUTH] = "certificate_authorities",
633 [MBEDTLS_SSL_EXT_ID_OID_FILTERS] = "oid_filters",
634 [MBEDTLS_SSL_EXT_ID_POST_HANDSHAKE_AUTH] = "post_handshake_auth",
635 [MBEDTLS_SSL_EXT_ID_SIG_ALG_CERT] = "signature_algorithms_cert",
636 [MBEDTLS_SSL_EXT_ID_KEY_SHARE] = "key_share",
637 [MBEDTLS_SSL_EXT_ID_TRUNCATED_HMAC] = "truncated_hmac",
638 [MBEDTLS_SSL_EXT_ID_SUPPORTED_POINT_FORMATS] = "supported_point_formats",
639 [MBEDTLS_SSL_EXT_ID_ENCRYPT_THEN_MAC] = "encrypt_then_mac",
640 [MBEDTLS_SSL_EXT_ID_EXTENDED_MASTER_SECRET] = "extended_master_secret",
Jan Bruckner151f6422023-02-10 12:45:19 +0100641 [MBEDTLS_SSL_EXT_ID_SESSION_TICKET] = "session_ticket",
642 [MBEDTLS_SSL_EXT_ID_RECORD_SIZE_LIMIT] = "record_size_limit"
Jerry Yud25cab02022-10-31 12:48:30 +0800643};
644
Chien Wong4e9683e2023-12-28 17:07:43 +0800645static const unsigned int extension_type_table[] = {
Jerry Yud25cab02022-10-31 12:48:30 +0800646 [MBEDTLS_SSL_EXT_ID_UNRECOGNIZED] = 0xff,
647 [MBEDTLS_SSL_EXT_ID_SERVERNAME] = MBEDTLS_TLS_EXT_SERVERNAME,
648 [MBEDTLS_SSL_EXT_ID_MAX_FRAGMENT_LENGTH] = MBEDTLS_TLS_EXT_MAX_FRAGMENT_LENGTH,
649 [MBEDTLS_SSL_EXT_ID_STATUS_REQUEST] = MBEDTLS_TLS_EXT_STATUS_REQUEST,
650 [MBEDTLS_SSL_EXT_ID_SUPPORTED_GROUPS] = MBEDTLS_TLS_EXT_SUPPORTED_GROUPS,
651 [MBEDTLS_SSL_EXT_ID_SIG_ALG] = MBEDTLS_TLS_EXT_SIG_ALG,
652 [MBEDTLS_SSL_EXT_ID_USE_SRTP] = MBEDTLS_TLS_EXT_USE_SRTP,
653 [MBEDTLS_SSL_EXT_ID_HEARTBEAT] = MBEDTLS_TLS_EXT_HEARTBEAT,
654 [MBEDTLS_SSL_EXT_ID_ALPN] = MBEDTLS_TLS_EXT_ALPN,
655 [MBEDTLS_SSL_EXT_ID_SCT] = MBEDTLS_TLS_EXT_SCT,
656 [MBEDTLS_SSL_EXT_ID_CLI_CERT_TYPE] = MBEDTLS_TLS_EXT_CLI_CERT_TYPE,
657 [MBEDTLS_SSL_EXT_ID_SERV_CERT_TYPE] = MBEDTLS_TLS_EXT_SERV_CERT_TYPE,
658 [MBEDTLS_SSL_EXT_ID_PADDING] = MBEDTLS_TLS_EXT_PADDING,
659 [MBEDTLS_SSL_EXT_ID_PRE_SHARED_KEY] = MBEDTLS_TLS_EXT_PRE_SHARED_KEY,
660 [MBEDTLS_SSL_EXT_ID_EARLY_DATA] = MBEDTLS_TLS_EXT_EARLY_DATA,
661 [MBEDTLS_SSL_EXT_ID_SUPPORTED_VERSIONS] = MBEDTLS_TLS_EXT_SUPPORTED_VERSIONS,
662 [MBEDTLS_SSL_EXT_ID_COOKIE] = MBEDTLS_TLS_EXT_COOKIE,
663 [MBEDTLS_SSL_EXT_ID_PSK_KEY_EXCHANGE_MODES] = MBEDTLS_TLS_EXT_PSK_KEY_EXCHANGE_MODES,
664 [MBEDTLS_SSL_EXT_ID_CERT_AUTH] = MBEDTLS_TLS_EXT_CERT_AUTH,
665 [MBEDTLS_SSL_EXT_ID_OID_FILTERS] = MBEDTLS_TLS_EXT_OID_FILTERS,
666 [MBEDTLS_SSL_EXT_ID_POST_HANDSHAKE_AUTH] = MBEDTLS_TLS_EXT_POST_HANDSHAKE_AUTH,
667 [MBEDTLS_SSL_EXT_ID_SIG_ALG_CERT] = MBEDTLS_TLS_EXT_SIG_ALG_CERT,
668 [MBEDTLS_SSL_EXT_ID_KEY_SHARE] = MBEDTLS_TLS_EXT_KEY_SHARE,
669 [MBEDTLS_SSL_EXT_ID_TRUNCATED_HMAC] = MBEDTLS_TLS_EXT_TRUNCATED_HMAC,
670 [MBEDTLS_SSL_EXT_ID_SUPPORTED_POINT_FORMATS] = MBEDTLS_TLS_EXT_SUPPORTED_POINT_FORMATS,
671 [MBEDTLS_SSL_EXT_ID_ENCRYPT_THEN_MAC] = MBEDTLS_TLS_EXT_ENCRYPT_THEN_MAC,
672 [MBEDTLS_SSL_EXT_ID_EXTENDED_MASTER_SECRET] = MBEDTLS_TLS_EXT_EXTENDED_MASTER_SECRET,
Jan Bruckner151f6422023-02-10 12:45:19 +0100673 [MBEDTLS_SSL_EXT_ID_SESSION_TICKET] = MBEDTLS_TLS_EXT_SESSION_TICKET,
674 [MBEDTLS_SSL_EXT_ID_RECORD_SIZE_LIMIT] = MBEDTLS_TLS_EXT_RECORD_SIZE_LIMIT
Jerry Yud25cab02022-10-31 12:48:30 +0800675};
676
Gilles Peskine449bd832023-01-11 14:50:10 +0100677const char *mbedtls_ssl_get_extension_name(unsigned int extension_type)
Jerry Yud25cab02022-10-31 12:48:30 +0800678{
Gilles Peskine449bd832023-01-11 14:50:10 +0100679 return extension_name_table[
680 mbedtls_ssl_get_extension_id(extension_type)];
Jerry Yud25cab02022-10-31 12:48:30 +0800681}
682
Gilles Peskine449bd832023-01-11 14:50:10 +0100683static const char *ssl_tls13_get_hs_msg_name(int hs_msg_type)
Jerry Yud25cab02022-10-31 12:48:30 +0800684{
Gilles Peskine449bd832023-01-11 14:50:10 +0100685 switch (hs_msg_type) {
Jerry Yud25cab02022-10-31 12:48:30 +0800686 case MBEDTLS_SSL_HS_CLIENT_HELLO:
Gilles Peskine449bd832023-01-11 14:50:10 +0100687 return "ClientHello";
Jerry Yud25cab02022-10-31 12:48:30 +0800688 case MBEDTLS_SSL_HS_SERVER_HELLO:
Gilles Peskine449bd832023-01-11 14:50:10 +0100689 return "ServerHello";
Jerry Yud25cab02022-10-31 12:48:30 +0800690 case MBEDTLS_SSL_TLS1_3_HS_HELLO_RETRY_REQUEST:
Gilles Peskine449bd832023-01-11 14:50:10 +0100691 return "HelloRetryRequest";
Jerry Yud25cab02022-10-31 12:48:30 +0800692 case MBEDTLS_SSL_HS_NEW_SESSION_TICKET:
Gilles Peskine449bd832023-01-11 14:50:10 +0100693 return "NewSessionTicket";
Jerry Yud25cab02022-10-31 12:48:30 +0800694 case MBEDTLS_SSL_HS_ENCRYPTED_EXTENSIONS:
Gilles Peskine449bd832023-01-11 14:50:10 +0100695 return "EncryptedExtensions";
Jerry Yud25cab02022-10-31 12:48:30 +0800696 case MBEDTLS_SSL_HS_CERTIFICATE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100697 return "Certificate";
Jerry Yud25cab02022-10-31 12:48:30 +0800698 case MBEDTLS_SSL_HS_CERTIFICATE_REQUEST:
Gilles Peskine449bd832023-01-11 14:50:10 +0100699 return "CertificateRequest";
Jerry Yud25cab02022-10-31 12:48:30 +0800700 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100701 return "Unknown";
Jerry Yud25cab02022-10-31 12:48:30 +0800702}
703
Gilles Peskine449bd832023-01-11 14:50:10 +0100704void mbedtls_ssl_print_extension(const mbedtls_ssl_context *ssl,
705 int level, const char *file, int line,
706 int hs_msg_type, unsigned int extension_type,
707 const char *extra_msg0, const char *extra_msg1)
Jerry Yud25cab02022-10-31 12:48:30 +0800708{
709 const char *extra_msg;
Gilles Peskine449bd832023-01-11 14:50:10 +0100710 if (extra_msg0 && extra_msg1) {
Jerry Yud25cab02022-10-31 12:48:30 +0800711 mbedtls_debug_print_msg(
712 ssl, level, file, line,
713 "%s: %s(%u) extension %s %s.",
Gilles Peskine449bd832023-01-11 14:50:10 +0100714 ssl_tls13_get_hs_msg_name(hs_msg_type),
715 mbedtls_ssl_get_extension_name(extension_type),
Jerry Yud25cab02022-10-31 12:48:30 +0800716 extension_type,
Gilles Peskine449bd832023-01-11 14:50:10 +0100717 extra_msg0, extra_msg1);
Jerry Yud25cab02022-10-31 12:48:30 +0800718 return;
719 }
720
721 extra_msg = extra_msg0 ? extra_msg0 : extra_msg1;
Gilles Peskine449bd832023-01-11 14:50:10 +0100722 if (extra_msg) {
Jerry Yud25cab02022-10-31 12:48:30 +0800723 mbedtls_debug_print_msg(
724 ssl, level, file, line,
Gilles Peskine449bd832023-01-11 14:50:10 +0100725 "%s: %s(%u) extension %s.", ssl_tls13_get_hs_msg_name(hs_msg_type),
726 mbedtls_ssl_get_extension_name(extension_type), extension_type,
727 extra_msg);
Jerry Yud25cab02022-10-31 12:48:30 +0800728 return;
729 }
730
731 mbedtls_debug_print_msg(
732 ssl, level, file, line,
Gilles Peskine449bd832023-01-11 14:50:10 +0100733 "%s: %s(%u) extension.", ssl_tls13_get_hs_msg_name(hs_msg_type),
734 mbedtls_ssl_get_extension_name(extension_type), extension_type);
Jerry Yud25cab02022-10-31 12:48:30 +0800735}
736
Gilles Peskine449bd832023-01-11 14:50:10 +0100737void mbedtls_ssl_print_extensions(const mbedtls_ssl_context *ssl,
738 int level, const char *file, int line,
739 int hs_msg_type, uint32_t extensions_mask,
740 const char *extra)
Jerry Yud25cab02022-10-31 12:48:30 +0800741{
742
Gilles Peskine449bd832023-01-11 14:50:10 +0100743 for (unsigned i = 0;
744 i < sizeof(extension_name_table) / sizeof(extension_name_table[0]);
745 i++) {
Jerry Yu79aa7212022-11-08 21:30:21 +0800746 mbedtls_ssl_print_extension(
Jerry Yuea52ed92022-11-08 21:01:17 +0800747 ssl, level, file, line, hs_msg_type, extension_type_table[i],
Gilles Peskine449bd832023-01-11 14:50:10 +0100748 extensions_mask & (1 << i) ? "exists" : "does not exist", extra);
Jerry Yud25cab02022-10-31 12:48:30 +0800749 }
750}
751
Pengyu Lvee455c02023-01-12 14:37:24 +0800752#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Pengyu Lvee455c02023-01-12 14:37:24 +0800753static const char *ticket_flag_name_table[] =
754{
755 [0] = "ALLOW_PSK_RESUMPTION",
756 [2] = "ALLOW_PSK_EPHEMERAL_RESUMPTION",
757 [3] = "ALLOW_EARLY_DATA",
758};
759
Pengyu Lv4938a562023-01-16 11:28:49 +0800760void mbedtls_ssl_print_ticket_flags(const mbedtls_ssl_context *ssl,
761 int level, const char *file, int line,
762 unsigned int flags)
Pengyu Lvee455c02023-01-12 14:37:24 +0800763{
764 size_t i;
765
766 mbedtls_debug_print_msg(ssl, level, file, line,
Pengyu Lv4938a562023-01-16 11:28:49 +0800767 "print ticket_flags (0x%02x)", flags);
768
769 flags = flags & MBEDTLS_SSL_TLS1_3_TICKET_FLAGS_MASK;
Pengyu Lvee455c02023-01-12 14:37:24 +0800770
771 for (i = 0; i < ARRAY_LENGTH(ticket_flag_name_table); i++) {
Pengyu Lv4938a562023-01-16 11:28:49 +0800772 if ((flags & (1 << i))) {
Pengyu Lvee455c02023-01-12 14:37:24 +0800773 mbedtls_debug_print_msg(ssl, level, file, line, "- %s is set.",
774 ticket_flag_name_table[i]);
775 }
776 }
777}
778#endif /* MBEDTLS_SSL_PROTO_TLS1_3 && MBEDTLS_SSL_SESSION_TICKETS */
779
Jerry Yud25cab02022-10-31 12:48:30 +0800780#endif /* MBEDTLS_DEBUG_C */
781
Gilles Peskine449bd832023-01-11 14:50:10 +0100782void mbedtls_ssl_optimize_checksum(mbedtls_ssl_context *ssl,
783 const mbedtls_ssl_ciphersuite_t *ciphersuite_info)
Jerry Yuc73c6182022-02-08 20:29:25 +0800784{
785 ((void) ciphersuite_info);
786
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100787#if defined(MBEDTLS_MD_CAN_SHA384)
Gilles Peskine449bd832023-01-11 14:50:10 +0100788 if (ciphersuite_info->mac == MBEDTLS_MD_SHA384) {
Jerry Yuc73c6182022-02-08 20:29:25 +0800789 ssl->handshake->update_checksum = ssl_update_checksum_sha384;
Gilles Peskine449bd832023-01-11 14:50:10 +0100790 } else
Jerry Yuc73c6182022-02-08 20:29:25 +0800791#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100792#if defined(MBEDTLS_MD_CAN_SHA256)
Gilles Peskine449bd832023-01-11 14:50:10 +0100793 if (ciphersuite_info->mac != MBEDTLS_MD_SHA384) {
Jerry Yuc73c6182022-02-08 20:29:25 +0800794 ssl->handshake->update_checksum = ssl_update_checksum_sha256;
Gilles Peskine449bd832023-01-11 14:50:10 +0100795 } else
Jerry Yuc73c6182022-02-08 20:29:25 +0800796#endif
797 {
Gilles Peskine449bd832023-01-11 14:50:10 +0100798 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
Jerry Yuc73c6182022-02-08 20:29:25 +0800799 return;
800 }
801}
802
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100803int mbedtls_ssl_add_hs_hdr_to_checksum(mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100804 unsigned hs_type,
805 size_t total_hs_len)
Ronald Cron8f6d39a2022-03-10 18:56:50 +0100806{
807 unsigned char hs_hdr[4];
808
809 /* Build HS header for checksum update. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100810 hs_hdr[0] = MBEDTLS_BYTE_0(hs_type);
811 hs_hdr[1] = MBEDTLS_BYTE_2(total_hs_len);
812 hs_hdr[2] = MBEDTLS_BYTE_1(total_hs_len);
813 hs_hdr[3] = MBEDTLS_BYTE_0(total_hs_len);
Ronald Cron8f6d39a2022-03-10 18:56:50 +0100814
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100815 return ssl->handshake->update_checksum(ssl, hs_hdr, sizeof(hs_hdr));
Ronald Cron8f6d39a2022-03-10 18:56:50 +0100816}
817
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100818int mbedtls_ssl_add_hs_msg_to_checksum(mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100819 unsigned hs_type,
820 unsigned char const *msg,
821 size_t msg_len)
Ronald Cron8f6d39a2022-03-10 18:56:50 +0100822{
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100823 int ret;
824 ret = mbedtls_ssl_add_hs_hdr_to_checksum(ssl, hs_type, msg_len);
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100825 if (ret != 0) {
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100826 return ret;
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100827 }
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100828 return ssl->handshake->update_checksum(ssl, msg, msg_len);
Ronald Cron8f6d39a2022-03-10 18:56:50 +0100829}
830
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100831int mbedtls_ssl_reset_checksum(mbedtls_ssl_context *ssl)
Jerry Yuc73c6182022-02-08 20:29:25 +0800832{
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100833#if defined(MBEDTLS_MD_CAN_SHA256) || \
834 defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100835#if defined(MBEDTLS_USE_PSA_CRYPTO)
836 psa_status_t status;
837#else
838 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
839#endif
Manuel Pégourié-Gonnard626aaed2023-02-06 22:03:06 +0100840#else /* SHA-256 or SHA-384 */
Jerry Yuc73c6182022-02-08 20:29:25 +0800841 ((void) ssl);
Manuel Pégourié-Gonnard626aaed2023-02-06 22:03:06 +0100842#endif /* SHA-256 or SHA-384 */
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100843#if defined(MBEDTLS_MD_CAN_SHA256)
Jerry Yuc73c6182022-02-08 20:29:25 +0800844#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100845 status = psa_hash_abort(&ssl->handshake->fin_sha256_psa);
846 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200847 return mbedtls_md_error_from_psa(status);
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100848 }
849 status = psa_hash_setup(&ssl->handshake->fin_sha256_psa, PSA_ALG_SHA_256);
850 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200851 return mbedtls_md_error_from_psa(status);
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100852 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800853#else
Manuel Pégourié-Gonnard947cee12023-03-06 11:59:59 +0100854 mbedtls_md_free(&ssl->handshake->fin_sha256);
855 mbedtls_md_init(&ssl->handshake->fin_sha256);
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +0100856 ret = mbedtls_md_setup(&ssl->handshake->fin_sha256,
857 mbedtls_md_info_from_type(MBEDTLS_MD_SHA256),
858 0);
859 if (ret != 0) {
860 return ret;
861 }
862 ret = mbedtls_md_starts(&ssl->handshake->fin_sha256);
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100863 if (ret != 0) {
864 return ret;
865 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800866#endif
867#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100868#if defined(MBEDTLS_MD_CAN_SHA384)
Jerry Yuc73c6182022-02-08 20:29:25 +0800869#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100870 status = psa_hash_abort(&ssl->handshake->fin_sha384_psa);
871 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200872 return mbedtls_md_error_from_psa(status);
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100873 }
874 status = psa_hash_setup(&ssl->handshake->fin_sha384_psa, PSA_ALG_SHA_384);
875 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200876 return mbedtls_md_error_from_psa(status);
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100877 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800878#else
Manuel Pégourié-Gonnard947cee12023-03-06 11:59:59 +0100879 mbedtls_md_free(&ssl->handshake->fin_sha384);
880 mbedtls_md_init(&ssl->handshake->fin_sha384);
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +0100881 ret = mbedtls_md_setup(&ssl->handshake->fin_sha384,
882 mbedtls_md_info_from_type(MBEDTLS_MD_SHA384), 0);
883 if (ret != 0) {
884 return ret;
885 }
886 ret = mbedtls_md_starts(&ssl->handshake->fin_sha384);
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100887 if (ret != 0) {
888 return ret;
889 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800890#endif
891#endif
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100892 return 0;
Jerry Yuc73c6182022-02-08 20:29:25 +0800893}
894
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100895static int ssl_update_checksum_start(mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100896 const unsigned char *buf, size_t len)
Jerry Yuc73c6182022-02-08 20:29:25 +0800897{
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100898#if defined(MBEDTLS_MD_CAN_SHA256) || \
899 defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnarddf949012023-02-06 10:00:52 +0100900#if defined(MBEDTLS_USE_PSA_CRYPTO)
901 psa_status_t status;
902#else
903 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
904#endif
Manuel Pégourié-Gonnard626aaed2023-02-06 22:03:06 +0100905#else /* SHA-256 or SHA-384 */
906 ((void) ssl);
907 (void) buf;
908 (void) len;
909#endif /* SHA-256 or SHA-384 */
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100910#if defined(MBEDTLS_MD_CAN_SHA256)
Jerry Yuc73c6182022-02-08 20:29:25 +0800911#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnarddf949012023-02-06 10:00:52 +0100912 status = psa_hash_update(&ssl->handshake->fin_sha256_psa, buf, len);
913 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200914 return mbedtls_md_error_from_psa(status);
Manuel Pégourié-Gonnarddf949012023-02-06 10:00:52 +0100915 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800916#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +0100917 ret = mbedtls_md_update(&ssl->handshake->fin_sha256, buf, len);
Manuel Pégourié-Gonnarddf949012023-02-06 10:00:52 +0100918 if (ret != 0) {
919 return ret;
920 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800921#endif
922#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100923#if defined(MBEDTLS_MD_CAN_SHA384)
Jerry Yuc73c6182022-02-08 20:29:25 +0800924#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnarddf949012023-02-06 10:00:52 +0100925 status = psa_hash_update(&ssl->handshake->fin_sha384_psa, buf, len);
926 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200927 return mbedtls_md_error_from_psa(status);
Manuel Pégourié-Gonnarddf949012023-02-06 10:00:52 +0100928 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800929#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +0100930 ret = mbedtls_md_update(&ssl->handshake->fin_sha384, buf, len);
Manuel Pégourié-Gonnarddf949012023-02-06 10:00:52 +0100931 if (ret != 0) {
932 return ret;
933 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800934#endif
935#endif
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100936 return 0;
Jerry Yuc73c6182022-02-08 20:29:25 +0800937}
938
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100939#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100940static int ssl_update_checksum_sha256(mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100941 const unsigned char *buf, size_t len)
Jerry Yuc73c6182022-02-08 20:29:25 +0800942{
943#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200944 return mbedtls_md_error_from_psa(psa_hash_update(
945 &ssl->handshake->fin_sha256_psa, buf, len));
Jerry Yuc73c6182022-02-08 20:29:25 +0800946#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +0100947 return mbedtls_md_update(&ssl->handshake->fin_sha256, buf, len);
Jerry Yuc73c6182022-02-08 20:29:25 +0800948#endif
949}
950#endif
951
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100952#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100953static int ssl_update_checksum_sha384(mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100954 const unsigned char *buf, size_t len)
Jerry Yuc73c6182022-02-08 20:29:25 +0800955{
956#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200957 return mbedtls_md_error_from_psa(psa_hash_update(
958 &ssl->handshake->fin_sha384_psa, buf, len));
Jerry Yuc73c6182022-02-08 20:29:25 +0800959#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +0100960 return mbedtls_md_update(&ssl->handshake->fin_sha384, buf, len);
Jerry Yuc73c6182022-02-08 20:29:25 +0800961#endif
962}
963#endif
964
Gilles Peskine449bd832023-01-11 14:50:10 +0100965static void ssl_handshake_params_init(mbedtls_ssl_handshake_params *handshake)
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200966{
Gilles Peskine449bd832023-01-11 14:50:10 +0100967 memset(handshake, 0, sizeof(mbedtls_ssl_handshake_params));
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200968
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100969#if defined(MBEDTLS_MD_CAN_SHA256)
Andrzej Kurekeb342242019-01-29 09:14:33 -0500970#if defined(MBEDTLS_USE_PSA_CRYPTO)
971 handshake->fin_sha256_psa = psa_hash_operation_init();
Andrzej Kurekeb342242019-01-29 09:14:33 -0500972#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +0100973 mbedtls_md_init(&handshake->fin_sha256);
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200974#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -0500975#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100976#if defined(MBEDTLS_MD_CAN_SHA384)
Andrzej Kurekeb342242019-01-29 09:14:33 -0500977#if defined(MBEDTLS_USE_PSA_CRYPTO)
Andrzej Kurek972fba52019-01-30 03:29:12 -0500978 handshake->fin_sha384_psa = psa_hash_operation_init();
Andrzej Kurekeb342242019-01-29 09:14:33 -0500979#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +0100980 mbedtls_md_init(&handshake->fin_sha384);
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200981#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -0500982#endif
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200983
984 handshake->update_checksum = ssl_update_checksum_start;
Hanno Becker7e5437a2017-04-28 17:15:26 +0100985
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200986#if defined(MBEDTLS_DHM_C)
Gilles Peskine449bd832023-01-11 14:50:10 +0100987 mbedtls_dhm_init(&handshake->dhm_ctx);
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200988#endif
Valerio Setti7aeec542023-07-05 18:57:21 +0200989#if !defined(MBEDTLS_USE_PSA_CRYPTO) && \
Valerio Setti6eb00542023-07-07 17:04:24 +0200990 defined(MBEDTLS_KEY_EXCHANGE_SOME_ECDH_OR_ECDHE_1_2_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +0100991 mbedtls_ecdh_init(&handshake->ecdh_ctx);
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200992#endif
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +0200993#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Neil Armstrongca7d5062022-05-31 14:43:23 +0200994#if defined(MBEDTLS_USE_PSA_CRYPTO)
995 handshake->psa_pake_ctx = psa_pake_operation_init();
996 handshake->psa_pake_password = MBEDTLS_SVC_KEY_ID_INIT;
997#else
Gilles Peskine449bd832023-01-11 14:50:10 +0100998 mbedtls_ecjpake_init(&handshake->ecjpake_ctx);
Neil Armstrongca7d5062022-05-31 14:43:23 +0200999#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard77c06462015-09-17 13:59:49 +02001000#if defined(MBEDTLS_SSL_CLI_C)
1001 handshake->ecjpake_cache = NULL;
1002 handshake->ecjpake_cache_len = 0;
1003#endif
Manuel Pégourié-Gonnard76cfd3f2015-09-15 12:10:54 +02001004#endif
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +02001005
Gilles Peskineeccd8882020-03-10 12:19:08 +01001006#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01001007 mbedtls_x509_crt_restart_init(&handshake->ecrs_ctx);
Manuel Pégourié-Gonnard862cde52017-05-17 11:56:15 +02001008#endif
1009
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +02001010#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
1011 handshake->sni_authmode = MBEDTLS_SSL_VERIFY_UNSET;
1012#endif
Hanno Becker75173122019-02-06 16:18:31 +00001013
1014#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
1015 !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01001016 mbedtls_pk_init(&handshake->peer_pubkey);
Hanno Becker75173122019-02-06 16:18:31 +00001017#endif
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001018}
1019
Gilles Peskine449bd832023-01-11 14:50:10 +01001020void mbedtls_ssl_transform_init(mbedtls_ssl_transform *transform)
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001021{
Gilles Peskine449bd832023-01-11 14:50:10 +01001022 memset(transform, 0, sizeof(mbedtls_ssl_transform));
Paul Bakker84bbeb52014-07-01 14:53:22 +02001023
Przemyslaw Stekiel8f80fb92022-01-11 08:28:13 +01001024#if defined(MBEDTLS_USE_PSA_CRYPTO)
1025 transform->psa_key_enc = MBEDTLS_SVC_KEY_ID_INIT;
1026 transform->psa_key_dec = MBEDTLS_SVC_KEY_ID_INIT;
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01001027#else
Gilles Peskine449bd832023-01-11 14:50:10 +01001028 mbedtls_cipher_init(&transform->cipher_ctx_enc);
1029 mbedtls_cipher_init(&transform->cipher_ctx_dec);
Przemyslaw Stekiel8f80fb92022-01-11 08:28:13 +01001030#endif
1031
Hanno Beckerfd86ca82020-11-30 08:54:23 +00001032#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Neil Armstrong39b8e7d2022-02-23 09:24:45 +01001033#if defined(MBEDTLS_USE_PSA_CRYPTO)
1034 transform->psa_mac_enc = MBEDTLS_SVC_KEY_ID_INIT;
1035 transform->psa_mac_dec = MBEDTLS_SVC_KEY_ID_INIT;
Neil Armstrongcf8841a2022-02-24 11:17:45 +01001036#else
Gilles Peskine449bd832023-01-11 14:50:10 +01001037 mbedtls_md_init(&transform->md_ctx_enc);
1038 mbedtls_md_init(&transform->md_ctx_dec);
Hanno Beckerd56ed242018-01-03 15:32:51 +00001039#endif
Neil Armstrongcf8841a2022-02-24 11:17:45 +01001040#endif
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001041}
1042
Gilles Peskine449bd832023-01-11 14:50:10 +01001043void mbedtls_ssl_session_init(mbedtls_ssl_session *session)
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001044{
Gilles Peskine449bd832023-01-11 14:50:10 +01001045 memset(session, 0, sizeof(mbedtls_ssl_session));
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001046}
1047
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001048MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001049static int ssl_handshake_init(mbedtls_ssl_context *ssl)
Paul Bakker48916f92012-09-16 19:57:18 +00001050{
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01001051 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1052
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001053 /* Clear old handshake information if present */
Jerry Yu2e199812022-12-01 18:57:19 +08001054#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01001055 if (ssl->transform_negotiate) {
1056 mbedtls_ssl_transform_free(ssl->transform_negotiate);
1057 }
Jerry Yu2e199812022-12-01 18:57:19 +08001058#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001059 if (ssl->session_negotiate) {
1060 mbedtls_ssl_session_free(ssl->session_negotiate);
1061 }
1062 if (ssl->handshake) {
1063 mbedtls_ssl_handshake_free(ssl);
1064 }
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001065
Jerry Yu2e199812022-12-01 18:57:19 +08001066#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001067 /*
1068 * Either the pointers are now NULL or cleared properly and can be freed.
1069 * Now allocate missing structures.
1070 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001071 if (ssl->transform_negotiate == NULL) {
1072 ssl->transform_negotiate = mbedtls_calloc(1, sizeof(mbedtls_ssl_transform));
Paul Bakkerb9cfaa02013-10-11 18:58:55 +02001073 }
Jerry Yu2e199812022-12-01 18:57:19 +08001074#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Paul Bakker48916f92012-09-16 19:57:18 +00001075
Gilles Peskine449bd832023-01-11 14:50:10 +01001076 if (ssl->session_negotiate == NULL) {
1077 ssl->session_negotiate = mbedtls_calloc(1, sizeof(mbedtls_ssl_session));
Paul Bakkerb9cfaa02013-10-11 18:58:55 +02001078 }
Paul Bakker48916f92012-09-16 19:57:18 +00001079
Gilles Peskine449bd832023-01-11 14:50:10 +01001080 if (ssl->handshake == NULL) {
1081 ssl->handshake = mbedtls_calloc(1, sizeof(mbedtls_ssl_handshake_params));
Paul Bakkerb9cfaa02013-10-11 18:58:55 +02001082 }
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05001083#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1084 /* If the buffers are too small - reallocate */
Andrzej Kurek8ea68722020-04-03 06:40:47 -04001085
Gilles Peskine449bd832023-01-11 14:50:10 +01001086 handle_buffer_resizing(ssl, 0, MBEDTLS_SSL_IN_BUFFER_LEN,
1087 MBEDTLS_SSL_OUT_BUFFER_LEN);
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05001088#endif
Paul Bakker48916f92012-09-16 19:57:18 +00001089
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001090 /* All pointers should exist and can be directly freed without issue */
Gilles Peskine449bd832023-01-11 14:50:10 +01001091 if (ssl->handshake == NULL ||
Jerry Yu2e199812022-12-01 18:57:19 +08001092#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Paul Bakker48916f92012-09-16 19:57:18 +00001093 ssl->transform_negotiate == NULL ||
Jerry Yu2e199812022-12-01 18:57:19 +08001094#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001095 ssl->session_negotiate == NULL) {
1096 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc() of ssl sub-contexts failed"));
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001097
Gilles Peskine449bd832023-01-11 14:50:10 +01001098 mbedtls_free(ssl->handshake);
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001099 ssl->handshake = NULL;
Jerry Yu2e199812022-12-01 18:57:19 +08001100
1101#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01001102 mbedtls_free(ssl->transform_negotiate);
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001103 ssl->transform_negotiate = NULL;
Jerry Yu2e199812022-12-01 18:57:19 +08001104#endif
1105
Gilles Peskine449bd832023-01-11 14:50:10 +01001106 mbedtls_free(ssl->session_negotiate);
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001107 ssl->session_negotiate = NULL;
1108
Gilles Peskine449bd832023-01-11 14:50:10 +01001109 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
Paul Bakker48916f92012-09-16 19:57:18 +00001110 }
1111
Jerry Yu4caf3ca2023-11-15 16:13:47 +08001112#if defined(MBEDTLS_SSL_EARLY_DATA)
1113#if defined(MBEDTLS_SSL_CLI_C)
Ronald Cron05d7cfb2024-03-03 15:39:30 +01001114 ssl->early_data_state = MBEDTLS_SSL_EARLY_DATA_STATE_IDLE;
Ronald Cron5d0ae902024-01-05 14:20:35 +01001115#endif
Jerry Yu4caf3ca2023-11-15 16:13:47 +08001116#if defined(MBEDTLS_SSL_SRV_C)
1117 ssl->discard_early_data_record = MBEDTLS_SSL_EARLY_DATA_NO_DISCARD;
1118#endif
Ronald Cron19bfe0a2024-02-26 16:43:01 +01001119 ssl->total_early_data_size = 0;
Jerry Yu4caf3ca2023-11-15 16:13:47 +08001120#endif /* MBEDTLS_SSL_EARLY_DATA */
Ronald Cron5d0ae902024-01-05 14:20:35 +01001121
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001122 /* Initialize structures */
Gilles Peskine449bd832023-01-11 14:50:10 +01001123 mbedtls_ssl_session_init(ssl->session_negotiate);
1124 ssl_handshake_params_init(ssl->handshake);
Paul Bakker968afaa2014-07-09 11:09:24 +02001125
Jerry Yu2e199812022-12-01 18:57:19 +08001126#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01001127 mbedtls_ssl_transform_init(ssl->transform_negotiate);
Jerry Yu2e199812022-12-01 18:57:19 +08001128#endif
1129
Manuel Pégourié-Gonnard537f2312023-02-05 10:17:45 +01001130 /* Setup handshake checksums */
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01001131 ret = mbedtls_ssl_reset_checksum(ssl);
1132 if (ret != 0) {
1133 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_reset_checksum", ret);
1134 return ret;
1135 }
Manuel Pégourié-Gonnard537f2312023-02-05 10:17:45 +01001136
Jerry Yud0766ec2022-09-22 10:46:57 +08001137#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && \
1138 defined(MBEDTLS_SSL_SRV_C) && \
1139 defined(MBEDTLS_SSL_SESSION_TICKETS)
1140 ssl->handshake->new_session_tickets_count =
Gilles Peskine449bd832023-01-11 14:50:10 +01001141 ssl->conf->new_session_tickets_count;
Jerry Yud0766ec2022-09-22 10:46:57 +08001142#endif
1143
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001144#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01001145 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +02001146 ssl->handshake->alt_transform_out = ssl->transform_out;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02001147
Gilles Peskine449bd832023-01-11 14:50:10 +01001148 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +02001149 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_PREPARING;
Gilles Peskine449bd832023-01-11 14:50:10 +01001150 } else {
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +02001151 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_WAITING;
Gilles Peskine449bd832023-01-11 14:50:10 +01001152 }
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001153
Gilles Peskine449bd832023-01-11 14:50:10 +01001154 mbedtls_ssl_set_timer(ssl, 0);
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +02001155 }
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02001156#endif
1157
Brett Warrene0edc842021-08-17 09:53:13 +01001158/*
1159 * curve_list is translated to IANA TLS group identifiers here because
1160 * mbedtls_ssl_conf_curves returns void and so can't return
1161 * any error codes.
1162 */
Manuel Pégourié-Gonnardf07ce3b2023-09-22 11:53:41 +02001163#if defined(MBEDTLS_ECP_C)
Brett Warrene0edc842021-08-17 09:53:13 +01001164#if !defined(MBEDTLS_DEPRECATED_REMOVED)
1165 /* Heap allocate and translate curve_list from internal to IANA group ids */
Gilles Peskine449bd832023-01-11 14:50:10 +01001166 if (ssl->conf->curve_list != NULL) {
Brett Warrene0edc842021-08-17 09:53:13 +01001167 size_t length;
1168 const mbedtls_ecp_group_id *curve_list = ssl->conf->curve_list;
1169
Thomas Daubney850a0792023-05-22 12:05:03 +01001170 for (length = 0; (curve_list[length] != MBEDTLS_ECP_DP_NONE); length++) {
Gilles Peskine449bd832023-01-11 14:50:10 +01001171 }
Brett Warrene0edc842021-08-17 09:53:13 +01001172
1173 /* Leave room for zero termination */
Gilles Peskine449bd832023-01-11 14:50:10 +01001174 uint16_t *group_list = mbedtls_calloc(length + 1, sizeof(uint16_t));
1175 if (group_list == NULL) {
1176 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
1177 }
Brett Warrene0edc842021-08-17 09:53:13 +01001178
Gilles Peskine449bd832023-01-11 14:50:10 +01001179 for (size_t i = 0; i < length; i++) {
Valerio Setti18c9fed2022-12-30 17:44:24 +01001180 uint16_t tls_id = mbedtls_ssl_get_tls_id_from_ecp_group_id(
Gilles Peskine449bd832023-01-11 14:50:10 +01001181 curve_list[i]);
1182 if (tls_id == 0) {
1183 mbedtls_free(group_list);
1184 return MBEDTLS_ERR_SSL_BAD_CONFIG;
Brett Warrene0edc842021-08-17 09:53:13 +01001185 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01001186 group_list[i] = tls_id;
Brett Warrene0edc842021-08-17 09:53:13 +01001187 }
1188
1189 group_list[length] = 0;
1190
1191 ssl->handshake->group_list = group_list;
1192 ssl->handshake->group_list_heap_allocated = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01001193 } else {
Brett Warrene0edc842021-08-17 09:53:13 +01001194 ssl->handshake->group_list = ssl->conf->group_list;
1195 ssl->handshake->group_list_heap_allocated = 0;
1196 }
1197#endif /* MBEDTLS_DEPRECATED_REMOVED */
Manuel Pégourié-Gonnardf07ce3b2023-09-22 11:53:41 +02001198#endif /* MBEDTLS_ECP_C */
Brett Warrene0edc842021-08-17 09:53:13 +01001199
Ronald Crone68ab4f2022-10-05 12:46:29 +02001200#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yuf017ee42022-01-12 15:49:48 +08001201#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Jerry Yua69269a2022-01-17 21:06:01 +08001202#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Jerry Yu713013f2022-01-17 18:16:35 +08001203 /* Heap allocate and translate sig_hashes from internal hash identifiers to
1204 signature algorithms IANA identifiers. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001205 if (mbedtls_ssl_conf_is_tls12_only(ssl->conf) &&
1206 ssl->conf->sig_hashes != NULL) {
Jerry Yuf017ee42022-01-12 15:49:48 +08001207 const int *md;
1208 const int *sig_hashes = ssl->conf->sig_hashes;
Jerry Yub476a442022-01-21 18:14:45 +08001209 size_t sig_algs_len = 0;
Jerry Yuf017ee42022-01-12 15:49:48 +08001210 uint16_t *p;
1211
Tom Cosgrove6ef9bb32023-03-08 14:19:51 +00001212 MBEDTLS_STATIC_ASSERT(MBEDTLS_SSL_MAX_SIG_ALG_LIST_LEN
1213 <= (SIZE_MAX - (2 * sizeof(uint16_t))),
1214 "MBEDTLS_SSL_MAX_SIG_ALG_LIST_LEN too big");
Jerry Yua68dca22022-01-20 16:28:27 +08001215
Gilles Peskine449bd832023-01-11 14:50:10 +01001216 for (md = sig_hashes; *md != MBEDTLS_MD_NONE; md++) {
1217 if (mbedtls_ssl_hash_from_md_alg(*md) == MBEDTLS_SSL_HASH_NONE) {
Jerry Yuf017ee42022-01-12 15:49:48 +08001218 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01001219 }
Valerio Settie9646ec2023-08-02 20:02:28 +02001220#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01001221 sig_algs_len += sizeof(uint16_t);
Jerry Yub476a442022-01-21 18:14:45 +08001222#endif
Jerry Yua68dca22022-01-20 16:28:27 +08001223
Jerry Yub476a442022-01-21 18:14:45 +08001224#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001225 sig_algs_len += sizeof(uint16_t);
Jerry Yub476a442022-01-21 18:14:45 +08001226#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001227 if (sig_algs_len > MBEDTLS_SSL_MAX_SIG_ALG_LIST_LEN) {
1228 return MBEDTLS_ERR_SSL_BAD_CONFIG;
1229 }
Jerry Yuf017ee42022-01-12 15:49:48 +08001230 }
1231
Gilles Peskine449bd832023-01-11 14:50:10 +01001232 if (sig_algs_len < MBEDTLS_SSL_MIN_SIG_ALG_LIST_LEN) {
1233 return MBEDTLS_ERR_SSL_BAD_CONFIG;
1234 }
Jerry Yuf017ee42022-01-12 15:49:48 +08001235
Gilles Peskine449bd832023-01-11 14:50:10 +01001236 ssl->handshake->sig_algs = mbedtls_calloc(1, sig_algs_len +
1237 sizeof(uint16_t));
1238 if (ssl->handshake->sig_algs == NULL) {
1239 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
1240 }
Jerry Yuf017ee42022-01-12 15:49:48 +08001241
Gilles Peskine449bd832023-01-11 14:50:10 +01001242 p = (uint16_t *) ssl->handshake->sig_algs;
1243 for (md = sig_hashes; *md != MBEDTLS_MD_NONE; md++) {
1244 unsigned char hash = mbedtls_ssl_hash_from_md_alg(*md);
1245 if (hash == MBEDTLS_SSL_HASH_NONE) {
Jerry Yuf017ee42022-01-12 15:49:48 +08001246 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01001247 }
Valerio Settie9646ec2023-08-02 20:02:28 +02001248#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01001249 *p = ((hash << 8) | MBEDTLS_SSL_SIG_ECDSA);
Jerry Yuf017ee42022-01-12 15:49:48 +08001250 p++;
Jerry Yu6106fdc2022-01-12 16:36:14 +08001251#endif
1252#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001253 *p = ((hash << 8) | MBEDTLS_SSL_SIG_RSA);
Jerry Yuf017ee42022-01-12 15:49:48 +08001254 p++;
Jerry Yu6106fdc2022-01-12 16:36:14 +08001255#endif
Jerry Yuf017ee42022-01-12 15:49:48 +08001256 }
Gabor Mezei15b95a62022-05-09 16:37:58 +02001257 *p = MBEDTLS_TLS_SIG_NONE;
Jerry Yuf017ee42022-01-12 15:49:48 +08001258 ssl->handshake->sig_algs_heap_allocated = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01001259 } else
Jerry Yua69269a2022-01-17 21:06:01 +08001260#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Jerry Yuf017ee42022-01-12 15:49:48 +08001261 {
Jerry Yuf017ee42022-01-12 15:49:48 +08001262 ssl->handshake->sig_algs_heap_allocated = 0;
1263 }
Jerry Yucc539102022-06-27 16:27:35 +08001264#endif /* !MBEDTLS_DEPRECATED_REMOVED */
Ronald Crone68ab4f2022-10-05 12:46:29 +02001265#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Gilles Peskine449bd832023-01-11 14:50:10 +01001266 return 0;
Paul Bakker48916f92012-09-16 19:57:18 +00001267}
1268
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001269#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001270/* Dummy cookie callbacks for defaults */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001271MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001272static int ssl_cookie_write_dummy(void *ctx,
1273 unsigned char **p, unsigned char *end,
1274 const unsigned char *cli_id, size_t cli_id_len)
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001275{
1276 ((void) ctx);
1277 ((void) p);
1278 ((void) end);
1279 ((void) cli_id);
1280 ((void) cli_id_len);
1281
Gilles Peskine449bd832023-01-11 14:50:10 +01001282 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001283}
1284
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001285MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001286static int ssl_cookie_check_dummy(void *ctx,
1287 const unsigned char *cookie, size_t cookie_len,
1288 const unsigned char *cli_id, size_t cli_id_len)
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001289{
1290 ((void) ctx);
1291 ((void) cookie);
1292 ((void) cookie_len);
1293 ((void) cli_id);
1294 ((void) cli_id_len);
1295
Gilles Peskine449bd832023-01-11 14:50:10 +01001296 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001297}
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001298#endif /* MBEDTLS_SSL_DTLS_HELLO_VERIFY && MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001299
Paul Bakker5121ce52009-01-03 21:22:43 +00001300/*
1301 * Initialize an SSL context
1302 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001303void mbedtls_ssl_init(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +02001304{
Gilles Peskine449bd832023-01-11 14:50:10 +01001305 memset(ssl, 0, sizeof(mbedtls_ssl_context));
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +02001306}
1307
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001308MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001309static int ssl_conf_version_check(const mbedtls_ssl_context *ssl)
Jerry Yu60835a82021-08-04 10:13:52 +08001310{
Ronald Cron086ee0b2022-03-15 15:18:51 +01001311 const mbedtls_ssl_config *conf = ssl->conf;
1312
Ronald Cron6f135e12021-12-08 16:57:54 +01001313#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01001314 if (mbedtls_ssl_conf_is_tls13_only(conf)) {
1315 if (conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
1316 MBEDTLS_SSL_DEBUG_MSG(1, ("DTLS 1.3 is not yet supported."));
1317 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
XiaokangQianed582dd2022-04-13 08:21:05 +00001318 }
1319
Gilles Peskine449bd832023-01-11 14:50:10 +01001320 MBEDTLS_SSL_DEBUG_MSG(4, ("The SSL configuration is tls13 only."));
1321 return 0;
Jerry Yu60835a82021-08-04 10:13:52 +08001322 }
1323#endif
1324
1325#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01001326 if (mbedtls_ssl_conf_is_tls12_only(conf)) {
1327 MBEDTLS_SSL_DEBUG_MSG(4, ("The SSL configuration is tls12 only."));
1328 return 0;
Jerry Yu60835a82021-08-04 10:13:52 +08001329 }
1330#endif
1331
Ronald Cron6f135e12021-12-08 16:57:54 +01001332#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01001333 if (mbedtls_ssl_conf_is_hybrid_tls12_tls13(conf)) {
1334 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
1335 MBEDTLS_SSL_DEBUG_MSG(1, ("DTLS not yet supported in Hybrid TLS 1.3 + TLS 1.2"));
1336 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
XiaokangQianed582dd2022-04-13 08:21:05 +00001337 }
1338
Gilles Peskine449bd832023-01-11 14:50:10 +01001339 MBEDTLS_SSL_DEBUG_MSG(4, ("The SSL configuration is TLS 1.3 or TLS 1.2."));
1340 return 0;
Jerry Yu60835a82021-08-04 10:13:52 +08001341 }
1342#endif
1343
Gilles Peskine449bd832023-01-11 14:50:10 +01001344 MBEDTLS_SSL_DEBUG_MSG(1, ("The SSL configuration is invalid."));
1345 return MBEDTLS_ERR_SSL_BAD_CONFIG;
Jerry Yu60835a82021-08-04 10:13:52 +08001346}
1347
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001348MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu60835a82021-08-04 10:13:52 +08001349static int ssl_conf_check(const mbedtls_ssl_context *ssl)
1350{
1351 int ret;
Gilles Peskine449bd832023-01-11 14:50:10 +01001352 ret = ssl_conf_version_check(ssl);
1353 if (ret != 0) {
1354 return ret;
1355 }
Jerry Yu60835a82021-08-04 10:13:52 +08001356
Jerry Yudef7ae42022-10-30 14:13:19 +08001357#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
1358 /* RFC 8446 section 4.4.3
1359 *
1360 * If the verification fails, the receiver MUST terminate the handshake with
1361 * a "decrypt_error" alert.
1362 *
1363 * If the client is configured as TLS 1.3 only with optional verify, return
1364 * bad config.
1365 *
1366 */
Pengyu Lv0a1ff2b2023-11-14 11:03:32 +08001367 if (mbedtls_ssl_conf_tls13_is_ephemeral_enabled(
Gilles Peskine449bd832023-01-11 14:50:10 +01001368 (mbedtls_ssl_context *) ssl) &&
Jerry Yudef7ae42022-10-30 14:13:19 +08001369 ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
1370 ssl->conf->max_tls_version == MBEDTLS_SSL_VERSION_TLS1_3 &&
1371 ssl->conf->min_tls_version == MBEDTLS_SSL_VERSION_TLS1_3 &&
Gilles Peskine449bd832023-01-11 14:50:10 +01001372 ssl->conf->authmode == MBEDTLS_SSL_VERIFY_OPTIONAL) {
Jerry Yudef7ae42022-10-30 14:13:19 +08001373 MBEDTLS_SSL_DEBUG_MSG(
Gilles Peskine449bd832023-01-11 14:50:10 +01001374 1, ("Optional verify auth mode "
1375 "is not available for TLS 1.3 client"));
1376 return MBEDTLS_ERR_SSL_BAD_CONFIG;
Jerry Yudef7ae42022-10-30 14:13:19 +08001377 }
1378#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
1379
Yanray Wangb422cab2023-12-01 16:18:10 +08001380 if (ssl->conf->f_rng == NULL) {
1381 MBEDTLS_SSL_DEBUG_MSG(1, ("no RNG provided"));
1382 return MBEDTLS_ERR_SSL_NO_RNG;
1383 }
1384
Jerry Yu60835a82021-08-04 10:13:52 +08001385 /* Space for further checks */
1386
Gilles Peskine449bd832023-01-11 14:50:10 +01001387 return 0;
Jerry Yu60835a82021-08-04 10:13:52 +08001388}
1389
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +02001390/*
1391 * Setup an SSL context
1392 */
Hanno Becker2a43f6f2018-08-10 11:12:52 +01001393
Gilles Peskine449bd832023-01-11 14:50:10 +01001394int mbedtls_ssl_setup(mbedtls_ssl_context *ssl,
1395 const mbedtls_ssl_config *conf)
Paul Bakker5121ce52009-01-03 21:22:43 +00001396{
Janos Follath865b3eb2019-12-16 11:46:15 +00001397 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Darryl Greenb33cc762019-11-28 14:29:44 +00001398 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
1399 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
Paul Bakker5121ce52009-01-03 21:22:43 +00001400
Manuel Pégourié-Gonnarddef0bbe2015-05-04 14:56:36 +02001401 ssl->conf = conf;
Paul Bakker62f2dee2012-09-28 07:31:51 +00001402
Gilles Peskine449bd832023-01-11 14:50:10 +01001403 if ((ret = ssl_conf_check(ssl)) != 0) {
1404 return ret;
1405 }
Ronald Cron8a12aee2023-03-08 15:30:43 +01001406 ssl->tls_version = ssl->conf->max_tls_version;
Jerry Yu60835a82021-08-04 10:13:52 +08001407
Paul Bakker62f2dee2012-09-28 07:31:51 +00001408 /*
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01001409 * Prepare base structures
Paul Bakker62f2dee2012-09-28 07:31:51 +00001410 */
k-stachowiakc9a5f022018-07-24 13:53:31 +02001411
1412 /* Set to NULL in case of an error condition */
1413 ssl->out_buf = NULL;
k-stachowiaka47911c2018-07-04 17:41:58 +02001414
Darryl Greenb33cc762019-11-28 14:29:44 +00001415#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1416 ssl->in_buf_len = in_buf_len;
1417#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001418 ssl->in_buf = mbedtls_calloc(1, in_buf_len);
1419 if (ssl->in_buf == NULL) {
1420 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc(%" MBEDTLS_PRINTF_SIZET " bytes) failed", in_buf_len));
k-stachowiak9f7798e2018-07-31 16:52:32 +02001421 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
k-stachowiaka47911c2018-07-04 17:41:58 +02001422 goto error;
Angus Grattond8213d02016-05-25 20:56:48 +10001423 }
1424
Darryl Greenb33cc762019-11-28 14:29:44 +00001425#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1426 ssl->out_buf_len = out_buf_len;
1427#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001428 ssl->out_buf = mbedtls_calloc(1, out_buf_len);
1429 if (ssl->out_buf == NULL) {
1430 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc(%" MBEDTLS_PRINTF_SIZET " bytes) failed", out_buf_len));
k-stachowiak9f7798e2018-07-31 16:52:32 +02001431 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
k-stachowiaka47911c2018-07-04 17:41:58 +02001432 goto error;
Paul Bakker5121ce52009-01-03 21:22:43 +00001433 }
1434
Gilles Peskine449bd832023-01-11 14:50:10 +01001435 mbedtls_ssl_reset_in_out_pointers(ssl);
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02001436
Johan Pascalb62bb512015-12-03 21:56:45 +01001437#if defined(MBEDTLS_SSL_DTLS_SRTP)
Gilles Peskine449bd832023-01-11 14:50:10 +01001438 memset(&ssl->dtls_srtp_info, 0, sizeof(ssl->dtls_srtp_info));
Johan Pascalb62bb512015-12-03 21:56:45 +01001439#endif
1440
Gilles Peskine449bd832023-01-11 14:50:10 +01001441 if ((ret = ssl_handshake_init(ssl)) != 0) {
k-stachowiaka47911c2018-07-04 17:41:58 +02001442 goto error;
Gilles Peskine449bd832023-01-11 14:50:10 +01001443 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001444
Gilles Peskine449bd832023-01-11 14:50:10 +01001445 return 0;
k-stachowiaka47911c2018-07-04 17:41:58 +02001446
1447error:
Gilles Peskine449bd832023-01-11 14:50:10 +01001448 mbedtls_free(ssl->in_buf);
1449 mbedtls_free(ssl->out_buf);
k-stachowiaka47911c2018-07-04 17:41:58 +02001450
1451 ssl->conf = NULL;
1452
Darryl Greenb33cc762019-11-28 14:29:44 +00001453#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1454 ssl->in_buf_len = 0;
1455 ssl->out_buf_len = 0;
1456#endif
k-stachowiaka47911c2018-07-04 17:41:58 +02001457 ssl->in_buf = NULL;
1458 ssl->out_buf = NULL;
1459
1460 ssl->in_hdr = NULL;
1461 ssl->in_ctr = NULL;
1462 ssl->in_len = NULL;
1463 ssl->in_iv = NULL;
1464 ssl->in_msg = NULL;
1465
1466 ssl->out_hdr = NULL;
1467 ssl->out_ctr = NULL;
1468 ssl->out_len = NULL;
1469 ssl->out_iv = NULL;
1470 ssl->out_msg = NULL;
1471
Gilles Peskine449bd832023-01-11 14:50:10 +01001472 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00001473}
1474
1475/*
Paul Bakker7eb013f2011-10-06 12:37:39 +00001476 * Reset an initialized and used SSL context for re-use while retaining
1477 * all application-set variables, function pointers and data.
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001478 *
1479 * If partial is non-zero, keep data in the input buffer and client ID.
1480 * (Use when a DTLS client reconnects from the same port.)
Paul Bakker7eb013f2011-10-06 12:37:39 +00001481 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001482void mbedtls_ssl_session_reset_msg_layer(mbedtls_ssl_context *ssl,
1483 int partial)
Paul Bakker7eb013f2011-10-06 12:37:39 +00001484{
Darryl Greenb33cc762019-11-28 14:29:44 +00001485#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1486 size_t in_buf_len = ssl->in_buf_len;
1487 size_t out_buf_len = ssl->out_buf_len;
1488#else
1489 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
1490 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
1491#endif
Paul Bakker48916f92012-09-16 19:57:18 +00001492
Hanno Beckerb0302c42021-08-03 09:39:42 +01001493#if !defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE) || !defined(MBEDTLS_SSL_SRV_C)
1494 partial = 0;
Hanno Becker7e772132018-08-10 12:38:21 +01001495#endif
1496
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001497 /* Cancel any possibly running timer */
Gilles Peskine449bd832023-01-11 14:50:10 +01001498 mbedtls_ssl_set_timer(ssl, 0);
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001499
Gilles Peskine449bd832023-01-11 14:50:10 +01001500 mbedtls_ssl_reset_in_out_pointers(ssl);
Hanno Beckerb0302c42021-08-03 09:39:42 +01001501
1502 /* Reset incoming message parsing */
1503 ssl->in_offt = NULL;
1504 ssl->nb_zero = 0;
1505 ssl->in_msgtype = 0;
1506 ssl->in_msglen = 0;
1507 ssl->in_hslen = 0;
1508 ssl->keep_current_message = 0;
1509 ssl->transform_in = NULL;
1510
1511#if defined(MBEDTLS_SSL_PROTO_DTLS)
1512 ssl->next_record_offset = 0;
1513 ssl->in_epoch = 0;
1514#endif
1515
1516 /* Keep current datagram if partial == 1 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001517 if (partial == 0) {
Hanno Beckerb0302c42021-08-03 09:39:42 +01001518 ssl->in_left = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01001519 memset(ssl->in_buf, 0, in_buf_len);
Hanno Beckerb0302c42021-08-03 09:39:42 +01001520 }
1521
Ronald Cronad8c17b2022-06-10 17:18:09 +02001522 ssl->send_alert = 0;
1523
Hanno Beckerb0302c42021-08-03 09:39:42 +01001524 /* Reset outgoing message writing */
1525 ssl->out_msgtype = 0;
1526 ssl->out_msglen = 0;
1527 ssl->out_left = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01001528 memset(ssl->out_buf, 0, out_buf_len);
1529 memset(ssl->cur_out_ctr, 0, sizeof(ssl->cur_out_ctr));
Hanno Beckerb0302c42021-08-03 09:39:42 +01001530 ssl->transform_out = NULL;
1531
1532#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Gilles Peskine449bd832023-01-11 14:50:10 +01001533 mbedtls_ssl_dtls_replay_reset(ssl);
Hanno Beckerb0302c42021-08-03 09:39:42 +01001534#endif
1535
XiaokangQian2b01dc32022-01-21 02:53:13 +00001536#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01001537 if (ssl->transform) {
1538 mbedtls_ssl_transform_free(ssl->transform);
1539 mbedtls_free(ssl->transform);
Hanno Beckerb0302c42021-08-03 09:39:42 +01001540 ssl->transform = NULL;
1541 }
XiaokangQian2b01dc32022-01-21 02:53:13 +00001542#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
1543
XiaokangQian2b01dc32022-01-21 02:53:13 +00001544#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01001545 mbedtls_ssl_transform_free(ssl->transform_application);
1546 mbedtls_free(ssl->transform_application);
XiaokangQian2b01dc32022-01-21 02:53:13 +00001547 ssl->transform_application = NULL;
1548
Gilles Peskine449bd832023-01-11 14:50:10 +01001549 if (ssl->handshake != NULL) {
Jerry Yu3d9b5902022-11-04 14:07:25 +08001550#if defined(MBEDTLS_SSL_EARLY_DATA)
Gilles Peskine449bd832023-01-11 14:50:10 +01001551 mbedtls_ssl_transform_free(ssl->handshake->transform_earlydata);
1552 mbedtls_free(ssl->handshake->transform_earlydata);
XiaokangQian2b01dc32022-01-21 02:53:13 +00001553 ssl->handshake->transform_earlydata = NULL;
Jerry Yu3d9b5902022-11-04 14:07:25 +08001554#endif
XiaokangQian2b01dc32022-01-21 02:53:13 +00001555
Gilles Peskine449bd832023-01-11 14:50:10 +01001556 mbedtls_ssl_transform_free(ssl->handshake->transform_handshake);
1557 mbedtls_free(ssl->handshake->transform_handshake);
XiaokangQian2b01dc32022-01-21 02:53:13 +00001558 ssl->handshake->transform_handshake = NULL;
1559 }
1560
XiaokangQian2b01dc32022-01-21 02:53:13 +00001561#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Beckerb0302c42021-08-03 09:39:42 +01001562}
1563
Gilles Peskine449bd832023-01-11 14:50:10 +01001564int mbedtls_ssl_session_reset_int(mbedtls_ssl_context *ssl, int partial)
Hanno Beckerb0302c42021-08-03 09:39:42 +01001565{
1566 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1567
1568 ssl->state = MBEDTLS_SSL_HELLO_REQUEST;
Ronald Cron195c0bc2024-02-08 08:51:20 +01001569 ssl->tls_version = ssl->conf->max_tls_version;
Hanno Beckerb0302c42021-08-03 09:39:42 +01001570
Gilles Peskine449bd832023-01-11 14:50:10 +01001571 mbedtls_ssl_session_reset_msg_layer(ssl, partial);
Hanno Beckerb0302c42021-08-03 09:39:42 +01001572
1573 /* Reset renegotiation state */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001574#if defined(MBEDTLS_SSL_RENEGOTIATION)
1575 ssl->renego_status = MBEDTLS_SSL_INITIAL_HANDSHAKE;
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001576 ssl->renego_records_seen = 0;
Paul Bakker48916f92012-09-16 19:57:18 +00001577
1578 ssl->verify_data_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01001579 memset(ssl->own_verify_data, 0, MBEDTLS_SSL_VERIFY_DATA_MAX_LEN);
1580 memset(ssl->peer_verify_data, 0, MBEDTLS_SSL_VERIFY_DATA_MAX_LEN);
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001581#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001582 ssl->secure_renegotiation = MBEDTLS_SSL_LEGACY_RENEGOTIATION;
Paul Bakker48916f92012-09-16 19:57:18 +00001583
Hanno Beckerb0302c42021-08-03 09:39:42 +01001584 ssl->session_in = NULL;
Hanno Becker78640902018-08-13 16:35:15 +01001585 ssl->session_out = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01001586 if (ssl->session) {
1587 mbedtls_ssl_session_free(ssl->session);
1588 mbedtls_free(ssl->session);
Paul Bakkerc0463502013-02-14 11:19:38 +01001589 ssl->session = NULL;
1590 }
1591
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001592#if defined(MBEDTLS_SSL_ALPN)
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001593 ssl->alpn_chosen = NULL;
1594#endif
1595
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001596#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
David Horstmann3b2276a2022-10-06 14:49:08 +01001597 int free_cli_id = 1;
Hanno Becker4ccbf062018-08-10 11:20:38 +01001598#if defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE)
Gilles Peskine449bd832023-01-11 14:50:10 +01001599 free_cli_id = (partial == 0);
Hanno Becker4ccbf062018-08-10 11:20:38 +01001600#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001601 if (free_cli_id) {
1602 mbedtls_free(ssl->cli_id);
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001603 ssl->cli_id = NULL;
1604 ssl->cli_id_len = 0;
1605 }
Manuel Pégourié-Gonnard43c02182014-07-22 17:32:01 +02001606#endif
1607
Gilles Peskine449bd832023-01-11 14:50:10 +01001608 if ((ret = ssl_handshake_init(ssl)) != 0) {
1609 return ret;
1610 }
Paul Bakker2770fbd2012-07-03 13:30:23 +00001611
Gilles Peskine449bd832023-01-11 14:50:10 +01001612 return 0;
Paul Bakker7eb013f2011-10-06 12:37:39 +00001613}
1614
Manuel Pégourié-Gonnard779e4292013-08-03 13:50:48 +02001615/*
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001616 * Reset an initialized and used SSL context for re-use while retaining
1617 * all application-set variables, function pointers and data.
1618 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001619int mbedtls_ssl_session_reset(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001620{
Gilles Peskine449bd832023-01-11 14:50:10 +01001621 return mbedtls_ssl_session_reset_int(ssl, 0);
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001622}
1623
1624/*
Paul Bakker5121ce52009-01-03 21:22:43 +00001625 * SSL set accessors
1626 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001627void mbedtls_ssl_conf_endpoint(mbedtls_ssl_config *conf, int endpoint)
Paul Bakker5121ce52009-01-03 21:22:43 +00001628{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001629 conf->endpoint = endpoint;
Paul Bakker5121ce52009-01-03 21:22:43 +00001630}
1631
Gilles Peskine449bd832023-01-11 14:50:10 +01001632void mbedtls_ssl_conf_transport(mbedtls_ssl_config *conf, int transport)
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001633{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001634 conf->transport = transport;
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001635}
1636
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001637#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Gilles Peskine449bd832023-01-11 14:50:10 +01001638void mbedtls_ssl_conf_dtls_anti_replay(mbedtls_ssl_config *conf, char mode)
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02001639{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001640 conf->anti_replay = mode;
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02001641}
1642#endif
1643
Gilles Peskine449bd832023-01-11 14:50:10 +01001644void mbedtls_ssl_conf_dtls_badmac_limit(mbedtls_ssl_config *conf, unsigned limit)
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001645{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001646 conf->badmac_limit = limit;
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001647}
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001648
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001649#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker04da1892018-08-14 13:22:10 +01001650
Gilles Peskine449bd832023-01-11 14:50:10 +01001651void mbedtls_ssl_set_datagram_packing(mbedtls_ssl_context *ssl,
1652 unsigned allow_packing)
Hanno Becker04da1892018-08-14 13:22:10 +01001653{
1654 ssl->disable_datagram_packing = !allow_packing;
1655}
1656
Gilles Peskine449bd832023-01-11 14:50:10 +01001657void mbedtls_ssl_conf_handshake_timeout(mbedtls_ssl_config *conf,
1658 uint32_t min, uint32_t max)
Manuel Pégourié-Gonnard905dd242014-10-01 12:03:55 +02001659{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001660 conf->hs_timeout_min = min;
1661 conf->hs_timeout_max = max;
Manuel Pégourié-Gonnard905dd242014-10-01 12:03:55 +02001662}
1663#endif
1664
Gilles Peskine449bd832023-01-11 14:50:10 +01001665void mbedtls_ssl_conf_authmode(mbedtls_ssl_config *conf, int authmode)
Paul Bakker5121ce52009-01-03 21:22:43 +00001666{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001667 conf->authmode = authmode;
Paul Bakker5121ce52009-01-03 21:22:43 +00001668}
1669
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001670#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001671void mbedtls_ssl_conf_verify(mbedtls_ssl_config *conf,
1672 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *),
1673 void *p_vrfy)
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001674{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001675 conf->f_vrfy = f_vrfy;
1676 conf->p_vrfy = p_vrfy;
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001677}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001678#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001679
Gilles Peskine449bd832023-01-11 14:50:10 +01001680void mbedtls_ssl_conf_rng(mbedtls_ssl_config *conf,
1681 int (*f_rng)(void *, unsigned char *, size_t),
1682 void *p_rng)
Paul Bakker5121ce52009-01-03 21:22:43 +00001683{
Manuel Pégourié-Gonnard750e4d72015-05-07 12:35:38 +01001684 conf->f_rng = f_rng;
1685 conf->p_rng = p_rng;
Paul Bakker5121ce52009-01-03 21:22:43 +00001686}
1687
Gilles Peskine449bd832023-01-11 14:50:10 +01001688void mbedtls_ssl_conf_dbg(mbedtls_ssl_config *conf,
1689 void (*f_dbg)(void *, int, const char *, int, const char *),
1690 void *p_dbg)
Paul Bakker5121ce52009-01-03 21:22:43 +00001691{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001692 conf->f_dbg = f_dbg;
1693 conf->p_dbg = p_dbg;
Paul Bakker5121ce52009-01-03 21:22:43 +00001694}
1695
Gilles Peskine449bd832023-01-11 14:50:10 +01001696void mbedtls_ssl_set_bio(mbedtls_ssl_context *ssl,
1697 void *p_bio,
1698 mbedtls_ssl_send_t *f_send,
1699 mbedtls_ssl_recv_t *f_recv,
1700 mbedtls_ssl_recv_timeout_t *f_recv_timeout)
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02001701{
1702 ssl->p_bio = p_bio;
1703 ssl->f_send = f_send;
1704 ssl->f_recv = f_recv;
1705 ssl->f_recv_timeout = f_recv_timeout;
Manuel Pégourié-Gonnard97fd52c2015-05-06 15:38:52 +01001706}
1707
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02001708#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01001709void mbedtls_ssl_set_mtu(mbedtls_ssl_context *ssl, uint16_t mtu)
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02001710{
1711 ssl->mtu = mtu;
1712}
1713#endif
1714
Gilles Peskine449bd832023-01-11 14:50:10 +01001715void mbedtls_ssl_conf_read_timeout(mbedtls_ssl_config *conf, uint32_t timeout)
Manuel Pégourié-Gonnard97fd52c2015-05-06 15:38:52 +01001716{
1717 conf->read_timeout = timeout;
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02001718}
1719
Gilles Peskine449bd832023-01-11 14:50:10 +01001720void mbedtls_ssl_set_timer_cb(mbedtls_ssl_context *ssl,
1721 void *p_timer,
1722 mbedtls_ssl_set_timer_t *f_set_timer,
1723 mbedtls_ssl_get_timer_t *f_get_timer)
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02001724{
1725 ssl->p_timer = p_timer;
1726 ssl->f_set_timer = f_set_timer;
1727 ssl->f_get_timer = f_get_timer;
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001728
1729 /* Make sure we start with no timer running */
Gilles Peskine449bd832023-01-11 14:50:10 +01001730 mbedtls_ssl_set_timer(ssl, 0);
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02001731}
1732
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001733#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001734void mbedtls_ssl_conf_session_cache(mbedtls_ssl_config *conf,
1735 void *p_cache,
1736 mbedtls_ssl_cache_get_t *f_get_cache,
1737 mbedtls_ssl_cache_set_t *f_set_cache)
Paul Bakker5121ce52009-01-03 21:22:43 +00001738{
Manuel Pégourié-Gonnard5cb33082015-05-06 18:06:26 +01001739 conf->p_cache = p_cache;
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001740 conf->f_get_cache = f_get_cache;
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001741 conf->f_set_cache = f_set_cache;
Paul Bakker5121ce52009-01-03 21:22:43 +00001742}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001743#endif /* MBEDTLS_SSL_SRV_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00001744
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001745#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001746int mbedtls_ssl_set_session(mbedtls_ssl_context *ssl, const mbedtls_ssl_session *session)
Paul Bakker5121ce52009-01-03 21:22:43 +00001747{
Janos Follath865b3eb2019-12-16 11:46:15 +00001748 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001749
Gilles Peskine449bd832023-01-11 14:50:10 +01001750 if (ssl == NULL ||
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001751 session == NULL ||
1752 ssl->session_negotiate == NULL ||
Gilles Peskine449bd832023-01-11 14:50:10 +01001753 ssl->conf->endpoint != MBEDTLS_SSL_IS_CLIENT) {
1754 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001755 }
1756
Gilles Peskine449bd832023-01-11 14:50:10 +01001757 if (ssl->handshake->resume == 1) {
1758 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
1759 }
Hanno Beckere810bbc2021-05-14 16:01:05 +01001760
Jerry Yu21092062022-10-10 21:21:31 +08001761#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01001762 if (session->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Ronald Cron8d630842024-04-04 14:05:21 +02001763#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Jerry Yu21092062022-10-10 21:21:31 +08001764 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
Gilles Peskine449bd832023-01-11 14:50:10 +01001765 mbedtls_ssl_ciphersuite_from_id(session->ciphersuite);
Jerry Yu21092062022-10-10 21:21:31 +08001766
Gilles Peskine449bd832023-01-11 14:50:10 +01001767 if (mbedtls_ssl_validate_ciphersuite(
Jerry Yu21092062022-10-10 21:21:31 +08001768 ssl, ciphersuite_info, MBEDTLS_SSL_VERSION_TLS1_3,
Gilles Peskine449bd832023-01-11 14:50:10 +01001769 MBEDTLS_SSL_VERSION_TLS1_3) != 0) {
1770 MBEDTLS_SSL_DEBUG_MSG(4, ("%d is not a valid TLS 1.3 ciphersuite.",
1771 session->ciphersuite));
1772 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jerry Yu21092062022-10-10 21:21:31 +08001773 }
Ronald Cron8d630842024-04-04 14:05:21 +02001774#else
1775 /*
1776 * If session tickets are not enabled, it is not possible to resume a
1777 * TLS 1.3 session, thus do not make any change to the SSL context in
1778 * the first place.
1779 */
1780 return 0;
1781#endif
Jerry Yu40afab62022-10-08 10:42:13 +08001782 }
Jerry Yu21092062022-10-10 21:21:31 +08001783#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yu40afab62022-10-08 10:42:13 +08001784
Gilles Peskine449bd832023-01-11 14:50:10 +01001785 if ((ret = mbedtls_ssl_session_copy(ssl->session_negotiate,
1786 session)) != 0) {
1787 return ret;
1788 }
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001789
Paul Bakker0a597072012-09-25 21:55:46 +00001790 ssl->handshake->resume = 1;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001791
Gilles Peskine449bd832023-01-11 14:50:10 +01001792 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00001793}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001794#endif /* MBEDTLS_SSL_CLI_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00001795
Gilles Peskine449bd832023-01-11 14:50:10 +01001796void mbedtls_ssl_conf_ciphersuites(mbedtls_ssl_config *conf,
1797 const int *ciphersuites)
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001798{
Hanno Beckerd60b6c62021-04-29 12:04:11 +01001799 conf->ciphersuite_list = ciphersuites;
Paul Bakker5121ce52009-01-03 21:22:43 +00001800}
1801
Ronald Cron6f135e12021-12-08 16:57:54 +01001802#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01001803void mbedtls_ssl_conf_tls13_key_exchange_modes(mbedtls_ssl_config *conf,
1804 const int kex_modes)
Hanno Becker71f1ed62021-07-24 06:01:47 +01001805{
Xiaofei Bai746f9482021-11-12 08:53:56 +00001806 conf->tls13_kex_modes = kex_modes & MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_ALL;
Hanno Becker71f1ed62021-07-24 06:01:47 +01001807}
Xiaokang Qian72de95d2022-10-25 02:54:33 +00001808
1809#if defined(MBEDTLS_SSL_EARLY_DATA)
Yanray Wangd5ed36f2023-11-07 11:40:43 +08001810void mbedtls_ssl_conf_early_data(mbedtls_ssl_config *conf,
1811 int early_data_enabled)
Xiaokang Qian72de95d2022-10-25 02:54:33 +00001812{
1813 conf->early_data_enabled = early_data_enabled;
1814}
Jerry Yucc4e0072022-11-22 17:22:22 +08001815
1816#if defined(MBEDTLS_SSL_SRV_C)
Yanray Wang07517612023-11-07 11:47:36 +08001817void mbedtls_ssl_conf_max_early_data_size(
Gilles Peskine449bd832023-01-11 14:50:10 +01001818 mbedtls_ssl_config *conf, uint32_t max_early_data_size)
Jerry Yucc4e0072022-11-22 17:22:22 +08001819{
Jerry Yu39da9852022-12-06 16:58:36 +08001820 conf->max_early_data_size = max_early_data_size;
Jerry Yucc4e0072022-11-22 17:22:22 +08001821}
1822#endif /* MBEDTLS_SSL_SRV_C */
1823
Xiaokang Qian72de95d2022-10-25 02:54:33 +00001824#endif /* MBEDTLS_SSL_EARLY_DATA */
Ronald Cron6f135e12021-12-08 16:57:54 +01001825#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker71f1ed62021-07-24 06:01:47 +01001826
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001827#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001828void mbedtls_ssl_conf_cert_profile(mbedtls_ssl_config *conf,
1829 const mbedtls_x509_crt_profile *profile)
Manuel Pégourié-Gonnard6e3ee3a2015-06-17 10:58:20 +02001830{
1831 conf->cert_profile = profile;
1832}
1833
Gilles Peskine449bd832023-01-11 14:50:10 +01001834static void ssl_key_cert_free(mbedtls_ssl_key_cert *key_cert)
Glenn Strauss36872db2022-01-22 05:06:31 -05001835{
1836 mbedtls_ssl_key_cert *cur = key_cert, *next;
1837
Gilles Peskine449bd832023-01-11 14:50:10 +01001838 while (cur != NULL) {
Glenn Strauss36872db2022-01-22 05:06:31 -05001839 next = cur->next;
Gilles Peskine449bd832023-01-11 14:50:10 +01001840 mbedtls_free(cur);
Glenn Strauss36872db2022-01-22 05:06:31 -05001841 cur = next;
1842 }
1843}
1844
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001845/* Append a new keycert entry to a (possibly empty) list */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001846MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001847static int ssl_append_key_cert(mbedtls_ssl_key_cert **head,
1848 mbedtls_x509_crt *cert,
1849 mbedtls_pk_context *key)
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001850{
niisato8ee24222018-06-25 19:05:48 +09001851 mbedtls_ssl_key_cert *new_cert;
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001852
Gilles Peskine449bd832023-01-11 14:50:10 +01001853 if (cert == NULL) {
Glenn Strauss36872db2022-01-22 05:06:31 -05001854 /* Free list if cert is null */
Gilles Peskine449bd832023-01-11 14:50:10 +01001855 ssl_key_cert_free(*head);
Glenn Strauss36872db2022-01-22 05:06:31 -05001856 *head = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01001857 return 0;
Glenn Strauss36872db2022-01-22 05:06:31 -05001858 }
1859
Gilles Peskine449bd832023-01-11 14:50:10 +01001860 new_cert = mbedtls_calloc(1, sizeof(mbedtls_ssl_key_cert));
1861 if (new_cert == NULL) {
1862 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
1863 }
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001864
niisato8ee24222018-06-25 19:05:48 +09001865 new_cert->cert = cert;
1866 new_cert->key = key;
1867 new_cert->next = NULL;
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001868
Glenn Strauss36872db2022-01-22 05:06:31 -05001869 /* Update head if the list was null, else add to the end */
Gilles Peskine449bd832023-01-11 14:50:10 +01001870 if (*head == NULL) {
niisato8ee24222018-06-25 19:05:48 +09001871 *head = new_cert;
Gilles Peskine449bd832023-01-11 14:50:10 +01001872 } else {
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001873 mbedtls_ssl_key_cert *cur = *head;
Gilles Peskine449bd832023-01-11 14:50:10 +01001874 while (cur->next != NULL) {
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001875 cur = cur->next;
Gilles Peskine449bd832023-01-11 14:50:10 +01001876 }
niisato8ee24222018-06-25 19:05:48 +09001877 cur->next = new_cert;
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001878 }
1879
Gilles Peskine449bd832023-01-11 14:50:10 +01001880 return 0;
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001881}
1882
Gilles Peskine449bd832023-01-11 14:50:10 +01001883int mbedtls_ssl_conf_own_cert(mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001884 mbedtls_x509_crt *own_cert,
Gilles Peskine449bd832023-01-11 14:50:10 +01001885 mbedtls_pk_context *pk_key)
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001886{
Gilles Peskine449bd832023-01-11 14:50:10 +01001887 return ssl_append_key_cert(&conf->key_cert, own_cert, pk_key);
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001888}
1889
Gilles Peskine449bd832023-01-11 14:50:10 +01001890void mbedtls_ssl_conf_ca_chain(mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01001891 mbedtls_x509_crt *ca_chain,
Gilles Peskine449bd832023-01-11 14:50:10 +01001892 mbedtls_x509_crl *ca_crl)
Paul Bakker5121ce52009-01-03 21:22:43 +00001893{
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01001894 conf->ca_chain = ca_chain;
1895 conf->ca_crl = ca_crl;
Hanno Becker5adaad92019-03-27 16:54:37 +00001896
1897#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
1898 /* mbedtls_ssl_conf_ca_chain() and mbedtls_ssl_conf_ca_cb()
1899 * cannot be used together. */
1900 conf->f_ca_cb = NULL;
1901 conf->p_ca_cb = NULL;
1902#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
Paul Bakker5121ce52009-01-03 21:22:43 +00001903}
Hanno Becker5adaad92019-03-27 16:54:37 +00001904
1905#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
Gilles Peskine449bd832023-01-11 14:50:10 +01001906void mbedtls_ssl_conf_ca_cb(mbedtls_ssl_config *conf,
1907 mbedtls_x509_crt_ca_cb_t f_ca_cb,
1908 void *p_ca_cb)
Hanno Becker5adaad92019-03-27 16:54:37 +00001909{
1910 conf->f_ca_cb = f_ca_cb;
1911 conf->p_ca_cb = p_ca_cb;
1912
1913 /* mbedtls_ssl_conf_ca_chain() and mbedtls_ssl_conf_ca_cb()
1914 * cannot be used together. */
1915 conf->ca_chain = NULL;
1916 conf->ca_crl = NULL;
1917}
1918#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001919#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkereb2c6582012-09-27 19:15:01 +00001920
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001921#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01001922const unsigned char *mbedtls_ssl_get_hs_sni(mbedtls_ssl_context *ssl,
1923 size_t *name_len)
Glenn Strauss69894072022-01-24 12:58:00 -05001924{
1925 *name_len = ssl->handshake->sni_name_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01001926 return ssl->handshake->sni_name;
Glenn Strauss69894072022-01-24 12:58:00 -05001927}
1928
Gilles Peskine449bd832023-01-11 14:50:10 +01001929int mbedtls_ssl_set_hs_own_cert(mbedtls_ssl_context *ssl,
1930 mbedtls_x509_crt *own_cert,
1931 mbedtls_pk_context *pk_key)
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001932{
Gilles Peskine449bd832023-01-11 14:50:10 +01001933 return ssl_append_key_cert(&ssl->handshake->sni_key_cert,
1934 own_cert, pk_key);
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001935}
Manuel Pégourié-Gonnard22bfa4b2015-05-11 08:46:37 +02001936
Gilles Peskine449bd832023-01-11 14:50:10 +01001937void mbedtls_ssl_set_hs_ca_chain(mbedtls_ssl_context *ssl,
1938 mbedtls_x509_crt *ca_chain,
1939 mbedtls_x509_crl *ca_crl)
Manuel Pégourié-Gonnard22bfa4b2015-05-11 08:46:37 +02001940{
1941 ssl->handshake->sni_ca_chain = ca_chain;
1942 ssl->handshake->sni_ca_crl = ca_crl;
1943}
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +02001944
Glenn Strauss999ef702022-03-11 01:37:23 -05001945#if defined(MBEDTLS_KEY_EXCHANGE_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01001946void mbedtls_ssl_set_hs_dn_hints(mbedtls_ssl_context *ssl,
1947 const mbedtls_x509_crt *crt)
Glenn Strauss999ef702022-03-11 01:37:23 -05001948{
1949 ssl->handshake->dn_hints = crt;
1950}
1951#endif /* MBEDTLS_KEY_EXCHANGE_CERT_REQ_ALLOWED_ENABLED */
1952
Gilles Peskine449bd832023-01-11 14:50:10 +01001953void mbedtls_ssl_set_hs_authmode(mbedtls_ssl_context *ssl,
1954 int authmode)
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +02001955{
1956 ssl->handshake->sni_authmode = authmode;
1957}
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001958#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
1959
Hanno Becker8927c832019-04-03 12:52:50 +01001960#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001961void mbedtls_ssl_set_verify(mbedtls_ssl_context *ssl,
1962 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *),
1963 void *p_vrfy)
Hanno Becker8927c832019-04-03 12:52:50 +01001964{
1965 ssl->f_vrfy = f_vrfy;
1966 ssl->p_vrfy = p_vrfy;
1967}
1968#endif
1969
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02001970#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02001971
Valerio Setti016f6822022-12-09 14:17:50 +01001972#if defined(MBEDTLS_USE_PSA_CRYPTO)
Przemek Stekielfde11282023-03-13 16:06:09 +01001973static const uint8_t jpake_server_id[] = { 's', 'e', 'r', 'v', 'e', 'r' };
1974static const uint8_t jpake_client_id[] = { 'c', 'l', 'i', 'e', 'n', 't' };
1975
Valerio Setti016f6822022-12-09 14:17:50 +01001976static psa_status_t mbedtls_ssl_set_hs_ecjpake_password_common(
Gilles Peskine449bd832023-01-11 14:50:10 +01001977 mbedtls_ssl_context *ssl,
1978 mbedtls_svc_key_id_t pwd)
Valerio Setti016f6822022-12-09 14:17:50 +01001979{
1980 psa_status_t status;
Valerio Setti016f6822022-12-09 14:17:50 +01001981 psa_pake_cipher_suite_t cipher_suite = psa_pake_cipher_suite_init();
Przemek Stekielfde11282023-03-13 16:06:09 +01001982 const uint8_t *user = NULL;
Przemek Stekiel4cd20312023-03-01 11:11:28 +01001983 size_t user_len = 0;
Przemek Stekielfde11282023-03-13 16:06:09 +01001984 const uint8_t *peer = NULL;
Przemek Stekiel4cd20312023-03-01 11:11:28 +01001985 size_t peer_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01001986 psa_pake_cs_set_algorithm(&cipher_suite, PSA_ALG_JPAKE);
1987 psa_pake_cs_set_primitive(&cipher_suite,
1988 PSA_PAKE_PRIMITIVE(PSA_PAKE_PRIMITIVE_TYPE_ECC,
1989 PSA_ECC_FAMILY_SECP_R1,
1990 256));
1991 psa_pake_cs_set_hash(&cipher_suite, PSA_ALG_SHA_256);
Valerio Setti016f6822022-12-09 14:17:50 +01001992
Gilles Peskine449bd832023-01-11 14:50:10 +01001993 status = psa_pake_setup(&ssl->handshake->psa_pake_ctx, &cipher_suite);
1994 if (status != PSA_SUCCESS) {
Valerio Setti016f6822022-12-09 14:17:50 +01001995 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001996 }
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02001997
Gilles Peskine449bd832023-01-11 14:50:10 +01001998 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Przemek Stekielfde11282023-03-13 16:06:09 +01001999 user = jpake_server_id;
2000 user_len = sizeof(jpake_server_id);
2001 peer = jpake_client_id;
2002 peer_len = sizeof(jpake_client_id);
Gilles Peskine449bd832023-01-11 14:50:10 +01002003 } else {
Przemek Stekielfde11282023-03-13 16:06:09 +01002004 user = jpake_client_id;
2005 user_len = sizeof(jpake_client_id);
2006 peer = jpake_server_id;
2007 peer_len = sizeof(jpake_server_id);
Gilles Peskine449bd832023-01-11 14:50:10 +01002008 }
Neil Armstrongca7d5062022-05-31 14:43:23 +02002009
Przemek Stekiel4cd20312023-03-01 11:11:28 +01002010 status = psa_pake_set_user(&ssl->handshake->psa_pake_ctx, user, user_len);
2011 if (status != PSA_SUCCESS) {
2012 return status;
2013 }
2014
2015 status = psa_pake_set_peer(&ssl->handshake->psa_pake_ctx, peer, peer_len);
Gilles Peskine449bd832023-01-11 14:50:10 +01002016 if (status != PSA_SUCCESS) {
Valerio Setti016f6822022-12-09 14:17:50 +01002017 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01002018 }
Valerio Setti016f6822022-12-09 14:17:50 +01002019
Gilles Peskine449bd832023-01-11 14:50:10 +01002020 status = psa_pake_set_password_key(&ssl->handshake->psa_pake_ctx, pwd);
2021 if (status != PSA_SUCCESS) {
Valerio Setti016f6822022-12-09 14:17:50 +01002022 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01002023 }
Valerio Setti016f6822022-12-09 14:17:50 +01002024
2025 ssl->handshake->psa_pake_ctx_is_ok = 1;
2026
Gilles Peskine449bd832023-01-11 14:50:10 +01002027 return PSA_SUCCESS;
Valerio Setti016f6822022-12-09 14:17:50 +01002028}
2029
Gilles Peskine449bd832023-01-11 14:50:10 +01002030int mbedtls_ssl_set_hs_ecjpake_password(mbedtls_ssl_context *ssl,
2031 const unsigned char *pw,
2032 size_t pw_len)
Valerio Setti016f6822022-12-09 14:17:50 +01002033{
2034 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
2035 psa_status_t status;
2036
Gilles Peskine449bd832023-01-11 14:50:10 +01002037 if (ssl->handshake == NULL || ssl->conf == NULL) {
2038 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Neil Armstrongca7d5062022-05-31 14:43:23 +02002039 }
2040
Gilles Peskine449bd832023-01-11 14:50:10 +01002041 /* Empty password is not valid */
2042 if ((pw == NULL) || (pw_len == 0)) {
2043 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2044 }
2045
2046 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_DERIVE);
2047 psa_set_key_algorithm(&attributes, PSA_ALG_JPAKE);
2048 psa_set_key_type(&attributes, PSA_KEY_TYPE_PASSWORD);
2049
2050 status = psa_import_key(&attributes, pw, pw_len,
2051 &ssl->handshake->psa_pake_password);
2052 if (status != PSA_SUCCESS) {
2053 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
2054 }
2055
2056 status = mbedtls_ssl_set_hs_ecjpake_password_common(ssl,
2057 ssl->handshake->psa_pake_password);
2058 if (status != PSA_SUCCESS) {
2059 psa_destroy_key(ssl->handshake->psa_pake_password);
2060 psa_pake_abort(&ssl->handshake->psa_pake_ctx);
2061 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
2062 }
2063
2064 return 0;
Valerio Setti02c25b52022-11-15 14:08:42 +01002065}
Valerio Settia9a97dc2022-11-28 18:26:16 +01002066
Gilles Peskine449bd832023-01-11 14:50:10 +01002067int mbedtls_ssl_set_hs_ecjpake_password_opaque(mbedtls_ssl_context *ssl,
2068 mbedtls_svc_key_id_t pwd)
Valerio Settia9a97dc2022-11-28 18:26:16 +01002069{
Valerio Settia9a97dc2022-11-28 18:26:16 +01002070 psa_status_t status;
2071
Gilles Peskine449bd832023-01-11 14:50:10 +01002072 if (ssl->handshake == NULL || ssl->conf == NULL) {
2073 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Neil Armstrongca7d5062022-05-31 14:43:23 +02002074 }
2075
Gilles Peskine449bd832023-01-11 14:50:10 +01002076 if (mbedtls_svc_key_id_is_null(pwd)) {
2077 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2078 }
2079
2080 status = mbedtls_ssl_set_hs_ecjpake_password_common(ssl, pwd);
2081 if (status != PSA_SUCCESS) {
2082 psa_pake_abort(&ssl->handshake->psa_pake_ctx);
2083 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
2084 }
2085
2086 return 0;
Valerio Setti02c25b52022-11-15 14:08:42 +01002087}
2088#else /* MBEDTLS_USE_PSA_CRYPTO */
Gilles Peskine449bd832023-01-11 14:50:10 +01002089int mbedtls_ssl_set_hs_ecjpake_password(mbedtls_ssl_context *ssl,
2090 const unsigned char *pw,
2091 size_t pw_len)
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002092{
2093 mbedtls_ecjpake_role role;
2094
Gilles Peskine449bd832023-01-11 14:50:10 +01002095 if (ssl->handshake == NULL || ssl->conf == NULL) {
2096 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2097 }
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002098
Valerio Settic689ed82022-12-07 14:40:38 +01002099 /* Empty password is not valid */
Gilles Peskine449bd832023-01-11 14:50:10 +01002100 if ((pw == NULL) || (pw_len == 0)) {
2101 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2102 }
Valerio Settic689ed82022-12-07 14:40:38 +01002103
Gilles Peskine449bd832023-01-11 14:50:10 +01002104 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002105 role = MBEDTLS_ECJPAKE_SERVER;
Gilles Peskine449bd832023-01-11 14:50:10 +01002106 } else {
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002107 role = MBEDTLS_ECJPAKE_CLIENT;
Gilles Peskine449bd832023-01-11 14:50:10 +01002108 }
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002109
Gilles Peskine449bd832023-01-11 14:50:10 +01002110 return mbedtls_ecjpake_setup(&ssl->handshake->ecjpake_ctx,
2111 role,
2112 MBEDTLS_MD_SHA256,
2113 MBEDTLS_ECP_DP_SECP256R1,
2114 pw, pw_len);
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002115}
Valerio Setti02c25b52022-11-15 14:08:42 +01002116#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02002117#endif /* MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED */
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002118
Ronald Cron73fe8df2022-10-05 14:31:43 +02002119#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01002120int mbedtls_ssl_conf_has_static_psk(mbedtls_ssl_config const *conf)
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002121{
Gilles Peskine449bd832023-01-11 14:50:10 +01002122 if (conf->psk_identity == NULL ||
2123 conf->psk_identity_len == 0) {
2124 return 0;
Ronald Crond29e13e2022-10-19 10:33:48 +02002125 }
2126
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002127#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01002128 if (!mbedtls_svc_key_id_is_null(conf->psk_opaque)) {
2129 return 1;
2130 }
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002131#endif /* MBEDTLS_USE_PSA_CRYPTO */
Ronald Crond29e13e2022-10-19 10:33:48 +02002132
Gilles Peskine449bd832023-01-11 14:50:10 +01002133 if (conf->psk != NULL && conf->psk_len != 0) {
2134 return 1;
2135 }
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002136
Gilles Peskine449bd832023-01-11 14:50:10 +01002137 return 0;
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002138}
2139
Gilles Peskine449bd832023-01-11 14:50:10 +01002140static void ssl_conf_remove_psk(mbedtls_ssl_config *conf)
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002141{
2142 /* Remove reference to existing PSK, if any. */
2143#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01002144 if (!mbedtls_svc_key_id_is_null(conf->psk_opaque)) {
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002145 /* The maintenance of the PSK key slot is the
2146 * user's responsibility. */
Ronald Croncf56a0a2020-08-04 09:51:30 +02002147 conf->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002148 }
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002149#endif /* MBEDTLS_USE_PSA_CRYPTO */
Gilles Peskine449bd832023-01-11 14:50:10 +01002150 if (conf->psk != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01002151 mbedtls_zeroize_and_free(conf->psk, conf->psk_len);
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002152 conf->psk = NULL;
2153 conf->psk_len = 0;
2154 }
2155
2156 /* Remove reference to PSK identity, if any. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002157 if (conf->psk_identity != NULL) {
2158 mbedtls_free(conf->psk_identity);
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002159 conf->psk_identity = NULL;
2160 conf->psk_identity_len = 0;
2161 }
2162}
2163
Hanno Becker7390c712018-11-15 13:33:04 +00002164/* This function assumes that PSK identity in the SSL config is unset.
2165 * It checks that the provided identity is well-formed and attempts
2166 * to make a copy of it in the SSL config.
2167 * On failure, the PSK identity in the config remains unset. */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002168MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002169static int ssl_conf_set_psk_identity(mbedtls_ssl_config *conf,
2170 unsigned char const *psk_identity,
2171 size_t psk_identity_len)
Paul Bakkerd4a56ec2013-04-16 18:05:29 +02002172{
Manuel Pégourié-Gonnardc6b5d832015-08-27 16:37:35 +02002173 /* Identity len will be encoded on two bytes */
Gilles Peskine449bd832023-01-11 14:50:10 +01002174 if (psk_identity == NULL ||
Ronald Cron2a87e9b2022-10-19 10:55:26 +02002175 psk_identity_len == 0 ||
Gilles Peskine449bd832023-01-11 14:50:10 +01002176 (psk_identity_len >> 16) != 0 ||
2177 psk_identity_len > MBEDTLS_SSL_OUT_CONTENT_LEN) {
2178 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnardc6b5d832015-08-27 16:37:35 +02002179 }
2180
Gilles Peskine449bd832023-01-11 14:50:10 +01002181 conf->psk_identity = mbedtls_calloc(1, psk_identity_len);
2182 if (conf->psk_identity == NULL) {
2183 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
2184 }
Paul Bakker6db455e2013-09-18 17:29:31 +02002185
Manuel Pégourié-Gonnard120fdbd2015-05-07 17:07:50 +01002186 conf->psk_identity_len = psk_identity_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01002187 memcpy(conf->psk_identity, psk_identity, conf->psk_identity_len);
Paul Bakker5ad403f2013-09-18 21:21:30 +02002188
Gilles Peskine449bd832023-01-11 14:50:10 +01002189 return 0;
Paul Bakker6db455e2013-09-18 17:29:31 +02002190}
2191
Gilles Peskine449bd832023-01-11 14:50:10 +01002192int mbedtls_ssl_conf_psk(mbedtls_ssl_config *conf,
2193 const unsigned char *psk, size_t psk_len,
2194 const unsigned char *psk_identity, size_t psk_identity_len)
Hanno Becker7390c712018-11-15 13:33:04 +00002195{
Janos Follath865b3eb2019-12-16 11:46:15 +00002196 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002197
2198 /* We currently only support one PSK, raw or opaque. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002199 if (mbedtls_ssl_conf_has_static_psk(conf)) {
2200 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
2201 }
Hanno Becker7390c712018-11-15 13:33:04 +00002202
2203 /* Check and set raw PSK */
Gilles Peskine449bd832023-01-11 14:50:10 +01002204 if (psk == NULL) {
2205 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2206 }
2207 if (psk_len == 0) {
2208 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2209 }
2210 if (psk_len > MBEDTLS_PSK_MAX_LEN) {
2211 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2212 }
Piotr Nowicki9926eaf2019-11-20 14:54:36 +01002213
Gilles Peskine449bd832023-01-11 14:50:10 +01002214 if ((conf->psk = mbedtls_calloc(1, psk_len)) == NULL) {
2215 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
2216 }
Hanno Becker7390c712018-11-15 13:33:04 +00002217 conf->psk_len = psk_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01002218 memcpy(conf->psk, psk, conf->psk_len);
Hanno Becker7390c712018-11-15 13:33:04 +00002219
2220 /* Check and set PSK Identity */
Gilles Peskine449bd832023-01-11 14:50:10 +01002221 ret = ssl_conf_set_psk_identity(conf, psk_identity, psk_identity_len);
2222 if (ret != 0) {
2223 ssl_conf_remove_psk(conf);
2224 }
Hanno Becker7390c712018-11-15 13:33:04 +00002225
Gilles Peskine449bd832023-01-11 14:50:10 +01002226 return ret;
Hanno Becker7390c712018-11-15 13:33:04 +00002227}
2228
Gilles Peskine449bd832023-01-11 14:50:10 +01002229static void ssl_remove_psk(mbedtls_ssl_context *ssl)
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002230{
2231#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01002232 if (!mbedtls_svc_key_id_is_null(ssl->handshake->psk_opaque)) {
Neil Armstrong501c9322022-05-03 09:35:09 +02002233 /* The maintenance of the external PSK key slot is the
2234 * user's responsibility. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002235 if (ssl->handshake->psk_opaque_is_internal) {
2236 psa_destroy_key(ssl->handshake->psk_opaque);
Neil Armstrong501c9322022-05-03 09:35:09 +02002237 ssl->handshake->psk_opaque_is_internal = 0;
2238 }
Ronald Croncf56a0a2020-08-04 09:51:30 +02002239 ssl->handshake->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002240 }
Neil Armstronge952a302022-05-03 10:22:14 +02002241#else
Gilles Peskine449bd832023-01-11 14:50:10 +01002242 if (ssl->handshake->psk != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01002243 mbedtls_zeroize_and_free(ssl->handshake->psk,
Gilles Peskine449bd832023-01-11 14:50:10 +01002244 ssl->handshake->psk_len);
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002245 ssl->handshake->psk_len = 0;
lhuang046d4d94f2024-06-11 12:37:02 -07002246 ssl->handshake->psk = NULL;
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002247 }
Neil Armstronge952a302022-05-03 10:22:14 +02002248#endif /* MBEDTLS_USE_PSA_CRYPTO */
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002249}
2250
Gilles Peskine449bd832023-01-11 14:50:10 +01002251int mbedtls_ssl_set_hs_psk(mbedtls_ssl_context *ssl,
2252 const unsigned char *psk, size_t psk_len)
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002253{
Neil Armstrong501c9322022-05-03 09:35:09 +02002254#if defined(MBEDTLS_USE_PSA_CRYPTO)
2255 psa_key_attributes_t key_attributes = psa_key_attributes_init();
Jerry Yu5d01c052022-08-17 10:18:10 +08002256 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Jerry Yu24b8c812022-08-20 19:06:56 +08002257 psa_algorithm_t alg = PSA_ALG_NONE;
Jerry Yu5d01c052022-08-17 10:18:10 +08002258 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Neil Armstrong501c9322022-05-03 09:35:09 +02002259#endif /* MBEDTLS_USE_PSA_CRYPTO */
2260
Gilles Peskine449bd832023-01-11 14:50:10 +01002261 if (psk == NULL || ssl->handshake == NULL) {
2262 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2263 }
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002264
Gilles Peskine449bd832023-01-11 14:50:10 +01002265 if (psk_len > MBEDTLS_PSK_MAX_LEN) {
2266 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2267 }
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002268
Gilles Peskine449bd832023-01-11 14:50:10 +01002269 ssl_remove_psk(ssl);
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002270
Neil Armstrong501c9322022-05-03 09:35:09 +02002271#if defined(MBEDTLS_USE_PSA_CRYPTO)
Jerry Yuccc68a42022-07-26 16:39:20 +08002272#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01002273 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_2) {
2274 if (ssl->handshake->ciphersuite_info->mac == MBEDTLS_MD_SHA384) {
2275 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_384);
2276 } else {
2277 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_256);
2278 }
2279 psa_set_key_usage_flags(&key_attributes, PSA_KEY_USAGE_DERIVE);
Jerry Yuccc68a42022-07-26 16:39:20 +08002280 }
2281#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Neil Armstrong501c9322022-05-03 09:35:09 +02002282
Jerry Yu568ec252022-07-22 21:27:34 +08002283#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01002284 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
2285 alg = PSA_ALG_HKDF_EXTRACT(PSA_ALG_ANY_HASH);
2286 psa_set_key_usage_flags(&key_attributes,
2287 PSA_KEY_USAGE_DERIVE | PSA_KEY_USAGE_EXPORT);
Jerry Yuccc68a42022-07-26 16:39:20 +08002288 }
2289#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
2290
Gilles Peskine449bd832023-01-11 14:50:10 +01002291 psa_set_key_algorithm(&key_attributes, alg);
2292 psa_set_key_type(&key_attributes, PSA_KEY_TYPE_DERIVE);
Neil Armstrong501c9322022-05-03 09:35:09 +02002293
Gilles Peskine449bd832023-01-11 14:50:10 +01002294 status = psa_import_key(&key_attributes, psk, psk_len, &key);
2295 if (status != PSA_SUCCESS) {
2296 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
2297 }
Neil Armstrong501c9322022-05-03 09:35:09 +02002298
2299 /* Allow calling psa_destroy_key() on psk remove */
2300 ssl->handshake->psk_opaque_is_internal = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01002301 return mbedtls_ssl_set_hs_psk_opaque(ssl, key);
Neil Armstrong501c9322022-05-03 09:35:09 +02002302#else
Gilles Peskine449bd832023-01-11 14:50:10 +01002303 if ((ssl->handshake->psk = mbedtls_calloc(1, psk_len)) == NULL) {
2304 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
2305 }
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002306
2307 ssl->handshake->psk_len = psk_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01002308 memcpy(ssl->handshake->psk, psk, ssl->handshake->psk_len);
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002309
Gilles Peskine449bd832023-01-11 14:50:10 +01002310 return 0;
Neil Armstrong501c9322022-05-03 09:35:09 +02002311#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002312}
2313
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002314#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01002315int mbedtls_ssl_conf_psk_opaque(mbedtls_ssl_config *conf,
2316 mbedtls_svc_key_id_t psk,
2317 const unsigned char *psk_identity,
2318 size_t psk_identity_len)
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002319{
Janos Follath865b3eb2019-12-16 11:46:15 +00002320 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002321
2322 /* We currently only support one PSK, raw or opaque. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002323 if (mbedtls_ssl_conf_has_static_psk(conf)) {
2324 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
2325 }
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002326
Hanno Becker7390c712018-11-15 13:33:04 +00002327 /* Check and set opaque PSK */
Gilles Peskine449bd832023-01-11 14:50:10 +01002328 if (mbedtls_svc_key_id_is_null(psk)) {
2329 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2330 }
Ronald Croncf56a0a2020-08-04 09:51:30 +02002331 conf->psk_opaque = psk;
Hanno Becker7390c712018-11-15 13:33:04 +00002332
2333 /* Check and set PSK Identity */
Gilles Peskine449bd832023-01-11 14:50:10 +01002334 ret = ssl_conf_set_psk_identity(conf, psk_identity,
2335 psk_identity_len);
2336 if (ret != 0) {
2337 ssl_conf_remove_psk(conf);
2338 }
Hanno Becker7390c712018-11-15 13:33:04 +00002339
Gilles Peskine449bd832023-01-11 14:50:10 +01002340 return ret;
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002341}
2342
Gilles Peskine449bd832023-01-11 14:50:10 +01002343int mbedtls_ssl_set_hs_psk_opaque(mbedtls_ssl_context *ssl,
2344 mbedtls_svc_key_id_t psk)
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002345{
Gilles Peskine449bd832023-01-11 14:50:10 +01002346 if ((mbedtls_svc_key_id_is_null(psk)) ||
2347 (ssl->handshake == NULL)) {
2348 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2349 }
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002350
Gilles Peskine449bd832023-01-11 14:50:10 +01002351 ssl_remove_psk(ssl);
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002352 ssl->handshake->psk_opaque = psk;
Gilles Peskine449bd832023-01-11 14:50:10 +01002353 return 0;
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002354}
2355#endif /* MBEDTLS_USE_PSA_CRYPTO */
2356
Jerry Yu8897c072022-08-12 13:56:53 +08002357#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002358void mbedtls_ssl_conf_psk_cb(mbedtls_ssl_config *conf,
2359 int (*f_psk)(void *, mbedtls_ssl_context *, const unsigned char *,
2360 size_t),
2361 void *p_psk)
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002362{
2363 conf->f_psk = f_psk;
2364 conf->p_psk = p_psk;
2365}
Jerry Yu8897c072022-08-12 13:56:53 +08002366#endif /* MBEDTLS_SSL_SRV_C */
2367
Ronald Cron73fe8df2022-10-05 14:31:43 +02002368#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED */
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002369
2370#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine301711e2022-04-26 16:57:05 +02002371static mbedtls_ssl_mode_t mbedtls_ssl_get_base_mode(
Gilles Peskine449bd832023-01-11 14:50:10 +01002372 psa_algorithm_t alg)
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002373{
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002374#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01002375 if (alg == PSA_ALG_CBC_NO_PADDING) {
2376 return MBEDTLS_SSL_MODE_CBC;
2377 }
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002378#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
Gilles Peskine449bd832023-01-11 14:50:10 +01002379 if (PSA_ALG_IS_AEAD(alg)) {
2380 return MBEDTLS_SSL_MODE_AEAD;
2381 }
2382 return MBEDTLS_SSL_MODE_STREAM;
Gilles Peskine301711e2022-04-26 16:57:05 +02002383}
2384
2385#else /* MBEDTLS_USE_PSA_CRYPTO */
2386
2387static mbedtls_ssl_mode_t mbedtls_ssl_get_base_mode(
Gilles Peskine449bd832023-01-11 14:50:10 +01002388 mbedtls_cipher_mode_t mode)
Gilles Peskine301711e2022-04-26 16:57:05 +02002389{
2390#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01002391 if (mode == MBEDTLS_MODE_CBC) {
2392 return MBEDTLS_SSL_MODE_CBC;
2393 }
Gilles Peskine301711e2022-04-26 16:57:05 +02002394#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
2395
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002396#if defined(MBEDTLS_GCM_C) || \
2397 defined(MBEDTLS_CCM_C) || \
2398 defined(MBEDTLS_CHACHAPOLY_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002399 if (mode == MBEDTLS_MODE_GCM ||
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002400 mode == MBEDTLS_MODE_CCM ||
Gilles Peskine449bd832023-01-11 14:50:10 +01002401 mode == MBEDTLS_MODE_CHACHAPOLY) {
2402 return MBEDTLS_SSL_MODE_AEAD;
2403 }
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002404#endif /* MBEDTLS_GCM_C || MBEDTLS_CCM_C || MBEDTLS_CHACHAPOLY_C */
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002405
Gilles Peskine449bd832023-01-11 14:50:10 +01002406 return MBEDTLS_SSL_MODE_STREAM;
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002407}
Gilles Peskine301711e2022-04-26 16:57:05 +02002408#endif /* MBEDTLS_USE_PSA_CRYPTO */
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002409
Gilles Peskinee108d982022-04-26 16:50:40 +02002410static mbedtls_ssl_mode_t mbedtls_ssl_get_actual_mode(
2411 mbedtls_ssl_mode_t base_mode,
Gilles Peskine449bd832023-01-11 14:50:10 +01002412 int encrypt_then_mac)
Gilles Peskinee108d982022-04-26 16:50:40 +02002413{
2414#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01002415 if (encrypt_then_mac == MBEDTLS_SSL_ETM_ENABLED &&
2416 base_mode == MBEDTLS_SSL_MODE_CBC) {
2417 return MBEDTLS_SSL_MODE_CBC_ETM;
Gilles Peskinee108d982022-04-26 16:50:40 +02002418 }
2419#else
2420 (void) encrypt_then_mac;
2421#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002422 return base_mode;
Gilles Peskinee108d982022-04-26 16:50:40 +02002423}
2424
Neil Armstrongab555e02022-04-04 11:07:59 +02002425mbedtls_ssl_mode_t mbedtls_ssl_get_mode_from_transform(
Gilles Peskine449bd832023-01-11 14:50:10 +01002426 const mbedtls_ssl_transform *transform)
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002427{
Gilles Peskinee108d982022-04-26 16:50:40 +02002428 mbedtls_ssl_mode_t base_mode = mbedtls_ssl_get_base_mode(
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002429#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01002430 transform->psa_alg
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002431#else
Gilles Peskine449bd832023-01-11 14:50:10 +01002432 mbedtls_cipher_get_cipher_mode(&transform->cipher_ctx_enc)
Gilles Peskinee108d982022-04-26 16:50:40 +02002433#endif
2434 );
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002435
Gilles Peskinee108d982022-04-26 16:50:40 +02002436 int encrypt_then_mac = 0;
Neil Armstrongf2c82f02022-04-05 11:16:53 +02002437#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskinee108d982022-04-26 16:50:40 +02002438 encrypt_then_mac = transform->encrypt_then_mac;
2439#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002440 return mbedtls_ssl_get_actual_mode(base_mode, encrypt_then_mac);
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002441}
2442
Neil Armstrongab555e02022-04-04 11:07:59 +02002443mbedtls_ssl_mode_t mbedtls_ssl_get_mode_from_ciphersuite(
Neil Armstrongf2c82f02022-04-05 11:16:53 +02002444#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01002445 int encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02002446#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01002447 const mbedtls_ssl_ciphersuite_t *suite)
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002448{
Gilles Peskinee108d982022-04-26 16:50:40 +02002449 mbedtls_ssl_mode_t base_mode = MBEDTLS_SSL_MODE_STREAM;
2450
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002451#if defined(MBEDTLS_USE_PSA_CRYPTO)
2452 psa_status_t status;
2453 psa_algorithm_t alg;
2454 psa_key_type_t type;
2455 size_t size;
Dave Rodgman2eab4622023-10-05 13:30:37 +01002456 status = mbedtls_ssl_cipher_to_psa((mbedtls_cipher_type_t) suite->cipher,
2457 0, &alg, &type, &size);
Gilles Peskine449bd832023-01-11 14:50:10 +01002458 if (status == PSA_SUCCESS) {
2459 base_mode = mbedtls_ssl_get_base_mode(alg);
2460 }
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002461#else
2462 const mbedtls_cipher_info_t *cipher =
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01002463 mbedtls_cipher_info_from_type((mbedtls_cipher_type_t) suite->cipher);
Gilles Peskine449bd832023-01-11 14:50:10 +01002464 if (cipher != NULL) {
Gilles Peskinee108d982022-04-26 16:50:40 +02002465 base_mode =
2466 mbedtls_ssl_get_base_mode(
Gilles Peskine449bd832023-01-11 14:50:10 +01002467 mbedtls_cipher_info_get_mode(cipher));
Gilles Peskinee108d982022-04-26 16:50:40 +02002468 }
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002469#endif /* MBEDTLS_USE_PSA_CRYPTO */
2470
Gilles Peskinee108d982022-04-26 16:50:40 +02002471#if !defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
2472 int encrypt_then_mac = 0;
2473#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002474 return mbedtls_ssl_get_actual_mode(base_mode, encrypt_then_mac);
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002475}
2476
Neil Armstrong8395d7a2022-05-18 11:44:56 +02002477#if defined(MBEDTLS_USE_PSA_CRYPTO) || defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yu251a12e2022-07-13 15:15:48 +08002478
Gilles Peskine449bd832023-01-11 14:50:10 +01002479psa_status_t mbedtls_ssl_cipher_to_psa(mbedtls_cipher_type_t mbedtls_cipher_type,
2480 size_t taglen,
2481 psa_algorithm_t *alg,
2482 psa_key_type_t *key_type,
2483 size_t *key_size)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002484{
Yanray Wang19e4dc82023-11-16 18:02:05 +08002485#if !defined(MBEDTLS_SSL_HAVE_CCM)
2486 (void) taglen;
2487#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002488 switch (mbedtls_cipher_type) {
Yanray Wang1a369d62023-11-16 15:17:31 +08002489#if defined(MBEDTLS_SSL_HAVE_AES) && defined(MBEDTLS_SSL_HAVE_CBC)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002490 case MBEDTLS_CIPHER_AES_128_CBC:
2491 *alg = PSA_ALG_CBC_NO_PADDING;
2492 *key_type = PSA_KEY_TYPE_AES;
2493 *key_size = 128;
2494 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002495#endif
2496#if defined(MBEDTLS_SSL_HAVE_AES) && defined(MBEDTLS_SSL_HAVE_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002497 case MBEDTLS_CIPHER_AES_128_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002498 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002499 *key_type = PSA_KEY_TYPE_AES;
2500 *key_size = 128;
2501 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002502#endif
2503#if defined(MBEDTLS_SSL_HAVE_AES) && defined(MBEDTLS_SSL_HAVE_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002504 case MBEDTLS_CIPHER_AES_128_GCM:
2505 *alg = PSA_ALG_GCM;
2506 *key_type = PSA_KEY_TYPE_AES;
2507 *key_size = 128;
2508 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002509#endif
2510#if defined(MBEDTLS_SSL_HAVE_AES) && defined(MBEDTLS_SSL_HAVE_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002511 case MBEDTLS_CIPHER_AES_192_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002512 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002513 *key_type = PSA_KEY_TYPE_AES;
2514 *key_size = 192;
2515 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002516#endif
2517#if defined(MBEDTLS_SSL_HAVE_AES) && defined(MBEDTLS_SSL_HAVE_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002518 case MBEDTLS_CIPHER_AES_192_GCM:
2519 *alg = PSA_ALG_GCM;
2520 *key_type = PSA_KEY_TYPE_AES;
2521 *key_size = 192;
2522 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002523#endif
2524#if defined(MBEDTLS_SSL_HAVE_AES) && defined(MBEDTLS_SSL_HAVE_CBC)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002525 case MBEDTLS_CIPHER_AES_256_CBC:
2526 *alg = PSA_ALG_CBC_NO_PADDING;
2527 *key_type = PSA_KEY_TYPE_AES;
2528 *key_size = 256;
2529 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002530#endif
2531#if defined(MBEDTLS_SSL_HAVE_AES) && defined(MBEDTLS_SSL_HAVE_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002532 case MBEDTLS_CIPHER_AES_256_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002533 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002534 *key_type = PSA_KEY_TYPE_AES;
2535 *key_size = 256;
2536 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002537#endif
2538#if defined(MBEDTLS_SSL_HAVE_AES) && defined(MBEDTLS_SSL_HAVE_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002539 case MBEDTLS_CIPHER_AES_256_GCM:
2540 *alg = PSA_ALG_GCM;
2541 *key_type = PSA_KEY_TYPE_AES;
2542 *key_size = 256;
2543 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002544#endif
2545#if defined(MBEDTLS_SSL_HAVE_ARIA) && defined(MBEDTLS_SSL_HAVE_CBC)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002546 case MBEDTLS_CIPHER_ARIA_128_CBC:
2547 *alg = PSA_ALG_CBC_NO_PADDING;
2548 *key_type = PSA_KEY_TYPE_ARIA;
2549 *key_size = 128;
2550 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002551#endif
2552#if defined(MBEDTLS_SSL_HAVE_ARIA) && defined(MBEDTLS_SSL_HAVE_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002553 case MBEDTLS_CIPHER_ARIA_128_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002554 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002555 *key_type = PSA_KEY_TYPE_ARIA;
2556 *key_size = 128;
2557 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002558#endif
2559#if defined(MBEDTLS_SSL_HAVE_ARIA) && defined(MBEDTLS_SSL_HAVE_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002560 case MBEDTLS_CIPHER_ARIA_128_GCM:
2561 *alg = PSA_ALG_GCM;
2562 *key_type = PSA_KEY_TYPE_ARIA;
2563 *key_size = 128;
2564 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002565#endif
2566#if defined(MBEDTLS_SSL_HAVE_ARIA) && defined(MBEDTLS_SSL_HAVE_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002567 case MBEDTLS_CIPHER_ARIA_192_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002568 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002569 *key_type = PSA_KEY_TYPE_ARIA;
2570 *key_size = 192;
2571 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002572#endif
2573#if defined(MBEDTLS_SSL_HAVE_ARIA) && defined(MBEDTLS_SSL_HAVE_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002574 case MBEDTLS_CIPHER_ARIA_192_GCM:
2575 *alg = PSA_ALG_GCM;
2576 *key_type = PSA_KEY_TYPE_ARIA;
2577 *key_size = 192;
2578 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002579#endif
2580#if defined(MBEDTLS_SSL_HAVE_ARIA) && defined(MBEDTLS_SSL_HAVE_CBC)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002581 case MBEDTLS_CIPHER_ARIA_256_CBC:
2582 *alg = PSA_ALG_CBC_NO_PADDING;
2583 *key_type = PSA_KEY_TYPE_ARIA;
2584 *key_size = 256;
2585 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002586#endif
2587#if defined(MBEDTLS_SSL_HAVE_ARIA) && defined(MBEDTLS_SSL_HAVE_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002588 case MBEDTLS_CIPHER_ARIA_256_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002589 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002590 *key_type = PSA_KEY_TYPE_ARIA;
2591 *key_size = 256;
2592 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002593#endif
2594#if defined(MBEDTLS_SSL_HAVE_ARIA) && defined(MBEDTLS_SSL_HAVE_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002595 case MBEDTLS_CIPHER_ARIA_256_GCM:
2596 *alg = PSA_ALG_GCM;
2597 *key_type = PSA_KEY_TYPE_ARIA;
2598 *key_size = 256;
2599 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002600#endif
2601#if defined(MBEDTLS_SSL_HAVE_CAMELLIA) && defined(MBEDTLS_SSL_HAVE_CBC)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002602 case MBEDTLS_CIPHER_CAMELLIA_128_CBC:
2603 *alg = PSA_ALG_CBC_NO_PADDING;
2604 *key_type = PSA_KEY_TYPE_CAMELLIA;
2605 *key_size = 128;
2606 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002607#endif
2608#if defined(MBEDTLS_SSL_HAVE_CAMELLIA) && defined(MBEDTLS_SSL_HAVE_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002609 case MBEDTLS_CIPHER_CAMELLIA_128_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002610 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002611 *key_type = PSA_KEY_TYPE_CAMELLIA;
2612 *key_size = 128;
2613 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002614#endif
2615#if defined(MBEDTLS_SSL_HAVE_CAMELLIA) && defined(MBEDTLS_SSL_HAVE_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002616 case MBEDTLS_CIPHER_CAMELLIA_128_GCM:
2617 *alg = PSA_ALG_GCM;
2618 *key_type = PSA_KEY_TYPE_CAMELLIA;
2619 *key_size = 128;
2620 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002621#endif
2622#if defined(MBEDTLS_SSL_HAVE_CAMELLIA) && defined(MBEDTLS_SSL_HAVE_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002623 case MBEDTLS_CIPHER_CAMELLIA_192_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002624 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002625 *key_type = PSA_KEY_TYPE_CAMELLIA;
2626 *key_size = 192;
2627 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002628#endif
2629#if defined(MBEDTLS_SSL_HAVE_CAMELLIA) && defined(MBEDTLS_SSL_HAVE_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002630 case MBEDTLS_CIPHER_CAMELLIA_192_GCM:
2631 *alg = PSA_ALG_GCM;
2632 *key_type = PSA_KEY_TYPE_CAMELLIA;
2633 *key_size = 192;
2634 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002635#endif
2636#if defined(MBEDTLS_SSL_HAVE_CAMELLIA) && defined(MBEDTLS_SSL_HAVE_CBC)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002637 case MBEDTLS_CIPHER_CAMELLIA_256_CBC:
2638 *alg = PSA_ALG_CBC_NO_PADDING;
2639 *key_type = PSA_KEY_TYPE_CAMELLIA;
2640 *key_size = 256;
2641 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002642#endif
2643#if defined(MBEDTLS_SSL_HAVE_CAMELLIA) && defined(MBEDTLS_SSL_HAVE_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002644 case MBEDTLS_CIPHER_CAMELLIA_256_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002645 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002646 *key_type = PSA_KEY_TYPE_CAMELLIA;
2647 *key_size = 256;
2648 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002649#endif
2650#if defined(MBEDTLS_SSL_HAVE_CAMELLIA) && defined(MBEDTLS_SSL_HAVE_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002651 case MBEDTLS_CIPHER_CAMELLIA_256_GCM:
2652 *alg = PSA_ALG_GCM;
2653 *key_type = PSA_KEY_TYPE_CAMELLIA;
2654 *key_size = 256;
2655 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002656#endif
2657#if defined(MBEDTLS_SSL_HAVE_CHACHAPOLY)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002658 case MBEDTLS_CIPHER_CHACHA20_POLY1305:
2659 *alg = PSA_ALG_CHACHA20_POLY1305;
2660 *key_type = PSA_KEY_TYPE_CHACHA20;
2661 *key_size = 256;
2662 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002663#endif
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002664 case MBEDTLS_CIPHER_NULL:
2665 *alg = MBEDTLS_SSL_NULL_CIPHER;
2666 *key_type = 0;
2667 *key_size = 0;
2668 break;
2669 default:
2670 return PSA_ERROR_NOT_SUPPORTED;
2671 }
2672
2673 return PSA_SUCCESS;
2674}
Neil Armstrong8395d7a2022-05-18 11:44:56 +02002675#endif /* MBEDTLS_USE_PSA_CRYPTO || MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002676
Manuel Pégourié-Gonnardcf141ca2015-05-20 10:35:51 +02002677#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002678int mbedtls_ssl_conf_dh_param_bin(mbedtls_ssl_config *conf,
2679 const unsigned char *dhm_P, size_t P_len,
2680 const unsigned char *dhm_G, size_t G_len)
Hanno Beckera90658f2017-10-04 15:29:08 +01002681{
Janos Follath865b3eb2019-12-16 11:46:15 +00002682 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Beckera90658f2017-10-04 15:29:08 +01002683
Gilles Peskine449bd832023-01-11 14:50:10 +01002684 mbedtls_mpi_free(&conf->dhm_P);
2685 mbedtls_mpi_free(&conf->dhm_G);
Glenn Strausscee11292021-12-20 01:43:17 -05002686
Gilles Peskine449bd832023-01-11 14:50:10 +01002687 if ((ret = mbedtls_mpi_read_binary(&conf->dhm_P, dhm_P, P_len)) != 0 ||
2688 (ret = mbedtls_mpi_read_binary(&conf->dhm_G, dhm_G, G_len)) != 0) {
2689 mbedtls_mpi_free(&conf->dhm_P);
2690 mbedtls_mpi_free(&conf->dhm_G);
2691 return ret;
Hanno Beckera90658f2017-10-04 15:29:08 +01002692 }
2693
Gilles Peskine449bd832023-01-11 14:50:10 +01002694 return 0;
Hanno Beckera90658f2017-10-04 15:29:08 +01002695}
Paul Bakker5121ce52009-01-03 21:22:43 +00002696
Gilles Peskine449bd832023-01-11 14:50:10 +01002697int mbedtls_ssl_conf_dh_param_ctx(mbedtls_ssl_config *conf, mbedtls_dhm_context *dhm_ctx)
Paul Bakker1b57b062011-01-06 15:48:19 +00002698{
Janos Follath865b3eb2019-12-16 11:46:15 +00002699 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker1b57b062011-01-06 15:48:19 +00002700
Gilles Peskine449bd832023-01-11 14:50:10 +01002701 mbedtls_mpi_free(&conf->dhm_P);
2702 mbedtls_mpi_free(&conf->dhm_G);
Glenn Strausscee11292021-12-20 01:43:17 -05002703
Gilles Peskine449bd832023-01-11 14:50:10 +01002704 if ((ret = mbedtls_dhm_get_value(dhm_ctx, MBEDTLS_DHM_PARAM_P,
2705 &conf->dhm_P)) != 0 ||
2706 (ret = mbedtls_dhm_get_value(dhm_ctx, MBEDTLS_DHM_PARAM_G,
2707 &conf->dhm_G)) != 0) {
2708 mbedtls_mpi_free(&conf->dhm_P);
2709 mbedtls_mpi_free(&conf->dhm_G);
2710 return ret;
Manuel Pégourié-Gonnard1028b742015-05-06 17:33:07 +01002711 }
Paul Bakker1b57b062011-01-06 15:48:19 +00002712
Gilles Peskine449bd832023-01-11 14:50:10 +01002713 return 0;
Paul Bakker1b57b062011-01-06 15:48:19 +00002714}
Manuel Pégourié-Gonnardcf141ca2015-05-20 10:35:51 +02002715#endif /* MBEDTLS_DHM_C && MBEDTLS_SSL_SRV_C */
Paul Bakker1b57b062011-01-06 15:48:19 +00002716
Manuel Pégourié-Gonnardbd990d62015-06-11 14:49:42 +02002717#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_CLI_C)
2718/*
2719 * Set the minimum length for Diffie-Hellman parameters
2720 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002721void mbedtls_ssl_conf_dhm_min_bitlen(mbedtls_ssl_config *conf,
2722 unsigned int bitlen)
Manuel Pégourié-Gonnardbd990d62015-06-11 14:49:42 +02002723{
2724 conf->dhm_min_bitlen = bitlen;
2725}
2726#endif /* MBEDTLS_DHM_C && MBEDTLS_SSL_CLI_C */
2727
Ronald Crone68ab4f2022-10-05 12:46:29 +02002728#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu7ddc38c2022-01-19 11:08:05 +08002729#if !defined(MBEDTLS_DEPRECATED_REMOVED) && defined(MBEDTLS_SSL_PROTO_TLS1_2)
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02002730/*
2731 * Set allowed/preferred hashes for handshake signatures
2732 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002733void mbedtls_ssl_conf_sig_hashes(mbedtls_ssl_config *conf,
2734 const int *hashes)
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02002735{
2736 conf->sig_hashes = hashes;
2737}
Jerry Yu7ddc38c2022-01-19 11:08:05 +08002738#endif /* !MBEDTLS_DEPRECATED_REMOVED && MBEDTLS_SSL_PROTO_TLS1_2 */
Hanno Becker1cd6e002021-08-10 13:27:10 +01002739
Jerry Yuf017ee42022-01-12 15:49:48 +08002740/* Configure allowed signature algorithms for handshake */
Gilles Peskine449bd832023-01-11 14:50:10 +01002741void mbedtls_ssl_conf_sig_algs(mbedtls_ssl_config *conf,
2742 const uint16_t *sig_algs)
Hanno Becker1cd6e002021-08-10 13:27:10 +01002743{
Jerry Yuf017ee42022-01-12 15:49:48 +08002744#if !defined(MBEDTLS_DEPRECATED_REMOVED)
2745 conf->sig_hashes = NULL;
2746#endif /* !MBEDTLS_DEPRECATED_REMOVED */
2747 conf->sig_algs = sig_algs;
Hanno Becker1cd6e002021-08-10 13:27:10 +01002748}
Ronald Crone68ab4f2022-10-05 12:46:29 +02002749#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02002750
Manuel Pégourié-Gonnardf07ce3b2023-09-22 11:53:41 +02002751#if defined(MBEDTLS_ECP_C)
Brett Warrene0edc842021-08-17 09:53:13 +01002752#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002753/*
2754 * Set the allowed elliptic curves
Brett Warrene0edc842021-08-17 09:53:13 +01002755 *
2756 * mbedtls_ssl_setup() takes the provided list
2757 * and translates it to a list of IANA TLS group identifiers,
2758 * stored in ssl->handshake->group_list.
2759 *
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002760 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002761void mbedtls_ssl_conf_curves(mbedtls_ssl_config *conf,
2762 const mbedtls_ecp_group_id *curve_list)
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002763{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002764 conf->curve_list = curve_list;
Brett Warrene0edc842021-08-17 09:53:13 +01002765 conf->group_list = NULL;
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002766}
Brett Warrene0edc842021-08-17 09:53:13 +01002767#endif /* MBEDTLS_DEPRECATED_REMOVED */
Manuel Pégourié-Gonnardf07ce3b2023-09-22 11:53:41 +02002768#endif /* MBEDTLS_ECP_C */
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002769
Brett Warrene0edc842021-08-17 09:53:13 +01002770/*
2771 * Set the allowed groups
2772 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002773void mbedtls_ssl_conf_groups(mbedtls_ssl_config *conf,
2774 const uint16_t *group_list)
Brett Warrene0edc842021-08-17 09:53:13 +01002775{
Manuel Pégourié-Gonnardf07ce3b2023-09-22 11:53:41 +02002776#if defined(MBEDTLS_ECP_C) && !defined(MBEDTLS_DEPRECATED_REMOVED)
Brett Warrene0edc842021-08-17 09:53:13 +01002777 conf->curve_list = NULL;
2778#endif
2779 conf->group_list = group_list;
2780}
2781
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01002782#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002783int mbedtls_ssl_set_hostname(mbedtls_ssl_context *ssl, const char *hostname)
Paul Bakker5121ce52009-01-03 21:22:43 +00002784{
Hanno Becker947194e2017-04-07 13:25:49 +01002785 /* Initialize to suppress unnecessary compiler warning */
2786 size_t hostname_len = 0;
2787
2788 /* Check if new hostname is valid before
2789 * making any change to current one */
Gilles Peskine449bd832023-01-11 14:50:10 +01002790 if (hostname != NULL) {
2791 hostname_len = strlen(hostname);
Hanno Becker947194e2017-04-07 13:25:49 +01002792
Gilles Peskine449bd832023-01-11 14:50:10 +01002793 if (hostname_len > MBEDTLS_SSL_MAX_HOST_NAME_LEN) {
2794 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2795 }
Hanno Becker947194e2017-04-07 13:25:49 +01002796 }
2797
2798 /* Now it's clear that we will overwrite the old hostname,
2799 * so we can free it safely */
2800
Gilles Peskine449bd832023-01-11 14:50:10 +01002801 if (ssl->hostname != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01002802 mbedtls_zeroize_and_free(ssl->hostname, strlen(ssl->hostname));
Hanno Becker947194e2017-04-07 13:25:49 +01002803 }
2804
2805 /* Passing NULL as hostname shall clear the old one */
Manuel Pégourié-Gonnardba26c242015-05-06 10:47:06 +01002806
Gilles Peskine449bd832023-01-11 14:50:10 +01002807 if (hostname == NULL) {
Hanno Becker947194e2017-04-07 13:25:49 +01002808 ssl->hostname = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01002809 } else {
2810 ssl->hostname = mbedtls_calloc(1, hostname_len + 1);
2811 if (ssl->hostname == NULL) {
2812 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
2813 }
Paul Bakker75c1a6f2013-08-19 14:25:29 +02002814
Gilles Peskine449bd832023-01-11 14:50:10 +01002815 memcpy(ssl->hostname, hostname, hostname_len);
Paul Bakker75c1a6f2013-08-19 14:25:29 +02002816
Hanno Becker947194e2017-04-07 13:25:49 +01002817 ssl->hostname[hostname_len] = '\0';
2818 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002819
Gilles Peskine449bd832023-01-11 14:50:10 +01002820 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00002821}
Hanno Becker1a9a51c2017-04-07 13:02:16 +01002822#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00002823
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01002824#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01002825void mbedtls_ssl_conf_sni(mbedtls_ssl_config *conf,
2826 int (*f_sni)(void *, mbedtls_ssl_context *,
2827 const unsigned char *, size_t),
2828 void *p_sni)
Paul Bakker5701cdc2012-09-27 21:49:42 +00002829{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002830 conf->f_sni = f_sni;
2831 conf->p_sni = p_sni;
Paul Bakker5701cdc2012-09-27 21:49:42 +00002832}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002833#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
Paul Bakker5701cdc2012-09-27 21:49:42 +00002834
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002835#if defined(MBEDTLS_SSL_ALPN)
Gilles Peskine449bd832023-01-11 14:50:10 +01002836int mbedtls_ssl_conf_alpn_protocols(mbedtls_ssl_config *conf, const char **protos)
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002837{
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002838 size_t cur_len, tot_len;
2839 const char **p;
2840
2841 /*
Brian J Murray1903fb32016-11-06 04:45:15 -08002842 * RFC 7301 3.1: "Empty strings MUST NOT be included and byte strings
2843 * MUST NOT be truncated."
2844 * We check lengths now rather than later.
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002845 */
2846 tot_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01002847 for (p = protos; *p != NULL; p++) {
2848 cur_len = strlen(*p);
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002849 tot_len += cur_len;
2850
Gilles Peskine449bd832023-01-11 14:50:10 +01002851 if ((cur_len == 0) ||
2852 (cur_len > MBEDTLS_SSL_MAX_ALPN_NAME_LEN) ||
2853 (tot_len > MBEDTLS_SSL_MAX_ALPN_LIST_LEN)) {
2854 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2855 }
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002856 }
2857
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002858 conf->alpn_list = protos;
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002859
Gilles Peskine449bd832023-01-11 14:50:10 +01002860 return 0;
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002861}
2862
Gilles Peskine449bd832023-01-11 14:50:10 +01002863const char *mbedtls_ssl_get_alpn_protocol(const mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002864{
Gilles Peskine449bd832023-01-11 14:50:10 +01002865 return ssl->alpn_chosen;
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002866}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002867#endif /* MBEDTLS_SSL_ALPN */
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002868
Johan Pascalb62bb512015-12-03 21:56:45 +01002869#if defined(MBEDTLS_SSL_DTLS_SRTP)
Gilles Peskine449bd832023-01-11 14:50:10 +01002870void mbedtls_ssl_conf_srtp_mki_value_supported(mbedtls_ssl_config *conf,
2871 int support_mki_value)
Ron Eldor591f1622018-01-22 12:30:04 +02002872{
2873 conf->dtls_srtp_mki_support = support_mki_value;
2874}
2875
Gilles Peskine449bd832023-01-11 14:50:10 +01002876int mbedtls_ssl_dtls_srtp_set_mki_value(mbedtls_ssl_context *ssl,
2877 unsigned char *mki_value,
2878 uint16_t mki_len)
Ron Eldor591f1622018-01-22 12:30:04 +02002879{
Gilles Peskine449bd832023-01-11 14:50:10 +01002880 if (mki_len > MBEDTLS_TLS_SRTP_MAX_MKI_LENGTH) {
2881 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Ron Eldora9788042018-12-05 11:04:31 +02002882 }
Ron Eldor591f1622018-01-22 12:30:04 +02002883
Gilles Peskine449bd832023-01-11 14:50:10 +01002884 if (ssl->conf->dtls_srtp_mki_support == MBEDTLS_SSL_DTLS_SRTP_MKI_UNSUPPORTED) {
2885 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Ron Eldora9788042018-12-05 11:04:31 +02002886 }
Ron Eldor591f1622018-01-22 12:30:04 +02002887
Gilles Peskine449bd832023-01-11 14:50:10 +01002888 memcpy(ssl->dtls_srtp_info.mki_value, mki_value, mki_len);
Ron Eldor591f1622018-01-22 12:30:04 +02002889 ssl->dtls_srtp_info.mki_len = mki_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01002890 return 0;
Ron Eldor591f1622018-01-22 12:30:04 +02002891}
2892
Gilles Peskine449bd832023-01-11 14:50:10 +01002893int mbedtls_ssl_conf_dtls_srtp_protection_profiles(mbedtls_ssl_config *conf,
2894 const mbedtls_ssl_srtp_profile *profiles)
Johan Pascalb62bb512015-12-03 21:56:45 +01002895{
Johan Pascal253d0262020-09-22 13:04:45 +02002896 const mbedtls_ssl_srtp_profile *p;
2897 size_t list_size = 0;
Johan Pascalb62bb512015-12-03 21:56:45 +01002898
Johan Pascal253d0262020-09-22 13:04:45 +02002899 /* check the profiles list: all entry must be valid,
2900 * its size cannot be more than the total number of supported profiles, currently 4 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002901 for (p = profiles; *p != MBEDTLS_TLS_SRTP_UNSET &&
2902 list_size <= MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH;
2903 p++) {
2904 if (mbedtls_ssl_check_srtp_profile_value(*p) != MBEDTLS_TLS_SRTP_UNSET) {
Johan Pascal76fdf1d2020-10-22 23:31:00 +02002905 list_size++;
Gilles Peskine449bd832023-01-11 14:50:10 +01002906 } else {
Johan Pascal76fdf1d2020-10-22 23:31:00 +02002907 /* unsupported value, stop parsing and set the size to an error value */
2908 list_size = MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH + 1;
Johan Pascalb62bb512015-12-03 21:56:45 +01002909 }
2910 }
2911
Gilles Peskine449bd832023-01-11 14:50:10 +01002912 if (list_size > MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH) {
2913 conf->dtls_srtp_profile_list = NULL;
2914 conf->dtls_srtp_profile_list_len = 0;
2915 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Johan Pascal253d0262020-09-22 13:04:45 +02002916 }
2917
Johan Pascal9bc97ca2020-09-21 23:44:45 +02002918 conf->dtls_srtp_profile_list = profiles;
Johan Pascal253d0262020-09-22 13:04:45 +02002919 conf->dtls_srtp_profile_list_len = list_size;
Johan Pascalb62bb512015-12-03 21:56:45 +01002920
Gilles Peskine449bd832023-01-11 14:50:10 +01002921 return 0;
Johan Pascalb62bb512015-12-03 21:56:45 +01002922}
2923
Gilles Peskine449bd832023-01-11 14:50:10 +01002924void mbedtls_ssl_get_dtls_srtp_negotiation_result(const mbedtls_ssl_context *ssl,
2925 mbedtls_dtls_srtp_info *dtls_srtp_info)
Johan Pascalb62bb512015-12-03 21:56:45 +01002926{
Johan Pascal2258a4f2020-10-28 13:53:09 +01002927 dtls_srtp_info->chosen_dtls_srtp_profile = ssl->dtls_srtp_info.chosen_dtls_srtp_profile;
2928 /* do not copy the mki value if there is no chosen profile */
Gilles Peskine449bd832023-01-11 14:50:10 +01002929 if (dtls_srtp_info->chosen_dtls_srtp_profile == MBEDTLS_TLS_SRTP_UNSET) {
Johan Pascal2258a4f2020-10-28 13:53:09 +01002930 dtls_srtp_info->mki_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01002931 } else {
Johan Pascal2258a4f2020-10-28 13:53:09 +01002932 dtls_srtp_info->mki_len = ssl->dtls_srtp_info.mki_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01002933 memcpy(dtls_srtp_info->mki_value, ssl->dtls_srtp_info.mki_value,
2934 ssl->dtls_srtp_info.mki_len);
Johan Pascal2258a4f2020-10-28 13:53:09 +01002935 }
Johan Pascalb62bb512015-12-03 21:56:45 +01002936}
Johan Pascalb62bb512015-12-03 21:56:45 +01002937#endif /* MBEDTLS_SSL_DTLS_SRTP */
2938
Aditya Patwardhan3096f332022-07-26 14:31:46 +05302939#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Gilles Peskine449bd832023-01-11 14:50:10 +01002940void mbedtls_ssl_conf_max_version(mbedtls_ssl_config *conf, int major, int minor)
Paul Bakker490ecc82011-10-06 13:04:09 +00002941{
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01002942 conf->max_tls_version = (mbedtls_ssl_protocol_version) ((major << 8) | minor);
Paul Bakker490ecc82011-10-06 13:04:09 +00002943}
2944
Gilles Peskine449bd832023-01-11 14:50:10 +01002945void mbedtls_ssl_conf_min_version(mbedtls_ssl_config *conf, int major, int minor)
Paul Bakker1d29fb52012-09-28 13:28:45 +00002946{
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01002947 conf->min_tls_version = (mbedtls_ssl_protocol_version) ((major << 8) | minor);
Paul Bakker1d29fb52012-09-28 13:28:45 +00002948}
Aditya Patwardhan3096f332022-07-26 14:31:46 +05302949#endif /* MBEDTLS_DEPRECATED_REMOVED */
Paul Bakker1d29fb52012-09-28 13:28:45 +00002950
Janos Follath088ce432017-04-10 12:42:31 +01002951#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002952void mbedtls_ssl_conf_cert_req_ca_list(mbedtls_ssl_config *conf,
2953 char cert_req_ca_list)
Janos Follath088ce432017-04-10 12:42:31 +01002954{
2955 conf->cert_req_ca_list = cert_req_ca_list;
2956}
2957#endif
2958
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002959#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01002960void mbedtls_ssl_conf_encrypt_then_mac(mbedtls_ssl_config *conf, char etm)
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01002961{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002962 conf->encrypt_then_mac = etm;
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01002963}
2964#endif
2965
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002966#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
Gilles Peskine449bd832023-01-11 14:50:10 +01002967void mbedtls_ssl_conf_extended_master_secret(mbedtls_ssl_config *conf, char ems)
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02002968{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002969 conf->extended_ms = ems;
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02002970}
2971#endif
2972
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002973#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01002974int mbedtls_ssl_conf_max_frag_len(mbedtls_ssl_config *conf, unsigned char mfl_code)
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002975{
Gilles Peskine449bd832023-01-11 14:50:10 +01002976 if (mfl_code >= MBEDTLS_SSL_MAX_FRAG_LEN_INVALID ||
2977 ssl_mfl_code_to_length(mfl_code) > MBEDTLS_TLS_EXT_ADV_CONTENT_LEN) {
2978 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002979 }
2980
Manuel Pégourié-Gonnard6bf89d62015-05-05 17:01:57 +01002981 conf->mfl_code = mfl_code;
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002982
Gilles Peskine449bd832023-01-11 14:50:10 +01002983 return 0;
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002984}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002985#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002986
Gilles Peskine449bd832023-01-11 14:50:10 +01002987void mbedtls_ssl_conf_legacy_renegotiation(mbedtls_ssl_config *conf, int allow_legacy)
Paul Bakker48916f92012-09-16 19:57:18 +00002988{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002989 conf->allow_legacy_renegotiation = allow_legacy;
Paul Bakker48916f92012-09-16 19:57:18 +00002990}
2991
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002992#if defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01002993void mbedtls_ssl_conf_renegotiation(mbedtls_ssl_config *conf, int renegotiation)
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01002994{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002995 conf->disable_renegotiation = renegotiation;
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01002996}
2997
Gilles Peskine449bd832023-01-11 14:50:10 +01002998void mbedtls_ssl_conf_renegotiation_enforced(mbedtls_ssl_config *conf, int max_records)
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02002999{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003000 conf->renego_max_records = max_records;
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02003001}
3002
Gilles Peskine449bd832023-01-11 14:50:10 +01003003void mbedtls_ssl_conf_renegotiation_period(mbedtls_ssl_config *conf,
3004 const unsigned char period[8])
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01003005{
Gilles Peskine449bd832023-01-11 14:50:10 +01003006 memcpy(conf->renego_period, period, 8);
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01003007}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003008#endif /* MBEDTLS_SSL_RENEGOTIATION */
Paul Bakker5121ce52009-01-03 21:22:43 +00003009
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003010#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02003011#if defined(MBEDTLS_SSL_CLI_C)
Ronald Crond67f8012024-08-28 07:45:57 +02003012
Gilles Peskine449bd832023-01-11 14:50:10 +01003013void mbedtls_ssl_conf_session_tickets(mbedtls_ssl_config *conf, int use_tickets)
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02003014{
Ronald Crond67f8012024-08-28 07:45:57 +02003015 conf->session_tickets &= ~MBEDTLS_SSL_SESSION_TICKETS_TLS1_2_MASK;
3016 conf->session_tickets |= (use_tickets != 0) <<
3017 MBEDTLS_SSL_SESSION_TICKETS_TLS1_2_BIT;
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02003018}
Ronald Crond67f8012024-08-28 07:45:57 +02003019
Ronald Cronbedddd72024-08-27 14:18:50 +02003020#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Ronald Cron9f44c882024-08-28 16:44:10 +02003021void mbedtls_ssl_conf_tls13_enable_signal_new_session_tickets(
3022 mbedtls_ssl_config *conf, int signal_new_session_tickets)
Ronald Cronbedddd72024-08-27 14:18:50 +02003023{
Ronald Crond67f8012024-08-28 07:45:57 +02003024 conf->session_tickets &= ~MBEDTLS_SSL_SESSION_TICKETS_TLS1_3_MASK;
Ronald Cron9f44c882024-08-28 16:44:10 +02003025 conf->session_tickets |= (signal_new_session_tickets != 0) <<
Ronald Crond67f8012024-08-28 07:45:57 +02003026 MBEDTLS_SSL_SESSION_TICKETS_TLS1_3_BIT;
3027}
Ronald Cronbedddd72024-08-27 14:18:50 +02003028#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
3029#endif /* MBEDTLS_SSL_CLI_C */
Paul Bakker606b4ba2013-08-14 16:52:14 +02003030
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02003031#if defined(MBEDTLS_SSL_SRV_C)
Jerry Yu1ad7ace2022-08-09 13:28:39 +08003032
Jerry Yud0766ec2022-09-22 10:46:57 +08003033#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003034void mbedtls_ssl_conf_new_session_tickets(mbedtls_ssl_config *conf,
3035 uint16_t num_tickets)
Jerry Yu1ad7ace2022-08-09 13:28:39 +08003036{
Jerry Yud0766ec2022-09-22 10:46:57 +08003037 conf->new_session_tickets_count = num_tickets;
Jerry Yu1ad7ace2022-08-09 13:28:39 +08003038}
3039#endif
3040
Gilles Peskine449bd832023-01-11 14:50:10 +01003041void mbedtls_ssl_conf_session_tickets_cb(mbedtls_ssl_config *conf,
3042 mbedtls_ssl_ticket_write_t *f_ticket_write,
3043 mbedtls_ssl_ticket_parse_t *f_ticket_parse,
3044 void *p_ticket)
Paul Bakker606b4ba2013-08-14 16:52:14 +02003045{
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02003046 conf->f_ticket_write = f_ticket_write;
3047 conf->f_ticket_parse = f_ticket_parse;
3048 conf->p_ticket = p_ticket;
Paul Bakker606b4ba2013-08-14 16:52:14 +02003049}
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02003050#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003051#endif /* MBEDTLS_SSL_SESSION_TICKETS */
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02003052
Gilles Peskine449bd832023-01-11 14:50:10 +01003053void mbedtls_ssl_set_export_keys_cb(mbedtls_ssl_context *ssl,
3054 mbedtls_ssl_export_keys_t *f_export_keys,
3055 void *p_export_keys)
Robert Cragie4feb7ae2015-10-02 13:33:37 +01003056{
Hanno Becker7e6c1782021-06-08 09:24:55 +01003057 ssl->f_export_keys = f_export_keys;
3058 ssl->p_export_keys = p_export_keys;
Ron Eldorf5cc10d2019-05-07 18:33:40 +03003059}
Robert Cragie4feb7ae2015-10-02 13:33:37 +01003060
Gilles Peskineb74a1c72018-04-24 13:09:22 +02003061#if defined(MBEDTLS_SSL_ASYNC_PRIVATE)
Gilles Peskine8bf79f62018-01-05 21:11:53 +01003062void mbedtls_ssl_conf_async_private_cb(
3063 mbedtls_ssl_config *conf,
3064 mbedtls_ssl_async_sign_t *f_async_sign,
3065 mbedtls_ssl_async_decrypt_t *f_async_decrypt,
3066 mbedtls_ssl_async_resume_t *f_async_resume,
3067 mbedtls_ssl_async_cancel_t *f_async_cancel,
Gilles Peskine449bd832023-01-11 14:50:10 +01003068 void *async_config_data)
Gilles Peskine8bf79f62018-01-05 21:11:53 +01003069{
3070 conf->f_async_sign_start = f_async_sign;
3071 conf->f_async_decrypt_start = f_async_decrypt;
3072 conf->f_async_resume = f_async_resume;
3073 conf->f_async_cancel = f_async_cancel;
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003074 conf->p_async_config_data = async_config_data;
3075}
3076
Gilles Peskine449bd832023-01-11 14:50:10 +01003077void *mbedtls_ssl_conf_get_async_config_data(const mbedtls_ssl_config *conf)
Gilles Peskine8f97af72018-04-26 11:46:10 +02003078{
Gilles Peskine449bd832023-01-11 14:50:10 +01003079 return conf->p_async_config_data;
Gilles Peskine8f97af72018-04-26 11:46:10 +02003080}
3081
Gilles Peskine449bd832023-01-11 14:50:10 +01003082void *mbedtls_ssl_get_async_operation_data(const mbedtls_ssl_context *ssl)
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003083{
Gilles Peskine449bd832023-01-11 14:50:10 +01003084 if (ssl->handshake == NULL) {
3085 return NULL;
3086 } else {
3087 return ssl->handshake->user_async_ctx;
3088 }
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003089}
3090
Gilles Peskine449bd832023-01-11 14:50:10 +01003091void mbedtls_ssl_set_async_operation_data(mbedtls_ssl_context *ssl,
3092 void *ctx)
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003093{
Gilles Peskine449bd832023-01-11 14:50:10 +01003094 if (ssl->handshake != NULL) {
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003095 ssl->handshake->user_async_ctx = ctx;
Gilles Peskine449bd832023-01-11 14:50:10 +01003096 }
Gilles Peskine8bf79f62018-01-05 21:11:53 +01003097}
Gilles Peskineb74a1c72018-04-24 13:09:22 +02003098#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
Gilles Peskine8bf79f62018-01-05 21:11:53 +01003099
Paul Bakker5121ce52009-01-03 21:22:43 +00003100/*
3101 * SSL get accessors
3102 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003103uint32_t mbedtls_ssl_get_verify_result(const mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00003104{
Gilles Peskine449bd832023-01-11 14:50:10 +01003105 if (ssl->session != NULL) {
3106 return ssl->session->verify_result;
3107 }
Manuel Pégourié-Gonnarde89163c2015-01-23 14:30:57 +00003108
Gilles Peskine449bd832023-01-11 14:50:10 +01003109 if (ssl->session_negotiate != NULL) {
3110 return ssl->session_negotiate->verify_result;
3111 }
Manuel Pégourié-Gonnarde89163c2015-01-23 14:30:57 +00003112
Gilles Peskine449bd832023-01-11 14:50:10 +01003113 return 0xFFFFFFFF;
Paul Bakker5121ce52009-01-03 21:22:43 +00003114}
3115
Gilles Peskine449bd832023-01-11 14:50:10 +01003116int mbedtls_ssl_get_ciphersuite_id_from_ssl(const mbedtls_ssl_context *ssl)
Glenn Strauss8f526902022-01-13 00:04:49 -05003117{
Gilles Peskine449bd832023-01-11 14:50:10 +01003118 if (ssl == NULL || ssl->session == NULL) {
3119 return 0;
3120 }
Glenn Strauss8f526902022-01-13 00:04:49 -05003121
Gilles Peskine449bd832023-01-11 14:50:10 +01003122 return ssl->session->ciphersuite;
Glenn Strauss8f526902022-01-13 00:04:49 -05003123}
3124
Gilles Peskine449bd832023-01-11 14:50:10 +01003125const char *mbedtls_ssl_get_ciphersuite(const mbedtls_ssl_context *ssl)
Paul Bakker72f62662011-01-16 21:27:44 +00003126{
Gilles Peskine449bd832023-01-11 14:50:10 +01003127 if (ssl == NULL || ssl->session == NULL) {
3128 return NULL;
3129 }
Paul Bakker926c8e42013-03-06 10:23:34 +01003130
Gilles Peskine449bd832023-01-11 14:50:10 +01003131 return mbedtls_ssl_get_ciphersuite_name(ssl->session->ciphersuite);
Paul Bakker72f62662011-01-16 21:27:44 +00003132}
3133
Gilles Peskine449bd832023-01-11 14:50:10 +01003134const char *mbedtls_ssl_get_version(const mbedtls_ssl_context *ssl)
Paul Bakker43ca69c2011-01-15 17:35:19 +00003135{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003136#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003137 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
3138 switch (ssl->tls_version) {
Glenn Strauss60bfe602022-03-14 19:04:24 -04003139 case MBEDTLS_SSL_VERSION_TLS1_2:
Gilles Peskine449bd832023-01-11 14:50:10 +01003140 return "DTLSv1.2";
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01003141 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01003142 return "unknown (DTLS)";
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01003143 }
3144 }
3145#endif
3146
Gilles Peskine449bd832023-01-11 14:50:10 +01003147 switch (ssl->tls_version) {
Glenn Strauss60bfe602022-03-14 19:04:24 -04003148 case MBEDTLS_SSL_VERSION_TLS1_2:
Gilles Peskine449bd832023-01-11 14:50:10 +01003149 return "TLSv1.2";
Glenn Strauss60bfe602022-03-14 19:04:24 -04003150 case MBEDTLS_SSL_VERSION_TLS1_3:
Gilles Peskine449bd832023-01-11 14:50:10 +01003151 return "TLSv1.3";
Paul Bakker43ca69c2011-01-15 17:35:19 +00003152 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01003153 return "unknown";
Paul Bakker43ca69c2011-01-15 17:35:19 +00003154 }
Paul Bakker43ca69c2011-01-15 17:35:19 +00003155}
3156
Waleed Elmelegy6a971fd2023-12-28 17:48:16 +00003157#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
3158
3159size_t mbedtls_ssl_get_output_record_size_limit(const mbedtls_ssl_context *ssl)
3160{
3161 const size_t max_len = MBEDTLS_SSL_OUT_CONTENT_LEN;
3162 size_t record_size_limit = max_len;
3163
3164 if (ssl->session != NULL &&
3165 ssl->session->record_size_limit >= MBEDTLS_SSL_RECORD_SIZE_LIMIT_MIN &&
3166 ssl->session->record_size_limit < max_len) {
3167 record_size_limit = ssl->session->record_size_limit;
3168 }
3169
3170 // TODO: this is currently untested
3171 /* During a handshake, use the value being negotiated */
3172 if (ssl->session_negotiate != NULL &&
3173 ssl->session_negotiate->record_size_limit >= MBEDTLS_SSL_RECORD_SIZE_LIMIT_MIN &&
3174 ssl->session_negotiate->record_size_limit < max_len) {
3175 record_size_limit = ssl->session_negotiate->record_size_limit;
3176 }
3177
3178 return record_size_limit;
3179}
3180#endif /* MBEDTLS_SSL_RECORD_SIZE_LIMIT */
3181
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02003182#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01003183size_t mbedtls_ssl_get_input_max_frag_len(const mbedtls_ssl_context *ssl)
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003184{
David Horstmann95d516f2021-05-04 18:36:56 +01003185 size_t max_len = MBEDTLS_SSL_IN_CONTENT_LEN;
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003186 size_t read_mfl;
3187
Jerry Yuddda0502022-12-01 19:43:12 +08003188#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003189 /* Use the configured MFL for the client if we're past SERVER_HELLO_DONE */
Gilles Peskine449bd832023-01-11 14:50:10 +01003190 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
3191 ssl->state >= MBEDTLS_SSL_SERVER_HELLO_DONE) {
3192 return ssl_mfl_code_to_length(ssl->conf->mfl_code);
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003193 }
Jerry Yuddda0502022-12-01 19:43:12 +08003194#endif
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003195
3196 /* Check if a smaller max length was negotiated */
Gilles Peskine449bd832023-01-11 14:50:10 +01003197 if (ssl->session_out != NULL) {
3198 read_mfl = ssl_mfl_code_to_length(ssl->session_out->mfl_code);
3199 if (read_mfl < max_len) {
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003200 max_len = read_mfl;
3201 }
3202 }
3203
Jerry Yuddda0502022-12-01 19:43:12 +08003204 /* During a handshake, use the value being negotiated */
Gilles Peskine449bd832023-01-11 14:50:10 +01003205 if (ssl->session_negotiate != NULL) {
3206 read_mfl = ssl_mfl_code_to_length(ssl->session_negotiate->mfl_code);
3207 if (read_mfl < max_len) {
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003208 max_len = read_mfl;
3209 }
3210 }
3211
Gilles Peskine449bd832023-01-11 14:50:10 +01003212 return max_len;
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003213}
3214
Gilles Peskine449bd832023-01-11 14:50:10 +01003215size_t mbedtls_ssl_get_output_max_frag_len(const mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02003216{
3217 size_t max_len;
3218
3219 /*
3220 * Assume mfl_code is correct since it was checked when set
3221 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003222 max_len = ssl_mfl_code_to_length(ssl->conf->mfl_code);
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02003223
Manuel Pégourié-Gonnard2cb17e22017-09-19 13:00:47 +02003224 /* Check if a smaller max length was negotiated */
Gilles Peskine449bd832023-01-11 14:50:10 +01003225 if (ssl->session_out != NULL &&
3226 ssl_mfl_code_to_length(ssl->session_out->mfl_code) < max_len) {
3227 max_len = ssl_mfl_code_to_length(ssl->session_out->mfl_code);
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02003228 }
3229
Manuel Pégourié-Gonnard2cb17e22017-09-19 13:00:47 +02003230 /* During a handshake, use the value being negotiated */
Gilles Peskine449bd832023-01-11 14:50:10 +01003231 if (ssl->session_negotiate != NULL &&
3232 ssl_mfl_code_to_length(ssl->session_negotiate->mfl_code) < max_len) {
3233 max_len = ssl_mfl_code_to_length(ssl->session_negotiate->mfl_code);
Manuel Pégourié-Gonnard2cb17e22017-09-19 13:00:47 +02003234 }
3235
Gilles Peskine449bd832023-01-11 14:50:10 +01003236 return max_len;
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02003237}
3238#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
3239
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003240#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003241size_t mbedtls_ssl_get_current_mtu(const mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003242{
Andrzej Kurekef43ce62018-10-09 08:24:12 -04003243 /* Return unlimited mtu for client hello messages to avoid fragmentation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01003244 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
3245 (ssl->state == MBEDTLS_SSL_CLIENT_HELLO ||
3246 ssl->state == MBEDTLS_SSL_SERVER_HELLO)) {
3247 return 0;
3248 }
Andrzej Kurekef43ce62018-10-09 08:24:12 -04003249
Gilles Peskine449bd832023-01-11 14:50:10 +01003250 if (ssl->handshake == NULL || ssl->handshake->mtu == 0) {
3251 return ssl->mtu;
3252 }
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003253
Gilles Peskine449bd832023-01-11 14:50:10 +01003254 if (ssl->mtu == 0) {
3255 return ssl->handshake->mtu;
3256 }
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003257
Gilles Peskine449bd832023-01-11 14:50:10 +01003258 return ssl->mtu < ssl->handshake->mtu ?
3259 ssl->mtu : ssl->handshake->mtu;
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003260}
3261#endif /* MBEDTLS_SSL_PROTO_DTLS */
3262
Gilles Peskine449bd832023-01-11 14:50:10 +01003263int mbedtls_ssl_get_max_out_record_payload(const mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003264{
3265 size_t max_len = MBEDTLS_SSL_OUT_CONTENT_LEN;
3266
Manuel Pégourié-Gonnard000281e2018-08-21 11:20:58 +02003267#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH) && \
Jan Brucknerf482dcc2023-03-15 09:09:06 +01003268 !defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT) && \
Manuel Pégourié-Gonnard000281e2018-08-21 11:20:58 +02003269 !defined(MBEDTLS_SSL_PROTO_DTLS)
3270 (void) ssl;
3271#endif
3272
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003273#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01003274 const size_t mfl = mbedtls_ssl_get_output_max_frag_len(ssl);
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003275
Gilles Peskine449bd832023-01-11 14:50:10 +01003276 if (max_len > mfl) {
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003277 max_len = mfl;
Gilles Peskine449bd832023-01-11 14:50:10 +01003278 }
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003279#endif
3280
Jan Brucknerf482dcc2023-03-15 09:09:06 +01003281#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
3282 const size_t record_size_limit = mbedtls_ssl_get_output_record_size_limit(ssl);
3283
3284 if (max_len > record_size_limit) {
3285 max_len = record_size_limit;
3286 }
3287#endif
3288
Waleed Elmelegy6a971fd2023-12-28 17:48:16 +00003289 if (ssl->transform_out != NULL &&
3290 ssl->transform_out->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Waleed Elmelegyf5017902024-01-09 14:18:34 +00003291 /*
3292 * In TLS 1.3 case, when records are protected, `max_len` as computed
3293 * above is the maximum length of the TLSInnerPlaintext structure that
3294 * along the plaintext payload contains the inner content type (one byte)
3295 * and some zero padding. Given the algorithm used for padding
3296 * in mbedtls_ssl_encrypt_buf(), compute the maximum length for
3297 * the plaintext payload. Round down to a multiple of
3298 * MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY and
3299 * subtract 1.
Waleed Elmelegy6a971fd2023-12-28 17:48:16 +00003300 */
3301 max_len = ((max_len / MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY) *
3302 MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY) - 1;
3303 }
3304
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003305#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003306 if (mbedtls_ssl_get_current_mtu(ssl) != 0) {
3307 const size_t mtu = mbedtls_ssl_get_current_mtu(ssl);
3308 const int ret = mbedtls_ssl_get_record_expansion(ssl);
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003309 const size_t overhead = (size_t) ret;
3310
Gilles Peskine449bd832023-01-11 14:50:10 +01003311 if (ret < 0) {
3312 return ret;
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003313 }
3314
Gilles Peskine449bd832023-01-11 14:50:10 +01003315 if (mtu <= overhead) {
3316 MBEDTLS_SSL_DEBUG_MSG(1, ("MTU too low for record expansion"));
3317 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
3318 }
3319
3320 if (max_len > mtu - overhead) {
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003321 max_len = mtu - overhead;
Gilles Peskine449bd832023-01-11 14:50:10 +01003322 }
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003323 }
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003324#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003325
Hanno Becker0defedb2018-08-10 12:35:02 +01003326#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH) && \
Waleed Elmelegy049cd302023-12-20 17:28:31 +00003327 !defined(MBEDTLS_SSL_PROTO_DTLS) && \
3328 !defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
Hanno Becker0defedb2018-08-10 12:35:02 +01003329 ((void) ssl);
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003330#endif
3331
Gilles Peskine449bd832023-01-11 14:50:10 +01003332 return (int) max_len;
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003333}
3334
Gilles Peskine449bd832023-01-11 14:50:10 +01003335int mbedtls_ssl_get_max_in_record_payload(const mbedtls_ssl_context *ssl)
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003336{
3337 size_t max_len = MBEDTLS_SSL_IN_CONTENT_LEN;
3338
3339#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
3340 (void) ssl;
3341#endif
3342
3343#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01003344 const size_t mfl = mbedtls_ssl_get_input_max_frag_len(ssl);
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003345
Gilles Peskine449bd832023-01-11 14:50:10 +01003346 if (max_len > mfl) {
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003347 max_len = mfl;
Gilles Peskine449bd832023-01-11 14:50:10 +01003348 }
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003349#endif
3350
Gilles Peskine449bd832023-01-11 14:50:10 +01003351 return (int) max_len;
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003352}
3353
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003354#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01003355const mbedtls_x509_crt *mbedtls_ssl_get_peer_cert(const mbedtls_ssl_context *ssl)
Paul Bakkerb0550d92012-10-30 07:51:03 +00003356{
Gilles Peskine449bd832023-01-11 14:50:10 +01003357 if (ssl == NULL || ssl->session == NULL) {
3358 return NULL;
3359 }
Paul Bakkerb0550d92012-10-30 07:51:03 +00003360
Hanno Beckere6824572019-02-07 13:18:46 +00003361#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01003362 return ssl->session->peer_cert;
Hanno Beckere6824572019-02-07 13:18:46 +00003363#else
Gilles Peskine449bd832023-01-11 14:50:10 +01003364 return NULL;
Hanno Beckere6824572019-02-07 13:18:46 +00003365#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Paul Bakkerb0550d92012-10-30 07:51:03 +00003366}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003367#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkerb0550d92012-10-30 07:51:03 +00003368
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003369#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01003370int mbedtls_ssl_get_session(const mbedtls_ssl_context *ssl,
3371 mbedtls_ssl_session *dst)
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003372{
Hanno Beckere810bbc2021-05-14 16:01:05 +01003373 int ret;
3374
Gilles Peskine449bd832023-01-11 14:50:10 +01003375 if (ssl == NULL ||
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003376 dst == NULL ||
3377 ssl->session == NULL ||
Gilles Peskine449bd832023-01-11 14:50:10 +01003378 ssl->conf->endpoint != MBEDTLS_SSL_IS_CLIENT) {
3379 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003380 }
3381
Hanno Beckere810bbc2021-05-14 16:01:05 +01003382 /* Since Mbed TLS 3.0, mbedtls_ssl_get_session() is no longer
3383 * idempotent: Each session can only be exported once.
3384 *
3385 * (This is in preparation for TLS 1.3 support where we will
3386 * need the ability to export multiple sessions (aka tickets),
3387 * which will be achieved by calling mbedtls_ssl_get_session()
3388 * multiple times until it fails.)
3389 *
3390 * Check whether we have already exported the current session,
3391 * and fail if so.
3392 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003393 if (ssl->session->exported == 1) {
3394 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
3395 }
Hanno Beckere810bbc2021-05-14 16:01:05 +01003396
Gilles Peskine449bd832023-01-11 14:50:10 +01003397 ret = mbedtls_ssl_session_copy(dst, ssl->session);
3398 if (ret != 0) {
3399 return ret;
3400 }
Hanno Beckere810bbc2021-05-14 16:01:05 +01003401
3402 /* Remember that we've exported the session. */
3403 ssl->session->exported = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01003404 return 0;
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003405}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003406#endif /* MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003407
David Horstmanncb01b362024-02-29 17:31:46 +00003408#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
3409
3410/* Serialization of TLS 1.2 sessions
David Horstmanne59f9702024-02-29 16:08:57 +00003411 *
David Horstmanncb01b362024-02-29 17:31:46 +00003412 * For more detail, see the description of ssl_session_save().
David Horstmanne59f9702024-02-29 16:08:57 +00003413 */
3414static size_t ssl_tls12_session_save(const mbedtls_ssl_session *session,
3415 unsigned char *buf,
3416 size_t buf_len)
3417{
3418 unsigned char *p = buf;
3419 size_t used = 0;
3420
3421#if defined(MBEDTLS_HAVE_TIME)
3422 uint64_t start;
3423#endif
3424#if defined(MBEDTLS_X509_CRT_PARSE_C)
3425#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
3426 size_t cert_len;
3427#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3428#endif /* MBEDTLS_X509_CRT_PARSE_C */
3429
3430 /*
3431 * Time
3432 */
3433#if defined(MBEDTLS_HAVE_TIME)
3434 used += 8;
3435
3436 if (used <= buf_len) {
3437 start = (uint64_t) session->start;
3438
3439 MBEDTLS_PUT_UINT64_BE(start, p, 0);
3440 p += 8;
3441 }
3442#endif /* MBEDTLS_HAVE_TIME */
3443
3444 /*
3445 * Basic mandatory fields
3446 */
3447 used += 1 /* id_len */
3448 + sizeof(session->id)
3449 + sizeof(session->master)
3450 + 4; /* verify_result */
3451
3452 if (used <= buf_len) {
3453 *p++ = MBEDTLS_BYTE_0(session->id_len);
3454 memcpy(p, session->id, 32);
3455 p += 32;
3456
3457 memcpy(p, session->master, 48);
3458 p += 48;
3459
3460 MBEDTLS_PUT_UINT32_BE(session->verify_result, p, 0);
3461 p += 4;
3462 }
3463
3464 /*
3465 * Peer's end-entity certificate
3466 */
3467#if defined(MBEDTLS_X509_CRT_PARSE_C)
3468#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
3469 if (session->peer_cert == NULL) {
3470 cert_len = 0;
3471 } else {
3472 cert_len = session->peer_cert->raw.len;
3473 }
3474
3475 used += 3 + cert_len;
3476
3477 if (used <= buf_len) {
3478 *p++ = MBEDTLS_BYTE_2(cert_len);
3479 *p++ = MBEDTLS_BYTE_1(cert_len);
3480 *p++ = MBEDTLS_BYTE_0(cert_len);
3481
3482 if (session->peer_cert != NULL) {
3483 memcpy(p, session->peer_cert->raw.p, cert_len);
3484 p += cert_len;
3485 }
3486 }
3487#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3488 if (session->peer_cert_digest != NULL) {
3489 used += 1 /* type */ + 1 /* length */ + session->peer_cert_digest_len;
3490 if (used <= buf_len) {
3491 *p++ = (unsigned char) session->peer_cert_digest_type;
3492 *p++ = (unsigned char) session->peer_cert_digest_len;
3493 memcpy(p, session->peer_cert_digest,
3494 session->peer_cert_digest_len);
3495 p += session->peer_cert_digest_len;
3496 }
3497 } else {
3498 used += 2;
3499 if (used <= buf_len) {
3500 *p++ = (unsigned char) MBEDTLS_MD_NONE;
3501 *p++ = 0;
3502 }
3503 }
3504#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3505#endif /* MBEDTLS_X509_CRT_PARSE_C */
3506
3507 /*
3508 * Session ticket if any, plus associated data
3509 */
3510#if defined(MBEDTLS_SSL_SESSION_TICKETS)
3511#if defined(MBEDTLS_SSL_CLI_C)
3512 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
3513 used += 3 + session->ticket_len + 4; /* len + ticket + lifetime */
3514
3515 if (used <= buf_len) {
3516 *p++ = MBEDTLS_BYTE_2(session->ticket_len);
3517 *p++ = MBEDTLS_BYTE_1(session->ticket_len);
3518 *p++ = MBEDTLS_BYTE_0(session->ticket_len);
3519
3520 if (session->ticket != NULL) {
3521 memcpy(p, session->ticket, session->ticket_len);
3522 p += session->ticket_len;
3523 }
3524
3525 MBEDTLS_PUT_UINT32_BE(session->ticket_lifetime, p, 0);
3526 p += 4;
3527 }
3528 }
3529#endif /* MBEDTLS_SSL_CLI_C */
3530#if defined(MBEDTLS_HAVE_TIME) && defined(MBEDTLS_SSL_SRV_C)
3531 if (session->endpoint == MBEDTLS_SSL_IS_SERVER) {
3532 used += 8;
3533
3534 if (used <= buf_len) {
3535 MBEDTLS_PUT_UINT64_BE((uint64_t) session->ticket_creation_time, p, 0);
3536 p += 8;
3537 }
3538 }
3539#endif /* MBEDTLS_HAVE_TIME && MBEDTLS_SSL_SRV_C */
3540#endif /* MBEDTLS_SSL_SESSION_TICKETS */
3541
3542 /*
3543 * Misc extension-related info
3544 */
3545#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
3546 used += 1;
3547
3548 if (used <= buf_len) {
3549 *p++ = session->mfl_code;
3550 }
3551#endif
3552
3553#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
3554 used += 1;
3555
3556 if (used <= buf_len) {
3557 *p++ = MBEDTLS_BYTE_0(session->encrypt_then_mac);
3558 }
3559#endif
3560
3561 return used;
3562}
3563
3564MBEDTLS_CHECK_RETURN_CRITICAL
3565static int ssl_tls12_session_load(mbedtls_ssl_session *session,
3566 const unsigned char *buf,
3567 size_t len)
3568{
3569#if defined(MBEDTLS_HAVE_TIME)
3570 uint64_t start;
3571#endif
3572#if defined(MBEDTLS_X509_CRT_PARSE_C)
3573#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
3574 size_t cert_len;
3575#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3576#endif /* MBEDTLS_X509_CRT_PARSE_C */
3577
3578 const unsigned char *p = buf;
3579 const unsigned char * const end = buf + len;
3580
3581 /*
3582 * Time
3583 */
3584#if defined(MBEDTLS_HAVE_TIME)
3585 if (8 > (size_t) (end - p)) {
3586 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3587 }
3588
3589 start = MBEDTLS_GET_UINT64_BE(p, 0);
3590 p += 8;
3591
3592 session->start = (time_t) start;
3593#endif /* MBEDTLS_HAVE_TIME */
3594
3595 /*
3596 * Basic mandatory fields
3597 */
3598 if (1 + 32 + 48 + 4 > (size_t) (end - p)) {
3599 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3600 }
3601
3602 session->id_len = *p++;
3603 memcpy(session->id, p, 32);
3604 p += 32;
3605
3606 memcpy(session->master, p, 48);
3607 p += 48;
3608
3609 session->verify_result = MBEDTLS_GET_UINT32_BE(p, 0);
3610 p += 4;
3611
3612 /* Immediately clear invalid pointer values that have been read, in case
3613 * we exit early before we replaced them with valid ones. */
3614#if defined(MBEDTLS_X509_CRT_PARSE_C)
3615#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
3616 session->peer_cert = NULL;
3617#else
3618 session->peer_cert_digest = NULL;
3619#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3620#endif /* MBEDTLS_X509_CRT_PARSE_C */
3621#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
3622 session->ticket = NULL;
3623#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
3624
3625 /*
3626 * Peer certificate
3627 */
3628#if defined(MBEDTLS_X509_CRT_PARSE_C)
3629#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
3630 /* Deserialize CRT from the end of the ticket. */
3631 if (3 > (size_t) (end - p)) {
3632 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3633 }
3634
3635 cert_len = MBEDTLS_GET_UINT24_BE(p, 0);
3636 p += 3;
3637
3638 if (cert_len != 0) {
3639 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
3640
3641 if (cert_len > (size_t) (end - p)) {
3642 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3643 }
3644
3645 session->peer_cert = mbedtls_calloc(1, sizeof(mbedtls_x509_crt));
3646
3647 if (session->peer_cert == NULL) {
3648 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
3649 }
3650
3651 mbedtls_x509_crt_init(session->peer_cert);
3652
3653 if ((ret = mbedtls_x509_crt_parse_der(session->peer_cert,
3654 p, cert_len)) != 0) {
3655 mbedtls_x509_crt_free(session->peer_cert);
3656 mbedtls_free(session->peer_cert);
3657 session->peer_cert = NULL;
3658 return ret;
3659 }
3660
3661 p += cert_len;
3662 }
3663#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3664 /* Deserialize CRT digest from the end of the ticket. */
3665 if (2 > (size_t) (end - p)) {
3666 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3667 }
3668
3669 session->peer_cert_digest_type = (mbedtls_md_type_t) *p++;
3670 session->peer_cert_digest_len = (size_t) *p++;
3671
3672 if (session->peer_cert_digest_len != 0) {
3673 const mbedtls_md_info_t *md_info =
3674 mbedtls_md_info_from_type(session->peer_cert_digest_type);
3675 if (md_info == NULL) {
3676 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3677 }
3678 if (session->peer_cert_digest_len != mbedtls_md_get_size(md_info)) {
3679 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3680 }
3681
3682 if (session->peer_cert_digest_len > (size_t) (end - p)) {
3683 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3684 }
3685
3686 session->peer_cert_digest =
3687 mbedtls_calloc(1, session->peer_cert_digest_len);
3688 if (session->peer_cert_digest == NULL) {
3689 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
3690 }
3691
3692 memcpy(session->peer_cert_digest, p,
3693 session->peer_cert_digest_len);
3694 p += session->peer_cert_digest_len;
3695 }
3696#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3697#endif /* MBEDTLS_X509_CRT_PARSE_C */
3698
3699 /*
3700 * Session ticket and associated data
3701 */
3702#if defined(MBEDTLS_SSL_SESSION_TICKETS)
3703#if defined(MBEDTLS_SSL_CLI_C)
3704 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
3705 if (3 > (size_t) (end - p)) {
3706 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3707 }
3708
3709 session->ticket_len = MBEDTLS_GET_UINT24_BE(p, 0);
3710 p += 3;
3711
3712 if (session->ticket_len != 0) {
3713 if (session->ticket_len > (size_t) (end - p)) {
3714 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3715 }
3716
3717 session->ticket = mbedtls_calloc(1, session->ticket_len);
3718 if (session->ticket == NULL) {
3719 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
3720 }
3721
3722 memcpy(session->ticket, p, session->ticket_len);
3723 p += session->ticket_len;
3724 }
3725
3726 if (4 > (size_t) (end - p)) {
3727 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3728 }
3729
3730 session->ticket_lifetime = MBEDTLS_GET_UINT32_BE(p, 0);
3731 p += 4;
3732 }
3733#endif /* MBEDTLS_SSL_CLI_C */
3734#if defined(MBEDTLS_HAVE_TIME) && defined(MBEDTLS_SSL_SRV_C)
3735 if (session->endpoint == MBEDTLS_SSL_IS_SERVER) {
3736 if (8 > (size_t) (end - p)) {
3737 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3738 }
3739 session->ticket_creation_time = MBEDTLS_GET_UINT64_BE(p, 0);
3740 p += 8;
3741 }
3742#endif /* MBEDTLS_HAVE_TIME && MBEDTLS_SSL_SRV_C */
3743#endif /* MBEDTLS_SSL_SESSION_TICKETS */
3744
3745 /*
3746 * Misc extension-related info
3747 */
3748#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
3749 if (1 > (size_t) (end - p)) {
3750 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3751 }
3752
3753 session->mfl_code = *p++;
3754#endif
3755
3756#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
3757 if (1 > (size_t) (end - p)) {
3758 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3759 }
3760
3761 session->encrypt_then_mac = *p++;
3762#endif
3763
3764 /* Done, should have consumed entire buffer */
3765 if (p != end) {
3766 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3767 }
3768
3769 return 0;
3770}
3771
3772#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
3773
3774#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
3775/* Serialization of TLS 1.3 sessions:
3776 *
David Horstmanncb01b362024-02-29 17:31:46 +00003777 * For more detail, see the description of ssl_session_save().
David Horstmanne59f9702024-02-29 16:08:57 +00003778 */
3779#if defined(MBEDTLS_SSL_SESSION_TICKETS)
3780MBEDTLS_CHECK_RETURN_CRITICAL
3781static int ssl_tls13_session_save(const mbedtls_ssl_session *session,
3782 unsigned char *buf,
3783 size_t buf_len,
3784 size_t *olen)
3785{
3786 unsigned char *p = buf;
3787#if defined(MBEDTLS_SSL_CLI_C) && \
3788 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
3789 size_t hostname_len = (session->hostname == NULL) ?
3790 0 : strlen(session->hostname) + 1;
3791#endif
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003792
3793#if defined(MBEDTLS_SSL_SRV_C) && \
3794 defined(MBEDTLS_SSL_EARLY_DATA) && defined(MBEDTLS_SSL_ALPN)
Waleed Elmelegydaa4da72024-03-13 16:25:34 +00003795 const size_t alpn_len = (session->ticket_alpn == NULL) ?
Waleed Elmelegyb28ab0a2024-03-13 16:48:28 +00003796 0 : strlen(session->ticket_alpn) + 1;
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003797#endif
David Horstmanne59f9702024-02-29 16:08:57 +00003798 size_t needed = 4 /* ticket_age_add */
3799 + 1 /* ticket_flags */
3800 + 1; /* resumption_key length */
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003801
David Horstmanne59f9702024-02-29 16:08:57 +00003802 *olen = 0;
3803
3804 if (session->resumption_key_len > MBEDTLS_SSL_TLS1_3_TICKET_RESUMPTION_KEY_LEN) {
3805 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3806 }
3807 needed += session->resumption_key_len; /* resumption_key */
3808
3809#if defined(MBEDTLS_SSL_EARLY_DATA)
3810 needed += 4; /* max_early_data_size */
3811#endif
3812#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
3813 needed += 2; /* record_size_limit */
3814#endif /* MBEDTLS_SSL_RECORD_SIZE_LIMIT */
3815
3816#if defined(MBEDTLS_HAVE_TIME)
3817 needed += 8; /* ticket_creation_time or ticket_reception_time */
3818#endif
3819
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003820#if defined(MBEDTLS_SSL_SRV_C)
3821 if (session->endpoint == MBEDTLS_SSL_IS_SERVER) {
3822#if defined(MBEDTLS_SSL_EARLY_DATA) && defined(MBEDTLS_SSL_ALPN)
Waleed Elmelegydaa4da72024-03-13 16:25:34 +00003823 needed += 2 /* alpn_len */
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003824 + alpn_len; /* alpn */
3825#endif
3826 }
3827#endif /* MBEDTLS_SSL_SRV_C */
3828
David Horstmanne59f9702024-02-29 16:08:57 +00003829#if defined(MBEDTLS_SSL_CLI_C)
3830 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
3831#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
3832 needed += 2 /* hostname_len */
3833 + hostname_len; /* hostname */
3834#endif
3835
3836 needed += 4 /* ticket_lifetime */
3837 + 2; /* ticket_len */
3838
3839 /* Check size_t overflow */
3840 if (session->ticket_len > SIZE_MAX - needed) {
3841 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3842 }
3843
3844 needed += session->ticket_len; /* ticket */
3845 }
3846#endif /* MBEDTLS_SSL_CLI_C */
3847
3848 *olen = needed;
3849 if (needed > buf_len) {
3850 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
3851 }
3852
3853 MBEDTLS_PUT_UINT32_BE(session->ticket_age_add, p, 0);
3854 p[4] = session->ticket_flags;
3855
3856 /* save resumption_key */
3857 p[5] = session->resumption_key_len;
3858 p += 6;
3859 memcpy(p, session->resumption_key, session->resumption_key_len);
3860 p += session->resumption_key_len;
3861
3862#if defined(MBEDTLS_SSL_EARLY_DATA)
3863 MBEDTLS_PUT_UINT32_BE(session->max_early_data_size, p, 0);
3864 p += 4;
3865#endif
3866#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
3867 MBEDTLS_PUT_UINT16_BE(session->record_size_limit, p, 0);
3868 p += 2;
3869#endif /* MBEDTLS_SSL_RECORD_SIZE_LIMIT */
3870
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003871#if defined(MBEDTLS_SSL_SRV_C)
David Horstmanne59f9702024-02-29 16:08:57 +00003872 if (session->endpoint == MBEDTLS_SSL_IS_SERVER) {
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003873#if defined(MBEDTLS_HAVE_TIME)
David Horstmanne59f9702024-02-29 16:08:57 +00003874 MBEDTLS_PUT_UINT64_BE((uint64_t) session->ticket_creation_time, p, 0);
3875 p += 8;
David Horstmanne59f9702024-02-29 16:08:57 +00003876#endif /* MBEDTLS_HAVE_TIME */
3877
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003878#if defined(MBEDTLS_SSL_EARLY_DATA) && defined(MBEDTLS_SSL_ALPN)
Waleed Elmelegydaa4da72024-03-13 16:25:34 +00003879 MBEDTLS_PUT_UINT16_BE(alpn_len, p, 0);
3880 p += 2;
3881
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003882 if (alpn_len > 0) {
3883 /* save chosen alpn */
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00003884 memcpy(p, session->ticket_alpn, alpn_len);
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003885 p += alpn_len;
3886 }
3887#endif /* MBEDTLS_SSL_EARLY_DATA && MBEDTLS_SSL_ALPN */
3888 }
3889#endif /* MBEDTLS_SSL_SRV_C */
3890
David Horstmanne59f9702024-02-29 16:08:57 +00003891#if defined(MBEDTLS_SSL_CLI_C)
3892 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
3893#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
3894 MBEDTLS_PUT_UINT16_BE(hostname_len, p, 0);
3895 p += 2;
3896 if (hostname_len > 0) {
3897 /* save host name */
3898 memcpy(p, session->hostname, hostname_len);
3899 p += hostname_len;
3900 }
3901#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
3902
3903#if defined(MBEDTLS_HAVE_TIME)
3904 MBEDTLS_PUT_UINT64_BE((uint64_t) session->ticket_reception_time, p, 0);
3905 p += 8;
3906#endif
3907 MBEDTLS_PUT_UINT32_BE(session->ticket_lifetime, p, 0);
3908 p += 4;
3909
3910 MBEDTLS_PUT_UINT16_BE(session->ticket_len, p, 0);
3911 p += 2;
3912
3913 if (session->ticket != NULL && session->ticket_len > 0) {
3914 memcpy(p, session->ticket, session->ticket_len);
3915 p += session->ticket_len;
3916 }
3917 }
3918#endif /* MBEDTLS_SSL_CLI_C */
3919 return 0;
3920}
3921
3922MBEDTLS_CHECK_RETURN_CRITICAL
3923static int ssl_tls13_session_load(mbedtls_ssl_session *session,
3924 const unsigned char *buf,
3925 size_t len)
3926{
3927 const unsigned char *p = buf;
3928 const unsigned char *end = buf + len;
3929
3930 if (end - p < 6) {
3931 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3932 }
3933 session->ticket_age_add = MBEDTLS_GET_UINT32_BE(p, 0);
3934 session->ticket_flags = p[4];
3935
3936 /* load resumption_key */
3937 session->resumption_key_len = p[5];
3938 p += 6;
3939
3940 if (end - p < session->resumption_key_len) {
3941 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3942 }
3943
3944 if (sizeof(session->resumption_key) < session->resumption_key_len) {
3945 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3946 }
3947 memcpy(session->resumption_key, p, session->resumption_key_len);
3948 p += session->resumption_key_len;
3949
3950#if defined(MBEDTLS_SSL_EARLY_DATA)
3951 if (end - p < 4) {
3952 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3953 }
3954 session->max_early_data_size = MBEDTLS_GET_UINT32_BE(p, 0);
3955 p += 4;
3956#endif
3957#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
3958 if (end - p < 2) {
3959 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3960 }
3961 session->record_size_limit = MBEDTLS_GET_UINT16_BE(p, 0);
3962 p += 2;
3963#endif /* MBEDTLS_SSL_RECORD_SIZE_LIMIT */
3964
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003965#if defined(MBEDTLS_SSL_SRV_C)
David Horstmanne59f9702024-02-29 16:08:57 +00003966 if (session->endpoint == MBEDTLS_SSL_IS_SERVER) {
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003967#if defined(MBEDTLS_HAVE_TIME)
David Horstmanne59f9702024-02-29 16:08:57 +00003968 if (end - p < 8) {
3969 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3970 }
3971 session->ticket_creation_time = MBEDTLS_GET_UINT64_BE(p, 0);
3972 p += 8;
David Horstmanne59f9702024-02-29 16:08:57 +00003973#endif /* MBEDTLS_HAVE_TIME */
3974
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003975#if defined(MBEDTLS_SSL_EARLY_DATA) && defined(MBEDTLS_SSL_ALPN)
Waleed Elmelegydaa4da72024-03-13 16:25:34 +00003976 size_t alpn_len;
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003977
Waleed Elmelegydaa4da72024-03-13 16:25:34 +00003978 if (end - p < 2) {
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003979 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3980 }
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00003981
Waleed Elmelegydaa4da72024-03-13 16:25:34 +00003982 alpn_len = MBEDTLS_GET_UINT16_BE(p, 0);
3983 p += 2;
3984
3985 if (end - p < (long int) alpn_len) {
Waleed Elmelegy7dfba342024-03-12 16:22:39 +00003986 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3987 }
3988
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003989 if (alpn_len > 0) {
Waleed Elmelegydaa4da72024-03-13 16:25:34 +00003990 int ret = mbedtls_ssl_session_set_ticket_alpn(session, (char *) p);
3991 if (ret != 0) {
3992 return ret;
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003993 }
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003994 p += alpn_len;
3995 }
3996#endif /* MBEDTLS_SSL_EARLY_DATA && MBEDTLS_SSL_ALPN */
3997 }
3998#endif /* MBEDTLS_SSL_SRV_C */
3999
David Horstmanne59f9702024-02-29 16:08:57 +00004000#if defined(MBEDTLS_SSL_CLI_C)
4001 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
4002#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
4003 size_t hostname_len;
4004 /* load host name */
4005 if (end - p < 2) {
4006 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4007 }
4008 hostname_len = MBEDTLS_GET_UINT16_BE(p, 0);
4009 p += 2;
4010
4011 if (end - p < (long int) hostname_len) {
4012 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4013 }
4014 if (hostname_len > 0) {
4015 session->hostname = mbedtls_calloc(1, hostname_len);
4016 if (session->hostname == NULL) {
4017 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
4018 }
4019 memcpy(session->hostname, p, hostname_len);
4020 p += hostname_len;
4021 }
4022#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
4023
4024#if defined(MBEDTLS_HAVE_TIME)
4025 if (end - p < 8) {
4026 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4027 }
4028 session->ticket_reception_time = MBEDTLS_GET_UINT64_BE(p, 0);
4029 p += 8;
4030#endif
4031 if (end - p < 4) {
4032 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4033 }
4034 session->ticket_lifetime = MBEDTLS_GET_UINT32_BE(p, 0);
4035 p += 4;
4036
4037 if (end - p < 2) {
4038 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4039 }
4040 session->ticket_len = MBEDTLS_GET_UINT16_BE(p, 0);
4041 p += 2;
4042
4043 if (end - p < (long int) session->ticket_len) {
4044 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4045 }
4046 if (session->ticket_len > 0) {
4047 session->ticket = mbedtls_calloc(1, session->ticket_len);
4048 if (session->ticket == NULL) {
4049 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
4050 }
4051 memcpy(session->ticket, p, session->ticket_len);
4052 p += session->ticket_len;
4053 }
4054 }
4055#endif /* MBEDTLS_SSL_CLI_C */
4056
4057 return 0;
4058
4059}
4060#else /* MBEDTLS_SSL_SESSION_TICKETS */
4061MBEDTLS_CHECK_RETURN_CRITICAL
4062static int ssl_tls13_session_save(const mbedtls_ssl_session *session,
4063 unsigned char *buf,
4064 size_t buf_len,
4065 size_t *olen)
4066{
4067 ((void) session);
4068 ((void) buf);
4069 ((void) buf_len);
4070 *olen = 0;
4071 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
4072}
4073
4074static int ssl_tls13_session_load(const mbedtls_ssl_session *session,
Norbert Fabritius93b2c322023-01-24 17:48:29 +01004075 const unsigned char *buf,
David Horstmanne59f9702024-02-29 16:08:57 +00004076 size_t buf_len)
4077{
4078 ((void) session);
4079 ((void) buf);
4080 ((void) buf_len);
4081 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
4082}
4083#endif /* !MBEDTLS_SSL_SESSION_TICKETS */
4084#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
4085
Paul Bakker5121ce52009-01-03 21:22:43 +00004086/*
Hanno Beckera835da52019-05-16 12:39:07 +01004087 * Define ticket header determining Mbed TLS version
4088 * and structure of the ticket.
4089 */
4090
Hanno Becker94ef3b32019-05-16 12:50:45 +01004091/*
Hanno Becker50b59662019-05-28 14:30:45 +01004092 * Define bitflag determining compile-time settings influencing
4093 * structure of serialized SSL sessions.
Hanno Becker94ef3b32019-05-16 12:50:45 +01004094 */
4095
Hanno Becker50b59662019-05-28 14:30:45 +01004096#if defined(MBEDTLS_HAVE_TIME)
Hanno Becker3e088662019-05-29 11:10:18 +01004097#define SSL_SERIALIZED_SESSION_CONFIG_TIME 1
Hanno Becker50b59662019-05-28 14:30:45 +01004098#else
Hanno Becker3e088662019-05-29 11:10:18 +01004099#define SSL_SERIALIZED_SESSION_CONFIG_TIME 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01004100#endif /* MBEDTLS_HAVE_TIME */
4101
4102#if defined(MBEDTLS_X509_CRT_PARSE_C)
Hanno Becker3e088662019-05-29 11:10:18 +01004103#define SSL_SERIALIZED_SESSION_CONFIG_CRT 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01004104#else
Hanno Becker3e088662019-05-29 11:10:18 +01004105#define SSL_SERIALIZED_SESSION_CONFIG_CRT 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01004106#endif /* MBEDTLS_X509_CRT_PARSE_C */
4107
David Horstmann5c5a32f2024-02-13 17:53:35 +00004108#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
David Horstmannf686f1d2024-03-01 11:20:32 +00004109#define SSL_SERIALIZED_SESSION_CONFIG_KEEP_PEER_CRT 1
David Horstmann5c5a32f2024-02-13 17:53:35 +00004110#else
David Horstmannf686f1d2024-03-01 11:20:32 +00004111#define SSL_SERIALIZED_SESSION_CONFIG_KEEP_PEER_CRT 0
David Horstmann5c5a32f2024-02-13 17:53:35 +00004112#endif /* MBEDTLS_SSL_SESSION_TICKETS */
4113
Hanno Becker94ef3b32019-05-16 12:50:45 +01004114#if defined(MBEDTLS_SSL_CLI_C) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Hanno Becker3e088662019-05-29 11:10:18 +01004115#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01004116#else
Hanno Becker3e088662019-05-29 11:10:18 +01004117#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01004118#endif /* MBEDTLS_SSL_CLI_C && MBEDTLS_SSL_SESSION_TICKETS */
4119
4120#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Hanno Becker3e088662019-05-29 11:10:18 +01004121#define SSL_SERIALIZED_SESSION_CONFIG_MFL 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01004122#else
Hanno Becker3e088662019-05-29 11:10:18 +01004123#define SSL_SERIALIZED_SESSION_CONFIG_MFL 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01004124#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
4125
Hanno Becker94ef3b32019-05-16 12:50:45 +01004126#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Hanno Becker3e088662019-05-29 11:10:18 +01004127#define SSL_SERIALIZED_SESSION_CONFIG_ETM 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01004128#else
Hanno Becker3e088662019-05-29 11:10:18 +01004129#define SSL_SERIALIZED_SESSION_CONFIG_ETM 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01004130#endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC */
4131
Hanno Becker94ef3b32019-05-16 12:50:45 +01004132#if defined(MBEDTLS_SSL_SESSION_TICKETS)
4133#define SSL_SERIALIZED_SESSION_CONFIG_TICKET 1
4134#else
4135#define SSL_SERIALIZED_SESSION_CONFIG_TICKET 0
4136#endif /* MBEDTLS_SSL_SESSION_TICKETS */
4137
David Horstmann92b258b2024-02-13 17:23:34 +00004138#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
4139#define SSL_SERIALIZED_SESSION_CONFIG_SNI 1
4140#else
4141#define SSL_SERIALIZED_SESSION_CONFIG_SNI 0
4142#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
4143
4144#if defined(MBEDTLS_SSL_EARLY_DATA)
4145#define SSL_SERIALIZED_SESSION_CONFIG_EARLY_DATA 1
4146#else
4147#define SSL_SERIALIZED_SESSION_CONFIG_EARLY_DATA 0
4148#endif /* MBEDTLS_SSL_EARLY_DATA */
4149
4150#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
4151#define SSL_SERIALIZED_SESSION_CONFIG_RECORD_SIZE 1
4152#else
4153#define SSL_SERIALIZED_SESSION_CONFIG_RECORD_SIZE 0
4154#endif /* MBEDTLS_SSL_RECORD_SIZE_LIMIT */
4155
Waleed Elmelegy7dfba342024-03-12 16:22:39 +00004156#if defined(MBEDTLS_SSL_ALPN) && defined(MBEDTLS_SSL_SRV_C) && \
4157 defined(MBEDTLS_SSL_EARLY_DATA)
Waleed Elmelegy11025632024-03-07 15:25:52 +00004158#define SSL_SERIALIZED_SESSION_CONFIG_ALPN 1
4159#else
4160#define SSL_SERIALIZED_SESSION_CONFIG_ALPN 0
4161#endif /* MBEDTLS_SSL_ALPN */
4162
Hanno Becker3e088662019-05-29 11:10:18 +01004163#define SSL_SERIALIZED_SESSION_CONFIG_TIME_BIT 0
4164#define SSL_SERIALIZED_SESSION_CONFIG_CRT_BIT 1
4165#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET_BIT 2
4166#define SSL_SERIALIZED_SESSION_CONFIG_MFL_BIT 3
Hanno Becker37bdbe62021-08-01 05:38:58 +01004167#define SSL_SERIALIZED_SESSION_CONFIG_ETM_BIT 4
4168#define SSL_SERIALIZED_SESSION_CONFIG_TICKET_BIT 5
David Horstmannf686f1d2024-03-01 11:20:32 +00004169#define SSL_SERIALIZED_SESSION_CONFIG_KEEP_PEER_CRT_BIT 6
David Horstmann92b258b2024-02-13 17:23:34 +00004170#define SSL_SERIALIZED_SESSION_CONFIG_SNI_BIT 7
4171#define SSL_SERIALIZED_SESSION_CONFIG_EARLY_DATA_BIT 8
4172#define SSL_SERIALIZED_SESSION_CONFIG_RECORD_SIZE_BIT 9
Waleed Elmelegy11025632024-03-07 15:25:52 +00004173#define SSL_SERIALIZED_SESSION_CONFIG_ALPN_BIT 10
Hanno Becker3e088662019-05-29 11:10:18 +01004174
Hanno Becker50b59662019-05-28 14:30:45 +01004175#define SSL_SERIALIZED_SESSION_CONFIG_BITFLAG \
Gilles Peskine449bd832023-01-11 14:50:10 +01004176 ((uint16_t) ( \
4177 (SSL_SERIALIZED_SESSION_CONFIG_TIME << SSL_SERIALIZED_SESSION_CONFIG_TIME_BIT) | \
4178 (SSL_SERIALIZED_SESSION_CONFIG_CRT << SSL_SERIALIZED_SESSION_CONFIG_CRT_BIT) | \
4179 (SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET << \
4180 SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET_BIT) | \
4181 (SSL_SERIALIZED_SESSION_CONFIG_MFL << SSL_SERIALIZED_SESSION_CONFIG_MFL_BIT) | \
4182 (SSL_SERIALIZED_SESSION_CONFIG_ETM << SSL_SERIALIZED_SESSION_CONFIG_ETM_BIT) | \
David Horstmann5c5a32f2024-02-13 17:53:35 +00004183 (SSL_SERIALIZED_SESSION_CONFIG_TICKET << SSL_SERIALIZED_SESSION_CONFIG_TICKET_BIT) | \
David Horstmann71fa1a92024-03-01 12:32:18 +00004184 (SSL_SERIALIZED_SESSION_CONFIG_KEEP_PEER_CRT << \
4185 SSL_SERIALIZED_SESSION_CONFIG_KEEP_PEER_CRT_BIT) | \
David Horstmann92b258b2024-02-13 17:23:34 +00004186 (SSL_SERIALIZED_SESSION_CONFIG_SNI << SSL_SERIALIZED_SESSION_CONFIG_SNI_BIT) | \
4187 (SSL_SERIALIZED_SESSION_CONFIG_EARLY_DATA << \
4188 SSL_SERIALIZED_SESSION_CONFIG_EARLY_DATA_BIT) | \
4189 (SSL_SERIALIZED_SESSION_CONFIG_RECORD_SIZE << \
Waleed Elmelegy11025632024-03-07 15:25:52 +00004190 SSL_SERIALIZED_SESSION_CONFIG_RECORD_SIZE_BIT) | \
Waleed Elmelegy75e33fa2024-03-07 16:57:58 +00004191 (SSL_SERIALIZED_SESSION_CONFIG_ALPN << \
Waleed Elmelegy11025632024-03-07 15:25:52 +00004192 SSL_SERIALIZED_SESSION_CONFIG_ALPN_BIT)))
Hanno Becker94ef3b32019-05-16 12:50:45 +01004193
Chien Wong4e9683e2023-12-28 17:07:43 +08004194static const unsigned char ssl_serialized_session_header[] = {
Hanno Becker94ef3b32019-05-16 12:50:45 +01004195 MBEDTLS_VERSION_MAJOR,
4196 MBEDTLS_VERSION_MINOR,
4197 MBEDTLS_VERSION_PATCH,
Gilles Peskine449bd832023-01-11 14:50:10 +01004198 MBEDTLS_BYTE_1(SSL_SERIALIZED_SESSION_CONFIG_BITFLAG),
4199 MBEDTLS_BYTE_0(SSL_SERIALIZED_SESSION_CONFIG_BITFLAG),
Hanno Beckerf8787072019-05-16 12:41:07 +01004200};
Hanno Beckera835da52019-05-16 12:39:07 +01004201
4202/*
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004203 * Serialize a session in the following format:
Manuel Pégourié-Gonnard35eb8022019-05-16 11:11:08 +02004204 * (in the presentation language of TLS, RFC 8446 section 3)
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004205 *
David Horstmanncb01b362024-02-29 17:31:46 +00004206 * TLS 1.2 session:
4207 *
4208 * struct {
4209 * #if defined(MBEDTLS_SSL_SESSION_TICKETS)
4210 * opaque ticket<0..2^24-1>; // length 0 means no ticket
4211 * uint32 ticket_lifetime;
4212 * #endif
4213 * } ClientOnlyData;
4214 *
4215 * struct {
4216 * #if defined(MBEDTLS_HAVE_TIME)
4217 * uint64 start_time;
4218 * #endif
4219 * uint8 session_id_len; // at most 32
4220 * opaque session_id[32];
4221 * opaque master[48]; // fixed length in the standard
4222 * uint32 verify_result;
4223 * #if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
4224 * opaque peer_cert<0..2^24-1>; // length 0 means no peer cert
4225 * #else
David Horstmann76ba26a2024-03-01 12:03:35 +00004226 * uint8 peer_cert_digest_type;
David Horstmanncb01b362024-02-29 17:31:46 +00004227 * opaque peer_cert_digest<0..2^8-1>
4228 * #endif
4229 * select (endpoint) {
4230 * case client: ClientOnlyData;
4231 * case server: uint64 ticket_creation_time;
4232 * };
4233 * #if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
4234 * uint8 mfl_code; // up to 255 according to standard
4235 * #endif
4236 * #if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
4237 * uint8 encrypt_then_mac; // 0 or 1
4238 * #endif
4239 * } serialized_session_tls12;
4240 *
4241 *
4242 * TLS 1.3 Session:
4243 *
4244 * struct {
4245 * #if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
4246 * opaque hostname<0..2^16-1>;
4247 * #endif
4248 * #if defined(MBEDTLS_HAVE_TIME)
4249 * uint64 ticket_reception_time;
4250 * #endif
4251 * uint32 ticket_lifetime;
4252 * opaque ticket<1..2^16-1>;
4253 * } ClientOnlyData;
4254 *
4255 * struct {
4256 * uint32 ticket_age_add;
4257 * uint8 ticket_flags;
4258 * opaque resumption_key<0..255>;
4259 * #if defined(MBEDTLS_SSL_EARLY_DATA)
4260 * uint32 max_early_data_size;
4261 * #endif
4262 * #if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
4263 * uint16 record_size_limit;
4264 * #endif
4265 * select ( endpoint ) {
4266 * case client: ClientOnlyData;
Waleed Elmelegy7dfba342024-03-12 16:22:39 +00004267 * case server:
David Horstmanncb01b362024-02-29 17:31:46 +00004268 * #if defined(MBEDTLS_HAVE_TIME)
Waleed Elmelegy7dfba342024-03-12 16:22:39 +00004269 * uint64 ticket_creation_time;
David Horstmanncb01b362024-02-29 17:31:46 +00004270 * #endif
Waleed Elmelegyfe9ae082024-03-07 15:47:31 +00004271 * #if defined(MBEDTLS_SSL_EARLY_DATA) && defined(MBEDTLS_SSL_ALPN)
Waleed Elmelegydaa4da72024-03-13 16:25:34 +00004272 * opaque ticket_alpn<0..256>;
David Horstmanncb01b362024-02-29 17:31:46 +00004273 * #endif
4274 * };
4275 * } serialized_session_tls13;
4276 *
4277 *
4278 * SSL session:
4279 *
4280 * struct {
Hanno Beckerdc28b6c2019-05-29 11:08:00 +01004281 *
Hanno Beckerdce50972021-08-01 05:39:23 +01004282 * opaque mbedtls_version[3]; // library version: major, minor, patch
4283 * opaque session_format[2]; // library-version specific 16-bit field
4284 * // determining the format of the remaining
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004285 * // serialized data.
Hanno Beckerdc28b6c2019-05-29 11:08:00 +01004286 *
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004287 * Note: When updating the format, remember to keep
4288 * these version+format bytes.
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004289 *
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004290 * // In this version, `session_format` determines
4291 * // the setting of those compile-time
4292 * // configuration options which influence
4293 * // the structure of mbedtls_ssl_session.
4294 *
Glenn Straussda7851c2022-03-14 13:29:48 -04004295 * uint8_t minor_ver; // Protocol minor version. Possible values:
Jerry Yu0c2a7382022-12-06 13:27:25 +08004296 * // - TLS 1.2 (0x0303)
4297 * // - TLS 1.3 (0x0304)
David Horstmann531aca22024-02-29 18:14:28 +00004298 * uint8_t endpoint;
4299 * uint16_t ciphersuite;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004300 *
Glenn Straussda7851c2022-03-14 13:29:48 -04004301 * select (serialized_session.tls_version) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004302 *
Glenn Straussda7851c2022-03-14 13:29:48 -04004303 * case MBEDTLS_SSL_VERSION_TLS1_2:
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004304 * serialized_session_tls12 data;
Jerry Yu0c2a7382022-12-06 13:27:25 +08004305 * case MBEDTLS_SSL_VERSION_TLS1_3:
Jerry Yuddda0502022-12-01 19:43:12 +08004306 * serialized_session_tls13 data;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004307 *
4308 * };
4309 *
4310 * } serialized_session;
4311 *
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004312 */
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004313
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004314MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004315static int ssl_session_save(const mbedtls_ssl_session *session,
4316 unsigned char omit_header,
4317 unsigned char *buf,
4318 size_t buf_len,
4319 size_t *olen)
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004320{
4321 unsigned char *p = buf;
4322 size_t used = 0;
Jerry Yu251a12e2022-07-13 15:15:48 +08004323 size_t remaining_len;
Jerry Yue36fdd62022-08-17 21:31:36 +08004324#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
4325 size_t out_len;
4326 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
4327#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01004328 if (session == NULL) {
4329 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
4330 }
Jerry Yu438ddd82022-07-07 06:55:50 +00004331
Gilles Peskine449bd832023-01-11 14:50:10 +01004332 if (!omit_header) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004333 /*
4334 * Add Mbed TLS version identifier
4335 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004336 used += sizeof(ssl_serialized_session_header);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004337
Gilles Peskine449bd832023-01-11 14:50:10 +01004338 if (used <= buf_len) {
4339 memcpy(p, ssl_serialized_session_header,
4340 sizeof(ssl_serialized_session_header));
4341 p += sizeof(ssl_serialized_session_header);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004342 }
4343 }
4344
4345 /*
Ronald Cron40a4ab02024-01-15 10:21:30 +01004346 * TLS version identifier, endpoint, ciphersuite
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004347 */
Ronald Cron40a4ab02024-01-15 10:21:30 +01004348 used += 1 /* TLS version */
4349 + 1 /* endpoint */
4350 + 2; /* ciphersuite */
Gilles Peskine449bd832023-01-11 14:50:10 +01004351 if (used <= buf_len) {
4352 *p++ = MBEDTLS_BYTE_0(session->tls_version);
Ronald Cron40a4ab02024-01-15 10:21:30 +01004353 *p++ = session->endpoint;
4354 MBEDTLS_PUT_UINT16_BE(session->ciphersuite, p, 0);
4355 p += 2;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004356 }
4357
4358 /* Forward to version-specific serialization routine. */
Jerry Yufca4d572022-07-21 10:37:48 +08004359 remaining_len = (buf_len >= used) ? buf_len - used : 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01004360 switch (session->tls_version) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004361#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01004362 case MBEDTLS_SSL_VERSION_TLS1_2:
4363 used += ssl_tls12_session_save(session, p, remaining_len);
4364 break;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004365#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
4366
Jerry Yu251a12e2022-07-13 15:15:48 +08004367#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004368 case MBEDTLS_SSL_VERSION_TLS1_3:
4369 ret = ssl_tls13_session_save(session, p, remaining_len, &out_len);
4370 if (ret != 0 && ret != MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL) {
4371 return ret;
4372 }
4373 used += out_len;
4374 break;
Jerry Yu251a12e2022-07-13 15:15:48 +08004375#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
4376
Gilles Peskine449bd832023-01-11 14:50:10 +01004377 default:
4378 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004379 }
4380
4381 *olen = used;
Gilles Peskine449bd832023-01-11 14:50:10 +01004382 if (used > buf_len) {
4383 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
4384 }
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004385
Gilles Peskine449bd832023-01-11 14:50:10 +01004386 return 0;
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004387}
4388
4389/*
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02004390 * Public wrapper for ssl_session_save()
4391 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004392int mbedtls_ssl_session_save(const mbedtls_ssl_session *session,
4393 unsigned char *buf,
4394 size_t buf_len,
4395 size_t *olen)
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02004396{
Gilles Peskine449bd832023-01-11 14:50:10 +01004397 return ssl_session_save(session, 0, buf, buf_len, olen);
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02004398}
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004399
Jerry Yuf1b23ca2022-02-18 11:48:47 +08004400/*
4401 * Deserialize session, see mbedtls_ssl_session_save() for format.
4402 *
4403 * This internal version is wrapped by a public function that cleans up in
4404 * case of error, and has an extra option omit_header.
4405 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004406MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004407static int ssl_session_load(mbedtls_ssl_session *session,
4408 unsigned char omit_header,
4409 const unsigned char *buf,
4410 size_t len)
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004411{
4412 const unsigned char *p = buf;
4413 const unsigned char * const end = buf + len;
Jerry Yu438ddd82022-07-07 06:55:50 +00004414 size_t remaining_len;
4415
4416
Gilles Peskine449bd832023-01-11 14:50:10 +01004417 if (session == NULL) {
4418 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
4419 }
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004420
Gilles Peskine449bd832023-01-11 14:50:10 +01004421 if (!omit_header) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004422 /*
4423 * Check Mbed TLS version identifier
4424 */
4425
Gilles Peskine449bd832023-01-11 14:50:10 +01004426 if ((size_t) (end - p) < sizeof(ssl_serialized_session_header)) {
4427 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004428 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004429
4430 if (memcmp(p, ssl_serialized_session_header,
4431 sizeof(ssl_serialized_session_header)) != 0) {
4432 return MBEDTLS_ERR_SSL_VERSION_MISMATCH;
4433 }
4434 p += sizeof(ssl_serialized_session_header);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004435 }
4436
4437 /*
Ronald Cron40a4ab02024-01-15 10:21:30 +01004438 * TLS version identifier, endpoint, ciphersuite
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004439 */
Ronald Cron40a4ab02024-01-15 10:21:30 +01004440 if (4 > (size_t) (end - p)) {
Gilles Peskine449bd832023-01-11 14:50:10 +01004441 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4442 }
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01004443 session->tls_version = (mbedtls_ssl_protocol_version) (0x0300 | *p++);
Ronald Cron40a4ab02024-01-15 10:21:30 +01004444 session->endpoint = *p++;
4445 session->ciphersuite = MBEDTLS_GET_UINT16_BE(p, 0);
4446 p += 2;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004447
4448 /* Dispatch according to TLS version. */
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00004449 remaining_len = (size_t) (end - p);
Gilles Peskine449bd832023-01-11 14:50:10 +01004450 switch (session->tls_version) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004451#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01004452 case MBEDTLS_SSL_VERSION_TLS1_2:
4453 return ssl_tls12_session_load(session, p, remaining_len);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004454#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
4455
Jerry Yu438ddd82022-07-07 06:55:50 +00004456#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004457 case MBEDTLS_SSL_VERSION_TLS1_3:
4458 return ssl_tls13_session_load(session, p, remaining_len);
Jerry Yu438ddd82022-07-07 06:55:50 +00004459#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
4460
Gilles Peskine449bd832023-01-11 14:50:10 +01004461 default:
4462 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004463 }
4464}
4465
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004466/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02004467 * Deserialize session: public wrapper for error cleaning
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02004468 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004469int mbedtls_ssl_session_load(mbedtls_ssl_session *session,
4470 const unsigned char *buf,
4471 size_t len)
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02004472{
Gilles Peskine449bd832023-01-11 14:50:10 +01004473 int ret = ssl_session_load(session, 0, buf, len);
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02004474
Gilles Peskine449bd832023-01-11 14:50:10 +01004475 if (ret != 0) {
4476 mbedtls_ssl_session_free(session);
4477 }
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02004478
Gilles Peskine449bd832023-01-11 14:50:10 +01004479 return ret;
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02004480}
4481
4482/*
Paul Bakker1961b702013-01-25 14:49:24 +01004483 * Perform a single step of the SSL handshake
Paul Bakker5121ce52009-01-03 21:22:43 +00004484 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004485MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004486static int ssl_prepare_handshake_step(mbedtls_ssl_context *ssl)
Hanno Becker41934dd2021-08-07 19:13:43 +01004487{
4488 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
4489
Ronald Cron66dbf912022-02-02 15:33:46 +01004490 /*
4491 * We may have not been able to send to the peer all the handshake data
Ronald Cron3f20b772022-03-08 16:00:02 +01004492 * that were written into the output buffer by the previous handshake step,
4493 * if the write to the network callback returned with the
Ronald Cron66dbf912022-02-02 15:33:46 +01004494 * #MBEDTLS_ERR_SSL_WANT_WRITE error code.
4495 * We proceed to the next handshake step only when all data from the
4496 * previous one have been sent to the peer, thus we make sure that this is
4497 * the case here by calling `mbedtls_ssl_flush_output()`. The function may
4498 * return with the #MBEDTLS_ERR_SSL_WANT_WRITE error code in which case
4499 * we have to wait before to go ahead.
4500 * In the case of TLS 1.3, handshake step handlers do not send data to the
4501 * peer. Data are only sent here and through
4502 * `mbedtls_ssl_handle_pending_alert` in case an error that triggered an
Andrzej Kurek5c65c572022-04-13 14:28:52 -04004503 * alert occurred.
Ronald Cron66dbf912022-02-02 15:33:46 +01004504 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004505 if ((ret = mbedtls_ssl_flush_output(ssl)) != 0) {
4506 return ret;
4507 }
Hanno Becker41934dd2021-08-07 19:13:43 +01004508
4509#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004510 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
4511 ssl->handshake->retransmit_state == MBEDTLS_SSL_RETRANS_SENDING) {
4512 if ((ret = mbedtls_ssl_flight_transmit(ssl)) != 0) {
4513 return ret;
4514 }
Hanno Becker41934dd2021-08-07 19:13:43 +01004515 }
4516#endif /* MBEDTLS_SSL_PROTO_DTLS */
4517
Gilles Peskine449bd832023-01-11 14:50:10 +01004518 return ret;
Hanno Becker41934dd2021-08-07 19:13:43 +01004519}
4520
Gilles Peskine449bd832023-01-11 14:50:10 +01004521int mbedtls_ssl_handshake_step(mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00004522{
Hanno Becker41934dd2021-08-07 19:13:43 +01004523 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00004524
Gilles Peskine449bd832023-01-11 14:50:10 +01004525 if (ssl == NULL ||
Hanno Becker41934dd2021-08-07 19:13:43 +01004526 ssl->conf == NULL ||
4527 ssl->handshake == NULL ||
Gilles Peskine449bd832023-01-11 14:50:10 +01004528 ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER) {
4529 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Becker41934dd2021-08-07 19:13:43 +01004530 }
4531
Gilles Peskine449bd832023-01-11 14:50:10 +01004532 ret = ssl_prepare_handshake_step(ssl);
4533 if (ret != 0) {
4534 return ret;
4535 }
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02004536
Gilles Peskine449bd832023-01-11 14:50:10 +01004537 ret = mbedtls_ssl_handle_pending_alert(ssl);
4538 if (ret != 0) {
Jerry Yue7047812021-09-13 19:26:39 +08004539 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01004540 }
Jerry Yue7047812021-09-13 19:26:39 +08004541
Tom Cosgrove2fdc7b32022-09-21 12:33:17 +01004542 /* If ssl->conf->endpoint is not one of MBEDTLS_SSL_IS_CLIENT or
4543 * MBEDTLS_SSL_IS_SERVER, this is the return code we give */
4544 ret = MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4545
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004546#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004547 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
4548 MBEDTLS_SSL_DEBUG_MSG(2, ("client state: %s",
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01004549 mbedtls_ssl_states_str((mbedtls_ssl_states) ssl->state)));
Jerry Yub9930e72021-08-06 17:11:51 +08004550
Gilles Peskine449bd832023-01-11 14:50:10 +01004551 switch (ssl->state) {
Ronald Cron9f0fba32022-02-10 16:45:15 +01004552 case MBEDTLS_SSL_HELLO_REQUEST:
4553 ssl->state = MBEDTLS_SSL_CLIENT_HELLO;
Tom Cosgrove87d9c6c2022-09-22 09:27:56 +01004554 ret = 0;
Ronald Cron9f0fba32022-02-10 16:45:15 +01004555 break;
Jerry Yub9930e72021-08-06 17:11:51 +08004556
Ronald Cron9f0fba32022-02-10 16:45:15 +01004557 case MBEDTLS_SSL_CLIENT_HELLO:
Gilles Peskine449bd832023-01-11 14:50:10 +01004558 ret = mbedtls_ssl_write_client_hello(ssl);
Ronald Cron9f0fba32022-02-10 16:45:15 +01004559 break;
4560
4561 default:
4562#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004563 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
4564 ret = mbedtls_ssl_tls13_handshake_client_step(ssl);
4565 } else {
4566 ret = mbedtls_ssl_handshake_client_step(ssl);
4567 }
Ronald Cron9f0fba32022-02-10 16:45:15 +01004568#elif defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01004569 ret = mbedtls_ssl_handshake_client_step(ssl);
Ronald Cron9f0fba32022-02-10 16:45:15 +01004570#else
Gilles Peskine449bd832023-01-11 14:50:10 +01004571 ret = mbedtls_ssl_tls13_handshake_client_step(ssl);
Ronald Cron9f0fba32022-02-10 16:45:15 +01004572#endif
4573 }
Jerry Yub9930e72021-08-06 17:11:51 +08004574 }
Ronald Cron6291b232023-03-08 15:51:25 +01004575#endif /* MBEDTLS_SSL_CLI_C */
4576
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004577#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004578 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Ronald Cron6291b232023-03-08 15:51:25 +01004579#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
4580 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Gilles Peskine449bd832023-01-11 14:50:10 +01004581 ret = mbedtls_ssl_tls13_handshake_server_step(ssl);
Ronald Cron6291b232023-03-08 15:51:25 +01004582 } else {
Gilles Peskine449bd832023-01-11 14:50:10 +01004583 ret = mbedtls_ssl_handshake_server_step(ssl);
4584 }
Ronald Cron6291b232023-03-08 15:51:25 +01004585#elif defined(MBEDTLS_SSL_PROTO_TLS1_2)
4586 ret = mbedtls_ssl_handshake_server_step(ssl);
4587#else
4588 ret = mbedtls_ssl_tls13_handshake_server_step(ssl);
Paul Bakker5121ce52009-01-03 21:22:43 +00004589#endif
Ronald Cron6291b232023-03-08 15:51:25 +01004590 }
4591#endif /* MBEDTLS_SSL_SRV_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00004592
Gilles Peskine449bd832023-01-11 14:50:10 +01004593 if (ret != 0) {
Jerry Yubbd5a3f2021-09-18 20:50:22 +08004594 /* handshake_step return error. And it is same
4595 * with alert_reason.
4596 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004597 if (ssl->send_alert) {
4598 ret = mbedtls_ssl_handle_pending_alert(ssl);
Jerry Yue7047812021-09-13 19:26:39 +08004599 goto cleanup;
4600 }
4601 }
4602
4603cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +01004604 return ret;
Paul Bakker1961b702013-01-25 14:49:24 +01004605}
4606
4607/*
4608 * Perform the SSL handshake
4609 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004610int mbedtls_ssl_handshake(mbedtls_ssl_context *ssl)
Paul Bakker1961b702013-01-25 14:49:24 +01004611{
4612 int ret = 0;
4613
Hanno Beckera817ea42020-10-20 15:20:23 +01004614 /* Sanity checks */
4615
Gilles Peskine449bd832023-01-11 14:50:10 +01004616 if (ssl == NULL || ssl->conf == NULL) {
4617 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4618 }
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02004619
Hanno Beckera817ea42020-10-20 15:20:23 +01004620#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004621 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
4622 (ssl->f_set_timer == NULL || ssl->f_get_timer == NULL)) {
4623 MBEDTLS_SSL_DEBUG_MSG(1, ("You must use "
4624 "mbedtls_ssl_set_timer_cb() for DTLS"));
4625 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Beckera817ea42020-10-20 15:20:23 +01004626 }
4627#endif /* MBEDTLS_SSL_PROTO_DTLS */
4628
Gilles Peskine449bd832023-01-11 14:50:10 +01004629 MBEDTLS_SSL_DEBUG_MSG(2, ("=> handshake"));
Paul Bakker1961b702013-01-25 14:49:24 +01004630
Hanno Beckera817ea42020-10-20 15:20:23 +01004631 /* Main handshake loop */
Gilles Peskine449bd832023-01-11 14:50:10 +01004632 while (ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER) {
4633 ret = mbedtls_ssl_handshake_step(ssl);
Paul Bakker1961b702013-01-25 14:49:24 +01004634
Gilles Peskine449bd832023-01-11 14:50:10 +01004635 if (ret != 0) {
Paul Bakker1961b702013-01-25 14:49:24 +01004636 break;
Gilles Peskine449bd832023-01-11 14:50:10 +01004637 }
Paul Bakker1961b702013-01-25 14:49:24 +01004638 }
4639
Gilles Peskine449bd832023-01-11 14:50:10 +01004640 MBEDTLS_SSL_DEBUG_MSG(2, ("<= handshake"));
Paul Bakker5121ce52009-01-03 21:22:43 +00004641
Gilles Peskine449bd832023-01-11 14:50:10 +01004642 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00004643}
4644
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004645#if defined(MBEDTLS_SSL_RENEGOTIATION)
4646#if defined(MBEDTLS_SSL_SRV_C)
Paul Bakker5121ce52009-01-03 21:22:43 +00004647/*
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004648 * Write HelloRequest to request renegotiation on server
Paul Bakker48916f92012-09-16 19:57:18 +00004649 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004650MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004651static int ssl_write_hello_request(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004652{
Janos Follath865b3eb2019-12-16 11:46:15 +00004653 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004654
Gilles Peskine449bd832023-01-11 14:50:10 +01004655 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write hello request"));
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004656
4657 ssl->out_msglen = 4;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004658 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
4659 ssl->out_msg[0] = MBEDTLS_SSL_HS_HELLO_REQUEST;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004660
Gilles Peskine449bd832023-01-11 14:50:10 +01004661 if ((ret = mbedtls_ssl_write_handshake_msg(ssl)) != 0) {
4662 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_handshake_msg", ret);
4663 return ret;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004664 }
4665
Gilles Peskine449bd832023-01-11 14:50:10 +01004666 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write hello request"));
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004667
Gilles Peskine449bd832023-01-11 14:50:10 +01004668 return 0;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004669}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004670#endif /* MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004671
4672/*
4673 * Actually renegotiate current connection, triggered by either:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004674 * - any side: calling mbedtls_ssl_renegotiate(),
4675 * - client: receiving a HelloRequest during mbedtls_ssl_read(),
4676 * - server: receiving any handshake message on server during mbedtls_ssl_read() after
Manuel Pégourié-Gonnard55e4ff22014-08-19 11:16:35 +02004677 * the initial handshake is completed.
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004678 * If the handshake doesn't complete due to waiting for I/O, it will continue
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004679 * during the next calls to mbedtls_ssl_renegotiate() or mbedtls_ssl_read() respectively.
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004680 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004681int mbedtls_ssl_start_renegotiation(mbedtls_ssl_context *ssl)
Paul Bakker48916f92012-09-16 19:57:18 +00004682{
Janos Follath865b3eb2019-12-16 11:46:15 +00004683 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker48916f92012-09-16 19:57:18 +00004684
Gilles Peskine449bd832023-01-11 14:50:10 +01004685 MBEDTLS_SSL_DEBUG_MSG(2, ("=> renegotiate"));
Paul Bakker48916f92012-09-16 19:57:18 +00004686
Gilles Peskine449bd832023-01-11 14:50:10 +01004687 if ((ret = ssl_handshake_init(ssl)) != 0) {
4688 return ret;
4689 }
Paul Bakker48916f92012-09-16 19:57:18 +00004690
Manuel Pégourié-Gonnard0557bd52014-08-19 19:18:39 +02004691 /* RFC 6347 4.2.2: "[...] the HelloRequest will have message_seq = 0 and
4692 * the ServerHello will have message_seq = 1" */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004693#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004694 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
4695 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING) {
4696 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02004697 ssl->handshake->out_msg_seq = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004698 } else {
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02004699 ssl->handshake->in_msg_seq = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004700 }
Manuel Pégourié-Gonnard0557bd52014-08-19 19:18:39 +02004701 }
4702#endif
4703
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004704 ssl->state = MBEDTLS_SSL_HELLO_REQUEST;
4705 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS;
Paul Bakker48916f92012-09-16 19:57:18 +00004706
Gilles Peskine449bd832023-01-11 14:50:10 +01004707 if ((ret = mbedtls_ssl_handshake(ssl)) != 0) {
4708 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_handshake", ret);
4709 return ret;
Paul Bakker48916f92012-09-16 19:57:18 +00004710 }
4711
Gilles Peskine449bd832023-01-11 14:50:10 +01004712 MBEDTLS_SSL_DEBUG_MSG(2, ("<= renegotiate"));
Paul Bakker48916f92012-09-16 19:57:18 +00004713
Gilles Peskine449bd832023-01-11 14:50:10 +01004714 return 0;
Paul Bakker48916f92012-09-16 19:57:18 +00004715}
4716
4717/*
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004718 * Renegotiate current connection on client,
4719 * or request renegotiation on server
4720 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004721int mbedtls_ssl_renegotiate(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004722{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004723 int ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004724
Gilles Peskine449bd832023-01-11 14:50:10 +01004725 if (ssl == NULL || ssl->conf == NULL) {
4726 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4727 }
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02004728
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004729#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004730 /* On server, just send the request */
Gilles Peskine449bd832023-01-11 14:50:10 +01004731 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
4732 if (mbedtls_ssl_is_handshake_over(ssl) == 0) {
4733 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4734 }
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004735
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004736 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_PENDING;
Manuel Pégourié-Gonnardf07f4212014-08-15 19:04:47 +02004737
4738 /* Did we already try/start sending HelloRequest? */
Gilles Peskine449bd832023-01-11 14:50:10 +01004739 if (ssl->out_left != 0) {
4740 return mbedtls_ssl_flush_output(ssl);
4741 }
Manuel Pégourié-Gonnardf07f4212014-08-15 19:04:47 +02004742
Gilles Peskine449bd832023-01-11 14:50:10 +01004743 return ssl_write_hello_request(ssl);
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004744 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004745#endif /* MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004746
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004747#if defined(MBEDTLS_SSL_CLI_C)
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004748 /*
4749 * On client, either start the renegotiation process or,
4750 * if already in progress, continue the handshake
4751 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004752 if (ssl->renego_status != MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS) {
4753 if (mbedtls_ssl_is_handshake_over(ssl) == 0) {
4754 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004755 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004756
4757 if ((ret = mbedtls_ssl_start_renegotiation(ssl)) != 0) {
4758 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_start_renegotiation", ret);
4759 return ret;
4760 }
4761 } else {
4762 if ((ret = mbedtls_ssl_handshake(ssl)) != 0) {
4763 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_handshake", ret);
4764 return ret;
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004765 }
4766 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004767#endif /* MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004768
Gilles Peskine449bd832023-01-11 14:50:10 +01004769 return ret;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004770}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004771#endif /* MBEDTLS_SSL_RENEGOTIATION */
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004772
Gilles Peskine449bd832023-01-11 14:50:10 +01004773void mbedtls_ssl_handshake_free(mbedtls_ssl_context *ssl)
Paul Bakker48916f92012-09-16 19:57:18 +00004774{
Gilles Peskine9b562d52018-04-25 20:32:43 +02004775 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
4776
Gilles Peskine449bd832023-01-11 14:50:10 +01004777 if (handshake == NULL) {
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004778 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01004779 }
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004780
Valerio Setti6f0441d2023-07-03 12:11:36 +02004781#if defined(MBEDTLS_PK_HAVE_ECC_KEYS)
Brett Warrene0edc842021-08-17 09:53:13 +01004782#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004783 if (ssl->handshake->group_list_heap_allocated) {
4784 mbedtls_free((void *) handshake->group_list);
4785 }
Brett Warrene0edc842021-08-17 09:53:13 +01004786 handshake->group_list = NULL;
4787#endif /* MBEDTLS_DEPRECATED_REMOVED */
Valerio Setti6f0441d2023-07-03 12:11:36 +02004788#endif /* MBEDTLS_PK_HAVE_ECC_KEYS */
Brett Warrene0edc842021-08-17 09:53:13 +01004789
Ronald Crone68ab4f2022-10-05 12:46:29 +02004790#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yuf017ee42022-01-12 15:49:48 +08004791#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004792 if (ssl->handshake->sig_algs_heap_allocated) {
4793 mbedtls_free((void *) handshake->sig_algs);
4794 }
Jerry Yuf017ee42022-01-12 15:49:48 +08004795 handshake->sig_algs = NULL;
4796#endif /* MBEDTLS_DEPRECATED_REMOVED */
Xiaofei Baic234ecf2022-02-08 09:59:23 +00004797#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004798 if (ssl->handshake->certificate_request_context) {
4799 mbedtls_free((void *) handshake->certificate_request_context);
Xiaofei Baic234ecf2022-02-08 09:59:23 +00004800 }
4801#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Ronald Crone68ab4f2022-10-05 12:46:29 +02004802#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Jerry Yuf017ee42022-01-12 15:49:48 +08004803
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02004804#if defined(MBEDTLS_SSL_ASYNC_PRIVATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01004805 if (ssl->conf->f_async_cancel != NULL && handshake->async_in_progress != 0) {
4806 ssl->conf->f_async_cancel(ssl);
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02004807 handshake->async_in_progress = 0;
4808 }
4809#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
4810
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01004811#if defined(MBEDTLS_MD_CAN_SHA256)
Andrzej Kurekeb342242019-01-29 09:14:33 -05004812#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01004813 psa_hash_abort(&handshake->fin_sha256_psa);
Andrzej Kurekeb342242019-01-29 09:14:33 -05004814#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01004815 mbedtls_md_free(&handshake->fin_sha256);
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02004816#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -05004817#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01004818#if defined(MBEDTLS_MD_CAN_SHA384)
Andrzej Kurekeb342242019-01-29 09:14:33 -05004819#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01004820 psa_hash_abort(&handshake->fin_sha384_psa);
Andrzej Kurekeb342242019-01-29 09:14:33 -05004821#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01004822 mbedtls_md_free(&handshake->fin_sha384);
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02004823#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -05004824#endif
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02004825
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004826#if defined(MBEDTLS_DHM_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004827 mbedtls_dhm_free(&handshake->dhm_ctx);
Paul Bakker48916f92012-09-16 19:57:18 +00004828#endif
Valerio Setti7aeec542023-07-05 18:57:21 +02004829#if !defined(MBEDTLS_USE_PSA_CRYPTO) && \
Valerio Setti6eb00542023-07-07 17:04:24 +02004830 defined(MBEDTLS_KEY_EXCHANGE_SOME_ECDH_OR_ECDHE_1_2_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004831 mbedtls_ecdh_free(&handshake->ecdh_ctx);
Paul Bakker61d113b2013-07-04 11:51:43 +02004832#endif
Valerio Setti02c25b52022-11-15 14:08:42 +01004833
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02004834#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Neil Armstrongca7d5062022-05-31 14:43:23 +02004835#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01004836 psa_pake_abort(&handshake->psa_pake_ctx);
Valerio Settieb3f7882022-12-08 18:42:58 +01004837 /*
4838 * Opaque keys are not stored in the handshake's data and it's the user
4839 * responsibility to destroy them. Clear ones, instead, are created by
4840 * the TLS library and should be destroyed at the same level
4841 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004842 if (!mbedtls_svc_key_id_is_null(handshake->psa_pake_password)) {
4843 psa_destroy_key(handshake->psa_pake_password);
Valerio Settieb3f7882022-12-08 18:42:58 +01004844 }
Neil Armstrongca7d5062022-05-31 14:43:23 +02004845 handshake->psa_pake_password = MBEDTLS_SVC_KEY_ID_INIT;
4846#else
Gilles Peskine449bd832023-01-11 14:50:10 +01004847 mbedtls_ecjpake_free(&handshake->ecjpake_ctx);
Neil Armstrongca7d5062022-05-31 14:43:23 +02004848#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard77c06462015-09-17 13:59:49 +02004849#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004850 mbedtls_free(handshake->ecjpake_cache);
Manuel Pégourié-Gonnard77c06462015-09-17 13:59:49 +02004851 handshake->ecjpake_cache = NULL;
4852 handshake->ecjpake_cache_len = 0;
4853#endif
Manuel Pégourié-Gonnard76cfd3f2015-09-15 12:10:54 +02004854#endif
Paul Bakker61d113b2013-07-04 11:51:43 +02004855
Valerio Setti7aeec542023-07-05 18:57:21 +02004856#if defined(MBEDTLS_KEY_EXCHANGE_SOME_ECDH_OR_ECDHE_ANY_ENABLED) || \
Valerio Setti45d56f32023-07-13 17:23:20 +02004857 defined(MBEDTLS_KEY_EXCHANGE_WITH_ECDSA_ANY_ENABLED) || \
Janos Follath4ae5c292016-02-10 11:27:43 +00004858 defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Paul Bakker9af723c2014-05-01 13:03:14 +02004859 /* explicit void pointer cast for buggy MS compiler */
Gilles Peskine449bd832023-01-11 14:50:10 +01004860 mbedtls_free((void *) handshake->curves_tls_id);
Manuel Pégourié-Gonnardd09453c2013-09-23 19:11:32 +02004861#endif
4862
Ronald Cron73fe8df2022-10-05 14:31:43 +02004863#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED)
Neil Armstrong501c9322022-05-03 09:35:09 +02004864#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01004865 if (!mbedtls_svc_key_id_is_null(ssl->handshake->psk_opaque)) {
Neil Armstrong501c9322022-05-03 09:35:09 +02004866 /* The maintenance of the external PSK key slot is the
4867 * user's responsibility. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004868 if (ssl->handshake->psk_opaque_is_internal) {
4869 psa_destroy_key(ssl->handshake->psk_opaque);
Neil Armstrong501c9322022-05-03 09:35:09 +02004870 ssl->handshake->psk_opaque_is_internal = 0;
4871 }
4872 ssl->handshake->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
4873 }
Neil Armstronge952a302022-05-03 10:22:14 +02004874#else
Gilles Peskine449bd832023-01-11 14:50:10 +01004875 if (handshake->psk != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01004876 mbedtls_zeroize_and_free(handshake->psk, handshake->psk_len);
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01004877 }
Neil Armstronge952a302022-05-03 10:22:14 +02004878#endif /* MBEDTLS_USE_PSA_CRYPTO */
Ronald Cron73fe8df2022-10-05 14:31:43 +02004879#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED */
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01004880
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004881#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
4882 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Manuel Pégourié-Gonnard83724542013-09-24 22:30:56 +02004883 /*
4884 * Free only the linked list wrapper, not the keys themselves
4885 * since the belong to the SNI callback
4886 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004887 ssl_key_cert_free(handshake->sni_key_cert);
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004888#endif /* MBEDTLS_X509_CRT_PARSE_C && MBEDTLS_SSL_SERVER_NAME_INDICATION */
Manuel Pégourié-Gonnard705fcca2013-09-23 20:04:20 +02004889
Gilles Peskineeccd8882020-03-10 12:19:08 +01004890#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004891 mbedtls_x509_crt_restart_free(&handshake->ecrs_ctx);
4892 if (handshake->ecrs_peer_cert != NULL) {
4893 mbedtls_x509_crt_free(handshake->ecrs_peer_cert);
4894 mbedtls_free(handshake->ecrs_peer_cert);
Hanno Becker3dad3112019-02-05 17:19:52 +00004895 }
Manuel Pégourié-Gonnard862cde52017-05-17 11:56:15 +02004896#endif
4897
Hanno Becker75173122019-02-06 16:18:31 +00004898#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
4899 !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01004900 mbedtls_pk_free(&handshake->peer_pubkey);
Hanno Becker75173122019-02-06 16:18:31 +00004901#endif /* MBEDTLS_X509_CRT_PARSE_C && !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
4902
XiaokangQian9b93c0d2022-02-09 06:02:25 +00004903#if defined(MBEDTLS_SSL_CLI_C) && \
Gilles Peskine449bd832023-01-11 14:50:10 +01004904 (defined(MBEDTLS_SSL_PROTO_DTLS) || defined(MBEDTLS_SSL_PROTO_TLS1_3))
4905 mbedtls_free(handshake->cookie);
XiaokangQian9b93c0d2022-02-09 06:02:25 +00004906#endif /* MBEDTLS_SSL_CLI_C &&
4907 ( MBEDTLS_SSL_PROTO_DTLS || MBEDTLS_SSL_PROTO_TLS1_3 ) */
XiaokangQian8499b6c2022-01-27 09:00:11 +00004908
4909#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004910 mbedtls_ssl_flight_free(handshake->flight);
4911 mbedtls_ssl_buffering_free(ssl);
XiaokangQian8499b6c2022-01-27 09:00:11 +00004912#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard74848812014-07-11 02:43:49 +02004913
Valerio Settiea59c432023-07-25 11:14:03 +02004914#if defined(MBEDTLS_KEY_EXCHANGE_SOME_XXDH_PSA_ANY_ENABLED)
Przemek Stekiel7ac93be2023-07-04 10:02:38 +02004915 if (handshake->xxdh_psa_privkey_is_external == 0) {
4916 psa_destroy_key(handshake->xxdh_psa_privkey);
Gilles Peskine449bd832023-01-11 14:50:10 +01004917 }
Valerio Settiea59c432023-07-25 11:14:03 +02004918#endif /* MBEDTLS_KEY_EXCHANGE_SOME_XXDH_PSA_ANY_ENABLED */
Hanno Becker4a63ed42019-01-08 11:39:35 +00004919
Ronald Cron6f135e12021-12-08 16:57:54 +01004920#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004921 mbedtls_ssl_transform_free(handshake->transform_handshake);
4922 mbedtls_free(handshake->transform_handshake);
Jerry Yu3d9b5902022-11-04 14:07:25 +08004923#if defined(MBEDTLS_SSL_EARLY_DATA)
Gilles Peskine449bd832023-01-11 14:50:10 +01004924 mbedtls_ssl_transform_free(handshake->transform_earlydata);
4925 mbedtls_free(handshake->transform_earlydata);
Jerry Yu3d9b5902022-11-04 14:07:25 +08004926#endif
Ronald Cron6f135e12021-12-08 16:57:54 +01004927#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yuba9c7272021-10-30 11:54:10 +08004928
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05004929
4930#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
4931 /* If the buffers are too big - reallocate. Because of the way Mbed TLS
4932 * processes datagrams and the fact that a datagram is allowed to have
4933 * several records in it, it is possible that the I/O buffers are not
4934 * empty at this stage */
Gilles Peskine449bd832023-01-11 14:50:10 +01004935 handle_buffer_resizing(ssl, 1, mbedtls_ssl_get_input_buflen(ssl),
4936 mbedtls_ssl_get_output_buflen(ssl));
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05004937#endif
Hanno Becker3aa186f2021-08-10 09:24:19 +01004938
Jerry Yuba9c7272021-10-30 11:54:10 +08004939 /* mbedtls_platform_zeroize MUST be last one in this function */
Gilles Peskine449bd832023-01-11 14:50:10 +01004940 mbedtls_platform_zeroize(handshake,
4941 sizeof(mbedtls_ssl_handshake_params));
Paul Bakker48916f92012-09-16 19:57:18 +00004942}
4943
Gilles Peskine449bd832023-01-11 14:50:10 +01004944void mbedtls_ssl_session_free(mbedtls_ssl_session *session)
Paul Bakker48916f92012-09-16 19:57:18 +00004945{
Gilles Peskine449bd832023-01-11 14:50:10 +01004946 if (session == NULL) {
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004947 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01004948 }
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004949
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004950#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004951 ssl_clear_peer_cert(session);
Paul Bakkered27a042013-04-18 22:46:23 +02004952#endif
Paul Bakker0a597072012-09-25 21:55:46 +00004953
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02004954#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
Xiaokang Qianbc663a02022-10-09 11:14:39 +00004955#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && \
4956 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01004957 mbedtls_free(session->hostname);
Xiaokang Qian281fd1b2022-09-20 11:35:41 +00004958#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01004959 mbedtls_free(session->ticket);
Paul Bakkera503a632013-08-14 13:48:06 +02004960#endif
Manuel Pégourié-Gonnard75d44012013-08-02 14:44:04 +02004961
Waleed Elmelegy2824a202024-02-23 17:51:47 +00004962#if defined(MBEDTLS_SSL_EARLY_DATA) && defined(MBEDTLS_SSL_ALPN) && \
4963 defined(MBEDTLS_SSL_SRV_C)
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00004964 mbedtls_free(session->ticket_alpn);
Paul Bakker5121ce52009-01-03 21:22:43 +00004965#endif
4966
Gilles Peskine449bd832023-01-11 14:50:10 +01004967 mbedtls_platform_zeroize(session, sizeof(mbedtls_ssl_session));
Paul Bakker5121ce52009-01-03 21:22:43 +00004968}
4969
Manuel Pégourié-Gonnard5c0e3772019-07-23 16:13:17 +02004970#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004971
4972#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
4973#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID 1u
4974#else
4975#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID 0u
4976#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
4977
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004978#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT 1u
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004979
4980#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
4981#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY 1u
4982#else
4983#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY 0u
4984#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
4985
4986#if defined(MBEDTLS_SSL_ALPN)
4987#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN 1u
4988#else
4989#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN 0u
4990#endif /* MBEDTLS_SSL_ALPN */
4991
4992#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID_BIT 0
4993#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT_BIT 1
4994#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY_BIT 2
4995#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN_BIT 3
4996
4997#define SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG \
Gilles Peskine449bd832023-01-11 14:50:10 +01004998 ((uint32_t) ( \
4999 (SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID << \
5000 SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID_BIT) | \
5001 (SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT << \
5002 SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT_BIT) | \
5003 (SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY << \
5004 SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY_BIT) | \
5005 (SSL_SERIALIZED_CONTEXT_CONFIG_ALPN << SSL_SERIALIZED_CONTEXT_CONFIG_ALPN_BIT) | \
5006 0u))
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02005007
Chien Wong4e9683e2023-12-28 17:07:43 +08005008static const unsigned char ssl_serialized_context_header[] = {
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005009 MBEDTLS_VERSION_MAJOR,
5010 MBEDTLS_VERSION_MINOR,
5011 MBEDTLS_VERSION_PATCH,
Gilles Peskine449bd832023-01-11 14:50:10 +01005012 MBEDTLS_BYTE_1(SSL_SERIALIZED_SESSION_CONFIG_BITFLAG),
5013 MBEDTLS_BYTE_0(SSL_SERIALIZED_SESSION_CONFIG_BITFLAG),
5014 MBEDTLS_BYTE_2(SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG),
5015 MBEDTLS_BYTE_1(SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG),
5016 MBEDTLS_BYTE_0(SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG),
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005017};
5018
Paul Bakker5121ce52009-01-03 21:22:43 +00005019/*
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005020 * Serialize a full SSL context
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02005021 *
5022 * The format of the serialized data is:
5023 * (in the presentation language of TLS, RFC 8446 section 3)
5024 *
5025 * // header
5026 * opaque mbedtls_version[3]; // major, minor, patch
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005027 * opaque context_format[5]; // version-specific field determining
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02005028 * // the format of the remaining
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005029 * // serialized data.
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02005030 * Note: When updating the format, remember to keep these
5031 * version+format bytes. (We may make their size part of the API.)
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02005032 *
5033 * // session sub-structure
5034 * opaque session<1..2^32-1>; // see mbedtls_ssl_session_save()
5035 * // transform sub-structure
5036 * uint8 random[64]; // ServerHello.random+ClientHello.random
5037 * uint8 in_cid<0..2^8-1> // Connection ID: expected incoming value
5038 * uint8 out_cid<0..2^8-1> // Connection ID: outgoing value to use
5039 * // fields from ssl_context
5040 * uint32 badmac_seen; // DTLS: number of records with failing MAC
5041 * uint64 in_window_top; // DTLS: last validated record seq_num
5042 * uint64 in_window; // DTLS: bitmask for replay protection
5043 * uint8 disable_datagram_packing; // DTLS: only one record per datagram
5044 * uint64 cur_out_ctr; // Record layer: outgoing sequence number
5045 * uint16 mtu; // DTLS: path mtu (max outgoing fragment size)
5046 * uint8 alpn_chosen<0..2^8-1> // ALPN: negotiated application protocol
5047 *
5048 * Note that many fields of the ssl_context or sub-structures are not
5049 * serialized, as they fall in one of the following categories:
5050 *
5051 * 1. forced value (eg in_left must be 0)
5052 * 2. pointer to dynamically-allocated memory (eg session, transform)
5053 * 3. value can be re-derived from other data (eg session keys from MS)
5054 * 4. value was temporary (eg content of input buffer)
5055 * 5. value will be provided by the user again (eg I/O callbacks and context)
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005056 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005057int mbedtls_ssl_context_save(mbedtls_ssl_context *ssl,
5058 unsigned char *buf,
5059 size_t buf_len,
5060 size_t *olen)
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005061{
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005062 unsigned char *p = buf;
5063 size_t used = 0;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005064 size_t session_len;
5065 int ret = 0;
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005066
Manuel Pégourié-Gonnard1aaf6692019-07-10 14:14:05 +02005067 /*
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02005068 * Enforce usage restrictions, see "return BAD_INPUT_DATA" in
5069 * this function's documentation.
5070 *
5071 * These are due to assumptions/limitations in the implementation. Some of
5072 * them are likely to stay (no handshake in progress) some might go away
5073 * (only DTLS) but are currently used to simplify the implementation.
Manuel Pégourié-Gonnard1aaf6692019-07-10 14:14:05 +02005074 */
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02005075 /* The initial handshake must be over */
Gilles Peskine449bd832023-01-11 14:50:10 +01005076 if (mbedtls_ssl_is_handshake_over(ssl) == 0) {
5077 MBEDTLS_SSL_DEBUG_MSG(1, ("Initial handshake isn't over"));
5078 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03005079 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005080 if (ssl->handshake != NULL) {
5081 MBEDTLS_SSL_DEBUG_MSG(1, ("Handshake isn't completed"));
5082 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03005083 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02005084 /* Double-check that sub-structures are indeed ready */
Gilles Peskine449bd832023-01-11 14:50:10 +01005085 if (ssl->transform == NULL || ssl->session == NULL) {
5086 MBEDTLS_SSL_DEBUG_MSG(1, ("Serialised structures aren't ready"));
5087 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03005088 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02005089 /* There must be no pending incoming or outgoing data */
Gilles Peskine449bd832023-01-11 14:50:10 +01005090 if (mbedtls_ssl_check_pending(ssl) != 0) {
5091 MBEDTLS_SSL_DEBUG_MSG(1, ("There is pending incoming data"));
5092 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03005093 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005094 if (ssl->out_left != 0) {
5095 MBEDTLS_SSL_DEBUG_MSG(1, ("There is pending outgoing data"));
5096 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03005097 }
Dave Rodgman556e8a32022-12-06 16:31:25 +00005098 /* Protocol must be DTLS, not TLS */
Gilles Peskine449bd832023-01-11 14:50:10 +01005099 if (ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
5100 MBEDTLS_SSL_DEBUG_MSG(1, ("Only DTLS is supported"));
5101 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03005102 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02005103 /* Version must be 1.2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005104 if (ssl->tls_version != MBEDTLS_SSL_VERSION_TLS1_2) {
5105 MBEDTLS_SSL_DEBUG_MSG(1, ("Only version 1.2 supported"));
5106 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03005107 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02005108 /* We must be using an AEAD ciphersuite */
Gilles Peskine449bd832023-01-11 14:50:10 +01005109 if (mbedtls_ssl_transform_uses_aead(ssl->transform) != 1) {
5110 MBEDTLS_SSL_DEBUG_MSG(1, ("Only AEAD ciphersuites supported"));
5111 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03005112 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02005113 /* Renegotiation must not be enabled */
5114#if defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01005115 if (ssl->conf->disable_renegotiation != MBEDTLS_SSL_RENEGOTIATION_DISABLED) {
5116 MBEDTLS_SSL_DEBUG_MSG(1, ("Renegotiation must not be enabled"));
5117 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03005118 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02005119#endif
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005120
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005121 /*
5122 * Version and format identifier
5123 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005124 used += sizeof(ssl_serialized_context_header);
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005125
Gilles Peskine449bd832023-01-11 14:50:10 +01005126 if (used <= buf_len) {
5127 memcpy(p, ssl_serialized_context_header,
5128 sizeof(ssl_serialized_context_header));
5129 p += sizeof(ssl_serialized_context_header);
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005130 }
5131
5132 /*
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005133 * Session (length + data)
5134 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005135 ret = ssl_session_save(ssl->session, 1, NULL, 0, &session_len);
5136 if (ret != MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL) {
5137 return ret;
5138 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005139
5140 used += 4 + session_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01005141 if (used <= buf_len) {
5142 MBEDTLS_PUT_UINT32_BE(session_len, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01005143 p += 4;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005144
Gilles Peskine449bd832023-01-11 14:50:10 +01005145 ret = ssl_session_save(ssl->session, 1,
5146 p, session_len, &session_len);
5147 if (ret != 0) {
5148 return ret;
5149 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005150
5151 p += session_len;
5152 }
5153
5154 /*
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005155 * Transform
5156 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005157 used += sizeof(ssl->transform->randbytes);
5158 if (used <= buf_len) {
5159 memcpy(p, ssl->transform->randbytes,
5160 sizeof(ssl->transform->randbytes));
5161 p += sizeof(ssl->transform->randbytes);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005162 }
5163
5164#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Dave Rodgmanc37ad442023-11-03 23:36:06 +00005165 used += 2U + ssl->transform->in_cid_len + ssl->transform->out_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01005166 if (used <= buf_len) {
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005167 *p++ = ssl->transform->in_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01005168 memcpy(p, ssl->transform->in_cid, ssl->transform->in_cid_len);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005169 p += ssl->transform->in_cid_len;
5170
5171 *p++ = ssl->transform->out_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01005172 memcpy(p, ssl->transform->out_cid, ssl->transform->out_cid_len);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005173 p += ssl->transform->out_cid_len;
5174 }
5175#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
5176
5177 /*
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005178 * Saved fields from top-level ssl_context structure
5179 */
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005180 used += 4;
Gilles Peskine449bd832023-01-11 14:50:10 +01005181 if (used <= buf_len) {
5182 MBEDTLS_PUT_UINT32_BE(ssl->badmac_seen, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01005183 p += 4;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005184 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005185
5186#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
5187 used += 16;
Gilles Peskine449bd832023-01-11 14:50:10 +01005188 if (used <= buf_len) {
5189 MBEDTLS_PUT_UINT64_BE(ssl->in_window_top, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01005190 p += 8;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005191
Gilles Peskine449bd832023-01-11 14:50:10 +01005192 MBEDTLS_PUT_UINT64_BE(ssl->in_window, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01005193 p += 8;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005194 }
5195#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
5196
5197#if defined(MBEDTLS_SSL_PROTO_DTLS)
5198 used += 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01005199 if (used <= buf_len) {
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005200 *p++ = ssl->disable_datagram_packing;
5201 }
5202#endif /* MBEDTLS_SSL_PROTO_DTLS */
5203
Jerry Yuae0b2e22021-10-08 15:21:19 +08005204 used += MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Gilles Peskine449bd832023-01-11 14:50:10 +01005205 if (used <= buf_len) {
5206 memcpy(p, ssl->cur_out_ctr, MBEDTLS_SSL_SEQUENCE_NUMBER_LEN);
Jerry Yuae0b2e22021-10-08 15:21:19 +08005207 p += MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005208 }
5209
5210#if defined(MBEDTLS_SSL_PROTO_DTLS)
5211 used += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01005212 if (used <= buf_len) {
5213 MBEDTLS_PUT_UINT16_BE(ssl->mtu, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01005214 p += 2;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005215 }
5216#endif /* MBEDTLS_SSL_PROTO_DTLS */
5217
5218#if defined(MBEDTLS_SSL_ALPN)
5219 {
5220 const uint8_t alpn_len = ssl->alpn_chosen
Gilles Peskine449bd832023-01-11 14:50:10 +01005221 ? (uint8_t) strlen(ssl->alpn_chosen)
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005222 : 0;
5223
5224 used += 1 + alpn_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01005225 if (used <= buf_len) {
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005226 *p++ = alpn_len;
5227
Gilles Peskine449bd832023-01-11 14:50:10 +01005228 if (ssl->alpn_chosen != NULL) {
5229 memcpy(p, ssl->alpn_chosen, alpn_len);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005230 p += alpn_len;
5231 }
5232 }
5233 }
5234#endif /* MBEDTLS_SSL_ALPN */
5235
5236 /*
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005237 * Done
5238 */
5239 *olen = used;
5240
Gilles Peskine449bd832023-01-11 14:50:10 +01005241 if (used > buf_len) {
5242 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
5243 }
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005244
Gilles Peskine449bd832023-01-11 14:50:10 +01005245 MBEDTLS_SSL_DEBUG_BUF(4, "saved context", buf, used);
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005246
Gilles Peskine449bd832023-01-11 14:50:10 +01005247 return mbedtls_ssl_session_reset_int(ssl, 0);
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005248}
5249
5250/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02005251 * Deserialize context, see mbedtls_ssl_context_save() for format.
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005252 *
5253 * This internal version is wrapped by a public function that cleans up in
5254 * case of error.
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005255 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005256MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01005257static int ssl_context_load(mbedtls_ssl_context *ssl,
5258 const unsigned char *buf,
5259 size_t len)
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005260{
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005261 const unsigned char *p = buf;
5262 const unsigned char * const end = buf + len;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005263 size_t session_len;
Janos Follath865b3eb2019-12-16 11:46:15 +00005264 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04005265#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Andrzej Kurek894edde2022-09-29 06:31:14 -04005266 tls_prf_fn prf_func = NULL;
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04005267#endif
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005268
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02005269 /*
5270 * The context should have been freshly setup or reset.
5271 * Give the user an error in case of obvious misuse.
Manuel Pégourié-Gonnard4ca930f2019-07-26 16:31:53 +02005272 * (Checking session is useful because it won't be NULL if we're
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02005273 * renegotiating, or if the user mistakenly loaded a session first.)
5274 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005275 if (ssl->state != MBEDTLS_SSL_HELLO_REQUEST ||
5276 ssl->session != NULL) {
5277 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02005278 }
5279
5280 /*
5281 * We can't check that the config matches the initial one, but we can at
5282 * least check it matches the requirements for serializing.
5283 */
Dave Rodgmane99b24d2023-09-14 15:45:03 +01005284 if (
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02005285#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard9a96fd72019-07-23 17:11:24 +02005286 ssl->conf->disable_renegotiation != MBEDTLS_SSL_RENEGOTIATION_DISABLED ||
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02005287#endif
Dave Rodgmane99b24d2023-09-14 15:45:03 +01005288 ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM ||
5289 ssl->conf->max_tls_version < MBEDTLS_SSL_VERSION_TLS1_2 ||
5290 ssl->conf->min_tls_version > MBEDTLS_SSL_VERSION_TLS1_2
5291 ) {
Gilles Peskine449bd832023-01-11 14:50:10 +01005292 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02005293 }
5294
Gilles Peskine449bd832023-01-11 14:50:10 +01005295 MBEDTLS_SSL_DEBUG_BUF(4, "context to load", buf, len);
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005296
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005297 /*
5298 * Check version identifier
5299 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005300 if ((size_t) (end - p) < sizeof(ssl_serialized_context_header)) {
5301 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005302 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005303
5304 if (memcmp(p, ssl_serialized_context_header,
5305 sizeof(ssl_serialized_context_header)) != 0) {
5306 return MBEDTLS_ERR_SSL_VERSION_MISMATCH;
5307 }
5308 p += sizeof(ssl_serialized_context_header);
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005309
5310 /*
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005311 * Session
5312 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005313 if ((size_t) (end - p) < 4) {
5314 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5315 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005316
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01005317 session_len = MBEDTLS_GET_UINT32_BE(p, 0);
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005318 p += 4;
5319
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02005320 /* This has been allocated by ssl_handshake_init(), called by
Hanno Becker43aefe22020-02-05 10:44:56 +00005321 * by either mbedtls_ssl_session_reset_int() or mbedtls_ssl_setup(). */
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02005322 ssl->session = ssl->session_negotiate;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005323 ssl->session_in = ssl->session;
5324 ssl->session_out = ssl->session;
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02005325 ssl->session_negotiate = NULL;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005326
Gilles Peskine449bd832023-01-11 14:50:10 +01005327 if ((size_t) (end - p) < session_len) {
5328 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5329 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005330
Gilles Peskine449bd832023-01-11 14:50:10 +01005331 ret = ssl_session_load(ssl->session, 1, p, session_len);
5332 if (ret != 0) {
5333 mbedtls_ssl_session_free(ssl->session);
5334 return ret;
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02005335 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005336
5337 p += session_len;
5338
5339 /*
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005340 * Transform
5341 */
5342
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02005343 /* This has been allocated by ssl_handshake_init(), called by
Hanno Becker43aefe22020-02-05 10:44:56 +00005344 * by either mbedtls_ssl_session_reset_int() or mbedtls_ssl_setup(). */
Jerry Yu2e199812022-12-01 18:57:19 +08005345#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02005346 ssl->transform = ssl->transform_negotiate;
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005347 ssl->transform_in = ssl->transform;
5348 ssl->transform_out = ssl->transform;
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02005349 ssl->transform_negotiate = NULL;
Jerry Yu2e199812022-12-01 18:57:19 +08005350#endif
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005351
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04005352#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005353 prf_func = ssl_tls12prf_from_cs(ssl->session->ciphersuite);
5354 if (prf_func == NULL) {
5355 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5356 }
Andrzej Kurek894edde2022-09-29 06:31:14 -04005357
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005358 /* Read random bytes and populate structure */
Gilles Peskine449bd832023-01-11 14:50:10 +01005359 if ((size_t) (end - p) < sizeof(ssl->transform->randbytes)) {
5360 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5361 }
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04005362
Gilles Peskine449bd832023-01-11 14:50:10 +01005363 ret = ssl_tls12_populate_transform(ssl->transform,
5364 ssl->session->ciphersuite,
5365 ssl->session->master,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02005366#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01005367 ssl->session->encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02005368#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01005369 prf_func,
5370 p, /* currently pointing to randbytes */
5371 MBEDTLS_SSL_VERSION_TLS1_2, /* (D)TLS 1.2 is forced */
5372 ssl->conf->endpoint,
5373 ssl);
5374 if (ret != 0) {
5375 return ret;
5376 }
Jerry Yu840fbb22022-02-17 14:59:29 +08005377#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005378 p += sizeof(ssl->transform->randbytes);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005379
5380#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
5381 /* Read connection IDs and store them */
Gilles Peskine449bd832023-01-11 14:50:10 +01005382 if ((size_t) (end - p) < 1) {
5383 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5384 }
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005385
5386 ssl->transform->in_cid_len = *p++;
5387
Gilles Peskine449bd832023-01-11 14:50:10 +01005388 if ((size_t) (end - p) < ssl->transform->in_cid_len + 1u) {
5389 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5390 }
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005391
Gilles Peskine449bd832023-01-11 14:50:10 +01005392 memcpy(ssl->transform->in_cid, p, ssl->transform->in_cid_len);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005393 p += ssl->transform->in_cid_len;
5394
5395 ssl->transform->out_cid_len = *p++;
5396
Gilles Peskine449bd832023-01-11 14:50:10 +01005397 if ((size_t) (end - p) < ssl->transform->out_cid_len) {
5398 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5399 }
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005400
Gilles Peskine449bd832023-01-11 14:50:10 +01005401 memcpy(ssl->transform->out_cid, p, ssl->transform->out_cid_len);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005402 p += ssl->transform->out_cid_len;
5403#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
5404
5405 /*
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005406 * Saved fields from top-level ssl_context structure
5407 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005408 if ((size_t) (end - p) < 4) {
5409 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5410 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005411
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01005412 ssl->badmac_seen = MBEDTLS_GET_UINT32_BE(p, 0);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005413 p += 4;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005414
5415#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Gilles Peskine449bd832023-01-11 14:50:10 +01005416 if ((size_t) (end - p) < 16) {
5417 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5418 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005419
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01005420 ssl->in_window_top = MBEDTLS_GET_UINT64_BE(p, 0);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005421 p += 8;
5422
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01005423 ssl->in_window = MBEDTLS_GET_UINT64_BE(p, 0);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005424 p += 8;
5425#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
5426
5427#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005428 if ((size_t) (end - p) < 1) {
5429 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5430 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005431
5432 ssl->disable_datagram_packing = *p++;
5433#endif /* MBEDTLS_SSL_PROTO_DTLS */
5434
Gilles Peskine449bd832023-01-11 14:50:10 +01005435 if ((size_t) (end - p) < sizeof(ssl->cur_out_ctr)) {
5436 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5437 }
5438 memcpy(ssl->cur_out_ctr, p, sizeof(ssl->cur_out_ctr));
5439 p += sizeof(ssl->cur_out_ctr);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005440
5441#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005442 if ((size_t) (end - p) < 2) {
5443 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5444 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005445
Dave Rodgmana3d0f612023-11-03 23:34:02 +00005446 ssl->mtu = MBEDTLS_GET_UINT16_BE(p, 0);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005447 p += 2;
5448#endif /* MBEDTLS_SSL_PROTO_DTLS */
5449
5450#if defined(MBEDTLS_SSL_ALPN)
5451 {
5452 uint8_t alpn_len;
5453 const char **cur;
5454
Gilles Peskine449bd832023-01-11 14:50:10 +01005455 if ((size_t) (end - p) < 1) {
5456 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5457 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005458
5459 alpn_len = *p++;
5460
Gilles Peskine449bd832023-01-11 14:50:10 +01005461 if (alpn_len != 0 && ssl->conf->alpn_list != NULL) {
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005462 /* alpn_chosen should point to an item in the configured list */
Gilles Peskine449bd832023-01-11 14:50:10 +01005463 for (cur = ssl->conf->alpn_list; *cur != NULL; cur++) {
5464 if (strlen(*cur) == alpn_len &&
Waleed Elmelegy131b2ff2024-03-14 01:39:39 +00005465 memcmp(p, *cur, alpn_len) == 0) {
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005466 ssl->alpn_chosen = *cur;
5467 break;
5468 }
5469 }
5470 }
5471
5472 /* can only happen on conf mismatch */
Gilles Peskine449bd832023-01-11 14:50:10 +01005473 if (alpn_len != 0 && ssl->alpn_chosen == NULL) {
5474 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5475 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005476
5477 p += alpn_len;
5478 }
5479#endif /* MBEDTLS_SSL_ALPN */
5480
5481 /*
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02005482 * Forced fields from top-level ssl_context structure
5483 *
5484 * Most of them already set to the correct value by mbedtls_ssl_init() and
5485 * mbedtls_ssl_reset(), so we only need to set the remaining ones.
5486 */
5487 ssl->state = MBEDTLS_SSL_HANDSHAKE_OVER;
Glenn Strauss60bfe602022-03-14 19:04:24 -04005488 ssl->tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02005489
Hanno Becker361b10d2019-08-30 10:42:49 +01005490 /* Adjust pointers for header fields of outgoing records to
5491 * the given transform, accounting for explicit IV and CID. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005492 mbedtls_ssl_update_out_pointers(ssl, ssl->transform);
Hanno Becker361b10d2019-08-30 10:42:49 +01005493
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02005494#if defined(MBEDTLS_SSL_PROTO_DTLS)
5495 ssl->in_epoch = 1;
5496#endif
5497
5498 /* mbedtls_ssl_reset() leaves the handshake sub-structure allocated,
5499 * which we don't want - otherwise we'd end up freeing the wrong transform
Hanno Beckerce5f5fd2020-02-05 10:47:44 +00005500 * by calling mbedtls_ssl_handshake_wrapup_free_hs_transform()
5501 * inappropriately. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005502 if (ssl->handshake != NULL) {
5503 mbedtls_ssl_handshake_free(ssl);
5504 mbedtls_free(ssl->handshake);
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02005505 ssl->handshake = NULL;
5506 }
5507
5508 /*
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005509 * Done - should have consumed entire buffer
5510 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005511 if (p != end) {
5512 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5513 }
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005514
Gilles Peskine449bd832023-01-11 14:50:10 +01005515 return 0;
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005516}
5517
5518/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02005519 * Deserialize context: public wrapper for error cleaning
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005520 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005521int mbedtls_ssl_context_load(mbedtls_ssl_context *context,
5522 const unsigned char *buf,
5523 size_t len)
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005524{
Gilles Peskine449bd832023-01-11 14:50:10 +01005525 int ret = ssl_context_load(context, buf, len);
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005526
Gilles Peskine449bd832023-01-11 14:50:10 +01005527 if (ret != 0) {
5528 mbedtls_ssl_free(context);
5529 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005530
Gilles Peskine449bd832023-01-11 14:50:10 +01005531 return ret;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005532}
Manuel Pégourié-Gonnard5c0e3772019-07-23 16:13:17 +02005533#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005534
5535/*
Paul Bakker5121ce52009-01-03 21:22:43 +00005536 * Free an SSL context
5537 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005538void mbedtls_ssl_free(mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00005539{
Gilles Peskine449bd832023-01-11 14:50:10 +01005540 if (ssl == NULL) {
Paul Bakkeraccaffe2014-06-26 13:37:14 +02005541 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01005542 }
Paul Bakkeraccaffe2014-06-26 13:37:14 +02005543
Gilles Peskine449bd832023-01-11 14:50:10 +01005544 MBEDTLS_SSL_DEBUG_MSG(2, ("=> free"));
Paul Bakker5121ce52009-01-03 21:22:43 +00005545
Gilles Peskine449bd832023-01-11 14:50:10 +01005546 if (ssl->out_buf != NULL) {
sander-visserb8aa2072020-05-06 22:05:13 +02005547#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
5548 size_t out_buf_len = ssl->out_buf_len;
5549#else
5550 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
5551#endif
5552
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005553 mbedtls_zeroize_and_free(ssl->out_buf, out_buf_len);
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05005554 ssl->out_buf = NULL;
Paul Bakker5121ce52009-01-03 21:22:43 +00005555 }
5556
Gilles Peskine449bd832023-01-11 14:50:10 +01005557 if (ssl->in_buf != NULL) {
sander-visserb8aa2072020-05-06 22:05:13 +02005558#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
5559 size_t in_buf_len = ssl->in_buf_len;
5560#else
5561 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
5562#endif
5563
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005564 mbedtls_zeroize_and_free(ssl->in_buf, in_buf_len);
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05005565 ssl->in_buf = NULL;
Paul Bakker5121ce52009-01-03 21:22:43 +00005566 }
5567
Gilles Peskine449bd832023-01-11 14:50:10 +01005568 if (ssl->transform) {
5569 mbedtls_ssl_transform_free(ssl->transform);
5570 mbedtls_free(ssl->transform);
Paul Bakker48916f92012-09-16 19:57:18 +00005571 }
5572
Gilles Peskine449bd832023-01-11 14:50:10 +01005573 if (ssl->handshake) {
5574 mbedtls_ssl_handshake_free(ssl);
5575 mbedtls_free(ssl->handshake);
Jerry Yu2e199812022-12-01 18:57:19 +08005576
5577#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005578 mbedtls_ssl_transform_free(ssl->transform_negotiate);
5579 mbedtls_free(ssl->transform_negotiate);
Jerry Yu2e199812022-12-01 18:57:19 +08005580#endif
5581
Gilles Peskine449bd832023-01-11 14:50:10 +01005582 mbedtls_ssl_session_free(ssl->session_negotiate);
5583 mbedtls_free(ssl->session_negotiate);
Paul Bakker48916f92012-09-16 19:57:18 +00005584 }
5585
Ronald Cron6f135e12021-12-08 16:57:54 +01005586#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01005587 mbedtls_ssl_transform_free(ssl->transform_application);
5588 mbedtls_free(ssl->transform_application);
Ronald Cron6f135e12021-12-08 16:57:54 +01005589#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker3aa186f2021-08-10 09:24:19 +01005590
Gilles Peskine449bd832023-01-11 14:50:10 +01005591 if (ssl->session) {
5592 mbedtls_ssl_session_free(ssl->session);
5593 mbedtls_free(ssl->session);
Paul Bakkerc0463502013-02-14 11:19:38 +01005594 }
5595
Manuel Pégourié-Gonnard55fab2d2015-05-11 16:15:19 +02005596#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005597 if (ssl->hostname != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005598 mbedtls_zeroize_and_free(ssl->hostname, strlen(ssl->hostname));
Paul Bakker5121ce52009-01-03 21:22:43 +00005599 }
Paul Bakker0be444a2013-08-27 21:55:01 +02005600#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00005601
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02005602#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005603 mbedtls_free(ssl->cli_id);
Manuel Pégourié-Gonnard43c02182014-07-22 17:32:01 +02005604#endif
5605
Gilles Peskine449bd832023-01-11 14:50:10 +01005606 MBEDTLS_SSL_DEBUG_MSG(2, ("<= free"));
Paul Bakker2da561c2009-02-05 18:00:28 +00005607
Paul Bakker86f04f42013-02-14 11:20:09 +01005608 /* Actually clear after last debug message */
Gilles Peskine449bd832023-01-11 14:50:10 +01005609 mbedtls_platform_zeroize(ssl, sizeof(mbedtls_ssl_context));
Paul Bakker5121ce52009-01-03 21:22:43 +00005610}
5611
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005612/*
Shaun Case8b0ecbc2021-12-20 21:14:10 -08005613 * Initialize mbedtls_ssl_config
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005614 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005615void mbedtls_ssl_config_init(mbedtls_ssl_config *conf)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005616{
Gilles Peskine449bd832023-01-11 14:50:10 +01005617 memset(conf, 0, sizeof(mbedtls_ssl_config));
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005618}
5619
Gilles Peskineae270bf2021-06-02 00:05:29 +02005620/* The selection should be the same as mbedtls_x509_crt_profile_default in
5621 * x509_crt.c, plus Montgomery curves for ECDHE. Here, the order matters:
Gilles Peskineb1940a72021-06-02 15:18:12 +02005622 * curves with a lower resource usage come first.
Gilles Peskineae270bf2021-06-02 00:05:29 +02005623 * See the documentation of mbedtls_ssl_conf_curves() for what we promise
Gilles Peskineb1940a72021-06-02 15:18:12 +02005624 * about this list.
5625 */
Chien Wong4e9683e2023-12-28 17:07:43 +08005626static const uint16_t ssl_preset_default_groups[] = {
Valerio Settidb6b4db2023-09-01 09:20:51 +02005627#if defined(MBEDTLS_ECP_HAVE_CURVE25519)
Brett Warrene0edc842021-08-17 09:53:13 +01005628 MBEDTLS_SSL_IANA_TLS_GROUP_X25519,
Gilles Peskineae270bf2021-06-02 00:05:29 +02005629#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005630#if defined(MBEDTLS_ECP_HAVE_SECP256R1)
Brett Warrene0edc842021-08-17 09:53:13 +01005631 MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1,
Gilles Peskineae270bf2021-06-02 00:05:29 +02005632#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005633#if defined(MBEDTLS_ECP_HAVE_SECP384R1)
Brett Warrene0edc842021-08-17 09:53:13 +01005634 MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02005635#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005636#if defined(MBEDTLS_ECP_HAVE_CURVE448)
Brett Warrene0edc842021-08-17 09:53:13 +01005637 MBEDTLS_SSL_IANA_TLS_GROUP_X448,
Gilles Peskineb1940a72021-06-02 15:18:12 +02005638#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005639#if defined(MBEDTLS_ECP_HAVE_SECP521R1)
Brett Warrene0edc842021-08-17 09:53:13 +01005640 MBEDTLS_SSL_IANA_TLS_GROUP_SECP521R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02005641#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005642#if defined(MBEDTLS_ECP_HAVE_BP256R1)
Brett Warrene0edc842021-08-17 09:53:13 +01005643 MBEDTLS_SSL_IANA_TLS_GROUP_BP256R1,
Gilles Peskineae270bf2021-06-02 00:05:29 +02005644#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005645#if defined(MBEDTLS_ECP_HAVE_BP384R1)
Brett Warrene0edc842021-08-17 09:53:13 +01005646 MBEDTLS_SSL_IANA_TLS_GROUP_BP384R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02005647#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005648#if defined(MBEDTLS_ECP_HAVE_BP512R1)
Brett Warrene0edc842021-08-17 09:53:13 +01005649 MBEDTLS_SSL_IANA_TLS_GROUP_BP512R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02005650#endif
Przemek Stekiel316c19e2023-05-31 15:25:11 +02005651#if defined(PSA_WANT_ALG_FFDH)
Przemek Stekiel383f4712022-12-12 14:48:57 +01005652 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE2048,
5653 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE3072,
5654 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE4096,
5655 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE6144,
5656 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE8192,
5657#endif
Brett Warrene0edc842021-08-17 09:53:13 +01005658 MBEDTLS_SSL_IANA_TLS_GROUP_NONE
Gilles Peskineae270bf2021-06-02 00:05:29 +02005659};
Gilles Peskineae270bf2021-06-02 00:05:29 +02005660
Alexey Tsvetkov2ca34372022-06-07 10:21:05 +03005661static const int ssl_preset_suiteb_ciphersuites[] = {
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005662 MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256,
5663 MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384,
5664 0
5665};
5666
Ronald Crone68ab4f2022-10-05 12:46:29 +02005667#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Hanno Becker9c6aa7b2021-08-10 13:50:43 +01005668
Jerry Yu909df7b2022-01-22 11:56:27 +08005669/* NOTICE:
Jerry Yu0b994b82022-01-25 17:22:12 +08005670 * For ssl_preset_*_sig_algs and ssl_tls12_preset_*_sig_algs, the following
Jerry Yu370e1462022-01-25 10:36:53 +08005671 * rules SHOULD be upheld.
5672 * - No duplicate entries.
5673 * - But if there is a good reason, do not change the order of the algorithms.
Jerry Yu09a99fc2022-07-28 14:22:17 +08005674 * - ssl_tls12_preset* is for TLS 1.2 use only.
Jerry Yu370e1462022-01-25 10:36:53 +08005675 * - ssl_preset_* is for TLS 1.3 only or hybrid TLS 1.3/1.2 handshakes.
Jerry Yu1a8b4812022-01-20 17:56:50 +08005676 */
Chien Wong4e9683e2023-12-28 17:07:43 +08005677static const uint16_t ssl_preset_default_sig_algs[] = {
Jerry Yu1a8b4812022-01-20 17:56:50 +08005678
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005679#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005680 defined(MBEDTLS_MD_CAN_SHA256) && \
Valerio Setticf29c5d2023-09-01 09:03:41 +02005681 defined(PSA_WANT_ECC_SECP_R1_256)
Jerry Yued5e9f42022-01-26 11:21:34 +08005682 MBEDTLS_TLS1_3_SIG_ECDSA_SECP256R1_SHA256,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005683 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256)
5684#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08005685
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005686#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005687 defined(MBEDTLS_MD_CAN_SHA384) && \
Valerio Setticf29c5d2023-09-01 09:03:41 +02005688 defined(PSA_WANT_ECC_SECP_R1_384)
Jerry Yu909df7b2022-01-22 11:56:27 +08005689 MBEDTLS_TLS1_3_SIG_ECDSA_SECP384R1_SHA384,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005690 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384)
5691#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08005692
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005693#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005694 defined(MBEDTLS_MD_CAN_SHA512) && \
Valerio Setticf29c5d2023-09-01 09:03:41 +02005695 defined(PSA_WANT_ECC_SECP_R1_521)
Jerry Yued5e9f42022-01-26 11:21:34 +08005696 MBEDTLS_TLS1_3_SIG_ECDSA_SECP521R1_SHA512,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005697 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA512)
5698#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08005699
Yanray Wang1136fad2023-11-22 16:54:31 +08005700#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && defined(MBEDTLS_MD_CAN_SHA512)
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005701 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA512,
Yanray Wang1136fad2023-11-22 16:54:31 +08005702#endif
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005703
Yanray Wang1136fad2023-11-22 16:54:31 +08005704#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && defined(MBEDTLS_MD_CAN_SHA384)
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005705 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA384,
Yanray Wang1136fad2023-11-22 16:54:31 +08005706#endif
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005707
Yanray Wang1136fad2023-11-22 16:54:31 +08005708#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && defined(MBEDTLS_MD_CAN_SHA256)
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005709 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256,
Yanray Wang1136fad2023-11-22 16:54:31 +08005710#endif
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005711
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005712#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_MD_CAN_SHA512)
Jerry Yu693a47a2022-06-23 14:02:28 +08005713 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA512,
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005714#endif /* MBEDTLS_RSA_C && MBEDTLS_MD_CAN_SHA512 */
Jerry Yu693a47a2022-06-23 14:02:28 +08005715
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005716#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_MD_CAN_SHA384)
Jerry Yu693a47a2022-06-23 14:02:28 +08005717 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA384,
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005718#endif /* MBEDTLS_RSA_C && MBEDTLS_MD_CAN_SHA384 */
Jerry Yu693a47a2022-06-23 14:02:28 +08005719
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005720#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_MD_CAN_SHA256)
Jerry Yu693a47a2022-06-23 14:02:28 +08005721 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA256,
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005722#endif /* MBEDTLS_RSA_C && MBEDTLS_MD_CAN_SHA256 */
Jerry Yu693a47a2022-06-23 14:02:28 +08005723
Gabor Mezei15b95a62022-05-09 16:37:58 +02005724 MBEDTLS_TLS_SIG_NONE
Jerry Yu909df7b2022-01-22 11:56:27 +08005725};
5726
5727/* NOTICE: see above */
5728#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
5729static uint16_t ssl_tls12_preset_default_sig_algs[] = {
Yanray Wang1136fad2023-11-22 16:54:31 +08005730
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005731#if defined(MBEDTLS_MD_CAN_SHA512)
Valerio Settie9646ec2023-08-02 20:02:28 +02005732#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005733 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA512),
Jerry Yu713013f2022-01-17 18:16:35 +08005734#endif
Jerry Yu09a99fc2022-07-28 14:22:17 +08005735#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT)
5736 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA512,
Yanray Wang1136fad2023-11-22 16:54:31 +08005737#endif
Gabor Mezeic1051b62022-05-10 13:13:58 +02005738#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005739 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA512),
Gabor Mezeic1051b62022-05-10 13:13:58 +02005740#endif
Yanray Wang1136fad2023-11-22 16:54:31 +08005741#endif /* MBEDTLS_MD_CAN_SHA512 */
5742
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005743#if defined(MBEDTLS_MD_CAN_SHA384)
Valerio Settie9646ec2023-08-02 20:02:28 +02005744#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005745 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384),
Jerry Yu11f0a9c2022-01-12 18:43:08 +08005746#endif
Jerry Yu09a99fc2022-07-28 14:22:17 +08005747#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT)
5748 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA384,
Yanray Wang1136fad2023-11-22 16:54:31 +08005749#endif
Gabor Mezeic1051b62022-05-10 13:13:58 +02005750#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005751 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA384),
Gabor Mezeic1051b62022-05-10 13:13:58 +02005752#endif
Yanray Wang1136fad2023-11-22 16:54:31 +08005753#endif /* MBEDTLS_MD_CAN_SHA384 */
5754
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005755#if defined(MBEDTLS_MD_CAN_SHA256)
Valerio Settie9646ec2023-08-02 20:02:28 +02005756#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005757 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256),
Jerry Yu11f0a9c2022-01-12 18:43:08 +08005758#endif
Jerry Yu09a99fc2022-07-28 14:22:17 +08005759#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT)
5760 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256,
Yanray Wang1136fad2023-11-22 16:54:31 +08005761#endif
Gabor Mezeic1051b62022-05-10 13:13:58 +02005762#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005763 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA256),
Gabor Mezeic1051b62022-05-10 13:13:58 +02005764#endif
Yanray Wang1136fad2023-11-22 16:54:31 +08005765#endif /* MBEDTLS_MD_CAN_SHA256 */
5766
Gabor Mezei15b95a62022-05-09 16:37:58 +02005767 MBEDTLS_TLS_SIG_NONE
Jerry Yu909df7b2022-01-22 11:56:27 +08005768};
5769#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Yanray Wang1136fad2023-11-22 16:54:31 +08005770
Jerry Yu909df7b2022-01-22 11:56:27 +08005771/* NOTICE: see above */
Chien Wong4e9683e2023-12-28 17:07:43 +08005772static const uint16_t ssl_preset_suiteb_sig_algs[] = {
Jerry Yu909df7b2022-01-22 11:56:27 +08005773
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005774#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Valerio Setti45d56f32023-07-13 17:23:20 +02005775 defined(MBEDTLS_MD_CAN_SHA256) && \
Valerio Settidb6b4db2023-09-01 09:20:51 +02005776 defined(MBEDTLS_ECP_HAVE_SECP256R1)
Jerry Yu909df7b2022-01-22 11:56:27 +08005777 MBEDTLS_TLS1_3_SIG_ECDSA_SECP256R1_SHA256,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005778 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256)
5779#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08005780
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005781#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Valerio Setti45d56f32023-07-13 17:23:20 +02005782 defined(MBEDTLS_MD_CAN_SHA384) && \
Valerio Settidb6b4db2023-09-01 09:20:51 +02005783 defined(MBEDTLS_ECP_HAVE_SECP384R1)
Jerry Yu53037892022-01-25 11:02:06 +08005784 MBEDTLS_TLS1_3_SIG_ECDSA_SECP384R1_SHA384,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005785 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384)
5786#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08005787
Gabor Mezei15b95a62022-05-09 16:37:58 +02005788 MBEDTLS_TLS_SIG_NONE
Jerry Yu713013f2022-01-17 18:16:35 +08005789};
Jerry Yu6106fdc2022-01-12 16:36:14 +08005790
Jerry Yu909df7b2022-01-22 11:56:27 +08005791/* NOTICE: see above */
5792#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
5793static uint16_t ssl_tls12_preset_suiteb_sig_algs[] = {
Yanray Wang1136fad2023-11-22 16:54:31 +08005794
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005795#if defined(MBEDTLS_MD_CAN_SHA256)
Valerio Settie9646ec2023-08-02 20:02:28 +02005796#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005797 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256),
Jerry Yu713013f2022-01-17 18:16:35 +08005798#endif
Yanray Wang1136fad2023-11-22 16:54:31 +08005799#endif /* MBEDTLS_MD_CAN_SHA256 */
Yanray Wang69ceb392023-11-22 16:32:39 +08005800
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005801#if defined(MBEDTLS_MD_CAN_SHA384)
Valerio Settie9646ec2023-08-02 20:02:28 +02005802#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005803 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384),
Jerry Yu18c833e2022-01-25 10:55:47 +08005804#endif
Yanray Wang1136fad2023-11-22 16:54:31 +08005805#endif /* MBEDTLS_MD_CAN_SHA384 */
5806
Gabor Mezei15b95a62022-05-09 16:37:58 +02005807 MBEDTLS_TLS_SIG_NONE
Hanno Becker9c6aa7b2021-08-10 13:50:43 +01005808};
Jerry Yu909df7b2022-01-22 11:56:27 +08005809#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
5810
Ronald Crone68ab4f2022-10-05 12:46:29 +02005811#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005812
Chien Wong4e9683e2023-12-28 17:07:43 +08005813static const uint16_t ssl_preset_suiteb_groups[] = {
Valerio Settidb6b4db2023-09-01 09:20:51 +02005814#if defined(MBEDTLS_ECP_HAVE_SECP256R1)
Brett Warrene0edc842021-08-17 09:53:13 +01005815 MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1,
Jaeden Amerod4311042019-06-03 08:27:16 +01005816#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005817#if defined(MBEDTLS_ECP_HAVE_SECP384R1)
Brett Warrene0edc842021-08-17 09:53:13 +01005818 MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1,
Jaeden Amerod4311042019-06-03 08:27:16 +01005819#endif
Brett Warrene0edc842021-08-17 09:53:13 +01005820 MBEDTLS_SSL_IANA_TLS_GROUP_NONE
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005821};
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005822
Ronald Crone68ab4f2022-10-05 12:46:29 +02005823#if defined(MBEDTLS_DEBUG_C) && defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu909df7b2022-01-22 11:56:27 +08005824/* Function for checking `ssl_preset_*_sig_algs` and `ssl_tls12_preset_*_sig_algs`
Jerry Yu370e1462022-01-25 10:36:53 +08005825 * to make sure there are no duplicated signature algorithm entries. */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005826MBEDTLS_CHECK_RETURN_CRITICAL
Chien Wong4e9683e2023-12-28 17:07:43 +08005827static int ssl_check_no_sig_alg_duplication(const uint16_t *sig_algs)
Jerry Yu1a8b4812022-01-20 17:56:50 +08005828{
5829 size_t i, j;
5830 int ret = 0;
Jerry Yu909df7b2022-01-22 11:56:27 +08005831
Gilles Peskine449bd832023-01-11 14:50:10 +01005832 for (i = 0; sig_algs[i] != MBEDTLS_TLS_SIG_NONE; i++) {
5833 for (j = 0; j < i; j++) {
5834 if (sig_algs[i] != sig_algs[j]) {
Jerry Yuf377d642022-01-25 10:43:59 +08005835 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01005836 }
5837 mbedtls_printf(" entry(%04x,%" MBEDTLS_PRINTF_SIZET
5838 ") is duplicated at %" MBEDTLS_PRINTF_SIZET "\n",
5839 sig_algs[i], j, i);
Jerry Yuf377d642022-01-25 10:43:59 +08005840 ret = -1;
Jerry Yu1a8b4812022-01-20 17:56:50 +08005841 }
5842 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005843 return ret;
Jerry Yu1a8b4812022-01-20 17:56:50 +08005844}
5845
Ronald Crone68ab4f2022-10-05 12:46:29 +02005846#endif /* MBEDTLS_DEBUG_C && MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Jerry Yu1a8b4812022-01-20 17:56:50 +08005847
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005848/*
Tillmann Karras588ad502015-09-25 04:27:22 +02005849 * Load default in mbedtls_ssl_config
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005850 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005851int mbedtls_ssl_config_defaults(mbedtls_ssl_config *conf,
5852 int endpoint, int transport, int preset)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005853{
Manuel Pégourié-Gonnard8b431fb2015-05-11 12:54:52 +02005854#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Janos Follath865b3eb2019-12-16 11:46:15 +00005855 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard8b431fb2015-05-11 12:54:52 +02005856#endif
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005857
Ronald Crone68ab4f2022-10-05 12:46:29 +02005858#if defined(MBEDTLS_DEBUG_C) && defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005859 if (ssl_check_no_sig_alg_duplication(ssl_preset_suiteb_sig_algs)) {
5860 mbedtls_printf("ssl_preset_suiteb_sig_algs has duplicated entries\n");
5861 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu1a8b4812022-01-20 17:56:50 +08005862 }
5863
Gilles Peskine449bd832023-01-11 14:50:10 +01005864 if (ssl_check_no_sig_alg_duplication(ssl_preset_default_sig_algs)) {
5865 mbedtls_printf("ssl_preset_default_sig_algs has duplicated entries\n");
5866 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu1a8b4812022-01-20 17:56:50 +08005867 }
Jerry Yu909df7b2022-01-22 11:56:27 +08005868
5869#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005870 if (ssl_check_no_sig_alg_duplication(ssl_tls12_preset_suiteb_sig_algs)) {
5871 mbedtls_printf("ssl_tls12_preset_suiteb_sig_algs has duplicated entries\n");
5872 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu909df7b2022-01-22 11:56:27 +08005873 }
5874
Gilles Peskine449bd832023-01-11 14:50:10 +01005875 if (ssl_check_no_sig_alg_duplication(ssl_tls12_preset_default_sig_algs)) {
5876 mbedtls_printf("ssl_tls12_preset_default_sig_algs has duplicated entries\n");
5877 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu909df7b2022-01-22 11:56:27 +08005878 }
5879#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Ronald Crone68ab4f2022-10-05 12:46:29 +02005880#endif /* MBEDTLS_DEBUG_C && MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Jerry Yu1a8b4812022-01-20 17:56:50 +08005881
Manuel Pégourié-Gonnard0de074f2015-05-14 12:58:01 +02005882 /* Use the functions here so that they are covered in tests,
5883 * but otherwise access member directly for efficiency */
Gilles Peskine449bd832023-01-11 14:50:10 +01005884 mbedtls_ssl_conf_endpoint(conf, endpoint);
5885 mbedtls_ssl_conf_transport(conf, transport);
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005886
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005887 /*
5888 * Things that are common to all presets
5889 */
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02005890#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005891 if (endpoint == MBEDTLS_SSL_IS_CLIENT) {
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02005892 conf->authmode = MBEDTLS_SSL_VERIFY_REQUIRED;
5893#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Ronald Crond67f8012024-08-28 07:45:57 +02005894 mbedtls_ssl_conf_session_tickets(conf, MBEDTLS_SSL_SESSION_TICKETS_ENABLED);
Ronald Cronbedddd72024-08-27 14:18:50 +02005895#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Ronald Cronc46edd42024-08-28 16:54:42 +02005896 /* Contrary to TLS 1.2 tickets, TLS 1.3 NewSessionTicket message
5897 * handling is disabled by default in Mbed TLS 3.6.x for backward
5898 * compatibility with client applications developed using Mbed TLS 3.5
5899 * or earlier with the default configuration.
5900 *
5901 * Up to Mbed TLS 3.5, in the default configuration TLS 1.3 was
5902 * disabled, and a Mbed TLS client with the default configuration would
5903 * establish a TLS 1.2 connection with a TLS 1.2 and TLS 1.3 capable
5904 * server.
5905 *
5906 * Starting with Mbed TLS 3.6.0, TLS 1.3 is enabled by default, and thus
5907 * an Mbed TLS client with the default configuration establishes a
5908 * TLS 1.3 connection with a TLS 1.2 and TLS 1.3 capable server. If
5909 * following the handshake the TLS 1.3 server sends NewSessionTicket
5910 * messages and the Mbed TLS client processes them, this results in
5911 * Mbed TLS high level APIs (mbedtls_ssl_read(),
5912 * mbedtls_ssl_handshake(), ...) to eventually return an
5913 * #MBEDTLS_ERR_SSL_RECEIVED_NEW_SESSION_TICKET non fatal error code
5914 * (see the documentation of mbedtls_ssl_read() for more information on
5915 * that error code). Applications unaware of that TLS 1.3 specific non
5916 * fatal error code are then failing.
5917 */
Ronald Cron9f44c882024-08-28 16:44:10 +02005918 mbedtls_ssl_conf_tls13_enable_signal_new_session_tickets(
5919 conf, MBEDTLS_SSL_TLS1_3_SIGNAL_NEW_SESSION_TICKETS_DISABLED);
Ronald Cronbedddd72024-08-27 14:18:50 +02005920#endif
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02005921#endif
5922 }
5923#endif
5924
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005925#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
5926 conf->encrypt_then_mac = MBEDTLS_SSL_ETM_ENABLED;
5927#endif
5928
5929#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
5930 conf->extended_ms = MBEDTLS_SSL_EXTENDED_MS_ENABLED;
5931#endif
5932
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02005933#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005934 conf->f_cookie_write = ssl_cookie_write_dummy;
5935 conf->f_cookie_check = ssl_cookie_check_dummy;
5936#endif
5937
5938#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
5939 conf->anti_replay = MBEDTLS_SSL_ANTI_REPLAY_ENABLED;
5940#endif
5941
Janos Follath088ce432017-04-10 12:42:31 +01005942#if defined(MBEDTLS_SSL_SRV_C)
5943 conf->cert_req_ca_list = MBEDTLS_SSL_CERT_REQ_CA_LIST_ENABLED;
TRodziewicz3946f792021-06-14 12:11:18 +02005944 conf->respect_cli_pref = MBEDTLS_SSL_SRV_CIPHERSUITE_ORDER_SERVER;
Janos Follath088ce432017-04-10 12:42:31 +01005945#endif
5946
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005947#if defined(MBEDTLS_SSL_PROTO_DTLS)
5948 conf->hs_timeout_min = MBEDTLS_SSL_DTLS_TIMEOUT_DFL_MIN;
5949 conf->hs_timeout_max = MBEDTLS_SSL_DTLS_TIMEOUT_DFL_MAX;
5950#endif
5951
5952#if defined(MBEDTLS_SSL_RENEGOTIATION)
5953 conf->renego_max_records = MBEDTLS_SSL_RENEGO_MAX_RECORDS_DEFAULT;
Gilles Peskine449bd832023-01-11 14:50:10 +01005954 memset(conf->renego_period, 0x00, 2);
5955 memset(conf->renego_period + 2, 0xFF, 6);
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005956#endif
5957
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005958#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005959 if (endpoint == MBEDTLS_SSL_IS_SERVER) {
Hanno Beckere2defad2021-07-24 05:59:17 +01005960 const unsigned char dhm_p[] =
5961 MBEDTLS_DHM_RFC3526_MODP_2048_P_BIN;
5962 const unsigned char dhm_g[] =
5963 MBEDTLS_DHM_RFC3526_MODP_2048_G_BIN;
Hanno Becker00d0a682017-10-04 13:14:29 +01005964
Gilles Peskine449bd832023-01-11 14:50:10 +01005965 if ((ret = mbedtls_ssl_conf_dh_param_bin(conf,
5966 dhm_p, sizeof(dhm_p),
5967 dhm_g, sizeof(dhm_g))) != 0) {
5968 return ret;
Hanno Beckere2defad2021-07-24 05:59:17 +01005969 }
5970 }
Manuel Pégourié-Gonnardbd990d62015-06-11 14:49:42 +02005971#endif
5972
Ronald Cron6f135e12021-12-08 16:57:54 +01005973#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yu6ee56aa2022-12-06 17:47:22 +08005974
5975#if defined(MBEDTLS_SSL_EARLY_DATA)
Yanray Wangd5ed36f2023-11-07 11:40:43 +08005976 mbedtls_ssl_conf_early_data(conf, MBEDTLS_SSL_EARLY_DATA_DISABLED);
Jerry Yu6ee56aa2022-12-06 17:47:22 +08005977#if defined(MBEDTLS_SSL_SRV_C)
Yanray Wang07517612023-11-07 11:47:36 +08005978 mbedtls_ssl_conf_max_early_data_size(conf, MBEDTLS_SSL_MAX_EARLY_DATA_SIZE);
Jerry Yu6ee56aa2022-12-06 17:47:22 +08005979#endif
5980#endif /* MBEDTLS_SSL_EARLY_DATA */
5981
Jerry Yud0766ec2022-09-22 10:46:57 +08005982#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Jerry Yu1ad7ace2022-08-09 13:28:39 +08005983 mbedtls_ssl_conf_new_session_tickets(
Gilles Peskine449bd832023-01-11 14:50:10 +01005984 conf, MBEDTLS_SSL_TLS1_3_DEFAULT_NEW_SESSION_TICKETS);
Jerry Yu1ad7ace2022-08-09 13:28:39 +08005985#endif
Hanno Becker71f1ed62021-07-24 06:01:47 +01005986 /*
5987 * Allow all TLS 1.3 key exchange modes by default.
5988 */
Xiaofei Bai746f9482021-11-12 08:53:56 +00005989 conf->tls13_kex_modes = MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_ALL;
Ronald Cron6f135e12021-12-08 16:57:54 +01005990#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker71f1ed62021-07-24 06:01:47 +01005991
Gilles Peskine449bd832023-01-11 14:50:10 +01005992 if (transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Glenn Strauss2dfcea22022-03-14 17:26:42 -04005993#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
XiaokangQian4d3a6042022-04-21 13:46:17 +00005994 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
XiaokangQian060d8672022-04-21 09:24:56 +00005995 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
XiaokangQian4d3a6042022-04-21 13:46:17 +00005996#else
Gilles Peskine449bd832023-01-11 14:50:10 +01005997 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
XiaokangQian060d8672022-04-21 09:24:56 +00005998#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01005999 } else {
XiaokangQian4d3a6042022-04-21 13:46:17 +00006000#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
Ronald Cron097ba142023-03-08 16:18:00 +01006001 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
6002 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
XiaokangQian4d3a6042022-04-21 13:46:17 +00006003#elif defined(MBEDTLS_SSL_PROTO_TLS1_3)
6004 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
6005 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
6006#elif defined(MBEDTLS_SSL_PROTO_TLS1_2)
6007 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
6008 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
6009#else
Gilles Peskine449bd832023-01-11 14:50:10 +01006010 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
XiaokangQian4d3a6042022-04-21 13:46:17 +00006011#endif
6012 }
Glenn Strauss2dfcea22022-03-14 17:26:42 -04006013
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02006014 /*
6015 * Preset-specific defaults
6016 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006017 switch (preset) {
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02006018 /*
6019 * NSA Suite B
6020 */
6021 case MBEDTLS_SSL_PRESET_SUITEB:
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02006022
Hanno Beckerd60b6c62021-04-29 12:04:11 +01006023 conf->ciphersuite_list = ssl_preset_suiteb_ciphersuites;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02006024
6025#if defined(MBEDTLS_X509_CRT_PARSE_C)
6026 conf->cert_profile = &mbedtls_x509_crt_profile_suiteb;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02006027#endif
6028
Ronald Crone68ab4f2022-10-05 12:46:29 +02006029#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu909df7b2022-01-22 11:56:27 +08006030#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01006031 if (mbedtls_ssl_conf_is_tls12_only(conf)) {
Jerry Yu909df7b2022-01-22 11:56:27 +08006032 conf->sig_algs = ssl_tls12_preset_suiteb_sig_algs;
Gilles Peskine449bd832023-01-11 14:50:10 +01006033 } else
Jerry Yu909df7b2022-01-22 11:56:27 +08006034#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006035 conf->sig_algs = ssl_preset_suiteb_sig_algs;
Ronald Crone68ab4f2022-10-05 12:46:29 +02006036#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02006037
Manuel Pégourié-Gonnardf07ce3b2023-09-22 11:53:41 +02006038#if defined(MBEDTLS_ECP_C) && !defined(MBEDTLS_DEPRECATED_REMOVED)
Brett Warrene0edc842021-08-17 09:53:13 +01006039 conf->curve_list = NULL;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02006040#endif
Brett Warrene0edc842021-08-17 09:53:13 +01006041 conf->group_list = ssl_preset_suiteb_groups;
Manuel Pégourié-Gonnardc98204e2015-08-11 04:21:01 +02006042 break;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02006043
6044 /*
6045 * Default
6046 */
6047 default:
Ronald Cronf6606552022-03-15 11:23:25 +01006048
Hanno Beckerd60b6c62021-04-29 12:04:11 +01006049 conf->ciphersuite_list = mbedtls_ssl_list_ciphersuites();
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02006050
6051#if defined(MBEDTLS_X509_CRT_PARSE_C)
6052 conf->cert_profile = &mbedtls_x509_crt_profile_default;
6053#endif
6054
Ronald Crone68ab4f2022-10-05 12:46:29 +02006055#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu909df7b2022-01-22 11:56:27 +08006056#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01006057 if (mbedtls_ssl_conf_is_tls12_only(conf)) {
Jerry Yu909df7b2022-01-22 11:56:27 +08006058 conf->sig_algs = ssl_tls12_preset_default_sig_algs;
Gilles Peskine449bd832023-01-11 14:50:10 +01006059 } else
Jerry Yu909df7b2022-01-22 11:56:27 +08006060#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006061 conf->sig_algs = ssl_preset_default_sig_algs;
Ronald Crone68ab4f2022-10-05 12:46:29 +02006062#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02006063
Manuel Pégourié-Gonnardf07ce3b2023-09-22 11:53:41 +02006064#if defined(MBEDTLS_ECP_C) && !defined(MBEDTLS_DEPRECATED_REMOVED)
Brett Warrene0edc842021-08-17 09:53:13 +01006065 conf->curve_list = NULL;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02006066#endif
Brett Warrene0edc842021-08-17 09:53:13 +01006067 conf->group_list = ssl_preset_default_groups;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02006068
6069#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_CLI_C)
6070 conf->dhm_min_bitlen = 1024;
6071#endif
6072 }
6073
Gilles Peskine449bd832023-01-11 14:50:10 +01006074 return 0;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02006075}
6076
6077/*
6078 * Free mbedtls_ssl_config
6079 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006080void mbedtls_ssl_config_free(mbedtls_ssl_config *conf)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02006081{
Troy-Butlerda73abc2024-04-02 13:37:31 -04006082 if (conf == NULL) {
6083 return;
6084 }
6085
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02006086#if defined(MBEDTLS_DHM_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01006087 mbedtls_mpi_free(&conf->dhm_P);
6088 mbedtls_mpi_free(&conf->dhm_G);
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02006089#endif
6090
Ronald Cron73fe8df2022-10-05 14:31:43 +02006091#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED)
Neil Armstrong501c9322022-05-03 09:35:09 +02006092#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01006093 if (!mbedtls_svc_key_id_is_null(conf->psk_opaque)) {
Neil Armstrong501c9322022-05-03 09:35:09 +02006094 conf->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
6095 }
Neil Armstrong8ecd6682022-05-05 11:40:35 +02006096#endif /* MBEDTLS_USE_PSA_CRYPTO */
Gilles Peskine449bd832023-01-11 14:50:10 +01006097 if (conf->psk != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01006098 mbedtls_zeroize_and_free(conf->psk, conf->psk_len);
Azim Khan27e8a122018-03-21 14:24:11 +00006099 conf->psk = NULL;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02006100 conf->psk_len = 0;
junyeonLEE316b1622017-12-20 16:29:30 +09006101 }
6102
Gilles Peskine449bd832023-01-11 14:50:10 +01006103 if (conf->psk_identity != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01006104 mbedtls_zeroize_and_free(conf->psk_identity, conf->psk_identity_len);
Azim Khan27e8a122018-03-21 14:24:11 +00006105 conf->psk_identity = NULL;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02006106 conf->psk_identity_len = 0;
6107 }
Ronald Cron73fe8df2022-10-05 14:31:43 +02006108#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED */
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02006109
6110#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01006111 ssl_key_cert_free(conf->key_cert);
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02006112#endif
6113
Gilles Peskine449bd832023-01-11 14:50:10 +01006114 mbedtls_platform_zeroize(conf, sizeof(mbedtls_ssl_config));
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02006115}
6116
Manuel Pégourié-Gonnard5674a972015-10-19 15:14:03 +02006117#if defined(MBEDTLS_PK_C) && \
Valerio Settie9646ec2023-08-02 20:02:28 +02006118 (defined(MBEDTLS_RSA_C) || defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED))
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02006119/*
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006120 * Convert between MBEDTLS_PK_XXX and SSL_SIG_XXX
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02006121 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006122unsigned char mbedtls_ssl_sig_from_pk(mbedtls_pk_context *pk)
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02006123{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006124#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01006125 if (mbedtls_pk_can_do(pk, MBEDTLS_PK_RSA)) {
6126 return MBEDTLS_SSL_SIG_RSA;
6127 }
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02006128#endif
Valerio Settie9646ec2023-08-02 20:02:28 +02006129#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01006130 if (mbedtls_pk_can_do(pk, MBEDTLS_PK_ECDSA)) {
6131 return MBEDTLS_SSL_SIG_ECDSA;
6132 }
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02006133#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01006134 return MBEDTLS_SSL_SIG_ANON;
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02006135}
6136
Gilles Peskine449bd832023-01-11 14:50:10 +01006137unsigned char mbedtls_ssl_sig_from_pk_alg(mbedtls_pk_type_t type)
Hanno Becker7e5437a2017-04-28 17:15:26 +01006138{
Gilles Peskine449bd832023-01-11 14:50:10 +01006139 switch (type) {
Hanno Becker7e5437a2017-04-28 17:15:26 +01006140 case MBEDTLS_PK_RSA:
Gilles Peskine449bd832023-01-11 14:50:10 +01006141 return MBEDTLS_SSL_SIG_RSA;
Hanno Becker7e5437a2017-04-28 17:15:26 +01006142 case MBEDTLS_PK_ECDSA:
6143 case MBEDTLS_PK_ECKEY:
Gilles Peskine449bd832023-01-11 14:50:10 +01006144 return MBEDTLS_SSL_SIG_ECDSA;
Hanno Becker7e5437a2017-04-28 17:15:26 +01006145 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006146 return MBEDTLS_SSL_SIG_ANON;
Hanno Becker7e5437a2017-04-28 17:15:26 +01006147 }
6148}
6149
Gilles Peskine449bd832023-01-11 14:50:10 +01006150mbedtls_pk_type_t mbedtls_ssl_pk_alg_from_sig(unsigned char sig)
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02006151{
Gilles Peskine449bd832023-01-11 14:50:10 +01006152 switch (sig) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006153#if defined(MBEDTLS_RSA_C)
6154 case MBEDTLS_SSL_SIG_RSA:
Gilles Peskine449bd832023-01-11 14:50:10 +01006155 return MBEDTLS_PK_RSA;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02006156#endif
Valerio Settie9646ec2023-08-02 20:02:28 +02006157#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006158 case MBEDTLS_SSL_SIG_ECDSA:
Gilles Peskine449bd832023-01-11 14:50:10 +01006159 return MBEDTLS_PK_ECDSA;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02006160#endif
6161 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006162 return MBEDTLS_PK_NONE;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02006163 }
6164}
Valerio Settie9646ec2023-08-02 20:02:28 +02006165#endif /* MBEDTLS_PK_C &&
6166 ( MBEDTLS_RSA_C || MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED ) */
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02006167
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02006168/*
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006169 * Convert from MBEDTLS_SSL_HASH_XXX to MBEDTLS_MD_XXX
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02006170 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006171mbedtls_md_type_t mbedtls_ssl_md_alg_from_hash(unsigned char hash)
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02006172{
Gilles Peskine449bd832023-01-11 14:50:10 +01006173 switch (hash) {
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006174#if defined(MBEDTLS_MD_CAN_MD5)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006175 case MBEDTLS_SSL_HASH_MD5:
Gilles Peskine449bd832023-01-11 14:50:10 +01006176 return MBEDTLS_MD_MD5;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02006177#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006178#if defined(MBEDTLS_MD_CAN_SHA1)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006179 case MBEDTLS_SSL_HASH_SHA1:
Gilles Peskine449bd832023-01-11 14:50:10 +01006180 return MBEDTLS_MD_SHA1;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02006181#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006182#if defined(MBEDTLS_MD_CAN_SHA224)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006183 case MBEDTLS_SSL_HASH_SHA224:
Gilles Peskine449bd832023-01-11 14:50:10 +01006184 return MBEDTLS_MD_SHA224;
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02006185#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006186#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006187 case MBEDTLS_SSL_HASH_SHA256:
Gilles Peskine449bd832023-01-11 14:50:10 +01006188 return MBEDTLS_MD_SHA256;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02006189#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006190#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006191 case MBEDTLS_SSL_HASH_SHA384:
Gilles Peskine449bd832023-01-11 14:50:10 +01006192 return MBEDTLS_MD_SHA384;
Mateusz Starzyk3352a532021-04-06 14:28:22 +02006193#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006194#if defined(MBEDTLS_MD_CAN_SHA512)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006195 case MBEDTLS_SSL_HASH_SHA512:
Gilles Peskine449bd832023-01-11 14:50:10 +01006196 return MBEDTLS_MD_SHA512;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02006197#endif
6198 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006199 return MBEDTLS_MD_NONE;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02006200 }
6201}
6202
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006203/*
6204 * Convert from MBEDTLS_MD_XXX to MBEDTLS_SSL_HASH_XXX
6205 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006206unsigned char mbedtls_ssl_hash_from_md_alg(int md)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006207{
Gilles Peskine449bd832023-01-11 14:50:10 +01006208 switch (md) {
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006209#if defined(MBEDTLS_MD_CAN_MD5)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006210 case MBEDTLS_MD_MD5:
Gilles Peskine449bd832023-01-11 14:50:10 +01006211 return MBEDTLS_SSL_HASH_MD5;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006212#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006213#if defined(MBEDTLS_MD_CAN_SHA1)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006214 case MBEDTLS_MD_SHA1:
Gilles Peskine449bd832023-01-11 14:50:10 +01006215 return MBEDTLS_SSL_HASH_SHA1;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006216#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006217#if defined(MBEDTLS_MD_CAN_SHA224)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006218 case MBEDTLS_MD_SHA224:
Gilles Peskine449bd832023-01-11 14:50:10 +01006219 return MBEDTLS_SSL_HASH_SHA224;
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02006220#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006221#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006222 case MBEDTLS_MD_SHA256:
Gilles Peskine449bd832023-01-11 14:50:10 +01006223 return MBEDTLS_SSL_HASH_SHA256;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006224#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006225#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006226 case MBEDTLS_MD_SHA384:
Gilles Peskine449bd832023-01-11 14:50:10 +01006227 return MBEDTLS_SSL_HASH_SHA384;
Mateusz Starzyk3352a532021-04-06 14:28:22 +02006228#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006229#if defined(MBEDTLS_MD_CAN_SHA512)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006230 case MBEDTLS_MD_SHA512:
Gilles Peskine449bd832023-01-11 14:50:10 +01006231 return MBEDTLS_SSL_HASH_SHA512;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006232#endif
6233 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006234 return MBEDTLS_SSL_HASH_NONE;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006235 }
6236}
6237
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01006238/*
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006239 * Check if a curve proposed by the peer is in our list.
Manuel Pégourié-Gonnard9d412d82015-06-17 12:10:46 +02006240 * Return 0 if we're willing to use it, -1 otherwise.
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01006241 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006242int mbedtls_ssl_check_curve_tls_id(const mbedtls_ssl_context *ssl, uint16_t tls_id)
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01006243{
Gilles Peskine449bd832023-01-11 14:50:10 +01006244 const uint16_t *group_list = mbedtls_ssl_get_groups(ssl);
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01006245
Gilles Peskine449bd832023-01-11 14:50:10 +01006246 if (group_list == NULL) {
6247 return -1;
Brett Warrene0edc842021-08-17 09:53:13 +01006248 }
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01006249
Gilles Peskine449bd832023-01-11 14:50:10 +01006250 for (; *group_list != 0; group_list++) {
6251 if (*group_list == tls_id) {
6252 return 0;
6253 }
6254 }
6255
6256 return -1;
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01006257}
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01006258
Valerio Setti49e69072023-06-27 17:27:51 +02006259#if defined(MBEDTLS_PK_HAVE_ECC_KEYS)
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01006260/*
6261 * Same as mbedtls_ssl_check_curve_tls_id() but with a mbedtls_ecp_group_id.
6262 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006263int mbedtls_ssl_check_curve(const mbedtls_ssl_context *ssl, mbedtls_ecp_group_id grp_id)
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01006264{
Gilles Peskine449bd832023-01-11 14:50:10 +01006265 uint16_t tls_id = mbedtls_ssl_get_tls_id_from_ecp_group_id(grp_id);
Leonid Rozenboim19e59732022-08-08 16:52:38 -07006266
Gilles Peskine449bd832023-01-11 14:50:10 +01006267 if (tls_id == 0) {
Leonid Rozenboim19e59732022-08-08 16:52:38 -07006268 return -1;
Gilles Peskine449bd832023-01-11 14:50:10 +01006269 }
Leonid Rozenboim19e59732022-08-08 16:52:38 -07006270
Gilles Peskine449bd832023-01-11 14:50:10 +01006271 return mbedtls_ssl_check_curve_tls_id(ssl, tls_id);
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01006272}
Valerio Setti49e69072023-06-27 17:27:51 +02006273#endif /* MBEDTLS_PK_HAVE_ECC_KEYS */
Valerio Setti67419f02023-01-04 16:12:42 +01006274
Valerio Setti18c9fed2022-12-30 17:44:24 +01006275static const struct {
6276 uint16_t tls_id;
6277 mbedtls_ecp_group_id ecp_group_id;
6278 psa_ecc_family_t psa_family;
6279 uint16_t bits;
Valerio Setti18c9fed2022-12-30 17:44:24 +01006280} tls_id_match_table[] =
6281{
Valerio Settidb6b4db2023-09-01 09:20:51 +02006282#if defined(MBEDTLS_ECP_HAVE_SECP521R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02006283 { 25, MBEDTLS_ECP_DP_SECP521R1, PSA_ECC_FAMILY_SECP_R1, 521 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006284#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02006285#if defined(MBEDTLS_ECP_HAVE_BP512R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02006286 { 28, MBEDTLS_ECP_DP_BP512R1, PSA_ECC_FAMILY_BRAINPOOL_P_R1, 512 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006287#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02006288#if defined(MBEDTLS_ECP_HAVE_SECP384R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02006289 { 24, MBEDTLS_ECP_DP_SECP384R1, PSA_ECC_FAMILY_SECP_R1, 384 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006290#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02006291#if defined(MBEDTLS_ECP_HAVE_BP384R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02006292 { 27, MBEDTLS_ECP_DP_BP384R1, PSA_ECC_FAMILY_BRAINPOOL_P_R1, 384 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006293#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02006294#if defined(MBEDTLS_ECP_HAVE_SECP256R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02006295 { 23, MBEDTLS_ECP_DP_SECP256R1, PSA_ECC_FAMILY_SECP_R1, 256 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006296#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02006297#if defined(MBEDTLS_ECP_HAVE_SECP256K1)
Valerio Settiacd32c02023-06-29 18:06:29 +02006298 { 22, MBEDTLS_ECP_DP_SECP256K1, PSA_ECC_FAMILY_SECP_K1, 256 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006299#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02006300#if defined(MBEDTLS_ECP_HAVE_BP256R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02006301 { 26, MBEDTLS_ECP_DP_BP256R1, PSA_ECC_FAMILY_BRAINPOOL_P_R1, 256 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006302#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02006303#if defined(MBEDTLS_ECP_HAVE_SECP224R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02006304 { 21, MBEDTLS_ECP_DP_SECP224R1, PSA_ECC_FAMILY_SECP_R1, 224 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006305#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02006306#if defined(MBEDTLS_ECP_HAVE_SECP224K1)
Valerio Settiacd32c02023-06-29 18:06:29 +02006307 { 20, MBEDTLS_ECP_DP_SECP224K1, PSA_ECC_FAMILY_SECP_K1, 224 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006308#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02006309#if defined(MBEDTLS_ECP_HAVE_SECP192R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02006310 { 19, MBEDTLS_ECP_DP_SECP192R1, PSA_ECC_FAMILY_SECP_R1, 192 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006311#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02006312#if defined(MBEDTLS_ECP_HAVE_SECP192K1)
Valerio Settiacd32c02023-06-29 18:06:29 +02006313 { 18, MBEDTLS_ECP_DP_SECP192K1, PSA_ECC_FAMILY_SECP_K1, 192 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006314#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02006315#if defined(MBEDTLS_ECP_HAVE_CURVE25519)
Valerio Settiacd32c02023-06-29 18:06:29 +02006316 { 29, MBEDTLS_ECP_DP_CURVE25519, PSA_ECC_FAMILY_MONTGOMERY, 255 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006317#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02006318#if defined(MBEDTLS_ECP_HAVE_CURVE448)
Valerio Settiacd32c02023-06-29 18:06:29 +02006319 { 30, MBEDTLS_ECP_DP_CURVE448, PSA_ECC_FAMILY_MONTGOMERY, 448 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006320#endif
Valerio Settiacd32c02023-06-29 18:06:29 +02006321 { 0, MBEDTLS_ECP_DP_NONE, 0, 0 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006322};
6323
Gilles Peskine449bd832023-01-11 14:50:10 +01006324int mbedtls_ssl_get_psa_curve_info_from_tls_id(uint16_t tls_id,
Przemek Stekielda4fba62023-06-02 14:52:28 +02006325 psa_key_type_t *type,
Gilles Peskine449bd832023-01-11 14:50:10 +01006326 size_t *bits)
Valerio Setti18c9fed2022-12-30 17:44:24 +01006327{
Gilles Peskine449bd832023-01-11 14:50:10 +01006328 for (int i = 0; tls_id_match_table[i].tls_id != 0; i++) {
6329 if (tls_id_match_table[i].tls_id == tls_id) {
Przemek Stekielda4fba62023-06-02 14:52:28 +02006330 if (type != NULL) {
6331 *type = PSA_KEY_TYPE_ECC_KEY_PAIR(tls_id_match_table[i].psa_family);
Gilles Peskine449bd832023-01-11 14:50:10 +01006332 }
6333 if (bits != NULL) {
Valerio Setti18c9fed2022-12-30 17:44:24 +01006334 *bits = tls_id_match_table[i].bits;
Gilles Peskine449bd832023-01-11 14:50:10 +01006335 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01006336 return PSA_SUCCESS;
6337 }
6338 }
6339
6340 return PSA_ERROR_NOT_SUPPORTED;
6341}
6342
Gilles Peskine449bd832023-01-11 14:50:10 +01006343mbedtls_ecp_group_id mbedtls_ssl_get_ecp_group_id_from_tls_id(uint16_t tls_id)
Valerio Setti18c9fed2022-12-30 17:44:24 +01006344{
Gilles Peskine449bd832023-01-11 14:50:10 +01006345 for (int i = 0; tls_id_match_table[i].tls_id != 0; i++) {
6346 if (tls_id_match_table[i].tls_id == tls_id) {
Valerio Setti18c9fed2022-12-30 17:44:24 +01006347 return tls_id_match_table[i].ecp_group_id;
Gilles Peskine449bd832023-01-11 14:50:10 +01006348 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01006349 }
6350
6351 return MBEDTLS_ECP_DP_NONE;
6352}
6353
Gilles Peskine449bd832023-01-11 14:50:10 +01006354uint16_t mbedtls_ssl_get_tls_id_from_ecp_group_id(mbedtls_ecp_group_id grp_id)
Valerio Setti18c9fed2022-12-30 17:44:24 +01006355{
Gilles Peskine449bd832023-01-11 14:50:10 +01006356 for (int i = 0; tls_id_match_table[i].ecp_group_id != MBEDTLS_ECP_DP_NONE;
6357 i++) {
6358 if (tls_id_match_table[i].ecp_group_id == grp_id) {
Valerio Setti18c9fed2022-12-30 17:44:24 +01006359 return tls_id_match_table[i].tls_id;
Gilles Peskine449bd832023-01-11 14:50:10 +01006360 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01006361 }
6362
6363 return 0;
6364}
6365
Valerio Setti67419f02023-01-04 16:12:42 +01006366#if defined(MBEDTLS_DEBUG_C)
Valerio Settiacd32c02023-06-29 18:06:29 +02006367static const struct {
6368 uint16_t tls_id;
6369 const char *name;
6370} tls_id_curve_name_table[] =
6371{
Valerio Setti54e23792023-07-07 10:49:27 +02006372 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP521R1, "secp521r1" },
6373 { MBEDTLS_SSL_IANA_TLS_GROUP_BP512R1, "brainpoolP512r1" },
6374 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1, "secp384r1" },
6375 { MBEDTLS_SSL_IANA_TLS_GROUP_BP384R1, "brainpoolP384r1" },
6376 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1, "secp256r1" },
6377 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP256K1, "secp256k1" },
6378 { MBEDTLS_SSL_IANA_TLS_GROUP_BP256R1, "brainpoolP256r1" },
6379 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP224R1, "secp224r1" },
6380 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP224K1, "secp224k1" },
6381 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP192R1, "secp192r1" },
6382 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP192K1, "secp192k1" },
6383 { MBEDTLS_SSL_IANA_TLS_GROUP_X25519, "x25519" },
6384 { MBEDTLS_SSL_IANA_TLS_GROUP_X448, "x448" },
Valerio Settiacd32c02023-06-29 18:06:29 +02006385 { 0, NULL },
6386};
6387
Gilles Peskine449bd832023-01-11 14:50:10 +01006388const char *mbedtls_ssl_get_curve_name_from_tls_id(uint16_t tls_id)
Valerio Setti18c9fed2022-12-30 17:44:24 +01006389{
Valerio Settiacd32c02023-06-29 18:06:29 +02006390 for (int i = 0; tls_id_curve_name_table[i].tls_id != 0; i++) {
6391 if (tls_id_curve_name_table[i].tls_id == tls_id) {
6392 return tls_id_curve_name_table[i].name;
Gilles Peskine449bd832023-01-11 14:50:10 +01006393 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01006394 }
6395
6396 return NULL;
6397}
Valerio Setti67419f02023-01-04 16:12:42 +01006398#endif
Valerio Setti18c9fed2022-12-30 17:44:24 +01006399
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006400#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01006401int mbedtls_ssl_check_cert_usage(const mbedtls_x509_crt *cert,
6402 const mbedtls_ssl_ciphersuite_t *ciphersuite,
6403 int cert_endpoint,
6404 uint32_t *flags)
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02006405{
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01006406 int ret = 0;
Dave Rodgmanc37ad442023-11-03 23:36:06 +00006407 unsigned int usage = 0;
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02006408 const char *ext_oid;
6409 size_t ext_len;
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02006410
Gilles Peskine449bd832023-01-11 14:50:10 +01006411 if (cert_endpoint == MBEDTLS_SSL_IS_SERVER) {
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02006412 /* Server part of the key exchange */
Gilles Peskine449bd832023-01-11 14:50:10 +01006413 switch (ciphersuite->key_exchange) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006414 case MBEDTLS_KEY_EXCHANGE_RSA:
6415 case MBEDTLS_KEY_EXCHANGE_RSA_PSK:
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01006416 usage = MBEDTLS_X509_KU_KEY_ENCIPHERMENT;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02006417 break;
6418
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006419 case MBEDTLS_KEY_EXCHANGE_DHE_RSA:
6420 case MBEDTLS_KEY_EXCHANGE_ECDHE_RSA:
6421 case MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA:
6422 usage = MBEDTLS_X509_KU_DIGITAL_SIGNATURE;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02006423 break;
6424
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006425 case MBEDTLS_KEY_EXCHANGE_ECDH_RSA:
6426 case MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA:
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01006427 usage = MBEDTLS_X509_KU_KEY_AGREEMENT;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02006428 break;
6429
6430 /* Don't use default: we want warnings when adding new values */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006431 case MBEDTLS_KEY_EXCHANGE_NONE:
6432 case MBEDTLS_KEY_EXCHANGE_PSK:
6433 case MBEDTLS_KEY_EXCHANGE_DHE_PSK:
6434 case MBEDTLS_KEY_EXCHANGE_ECDHE_PSK:
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +02006435 case MBEDTLS_KEY_EXCHANGE_ECJPAKE:
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02006436 usage = 0;
6437 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006438 } else {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006439 /* Client auth: we only implement rsa_sign and mbedtls_ecdsa_sign for now */
6440 usage = MBEDTLS_X509_KU_DIGITAL_SIGNATURE;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02006441 }
6442
Gilles Peskine449bd832023-01-11 14:50:10 +01006443 if (mbedtls_x509_crt_check_key_usage(cert, usage) != 0) {
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01006444 *flags |= MBEDTLS_X509_BADCERT_KEY_USAGE;
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01006445 ret = -1;
6446 }
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02006447
Gilles Peskine449bd832023-01-11 14:50:10 +01006448 if (cert_endpoint == MBEDTLS_SSL_IS_SERVER) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006449 ext_oid = MBEDTLS_OID_SERVER_AUTH;
Gilles Peskine449bd832023-01-11 14:50:10 +01006450 ext_len = MBEDTLS_OID_SIZE(MBEDTLS_OID_SERVER_AUTH);
6451 } else {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006452 ext_oid = MBEDTLS_OID_CLIENT_AUTH;
Gilles Peskine449bd832023-01-11 14:50:10 +01006453 ext_len = MBEDTLS_OID_SIZE(MBEDTLS_OID_CLIENT_AUTH);
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02006454 }
6455
Gilles Peskine449bd832023-01-11 14:50:10 +01006456 if (mbedtls_x509_crt_check_extended_key_usage(cert, ext_oid, ext_len) != 0) {
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01006457 *flags |= MBEDTLS_X509_BADCERT_EXT_KEY_USAGE;
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01006458 ret = -1;
6459 }
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02006460
Gilles Peskine449bd832023-01-11 14:50:10 +01006461 return ret;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02006462}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006463#endif /* MBEDTLS_X509_CRT_PARSE_C */
Manuel Pégourié-Gonnard3a306b92014-04-29 15:11:17 +02006464
Jerry Yu148165c2021-09-24 23:20:59 +08006465#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01006466int mbedtls_ssl_get_handshake_transcript(mbedtls_ssl_context *ssl,
6467 const mbedtls_md_type_t md,
6468 unsigned char *dst,
6469 size_t dst_len,
6470 size_t *olen)
Jerry Yu148165c2021-09-24 23:20:59 +08006471{
Ronald Cronf6893e12022-01-07 22:09:01 +01006472 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
6473 psa_hash_operation_t *hash_operation_to_clone;
6474 psa_hash_operation_t hash_operation = psa_hash_operation_init();
6475
Jerry Yu148165c2021-09-24 23:20:59 +08006476 *olen = 0;
Ronald Cronf6893e12022-01-07 22:09:01 +01006477
Gilles Peskine449bd832023-01-11 14:50:10 +01006478 switch (md) {
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006479#if defined(MBEDTLS_MD_CAN_SHA384)
Gilles Peskine449bd832023-01-11 14:50:10 +01006480 case MBEDTLS_MD_SHA384:
6481 hash_operation_to_clone = &ssl->handshake->fin_sha384_psa;
6482 break;
Ronald Cronf6893e12022-01-07 22:09:01 +01006483#endif
6484
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006485#if defined(MBEDTLS_MD_CAN_SHA256)
Gilles Peskine449bd832023-01-11 14:50:10 +01006486 case MBEDTLS_MD_SHA256:
6487 hash_operation_to_clone = &ssl->handshake->fin_sha256_psa;
6488 break;
Ronald Cronf6893e12022-01-07 22:09:01 +01006489#endif
6490
Gilles Peskine449bd832023-01-11 14:50:10 +01006491 default:
6492 goto exit;
6493 }
6494
6495 status = psa_hash_clone(hash_operation_to_clone, &hash_operation);
6496 if (status != PSA_SUCCESS) {
Ronald Cronf6893e12022-01-07 22:09:01 +01006497 goto exit;
6498 }
6499
Gilles Peskine449bd832023-01-11 14:50:10 +01006500 status = psa_hash_finish(&hash_operation, dst, dst_len, olen);
6501 if (status != PSA_SUCCESS) {
Ronald Cronf6893e12022-01-07 22:09:01 +01006502 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006503 }
Ronald Cronf6893e12022-01-07 22:09:01 +01006504
6505exit:
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006506#if !defined(MBEDTLS_MD_CAN_SHA384) && \
6507 !defined(MBEDTLS_MD_CAN_SHA256)
Andrzej Kurekeabeb302022-10-17 07:52:51 -04006508 (void) ssl;
6509#endif
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05006510 return PSA_TO_MBEDTLS_ERR(status);
Jerry Yu148165c2021-09-24 23:20:59 +08006511}
6512#else /* MBEDTLS_USE_PSA_CRYPTO */
6513
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006514#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006515MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006516static int ssl_get_handshake_transcript_sha384(mbedtls_ssl_context *ssl,
6517 unsigned char *dst,
6518 size_t dst_len,
6519 size_t *olen)
Jerry Yu24c0ec32021-09-09 14:21:07 +08006520{
Jerry Yu24c0ec32021-09-09 14:21:07 +08006521 int ret;
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01006522 mbedtls_md_context_t sha384;
Jerry Yu24c0ec32021-09-09 14:21:07 +08006523
Gilles Peskine449bd832023-01-11 14:50:10 +01006524 if (dst_len < 48) {
6525 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
6526 }
Jerry Yu24c0ec32021-09-09 14:21:07 +08006527
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01006528 mbedtls_md_init(&sha384);
6529 ret = mbedtls_md_setup(&sha384, mbedtls_md_info_from_type(MBEDTLS_MD_SHA384), 0);
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01006530 if (ret != 0) {
6531 goto exit;
6532 }
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01006533 ret = mbedtls_md_clone(&sha384, &ssl->handshake->fin_sha384);
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01006534 if (ret != 0) {
6535 goto exit;
6536 }
Jerry Yu24c0ec32021-09-09 14:21:07 +08006537
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01006538 if ((ret = mbedtls_md_finish(&sha384, dst)) != 0) {
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01006539 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_finish", ret);
Jerry Yu24c0ec32021-09-09 14:21:07 +08006540 goto exit;
6541 }
6542
6543 *olen = 48;
6544
6545exit:
6546
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01006547 mbedtls_md_free(&sha384);
Gilles Peskine449bd832023-01-11 14:50:10 +01006548 return ret;
Jerry Yu24c0ec32021-09-09 14:21:07 +08006549}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006550#endif /* MBEDTLS_MD_CAN_SHA384 */
Jerry Yu24c0ec32021-09-09 14:21:07 +08006551
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006552#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006553MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006554static int ssl_get_handshake_transcript_sha256(mbedtls_ssl_context *ssl,
6555 unsigned char *dst,
6556 size_t dst_len,
6557 size_t *olen)
Jerry Yu24c0ec32021-09-09 14:21:07 +08006558{
Jerry Yu24c0ec32021-09-09 14:21:07 +08006559 int ret;
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01006560 mbedtls_md_context_t sha256;
Jerry Yu24c0ec32021-09-09 14:21:07 +08006561
Gilles Peskine449bd832023-01-11 14:50:10 +01006562 if (dst_len < 32) {
6563 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
6564 }
Jerry Yu24c0ec32021-09-09 14:21:07 +08006565
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01006566 mbedtls_md_init(&sha256);
6567 ret = mbedtls_md_setup(&sha256, mbedtls_md_info_from_type(MBEDTLS_MD_SHA256), 0);
6568 if (ret != 0) {
6569 goto exit;
6570 }
6571 ret = mbedtls_md_clone(&sha256, &ssl->handshake->fin_sha256);
6572 if (ret != 0) {
6573 goto exit;
6574 }
Jerry Yuc5aef882021-12-23 20:15:02 +08006575
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01006576 if ((ret = mbedtls_md_finish(&sha256, dst)) != 0) {
6577 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_finish", ret);
Jerry Yu24c0ec32021-09-09 14:21:07 +08006578 goto exit;
6579 }
6580
6581 *olen = 32;
6582
6583exit:
6584
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01006585 mbedtls_md_free(&sha256);
Gilles Peskine449bd832023-01-11 14:50:10 +01006586 return ret;
Jerry Yu24c0ec32021-09-09 14:21:07 +08006587}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006588#endif /* MBEDTLS_MD_CAN_SHA256 */
Jerry Yu24c0ec32021-09-09 14:21:07 +08006589
Gilles Peskine449bd832023-01-11 14:50:10 +01006590int mbedtls_ssl_get_handshake_transcript(mbedtls_ssl_context *ssl,
6591 const mbedtls_md_type_t md,
6592 unsigned char *dst,
6593 size_t dst_len,
6594 size_t *olen)
Jerry Yu24c0ec32021-09-09 14:21:07 +08006595{
Gilles Peskine449bd832023-01-11 14:50:10 +01006596 switch (md) {
Jerry Yuc1ddeef2021-10-08 15:14:45 +08006597
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006598#if defined(MBEDTLS_MD_CAN_SHA384)
Gilles Peskine449bd832023-01-11 14:50:10 +01006599 case MBEDTLS_MD_SHA384:
6600 return ssl_get_handshake_transcript_sha384(ssl, dst, dst_len, olen);
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006601#endif /* MBEDTLS_MD_CAN_SHA384*/
Jerry Yuc1ddeef2021-10-08 15:14:45 +08006602
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006603#if defined(MBEDTLS_MD_CAN_SHA256)
Gilles Peskine449bd832023-01-11 14:50:10 +01006604 case MBEDTLS_MD_SHA256:
6605 return ssl_get_handshake_transcript_sha256(ssl, dst, dst_len, olen);
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006606#endif /* MBEDTLS_MD_CAN_SHA256*/
Jerry Yuc1ddeef2021-10-08 15:14:45 +08006607
Gilles Peskine449bd832023-01-11 14:50:10 +01006608 default:
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006609#if !defined(MBEDTLS_MD_CAN_SHA384) && \
6610 !defined(MBEDTLS_MD_CAN_SHA256)
Gilles Peskine449bd832023-01-11 14:50:10 +01006611 (void) ssl;
6612 (void) dst;
6613 (void) dst_len;
6614 (void) olen;
Andrzej Kurek409248a2022-10-24 10:33:21 -04006615#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01006616 break;
Jerry Yuc1ddeef2021-10-08 15:14:45 +08006617 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006618 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yu24c0ec32021-09-09 14:21:07 +08006619}
XiaokangQian647719a2021-12-07 09:16:29 +00006620
Jerry Yu148165c2021-09-24 23:20:59 +08006621#endif /* !MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu24c0ec32021-09-09 14:21:07 +08006622
Ronald Crone68ab4f2022-10-05 12:46:29 +02006623#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Gabor Mezei078e8032022-04-27 21:17:56 +02006624/* mbedtls_ssl_parse_sig_alg_ext()
6625 *
6626 * The `extension_data` field of signature algorithm contains a `SignatureSchemeList`
6627 * value (TLS 1.3 RFC8446):
6628 * enum {
6629 * ....
6630 * ecdsa_secp256r1_sha256( 0x0403 ),
6631 * ecdsa_secp384r1_sha384( 0x0503 ),
6632 * ecdsa_secp521r1_sha512( 0x0603 ),
6633 * ....
6634 * } SignatureScheme;
6635 *
6636 * struct {
6637 * SignatureScheme supported_signature_algorithms<2..2^16-2>;
6638 * } SignatureSchemeList;
6639 *
6640 * The `extension_data` field of signature algorithm contains a `SignatureAndHashAlgorithm`
6641 * value (TLS 1.2 RFC5246):
6642 * enum {
6643 * none(0), md5(1), sha1(2), sha224(3), sha256(4), sha384(5),
6644 * sha512(6), (255)
6645 * } HashAlgorithm;
6646 *
6647 * enum { anonymous(0), rsa(1), dsa(2), ecdsa(3), (255) }
6648 * SignatureAlgorithm;
6649 *
6650 * struct {
6651 * HashAlgorithm hash;
6652 * SignatureAlgorithm signature;
6653 * } SignatureAndHashAlgorithm;
6654 *
6655 * SignatureAndHashAlgorithm
6656 * supported_signature_algorithms<2..2^16-2>;
6657 *
6658 * The TLS 1.3 signature algorithm extension was defined to be a compatible
6659 * generalization of the TLS 1.2 signature algorithm extension.
6660 * `SignatureAndHashAlgorithm` field of TLS 1.2 can be represented by
6661 * `SignatureScheme` field of TLS 1.3
6662 *
6663 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006664int mbedtls_ssl_parse_sig_alg_ext(mbedtls_ssl_context *ssl,
6665 const unsigned char *buf,
6666 const unsigned char *end)
Gabor Mezei078e8032022-04-27 21:17:56 +02006667{
6668 const unsigned char *p = buf;
6669 size_t supported_sig_algs_len = 0;
6670 const unsigned char *supported_sig_algs_end;
6671 uint16_t sig_alg;
6672 uint32_t common_idx = 0;
6673
Gilles Peskine449bd832023-01-11 14:50:10 +01006674 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
6675 supported_sig_algs_len = MBEDTLS_GET_UINT16_BE(p, 0);
Gabor Mezei078e8032022-04-27 21:17:56 +02006676 p += 2;
6677
Gilles Peskine449bd832023-01-11 14:50:10 +01006678 memset(ssl->handshake->received_sig_algs, 0,
6679 sizeof(ssl->handshake->received_sig_algs));
Gabor Mezei078e8032022-04-27 21:17:56 +02006680
Gilles Peskine449bd832023-01-11 14:50:10 +01006681 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, supported_sig_algs_len);
Gabor Mezei078e8032022-04-27 21:17:56 +02006682 supported_sig_algs_end = p + supported_sig_algs_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01006683 while (p < supported_sig_algs_end) {
6684 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, supported_sig_algs_end, 2);
6685 sig_alg = MBEDTLS_GET_UINT16_BE(p, 0);
Gabor Mezei078e8032022-04-27 21:17:56 +02006686 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01006687 MBEDTLS_SSL_DEBUG_MSG(4, ("received signature algorithm: 0x%x %s",
6688 sig_alg,
6689 mbedtls_ssl_sig_alg_to_str(sig_alg)));
Jerry Yu2fe6c632022-06-29 10:02:38 +08006690#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01006691 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_2 &&
6692 (!(mbedtls_ssl_sig_alg_is_supported(ssl, sig_alg) &&
6693 mbedtls_ssl_sig_alg_is_offered(ssl, sig_alg)))) {
Gabor Mezei078e8032022-04-27 21:17:56 +02006694 continue;
Jerry Yu2fe6c632022-06-29 10:02:38 +08006695 }
6696#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gabor Mezei078e8032022-04-27 21:17:56 +02006697
Gilles Peskine449bd832023-01-11 14:50:10 +01006698 MBEDTLS_SSL_DEBUG_MSG(4, ("valid signature algorithm: %s",
6699 mbedtls_ssl_sig_alg_to_str(sig_alg)));
Gabor Mezei078e8032022-04-27 21:17:56 +02006700
Gilles Peskine449bd832023-01-11 14:50:10 +01006701 if (common_idx + 1 < MBEDTLS_RECEIVED_SIG_ALGS_SIZE) {
Gabor Mezei078e8032022-04-27 21:17:56 +02006702 ssl->handshake->received_sig_algs[common_idx] = sig_alg;
6703 common_idx += 1;
6704 }
6705 }
6706 /* Check that we consumed all the message. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006707 if (p != end) {
6708 MBEDTLS_SSL_DEBUG_MSG(1,
6709 ("Signature algorithms extension length misaligned"));
6710 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR,
6711 MBEDTLS_ERR_SSL_DECODE_ERROR);
6712 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Gabor Mezei078e8032022-04-27 21:17:56 +02006713 }
6714
Gilles Peskine449bd832023-01-11 14:50:10 +01006715 if (common_idx == 0) {
6716 MBEDTLS_SSL_DEBUG_MSG(3, ("no signature algorithm in common"));
6717 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE,
6718 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE);
6719 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Gabor Mezei078e8032022-04-27 21:17:56 +02006720 }
6721
Gabor Mezei15b95a62022-05-09 16:37:58 +02006722 ssl->handshake->received_sig_algs[common_idx] = MBEDTLS_TLS_SIG_NONE;
Gilles Peskine449bd832023-01-11 14:50:10 +01006723 return 0;
Gabor Mezei078e8032022-04-27 21:17:56 +02006724}
6725
Ronald Crone68ab4f2022-10-05 12:46:29 +02006726#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Gabor Mezei078e8032022-04-27 21:17:56 +02006727
Jerry Yudc7bd172022-02-17 13:44:15 +08006728#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
6729
6730#if defined(MBEDTLS_USE_PSA_CRYPTO)
6731
Gilles Peskine449bd832023-01-11 14:50:10 +01006732static psa_status_t setup_psa_key_derivation(psa_key_derivation_operation_t *derivation,
6733 mbedtls_svc_key_id_t key,
6734 psa_algorithm_t alg,
6735 const unsigned char *raw_psk, size_t raw_psk_length,
6736 const unsigned char *seed, size_t seed_length,
6737 const unsigned char *label, size_t label_length,
6738 const unsigned char *other_secret,
6739 size_t other_secret_length,
6740 size_t capacity)
Jerry Yudc7bd172022-02-17 13:44:15 +08006741{
6742 psa_status_t status;
6743
Gilles Peskine449bd832023-01-11 14:50:10 +01006744 status = psa_key_derivation_setup(derivation, alg);
6745 if (status != PSA_SUCCESS) {
6746 return status;
6747 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006748
Gilles Peskine449bd832023-01-11 14:50:10 +01006749 if (PSA_ALG_IS_TLS12_PRF(alg) || PSA_ALG_IS_TLS12_PSK_TO_MS(alg)) {
6750 status = psa_key_derivation_input_bytes(derivation,
6751 PSA_KEY_DERIVATION_INPUT_SEED,
6752 seed, seed_length);
6753 if (status != PSA_SUCCESS) {
6754 return status;
Przemek Stekiel1f027032022-04-05 17:12:11 +02006755 }
6756
Gilles Peskine449bd832023-01-11 14:50:10 +01006757 if (other_secret != NULL) {
6758 status = psa_key_derivation_input_bytes(derivation,
6759 PSA_KEY_DERIVATION_INPUT_OTHER_SECRET,
6760 other_secret, other_secret_length);
6761 if (status != PSA_SUCCESS) {
6762 return status;
6763 }
6764 }
6765
6766 if (mbedtls_svc_key_id_is_null(key)) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006767 status = psa_key_derivation_input_bytes(
6768 derivation, PSA_KEY_DERIVATION_INPUT_SECRET,
Gilles Peskine449bd832023-01-11 14:50:10 +01006769 raw_psk, raw_psk_length);
6770 } else {
Jerry Yudc7bd172022-02-17 13:44:15 +08006771 status = psa_key_derivation_input_key(
Gilles Peskine449bd832023-01-11 14:50:10 +01006772 derivation, PSA_KEY_DERIVATION_INPUT_SECRET, key);
Jerry Yudc7bd172022-02-17 13:44:15 +08006773 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006774 if (status != PSA_SUCCESS) {
6775 return status;
6776 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006777
Gilles Peskine449bd832023-01-11 14:50:10 +01006778 status = psa_key_derivation_input_bytes(derivation,
6779 PSA_KEY_DERIVATION_INPUT_LABEL,
6780 label, label_length);
6781 if (status != PSA_SUCCESS) {
6782 return status;
6783 }
6784 } else {
6785 return PSA_ERROR_NOT_SUPPORTED;
Jerry Yudc7bd172022-02-17 13:44:15 +08006786 }
6787
Gilles Peskine449bd832023-01-11 14:50:10 +01006788 status = psa_key_derivation_set_capacity(derivation, capacity);
6789 if (status != PSA_SUCCESS) {
6790 return status;
6791 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006792
Gilles Peskine449bd832023-01-11 14:50:10 +01006793 return PSA_SUCCESS;
Jerry Yudc7bd172022-02-17 13:44:15 +08006794}
6795
Andrzej Kurek57d10632022-10-24 10:32:01 -04006796#if defined(PSA_WANT_ALG_SHA_384) || \
6797 defined(PSA_WANT_ALG_SHA_256)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006798MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006799static int tls_prf_generic(mbedtls_md_type_t md_type,
6800 const unsigned char *secret, size_t slen,
6801 const char *label,
6802 const unsigned char *random, size_t rlen,
6803 unsigned char *dstbuf, size_t dlen)
Jerry Yudc7bd172022-02-17 13:44:15 +08006804{
6805 psa_status_t status;
6806 psa_algorithm_t alg;
6807 mbedtls_svc_key_id_t master_key = MBEDTLS_SVC_KEY_ID_INIT;
6808 psa_key_derivation_operation_t derivation =
6809 PSA_KEY_DERIVATION_OPERATION_INIT;
6810
Gilles Peskine449bd832023-01-11 14:50:10 +01006811 if (md_type == MBEDTLS_MD_SHA384) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006812 alg = PSA_ALG_TLS12_PRF(PSA_ALG_SHA_384);
Gilles Peskine449bd832023-01-11 14:50:10 +01006813 } else {
Jerry Yudc7bd172022-02-17 13:44:15 +08006814 alg = PSA_ALG_TLS12_PRF(PSA_ALG_SHA_256);
Gilles Peskine449bd832023-01-11 14:50:10 +01006815 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006816
6817 /* Normally a "secret" should be long enough to be impossible to
6818 * find by brute force, and in particular should not be empty. But
6819 * this PRF is also used to derive an IV, in particular in EAP-TLS,
6820 * and for this use case it makes sense to have a 0-length "secret".
6821 * Since the key API doesn't allow importing a key of length 0,
6822 * keep master_key=0, which setup_psa_key_derivation() understands
6823 * to mean a 0-length "secret" input. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006824 if (slen != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006825 psa_key_attributes_t key_attributes = psa_key_attributes_init();
Gilles Peskine449bd832023-01-11 14:50:10 +01006826 psa_set_key_usage_flags(&key_attributes, PSA_KEY_USAGE_DERIVE);
6827 psa_set_key_algorithm(&key_attributes, alg);
6828 psa_set_key_type(&key_attributes, PSA_KEY_TYPE_DERIVE);
Jerry Yudc7bd172022-02-17 13:44:15 +08006829
Gilles Peskine449bd832023-01-11 14:50:10 +01006830 status = psa_import_key(&key_attributes, secret, slen, &master_key);
6831 if (status != PSA_SUCCESS) {
6832 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
6833 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006834 }
6835
Gilles Peskine449bd832023-01-11 14:50:10 +01006836 status = setup_psa_key_derivation(&derivation,
6837 master_key, alg,
6838 NULL, 0,
6839 random, rlen,
6840 (unsigned char const *) label,
6841 (size_t) strlen(label),
6842 NULL, 0,
6843 dlen);
6844 if (status != PSA_SUCCESS) {
6845 psa_key_derivation_abort(&derivation);
6846 psa_destroy_key(master_key);
6847 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yudc7bd172022-02-17 13:44:15 +08006848 }
6849
Gilles Peskine449bd832023-01-11 14:50:10 +01006850 status = psa_key_derivation_output_bytes(&derivation, dstbuf, dlen);
6851 if (status != PSA_SUCCESS) {
6852 psa_key_derivation_abort(&derivation);
6853 psa_destroy_key(master_key);
6854 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yudc7bd172022-02-17 13:44:15 +08006855 }
6856
Gilles Peskine449bd832023-01-11 14:50:10 +01006857 status = psa_key_derivation_abort(&derivation);
6858 if (status != PSA_SUCCESS) {
6859 psa_destroy_key(master_key);
6860 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yudc7bd172022-02-17 13:44:15 +08006861 }
6862
Gilles Peskine449bd832023-01-11 14:50:10 +01006863 if (!mbedtls_svc_key_id_is_null(master_key)) {
6864 status = psa_destroy_key(master_key);
6865 }
6866 if (status != PSA_SUCCESS) {
6867 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
6868 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006869
Gilles Peskine449bd832023-01-11 14:50:10 +01006870 return 0;
Jerry Yudc7bd172022-02-17 13:44:15 +08006871}
Andrzej Kurek57d10632022-10-24 10:32:01 -04006872#endif /* PSA_WANT_ALG_SHA_256 || PSA_WANT_ALG_SHA_384 */
Jerry Yudc7bd172022-02-17 13:44:15 +08006873#else /* MBEDTLS_USE_PSA_CRYPTO */
6874
Andrzej Kurek57d10632022-10-24 10:32:01 -04006875#if defined(MBEDTLS_MD_C) && \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006876 (defined(MBEDTLS_MD_CAN_SHA256) || \
6877 defined(MBEDTLS_MD_CAN_SHA384))
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006878MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006879static int tls_prf_generic(mbedtls_md_type_t md_type,
6880 const unsigned char *secret, size_t slen,
6881 const char *label,
6882 const unsigned char *random, size_t rlen,
6883 unsigned char *dstbuf, size_t dlen)
Jerry Yudc7bd172022-02-17 13:44:15 +08006884{
6885 size_t nb;
6886 size_t i, j, k, md_len;
6887 unsigned char *tmp;
6888 size_t tmp_len = 0;
6889 unsigned char h_i[MBEDTLS_MD_MAX_SIZE];
6890 const mbedtls_md_info_t *md_info;
6891 mbedtls_md_context_t md_ctx;
6892 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6893
Gilles Peskine449bd832023-01-11 14:50:10 +01006894 mbedtls_md_init(&md_ctx);
Jerry Yudc7bd172022-02-17 13:44:15 +08006895
Gilles Peskine449bd832023-01-11 14:50:10 +01006896 if ((md_info = mbedtls_md_info_from_type(md_type)) == NULL) {
6897 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
6898 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006899
Gilles Peskine449bd832023-01-11 14:50:10 +01006900 md_len = mbedtls_md_get_size(md_info);
Jerry Yudc7bd172022-02-17 13:44:15 +08006901
Gilles Peskine449bd832023-01-11 14:50:10 +01006902 tmp_len = md_len + strlen(label) + rlen;
6903 tmp = mbedtls_calloc(1, tmp_len);
6904 if (tmp == NULL) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006905 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
6906 goto exit;
6907 }
6908
Gilles Peskine449bd832023-01-11 14:50:10 +01006909 nb = strlen(label);
6910 memcpy(tmp + md_len, label, nb);
6911 memcpy(tmp + md_len + nb, random, rlen);
Jerry Yudc7bd172022-02-17 13:44:15 +08006912 nb += rlen;
6913
6914 /*
6915 * Compute P_<hash>(secret, label + random)[0..dlen]
6916 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006917 if ((ret = mbedtls_md_setup(&md_ctx, md_info, 1)) != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006918 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006919 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006920
Gilles Peskine449bd832023-01-11 14:50:10 +01006921 ret = mbedtls_md_hmac_starts(&md_ctx, secret, slen);
6922 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006923 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006924 }
6925 ret = mbedtls_md_hmac_update(&md_ctx, tmp + md_len, nb);
6926 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006927 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006928 }
6929 ret = mbedtls_md_hmac_finish(&md_ctx, tmp);
6930 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006931 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006932 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006933
Gilles Peskine449bd832023-01-11 14:50:10 +01006934 for (i = 0; i < dlen; i += md_len) {
6935 ret = mbedtls_md_hmac_reset(&md_ctx);
6936 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006937 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006938 }
6939 ret = mbedtls_md_hmac_update(&md_ctx, tmp, md_len + nb);
6940 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006941 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006942 }
6943 ret = mbedtls_md_hmac_finish(&md_ctx, h_i);
6944 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006945 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006946 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006947
Gilles Peskine449bd832023-01-11 14:50:10 +01006948 ret = mbedtls_md_hmac_reset(&md_ctx);
6949 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006950 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006951 }
6952 ret = mbedtls_md_hmac_update(&md_ctx, tmp, md_len);
6953 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006954 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006955 }
6956 ret = mbedtls_md_hmac_finish(&md_ctx, tmp);
6957 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006958 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006959 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006960
Gilles Peskine449bd832023-01-11 14:50:10 +01006961 k = (i + md_len > dlen) ? dlen % md_len : md_len;
Jerry Yudc7bd172022-02-17 13:44:15 +08006962
Gilles Peskine449bd832023-01-11 14:50:10 +01006963 for (j = 0; j < k; j++) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006964 dstbuf[i + j] = h_i[j];
Gilles Peskine449bd832023-01-11 14:50:10 +01006965 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006966 }
6967
6968exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01006969 mbedtls_md_free(&md_ctx);
Jerry Yudc7bd172022-02-17 13:44:15 +08006970
Gilles Peskine449bd832023-01-11 14:50:10 +01006971 if (tmp != NULL) {
6972 mbedtls_platform_zeroize(tmp, tmp_len);
6973 }
Dave Rodgman29b9b2b2022-11-01 16:08:14 +00006974
Gilles Peskine449bd832023-01-11 14:50:10 +01006975 mbedtls_platform_zeroize(h_i, sizeof(h_i));
Jerry Yudc7bd172022-02-17 13:44:15 +08006976
Gilles Peskine449bd832023-01-11 14:50:10 +01006977 mbedtls_free(tmp);
Jerry Yudc7bd172022-02-17 13:44:15 +08006978
Gilles Peskine449bd832023-01-11 14:50:10 +01006979 return ret;
Jerry Yudc7bd172022-02-17 13:44:15 +08006980}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006981#endif /* MBEDTLS_MD_C && ( MBEDTLS_MD_CAN_SHA256 || MBEDTLS_MD_CAN_SHA384 ) */
Jerry Yudc7bd172022-02-17 13:44:15 +08006982#endif /* MBEDTLS_USE_PSA_CRYPTO */
6983
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006984#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006985MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006986static int tls_prf_sha256(const unsigned char *secret, size_t slen,
6987 const char *label,
6988 const unsigned char *random, size_t rlen,
6989 unsigned char *dstbuf, size_t dlen)
Jerry Yudc7bd172022-02-17 13:44:15 +08006990{
Gilles Peskine449bd832023-01-11 14:50:10 +01006991 return tls_prf_generic(MBEDTLS_MD_SHA256, secret, slen,
6992 label, random, rlen, dstbuf, dlen);
Jerry Yudc7bd172022-02-17 13:44:15 +08006993}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006994#endif /* MBEDTLS_MD_CAN_SHA256*/
Jerry Yudc7bd172022-02-17 13:44:15 +08006995
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006996#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006997MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006998static int tls_prf_sha384(const unsigned char *secret, size_t slen,
6999 const char *label,
7000 const unsigned char *random, size_t rlen,
7001 unsigned char *dstbuf, size_t dlen)
Jerry Yudc7bd172022-02-17 13:44:15 +08007002{
Gilles Peskine449bd832023-01-11 14:50:10 +01007003 return tls_prf_generic(MBEDTLS_MD_SHA384, secret, slen,
7004 label, random, rlen, dstbuf, dlen);
Jerry Yudc7bd172022-02-17 13:44:15 +08007005}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01007006#endif /* MBEDTLS_MD_CAN_SHA384*/
Jerry Yudc7bd172022-02-17 13:44:15 +08007007
Jerry Yuf009d862022-02-17 14:01:37 +08007008/*
7009 * Set appropriate PRF function and other SSL / TLS1.2 functions
7010 *
7011 * Inputs:
Jerry Yuf009d862022-02-17 14:01:37 +08007012 * - hash associated with the ciphersuite (only used by TLS 1.2)
7013 *
7014 * Outputs:
7015 * - the tls_prf, calc_verify and calc_finished members of handshake structure
7016 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007017MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007018static int ssl_set_handshake_prfs(mbedtls_ssl_handshake_params *handshake,
7019 mbedtls_md_type_t hash)
Jerry Yuf009d862022-02-17 14:01:37 +08007020{
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01007021#if defined(MBEDTLS_MD_CAN_SHA384)
Gilles Peskine449bd832023-01-11 14:50:10 +01007022 if (hash == MBEDTLS_MD_SHA384) {
Jerry Yuf009d862022-02-17 14:01:37 +08007023 handshake->tls_prf = tls_prf_sha384;
7024 handshake->calc_verify = ssl_calc_verify_tls_sha384;
7025 handshake->calc_finished = ssl_calc_finished_tls_sha384;
Gilles Peskine449bd832023-01-11 14:50:10 +01007026 } else
Jerry Yuf009d862022-02-17 14:01:37 +08007027#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01007028#if defined(MBEDTLS_MD_CAN_SHA256)
Jerry Yuf009d862022-02-17 14:01:37 +08007029 {
Ronald Cron81591aa2022-03-07 09:05:51 +01007030 (void) hash;
Jerry Yuf009d862022-02-17 14:01:37 +08007031 handshake->tls_prf = tls_prf_sha256;
7032 handshake->calc_verify = ssl_calc_verify_tls_sha256;
7033 handshake->calc_finished = ssl_calc_finished_tls_sha256;
7034 }
Ronald Cron81591aa2022-03-07 09:05:51 +01007035#else
Jerry Yuf009d862022-02-17 14:01:37 +08007036 {
Jerry Yuf009d862022-02-17 14:01:37 +08007037 (void) handshake;
Ronald Cron81591aa2022-03-07 09:05:51 +01007038 (void) hash;
Gilles Peskine449bd832023-01-11 14:50:10 +01007039 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yuf009d862022-02-17 14:01:37 +08007040 }
Ronald Cron81591aa2022-03-07 09:05:51 +01007041#endif
Jerry Yuf009d862022-02-17 14:01:37 +08007042
Gilles Peskine449bd832023-01-11 14:50:10 +01007043 return 0;
Jerry Yuf009d862022-02-17 14:01:37 +08007044}
Jerry Yud6ab2352022-02-17 14:03:43 +08007045
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007046/*
7047 * Compute master secret if needed
7048 *
7049 * Parameters:
7050 * [in/out] handshake
7051 * [in] resume, premaster, extended_ms, calc_verify, tls_prf
7052 * (PSA-PSK) ciphersuite_info, psk_opaque
7053 * [out] premaster (cleared)
7054 * [out] master
7055 * [in] ssl: optionally used for debugging, EMS and PSA-PSK
7056 * debug: conf->f_dbg, conf->p_dbg
7057 * EMS: passed to calc_verify (debug + session_negotiate)
Ronald Crona25cf582022-03-07 11:10:36 +01007058 * PSA-PSA: conf
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007059 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007060MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007061static int ssl_compute_master(mbedtls_ssl_handshake_params *handshake,
7062 unsigned char *master,
7063 const mbedtls_ssl_context *ssl)
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007064{
7065 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7066
7067 /* cf. RFC 5246, Section 8.1:
7068 * "The master secret is always exactly 48 bytes in length." */
7069 size_t const master_secret_len = 48;
7070
7071#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
7072 unsigned char session_hash[48];
7073#endif /* MBEDTLS_SSL_EXTENDED_MASTER_SECRET */
7074
7075 /* The label for the KDF used for key expansion.
7076 * This is either "master secret" or "extended master secret"
7077 * depending on whether the Extended Master Secret extension
7078 * is used. */
7079 char const *lbl = "master secret";
7080
Przemek Stekielae4ed302022-04-05 17:15:55 +02007081 /* The seed for the KDF used for key expansion.
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007082 * - If the Extended Master Secret extension is not used,
7083 * this is ClientHello.Random + ServerHello.Random
7084 * (see Sect. 8.1 in RFC 5246).
7085 * - If the Extended Master Secret extension is used,
7086 * this is the transcript of the handshake so far.
7087 * (see Sect. 4 in RFC 7627). */
Przemek Stekielae4ed302022-04-05 17:15:55 +02007088 unsigned char const *seed = handshake->randbytes;
7089 size_t seed_len = 64;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007090
7091#if !defined(MBEDTLS_DEBUG_C) && \
7092 !defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET) && \
7093 !(defined(MBEDTLS_USE_PSA_CRYPTO) && \
Gilles Peskine449bd832023-01-11 14:50:10 +01007094 defined(MBEDTLS_KEY_EXCHANGE_PSK_ENABLED))
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007095 ssl = NULL; /* make sure we don't use it except for those cases */
7096 (void) ssl;
7097#endif
7098
Gilles Peskine449bd832023-01-11 14:50:10 +01007099 if (handshake->resume != 0) {
7100 MBEDTLS_SSL_DEBUG_MSG(3, ("no premaster (session resumed)"));
7101 return 0;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007102 }
7103
7104#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
Gilles Peskine449bd832023-01-11 14:50:10 +01007105 if (handshake->extended_ms == MBEDTLS_SSL_EXTENDED_MS_ENABLED) {
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007106 lbl = "extended master secret";
Przemek Stekielae4ed302022-04-05 17:15:55 +02007107 seed = session_hash;
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01007108 ret = handshake->calc_verify(ssl, session_hash, &seed_len);
7109 if (ret != 0) {
7110 MBEDTLS_SSL_DEBUG_RET(1, "calc_verify", ret);
7111 }
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007112
Gilles Peskine449bd832023-01-11 14:50:10 +01007113 MBEDTLS_SSL_DEBUG_BUF(3, "session hash for extended master secret",
7114 session_hash, seed_len);
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007115 }
Przemek Stekiel169bf0b2022-04-29 07:53:29 +02007116#endif /* MBEDTLS_SSL_EXTENDED_MASTER_SECRET */
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007117
Przemek Stekiel99114f32022-04-22 11:20:09 +02007118#if defined(MBEDTLS_USE_PSA_CRYPTO) && \
Przemek Stekiel8a4b7fd2022-04-28 09:22:22 +02007119 defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007120 if (mbedtls_ssl_ciphersuite_uses_psk(handshake->ciphersuite_info) == 1) {
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007121 /* Perform PSK-to-MS expansion in a single step. */
7122 psa_status_t status;
7123 psa_algorithm_t alg;
7124 mbedtls_svc_key_id_t psk;
7125 psa_key_derivation_operation_t derivation =
7126 PSA_KEY_DERIVATION_OPERATION_INIT;
Dave Rodgman2eab4622023-10-05 13:30:37 +01007127 mbedtls_md_type_t hash_alg = (mbedtls_md_type_t) handshake->ciphersuite_info->mac;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007128
Gilles Peskine449bd832023-01-11 14:50:10 +01007129 MBEDTLS_SSL_DEBUG_MSG(2, ("perform PSA-based PSK-to-MS expansion"));
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007130
Gilles Peskine449bd832023-01-11 14:50:10 +01007131 psk = mbedtls_ssl_get_opaque_psk(ssl);
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007132
Gilles Peskine449bd832023-01-11 14:50:10 +01007133 if (hash_alg == MBEDTLS_MD_SHA384) {
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007134 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_384);
Gilles Peskine449bd832023-01-11 14:50:10 +01007135 } else {
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007136 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_256);
Gilles Peskine449bd832023-01-11 14:50:10 +01007137 }
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007138
Przemek Stekiel51a1f362022-04-13 08:57:06 +02007139 size_t other_secret_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01007140 unsigned char *other_secret = NULL;
Przemek Stekielc2033402022-04-05 17:19:41 +02007141
Gilles Peskine449bd832023-01-11 14:50:10 +01007142 switch (handshake->ciphersuite_info->key_exchange) {
Przemek Stekiel19b80f82022-04-14 08:29:31 +02007143 /* Provide other secret.
Przemek Stekiel51a1f362022-04-13 08:57:06 +02007144 * Other secret is stored in premaster, where first 2 bytes hold the
Przemek Stekiel19b80f82022-04-14 08:29:31 +02007145 * length of the other key.
Przemek Stekielc2033402022-04-05 17:19:41 +02007146 */
Przemek Stekiel19b80f82022-04-14 08:29:31 +02007147 case MBEDTLS_KEY_EXCHANGE_RSA_PSK:
Przemek Stekiel8abcee92022-04-28 09:16:28 +02007148 /* For RSA-PSK other key length is always 48 bytes. */
Przemek Stekiel19b80f82022-04-14 08:29:31 +02007149 other_secret_len = 48;
7150 other_secret = handshake->premaster + 2;
7151 break;
7152 case MBEDTLS_KEY_EXCHANGE_ECDHE_PSK:
Przemek Stekielb293aaa2022-04-19 12:22:38 +02007153 case MBEDTLS_KEY_EXCHANGE_DHE_PSK:
Przemek Stekiel19b80f82022-04-14 08:29:31 +02007154 other_secret_len = MBEDTLS_GET_UINT16_BE(handshake->premaster, 0);
7155 other_secret = handshake->premaster + 2;
7156 break;
7157 default:
7158 break;
Przemek Stekielc2033402022-04-05 17:19:41 +02007159 }
7160
Gilles Peskine449bd832023-01-11 14:50:10 +01007161 status = setup_psa_key_derivation(&derivation, psk, alg,
7162 ssl->conf->psk, ssl->conf->psk_len,
7163 seed, seed_len,
7164 (unsigned char const *) lbl,
7165 (size_t) strlen(lbl),
7166 other_secret, other_secret_len,
7167 master_secret_len);
7168 if (status != PSA_SUCCESS) {
7169 psa_key_derivation_abort(&derivation);
7170 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007171 }
7172
Gilles Peskine449bd832023-01-11 14:50:10 +01007173 status = psa_key_derivation_output_bytes(&derivation,
7174 master,
7175 master_secret_len);
7176 if (status != PSA_SUCCESS) {
7177 psa_key_derivation_abort(&derivation);
7178 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007179 }
7180
Gilles Peskine449bd832023-01-11 14:50:10 +01007181 status = psa_key_derivation_abort(&derivation);
7182 if (status != PSA_SUCCESS) {
7183 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
7184 }
7185 } else
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007186#endif
7187 {
Neil Armstrongca7d5062022-05-31 14:43:23 +02007188#if defined(MBEDTLS_USE_PSA_CRYPTO) && \
Gilles Peskine449bd832023-01-11 14:50:10 +01007189 defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
7190 if (handshake->ciphersuite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_ECJPAKE) {
Neil Armstrongca7d5062022-05-31 14:43:23 +02007191 psa_status_t status;
7192 psa_algorithm_t alg = PSA_ALG_TLS12_ECJPAKE_TO_PMS;
7193 psa_key_derivation_operation_t derivation =
7194 PSA_KEY_DERIVATION_OPERATION_INIT;
7195
Gilles Peskine449bd832023-01-11 14:50:10 +01007196 MBEDTLS_SSL_DEBUG_MSG(2, ("perform PSA-based PMS KDF for ECJPAKE"));
Neil Armstrongca7d5062022-05-31 14:43:23 +02007197
7198 handshake->pmslen = PSA_TLS12_ECJPAKE_TO_PMS_DATA_SIZE;
7199
Gilles Peskine449bd832023-01-11 14:50:10 +01007200 status = psa_key_derivation_setup(&derivation, alg);
7201 if (status != PSA_SUCCESS) {
7202 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Neil Armstrongca7d5062022-05-31 14:43:23 +02007203 }
7204
Gilles Peskine449bd832023-01-11 14:50:10 +01007205 status = psa_key_derivation_set_capacity(&derivation,
7206 PSA_TLS12_ECJPAKE_TO_PMS_DATA_SIZE);
7207 if (status != PSA_SUCCESS) {
7208 psa_key_derivation_abort(&derivation);
7209 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Neil Armstrongca7d5062022-05-31 14:43:23 +02007210 }
7211
Gilles Peskine449bd832023-01-11 14:50:10 +01007212 status = psa_pake_get_implicit_key(&handshake->psa_pake_ctx,
7213 &derivation);
7214 if (status != PSA_SUCCESS) {
7215 psa_key_derivation_abort(&derivation);
7216 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Neil Armstrongca7d5062022-05-31 14:43:23 +02007217 }
7218
Gilles Peskine449bd832023-01-11 14:50:10 +01007219 status = psa_key_derivation_output_bytes(&derivation,
7220 handshake->premaster,
7221 handshake->pmslen);
7222 if (status != PSA_SUCCESS) {
7223 psa_key_derivation_abort(&derivation);
7224 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
7225 }
7226
7227 status = psa_key_derivation_abort(&derivation);
7228 if (status != PSA_SUCCESS) {
7229 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Neil Armstrongca7d5062022-05-31 14:43:23 +02007230 }
7231 }
7232#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01007233 ret = handshake->tls_prf(handshake->premaster, handshake->pmslen,
7234 lbl, seed, seed_len,
7235 master,
7236 master_secret_len);
7237 if (ret != 0) {
7238 MBEDTLS_SSL_DEBUG_RET(1, "prf", ret);
7239 return ret;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007240 }
7241
Gilles Peskine449bd832023-01-11 14:50:10 +01007242 MBEDTLS_SSL_DEBUG_BUF(3, "premaster secret",
7243 handshake->premaster,
7244 handshake->pmslen);
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007245
Gilles Peskine449bd832023-01-11 14:50:10 +01007246 mbedtls_platform_zeroize(handshake->premaster,
7247 sizeof(handshake->premaster));
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007248 }
7249
Gilles Peskine449bd832023-01-11 14:50:10 +01007250 return 0;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007251}
7252
Gilles Peskine449bd832023-01-11 14:50:10 +01007253int mbedtls_ssl_derive_keys(mbedtls_ssl_context *ssl)
Jerry Yud62f87e2022-02-17 14:09:02 +08007254{
7255 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7256 const mbedtls_ssl_ciphersuite_t * const ciphersuite_info =
7257 ssl->handshake->ciphersuite_info;
7258
Gilles Peskine449bd832023-01-11 14:50:10 +01007259 MBEDTLS_SSL_DEBUG_MSG(2, ("=> derive keys"));
Jerry Yud62f87e2022-02-17 14:09:02 +08007260
7261 /* Set PRF, calc_verify and calc_finished function pointers */
Gilles Peskine449bd832023-01-11 14:50:10 +01007262 ret = ssl_set_handshake_prfs(ssl->handshake,
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01007263 (mbedtls_md_type_t) ciphersuite_info->mac);
Gilles Peskine449bd832023-01-11 14:50:10 +01007264 if (ret != 0) {
7265 MBEDTLS_SSL_DEBUG_RET(1, "ssl_set_handshake_prfs", ret);
7266 return ret;
Jerry Yud62f87e2022-02-17 14:09:02 +08007267 }
7268
7269 /* Compute master secret if needed */
Gilles Peskine449bd832023-01-11 14:50:10 +01007270 ret = ssl_compute_master(ssl->handshake,
7271 ssl->session_negotiate->master,
7272 ssl);
7273 if (ret != 0) {
7274 MBEDTLS_SSL_DEBUG_RET(1, "ssl_compute_master", ret);
7275 return ret;
Jerry Yud62f87e2022-02-17 14:09:02 +08007276 }
7277
7278 /* Swap the client and server random values:
7279 * - MS derivation wanted client+server (RFC 5246 8.1)
7280 * - key derivation wants server+client (RFC 5246 6.3) */
7281 {
7282 unsigned char tmp[64];
Gilles Peskine449bd832023-01-11 14:50:10 +01007283 memcpy(tmp, ssl->handshake->randbytes, 64);
7284 memcpy(ssl->handshake->randbytes, tmp + 32, 32);
7285 memcpy(ssl->handshake->randbytes + 32, tmp, 32);
7286 mbedtls_platform_zeroize(tmp, sizeof(tmp));
Jerry Yud62f87e2022-02-17 14:09:02 +08007287 }
7288
7289 /* Populate transform structure */
Gilles Peskine449bd832023-01-11 14:50:10 +01007290 ret = ssl_tls12_populate_transform(ssl->transform_negotiate,
7291 ssl->session_negotiate->ciphersuite,
7292 ssl->session_negotiate->master,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02007293#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01007294 ssl->session_negotiate->encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02007295#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01007296 ssl->handshake->tls_prf,
7297 ssl->handshake->randbytes,
7298 ssl->tls_version,
7299 ssl->conf->endpoint,
7300 ssl);
7301 if (ret != 0) {
7302 MBEDTLS_SSL_DEBUG_RET(1, "ssl_tls12_populate_transform", ret);
7303 return ret;
Jerry Yud62f87e2022-02-17 14:09:02 +08007304 }
7305
7306 /* We no longer need Server/ClientHello.random values */
Gilles Peskine449bd832023-01-11 14:50:10 +01007307 mbedtls_platform_zeroize(ssl->handshake->randbytes,
7308 sizeof(ssl->handshake->randbytes));
Jerry Yud62f87e2022-02-17 14:09:02 +08007309
Gilles Peskine449bd832023-01-11 14:50:10 +01007310 MBEDTLS_SSL_DEBUG_MSG(2, ("<= derive keys"));
Jerry Yud62f87e2022-02-17 14:09:02 +08007311
Gilles Peskine449bd832023-01-11 14:50:10 +01007312 return 0;
Jerry Yud62f87e2022-02-17 14:09:02 +08007313}
Jerry Yu8392e0d2022-02-17 14:10:24 +08007314
Gilles Peskine449bd832023-01-11 14:50:10 +01007315int mbedtls_ssl_set_calc_verify_md(mbedtls_ssl_context *ssl, int md)
Ronald Cron4dcbca92022-03-07 10:21:40 +01007316{
Gilles Peskine449bd832023-01-11 14:50:10 +01007317 switch (md) {
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01007318#if defined(MBEDTLS_MD_CAN_SHA384)
Ronald Cron4dcbca92022-03-07 10:21:40 +01007319 case MBEDTLS_SSL_HASH_SHA384:
7320 ssl->handshake->calc_verify = ssl_calc_verify_tls_sha384;
7321 break;
7322#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01007323#if defined(MBEDTLS_MD_CAN_SHA256)
Ronald Cron4dcbca92022-03-07 10:21:40 +01007324 case MBEDTLS_SSL_HASH_SHA256:
7325 ssl->handshake->calc_verify = ssl_calc_verify_tls_sha256;
7326 break;
7327#endif
7328 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01007329 return -1;
Ronald Cron4dcbca92022-03-07 10:21:40 +01007330 }
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01007331#if !defined(MBEDTLS_MD_CAN_SHA384) && \
7332 !defined(MBEDTLS_MD_CAN_SHA256)
Andrzej Kurekeabeb302022-10-17 07:52:51 -04007333 (void) ssl;
7334#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01007335 return 0;
Ronald Cron4dcbca92022-03-07 10:21:40 +01007336}
7337
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007338#if defined(MBEDTLS_USE_PSA_CRYPTO)
7339static int ssl_calc_verify_tls_psa(const mbedtls_ssl_context *ssl,
7340 const psa_hash_operation_t *hs_op,
7341 size_t buffer_size,
7342 unsigned char *hash,
7343 size_t *hlen)
7344{
7345 psa_status_t status;
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007346 psa_hash_operation_t cloned_op = psa_hash_operation_init();
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007347
7348#if !defined(MBEDTLS_DEBUG_C)
7349 (void) ssl;
7350#endif
7351 MBEDTLS_SSL_DEBUG_MSG(2, ("=> PSA calc verify"));
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007352 status = psa_hash_clone(hs_op, &cloned_op);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007353 if (status != PSA_SUCCESS) {
7354 goto exit;
7355 }
7356
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007357 status = psa_hash_finish(&cloned_op, hash, buffer_size, hlen);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007358 if (status != PSA_SUCCESS) {
7359 goto exit;
7360 }
7361
7362 MBEDTLS_SSL_DEBUG_BUF(3, "PSA calculated verify result", hash, *hlen);
7363 MBEDTLS_SSL_DEBUG_MSG(2, ("<= PSA calc verify"));
7364
7365exit:
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007366 psa_hash_abort(&cloned_op);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007367 return mbedtls_md_error_from_psa(status);
7368}
7369#else
7370static int ssl_calc_verify_tls_legacy(const mbedtls_ssl_context *ssl,
7371 const mbedtls_md_context_t *hs_ctx,
7372 unsigned char *hash,
7373 size_t *hlen)
7374{
7375 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007376 mbedtls_md_context_t cloned_ctx;
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007377
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007378 mbedtls_md_init(&cloned_ctx);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007379
7380#if !defined(MBEDTLS_DEBUG_C)
7381 (void) ssl;
7382#endif
7383 MBEDTLS_SSL_DEBUG_MSG(2, ("=> calc verify"));
7384
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007385 ret = mbedtls_md_setup(&cloned_ctx, mbedtls_md_info_from_ctx(hs_ctx), 0);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007386 if (ret != 0) {
7387 goto exit;
7388 }
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007389 ret = mbedtls_md_clone(&cloned_ctx, hs_ctx);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007390 if (ret != 0) {
7391 goto exit;
7392 }
7393
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007394 ret = mbedtls_md_finish(&cloned_ctx, hash);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007395 if (ret != 0) {
7396 goto exit;
7397 }
7398
7399 *hlen = mbedtls_md_get_size(mbedtls_md_info_from_ctx(hs_ctx));
7400
7401 MBEDTLS_SSL_DEBUG_BUF(3, "calculated verify result", hash, *hlen);
7402 MBEDTLS_SSL_DEBUG_MSG(2, ("<= calc verify"));
7403
7404exit:
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007405 mbedtls_md_free(&cloned_ctx);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007406 return ret;
7407}
7408#endif /* MBEDTLS_USE_PSA_CRYPTO */
7409
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01007410#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +01007411int ssl_calc_verify_tls_sha256(const mbedtls_ssl_context *ssl,
7412 unsigned char *hash,
7413 size_t *hlen)
Jerry Yu8392e0d2022-02-17 14:10:24 +08007414{
7415#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007416 return ssl_calc_verify_tls_psa(ssl, &ssl->handshake->fin_sha256_psa, 32,
7417 hash, hlen);
Jerry Yu8392e0d2022-02-17 14:10:24 +08007418#else
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007419 return ssl_calc_verify_tls_legacy(ssl, &ssl->handshake->fin_sha256,
7420 hash, hlen);
Jerry Yu8392e0d2022-02-17 14:10:24 +08007421#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu8392e0d2022-02-17 14:10:24 +08007422}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01007423#endif /* MBEDTLS_MD_CAN_SHA256 */
Jerry Yu8392e0d2022-02-17 14:10:24 +08007424
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01007425#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +01007426int ssl_calc_verify_tls_sha384(const mbedtls_ssl_context *ssl,
7427 unsigned char *hash,
7428 size_t *hlen)
Jerry Yuc1cb3842022-02-17 14:13:48 +08007429{
7430#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007431 return ssl_calc_verify_tls_psa(ssl, &ssl->handshake->fin_sha384_psa, 48,
7432 hash, hlen);
Jerry Yuc1cb3842022-02-17 14:13:48 +08007433#else
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007434 return ssl_calc_verify_tls_legacy(ssl, &ssl->handshake->fin_sha384,
7435 hash, hlen);
Jerry Yuc1cb3842022-02-17 14:13:48 +08007436#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yuc1cb3842022-02-17 14:13:48 +08007437}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01007438#endif /* MBEDTLS_MD_CAN_SHA384 */
Jerry Yuc1cb3842022-02-17 14:13:48 +08007439
Neil Armstrong80f6f322022-05-03 17:56:38 +02007440#if !defined(MBEDTLS_USE_PSA_CRYPTO) && \
7441 defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007442int mbedtls_ssl_psk_derive_premaster(mbedtls_ssl_context *ssl, mbedtls_key_exchange_type_t key_ex)
Jerry Yuce3dca42022-02-17 14:16:37 +08007443{
7444 unsigned char *p = ssl->handshake->premaster;
Gilles Peskine449bd832023-01-11 14:50:10 +01007445 unsigned char *end = p + sizeof(ssl->handshake->premaster);
Jerry Yuce3dca42022-02-17 14:16:37 +08007446 const unsigned char *psk = NULL;
7447 size_t psk_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01007448 int psk_ret = mbedtls_ssl_get_psk(ssl, &psk, &psk_len);
Jerry Yuce3dca42022-02-17 14:16:37 +08007449
Gilles Peskine449bd832023-01-11 14:50:10 +01007450 if (psk_ret == MBEDTLS_ERR_SSL_PRIVATE_KEY_REQUIRED) {
Jerry Yuce3dca42022-02-17 14:16:37 +08007451 /*
7452 * This should never happen because the existence of a PSK is always
Przemek Stekielb293aaa2022-04-19 12:22:38 +02007453 * checked before calling this function.
7454 *
7455 * The exception is opaque DHE-PSK. For DHE-PSK fill premaster with
Przemek Stekiel8abcee92022-04-28 09:16:28 +02007456 * the shared secret without PSK.
Jerry Yuce3dca42022-02-17 14:16:37 +08007457 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007458 if (key_ex != MBEDTLS_KEY_EXCHANGE_DHE_PSK) {
7459 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
7460 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Przemek Stekielb293aaa2022-04-19 12:22:38 +02007461 }
Jerry Yuce3dca42022-02-17 14:16:37 +08007462 }
7463
7464 /*
7465 * PMS = struct {
7466 * opaque other_secret<0..2^16-1>;
7467 * opaque psk<0..2^16-1>;
7468 * };
7469 * with "other_secret" depending on the particular key exchange
7470 */
7471#if defined(MBEDTLS_KEY_EXCHANGE_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007472 if (key_ex == MBEDTLS_KEY_EXCHANGE_PSK) {
7473 if (end - p < 2) {
7474 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
7475 }
Jerry Yuce3dca42022-02-17 14:16:37 +08007476
Gilles Peskine449bd832023-01-11 14:50:10 +01007477 MBEDTLS_PUT_UINT16_BE(psk_len, p, 0);
Jerry Yuce3dca42022-02-17 14:16:37 +08007478 p += 2;
7479
Gilles Peskine449bd832023-01-11 14:50:10 +01007480 if (end < p || (size_t) (end - p) < psk_len) {
7481 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
7482 }
Jerry Yuce3dca42022-02-17 14:16:37 +08007483
Gilles Peskine449bd832023-01-11 14:50:10 +01007484 memset(p, 0, psk_len);
Jerry Yuce3dca42022-02-17 14:16:37 +08007485 p += psk_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01007486 } else
Jerry Yuce3dca42022-02-17 14:16:37 +08007487#endif /* MBEDTLS_KEY_EXCHANGE_PSK_ENABLED */
7488#if defined(MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007489 if (key_ex == MBEDTLS_KEY_EXCHANGE_RSA_PSK) {
Jerry Yuce3dca42022-02-17 14:16:37 +08007490 /*
7491 * other_secret already set by the ClientKeyExchange message,
7492 * and is 48 bytes long
7493 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007494 if (end - p < 2) {
7495 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
7496 }
Jerry Yuce3dca42022-02-17 14:16:37 +08007497
7498 *p++ = 0;
7499 *p++ = 48;
7500 p += 48;
Gilles Peskine449bd832023-01-11 14:50:10 +01007501 } else
Jerry Yuce3dca42022-02-17 14:16:37 +08007502#endif /* MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED */
7503#if defined(MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007504 if (key_ex == MBEDTLS_KEY_EXCHANGE_DHE_PSK) {
Jerry Yuce3dca42022-02-17 14:16:37 +08007505 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7506 size_t len;
7507
7508 /* Write length only when we know the actual value */
Gilles Peskine449bd832023-01-11 14:50:10 +01007509 if ((ret = mbedtls_dhm_calc_secret(&ssl->handshake->dhm_ctx,
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00007510 p + 2, (size_t) (end - (p + 2)), &len,
Gilles Peskine449bd832023-01-11 14:50:10 +01007511 ssl->conf->f_rng, ssl->conf->p_rng)) != 0) {
7512 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_dhm_calc_secret", ret);
7513 return ret;
Jerry Yuce3dca42022-02-17 14:16:37 +08007514 }
Gilles Peskine449bd832023-01-11 14:50:10 +01007515 MBEDTLS_PUT_UINT16_BE(len, p, 0);
Jerry Yuce3dca42022-02-17 14:16:37 +08007516 p += 2 + len;
7517
Gilles Peskine449bd832023-01-11 14:50:10 +01007518 MBEDTLS_SSL_DEBUG_MPI(3, "DHM: K ", &ssl->handshake->dhm_ctx.K);
7519 } else
Jerry Yuce3dca42022-02-17 14:16:37 +08007520#endif /* MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED */
Neil Armstrong80f6f322022-05-03 17:56:38 +02007521#if defined(MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007522 if (key_ex == MBEDTLS_KEY_EXCHANGE_ECDHE_PSK) {
Jerry Yuce3dca42022-02-17 14:16:37 +08007523 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7524 size_t zlen;
7525
Gilles Peskine449bd832023-01-11 14:50:10 +01007526 if ((ret = mbedtls_ecdh_calc_secret(&ssl->handshake->ecdh_ctx, &zlen,
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00007527 p + 2, (size_t) (end - (p + 2)),
Gilles Peskine449bd832023-01-11 14:50:10 +01007528 ssl->conf->f_rng, ssl->conf->p_rng)) != 0) {
7529 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ecdh_calc_secret", ret);
7530 return ret;
Jerry Yuce3dca42022-02-17 14:16:37 +08007531 }
7532
Gilles Peskine449bd832023-01-11 14:50:10 +01007533 MBEDTLS_PUT_UINT16_BE(zlen, p, 0);
Jerry Yuce3dca42022-02-17 14:16:37 +08007534 p += 2 + zlen;
7535
Gilles Peskine449bd832023-01-11 14:50:10 +01007536 MBEDTLS_SSL_DEBUG_ECDH(3, &ssl->handshake->ecdh_ctx,
7537 MBEDTLS_DEBUG_ECDH_Z);
7538 } else
Neil Armstrong80f6f322022-05-03 17:56:38 +02007539#endif /* MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED */
Jerry Yuce3dca42022-02-17 14:16:37 +08007540 {
Gilles Peskine449bd832023-01-11 14:50:10 +01007541 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
7542 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yuce3dca42022-02-17 14:16:37 +08007543 }
7544
7545 /* opaque psk<0..2^16-1>; */
Gilles Peskine449bd832023-01-11 14:50:10 +01007546 if (end - p < 2) {
7547 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
7548 }
Jerry Yuce3dca42022-02-17 14:16:37 +08007549
Gilles Peskine449bd832023-01-11 14:50:10 +01007550 MBEDTLS_PUT_UINT16_BE(psk_len, p, 0);
Jerry Yuce3dca42022-02-17 14:16:37 +08007551 p += 2;
7552
Gilles Peskine449bd832023-01-11 14:50:10 +01007553 if (end < p || (size_t) (end - p) < psk_len) {
7554 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
7555 }
Jerry Yuce3dca42022-02-17 14:16:37 +08007556
Gilles Peskine449bd832023-01-11 14:50:10 +01007557 memcpy(p, psk, psk_len);
Jerry Yuce3dca42022-02-17 14:16:37 +08007558 p += psk_len;
7559
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00007560 ssl->handshake->pmslen = (size_t) (p - ssl->handshake->premaster);
Jerry Yuce3dca42022-02-17 14:16:37 +08007561
Gilles Peskine449bd832023-01-11 14:50:10 +01007562 return 0;
Jerry Yuce3dca42022-02-17 14:16:37 +08007563}
Neil Armstrong80f6f322022-05-03 17:56:38 +02007564#endif /* !MBEDTLS_USE_PSA_CRYPTO && MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
Jerry Yuc2c673d2022-02-17 14:20:39 +08007565
7566#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007567MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007568static int ssl_write_hello_request(mbedtls_ssl_context *ssl);
Jerry Yuc2c673d2022-02-17 14:20:39 +08007569
7570#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01007571int mbedtls_ssl_resend_hello_request(mbedtls_ssl_context *ssl)
Jerry Yuc2c673d2022-02-17 14:20:39 +08007572{
7573 /* If renegotiation is not enforced, retransmit until we would reach max
7574 * timeout if we were using the usual handshake doubling scheme */
Gilles Peskine449bd832023-01-11 14:50:10 +01007575 if (ssl->conf->renego_max_records < 0) {
Jerry Yuc2c673d2022-02-17 14:20:39 +08007576 uint32_t ratio = ssl->conf->hs_timeout_max / ssl->conf->hs_timeout_min + 1;
7577 unsigned char doublings = 1;
7578
Gilles Peskine449bd832023-01-11 14:50:10 +01007579 while (ratio != 0) {
Jerry Yuc2c673d2022-02-17 14:20:39 +08007580 ++doublings;
7581 ratio >>= 1;
7582 }
7583
Gilles Peskine449bd832023-01-11 14:50:10 +01007584 if (++ssl->renego_records_seen > doublings) {
7585 MBEDTLS_SSL_DEBUG_MSG(2, ("no longer retransmitting hello request"));
7586 return 0;
Jerry Yuc2c673d2022-02-17 14:20:39 +08007587 }
7588 }
7589
Gilles Peskine449bd832023-01-11 14:50:10 +01007590 return ssl_write_hello_request(ssl);
Jerry Yuc2c673d2022-02-17 14:20:39 +08007591}
7592#endif
7593#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_RENEGOTIATION */
Jerry Yud9526692022-02-17 14:23:47 +08007594
Jerry Yud9526692022-02-17 14:23:47 +08007595/*
7596 * Handshake functions
7597 */
7598#if !defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
7599/* No certificate support -> dummy functions */
Gilles Peskine449bd832023-01-11 14:50:10 +01007600int mbedtls_ssl_write_certificate(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08007601{
7602 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
7603 ssl->handshake->ciphersuite_info;
7604
Gilles Peskine449bd832023-01-11 14:50:10 +01007605 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007606
Gilles Peskine449bd832023-01-11 14:50:10 +01007607 if (!mbedtls_ssl_ciphersuite_uses_srv_cert(ciphersuite_info)) {
7608 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007609 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01007610 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007611 }
7612
Gilles Peskine449bd832023-01-11 14:50:10 +01007613 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
7614 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007615}
7616
Gilles Peskine449bd832023-01-11 14:50:10 +01007617int mbedtls_ssl_parse_certificate(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08007618{
7619 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
7620 ssl->handshake->ciphersuite_info;
7621
Gilles Peskine449bd832023-01-11 14:50:10 +01007622 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007623
Gilles Peskine449bd832023-01-11 14:50:10 +01007624 if (!mbedtls_ssl_ciphersuite_uses_srv_cert(ciphersuite_info)) {
7625 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007626 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01007627 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007628 }
7629
Gilles Peskine449bd832023-01-11 14:50:10 +01007630 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
7631 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007632}
7633
7634#else /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
7635/* Some certificate support -> implement write and parse */
7636
Gilles Peskine449bd832023-01-11 14:50:10 +01007637int mbedtls_ssl_write_certificate(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08007638{
7639 int ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
7640 size_t i, n;
7641 const mbedtls_x509_crt *crt;
7642 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
7643 ssl->handshake->ciphersuite_info;
7644
Gilles Peskine449bd832023-01-11 14:50:10 +01007645 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007646
Gilles Peskine449bd832023-01-11 14:50:10 +01007647 if (!mbedtls_ssl_ciphersuite_uses_srv_cert(ciphersuite_info)) {
7648 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007649 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01007650 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007651 }
7652
7653#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007654 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
7655 if (ssl->handshake->client_auth == 0) {
7656 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007657 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01007658 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007659 }
7660 }
7661#endif /* MBEDTLS_SSL_CLI_C */
7662#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007663 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
7664 if (mbedtls_ssl_own_cert(ssl) == NULL) {
Jerry Yud9526692022-02-17 14:23:47 +08007665 /* Should never happen because we shouldn't have picked the
7666 * ciphersuite if we don't have a certificate. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007667 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007668 }
7669 }
7670#endif
7671
Gilles Peskine449bd832023-01-11 14:50:10 +01007672 MBEDTLS_SSL_DEBUG_CRT(3, "own certificate", mbedtls_ssl_own_cert(ssl));
Jerry Yud9526692022-02-17 14:23:47 +08007673
7674 /*
7675 * 0 . 0 handshake type
7676 * 1 . 3 handshake length
7677 * 4 . 6 length of all certs
7678 * 7 . 9 length of cert. 1
7679 * 10 . n-1 peer certificate
7680 * n . n+2 length of cert. 2
7681 * n+3 . ... upper level cert, etc.
7682 */
7683 i = 7;
Gilles Peskine449bd832023-01-11 14:50:10 +01007684 crt = mbedtls_ssl_own_cert(ssl);
Jerry Yud9526692022-02-17 14:23:47 +08007685
Gilles Peskine449bd832023-01-11 14:50:10 +01007686 while (crt != NULL) {
Jerry Yud9526692022-02-17 14:23:47 +08007687 n = crt->raw.len;
Gilles Peskine449bd832023-01-11 14:50:10 +01007688 if (n > MBEDTLS_SSL_OUT_CONTENT_LEN - 3 - i) {
7689 MBEDTLS_SSL_DEBUG_MSG(1, ("certificate too large, %" MBEDTLS_PRINTF_SIZET
7690 " > %" MBEDTLS_PRINTF_SIZET,
7691 i + 3 + n, (size_t) MBEDTLS_SSL_OUT_CONTENT_LEN));
7692 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
Jerry Yud9526692022-02-17 14:23:47 +08007693 }
7694
Gilles Peskine449bd832023-01-11 14:50:10 +01007695 ssl->out_msg[i] = MBEDTLS_BYTE_2(n);
7696 ssl->out_msg[i + 1] = MBEDTLS_BYTE_1(n);
7697 ssl->out_msg[i + 2] = MBEDTLS_BYTE_0(n);
Jerry Yud9526692022-02-17 14:23:47 +08007698
Gilles Peskine449bd832023-01-11 14:50:10 +01007699 i += 3; memcpy(ssl->out_msg + i, crt->raw.p, n);
Jerry Yud9526692022-02-17 14:23:47 +08007700 i += n; crt = crt->next;
7701 }
7702
Gilles Peskine449bd832023-01-11 14:50:10 +01007703 ssl->out_msg[4] = MBEDTLS_BYTE_2(i - 7);
7704 ssl->out_msg[5] = MBEDTLS_BYTE_1(i - 7);
7705 ssl->out_msg[6] = MBEDTLS_BYTE_0(i - 7);
Jerry Yud9526692022-02-17 14:23:47 +08007706
7707 ssl->out_msglen = i;
7708 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
7709 ssl->out_msg[0] = MBEDTLS_SSL_HS_CERTIFICATE;
7710
7711 ssl->state++;
7712
Gilles Peskine449bd832023-01-11 14:50:10 +01007713 if ((ret = mbedtls_ssl_write_handshake_msg(ssl)) != 0) {
7714 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_handshake_msg", ret);
7715 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007716 }
7717
Gilles Peskine449bd832023-01-11 14:50:10 +01007718 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007719
Gilles Peskine449bd832023-01-11 14:50:10 +01007720 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007721}
7722
7723#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
7724
7725#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007726MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007727static int ssl_check_peer_crt_unchanged(mbedtls_ssl_context *ssl,
7728 unsigned char *crt_buf,
7729 size_t crt_buf_len)
Jerry Yud9526692022-02-17 14:23:47 +08007730{
7731 mbedtls_x509_crt const * const peer_crt = ssl->session->peer_cert;
7732
Gilles Peskine449bd832023-01-11 14:50:10 +01007733 if (peer_crt == NULL) {
7734 return -1;
7735 }
Jerry Yud9526692022-02-17 14:23:47 +08007736
Gilles Peskine449bd832023-01-11 14:50:10 +01007737 if (peer_crt->raw.len != crt_buf_len) {
7738 return -1;
7739 }
Jerry Yud9526692022-02-17 14:23:47 +08007740
Gilles Peskine449bd832023-01-11 14:50:10 +01007741 return memcmp(peer_crt->raw.p, crt_buf, peer_crt->raw.len);
Jerry Yud9526692022-02-17 14:23:47 +08007742}
7743#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007744MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007745static int ssl_check_peer_crt_unchanged(mbedtls_ssl_context *ssl,
7746 unsigned char *crt_buf,
7747 size_t crt_buf_len)
Jerry Yud9526692022-02-17 14:23:47 +08007748{
7749 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7750 unsigned char const * const peer_cert_digest =
7751 ssl->session->peer_cert_digest;
7752 mbedtls_md_type_t const peer_cert_digest_type =
7753 ssl->session->peer_cert_digest_type;
7754 mbedtls_md_info_t const * const digest_info =
Gilles Peskine449bd832023-01-11 14:50:10 +01007755 mbedtls_md_info_from_type(peer_cert_digest_type);
Jerry Yud9526692022-02-17 14:23:47 +08007756 unsigned char tmp_digest[MBEDTLS_SSL_PEER_CERT_DIGEST_MAX_LEN];
7757 size_t digest_len;
7758
Gilles Peskine449bd832023-01-11 14:50:10 +01007759 if (peer_cert_digest == NULL || digest_info == NULL) {
7760 return -1;
7761 }
Jerry Yud9526692022-02-17 14:23:47 +08007762
Gilles Peskine449bd832023-01-11 14:50:10 +01007763 digest_len = mbedtls_md_get_size(digest_info);
7764 if (digest_len > MBEDTLS_SSL_PEER_CERT_DIGEST_MAX_LEN) {
7765 return -1;
7766 }
Jerry Yud9526692022-02-17 14:23:47 +08007767
Gilles Peskine449bd832023-01-11 14:50:10 +01007768 ret = mbedtls_md(digest_info, crt_buf, crt_buf_len, tmp_digest);
7769 if (ret != 0) {
7770 return -1;
7771 }
Jerry Yud9526692022-02-17 14:23:47 +08007772
Gilles Peskine449bd832023-01-11 14:50:10 +01007773 return memcmp(tmp_digest, peer_cert_digest, digest_len);
Jerry Yud9526692022-02-17 14:23:47 +08007774}
7775#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7776#endif /* MBEDTLS_SSL_RENEGOTIATION && MBEDTLS_SSL_CLI_C */
7777
7778/*
7779 * Once the certificate message is read, parse it into a cert chain and
7780 * perform basic checks, but leave actual verification to the caller
7781 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007782MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007783static int ssl_parse_certificate_chain(mbedtls_ssl_context *ssl,
7784 mbedtls_x509_crt *chain)
Jerry Yud9526692022-02-17 14:23:47 +08007785{
7786 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7787#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007788 int crt_cnt = 0;
Jerry Yud9526692022-02-17 14:23:47 +08007789#endif
7790 size_t i, n;
7791 uint8_t alert;
7792
Gilles Peskine449bd832023-01-11 14:50:10 +01007793 if (ssl->in_msgtype != MBEDTLS_SSL_MSG_HANDSHAKE) {
7794 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7795 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7796 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
7797 return MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
Jerry Yud9526692022-02-17 14:23:47 +08007798 }
7799
Gilles Peskine449bd832023-01-11 14:50:10 +01007800 if (ssl->in_msg[0] != MBEDTLS_SSL_HS_CERTIFICATE) {
7801 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7802 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
7803 return MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
Jerry Yud9526692022-02-17 14:23:47 +08007804 }
7805
Gilles Peskine449bd832023-01-11 14:50:10 +01007806 if (ssl->in_hslen < mbedtls_ssl_hs_hdr_len(ssl) + 3 + 3) {
7807 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7808 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7809 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
7810 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007811 }
7812
Gilles Peskine449bd832023-01-11 14:50:10 +01007813 i = mbedtls_ssl_hs_hdr_len(ssl);
Jerry Yud9526692022-02-17 14:23:47 +08007814
7815 /*
7816 * Same message structure as in mbedtls_ssl_write_certificate()
7817 */
Dave Rodgmana3d0f612023-11-03 23:34:02 +00007818 n = MBEDTLS_GET_UINT16_BE(ssl->in_msg, i + 1);
Jerry Yud9526692022-02-17 14:23:47 +08007819
Gilles Peskine449bd832023-01-11 14:50:10 +01007820 if (ssl->in_msg[i] != 0 ||
7821 ssl->in_hslen != n + 3 + mbedtls_ssl_hs_hdr_len(ssl)) {
7822 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7823 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7824 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
7825 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007826 }
7827
7828 /* Make &ssl->in_msg[i] point to the beginning of the CRT chain. */
7829 i += 3;
7830
7831 /* Iterate through and parse the CRTs in the provided chain. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007832 while (i < ssl->in_hslen) {
Jerry Yud9526692022-02-17 14:23:47 +08007833 /* Check that there's room for the next CRT's length fields. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007834 if (i + 3 > ssl->in_hslen) {
7835 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7836 mbedtls_ssl_send_alert_message(ssl,
7837 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7838 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
7839 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007840 }
7841 /* In theory, the CRT can be up to 2**24 Bytes, but we don't support
7842 * anything beyond 2**16 ~ 64K. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007843 if (ssl->in_msg[i] != 0) {
7844 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7845 mbedtls_ssl_send_alert_message(ssl,
7846 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7847 MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT);
7848 return MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
Jerry Yud9526692022-02-17 14:23:47 +08007849 }
7850
7851 /* Read length of the next CRT in the chain. */
Dave Rodgmana3d0f612023-11-03 23:34:02 +00007852 n = MBEDTLS_GET_UINT16_BE(ssl->in_msg, i + 1);
Jerry Yud9526692022-02-17 14:23:47 +08007853 i += 3;
7854
Gilles Peskine449bd832023-01-11 14:50:10 +01007855 if (n < 128 || i + n > ssl->in_hslen) {
7856 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7857 mbedtls_ssl_send_alert_message(ssl,
7858 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7859 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
7860 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007861 }
7862
7863 /* Check if we're handling the first CRT in the chain. */
7864#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007865 if (crt_cnt++ == 0 &&
Jerry Yud9526692022-02-17 14:23:47 +08007866 ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
Gilles Peskine449bd832023-01-11 14:50:10 +01007867 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS) {
Jerry Yud9526692022-02-17 14:23:47 +08007868 /* During client-side renegotiation, check that the server's
7869 * end-CRTs hasn't changed compared to the initial handshake,
7870 * mitigating the triple handshake attack. On success, reuse
7871 * the original end-CRT instead of parsing it again. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007872 MBEDTLS_SSL_DEBUG_MSG(3, ("Check that peer CRT hasn't changed during renegotiation"));
7873 if (ssl_check_peer_crt_unchanged(ssl,
7874 &ssl->in_msg[i],
7875 n) != 0) {
7876 MBEDTLS_SSL_DEBUG_MSG(1, ("new server cert during renegotiation"));
7877 mbedtls_ssl_send_alert_message(ssl,
7878 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7879 MBEDTLS_SSL_ALERT_MSG_ACCESS_DENIED);
7880 return MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
Jerry Yud9526692022-02-17 14:23:47 +08007881 }
7882
7883 /* Now we can safely free the original chain. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007884 ssl_clear_peer_cert(ssl->session);
Jerry Yud9526692022-02-17 14:23:47 +08007885 }
7886#endif /* MBEDTLS_SSL_RENEGOTIATION && MBEDTLS_SSL_CLI_C */
7887
7888 /* Parse the next certificate in the chain. */
7889#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01007890 ret = mbedtls_x509_crt_parse_der(chain, ssl->in_msg + i, n);
Jerry Yud9526692022-02-17 14:23:47 +08007891#else
7892 /* If we don't need to store the CRT chain permanently, parse
7893 * it in-place from the input buffer instead of making a copy. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007894 ret = mbedtls_x509_crt_parse_der_nocopy(chain, ssl->in_msg + i, n);
Jerry Yud9526692022-02-17 14:23:47 +08007895#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Gilles Peskine449bd832023-01-11 14:50:10 +01007896 switch (ret) {
Jerry Yud9526692022-02-17 14:23:47 +08007897 case 0: /*ok*/
7898 case MBEDTLS_ERR_X509_UNKNOWN_SIG_ALG + MBEDTLS_ERR_OID_NOT_FOUND:
7899 /* Ignore certificate with an unknown algorithm: maybe a
7900 prior certificate was already trusted. */
7901 break;
7902
7903 case MBEDTLS_ERR_X509_ALLOC_FAILED:
7904 alert = MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR;
7905 goto crt_parse_der_failed;
7906
7907 case MBEDTLS_ERR_X509_UNKNOWN_VERSION:
7908 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
7909 goto crt_parse_der_failed;
7910
7911 default:
7912 alert = MBEDTLS_SSL_ALERT_MSG_BAD_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01007913crt_parse_der_failed:
7914 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL, alert);
7915 MBEDTLS_SSL_DEBUG_RET(1, " mbedtls_x509_crt_parse_der", ret);
7916 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007917 }
7918
7919 i += n;
7920 }
7921
Gilles Peskine449bd832023-01-11 14:50:10 +01007922 MBEDTLS_SSL_DEBUG_CRT(3, "peer certificate", chain);
7923 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007924}
7925
7926#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007927MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007928static int ssl_srv_check_client_no_crt_notification(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08007929{
Gilles Peskine449bd832023-01-11 14:50:10 +01007930 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
7931 return -1;
7932 }
Jerry Yud9526692022-02-17 14:23:47 +08007933
Gilles Peskine449bd832023-01-11 14:50:10 +01007934 if (ssl->in_hslen == 3 + mbedtls_ssl_hs_hdr_len(ssl) &&
Jerry Yud9526692022-02-17 14:23:47 +08007935 ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
7936 ssl->in_msg[0] == MBEDTLS_SSL_HS_CERTIFICATE &&
Gilles Peskine449bd832023-01-11 14:50:10 +01007937 memcmp(ssl->in_msg + mbedtls_ssl_hs_hdr_len(ssl), "\0\0\0", 3) == 0) {
7938 MBEDTLS_SSL_DEBUG_MSG(1, ("peer has no certificate"));
7939 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007940 }
Gilles Peskine449bd832023-01-11 14:50:10 +01007941 return -1;
Jerry Yud9526692022-02-17 14:23:47 +08007942}
7943#endif /* MBEDTLS_SSL_SRV_C */
7944
7945/* Check if a certificate message is expected.
7946 * Return either
7947 * - SSL_CERTIFICATE_EXPECTED, or
7948 * - SSL_CERTIFICATE_SKIP
7949 * indicating whether a Certificate message is expected or not.
7950 */
7951#define SSL_CERTIFICATE_EXPECTED 0
7952#define SSL_CERTIFICATE_SKIP 1
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007953MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007954static int ssl_parse_certificate_coordinate(mbedtls_ssl_context *ssl,
7955 int authmode)
Jerry Yud9526692022-02-17 14:23:47 +08007956{
7957 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
7958 ssl->handshake->ciphersuite_info;
7959
Gilles Peskine449bd832023-01-11 14:50:10 +01007960 if (!mbedtls_ssl_ciphersuite_uses_srv_cert(ciphersuite_info)) {
7961 return SSL_CERTIFICATE_SKIP;
7962 }
Jerry Yud9526692022-02-17 14:23:47 +08007963
7964#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007965 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
7966 if (ciphersuite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_RSA_PSK) {
7967 return SSL_CERTIFICATE_SKIP;
7968 }
Jerry Yud9526692022-02-17 14:23:47 +08007969
Gilles Peskine449bd832023-01-11 14:50:10 +01007970 if (authmode == MBEDTLS_SSL_VERIFY_NONE) {
Jerry Yud9526692022-02-17 14:23:47 +08007971 ssl->session_negotiate->verify_result =
7972 MBEDTLS_X509_BADCERT_SKIP_VERIFY;
Gilles Peskine449bd832023-01-11 14:50:10 +01007973 return SSL_CERTIFICATE_SKIP;
Jerry Yud9526692022-02-17 14:23:47 +08007974 }
7975 }
7976#else
7977 ((void) authmode);
7978#endif /* MBEDTLS_SSL_SRV_C */
7979
Gilles Peskine449bd832023-01-11 14:50:10 +01007980 return SSL_CERTIFICATE_EXPECTED;
Jerry Yud9526692022-02-17 14:23:47 +08007981}
7982
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007983MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007984static int ssl_parse_certificate_verify(mbedtls_ssl_context *ssl,
7985 int authmode,
7986 mbedtls_x509_crt *chain,
7987 void *rs_ctx)
Jerry Yud9526692022-02-17 14:23:47 +08007988{
7989 int ret = 0;
7990 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
7991 ssl->handshake->ciphersuite_info;
7992 int have_ca_chain = 0;
7993
7994 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *);
7995 void *p_vrfy;
7996
Gilles Peskine449bd832023-01-11 14:50:10 +01007997 if (authmode == MBEDTLS_SSL_VERIFY_NONE) {
7998 return 0;
7999 }
Jerry Yud9526692022-02-17 14:23:47 +08008000
Gilles Peskine449bd832023-01-11 14:50:10 +01008001 if (ssl->f_vrfy != NULL) {
8002 MBEDTLS_SSL_DEBUG_MSG(3, ("Use context-specific verification callback"));
Jerry Yud9526692022-02-17 14:23:47 +08008003 f_vrfy = ssl->f_vrfy;
8004 p_vrfy = ssl->p_vrfy;
Gilles Peskine449bd832023-01-11 14:50:10 +01008005 } else {
8006 MBEDTLS_SSL_DEBUG_MSG(3, ("Use configuration-specific verification callback"));
Jerry Yud9526692022-02-17 14:23:47 +08008007 f_vrfy = ssl->conf->f_vrfy;
8008 p_vrfy = ssl->conf->p_vrfy;
8009 }
8010
8011 /*
8012 * Main check: verify certificate
8013 */
8014#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
Gilles Peskine449bd832023-01-11 14:50:10 +01008015 if (ssl->conf->f_ca_cb != NULL) {
Jerry Yud9526692022-02-17 14:23:47 +08008016 ((void) rs_ctx);
8017 have_ca_chain = 1;
8018
Gilles Peskine449bd832023-01-11 14:50:10 +01008019 MBEDTLS_SSL_DEBUG_MSG(3, ("use CA callback for X.509 CRT verification"));
Jerry Yud9526692022-02-17 14:23:47 +08008020 ret = mbedtls_x509_crt_verify_with_ca_cb(
8021 chain,
8022 ssl->conf->f_ca_cb,
8023 ssl->conf->p_ca_cb,
8024 ssl->conf->cert_profile,
8025 ssl->hostname,
8026 &ssl->session_negotiate->verify_result,
Gilles Peskine449bd832023-01-11 14:50:10 +01008027 f_vrfy, p_vrfy);
8028 } else
Jerry Yud9526692022-02-17 14:23:47 +08008029#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
8030 {
8031 mbedtls_x509_crt *ca_chain;
8032 mbedtls_x509_crl *ca_crl;
8033
8034#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01008035 if (ssl->handshake->sni_ca_chain != NULL) {
Jerry Yud9526692022-02-17 14:23:47 +08008036 ca_chain = ssl->handshake->sni_ca_chain;
8037 ca_crl = ssl->handshake->sni_ca_crl;
Gilles Peskine449bd832023-01-11 14:50:10 +01008038 } else
Jerry Yud9526692022-02-17 14:23:47 +08008039#endif
8040 {
8041 ca_chain = ssl->conf->ca_chain;
8042 ca_crl = ssl->conf->ca_crl;
8043 }
8044
Gilles Peskine449bd832023-01-11 14:50:10 +01008045 if (ca_chain != NULL) {
Jerry Yud9526692022-02-17 14:23:47 +08008046 have_ca_chain = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01008047 }
Jerry Yud9526692022-02-17 14:23:47 +08008048
8049 ret = mbedtls_x509_crt_verify_restartable(
8050 chain,
8051 ca_chain, ca_crl,
8052 ssl->conf->cert_profile,
8053 ssl->hostname,
8054 &ssl->session_negotiate->verify_result,
Gilles Peskine449bd832023-01-11 14:50:10 +01008055 f_vrfy, p_vrfy, rs_ctx);
Jerry Yud9526692022-02-17 14:23:47 +08008056 }
8057
Gilles Peskine449bd832023-01-11 14:50:10 +01008058 if (ret != 0) {
8059 MBEDTLS_SSL_DEBUG_RET(1, "x509_verify_cert", ret);
Jerry Yud9526692022-02-17 14:23:47 +08008060 }
8061
8062#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01008063 if (ret == MBEDTLS_ERR_ECP_IN_PROGRESS) {
8064 return MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS;
8065 }
Jerry Yud9526692022-02-17 14:23:47 +08008066#endif
8067
8068 /*
8069 * Secondary checks: always done, but change 'ret' only if it was 0
8070 */
8071
Valerio Settiacd32c02023-06-29 18:06:29 +02008072#if defined(MBEDTLS_PK_HAVE_ECC_KEYS)
Jerry Yud9526692022-02-17 14:23:47 +08008073 {
8074 const mbedtls_pk_context *pk = &chain->pk;
8075
Manuel Pégourié-Gonnard66b0d612022-06-17 10:49:29 +02008076 /* If certificate uses an EC key, make sure the curve is OK.
8077 * This is a public key, so it can't be opaque, so can_do() is a good
8078 * enough check to ensure pk_ec() is safe to use here. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008079 if (mbedtls_pk_can_do(pk, MBEDTLS_PK_ECKEY)) {
Leonid Rozenboim19e59732022-08-08 16:52:38 -07008080 /* and in the unlikely case the above assumption no longer holds
8081 * we are making sure that pk_ec() here does not return a NULL
8082 */
Valerio Settif9362b72023-11-29 08:42:27 +01008083 mbedtls_ecp_group_id grp_id = mbedtls_pk_get_ec_group_id(pk);
Valerio Settid0405092023-05-24 13:16:40 +02008084 if (grp_id == MBEDTLS_ECP_DP_NONE) {
8085 MBEDTLS_SSL_DEBUG_MSG(1, ("invalid group ID"));
Gilles Peskine449bd832023-01-11 14:50:10 +01008086 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Leonid Rozenboim19e59732022-08-08 16:52:38 -07008087 }
Valerio Setti97207782023-05-18 18:59:06 +02008088 if (mbedtls_ssl_check_curve(ssl, grp_id) != 0) {
Leonid Rozenboim19e59732022-08-08 16:52:38 -07008089 ssl->session_negotiate->verify_result |=
8090 MBEDTLS_X509_BADCERT_BAD_KEY;
8091
Gilles Peskine449bd832023-01-11 14:50:10 +01008092 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate (EC key curve)"));
8093 if (ret == 0) {
Leonid Rozenboim19e59732022-08-08 16:52:38 -07008094 ret = MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
Gilles Peskine449bd832023-01-11 14:50:10 +01008095 }
Leonid Rozenboim19e59732022-08-08 16:52:38 -07008096 }
Jerry Yud9526692022-02-17 14:23:47 +08008097 }
8098 }
Valerio Settiacd32c02023-06-29 18:06:29 +02008099#endif /* MBEDTLS_PK_HAVE_ECC_KEYS */
Jerry Yud9526692022-02-17 14:23:47 +08008100
Gilles Peskine449bd832023-01-11 14:50:10 +01008101 if (mbedtls_ssl_check_cert_usage(chain,
8102 ciphersuite_info,
8103 !ssl->conf->endpoint,
8104 &ssl->session_negotiate->verify_result) != 0) {
8105 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate (usage extensions)"));
8106 if (ret == 0) {
Jerry Yud9526692022-02-17 14:23:47 +08008107 ret = MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
Gilles Peskine449bd832023-01-11 14:50:10 +01008108 }
Jerry Yud9526692022-02-17 14:23:47 +08008109 }
8110
8111 /* mbedtls_x509_crt_verify_with_profile is supposed to report a
8112 * verification failure through MBEDTLS_ERR_X509_CERT_VERIFY_FAILED,
8113 * with details encoded in the verification flags. All other kinds
8114 * of error codes, including those from the user provided f_vrfy
8115 * functions, are treated as fatal and lead to a failure of
8116 * ssl_parse_certificate even if verification was optional. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008117 if (authmode == MBEDTLS_SSL_VERIFY_OPTIONAL &&
8118 (ret == MBEDTLS_ERR_X509_CERT_VERIFY_FAILED ||
8119 ret == MBEDTLS_ERR_SSL_BAD_CERTIFICATE)) {
Jerry Yud9526692022-02-17 14:23:47 +08008120 ret = 0;
8121 }
8122
Gilles Peskine449bd832023-01-11 14:50:10 +01008123 if (have_ca_chain == 0 && authmode == MBEDTLS_SSL_VERIFY_REQUIRED) {
8124 MBEDTLS_SSL_DEBUG_MSG(1, ("got no CA chain"));
Jerry Yud9526692022-02-17 14:23:47 +08008125 ret = MBEDTLS_ERR_SSL_CA_CHAIN_REQUIRED;
8126 }
8127
Gilles Peskine449bd832023-01-11 14:50:10 +01008128 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08008129 uint8_t alert;
8130
8131 /* The certificate may have been rejected for several reasons.
8132 Pick one and send the corresponding alert. Which alert to send
8133 may be a subject of debate in some cases. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008134 if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_OTHER) {
Jerry Yud9526692022-02-17 14:23:47 +08008135 alert = MBEDTLS_SSL_ALERT_MSG_ACCESS_DENIED;
Gilles Peskine449bd832023-01-11 14:50:10 +01008136 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_CN_MISMATCH) {
Jerry Yud9526692022-02-17 14:23:47 +08008137 alert = MBEDTLS_SSL_ALERT_MSG_BAD_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01008138 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_KEY_USAGE) {
Jerry Yud9526692022-02-17 14:23:47 +08008139 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01008140 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_EXT_KEY_USAGE) {
Jerry Yud9526692022-02-17 14:23:47 +08008141 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01008142 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_NS_CERT_TYPE) {
Jerry Yud9526692022-02-17 14:23:47 +08008143 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01008144 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_BAD_PK) {
Jerry Yud9526692022-02-17 14:23:47 +08008145 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01008146 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_BAD_KEY) {
Jerry Yud9526692022-02-17 14:23:47 +08008147 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01008148 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_EXPIRED) {
Jerry Yud9526692022-02-17 14:23:47 +08008149 alert = MBEDTLS_SSL_ALERT_MSG_CERT_EXPIRED;
Gilles Peskine449bd832023-01-11 14:50:10 +01008150 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_REVOKED) {
Jerry Yud9526692022-02-17 14:23:47 +08008151 alert = MBEDTLS_SSL_ALERT_MSG_CERT_REVOKED;
Gilles Peskine449bd832023-01-11 14:50:10 +01008152 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_NOT_TRUSTED) {
Jerry Yud9526692022-02-17 14:23:47 +08008153 alert = MBEDTLS_SSL_ALERT_MSG_UNKNOWN_CA;
Gilles Peskine449bd832023-01-11 14:50:10 +01008154 } else {
Jerry Yud9526692022-02-17 14:23:47 +08008155 alert = MBEDTLS_SSL_ALERT_MSG_CERT_UNKNOWN;
Gilles Peskine449bd832023-01-11 14:50:10 +01008156 }
8157 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8158 alert);
Jerry Yud9526692022-02-17 14:23:47 +08008159 }
8160
8161#if defined(MBEDTLS_DEBUG_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008162 if (ssl->session_negotiate->verify_result != 0) {
8163 MBEDTLS_SSL_DEBUG_MSG(3, ("! Certificate verification flags %08x",
8164 (unsigned int) ssl->session_negotiate->verify_result));
8165 } else {
8166 MBEDTLS_SSL_DEBUG_MSG(3, ("Certificate verification flags clear"));
Jerry Yud9526692022-02-17 14:23:47 +08008167 }
8168#endif /* MBEDTLS_DEBUG_C */
8169
Gilles Peskine449bd832023-01-11 14:50:10 +01008170 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08008171}
8172
8173#if !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02008174MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01008175static int ssl_remember_peer_crt_digest(mbedtls_ssl_context *ssl,
8176 unsigned char *start, size_t len)
Jerry Yud9526692022-02-17 14:23:47 +08008177{
8178 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
8179 /* Remember digest of the peer's end-CRT. */
8180 ssl->session_negotiate->peer_cert_digest =
Gilles Peskine449bd832023-01-11 14:50:10 +01008181 mbedtls_calloc(1, MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN);
8182 if (ssl->session_negotiate->peer_cert_digest == NULL) {
8183 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc(%d bytes) failed",
8184 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN));
8185 mbedtls_ssl_send_alert_message(ssl,
8186 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8187 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR);
Jerry Yud9526692022-02-17 14:23:47 +08008188
Gilles Peskine449bd832023-01-11 14:50:10 +01008189 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
Jerry Yud9526692022-02-17 14:23:47 +08008190 }
8191
Gilles Peskine449bd832023-01-11 14:50:10 +01008192 ret = mbedtls_md(mbedtls_md_info_from_type(
8193 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE),
8194 start, len,
8195 ssl->session_negotiate->peer_cert_digest);
Jerry Yud9526692022-02-17 14:23:47 +08008196
8197 ssl->session_negotiate->peer_cert_digest_type =
8198 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE;
8199 ssl->session_negotiate->peer_cert_digest_len =
8200 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN;
8201
Gilles Peskine449bd832023-01-11 14:50:10 +01008202 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08008203}
8204
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02008205MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01008206static int ssl_remember_peer_pubkey(mbedtls_ssl_context *ssl,
8207 unsigned char *start, size_t len)
Jerry Yud9526692022-02-17 14:23:47 +08008208{
8209 unsigned char *end = start + len;
8210 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
8211
8212 /* Make a copy of the peer's raw public key. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008213 mbedtls_pk_init(&ssl->handshake->peer_pubkey);
8214 ret = mbedtls_pk_parse_subpubkey(&start, end,
8215 &ssl->handshake->peer_pubkey);
8216 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08008217 /* We should have parsed the public key before. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008218 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08008219 }
8220
Gilles Peskine449bd832023-01-11 14:50:10 +01008221 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08008222}
8223#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
8224
Gilles Peskine449bd832023-01-11 14:50:10 +01008225int mbedtls_ssl_parse_certificate(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08008226{
8227 int ret = 0;
8228 int crt_expected;
8229#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
8230 const int authmode = ssl->handshake->sni_authmode != MBEDTLS_SSL_VERIFY_UNSET
8231 ? ssl->handshake->sni_authmode
8232 : ssl->conf->authmode;
8233#else
8234 const int authmode = ssl->conf->authmode;
8235#endif
8236 void *rs_ctx = NULL;
8237 mbedtls_x509_crt *chain = NULL;
8238
Gilles Peskine449bd832023-01-11 14:50:10 +01008239 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08008240
Gilles Peskine449bd832023-01-11 14:50:10 +01008241 crt_expected = ssl_parse_certificate_coordinate(ssl, authmode);
8242 if (crt_expected == SSL_CERTIFICATE_SKIP) {
8243 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08008244 goto exit;
8245 }
8246
8247#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01008248 if (ssl->handshake->ecrs_enabled &&
8249 ssl->handshake->ecrs_state == ssl_ecrs_crt_verify) {
Jerry Yud9526692022-02-17 14:23:47 +08008250 chain = ssl->handshake->ecrs_peer_cert;
8251 ssl->handshake->ecrs_peer_cert = NULL;
8252 goto crt_verify;
8253 }
8254#endif
8255
Gilles Peskine449bd832023-01-11 14:50:10 +01008256 if ((ret = mbedtls_ssl_read_record(ssl, 1)) != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08008257 /* mbedtls_ssl_read_record may have sent an alert already. We
8258 let it decide whether to alert. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008259 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_read_record", ret);
Jerry Yud9526692022-02-17 14:23:47 +08008260 goto exit;
8261 }
8262
8263#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008264 if (ssl_srv_check_client_no_crt_notification(ssl) == 0) {
Jerry Yud9526692022-02-17 14:23:47 +08008265 ssl->session_negotiate->verify_result = MBEDTLS_X509_BADCERT_MISSING;
8266
Gilles Peskine449bd832023-01-11 14:50:10 +01008267 if (authmode != MBEDTLS_SSL_VERIFY_OPTIONAL) {
Jerry Yud9526692022-02-17 14:23:47 +08008268 ret = MBEDTLS_ERR_SSL_NO_CLIENT_CERTIFICATE;
Gilles Peskine449bd832023-01-11 14:50:10 +01008269 }
Jerry Yud9526692022-02-17 14:23:47 +08008270
8271 goto exit;
8272 }
8273#endif /* MBEDTLS_SSL_SRV_C */
8274
8275 /* Clear existing peer CRT structure in case we tried to
8276 * reuse a session but it failed, and allocate a new one. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008277 ssl_clear_peer_cert(ssl->session_negotiate);
Jerry Yud9526692022-02-17 14:23:47 +08008278
Gilles Peskine449bd832023-01-11 14:50:10 +01008279 chain = mbedtls_calloc(1, sizeof(mbedtls_x509_crt));
8280 if (chain == NULL) {
8281 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc(%" MBEDTLS_PRINTF_SIZET " bytes) failed",
8282 sizeof(mbedtls_x509_crt)));
8283 mbedtls_ssl_send_alert_message(ssl,
8284 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8285 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR);
Jerry Yud9526692022-02-17 14:23:47 +08008286
8287 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
8288 goto exit;
8289 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008290 mbedtls_x509_crt_init(chain);
Jerry Yud9526692022-02-17 14:23:47 +08008291
Gilles Peskine449bd832023-01-11 14:50:10 +01008292 ret = ssl_parse_certificate_chain(ssl, chain);
8293 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08008294 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01008295 }
Jerry Yud9526692022-02-17 14:23:47 +08008296
8297#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01008298 if (ssl->handshake->ecrs_enabled) {
Jerry Yud9526692022-02-17 14:23:47 +08008299 ssl->handshake->ecrs_state = ssl_ecrs_crt_verify;
Gilles Peskine449bd832023-01-11 14:50:10 +01008300 }
Jerry Yud9526692022-02-17 14:23:47 +08008301
8302crt_verify:
Gilles Peskine449bd832023-01-11 14:50:10 +01008303 if (ssl->handshake->ecrs_enabled) {
Jerry Yud9526692022-02-17 14:23:47 +08008304 rs_ctx = &ssl->handshake->ecrs_ctx;
Gilles Peskine449bd832023-01-11 14:50:10 +01008305 }
Jerry Yud9526692022-02-17 14:23:47 +08008306#endif
8307
Gilles Peskine449bd832023-01-11 14:50:10 +01008308 ret = ssl_parse_certificate_verify(ssl, authmode,
8309 chain, rs_ctx);
8310 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08008311 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01008312 }
Jerry Yud9526692022-02-17 14:23:47 +08008313
8314#if !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
8315 {
8316 unsigned char *crt_start, *pk_start;
8317 size_t crt_len, pk_len;
8318
8319 /* We parse the CRT chain without copying, so
8320 * these pointers point into the input buffer,
8321 * and are hence still valid after freeing the
8322 * CRT chain. */
8323
8324 crt_start = chain->raw.p;
8325 crt_len = chain->raw.len;
8326
8327 pk_start = chain->pk_raw.p;
8328 pk_len = chain->pk_raw.len;
8329
8330 /* Free the CRT structures before computing
8331 * digest and copying the peer's public key. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008332 mbedtls_x509_crt_free(chain);
8333 mbedtls_free(chain);
Jerry Yud9526692022-02-17 14:23:47 +08008334 chain = NULL;
8335
Gilles Peskine449bd832023-01-11 14:50:10 +01008336 ret = ssl_remember_peer_crt_digest(ssl, crt_start, crt_len);
8337 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08008338 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01008339 }
Jerry Yud9526692022-02-17 14:23:47 +08008340
Gilles Peskine449bd832023-01-11 14:50:10 +01008341 ret = ssl_remember_peer_pubkey(ssl, pk_start, pk_len);
8342 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08008343 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01008344 }
Jerry Yud9526692022-02-17 14:23:47 +08008345 }
8346#else /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
8347 /* Pass ownership to session structure. */
8348 ssl->session_negotiate->peer_cert = chain;
8349 chain = NULL;
8350#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
8351
Gilles Peskine449bd832023-01-11 14:50:10 +01008352 MBEDTLS_SSL_DEBUG_MSG(2, ("<= parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08008353
8354exit:
8355
Gilles Peskine449bd832023-01-11 14:50:10 +01008356 if (ret == 0) {
Jerry Yud9526692022-02-17 14:23:47 +08008357 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01008358 }
Jerry Yud9526692022-02-17 14:23:47 +08008359
8360#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01008361 if (ret == MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS) {
Jerry Yud9526692022-02-17 14:23:47 +08008362 ssl->handshake->ecrs_peer_cert = chain;
8363 chain = NULL;
8364 }
8365#endif
8366
Gilles Peskine449bd832023-01-11 14:50:10 +01008367 if (chain != NULL) {
8368 mbedtls_x509_crt_free(chain);
8369 mbedtls_free(chain);
Jerry Yud9526692022-02-17 14:23:47 +08008370 }
8371
Gilles Peskine449bd832023-01-11 14:50:10 +01008372 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08008373}
8374#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
8375
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008376static int ssl_calc_finished_tls_generic(mbedtls_ssl_context *ssl, void *ctx,
8377 unsigned char *padbuf, size_t hlen,
8378 unsigned char *buf, int from)
Jerry Yu615bd6f2022-02-17 14:25:15 +08008379{
Dave Rodgmanc37ad442023-11-03 23:36:06 +00008380 unsigned int len = 12;
Jerry Yu615bd6f2022-02-17 14:25:15 +08008381 const char *sender;
Jerry Yu615bd6f2022-02-17 14:25:15 +08008382#if defined(MBEDTLS_USE_PSA_CRYPTO)
Jerry Yu615bd6f2022-02-17 14:25:15 +08008383 psa_status_t status;
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008384 psa_hash_operation_t *hs_op = ctx;
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02008385 psa_hash_operation_t cloned_op = PSA_HASH_OPERATION_INIT;
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008386 size_t hash_size;
Jerry Yu615bd6f2022-02-17 14:25:15 +08008387#else
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01008388 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008389 mbedtls_md_context_t *hs_ctx = ctx;
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02008390 mbedtls_md_context_t cloned_ctx;
8391 mbedtls_md_init(&cloned_ctx);
Jerry Yu615bd6f2022-02-17 14:25:15 +08008392#endif
8393
8394 mbedtls_ssl_session *session = ssl->session_negotiate;
Gilles Peskine449bd832023-01-11 14:50:10 +01008395 if (!session) {
Jerry Yu615bd6f2022-02-17 14:25:15 +08008396 session = ssl->session;
Gilles Peskine449bd832023-01-11 14:50:10 +01008397 }
Jerry Yu615bd6f2022-02-17 14:25:15 +08008398
Gilles Peskine449bd832023-01-11 14:50:10 +01008399 sender = (from == MBEDTLS_SSL_IS_CLIENT)
Jerry Yu615bd6f2022-02-17 14:25:15 +08008400 ? "client finished"
8401 : "server finished";
8402
8403#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008404 MBEDTLS_SSL_DEBUG_MSG(2, ("=> calc PSA finished tls"));
Jerry Yu615bd6f2022-02-17 14:25:15 +08008405
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02008406 status = psa_hash_clone(hs_op, &cloned_op);
Gilles Peskine449bd832023-01-11 14:50:10 +01008407 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01008408 goto exit;
Jerry Yu615bd6f2022-02-17 14:25:15 +08008409 }
8410
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02008411 status = psa_hash_finish(&cloned_op, padbuf, hlen, &hash_size);
Gilles Peskine449bd832023-01-11 14:50:10 +01008412 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01008413 goto exit;
Jerry Yu615bd6f2022-02-17 14:25:15 +08008414 }
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008415 MBEDTLS_SSL_DEBUG_BUF(3, "PSA calculated padbuf", padbuf, hlen);
Jerry Yu615bd6f2022-02-17 14:25:15 +08008416#else
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008417 MBEDTLS_SSL_DEBUG_MSG(2, ("=> calc finished tls"));
Jerry Yu615bd6f2022-02-17 14:25:15 +08008418
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02008419 ret = mbedtls_md_setup(&cloned_ctx, mbedtls_md_info_from_ctx(hs_ctx), 0);
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01008420 if (ret != 0) {
8421 goto exit;
8422 }
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02008423 ret = mbedtls_md_clone(&cloned_ctx, hs_ctx);
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01008424 if (ret != 0) {
8425 goto exit;
8426 }
Jerry Yu615bd6f2022-02-17 14:25:15 +08008427
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02008428 ret = mbedtls_md_finish(&cloned_ctx, padbuf);
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008429 if (ret != 0) {
8430 goto exit;
8431 }
8432#endif /* MBEDTLS_USE_PSA_CRYPTO */
8433
8434 MBEDTLS_SSL_DEBUG_BUF(4, "finished output", padbuf, hlen);
8435
Jerry Yu615bd6f2022-02-17 14:25:15 +08008436 /*
8437 * TLSv1.2:
8438 * hash = PRF( master, finished_label,
8439 * Hash( handshake ) )[0.11]
8440 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008441 ssl->handshake->tls_prf(session->master, 48, sender,
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008442 padbuf, hlen, buf, len);
Jerry Yu615bd6f2022-02-17 14:25:15 +08008443
Gilles Peskine449bd832023-01-11 14:50:10 +01008444 MBEDTLS_SSL_DEBUG_BUF(3, "calc finished result", buf, len);
Jerry Yu615bd6f2022-02-17 14:25:15 +08008445
Paul Elliottecb95be2023-08-11 16:41:04 +01008446 mbedtls_platform_zeroize(padbuf, hlen);
Jerry Yu615bd6f2022-02-17 14:25:15 +08008447
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008448 MBEDTLS_SSL_DEBUG_MSG(2, ("<= calc finished"));
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01008449
8450exit:
8451#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02008452 psa_hash_abort(&cloned_op);
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +02008453 return mbedtls_md_error_from_psa(status);
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01008454#else
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02008455 mbedtls_md_free(&cloned_ctx);
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01008456 return ret;
8457#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu615bd6f2022-02-17 14:25:15 +08008458}
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008459
8460#if defined(MBEDTLS_MD_CAN_SHA256)
8461static int ssl_calc_finished_tls_sha256(
8462 mbedtls_ssl_context *ssl, unsigned char *buf, int from)
8463{
8464 unsigned char padbuf[32];
8465 return ssl_calc_finished_tls_generic(ssl,
8466#if defined(MBEDTLS_USE_PSA_CRYPTO)
8467 &ssl->handshake->fin_sha256_psa,
8468#else
8469 &ssl->handshake->fin_sha256,
8470#endif
8471 padbuf, sizeof(padbuf),
8472 buf, from);
8473}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01008474#endif /* MBEDTLS_MD_CAN_SHA256*/
Jerry Yu615bd6f2022-02-17 14:25:15 +08008475
Jerry Yub7ba49e2022-02-17 14:25:53 +08008476
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01008477#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +01008478static int ssl_calc_finished_tls_sha384(
Gilles Peskine449bd832023-01-11 14:50:10 +01008479 mbedtls_ssl_context *ssl, unsigned char *buf, int from)
Jerry Yub7ba49e2022-02-17 14:25:53 +08008480{
Jerry Yub7ba49e2022-02-17 14:25:53 +08008481 unsigned char padbuf[48];
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008482 return ssl_calc_finished_tls_generic(ssl,
Jerry Yub7ba49e2022-02-17 14:25:53 +08008483#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008484 &ssl->handshake->fin_sha384_psa,
Jerry Yub7ba49e2022-02-17 14:25:53 +08008485#else
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008486 &ssl->handshake->fin_sha384,
Jerry Yub7ba49e2022-02-17 14:25:53 +08008487#endif
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008488 padbuf, sizeof(padbuf),
8489 buf, from);
Jerry Yub7ba49e2022-02-17 14:25:53 +08008490}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01008491#endif /* MBEDTLS_MD_CAN_SHA384*/
Jerry Yub7ba49e2022-02-17 14:25:53 +08008492
Gilles Peskine449bd832023-01-11 14:50:10 +01008493void mbedtls_ssl_handshake_wrapup_free_hs_transform(mbedtls_ssl_context *ssl)
Jerry Yuaef00152022-02-17 14:27:31 +08008494{
Gilles Peskine449bd832023-01-11 14:50:10 +01008495 MBEDTLS_SSL_DEBUG_MSG(3, ("=> handshake wrapup: final free"));
Jerry Yuaef00152022-02-17 14:27:31 +08008496
8497 /*
8498 * Free our handshake params
8499 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008500 mbedtls_ssl_handshake_free(ssl);
8501 mbedtls_free(ssl->handshake);
Jerry Yuaef00152022-02-17 14:27:31 +08008502 ssl->handshake = NULL;
8503
8504 /*
Shaun Case8b0ecbc2021-12-20 21:14:10 -08008505 * Free the previous transform and switch in the current one
Jerry Yuaef00152022-02-17 14:27:31 +08008506 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008507 if (ssl->transform) {
8508 mbedtls_ssl_transform_free(ssl->transform);
8509 mbedtls_free(ssl->transform);
Jerry Yuaef00152022-02-17 14:27:31 +08008510 }
8511 ssl->transform = ssl->transform_negotiate;
8512 ssl->transform_negotiate = NULL;
8513
Gilles Peskine449bd832023-01-11 14:50:10 +01008514 MBEDTLS_SSL_DEBUG_MSG(3, ("<= handshake wrapup: final free"));
Jerry Yuaef00152022-02-17 14:27:31 +08008515}
8516
Gilles Peskine449bd832023-01-11 14:50:10 +01008517void mbedtls_ssl_handshake_wrapup(mbedtls_ssl_context *ssl)
Jerry Yu2a9fff52022-02-17 14:28:51 +08008518{
8519 int resume = ssl->handshake->resume;
8520
Gilles Peskine449bd832023-01-11 14:50:10 +01008521 MBEDTLS_SSL_DEBUG_MSG(3, ("=> handshake wrapup"));
Jerry Yu2a9fff52022-02-17 14:28:51 +08008522
8523#if defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01008524 if (ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS) {
Jerry Yu2a9fff52022-02-17 14:28:51 +08008525 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_DONE;
8526 ssl->renego_records_seen = 0;
8527 }
8528#endif
8529
8530 /*
8531 * Free the previous session and switch in the current one
8532 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008533 if (ssl->session) {
Jerry Yu2a9fff52022-02-17 14:28:51 +08008534#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
8535 /* RFC 7366 3.1: keep the EtM state */
8536 ssl->session_negotiate->encrypt_then_mac =
Gilles Peskine449bd832023-01-11 14:50:10 +01008537 ssl->session->encrypt_then_mac;
Jerry Yu2a9fff52022-02-17 14:28:51 +08008538#endif
8539
Gilles Peskine449bd832023-01-11 14:50:10 +01008540 mbedtls_ssl_session_free(ssl->session);
8541 mbedtls_free(ssl->session);
Jerry Yu2a9fff52022-02-17 14:28:51 +08008542 }
8543 ssl->session = ssl->session_negotiate;
8544 ssl->session_negotiate = NULL;
8545
8546 /*
8547 * Add cache entry
8548 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008549 if (ssl->conf->f_set_cache != NULL &&
Jerry Yu2a9fff52022-02-17 14:28:51 +08008550 ssl->session->id_len != 0 &&
Gilles Peskine449bd832023-01-11 14:50:10 +01008551 resume == 0) {
8552 if (ssl->conf->f_set_cache(ssl->conf->p_cache,
8553 ssl->session->id,
8554 ssl->session->id_len,
8555 ssl->session) != 0) {
8556 MBEDTLS_SSL_DEBUG_MSG(1, ("cache did not store session"));
8557 }
Jerry Yu2a9fff52022-02-17 14:28:51 +08008558 }
8559
8560#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01008561 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
8562 ssl->handshake->flight != NULL) {
Jerry Yu2a9fff52022-02-17 14:28:51 +08008563 /* Cancel handshake timer */
Gilles Peskine449bd832023-01-11 14:50:10 +01008564 mbedtls_ssl_set_timer(ssl, 0);
Jerry Yu2a9fff52022-02-17 14:28:51 +08008565
8566 /* Keep last flight around in case we need to resend it:
8567 * we need the handshake and transform structures for that */
Gilles Peskine449bd832023-01-11 14:50:10 +01008568 MBEDTLS_SSL_DEBUG_MSG(3, ("skip freeing handshake and transform"));
8569 } else
Jerry Yu2a9fff52022-02-17 14:28:51 +08008570#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01008571 mbedtls_ssl_handshake_wrapup_free_hs_transform(ssl);
Jerry Yu2a9fff52022-02-17 14:28:51 +08008572
Jerry Yu5ed73ff2022-10-27 13:08:42 +08008573 ssl->state = MBEDTLS_SSL_HANDSHAKE_OVER;
Jerry Yu2a9fff52022-02-17 14:28:51 +08008574
Gilles Peskine449bd832023-01-11 14:50:10 +01008575 MBEDTLS_SSL_DEBUG_MSG(3, ("<= handshake wrapup"));
Jerry Yu2a9fff52022-02-17 14:28:51 +08008576}
8577
Gilles Peskine449bd832023-01-11 14:50:10 +01008578int mbedtls_ssl_write_finished(mbedtls_ssl_context *ssl)
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008579{
Dave Rodgmanc37ad442023-11-03 23:36:06 +00008580 int ret;
8581 unsigned int hash_len;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008582
Gilles Peskine449bd832023-01-11 14:50:10 +01008583 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write finished"));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008584
Gilles Peskine449bd832023-01-11 14:50:10 +01008585 mbedtls_ssl_update_out_pointers(ssl, ssl->transform_negotiate);
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008586
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01008587 ret = ssl->handshake->calc_finished(ssl, ssl->out_msg + 4, ssl->conf->endpoint);
8588 if (ret != 0) {
8589 MBEDTLS_SSL_DEBUG_RET(1, "calc_finished", ret);
8590 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008591
8592 /*
8593 * RFC 5246 7.4.9 (Page 63) says 12 is the default length and ciphersuites
8594 * may define some other value. Currently (early 2016), no defined
8595 * ciphersuite does this (and this is unlikely to change as activity has
8596 * moved to TLS 1.3 now) so we can keep the hardcoded 12 here.
8597 */
8598 hash_len = 12;
8599
8600#if defined(MBEDTLS_SSL_RENEGOTIATION)
8601 ssl->verify_data_len = hash_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01008602 memcpy(ssl->own_verify_data, ssl->out_msg + 4, hash_len);
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008603#endif
8604
8605 ssl->out_msglen = 4 + hash_len;
8606 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
8607 ssl->out_msg[0] = MBEDTLS_SSL_HS_FINISHED;
8608
8609 /*
8610 * In case of session resuming, invert the client and server
8611 * ChangeCipherSpec messages order.
8612 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008613 if (ssl->handshake->resume != 0) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008614#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008615 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008616 ssl->state = MBEDTLS_SSL_HANDSHAKE_WRAPUP;
Gilles Peskine449bd832023-01-11 14:50:10 +01008617 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008618#endif
8619#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008620 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008621 ssl->state = MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC;
Gilles Peskine449bd832023-01-11 14:50:10 +01008622 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008623#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01008624 } else {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008625 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01008626 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008627
8628 /*
8629 * Switch to our negotiated transform and session parameters for outbound
8630 * data.
8631 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008632 MBEDTLS_SSL_DEBUG_MSG(3, ("switching to new transform spec for outbound data"));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008633
8634#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01008635 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008636 unsigned char i;
8637
8638 /* Remember current epoch settings for resending */
8639 ssl->handshake->alt_transform_out = ssl->transform_out;
Gilles Peskine449bd832023-01-11 14:50:10 +01008640 memcpy(ssl->handshake->alt_out_ctr, ssl->cur_out_ctr,
8641 sizeof(ssl->handshake->alt_out_ctr));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008642
8643 /* Set sequence_number to zero */
Gilles Peskine449bd832023-01-11 14:50:10 +01008644 memset(&ssl->cur_out_ctr[2], 0, sizeof(ssl->cur_out_ctr) - 2);
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008645
8646
8647 /* Increment epoch */
Gilles Peskine449bd832023-01-11 14:50:10 +01008648 for (i = 2; i > 0; i--) {
8649 if (++ssl->cur_out_ctr[i - 1] != 0) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008650 break;
Gilles Peskine449bd832023-01-11 14:50:10 +01008651 }
8652 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008653
8654 /* The loop goes to its end iff the counter is wrapping */
Gilles Peskine449bd832023-01-11 14:50:10 +01008655 if (i == 0) {
8656 MBEDTLS_SSL_DEBUG_MSG(1, ("DTLS epoch would wrap"));
8657 return MBEDTLS_ERR_SSL_COUNTER_WRAPPING;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008658 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008659 } else
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008660#endif /* MBEDTLS_SSL_PROTO_DTLS */
Gilles Peskine449bd832023-01-11 14:50:10 +01008661 memset(ssl->cur_out_ctr, 0, sizeof(ssl->cur_out_ctr));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008662
8663 ssl->transform_out = ssl->transform_negotiate;
8664 ssl->session_out = ssl->session_negotiate;
8665
8666#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01008667 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
8668 mbedtls_ssl_send_flight_completed(ssl);
8669 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008670#endif
8671
Gilles Peskine449bd832023-01-11 14:50:10 +01008672 if ((ret = mbedtls_ssl_write_handshake_msg(ssl)) != 0) {
8673 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_handshake_msg", ret);
8674 return ret;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008675 }
8676
8677#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01008678 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
8679 (ret = mbedtls_ssl_flight_transmit(ssl)) != 0) {
8680 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_flight_transmit", ret);
8681 return ret;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008682 }
8683#endif
8684
Gilles Peskine449bd832023-01-11 14:50:10 +01008685 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write finished"));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008686
Gilles Peskine449bd832023-01-11 14:50:10 +01008687 return 0;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008688}
8689
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008690#define SSL_MAX_HASH_LEN 12
8691
Gilles Peskine449bd832023-01-11 14:50:10 +01008692int mbedtls_ssl_parse_finished(mbedtls_ssl_context *ssl)
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008693{
8694 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
8695 unsigned int hash_len = 12;
8696 unsigned char buf[SSL_MAX_HASH_LEN];
8697
Gilles Peskine449bd832023-01-11 14:50:10 +01008698 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse finished"));
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008699
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01008700 ret = ssl->handshake->calc_finished(ssl, buf, ssl->conf->endpoint ^ 1);
8701 if (ret != 0) {
8702 MBEDTLS_SSL_DEBUG_RET(1, "calc_finished", ret);
8703 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008704
Gilles Peskine449bd832023-01-11 14:50:10 +01008705 if ((ret = mbedtls_ssl_read_record(ssl, 1)) != 0) {
8706 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_read_record", ret);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008707 goto exit;
8708 }
8709
Gilles Peskine449bd832023-01-11 14:50:10 +01008710 if (ssl->in_msgtype != MBEDTLS_SSL_MSG_HANDSHAKE) {
8711 MBEDTLS_SSL_DEBUG_MSG(1, ("bad finished message"));
8712 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8713 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008714 ret = MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
8715 goto exit;
8716 }
8717
Gilles Peskine449bd832023-01-11 14:50:10 +01008718 if (ssl->in_msg[0] != MBEDTLS_SSL_HS_FINISHED) {
8719 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8720 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008721 ret = MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
8722 goto exit;
8723 }
8724
Gilles Peskine449bd832023-01-11 14:50:10 +01008725 if (ssl->in_hslen != mbedtls_ssl_hs_hdr_len(ssl) + hash_len) {
8726 MBEDTLS_SSL_DEBUG_MSG(1, ("bad finished message"));
8727 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8728 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008729 ret = MBEDTLS_ERR_SSL_DECODE_ERROR;
8730 goto exit;
8731 }
8732
Gilles Peskine449bd832023-01-11 14:50:10 +01008733 if (mbedtls_ct_memcmp(ssl->in_msg + mbedtls_ssl_hs_hdr_len(ssl),
8734 buf, hash_len) != 0) {
8735 MBEDTLS_SSL_DEBUG_MSG(1, ("bad finished message"));
8736 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8737 MBEDTLS_SSL_ALERT_MSG_DECRYPT_ERROR);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008738 ret = MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
8739 goto exit;
8740 }
8741
8742#if defined(MBEDTLS_SSL_RENEGOTIATION)
8743 ssl->verify_data_len = hash_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01008744 memcpy(ssl->peer_verify_data, buf, hash_len);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008745#endif
8746
Gilles Peskine449bd832023-01-11 14:50:10 +01008747 if (ssl->handshake->resume != 0) {
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008748#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008749 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008750 ssl->state = MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC;
Gilles Peskine449bd832023-01-11 14:50:10 +01008751 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008752#endif
8753#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008754 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008755 ssl->state = MBEDTLS_SSL_HANDSHAKE_WRAPUP;
Gilles Peskine449bd832023-01-11 14:50:10 +01008756 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008757#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01008758 } else {
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008759 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01008760 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008761
8762#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01008763 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
8764 mbedtls_ssl_recv_flight_completed(ssl);
8765 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008766#endif
8767
Gilles Peskine449bd832023-01-11 14:50:10 +01008768 MBEDTLS_SSL_DEBUG_MSG(2, ("<= parse finished"));
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008769
8770exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01008771 mbedtls_platform_zeroize(buf, hash_len);
8772 return ret;
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008773}
8774
Jerry Yu392112c2022-02-17 14:34:10 +08008775#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
8776/*
8777 * Helper to get TLS 1.2 PRF from ciphersuite
8778 * (Duplicates bits of logic from ssl_set_handshake_prfs().)
8779 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008780static tls_prf_fn ssl_tls12prf_from_cs(int ciphersuite_id)
Jerry Yu392112c2022-02-17 14:34:10 +08008781{
Jerry Yu392112c2022-02-17 14:34:10 +08008782 const mbedtls_ssl_ciphersuite_t * const ciphersuite_info =
Gilles Peskine449bd832023-01-11 14:50:10 +01008783 mbedtls_ssl_ciphersuite_from_id(ciphersuite_id);
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01008784#if defined(MBEDTLS_MD_CAN_SHA384)
Gilles Peskine449bd832023-01-11 14:50:10 +01008785 if (ciphersuite_info != NULL && ciphersuite_info->mac == MBEDTLS_MD_SHA384) {
8786 return tls_prf_sha384;
8787 } else
Jerry Yu392112c2022-02-17 14:34:10 +08008788#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01008789#if defined(MBEDTLS_MD_CAN_SHA256)
Andrzej Kurek894edde2022-09-29 06:31:14 -04008790 {
Gilles Peskine449bd832023-01-11 14:50:10 +01008791 if (ciphersuite_info != NULL && ciphersuite_info->mac == MBEDTLS_MD_SHA256) {
8792 return tls_prf_sha256;
8793 }
Andrzej Kurek894edde2022-09-29 06:31:14 -04008794 }
8795#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01008796#if !defined(MBEDTLS_MD_CAN_SHA384) && \
8797 !defined(MBEDTLS_MD_CAN_SHA256)
Andrzej Kurek894edde2022-09-29 06:31:14 -04008798 (void) ciphersuite_info;
8799#endif
Andrzej Kurekeabeb302022-10-17 07:52:51 -04008800
Gilles Peskine449bd832023-01-11 14:50:10 +01008801 return NULL;
Jerry Yu392112c2022-02-17 14:34:10 +08008802}
8803#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
Jerry Yue93ffcd2022-02-17 14:37:06 +08008804
Gilles Peskine449bd832023-01-11 14:50:10 +01008805static mbedtls_tls_prf_types tls_prf_get_type(mbedtls_ssl_tls_prf_cb *tls_prf)
Jerry Yue93ffcd2022-02-17 14:37:06 +08008806{
8807 ((void) tls_prf);
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01008808#if defined(MBEDTLS_MD_CAN_SHA384)
Gilles Peskine449bd832023-01-11 14:50:10 +01008809 if (tls_prf == tls_prf_sha384) {
8810 return MBEDTLS_SSL_TLS_PRF_SHA384;
8811 } else
Jerry Yue93ffcd2022-02-17 14:37:06 +08008812#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01008813#if defined(MBEDTLS_MD_CAN_SHA256)
Gilles Peskine449bd832023-01-11 14:50:10 +01008814 if (tls_prf == tls_prf_sha256) {
8815 return MBEDTLS_SSL_TLS_PRF_SHA256;
8816 } else
Jerry Yue93ffcd2022-02-17 14:37:06 +08008817#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01008818 return MBEDTLS_SSL_TLS_PRF_NONE;
Jerry Yue93ffcd2022-02-17 14:37:06 +08008819}
8820
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008821/*
8822 * Populate a transform structure with session keys and all the other
8823 * necessary information.
8824 *
8825 * Parameters:
8826 * - [in/out]: transform: structure to populate
8827 * [in] must be just initialised with mbedtls_ssl_transform_init()
8828 * [out] fully populated, ready for use by mbedtls_ssl_{en,de}crypt_buf()
8829 * - [in] ciphersuite
8830 * - [in] master
8831 * - [in] encrypt_then_mac
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008832 * - [in] tls_prf: pointer to PRF to use for key derivation
8833 * - [in] randbytes: buffer holding ServerHello.random + ClientHello.random
Glenn Strauss07c64162022-03-14 12:34:51 -04008834 * - [in] tls_version: TLS version
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008835 * - [in] endpoint: client or server
8836 * - [in] ssl: used for:
8837 * - ssl->conf->{f,p}_export_keys
8838 * [in] optionally used for:
8839 * - MBEDTLS_DEBUG_C: ssl->conf->{f,p}_dbg
8840 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02008841MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01008842static int ssl_tls12_populate_transform(mbedtls_ssl_transform *transform,
8843 int ciphersuite,
8844 const unsigned char master[48],
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008845#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01008846 int encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008847#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01008848 ssl_tls_prf_t tls_prf,
8849 const unsigned char randbytes[64],
8850 mbedtls_ssl_protocol_version tls_version,
8851 unsigned endpoint,
8852 const mbedtls_ssl_context *ssl)
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008853{
8854 int ret = 0;
8855 unsigned char keyblk[256];
8856 unsigned char *key1;
8857 unsigned char *key2;
8858 unsigned char *mac_enc;
8859 unsigned char *mac_dec;
8860 size_t mac_key_len = 0;
8861 size_t iv_copy_len;
8862 size_t keylen;
8863 const mbedtls_ssl_ciphersuite_t *ciphersuite_info;
Neil Armstrong7fea33e2022-04-01 15:40:25 +02008864 mbedtls_ssl_mode_t ssl_mode;
Neil Armstronge4512952022-03-08 09:08:22 +01008865#if !defined(MBEDTLS_USE_PSA_CRYPTO)
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008866 const mbedtls_cipher_info_t *cipher_info;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008867 const mbedtls_md_info_t *md_info;
Neil Armstronge4512952022-03-08 09:08:22 +01008868#endif /* !MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008869
8870#if defined(MBEDTLS_USE_PSA_CRYPTO)
8871 psa_key_type_t key_type;
8872 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
8873 psa_algorithm_t alg;
Neil Armstronge4512952022-03-08 09:08:22 +01008874 psa_algorithm_t mac_alg = 0;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008875 size_t key_bits;
8876 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
8877#endif
8878
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008879 /*
8880 * Some data just needs copying into the structure
8881 */
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008882#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008883 transform->encrypt_then_mac = encrypt_then_mac;
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008884#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Glenn Strauss07c64162022-03-14 12:34:51 -04008885 transform->tls_version = tls_version;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008886
8887#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01008888 memcpy(transform->randbytes, randbytes, sizeof(transform->randbytes));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008889#endif
8890
8891#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01008892 if (tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008893 /* At the moment, we keep TLS <= 1.2 and TLS 1.3 transform
8894 * generation separate. This should never happen. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008895 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008896 }
8897#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
8898
8899 /*
8900 * Get various info structures
8901 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008902 ciphersuite_info = mbedtls_ssl_ciphersuite_from_id(ciphersuite);
8903 if (ciphersuite_info == NULL) {
8904 MBEDTLS_SSL_DEBUG_MSG(1, ("ciphersuite info for %d not found",
8905 ciphersuite));
8906 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008907 }
8908
Neil Armstrongab555e02022-04-04 11:07:59 +02008909 ssl_mode = mbedtls_ssl_get_mode_from_ciphersuite(
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008910#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01008911 encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008912#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01008913 ciphersuite_info);
Neil Armstrong7fea33e2022-04-01 15:40:25 +02008914
Gilles Peskine449bd832023-01-11 14:50:10 +01008915 if (ssl_mode == MBEDTLS_SSL_MODE_AEAD) {
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008916 transform->taglen =
8917 ciphersuite_info->flags & MBEDTLS_CIPHERSUITE_SHORT_TAG ? 8 : 16;
Gilles Peskine449bd832023-01-11 14:50:10 +01008918 }
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008919
8920#if defined(MBEDTLS_USE_PSA_CRYPTO)
Dave Rodgman2eab4622023-10-05 13:30:37 +01008921 if ((status = mbedtls_ssl_cipher_to_psa((mbedtls_cipher_type_t) ciphersuite_info->cipher,
Gilles Peskine449bd832023-01-11 14:50:10 +01008922 transform->taglen,
8923 &alg,
8924 &key_type,
8925 &key_bits)) != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008926 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01008927 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_cipher_to_psa", ret);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008928 goto end;
8929 }
8930#else
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01008931 cipher_info = mbedtls_cipher_info_from_type((mbedtls_cipher_type_t) ciphersuite_info->cipher);
Gilles Peskine449bd832023-01-11 14:50:10 +01008932 if (cipher_info == NULL) {
8933 MBEDTLS_SSL_DEBUG_MSG(1, ("cipher info for %u not found",
8934 ciphersuite_info->cipher));
8935 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008936 }
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008937#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008938
Neil Armstronge4512952022-03-08 09:08:22 +01008939#if defined(MBEDTLS_USE_PSA_CRYPTO)
Dave Rodgman2eab4622023-10-05 13:30:37 +01008940 mac_alg = mbedtls_md_psa_alg_from_type((mbedtls_md_type_t) ciphersuite_info->mac);
Gilles Peskine449bd832023-01-11 14:50:10 +01008941 if (mac_alg == 0) {
Manuel Pégourié-Gonnard2d6d9932023-03-28 11:38:08 +02008942 MBEDTLS_SSL_DEBUG_MSG(1, ("mbedtls_md_psa_alg_from_type for %u not found",
Gilles Peskine449bd832023-01-11 14:50:10 +01008943 (unsigned) ciphersuite_info->mac));
8944 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Neil Armstronge4512952022-03-08 09:08:22 +01008945 }
8946#else
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01008947 md_info = mbedtls_md_info_from_type((mbedtls_md_type_t) ciphersuite_info->mac);
Gilles Peskine449bd832023-01-11 14:50:10 +01008948 if (md_info == NULL) {
8949 MBEDTLS_SSL_DEBUG_MSG(1, ("mbedtls_md info for %u not found",
8950 (unsigned) ciphersuite_info->mac));
8951 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008952 }
Neil Armstronge4512952022-03-08 09:08:22 +01008953#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008954
8955#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
8956 /* Copy own and peer's CID if the use of the CID
8957 * extension has been negotiated. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008958 if (ssl->handshake->cid_in_use == MBEDTLS_SSL_CID_ENABLED) {
8959 MBEDTLS_SSL_DEBUG_MSG(3, ("Copy CIDs into SSL transform"));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008960
8961 transform->in_cid_len = ssl->own_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01008962 memcpy(transform->in_cid, ssl->own_cid, ssl->own_cid_len);
8963 MBEDTLS_SSL_DEBUG_BUF(3, "Incoming CID", transform->in_cid,
8964 transform->in_cid_len);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008965
8966 transform->out_cid_len = ssl->handshake->peer_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01008967 memcpy(transform->out_cid, ssl->handshake->peer_cid,
8968 ssl->handshake->peer_cid_len);
8969 MBEDTLS_SSL_DEBUG_BUF(3, "Outgoing CID", transform->out_cid,
8970 transform->out_cid_len);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008971 }
8972#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
8973
8974 /*
8975 * Compute key block using the PRF
8976 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008977 ret = tls_prf(master, 48, "key expansion", randbytes, 64, keyblk, 256);
8978 if (ret != 0) {
8979 MBEDTLS_SSL_DEBUG_RET(1, "prf", ret);
8980 return ret;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008981 }
8982
Gilles Peskine449bd832023-01-11 14:50:10 +01008983 MBEDTLS_SSL_DEBUG_MSG(3, ("ciphersuite = %s",
8984 mbedtls_ssl_get_ciphersuite_name(ciphersuite)));
8985 MBEDTLS_SSL_DEBUG_BUF(3, "master secret", master, 48);
8986 MBEDTLS_SSL_DEBUG_BUF(4, "random bytes", randbytes, 64);
8987 MBEDTLS_SSL_DEBUG_BUF(4, "key block", keyblk, 256);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008988
8989 /*
8990 * Determine the appropriate key, IV and MAC length.
8991 */
8992
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008993#if defined(MBEDTLS_USE_PSA_CRYPTO)
8994 keylen = PSA_BITS_TO_BYTES(key_bits);
8995#else
Gilles Peskine449bd832023-01-11 14:50:10 +01008996 keylen = mbedtls_cipher_info_get_key_bitlen(cipher_info) / 8;
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008997#endif
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008998
Valerio Settie5707042023-10-11 11:54:42 +02008999#if defined(MBEDTLS_SSL_HAVE_AEAD)
Gilles Peskine449bd832023-01-11 14:50:10 +01009000 if (ssl_mode == MBEDTLS_SSL_MODE_AEAD) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009001 size_t explicit_ivlen;
9002
9003 transform->maclen = 0;
9004 mac_key_len = 0;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009005
9006 /* All modes haves 96-bit IVs, but the length of the static parts vary
9007 * with mode and version:
9008 * - For GCM and CCM in TLS 1.2, there's a static IV of 4 Bytes
9009 * (to be concatenated with a dynamically chosen IV of 8 Bytes)
9010 * - For ChaChaPoly in TLS 1.2, and all modes in TLS 1.3, there's
9011 * a static IV of 12 Bytes (to be XOR'ed with the 8 Byte record
9012 * sequence number).
9013 */
9014 transform->ivlen = 12;
David Horstmann3b2276a2022-10-06 14:49:08 +01009015
9016 int is_chachapoly = 0;
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02009017#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01009018 is_chachapoly = (key_type == PSA_KEY_TYPE_CHACHA20);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02009019#else
Gilles Peskine449bd832023-01-11 14:50:10 +01009020 is_chachapoly = (mbedtls_cipher_info_get_mode(cipher_info)
9021 == MBEDTLS_MODE_CHACHAPOLY);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02009022#endif /* MBEDTLS_USE_PSA_CRYPTO */
David Horstmann3b2276a2022-10-06 14:49:08 +01009023
Gilles Peskine449bd832023-01-11 14:50:10 +01009024 if (is_chachapoly) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009025 transform->fixed_ivlen = 12;
Gilles Peskine449bd832023-01-11 14:50:10 +01009026 } else {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009027 transform->fixed_ivlen = 4;
Gilles Peskine449bd832023-01-11 14:50:10 +01009028 }
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009029
9030 /* Minimum length of encrypted record */
9031 explicit_ivlen = transform->ivlen - transform->fixed_ivlen;
9032 transform->minlen = explicit_ivlen + transform->taglen;
Gilles Peskine449bd832023-01-11 14:50:10 +01009033 } else
Valerio Settie5707042023-10-11 11:54:42 +02009034#endif /* MBEDTLS_SSL_HAVE_AEAD */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009035#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01009036 if (ssl_mode == MBEDTLS_SSL_MODE_STREAM ||
Neil Armstrong7fea33e2022-04-01 15:40:25 +02009037 ssl_mode == MBEDTLS_SSL_MODE_CBC ||
Gilles Peskine449bd832023-01-11 14:50:10 +01009038 ssl_mode == MBEDTLS_SSL_MODE_CBC_ETM) {
Neil Armstronge4512952022-03-08 09:08:22 +01009039#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01009040 size_t block_size = PSA_BLOCK_CIPHER_BLOCK_LENGTH(key_type);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02009041#else
Dave Rodgman85a88132023-06-24 11:41:50 +01009042 size_t block_size = mbedtls_cipher_info_get_block_size(cipher_info);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02009043#endif /* MBEDTLS_USE_PSA_CRYPTO */
9044
9045#if defined(MBEDTLS_USE_PSA_CRYPTO)
Neil Armstronge4512952022-03-08 09:08:22 +01009046 /* Get MAC length */
9047 mac_key_len = PSA_HASH_LENGTH(mac_alg);
9048#else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009049 /* Initialize HMAC contexts */
Gilles Peskine449bd832023-01-11 14:50:10 +01009050 if ((ret = mbedtls_md_setup(&transform->md_ctx_enc, md_info, 1)) != 0 ||
9051 (ret = mbedtls_md_setup(&transform->md_ctx_dec, md_info, 1)) != 0) {
9052 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_setup", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009053 goto end;
9054 }
9055
9056 /* Get MAC length */
Gilles Peskine449bd832023-01-11 14:50:10 +01009057 mac_key_len = mbedtls_md_get_size(md_info);
Neil Armstronge4512952022-03-08 09:08:22 +01009058#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009059 transform->maclen = mac_key_len;
9060
9061 /* IV length */
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02009062#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01009063 transform->ivlen = PSA_CIPHER_IV_LENGTH(key_type, alg);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02009064#else
Dave Rodgmanbb521fd2023-06-24 11:21:25 +01009065 transform->ivlen = mbedtls_cipher_info_get_iv_size(cipher_info);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02009066#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009067
9068 /* Minimum length */
Gilles Peskine449bd832023-01-11 14:50:10 +01009069 if (ssl_mode == MBEDTLS_SSL_MODE_STREAM) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009070 transform->minlen = transform->maclen;
Gilles Peskine449bd832023-01-11 14:50:10 +01009071 } else {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009072 /*
9073 * GenericBlockCipher:
9074 * 1. if EtM is in use: one block plus MAC
9075 * otherwise: * first multiple of blocklen greater than maclen
9076 * 2. IV
9077 */
9078#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01009079 if (ssl_mode == MBEDTLS_SSL_MODE_CBC_ETM) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009080 transform->minlen = transform->maclen
Gilles Peskine449bd832023-01-11 14:50:10 +01009081 + block_size;
9082 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009083#endif
9084 {
9085 transform->minlen = transform->maclen
Gilles Peskine449bd832023-01-11 14:50:10 +01009086 + block_size
9087 - transform->maclen % block_size;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009088 }
9089
Gilles Peskine449bd832023-01-11 14:50:10 +01009090 if (tls_version == MBEDTLS_SSL_VERSION_TLS1_2) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009091 transform->minlen += transform->ivlen;
Gilles Peskine449bd832023-01-11 14:50:10 +01009092 } else {
9093 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009094 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
9095 goto end;
9096 }
9097 }
Gilles Peskine449bd832023-01-11 14:50:10 +01009098 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009099#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
9100 {
Gilles Peskine449bd832023-01-11 14:50:10 +01009101 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
9102 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009103 }
9104
Gilles Peskine449bd832023-01-11 14:50:10 +01009105 MBEDTLS_SSL_DEBUG_MSG(3, ("keylen: %u, minlen: %u, ivlen: %u, maclen: %u",
9106 (unsigned) keylen,
9107 (unsigned) transform->minlen,
9108 (unsigned) transform->ivlen,
9109 (unsigned) transform->maclen));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009110
9111 /*
9112 * Finally setup the cipher contexts, IVs and MAC secrets.
9113 */
9114#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01009115 if (endpoint == MBEDTLS_SSL_IS_CLIENT) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009116 key1 = keyblk + mac_key_len * 2;
9117 key2 = keyblk + mac_key_len * 2 + keylen;
9118
9119 mac_enc = keyblk;
9120 mac_dec = keyblk + mac_key_len;
9121
Gilles Peskine449bd832023-01-11 14:50:10 +01009122 iv_copy_len = (transform->fixed_ivlen) ?
9123 transform->fixed_ivlen : transform->ivlen;
9124 memcpy(transform->iv_enc, key2 + keylen, iv_copy_len);
9125 memcpy(transform->iv_dec, key2 + keylen + iv_copy_len,
9126 iv_copy_len);
9127 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009128#endif /* MBEDTLS_SSL_CLI_C */
9129#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01009130 if (endpoint == MBEDTLS_SSL_IS_SERVER) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009131 key1 = keyblk + mac_key_len * 2 + keylen;
9132 key2 = keyblk + mac_key_len * 2;
9133
9134 mac_enc = keyblk + mac_key_len;
9135 mac_dec = keyblk;
9136
Gilles Peskine449bd832023-01-11 14:50:10 +01009137 iv_copy_len = (transform->fixed_ivlen) ?
9138 transform->fixed_ivlen : transform->ivlen;
9139 memcpy(transform->iv_dec, key1 + keylen, iv_copy_len);
9140 memcpy(transform->iv_enc, key1 + keylen + iv_copy_len,
9141 iv_copy_len);
9142 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009143#endif /* MBEDTLS_SSL_SRV_C */
9144 {
Gilles Peskine449bd832023-01-11 14:50:10 +01009145 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009146 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
9147 goto end;
9148 }
9149
Paul Elliott4fb19552023-10-18 12:15:30 +01009150 if (ssl->f_export_keys != NULL) {
Gilles Peskine449bd832023-01-11 14:50:10 +01009151 ssl->f_export_keys(ssl->p_export_keys,
9152 MBEDTLS_SSL_KEY_EXPORT_TLS12_MASTER_SECRET,
9153 master, 48,
9154 randbytes + 32,
9155 randbytes,
9156 tls_prf_get_type(tls_prf));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009157 }
9158
9159#if defined(MBEDTLS_USE_PSA_CRYPTO)
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009160 transform->psa_alg = alg;
9161
Gilles Peskine449bd832023-01-11 14:50:10 +01009162 if (alg != MBEDTLS_SSL_NULL_CIPHER) {
9163 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_ENCRYPT);
9164 psa_set_key_algorithm(&attributes, alg);
9165 psa_set_key_type(&attributes, key_type);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009166
Gilles Peskine449bd832023-01-11 14:50:10 +01009167 if ((status = psa_import_key(&attributes,
9168 key1,
9169 PSA_BITS_TO_BYTES(key_bits),
9170 &transform->psa_key_enc)) != PSA_SUCCESS) {
9171 MBEDTLS_SSL_DEBUG_RET(3, "psa_import_key", (int) status);
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05009172 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01009173 MBEDTLS_SSL_DEBUG_RET(1, "psa_import_key", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009174 goto end;
9175 }
9176
Gilles Peskine449bd832023-01-11 14:50:10 +01009177 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_DECRYPT);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009178
Gilles Peskine449bd832023-01-11 14:50:10 +01009179 if ((status = psa_import_key(&attributes,
9180 key2,
9181 PSA_BITS_TO_BYTES(key_bits),
9182 &transform->psa_key_dec)) != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05009183 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01009184 MBEDTLS_SSL_DEBUG_RET(1, "psa_import_key", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009185 goto end;
9186 }
9187 }
9188#else
Gilles Peskine449bd832023-01-11 14:50:10 +01009189 if ((ret = mbedtls_cipher_setup(&transform->cipher_ctx_enc,
9190 cipher_info)) != 0) {
9191 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_setup", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009192 goto end;
9193 }
9194
Gilles Peskine449bd832023-01-11 14:50:10 +01009195 if ((ret = mbedtls_cipher_setup(&transform->cipher_ctx_dec,
9196 cipher_info)) != 0) {
9197 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_setup", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009198 goto end;
9199 }
9200
Gilles Peskine449bd832023-01-11 14:50:10 +01009201 if ((ret = mbedtls_cipher_setkey(&transform->cipher_ctx_enc, key1,
9202 (int) mbedtls_cipher_info_get_key_bitlen(cipher_info),
9203 MBEDTLS_ENCRYPT)) != 0) {
9204 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_setkey", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009205 goto end;
9206 }
9207
Gilles Peskine449bd832023-01-11 14:50:10 +01009208 if ((ret = mbedtls_cipher_setkey(&transform->cipher_ctx_dec, key2,
9209 (int) mbedtls_cipher_info_get_key_bitlen(cipher_info),
9210 MBEDTLS_DECRYPT)) != 0) {
9211 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_setkey", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009212 goto end;
9213 }
9214
9215#if defined(MBEDTLS_CIPHER_MODE_CBC)
Gilles Peskine449bd832023-01-11 14:50:10 +01009216 if (mbedtls_cipher_info_get_mode(cipher_info) == MBEDTLS_MODE_CBC) {
9217 if ((ret = mbedtls_cipher_set_padding_mode(&transform->cipher_ctx_enc,
9218 MBEDTLS_PADDING_NONE)) != 0) {
9219 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_set_padding_mode", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009220 goto end;
9221 }
9222
Gilles Peskine449bd832023-01-11 14:50:10 +01009223 if ((ret = mbedtls_cipher_set_padding_mode(&transform->cipher_ctx_dec,
9224 MBEDTLS_PADDING_NONE)) != 0) {
9225 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_set_padding_mode", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009226 goto end;
9227 }
9228 }
9229#endif /* MBEDTLS_CIPHER_MODE_CBC */
9230#endif /* MBEDTLS_USE_PSA_CRYPTO */
9231
Neil Armstrong29c0c042022-03-17 17:47:28 +01009232#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
9233 /* For HMAC-based ciphersuites, initialize the HMAC transforms.
9234 For AEAD-based ciphersuites, there is nothing to do here. */
Gilles Peskine449bd832023-01-11 14:50:10 +01009235 if (mac_key_len != 0) {
Neil Armstrong29c0c042022-03-17 17:47:28 +01009236#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01009237 transform->psa_mac_alg = PSA_ALG_HMAC(mac_alg);
Neil Armstrong29c0c042022-03-17 17:47:28 +01009238
Gilles Peskine449bd832023-01-11 14:50:10 +01009239 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_SIGN_MESSAGE);
9240 psa_set_key_algorithm(&attributes, PSA_ALG_HMAC(mac_alg));
9241 psa_set_key_type(&attributes, PSA_KEY_TYPE_HMAC);
Neil Armstrong29c0c042022-03-17 17:47:28 +01009242
Gilles Peskine449bd832023-01-11 14:50:10 +01009243 if ((status = psa_import_key(&attributes,
9244 mac_enc, mac_key_len,
9245 &transform->psa_mac_enc)) != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05009246 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01009247 MBEDTLS_SSL_DEBUG_RET(1, "psa_import_mac_key", ret);
Neil Armstrong29c0c042022-03-17 17:47:28 +01009248 goto end;
9249 }
9250
Gilles Peskine449bd832023-01-11 14:50:10 +01009251 if ((transform->psa_alg == MBEDTLS_SSL_NULL_CIPHER) ||
9252 ((transform->psa_alg == PSA_ALG_CBC_NO_PADDING)
Andrzej Kurek8c95ac42022-08-17 16:17:00 -04009253#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01009254 && (transform->encrypt_then_mac == MBEDTLS_SSL_ETM_DISABLED)
Andrzej Kurek8c95ac42022-08-17 16:17:00 -04009255#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01009256 )) {
Neil Armstrong29c0c042022-03-17 17:47:28 +01009257 /* mbedtls_ct_hmac() requires the key to be exportable */
Gilles Peskine449bd832023-01-11 14:50:10 +01009258 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_EXPORT |
9259 PSA_KEY_USAGE_VERIFY_HASH);
9260 } else {
9261 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_VERIFY_HASH);
9262 }
Neil Armstrong29c0c042022-03-17 17:47:28 +01009263
Gilles Peskine449bd832023-01-11 14:50:10 +01009264 if ((status = psa_import_key(&attributes,
9265 mac_dec, mac_key_len,
9266 &transform->psa_mac_dec)) != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05009267 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01009268 MBEDTLS_SSL_DEBUG_RET(1, "psa_import_mac_key", ret);
Neil Armstrong29c0c042022-03-17 17:47:28 +01009269 goto end;
9270 }
9271#else
Gilles Peskine449bd832023-01-11 14:50:10 +01009272 ret = mbedtls_md_hmac_starts(&transform->md_ctx_enc, mac_enc, mac_key_len);
9273 if (ret != 0) {
Neil Armstrong29c0c042022-03-17 17:47:28 +01009274 goto end;
Gilles Peskine449bd832023-01-11 14:50:10 +01009275 }
9276 ret = mbedtls_md_hmac_starts(&transform->md_ctx_dec, mac_dec, mac_key_len);
9277 if (ret != 0) {
Neil Armstrong29c0c042022-03-17 17:47:28 +01009278 goto end;
Gilles Peskine449bd832023-01-11 14:50:10 +01009279 }
Neil Armstrong29c0c042022-03-17 17:47:28 +01009280#endif /* MBEDTLS_USE_PSA_CRYPTO */
9281 }
9282#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
9283
9284 ((void) mac_dec);
9285 ((void) mac_enc);
9286
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009287end:
Gilles Peskine449bd832023-01-11 14:50:10 +01009288 mbedtls_platform_zeroize(keyblk, sizeof(keyblk));
9289 return ret;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009290}
9291
Valerio Settia08b1a42022-11-17 15:10:02 +01009292#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED) && \
9293 defined(MBEDTLS_USE_PSA_CRYPTO)
Valerio Setti6b3dab02022-11-17 17:14:54 +01009294int mbedtls_psa_ecjpake_read_round(
Gilles Peskine449bd832023-01-11 14:50:10 +01009295 psa_pake_operation_t *pake_ctx,
9296 const unsigned char *buf,
9297 size_t len, mbedtls_ecjpake_rounds_t round)
Valerio Settia08b1a42022-11-17 15:10:02 +01009298{
9299 psa_status_t status;
9300 size_t input_offset = 0;
Valerio Setti819de862022-11-17 18:05:19 +01009301 /*
Valerio Setti6b3dab02022-11-17 17:14:54 +01009302 * At round one repeat the KEY_SHARE, ZK_PUBLIC & ZF_PROOF twice
9303 * At round two perform a single cycle
9304 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009305 unsigned int remaining_steps = (round == MBEDTLS_ECJPAKE_ROUND_ONE) ? 2 : 1;
Valerio Settia08b1a42022-11-17 15:10:02 +01009306
Gilles Peskine449bd832023-01-11 14:50:10 +01009307 for (; remaining_steps > 0; remaining_steps--) {
9308 for (psa_pake_step_t step = PSA_PAKE_STEP_KEY_SHARE;
Valerio Settia08b1a42022-11-17 15:10:02 +01009309 step <= PSA_PAKE_STEP_ZK_PROOF;
Gilles Peskine449bd832023-01-11 14:50:10 +01009310 ++step) {
Valerio Settia08b1a42022-11-17 15:10:02 +01009311 /* Length is stored at the first byte */
9312 size_t length = buf[input_offset];
9313 input_offset += 1;
9314
Gilles Peskine449bd832023-01-11 14:50:10 +01009315 if (input_offset + length > len) {
Valerio Settia08b1a42022-11-17 15:10:02 +01009316 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
9317 }
9318
Gilles Peskine449bd832023-01-11 14:50:10 +01009319 status = psa_pake_input(pake_ctx, step,
9320 buf + input_offset, length);
9321 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05009322 return PSA_TO_MBEDTLS_ERR(status);
Valerio Settia08b1a42022-11-17 15:10:02 +01009323 }
9324
9325 input_offset += length;
9326 }
9327 }
9328
Gilles Peskine449bd832023-01-11 14:50:10 +01009329 if (input_offset != len) {
Valerio Setti61ea17d2022-11-18 12:11:00 +01009330 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Gilles Peskine449bd832023-01-11 14:50:10 +01009331 }
Valerio Setti30ebe112022-11-17 16:23:34 +01009332
Gilles Peskine449bd832023-01-11 14:50:10 +01009333 return 0;
Valerio Settia08b1a42022-11-17 15:10:02 +01009334}
9335
Valerio Setti6b3dab02022-11-17 17:14:54 +01009336int mbedtls_psa_ecjpake_write_round(
Gilles Peskine449bd832023-01-11 14:50:10 +01009337 psa_pake_operation_t *pake_ctx,
9338 unsigned char *buf,
9339 size_t len, size_t *olen,
9340 mbedtls_ecjpake_rounds_t round)
Valerio Settia08b1a42022-11-17 15:10:02 +01009341{
9342 psa_status_t status;
9343 size_t output_offset = 0;
9344 size_t output_len;
Valerio Setti819de862022-11-17 18:05:19 +01009345 /*
Valerio Setti6b3dab02022-11-17 17:14:54 +01009346 * At round one repeat the KEY_SHARE, ZK_PUBLIC & ZF_PROOF twice
9347 * At round two perform a single cycle
9348 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009349 unsigned int remaining_steps = (round == MBEDTLS_ECJPAKE_ROUND_ONE) ? 2 : 1;
Valerio Settia08b1a42022-11-17 15:10:02 +01009350
Gilles Peskine449bd832023-01-11 14:50:10 +01009351 for (; remaining_steps > 0; remaining_steps--) {
9352 for (psa_pake_step_t step = PSA_PAKE_STEP_KEY_SHARE;
9353 step <= PSA_PAKE_STEP_ZK_PROOF;
9354 ++step) {
Valerio Setti79f6b6b2022-11-21 14:17:03 +01009355 /*
Valerio Settid4a9b1a2022-11-22 11:11:10 +01009356 * For each step, prepend 1 byte with the length of the data as
9357 * given by psa_pake_output().
Valerio Setti79f6b6b2022-11-21 14:17:03 +01009358 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009359 status = psa_pake_output(pake_ctx, step,
9360 buf + output_offset + 1,
9361 len - output_offset - 1,
9362 &output_len);
9363 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05009364 return PSA_TO_MBEDTLS_ERR(status);
Valerio Settia08b1a42022-11-17 15:10:02 +01009365 }
9366
Valerio Setti99d88c12022-11-22 16:03:43 +01009367 *(buf + output_offset) = (uint8_t) output_len;
Valerio Setti79f6b6b2022-11-21 14:17:03 +01009368
9369 output_offset += output_len + 1;
Valerio Settia08b1a42022-11-17 15:10:02 +01009370 }
9371 }
9372
9373 *olen = output_offset;
9374
Gilles Peskine449bd832023-01-11 14:50:10 +01009375 return 0;
Valerio Settia08b1a42022-11-17 15:10:02 +01009376}
Valerio Settia08b1a42022-11-17 15:10:02 +01009377#endif //MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED && MBEDTLS_USE_PSA_CRYPTO
9378
Jerry Yuee40f9d2022-02-17 14:55:16 +08009379#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01009380int mbedtls_ssl_get_key_exchange_md_tls1_2(mbedtls_ssl_context *ssl,
9381 unsigned char *hash, size_t *hashlen,
9382 unsigned char *data, size_t data_len,
9383 mbedtls_md_type_t md_alg)
Jerry Yuee40f9d2022-02-17 14:55:16 +08009384{
9385 psa_status_t status;
9386 psa_hash_operation_t hash_operation = PSA_HASH_OPERATION_INIT;
Manuel Pégourié-Gonnard2d6d9932023-03-28 11:38:08 +02009387 psa_algorithm_t hash_alg = mbedtls_md_psa_alg_from_type(md_alg);
Jerry Yuee40f9d2022-02-17 14:55:16 +08009388
Gilles Peskine449bd832023-01-11 14:50:10 +01009389 MBEDTLS_SSL_DEBUG_MSG(3, ("Perform PSA-based computation of digest of ServerKeyExchange"));
Jerry Yuee40f9d2022-02-17 14:55:16 +08009390
Gilles Peskine449bd832023-01-11 14:50:10 +01009391 if ((status = psa_hash_setup(&hash_operation,
9392 hash_alg)) != PSA_SUCCESS) {
9393 MBEDTLS_SSL_DEBUG_RET(1, "psa_hash_setup", status);
Jerry Yuee40f9d2022-02-17 14:55:16 +08009394 goto exit;
9395 }
9396
Gilles Peskine449bd832023-01-11 14:50:10 +01009397 if ((status = psa_hash_update(&hash_operation, ssl->handshake->randbytes,
9398 64)) != PSA_SUCCESS) {
9399 MBEDTLS_SSL_DEBUG_RET(1, "psa_hash_update", status);
Jerry Yuee40f9d2022-02-17 14:55:16 +08009400 goto exit;
9401 }
9402
Gilles Peskine449bd832023-01-11 14:50:10 +01009403 if ((status = psa_hash_update(&hash_operation,
9404 data, data_len)) != PSA_SUCCESS) {
9405 MBEDTLS_SSL_DEBUG_RET(1, "psa_hash_update", status);
Jerry Yuee40f9d2022-02-17 14:55:16 +08009406 goto exit;
9407 }
9408
Gilles Peskine449bd832023-01-11 14:50:10 +01009409 if ((status = psa_hash_finish(&hash_operation, hash, PSA_HASH_MAX_SIZE,
9410 hashlen)) != PSA_SUCCESS) {
9411 MBEDTLS_SSL_DEBUG_RET(1, "psa_hash_finish", status);
9412 goto exit;
Jerry Yuee40f9d2022-02-17 14:55:16 +08009413 }
9414
9415exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01009416 if (status != PSA_SUCCESS) {
9417 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
9418 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR);
9419 switch (status) {
Jerry Yuee40f9d2022-02-17 14:55:16 +08009420 case PSA_ERROR_NOT_SUPPORTED:
Gilles Peskine449bd832023-01-11 14:50:10 +01009421 return MBEDTLS_ERR_MD_FEATURE_UNAVAILABLE;
Jerry Yuee40f9d2022-02-17 14:55:16 +08009422 case PSA_ERROR_BAD_STATE: /* Intentional fallthrough */
9423 case PSA_ERROR_BUFFER_TOO_SMALL:
Gilles Peskine449bd832023-01-11 14:50:10 +01009424 return MBEDTLS_ERR_MD_BAD_INPUT_DATA;
Jerry Yuee40f9d2022-02-17 14:55:16 +08009425 case PSA_ERROR_INSUFFICIENT_MEMORY:
Gilles Peskine449bd832023-01-11 14:50:10 +01009426 return MBEDTLS_ERR_MD_ALLOC_FAILED;
Jerry Yuee40f9d2022-02-17 14:55:16 +08009427 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01009428 return MBEDTLS_ERR_PLATFORM_HW_ACCEL_FAILED;
Jerry Yuee40f9d2022-02-17 14:55:16 +08009429 }
9430 }
Gilles Peskine449bd832023-01-11 14:50:10 +01009431 return 0;
Jerry Yuee40f9d2022-02-17 14:55:16 +08009432}
9433
9434#else
9435
Gilles Peskine449bd832023-01-11 14:50:10 +01009436int mbedtls_ssl_get_key_exchange_md_tls1_2(mbedtls_ssl_context *ssl,
9437 unsigned char *hash, size_t *hashlen,
9438 unsigned char *data, size_t data_len,
9439 mbedtls_md_type_t md_alg)
Jerry Yuee40f9d2022-02-17 14:55:16 +08009440{
9441 int ret = 0;
9442 mbedtls_md_context_t ctx;
Gilles Peskine449bd832023-01-11 14:50:10 +01009443 const mbedtls_md_info_t *md_info = mbedtls_md_info_from_type(md_alg);
9444 *hashlen = mbedtls_md_get_size(md_info);
Jerry Yuee40f9d2022-02-17 14:55:16 +08009445
Gilles Peskine449bd832023-01-11 14:50:10 +01009446 MBEDTLS_SSL_DEBUG_MSG(3, ("Perform mbedtls-based computation of digest of ServerKeyExchange"));
Jerry Yuee40f9d2022-02-17 14:55:16 +08009447
Gilles Peskine449bd832023-01-11 14:50:10 +01009448 mbedtls_md_init(&ctx);
Jerry Yuee40f9d2022-02-17 14:55:16 +08009449
9450 /*
9451 * digitally-signed struct {
9452 * opaque client_random[32];
9453 * opaque server_random[32];
9454 * ServerDHParams params;
9455 * };
9456 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009457 if ((ret = mbedtls_md_setup(&ctx, md_info, 0)) != 0) {
9458 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_setup", ret);
Jerry Yuee40f9d2022-02-17 14:55:16 +08009459 goto exit;
9460 }
Gilles Peskine449bd832023-01-11 14:50:10 +01009461 if ((ret = mbedtls_md_starts(&ctx)) != 0) {
9462 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_starts", ret);
Jerry Yuee40f9d2022-02-17 14:55:16 +08009463 goto exit;
9464 }
Gilles Peskine449bd832023-01-11 14:50:10 +01009465 if ((ret = mbedtls_md_update(&ctx, ssl->handshake->randbytes, 64)) != 0) {
9466 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_update", ret);
Jerry Yuee40f9d2022-02-17 14:55:16 +08009467 goto exit;
9468 }
Gilles Peskine449bd832023-01-11 14:50:10 +01009469 if ((ret = mbedtls_md_update(&ctx, data, data_len)) != 0) {
9470 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_update", ret);
Jerry Yuee40f9d2022-02-17 14:55:16 +08009471 goto exit;
9472 }
Gilles Peskine449bd832023-01-11 14:50:10 +01009473 if ((ret = mbedtls_md_finish(&ctx, hash)) != 0) {
9474 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_finish", ret);
Jerry Yuee40f9d2022-02-17 14:55:16 +08009475 goto exit;
9476 }
9477
9478exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01009479 mbedtls_md_free(&ctx);
Jerry Yuee40f9d2022-02-17 14:55:16 +08009480
Gilles Peskine449bd832023-01-11 14:50:10 +01009481 if (ret != 0) {
9482 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
9483 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR);
9484 }
Jerry Yuee40f9d2022-02-17 14:55:16 +08009485
Gilles Peskine449bd832023-01-11 14:50:10 +01009486 return ret;
Jerry Yuee40f9d2022-02-17 14:55:16 +08009487}
9488#endif /* MBEDTLS_USE_PSA_CRYPTO */
9489
Jerry Yud9d91da2022-02-17 14:57:06 +08009490#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
9491
Gabor Mezeia3d016c2022-05-10 12:44:09 +02009492/* Find the preferred hash for a given signature algorithm. */
9493unsigned int mbedtls_ssl_tls12_get_preferred_hash_for_sig_alg(
Gilles Peskine449bd832023-01-11 14:50:10 +01009494 mbedtls_ssl_context *ssl,
9495 unsigned int sig_alg)
Jerry Yud9d91da2022-02-17 14:57:06 +08009496{
Gabor Mezei078e8032022-04-27 21:17:56 +02009497 unsigned int i;
Gabor Mezeia3d016c2022-05-10 12:44:09 +02009498 uint16_t *received_sig_algs = ssl->handshake->received_sig_algs;
Gabor Mezei078e8032022-04-27 21:17:56 +02009499
Gilles Peskine449bd832023-01-11 14:50:10 +01009500 if (sig_alg == MBEDTLS_SSL_SIG_ANON) {
9501 return MBEDTLS_SSL_HASH_NONE;
9502 }
Gabor Mezei078e8032022-04-27 21:17:56 +02009503
Gilles Peskine449bd832023-01-11 14:50:10 +01009504 for (i = 0; received_sig_algs[i] != MBEDTLS_TLS_SIG_NONE; i++) {
Neil Armstrong9f1176a2022-06-24 18:19:19 +02009505 unsigned int hash_alg_received =
Gilles Peskine449bd832023-01-11 14:50:10 +01009506 MBEDTLS_SSL_TLS12_HASH_ALG_FROM_SIG_AND_HASH_ALG(
9507 received_sig_algs[i]);
Neil Armstrong9f1176a2022-06-24 18:19:19 +02009508 unsigned int sig_alg_received =
Gilles Peskine449bd832023-01-11 14:50:10 +01009509 MBEDTLS_SSL_TLS12_SIG_ALG_FROM_SIG_AND_HASH_ALG(
9510 received_sig_algs[i]);
Neil Armstrong9f1176a2022-06-24 18:19:19 +02009511
Manuel Pégourié-Gonnard47bb3802023-06-05 12:40:32 +02009512 mbedtls_md_type_t md_alg =
9513 mbedtls_ssl_md_alg_from_hash((unsigned char) hash_alg_received);
9514 if (md_alg == MBEDTLS_MD_NONE) {
9515 continue;
9516 }
9517
Gilles Peskine449bd832023-01-11 14:50:10 +01009518 if (sig_alg == sig_alg_received) {
Neil Armstrong9f1176a2022-06-24 18:19:19 +02009519#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01009520 if (ssl->handshake->key_cert && ssl->handshake->key_cert->key) {
Neil Armstrong96eceb82022-06-30 18:05:05 +02009521 psa_algorithm_t psa_hash_alg =
Manuel Pégourié-Gonnard47bb3802023-06-05 12:40:32 +02009522 mbedtls_md_psa_alg_from_type(md_alg);
Neil Armstrong9f1176a2022-06-24 18:19:19 +02009523
Gilles Peskine449bd832023-01-11 14:50:10 +01009524 if (sig_alg_received == MBEDTLS_SSL_SIG_ECDSA &&
9525 !mbedtls_pk_can_do_ext(ssl->handshake->key_cert->key,
9526 PSA_ALG_ECDSA(psa_hash_alg),
9527 PSA_KEY_USAGE_SIGN_HASH)) {
Neil Armstrong9f1176a2022-06-24 18:19:19 +02009528 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01009529 }
Neil Armstrong9f1176a2022-06-24 18:19:19 +02009530
Gilles Peskine449bd832023-01-11 14:50:10 +01009531 if (sig_alg_received == MBEDTLS_SSL_SIG_RSA &&
9532 !mbedtls_pk_can_do_ext(ssl->handshake->key_cert->key,
9533 PSA_ALG_RSA_PKCS1V15_SIGN(
9534 psa_hash_alg),
9535 PSA_KEY_USAGE_SIGN_HASH)) {
Neil Armstrong9f1176a2022-06-24 18:19:19 +02009536 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01009537 }
Neil Armstrong9f1176a2022-06-24 18:19:19 +02009538 }
Neil Armstrong9f1176a2022-06-24 18:19:19 +02009539#endif /* MBEDTLS_USE_PSA_CRYPTO */
Neil Armstrong96eceb82022-06-30 18:05:05 +02009540
Gilles Peskine449bd832023-01-11 14:50:10 +01009541 return hash_alg_received;
Neil Armstrong9f1176a2022-06-24 18:19:19 +02009542 }
Jerry Yud9d91da2022-02-17 14:57:06 +08009543 }
Jerry Yud9d91da2022-02-17 14:57:06 +08009544
Gilles Peskine449bd832023-01-11 14:50:10 +01009545 return MBEDTLS_SSL_HASH_NONE;
Jerry Yud9d91da2022-02-17 14:57:06 +08009546}
9547
9548#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
9549
Jerry Yudc7bd172022-02-17 13:44:15 +08009550#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
9551
XiaokangQian75d40ef2022-04-20 11:05:24 +00009552int mbedtls_ssl_validate_ciphersuite(
9553 const mbedtls_ssl_context *ssl,
9554 const mbedtls_ssl_ciphersuite_t *suite_info,
9555 mbedtls_ssl_protocol_version min_tls_version,
Gilles Peskine449bd832023-01-11 14:50:10 +01009556 mbedtls_ssl_protocol_version max_tls_version)
XiaokangQian75d40ef2022-04-20 11:05:24 +00009557{
9558 (void) ssl;
9559
Gilles Peskine449bd832023-01-11 14:50:10 +01009560 if (suite_info == NULL) {
9561 return -1;
9562 }
XiaokangQian75d40ef2022-04-20 11:05:24 +00009563
Gilles Peskine449bd832023-01-11 14:50:10 +01009564 if ((suite_info->min_tls_version > max_tls_version) ||
9565 (suite_info->max_tls_version < min_tls_version)) {
9566 return -1;
XiaokangQian75d40ef2022-04-20 11:05:24 +00009567 }
9568
XiaokangQian060d8672022-04-21 09:24:56 +00009569#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_CLI_C)
XiaokangQian75d40ef2022-04-20 11:05:24 +00009570#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Neil Armstrongca7d5062022-05-31 14:43:23 +02009571#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01009572 if (suite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_ECJPAKE &&
9573 ssl->handshake->psa_pake_ctx_is_ok != 1)
Neil Armstrongca7d5062022-05-31 14:43:23 +02009574#else
Gilles Peskine449bd832023-01-11 14:50:10 +01009575 if (suite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_ECJPAKE &&
9576 mbedtls_ecjpake_check(&ssl->handshake->ecjpake_ctx) != 0)
Neil Armstrongca7d5062022-05-31 14:43:23 +02009577#endif /* MBEDTLS_USE_PSA_CRYPTO */
XiaokangQian75d40ef2022-04-20 11:05:24 +00009578 {
Gilles Peskine449bd832023-01-11 14:50:10 +01009579 return -1;
XiaokangQian75d40ef2022-04-20 11:05:24 +00009580 }
9581#endif
9582
9583 /* Don't suggest PSK-based ciphersuite if no PSK is available. */
9584#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01009585 if (mbedtls_ssl_ciphersuite_uses_psk(suite_info) &&
9586 mbedtls_ssl_conf_has_static_psk(ssl->conf) == 0) {
9587 return -1;
XiaokangQian75d40ef2022-04-20 11:05:24 +00009588 }
9589#endif /* MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
9590#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
9591
Gilles Peskine449bd832023-01-11 14:50:10 +01009592 return 0;
XiaokangQian75d40ef2022-04-20 11:05:24 +00009593}
9594
Ronald Crone68ab4f2022-10-05 12:46:29 +02009595#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
XiaokangQianeaf36512022-04-24 09:07:44 +00009596/*
9597 * Function for writing a signature algorithm extension.
9598 *
9599 * The `extension_data` field of signature algorithm contains a `SignatureSchemeList`
9600 * value (TLS 1.3 RFC8446):
9601 * enum {
9602 * ....
9603 * ecdsa_secp256r1_sha256( 0x0403 ),
9604 * ecdsa_secp384r1_sha384( 0x0503 ),
9605 * ecdsa_secp521r1_sha512( 0x0603 ),
9606 * ....
9607 * } SignatureScheme;
9608 *
9609 * struct {
9610 * SignatureScheme supported_signature_algorithms<2..2^16-2>;
9611 * } SignatureSchemeList;
9612 *
9613 * The `extension_data` field of signature algorithm contains a `SignatureAndHashAlgorithm`
9614 * value (TLS 1.2 RFC5246):
9615 * enum {
9616 * none(0), md5(1), sha1(2), sha224(3), sha256(4), sha384(5),
9617 * sha512(6), (255)
9618 * } HashAlgorithm;
9619 *
9620 * enum { anonymous(0), rsa(1), dsa(2), ecdsa(3), (255) }
9621 * SignatureAlgorithm;
9622 *
9623 * struct {
9624 * HashAlgorithm hash;
9625 * SignatureAlgorithm signature;
9626 * } SignatureAndHashAlgorithm;
9627 *
9628 * SignatureAndHashAlgorithm
9629 * supported_signature_algorithms<2..2^16-2>;
9630 *
9631 * The TLS 1.3 signature algorithm extension was defined to be a compatible
9632 * generalization of the TLS 1.2 signature algorithm extension.
9633 * `SignatureAndHashAlgorithm` field of TLS 1.2 can be represented by
9634 * `SignatureScheme` field of TLS 1.3
9635 *
9636 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009637int mbedtls_ssl_write_sig_alg_ext(mbedtls_ssl_context *ssl, unsigned char *buf,
9638 const unsigned char *end, size_t *out_len)
XiaokangQianeaf36512022-04-24 09:07:44 +00009639{
9640 unsigned char *p = buf;
9641 unsigned char *supported_sig_alg; /* Start of supported_signature_algorithms */
9642 size_t supported_sig_alg_len = 0; /* Length of supported_signature_algorithms */
9643
9644 *out_len = 0;
9645
Gilles Peskine449bd832023-01-11 14:50:10 +01009646 MBEDTLS_SSL_DEBUG_MSG(3, ("adding signature_algorithms extension"));
XiaokangQianeaf36512022-04-24 09:07:44 +00009647
9648 /* Check if we have space for header and length field:
9649 * - extension_type (2 bytes)
9650 * - extension_data_length (2 bytes)
9651 * - supported_signature_algorithms_length (2 bytes)
9652 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009653 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 6);
XiaokangQianeaf36512022-04-24 09:07:44 +00009654 p += 6;
9655
9656 /*
9657 * Write supported_signature_algorithms
9658 */
9659 supported_sig_alg = p;
Gilles Peskine449bd832023-01-11 14:50:10 +01009660 const uint16_t *sig_alg = mbedtls_ssl_get_sig_algs(ssl);
9661 if (sig_alg == NULL) {
9662 return MBEDTLS_ERR_SSL_BAD_CONFIG;
9663 }
XiaokangQianeaf36512022-04-24 09:07:44 +00009664
Gilles Peskine449bd832023-01-11 14:50:10 +01009665 for (; *sig_alg != MBEDTLS_TLS1_3_SIG_NONE; sig_alg++) {
9666 MBEDTLS_SSL_DEBUG_MSG(3, ("got signature scheme [%x] %s",
9667 *sig_alg,
9668 mbedtls_ssl_sig_alg_to_str(*sig_alg)));
9669 if (!mbedtls_ssl_sig_alg_is_supported(ssl, *sig_alg)) {
XiaokangQianeaf36512022-04-24 09:07:44 +00009670 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01009671 }
9672 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 2);
9673 MBEDTLS_PUT_UINT16_BE(*sig_alg, p, 0);
XiaokangQianeaf36512022-04-24 09:07:44 +00009674 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01009675 MBEDTLS_SSL_DEBUG_MSG(3, ("sent signature scheme [%x] %s",
9676 *sig_alg,
9677 mbedtls_ssl_sig_alg_to_str(*sig_alg)));
XiaokangQianeaf36512022-04-24 09:07:44 +00009678 }
9679
9680 /* Length of supported_signature_algorithms */
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00009681 supported_sig_alg_len = (size_t) (p - supported_sig_alg);
Gilles Peskine449bd832023-01-11 14:50:10 +01009682 if (supported_sig_alg_len == 0) {
9683 MBEDTLS_SSL_DEBUG_MSG(1, ("No signature algorithms defined."));
9684 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
XiaokangQianeaf36512022-04-24 09:07:44 +00009685 }
9686
Gilles Peskine449bd832023-01-11 14:50:10 +01009687 MBEDTLS_PUT_UINT16_BE(MBEDTLS_TLS_EXT_SIG_ALG, buf, 0);
9688 MBEDTLS_PUT_UINT16_BE(supported_sig_alg_len + 2, buf, 2);
9689 MBEDTLS_PUT_UINT16_BE(supported_sig_alg_len, buf, 4);
XiaokangQianeaf36512022-04-24 09:07:44 +00009690
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00009691 *out_len = (size_t) (p - buf);
XiaokangQianeaf36512022-04-24 09:07:44 +00009692
9693#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01009694 mbedtls_ssl_tls13_set_hs_sent_ext_mask(ssl, MBEDTLS_TLS_EXT_SIG_ALG);
XiaokangQianeaf36512022-04-24 09:07:44 +00009695#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yu0c354a22022-08-29 15:25:36 +08009696
Gilles Peskine449bd832023-01-11 14:50:10 +01009697 return 0;
XiaokangQianeaf36512022-04-24 09:07:44 +00009698}
Ronald Crone68ab4f2022-10-05 12:46:29 +02009699#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
XiaokangQianeaf36512022-04-24 09:07:44 +00009700
XiaokangQian40a35232022-05-07 09:02:40 +00009701#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
XiaokangQian9b2b7712022-05-17 02:57:00 +00009702/*
9703 * mbedtls_ssl_parse_server_name_ext
9704 *
9705 * Structure of server_name extension:
9706 *
9707 * enum {
9708 * host_name(0), (255)
9709 * } NameType;
9710 * opaque HostName<1..2^16-1>;
9711 *
9712 * struct {
9713 * NameType name_type;
9714 * select (name_type) {
9715 * case host_name: HostName;
9716 * } name;
9717 * } ServerName;
9718 * struct {
9719 * ServerName server_name_list<1..2^16-1>
9720 * } ServerNameList;
9721 */
Ronald Cronce7d76e2022-07-08 18:56:49 +02009722MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01009723int mbedtls_ssl_parse_server_name_ext(mbedtls_ssl_context *ssl,
9724 const unsigned char *buf,
9725 const unsigned char *end)
XiaokangQian40a35232022-05-07 09:02:40 +00009726{
9727 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
9728 const unsigned char *p = buf;
XiaokangQian9b2b7712022-05-17 02:57:00 +00009729 size_t server_name_list_len, hostname_len;
9730 const unsigned char *server_name_list_end;
XiaokangQian40a35232022-05-07 09:02:40 +00009731
Gilles Peskine449bd832023-01-11 14:50:10 +01009732 MBEDTLS_SSL_DEBUG_MSG(3, ("parse ServerName extension"));
XiaokangQian40a35232022-05-07 09:02:40 +00009733
Gilles Peskine449bd832023-01-11 14:50:10 +01009734 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
9735 server_name_list_len = MBEDTLS_GET_UINT16_BE(p, 0);
XiaokangQian40a35232022-05-07 09:02:40 +00009736 p += 2;
9737
Gilles Peskine449bd832023-01-11 14:50:10 +01009738 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, server_name_list_len);
XiaokangQian9b2b7712022-05-17 02:57:00 +00009739 server_name_list_end = p + server_name_list_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01009740 while (p < server_name_list_end) {
9741 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, server_name_list_end, 3);
9742 hostname_len = MBEDTLS_GET_UINT16_BE(p, 1);
9743 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, server_name_list_end,
9744 hostname_len + 3);
XiaokangQian40a35232022-05-07 09:02:40 +00009745
Gilles Peskine449bd832023-01-11 14:50:10 +01009746 if (p[0] == MBEDTLS_TLS_EXT_SERVERNAME_HOSTNAME) {
XiaokangQian75fe8c72022-06-15 09:42:45 +00009747 /* sni_name is intended to be used only during the parsing of the
9748 * ClientHello message (it is reset to NULL before the end of
9749 * the message parsing). Thus it is ok to just point to the
9750 * reception buffer and not make a copy of it.
9751 */
XiaokangQianf2a94202022-05-20 06:44:24 +00009752 ssl->handshake->sni_name = p + 3;
9753 ssl->handshake->sni_name_len = hostname_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01009754 if (ssl->conf->f_sni == NULL) {
9755 return 0;
XiaokangQian40a35232022-05-07 09:02:40 +00009756 }
Gilles Peskine449bd832023-01-11 14:50:10 +01009757 ret = ssl->conf->f_sni(ssl->conf->p_sni,
9758 ssl, p + 3, hostname_len);
9759 if (ret != 0) {
9760 MBEDTLS_SSL_DEBUG_RET(1, "ssl_sni_wrapper", ret);
9761 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_UNRECOGNIZED_NAME,
9762 MBEDTLS_ERR_SSL_UNRECOGNIZED_NAME);
9763 return MBEDTLS_ERR_SSL_UNRECOGNIZED_NAME;
9764 }
9765 return 0;
XiaokangQian40a35232022-05-07 09:02:40 +00009766 }
9767
9768 p += hostname_len + 3;
9769 }
9770
Gilles Peskine449bd832023-01-11 14:50:10 +01009771 return 0;
XiaokangQian40a35232022-05-07 09:02:40 +00009772}
9773#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
9774
XiaokangQianacb39922022-06-17 10:18:48 +00009775#if defined(MBEDTLS_SSL_ALPN)
Ronald Cronce7d76e2022-07-08 18:56:49 +02009776MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01009777int mbedtls_ssl_parse_alpn_ext(mbedtls_ssl_context *ssl,
9778 const unsigned char *buf,
9779 const unsigned char *end)
XiaokangQianacb39922022-06-17 10:18:48 +00009780{
9781 const unsigned char *p = buf;
XiaokangQianc7403452022-06-23 03:24:12 +00009782 size_t protocol_name_list_len;
XiaokangQian95d5f542022-06-24 02:29:26 +00009783 const unsigned char *protocol_name_list;
9784 const unsigned char *protocol_name_list_end;
XiaokangQianc7403452022-06-23 03:24:12 +00009785 size_t protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00009786
9787 /* If ALPN not configured, just ignore the extension */
Gilles Peskine449bd832023-01-11 14:50:10 +01009788 if (ssl->conf->alpn_list == NULL) {
9789 return 0;
9790 }
XiaokangQianacb39922022-06-17 10:18:48 +00009791
9792 /*
XiaokangQianc7403452022-06-23 03:24:12 +00009793 * RFC7301, section 3.1
9794 * opaque ProtocolName<1..2^8-1>;
XiaokangQianacb39922022-06-17 10:18:48 +00009795 *
XiaokangQianc7403452022-06-23 03:24:12 +00009796 * struct {
9797 * ProtocolName protocol_name_list<2..2^16-1>
9798 * } ProtocolNameList;
XiaokangQianacb39922022-06-17 10:18:48 +00009799 */
9800
XiaokangQianc7403452022-06-23 03:24:12 +00009801 /*
XiaokangQian0b776e22022-06-24 09:04:59 +00009802 * protocol_name_list_len 2 bytes
9803 * protocol_name_len 1 bytes
9804 * protocol_name >=1 byte
XiaokangQianc7403452022-06-23 03:24:12 +00009805 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009806 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 4);
XiaokangQianacb39922022-06-17 10:18:48 +00009807
Gilles Peskine449bd832023-01-11 14:50:10 +01009808 protocol_name_list_len = MBEDTLS_GET_UINT16_BE(p, 0);
XiaokangQianacb39922022-06-17 10:18:48 +00009809 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01009810 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, protocol_name_list_len);
XiaokangQian95d5f542022-06-24 02:29:26 +00009811 protocol_name_list = p;
9812 protocol_name_list_end = p + protocol_name_list_len;
XiaokangQianacb39922022-06-17 10:18:48 +00009813
9814 /* Validate peer's list (lengths) */
Gilles Peskine449bd832023-01-11 14:50:10 +01009815 while (p < protocol_name_list_end) {
XiaokangQian95d5f542022-06-24 02:29:26 +00009816 protocol_name_len = *p++;
Gilles Peskine449bd832023-01-11 14:50:10 +01009817 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, protocol_name_list_end,
9818 protocol_name_len);
9819 if (protocol_name_len == 0) {
XiaokangQian95d5f542022-06-24 02:29:26 +00009820 MBEDTLS_SSL_PEND_FATAL_ALERT(
9821 MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
Gilles Peskine449bd832023-01-11 14:50:10 +01009822 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
9823 return MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
XiaokangQian95d5f542022-06-24 02:29:26 +00009824 }
9825
9826 p += protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00009827 }
9828
9829 /* Use our order of preference */
Gilles Peskine449bd832023-01-11 14:50:10 +01009830 for (const char **alpn = ssl->conf->alpn_list; *alpn != NULL; alpn++) {
9831 size_t const alpn_len = strlen(*alpn);
XiaokangQian95d5f542022-06-24 02:29:26 +00009832 p = protocol_name_list;
Gilles Peskine449bd832023-01-11 14:50:10 +01009833 while (p < protocol_name_list_end) {
XiaokangQian95d5f542022-06-24 02:29:26 +00009834 protocol_name_len = *p++;
Gilles Peskine449bd832023-01-11 14:50:10 +01009835 if (protocol_name_len == alpn_len &&
9836 memcmp(p, *alpn, alpn_len) == 0) {
XiaokangQianacb39922022-06-17 10:18:48 +00009837 ssl->alpn_chosen = *alpn;
Gilles Peskine449bd832023-01-11 14:50:10 +01009838 return 0;
XiaokangQianacb39922022-06-17 10:18:48 +00009839 }
XiaokangQian95d5f542022-06-24 02:29:26 +00009840
9841 p += protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00009842 }
9843 }
9844
XiaokangQian95d5f542022-06-24 02:29:26 +00009845 /* If we get here, no match was found */
XiaokangQianacb39922022-06-17 10:18:48 +00009846 MBEDTLS_SSL_PEND_FATAL_ALERT(
Gilles Peskine449bd832023-01-11 14:50:10 +01009847 MBEDTLS_SSL_ALERT_MSG_NO_APPLICATION_PROTOCOL,
9848 MBEDTLS_ERR_SSL_NO_APPLICATION_PROTOCOL);
9849 return MBEDTLS_ERR_SSL_NO_APPLICATION_PROTOCOL;
XiaokangQianacb39922022-06-17 10:18:48 +00009850}
9851
Gilles Peskine449bd832023-01-11 14:50:10 +01009852int mbedtls_ssl_write_alpn_ext(mbedtls_ssl_context *ssl,
9853 unsigned char *buf,
9854 unsigned char *end,
9855 size_t *out_len)
XiaokangQianacb39922022-06-17 10:18:48 +00009856{
9857 unsigned char *p = buf;
XiaokangQian95d5f542022-06-24 02:29:26 +00009858 size_t protocol_name_len;
XiaokangQianc7403452022-06-23 03:24:12 +00009859 *out_len = 0;
XiaokangQianacb39922022-06-17 10:18:48 +00009860
Gilles Peskine449bd832023-01-11 14:50:10 +01009861 if (ssl->alpn_chosen == NULL) {
9862 return 0;
XiaokangQianacb39922022-06-17 10:18:48 +00009863 }
9864
Gilles Peskine449bd832023-01-11 14:50:10 +01009865 protocol_name_len = strlen(ssl->alpn_chosen);
9866 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 7 + protocol_name_len);
XiaokangQianacb39922022-06-17 10:18:48 +00009867
Gilles Peskine449bd832023-01-11 14:50:10 +01009868 MBEDTLS_SSL_DEBUG_MSG(3, ("server side, adding alpn extension"));
XiaokangQianacb39922022-06-17 10:18:48 +00009869 /*
9870 * 0 . 1 ext identifier
9871 * 2 . 3 ext length
9872 * 4 . 5 protocol list length
9873 * 6 . 6 protocol name length
9874 * 7 . 7+n protocol name
9875 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009876 MBEDTLS_PUT_UINT16_BE(MBEDTLS_TLS_EXT_ALPN, p, 0);
XiaokangQianacb39922022-06-17 10:18:48 +00009877
XiaokangQian95d5f542022-06-24 02:29:26 +00009878 *out_len = 7 + protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00009879
Gilles Peskine449bd832023-01-11 14:50:10 +01009880 MBEDTLS_PUT_UINT16_BE(protocol_name_len + 3, p, 2);
9881 MBEDTLS_PUT_UINT16_BE(protocol_name_len + 1, p, 4);
XiaokangQian0b776e22022-06-24 09:04:59 +00009882 /* Note: the length of the chosen protocol has been checked to be less
9883 * than 255 bytes in `mbedtls_ssl_conf_alpn_protocols`.
9884 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009885 p[6] = MBEDTLS_BYTE_0(protocol_name_len);
XiaokangQianacb39922022-06-17 10:18:48 +00009886
Gilles Peskine449bd832023-01-11 14:50:10 +01009887 memcpy(p + 7, ssl->alpn_chosen, protocol_name_len);
Jerry Yub95dd362022-11-08 21:19:34 +08009888
9889#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01009890 mbedtls_ssl_tls13_set_hs_sent_ext_mask(ssl, MBEDTLS_TLS_EXT_ALPN);
Jerry Yub95dd362022-11-08 21:19:34 +08009891#endif
9892
Gilles Peskine449bd832023-01-11 14:50:10 +01009893 return 0;
XiaokangQianacb39922022-06-17 10:18:48 +00009894}
9895#endif /* MBEDTLS_SSL_ALPN */
9896
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009897#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && \
Xiaokang Qian03409292022-10-12 02:49:52 +00009898 defined(MBEDTLS_SSL_SESSION_TICKETS) && \
Xiaokang Qianed0620c2022-10-12 06:58:13 +00009899 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION) && \
Xiaokang Qianed3afcd2022-10-12 08:31:11 +00009900 defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01009901int mbedtls_ssl_session_set_hostname(mbedtls_ssl_session *session,
9902 const char *hostname)
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009903{
9904 /* Initialize to suppress unnecessary compiler warning */
9905 size_t hostname_len = 0;
9906
9907 /* Check if new hostname is valid before
9908 * making any change to current one */
Gilles Peskine449bd832023-01-11 14:50:10 +01009909 if (hostname != NULL) {
9910 hostname_len = strlen(hostname);
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009911
Gilles Peskine449bd832023-01-11 14:50:10 +01009912 if (hostname_len > MBEDTLS_SSL_MAX_HOST_NAME_LEN) {
9913 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9914 }
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009915 }
9916
9917 /* Now it's clear that we will overwrite the old hostname,
9918 * so we can free it safely */
Gilles Peskine449bd832023-01-11 14:50:10 +01009919 if (session->hostname != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01009920 mbedtls_zeroize_and_free(session->hostname,
Gilles Peskine449bd832023-01-11 14:50:10 +01009921 strlen(session->hostname));
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009922 }
9923
9924 /* Passing NULL as hostname shall clear the old one */
Gilles Peskine449bd832023-01-11 14:50:10 +01009925 if (hostname == NULL) {
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009926 session->hostname = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01009927 } else {
9928 session->hostname = mbedtls_calloc(1, hostname_len + 1);
9929 if (session->hostname == NULL) {
9930 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
9931 }
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009932
Gilles Peskine449bd832023-01-11 14:50:10 +01009933 memcpy(session->hostname, hostname, hostname_len);
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009934 }
9935
Gilles Peskine449bd832023-01-11 14:50:10 +01009936 return 0;
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009937}
Xiaokang Qian03409292022-10-12 02:49:52 +00009938#endif /* MBEDTLS_SSL_PROTO_TLS1_3 &&
9939 MBEDTLS_SSL_SESSION_TICKETS &&
Xiaokang Qianed0620c2022-10-12 06:58:13 +00009940 MBEDTLS_SSL_SERVER_NAME_INDICATION &&
Xiaokang Qianed3afcd2022-10-12 08:31:11 +00009941 MBEDTLS_SSL_CLI_C */
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009942
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00009943#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_EARLY_DATA) && \
9944 defined(MBEDTLS_SSL_ALPN)
Waleed Elmelegy7dfba342024-03-12 16:22:39 +00009945int mbedtls_ssl_session_set_ticket_alpn(mbedtls_ssl_session *session,
9946 const char *alpn)
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00009947{
9948 size_t alpn_len = 0;
9949
9950 if (alpn != NULL) {
9951 alpn_len = strlen(alpn);
9952
9953 if (alpn_len > MBEDTLS_SSL_MAX_ALPN_NAME_LEN) {
9954 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9955 }
9956 }
9957
9958 if (session->ticket_alpn != NULL) {
9959 mbedtls_zeroize_and_free(session->ticket_alpn,
9960 strlen(session->ticket_alpn));
Waleed Elmelegy7dfba342024-03-12 16:22:39 +00009961 session->ticket_alpn = NULL;
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00009962 }
9963
Waleed Elmelegy7dfba342024-03-12 16:22:39 +00009964 if (alpn != NULL) {
9965 session->ticket_alpn = mbedtls_calloc(alpn_len + 1, 1);
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00009966 if (session->ticket_alpn == NULL) {
9967 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
9968 }
Waleed Elmelegy7dfba342024-03-12 16:22:39 +00009969 memcpy(session->ticket_alpn, alpn, alpn_len);
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00009970 }
9971
9972 return 0;
9973}
9974#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_EARLY_DATA && MBEDTLS_SSL_ALPN */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02009975#endif /* MBEDTLS_SSL_TLS_C */