blob: 89588a4787ea4beb0148e2968a5fe4ab3c1c8c70 [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
3013#define MBEDTLS_SSL_SESSION_TICKETS_TLS1_2_BIT 0
3014#define MBEDTLS_SSL_SESSION_TICKETS_TLS1_3_BIT 1
3015
3016#define MBEDTLS_SSL_SESSION_TICKETS_TLS1_2_MASK \
3017 (1 << MBEDTLS_SSL_SESSION_TICKETS_TLS1_2_BIT)
3018#define MBEDTLS_SSL_SESSION_TICKETS_TLS1_3_MASK \
3019 (1 << MBEDTLS_SSL_SESSION_TICKETS_TLS1_3_BIT)
3020
Gilles Peskine449bd832023-01-11 14:50:10 +01003021void mbedtls_ssl_conf_session_tickets(mbedtls_ssl_config *conf, int use_tickets)
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02003022{
Ronald Crond67f8012024-08-28 07:45:57 +02003023 conf->session_tickets &= ~MBEDTLS_SSL_SESSION_TICKETS_TLS1_2_MASK;
3024 conf->session_tickets |= (use_tickets != 0) <<
3025 MBEDTLS_SSL_SESSION_TICKETS_TLS1_2_BIT;
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02003026}
Ronald Crond67f8012024-08-28 07:45:57 +02003027
3028int mbedtls_ssl_conf_get_session_tickets(const mbedtls_ssl_config *conf)
3029{
3030 return conf->session_tickets & MBEDTLS_SSL_SESSION_TICKETS_TLS1_2_MASK ?
3031 MBEDTLS_SSL_SESSION_TICKETS_ENABLED :
3032 MBEDTLS_SSL_SESSION_TICKETS_DISABLED;
3033}
3034
Ronald Cronbedddd72024-08-27 14:18:50 +02003035#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
3036void mbedtls_ssl_conf_enable_new_session_tickets(mbedtls_ssl_config *conf,
Ronald Crond67f8012024-08-28 07:45:57 +02003037 int use_new_session_tickets)
Ronald Cronbedddd72024-08-27 14:18:50 +02003038{
Ronald Crond67f8012024-08-28 07:45:57 +02003039 conf->session_tickets &= ~MBEDTLS_SSL_SESSION_TICKETS_TLS1_3_MASK;
3040 conf->session_tickets |= (use_new_session_tickets != 0) <<
3041 MBEDTLS_SSL_SESSION_TICKETS_TLS1_3_BIT;
3042}
3043
3044int mbedtls_ssl_conf_is_new_session_tickets_enabled(const mbedtls_ssl_config *conf)
3045{
3046 return conf->session_tickets & MBEDTLS_SSL_SESSION_TICKETS_TLS1_3_MASK ?
3047 MBEDTLS_SSL_NEW_SESSION_TICKETS_ENABLED :
3048 MBEDTLS_SSL_NEW_SESSION_TICKETS_DISABLED;
Ronald Cronbedddd72024-08-27 14:18:50 +02003049}
3050#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
3051#endif /* MBEDTLS_SSL_CLI_C */
Paul Bakker606b4ba2013-08-14 16:52:14 +02003052
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02003053#if defined(MBEDTLS_SSL_SRV_C)
Jerry Yu1ad7ace2022-08-09 13:28:39 +08003054
Jerry Yud0766ec2022-09-22 10:46:57 +08003055#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003056void mbedtls_ssl_conf_new_session_tickets(mbedtls_ssl_config *conf,
3057 uint16_t num_tickets)
Jerry Yu1ad7ace2022-08-09 13:28:39 +08003058{
Jerry Yud0766ec2022-09-22 10:46:57 +08003059 conf->new_session_tickets_count = num_tickets;
Jerry Yu1ad7ace2022-08-09 13:28:39 +08003060}
3061#endif
3062
Gilles Peskine449bd832023-01-11 14:50:10 +01003063void mbedtls_ssl_conf_session_tickets_cb(mbedtls_ssl_config *conf,
3064 mbedtls_ssl_ticket_write_t *f_ticket_write,
3065 mbedtls_ssl_ticket_parse_t *f_ticket_parse,
3066 void *p_ticket)
Paul Bakker606b4ba2013-08-14 16:52:14 +02003067{
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02003068 conf->f_ticket_write = f_ticket_write;
3069 conf->f_ticket_parse = f_ticket_parse;
3070 conf->p_ticket = p_ticket;
Paul Bakker606b4ba2013-08-14 16:52:14 +02003071}
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02003072#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003073#endif /* MBEDTLS_SSL_SESSION_TICKETS */
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02003074
Gilles Peskine449bd832023-01-11 14:50:10 +01003075void mbedtls_ssl_set_export_keys_cb(mbedtls_ssl_context *ssl,
3076 mbedtls_ssl_export_keys_t *f_export_keys,
3077 void *p_export_keys)
Robert Cragie4feb7ae2015-10-02 13:33:37 +01003078{
Hanno Becker7e6c1782021-06-08 09:24:55 +01003079 ssl->f_export_keys = f_export_keys;
3080 ssl->p_export_keys = p_export_keys;
Ron Eldorf5cc10d2019-05-07 18:33:40 +03003081}
Robert Cragie4feb7ae2015-10-02 13:33:37 +01003082
Gilles Peskineb74a1c72018-04-24 13:09:22 +02003083#if defined(MBEDTLS_SSL_ASYNC_PRIVATE)
Gilles Peskine8bf79f62018-01-05 21:11:53 +01003084void mbedtls_ssl_conf_async_private_cb(
3085 mbedtls_ssl_config *conf,
3086 mbedtls_ssl_async_sign_t *f_async_sign,
3087 mbedtls_ssl_async_decrypt_t *f_async_decrypt,
3088 mbedtls_ssl_async_resume_t *f_async_resume,
3089 mbedtls_ssl_async_cancel_t *f_async_cancel,
Gilles Peskine449bd832023-01-11 14:50:10 +01003090 void *async_config_data)
Gilles Peskine8bf79f62018-01-05 21:11:53 +01003091{
3092 conf->f_async_sign_start = f_async_sign;
3093 conf->f_async_decrypt_start = f_async_decrypt;
3094 conf->f_async_resume = f_async_resume;
3095 conf->f_async_cancel = f_async_cancel;
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003096 conf->p_async_config_data = async_config_data;
3097}
3098
Gilles Peskine449bd832023-01-11 14:50:10 +01003099void *mbedtls_ssl_conf_get_async_config_data(const mbedtls_ssl_config *conf)
Gilles Peskine8f97af72018-04-26 11:46:10 +02003100{
Gilles Peskine449bd832023-01-11 14:50:10 +01003101 return conf->p_async_config_data;
Gilles Peskine8f97af72018-04-26 11:46:10 +02003102}
3103
Gilles Peskine449bd832023-01-11 14:50:10 +01003104void *mbedtls_ssl_get_async_operation_data(const mbedtls_ssl_context *ssl)
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003105{
Gilles Peskine449bd832023-01-11 14:50:10 +01003106 if (ssl->handshake == NULL) {
3107 return NULL;
3108 } else {
3109 return ssl->handshake->user_async_ctx;
3110 }
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003111}
3112
Gilles Peskine449bd832023-01-11 14:50:10 +01003113void mbedtls_ssl_set_async_operation_data(mbedtls_ssl_context *ssl,
3114 void *ctx)
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003115{
Gilles Peskine449bd832023-01-11 14:50:10 +01003116 if (ssl->handshake != NULL) {
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003117 ssl->handshake->user_async_ctx = ctx;
Gilles Peskine449bd832023-01-11 14:50:10 +01003118 }
Gilles Peskine8bf79f62018-01-05 21:11:53 +01003119}
Gilles Peskineb74a1c72018-04-24 13:09:22 +02003120#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
Gilles Peskine8bf79f62018-01-05 21:11:53 +01003121
Paul Bakker5121ce52009-01-03 21:22:43 +00003122/*
3123 * SSL get accessors
3124 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003125uint32_t mbedtls_ssl_get_verify_result(const mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00003126{
Gilles Peskine449bd832023-01-11 14:50:10 +01003127 if (ssl->session != NULL) {
3128 return ssl->session->verify_result;
3129 }
Manuel Pégourié-Gonnarde89163c2015-01-23 14:30:57 +00003130
Gilles Peskine449bd832023-01-11 14:50:10 +01003131 if (ssl->session_negotiate != NULL) {
3132 return ssl->session_negotiate->verify_result;
3133 }
Manuel Pégourié-Gonnarde89163c2015-01-23 14:30:57 +00003134
Gilles Peskine449bd832023-01-11 14:50:10 +01003135 return 0xFFFFFFFF;
Paul Bakker5121ce52009-01-03 21:22:43 +00003136}
3137
Gilles Peskine449bd832023-01-11 14:50:10 +01003138int mbedtls_ssl_get_ciphersuite_id_from_ssl(const mbedtls_ssl_context *ssl)
Glenn Strauss8f526902022-01-13 00:04:49 -05003139{
Gilles Peskine449bd832023-01-11 14:50:10 +01003140 if (ssl == NULL || ssl->session == NULL) {
3141 return 0;
3142 }
Glenn Strauss8f526902022-01-13 00:04:49 -05003143
Gilles Peskine449bd832023-01-11 14:50:10 +01003144 return ssl->session->ciphersuite;
Glenn Strauss8f526902022-01-13 00:04:49 -05003145}
3146
Gilles Peskine449bd832023-01-11 14:50:10 +01003147const char *mbedtls_ssl_get_ciphersuite(const mbedtls_ssl_context *ssl)
Paul Bakker72f62662011-01-16 21:27:44 +00003148{
Gilles Peskine449bd832023-01-11 14:50:10 +01003149 if (ssl == NULL || ssl->session == NULL) {
3150 return NULL;
3151 }
Paul Bakker926c8e42013-03-06 10:23:34 +01003152
Gilles Peskine449bd832023-01-11 14:50:10 +01003153 return mbedtls_ssl_get_ciphersuite_name(ssl->session->ciphersuite);
Paul Bakker72f62662011-01-16 21:27:44 +00003154}
3155
Gilles Peskine449bd832023-01-11 14:50:10 +01003156const char *mbedtls_ssl_get_version(const mbedtls_ssl_context *ssl)
Paul Bakker43ca69c2011-01-15 17:35:19 +00003157{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003158#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003159 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
3160 switch (ssl->tls_version) {
Glenn Strauss60bfe602022-03-14 19:04:24 -04003161 case MBEDTLS_SSL_VERSION_TLS1_2:
Gilles Peskine449bd832023-01-11 14:50:10 +01003162 return "DTLSv1.2";
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01003163 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01003164 return "unknown (DTLS)";
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01003165 }
3166 }
3167#endif
3168
Gilles Peskine449bd832023-01-11 14:50:10 +01003169 switch (ssl->tls_version) {
Glenn Strauss60bfe602022-03-14 19:04:24 -04003170 case MBEDTLS_SSL_VERSION_TLS1_2:
Gilles Peskine449bd832023-01-11 14:50:10 +01003171 return "TLSv1.2";
Glenn Strauss60bfe602022-03-14 19:04:24 -04003172 case MBEDTLS_SSL_VERSION_TLS1_3:
Gilles Peskine449bd832023-01-11 14:50:10 +01003173 return "TLSv1.3";
Paul Bakker43ca69c2011-01-15 17:35:19 +00003174 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01003175 return "unknown";
Paul Bakker43ca69c2011-01-15 17:35:19 +00003176 }
Paul Bakker43ca69c2011-01-15 17:35:19 +00003177}
3178
Waleed Elmelegy6a971fd2023-12-28 17:48:16 +00003179#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
3180
3181size_t mbedtls_ssl_get_output_record_size_limit(const mbedtls_ssl_context *ssl)
3182{
3183 const size_t max_len = MBEDTLS_SSL_OUT_CONTENT_LEN;
3184 size_t record_size_limit = max_len;
3185
3186 if (ssl->session != NULL &&
3187 ssl->session->record_size_limit >= MBEDTLS_SSL_RECORD_SIZE_LIMIT_MIN &&
3188 ssl->session->record_size_limit < max_len) {
3189 record_size_limit = ssl->session->record_size_limit;
3190 }
3191
3192 // TODO: this is currently untested
3193 /* During a handshake, use the value being negotiated */
3194 if (ssl->session_negotiate != NULL &&
3195 ssl->session_negotiate->record_size_limit >= MBEDTLS_SSL_RECORD_SIZE_LIMIT_MIN &&
3196 ssl->session_negotiate->record_size_limit < max_len) {
3197 record_size_limit = ssl->session_negotiate->record_size_limit;
3198 }
3199
3200 return record_size_limit;
3201}
3202#endif /* MBEDTLS_SSL_RECORD_SIZE_LIMIT */
3203
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02003204#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01003205size_t mbedtls_ssl_get_input_max_frag_len(const mbedtls_ssl_context *ssl)
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003206{
David Horstmann95d516f2021-05-04 18:36:56 +01003207 size_t max_len = MBEDTLS_SSL_IN_CONTENT_LEN;
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003208 size_t read_mfl;
3209
Jerry Yuddda0502022-12-01 19:43:12 +08003210#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003211 /* Use the configured MFL for the client if we're past SERVER_HELLO_DONE */
Gilles Peskine449bd832023-01-11 14:50:10 +01003212 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
3213 ssl->state >= MBEDTLS_SSL_SERVER_HELLO_DONE) {
3214 return ssl_mfl_code_to_length(ssl->conf->mfl_code);
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003215 }
Jerry Yuddda0502022-12-01 19:43:12 +08003216#endif
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003217
3218 /* Check if a smaller max length was negotiated */
Gilles Peskine449bd832023-01-11 14:50:10 +01003219 if (ssl->session_out != NULL) {
3220 read_mfl = ssl_mfl_code_to_length(ssl->session_out->mfl_code);
3221 if (read_mfl < max_len) {
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003222 max_len = read_mfl;
3223 }
3224 }
3225
Jerry Yuddda0502022-12-01 19:43:12 +08003226 /* During a handshake, use the value being negotiated */
Gilles Peskine449bd832023-01-11 14:50:10 +01003227 if (ssl->session_negotiate != NULL) {
3228 read_mfl = ssl_mfl_code_to_length(ssl->session_negotiate->mfl_code);
3229 if (read_mfl < max_len) {
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003230 max_len = read_mfl;
3231 }
3232 }
3233
Gilles Peskine449bd832023-01-11 14:50:10 +01003234 return max_len;
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003235}
3236
Gilles Peskine449bd832023-01-11 14:50:10 +01003237size_t mbedtls_ssl_get_output_max_frag_len(const mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02003238{
3239 size_t max_len;
3240
3241 /*
3242 * Assume mfl_code is correct since it was checked when set
3243 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003244 max_len = ssl_mfl_code_to_length(ssl->conf->mfl_code);
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02003245
Manuel Pégourié-Gonnard2cb17e22017-09-19 13:00:47 +02003246 /* Check if a smaller max length was negotiated */
Gilles Peskine449bd832023-01-11 14:50:10 +01003247 if (ssl->session_out != NULL &&
3248 ssl_mfl_code_to_length(ssl->session_out->mfl_code) < max_len) {
3249 max_len = ssl_mfl_code_to_length(ssl->session_out->mfl_code);
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02003250 }
3251
Manuel Pégourié-Gonnard2cb17e22017-09-19 13:00:47 +02003252 /* During a handshake, use the value being negotiated */
Gilles Peskine449bd832023-01-11 14:50:10 +01003253 if (ssl->session_negotiate != NULL &&
3254 ssl_mfl_code_to_length(ssl->session_negotiate->mfl_code) < max_len) {
3255 max_len = ssl_mfl_code_to_length(ssl->session_negotiate->mfl_code);
Manuel Pégourié-Gonnard2cb17e22017-09-19 13:00:47 +02003256 }
3257
Gilles Peskine449bd832023-01-11 14:50:10 +01003258 return max_len;
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02003259}
3260#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
3261
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003262#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003263size_t mbedtls_ssl_get_current_mtu(const mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003264{
Andrzej Kurekef43ce62018-10-09 08:24:12 -04003265 /* Return unlimited mtu for client hello messages to avoid fragmentation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01003266 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
3267 (ssl->state == MBEDTLS_SSL_CLIENT_HELLO ||
3268 ssl->state == MBEDTLS_SSL_SERVER_HELLO)) {
3269 return 0;
3270 }
Andrzej Kurekef43ce62018-10-09 08:24:12 -04003271
Gilles Peskine449bd832023-01-11 14:50:10 +01003272 if (ssl->handshake == NULL || ssl->handshake->mtu == 0) {
3273 return ssl->mtu;
3274 }
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003275
Gilles Peskine449bd832023-01-11 14:50:10 +01003276 if (ssl->mtu == 0) {
3277 return ssl->handshake->mtu;
3278 }
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003279
Gilles Peskine449bd832023-01-11 14:50:10 +01003280 return ssl->mtu < ssl->handshake->mtu ?
3281 ssl->mtu : ssl->handshake->mtu;
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003282}
3283#endif /* MBEDTLS_SSL_PROTO_DTLS */
3284
Gilles Peskine449bd832023-01-11 14:50:10 +01003285int mbedtls_ssl_get_max_out_record_payload(const mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003286{
3287 size_t max_len = MBEDTLS_SSL_OUT_CONTENT_LEN;
3288
Manuel Pégourié-Gonnard000281e2018-08-21 11:20:58 +02003289#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH) && \
Jan Brucknerf482dcc2023-03-15 09:09:06 +01003290 !defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT) && \
Manuel Pégourié-Gonnard000281e2018-08-21 11:20:58 +02003291 !defined(MBEDTLS_SSL_PROTO_DTLS)
3292 (void) ssl;
3293#endif
3294
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003295#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01003296 const size_t mfl = mbedtls_ssl_get_output_max_frag_len(ssl);
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003297
Gilles Peskine449bd832023-01-11 14:50:10 +01003298 if (max_len > mfl) {
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003299 max_len = mfl;
Gilles Peskine449bd832023-01-11 14:50:10 +01003300 }
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003301#endif
3302
Jan Brucknerf482dcc2023-03-15 09:09:06 +01003303#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
3304 const size_t record_size_limit = mbedtls_ssl_get_output_record_size_limit(ssl);
3305
3306 if (max_len > record_size_limit) {
3307 max_len = record_size_limit;
3308 }
3309#endif
3310
Waleed Elmelegy6a971fd2023-12-28 17:48:16 +00003311 if (ssl->transform_out != NULL &&
3312 ssl->transform_out->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Waleed Elmelegyf5017902024-01-09 14:18:34 +00003313 /*
3314 * In TLS 1.3 case, when records are protected, `max_len` as computed
3315 * above is the maximum length of the TLSInnerPlaintext structure that
3316 * along the plaintext payload contains the inner content type (one byte)
3317 * and some zero padding. Given the algorithm used for padding
3318 * in mbedtls_ssl_encrypt_buf(), compute the maximum length for
3319 * the plaintext payload. Round down to a multiple of
3320 * MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY and
3321 * subtract 1.
Waleed Elmelegy6a971fd2023-12-28 17:48:16 +00003322 */
3323 max_len = ((max_len / MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY) *
3324 MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY) - 1;
3325 }
3326
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003327#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003328 if (mbedtls_ssl_get_current_mtu(ssl) != 0) {
3329 const size_t mtu = mbedtls_ssl_get_current_mtu(ssl);
3330 const int ret = mbedtls_ssl_get_record_expansion(ssl);
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003331 const size_t overhead = (size_t) ret;
3332
Gilles Peskine449bd832023-01-11 14:50:10 +01003333 if (ret < 0) {
3334 return ret;
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003335 }
3336
Gilles Peskine449bd832023-01-11 14:50:10 +01003337 if (mtu <= overhead) {
3338 MBEDTLS_SSL_DEBUG_MSG(1, ("MTU too low for record expansion"));
3339 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
3340 }
3341
3342 if (max_len > mtu - overhead) {
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003343 max_len = mtu - overhead;
Gilles Peskine449bd832023-01-11 14:50:10 +01003344 }
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003345 }
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003346#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003347
Hanno Becker0defedb2018-08-10 12:35:02 +01003348#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH) && \
Waleed Elmelegy049cd302023-12-20 17:28:31 +00003349 !defined(MBEDTLS_SSL_PROTO_DTLS) && \
3350 !defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
Hanno Becker0defedb2018-08-10 12:35:02 +01003351 ((void) ssl);
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003352#endif
3353
Gilles Peskine449bd832023-01-11 14:50:10 +01003354 return (int) max_len;
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003355}
3356
Gilles Peskine449bd832023-01-11 14:50:10 +01003357int mbedtls_ssl_get_max_in_record_payload(const mbedtls_ssl_context *ssl)
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003358{
3359 size_t max_len = MBEDTLS_SSL_IN_CONTENT_LEN;
3360
3361#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
3362 (void) ssl;
3363#endif
3364
3365#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01003366 const size_t mfl = mbedtls_ssl_get_input_max_frag_len(ssl);
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003367
Gilles Peskine449bd832023-01-11 14:50:10 +01003368 if (max_len > mfl) {
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003369 max_len = mfl;
Gilles Peskine449bd832023-01-11 14:50:10 +01003370 }
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003371#endif
3372
Gilles Peskine449bd832023-01-11 14:50:10 +01003373 return (int) max_len;
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003374}
3375
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003376#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01003377const mbedtls_x509_crt *mbedtls_ssl_get_peer_cert(const mbedtls_ssl_context *ssl)
Paul Bakkerb0550d92012-10-30 07:51:03 +00003378{
Gilles Peskine449bd832023-01-11 14:50:10 +01003379 if (ssl == NULL || ssl->session == NULL) {
3380 return NULL;
3381 }
Paul Bakkerb0550d92012-10-30 07:51:03 +00003382
Hanno Beckere6824572019-02-07 13:18:46 +00003383#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01003384 return ssl->session->peer_cert;
Hanno Beckere6824572019-02-07 13:18:46 +00003385#else
Gilles Peskine449bd832023-01-11 14:50:10 +01003386 return NULL;
Hanno Beckere6824572019-02-07 13:18:46 +00003387#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Paul Bakkerb0550d92012-10-30 07:51:03 +00003388}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003389#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkerb0550d92012-10-30 07:51:03 +00003390
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003391#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01003392int mbedtls_ssl_get_session(const mbedtls_ssl_context *ssl,
3393 mbedtls_ssl_session *dst)
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003394{
Hanno Beckere810bbc2021-05-14 16:01:05 +01003395 int ret;
3396
Gilles Peskine449bd832023-01-11 14:50:10 +01003397 if (ssl == NULL ||
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003398 dst == NULL ||
3399 ssl->session == NULL ||
Gilles Peskine449bd832023-01-11 14:50:10 +01003400 ssl->conf->endpoint != MBEDTLS_SSL_IS_CLIENT) {
3401 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003402 }
3403
Hanno Beckere810bbc2021-05-14 16:01:05 +01003404 /* Since Mbed TLS 3.0, mbedtls_ssl_get_session() is no longer
3405 * idempotent: Each session can only be exported once.
3406 *
3407 * (This is in preparation for TLS 1.3 support where we will
3408 * need the ability to export multiple sessions (aka tickets),
3409 * which will be achieved by calling mbedtls_ssl_get_session()
3410 * multiple times until it fails.)
3411 *
3412 * Check whether we have already exported the current session,
3413 * and fail if so.
3414 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003415 if (ssl->session->exported == 1) {
3416 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
3417 }
Hanno Beckere810bbc2021-05-14 16:01:05 +01003418
Gilles Peskine449bd832023-01-11 14:50:10 +01003419 ret = mbedtls_ssl_session_copy(dst, ssl->session);
3420 if (ret != 0) {
3421 return ret;
3422 }
Hanno Beckere810bbc2021-05-14 16:01:05 +01003423
3424 /* Remember that we've exported the session. */
3425 ssl->session->exported = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01003426 return 0;
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003427}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003428#endif /* MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003429
David Horstmanncb01b362024-02-29 17:31:46 +00003430#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
3431
3432/* Serialization of TLS 1.2 sessions
David Horstmanne59f9702024-02-29 16:08:57 +00003433 *
David Horstmanncb01b362024-02-29 17:31:46 +00003434 * For more detail, see the description of ssl_session_save().
David Horstmanne59f9702024-02-29 16:08:57 +00003435 */
3436static size_t ssl_tls12_session_save(const mbedtls_ssl_session *session,
3437 unsigned char *buf,
3438 size_t buf_len)
3439{
3440 unsigned char *p = buf;
3441 size_t used = 0;
3442
3443#if defined(MBEDTLS_HAVE_TIME)
3444 uint64_t start;
3445#endif
3446#if defined(MBEDTLS_X509_CRT_PARSE_C)
3447#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
3448 size_t cert_len;
3449#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3450#endif /* MBEDTLS_X509_CRT_PARSE_C */
3451
3452 /*
3453 * Time
3454 */
3455#if defined(MBEDTLS_HAVE_TIME)
3456 used += 8;
3457
3458 if (used <= buf_len) {
3459 start = (uint64_t) session->start;
3460
3461 MBEDTLS_PUT_UINT64_BE(start, p, 0);
3462 p += 8;
3463 }
3464#endif /* MBEDTLS_HAVE_TIME */
3465
3466 /*
3467 * Basic mandatory fields
3468 */
3469 used += 1 /* id_len */
3470 + sizeof(session->id)
3471 + sizeof(session->master)
3472 + 4; /* verify_result */
3473
3474 if (used <= buf_len) {
3475 *p++ = MBEDTLS_BYTE_0(session->id_len);
3476 memcpy(p, session->id, 32);
3477 p += 32;
3478
3479 memcpy(p, session->master, 48);
3480 p += 48;
3481
3482 MBEDTLS_PUT_UINT32_BE(session->verify_result, p, 0);
3483 p += 4;
3484 }
3485
3486 /*
3487 * Peer's end-entity certificate
3488 */
3489#if defined(MBEDTLS_X509_CRT_PARSE_C)
3490#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
3491 if (session->peer_cert == NULL) {
3492 cert_len = 0;
3493 } else {
3494 cert_len = session->peer_cert->raw.len;
3495 }
3496
3497 used += 3 + cert_len;
3498
3499 if (used <= buf_len) {
3500 *p++ = MBEDTLS_BYTE_2(cert_len);
3501 *p++ = MBEDTLS_BYTE_1(cert_len);
3502 *p++ = MBEDTLS_BYTE_0(cert_len);
3503
3504 if (session->peer_cert != NULL) {
3505 memcpy(p, session->peer_cert->raw.p, cert_len);
3506 p += cert_len;
3507 }
3508 }
3509#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3510 if (session->peer_cert_digest != NULL) {
3511 used += 1 /* type */ + 1 /* length */ + session->peer_cert_digest_len;
3512 if (used <= buf_len) {
3513 *p++ = (unsigned char) session->peer_cert_digest_type;
3514 *p++ = (unsigned char) session->peer_cert_digest_len;
3515 memcpy(p, session->peer_cert_digest,
3516 session->peer_cert_digest_len);
3517 p += session->peer_cert_digest_len;
3518 }
3519 } else {
3520 used += 2;
3521 if (used <= buf_len) {
3522 *p++ = (unsigned char) MBEDTLS_MD_NONE;
3523 *p++ = 0;
3524 }
3525 }
3526#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3527#endif /* MBEDTLS_X509_CRT_PARSE_C */
3528
3529 /*
3530 * Session ticket if any, plus associated data
3531 */
3532#if defined(MBEDTLS_SSL_SESSION_TICKETS)
3533#if defined(MBEDTLS_SSL_CLI_C)
3534 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
3535 used += 3 + session->ticket_len + 4; /* len + ticket + lifetime */
3536
3537 if (used <= buf_len) {
3538 *p++ = MBEDTLS_BYTE_2(session->ticket_len);
3539 *p++ = MBEDTLS_BYTE_1(session->ticket_len);
3540 *p++ = MBEDTLS_BYTE_0(session->ticket_len);
3541
3542 if (session->ticket != NULL) {
3543 memcpy(p, session->ticket, session->ticket_len);
3544 p += session->ticket_len;
3545 }
3546
3547 MBEDTLS_PUT_UINT32_BE(session->ticket_lifetime, p, 0);
3548 p += 4;
3549 }
3550 }
3551#endif /* MBEDTLS_SSL_CLI_C */
3552#if defined(MBEDTLS_HAVE_TIME) && defined(MBEDTLS_SSL_SRV_C)
3553 if (session->endpoint == MBEDTLS_SSL_IS_SERVER) {
3554 used += 8;
3555
3556 if (used <= buf_len) {
3557 MBEDTLS_PUT_UINT64_BE((uint64_t) session->ticket_creation_time, p, 0);
3558 p += 8;
3559 }
3560 }
3561#endif /* MBEDTLS_HAVE_TIME && MBEDTLS_SSL_SRV_C */
3562#endif /* MBEDTLS_SSL_SESSION_TICKETS */
3563
3564 /*
3565 * Misc extension-related info
3566 */
3567#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
3568 used += 1;
3569
3570 if (used <= buf_len) {
3571 *p++ = session->mfl_code;
3572 }
3573#endif
3574
3575#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
3576 used += 1;
3577
3578 if (used <= buf_len) {
3579 *p++ = MBEDTLS_BYTE_0(session->encrypt_then_mac);
3580 }
3581#endif
3582
3583 return used;
3584}
3585
3586MBEDTLS_CHECK_RETURN_CRITICAL
3587static int ssl_tls12_session_load(mbedtls_ssl_session *session,
3588 const unsigned char *buf,
3589 size_t len)
3590{
3591#if defined(MBEDTLS_HAVE_TIME)
3592 uint64_t start;
3593#endif
3594#if defined(MBEDTLS_X509_CRT_PARSE_C)
3595#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
3596 size_t cert_len;
3597#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3598#endif /* MBEDTLS_X509_CRT_PARSE_C */
3599
3600 const unsigned char *p = buf;
3601 const unsigned char * const end = buf + len;
3602
3603 /*
3604 * Time
3605 */
3606#if defined(MBEDTLS_HAVE_TIME)
3607 if (8 > (size_t) (end - p)) {
3608 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3609 }
3610
3611 start = MBEDTLS_GET_UINT64_BE(p, 0);
3612 p += 8;
3613
3614 session->start = (time_t) start;
3615#endif /* MBEDTLS_HAVE_TIME */
3616
3617 /*
3618 * Basic mandatory fields
3619 */
3620 if (1 + 32 + 48 + 4 > (size_t) (end - p)) {
3621 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3622 }
3623
3624 session->id_len = *p++;
3625 memcpy(session->id, p, 32);
3626 p += 32;
3627
3628 memcpy(session->master, p, 48);
3629 p += 48;
3630
3631 session->verify_result = MBEDTLS_GET_UINT32_BE(p, 0);
3632 p += 4;
3633
3634 /* Immediately clear invalid pointer values that have been read, in case
3635 * we exit early before we replaced them with valid ones. */
3636#if defined(MBEDTLS_X509_CRT_PARSE_C)
3637#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
3638 session->peer_cert = NULL;
3639#else
3640 session->peer_cert_digest = NULL;
3641#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3642#endif /* MBEDTLS_X509_CRT_PARSE_C */
3643#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
3644 session->ticket = NULL;
3645#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
3646
3647 /*
3648 * Peer certificate
3649 */
3650#if defined(MBEDTLS_X509_CRT_PARSE_C)
3651#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
3652 /* Deserialize CRT from the end of the ticket. */
3653 if (3 > (size_t) (end - p)) {
3654 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3655 }
3656
3657 cert_len = MBEDTLS_GET_UINT24_BE(p, 0);
3658 p += 3;
3659
3660 if (cert_len != 0) {
3661 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
3662
3663 if (cert_len > (size_t) (end - p)) {
3664 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3665 }
3666
3667 session->peer_cert = mbedtls_calloc(1, sizeof(mbedtls_x509_crt));
3668
3669 if (session->peer_cert == NULL) {
3670 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
3671 }
3672
3673 mbedtls_x509_crt_init(session->peer_cert);
3674
3675 if ((ret = mbedtls_x509_crt_parse_der(session->peer_cert,
3676 p, cert_len)) != 0) {
3677 mbedtls_x509_crt_free(session->peer_cert);
3678 mbedtls_free(session->peer_cert);
3679 session->peer_cert = NULL;
3680 return ret;
3681 }
3682
3683 p += cert_len;
3684 }
3685#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3686 /* Deserialize CRT digest from the end of the ticket. */
3687 if (2 > (size_t) (end - p)) {
3688 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3689 }
3690
3691 session->peer_cert_digest_type = (mbedtls_md_type_t) *p++;
3692 session->peer_cert_digest_len = (size_t) *p++;
3693
3694 if (session->peer_cert_digest_len != 0) {
3695 const mbedtls_md_info_t *md_info =
3696 mbedtls_md_info_from_type(session->peer_cert_digest_type);
3697 if (md_info == NULL) {
3698 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3699 }
3700 if (session->peer_cert_digest_len != mbedtls_md_get_size(md_info)) {
3701 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3702 }
3703
3704 if (session->peer_cert_digest_len > (size_t) (end - p)) {
3705 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3706 }
3707
3708 session->peer_cert_digest =
3709 mbedtls_calloc(1, session->peer_cert_digest_len);
3710 if (session->peer_cert_digest == NULL) {
3711 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
3712 }
3713
3714 memcpy(session->peer_cert_digest, p,
3715 session->peer_cert_digest_len);
3716 p += session->peer_cert_digest_len;
3717 }
3718#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3719#endif /* MBEDTLS_X509_CRT_PARSE_C */
3720
3721 /*
3722 * Session ticket and associated data
3723 */
3724#if defined(MBEDTLS_SSL_SESSION_TICKETS)
3725#if defined(MBEDTLS_SSL_CLI_C)
3726 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
3727 if (3 > (size_t) (end - p)) {
3728 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3729 }
3730
3731 session->ticket_len = MBEDTLS_GET_UINT24_BE(p, 0);
3732 p += 3;
3733
3734 if (session->ticket_len != 0) {
3735 if (session->ticket_len > (size_t) (end - p)) {
3736 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3737 }
3738
3739 session->ticket = mbedtls_calloc(1, session->ticket_len);
3740 if (session->ticket == NULL) {
3741 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
3742 }
3743
3744 memcpy(session->ticket, p, session->ticket_len);
3745 p += session->ticket_len;
3746 }
3747
3748 if (4 > (size_t) (end - p)) {
3749 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3750 }
3751
3752 session->ticket_lifetime = MBEDTLS_GET_UINT32_BE(p, 0);
3753 p += 4;
3754 }
3755#endif /* MBEDTLS_SSL_CLI_C */
3756#if defined(MBEDTLS_HAVE_TIME) && defined(MBEDTLS_SSL_SRV_C)
3757 if (session->endpoint == MBEDTLS_SSL_IS_SERVER) {
3758 if (8 > (size_t) (end - p)) {
3759 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3760 }
3761 session->ticket_creation_time = MBEDTLS_GET_UINT64_BE(p, 0);
3762 p += 8;
3763 }
3764#endif /* MBEDTLS_HAVE_TIME && MBEDTLS_SSL_SRV_C */
3765#endif /* MBEDTLS_SSL_SESSION_TICKETS */
3766
3767 /*
3768 * Misc extension-related info
3769 */
3770#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
3771 if (1 > (size_t) (end - p)) {
3772 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3773 }
3774
3775 session->mfl_code = *p++;
3776#endif
3777
3778#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
3779 if (1 > (size_t) (end - p)) {
3780 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3781 }
3782
3783 session->encrypt_then_mac = *p++;
3784#endif
3785
3786 /* Done, should have consumed entire buffer */
3787 if (p != end) {
3788 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3789 }
3790
3791 return 0;
3792}
3793
3794#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
3795
3796#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
3797/* Serialization of TLS 1.3 sessions:
3798 *
David Horstmanncb01b362024-02-29 17:31:46 +00003799 * For more detail, see the description of ssl_session_save().
David Horstmanne59f9702024-02-29 16:08:57 +00003800 */
3801#if defined(MBEDTLS_SSL_SESSION_TICKETS)
3802MBEDTLS_CHECK_RETURN_CRITICAL
3803static int ssl_tls13_session_save(const mbedtls_ssl_session *session,
3804 unsigned char *buf,
3805 size_t buf_len,
3806 size_t *olen)
3807{
3808 unsigned char *p = buf;
3809#if defined(MBEDTLS_SSL_CLI_C) && \
3810 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
3811 size_t hostname_len = (session->hostname == NULL) ?
3812 0 : strlen(session->hostname) + 1;
3813#endif
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003814
3815#if defined(MBEDTLS_SSL_SRV_C) && \
3816 defined(MBEDTLS_SSL_EARLY_DATA) && defined(MBEDTLS_SSL_ALPN)
Waleed Elmelegydaa4da72024-03-13 16:25:34 +00003817 const size_t alpn_len = (session->ticket_alpn == NULL) ?
Waleed Elmelegyb28ab0a2024-03-13 16:48:28 +00003818 0 : strlen(session->ticket_alpn) + 1;
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003819#endif
David Horstmanne59f9702024-02-29 16:08:57 +00003820 size_t needed = 4 /* ticket_age_add */
3821 + 1 /* ticket_flags */
3822 + 1; /* resumption_key length */
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003823
David Horstmanne59f9702024-02-29 16:08:57 +00003824 *olen = 0;
3825
3826 if (session->resumption_key_len > MBEDTLS_SSL_TLS1_3_TICKET_RESUMPTION_KEY_LEN) {
3827 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3828 }
3829 needed += session->resumption_key_len; /* resumption_key */
3830
3831#if defined(MBEDTLS_SSL_EARLY_DATA)
3832 needed += 4; /* max_early_data_size */
3833#endif
3834#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
3835 needed += 2; /* record_size_limit */
3836#endif /* MBEDTLS_SSL_RECORD_SIZE_LIMIT */
3837
3838#if defined(MBEDTLS_HAVE_TIME)
3839 needed += 8; /* ticket_creation_time or ticket_reception_time */
3840#endif
3841
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003842#if defined(MBEDTLS_SSL_SRV_C)
3843 if (session->endpoint == MBEDTLS_SSL_IS_SERVER) {
3844#if defined(MBEDTLS_SSL_EARLY_DATA) && defined(MBEDTLS_SSL_ALPN)
Waleed Elmelegydaa4da72024-03-13 16:25:34 +00003845 needed += 2 /* alpn_len */
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003846 + alpn_len; /* alpn */
3847#endif
3848 }
3849#endif /* MBEDTLS_SSL_SRV_C */
3850
David Horstmanne59f9702024-02-29 16:08:57 +00003851#if defined(MBEDTLS_SSL_CLI_C)
3852 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
3853#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
3854 needed += 2 /* hostname_len */
3855 + hostname_len; /* hostname */
3856#endif
3857
3858 needed += 4 /* ticket_lifetime */
3859 + 2; /* ticket_len */
3860
3861 /* Check size_t overflow */
3862 if (session->ticket_len > SIZE_MAX - needed) {
3863 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3864 }
3865
3866 needed += session->ticket_len; /* ticket */
3867 }
3868#endif /* MBEDTLS_SSL_CLI_C */
3869
3870 *olen = needed;
3871 if (needed > buf_len) {
3872 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
3873 }
3874
3875 MBEDTLS_PUT_UINT32_BE(session->ticket_age_add, p, 0);
3876 p[4] = session->ticket_flags;
3877
3878 /* save resumption_key */
3879 p[5] = session->resumption_key_len;
3880 p += 6;
3881 memcpy(p, session->resumption_key, session->resumption_key_len);
3882 p += session->resumption_key_len;
3883
3884#if defined(MBEDTLS_SSL_EARLY_DATA)
3885 MBEDTLS_PUT_UINT32_BE(session->max_early_data_size, p, 0);
3886 p += 4;
3887#endif
3888#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
3889 MBEDTLS_PUT_UINT16_BE(session->record_size_limit, p, 0);
3890 p += 2;
3891#endif /* MBEDTLS_SSL_RECORD_SIZE_LIMIT */
3892
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003893#if defined(MBEDTLS_SSL_SRV_C)
David Horstmanne59f9702024-02-29 16:08:57 +00003894 if (session->endpoint == MBEDTLS_SSL_IS_SERVER) {
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003895#if defined(MBEDTLS_HAVE_TIME)
David Horstmanne59f9702024-02-29 16:08:57 +00003896 MBEDTLS_PUT_UINT64_BE((uint64_t) session->ticket_creation_time, p, 0);
3897 p += 8;
David Horstmanne59f9702024-02-29 16:08:57 +00003898#endif /* MBEDTLS_HAVE_TIME */
3899
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003900#if defined(MBEDTLS_SSL_EARLY_DATA) && defined(MBEDTLS_SSL_ALPN)
Waleed Elmelegydaa4da72024-03-13 16:25:34 +00003901 MBEDTLS_PUT_UINT16_BE(alpn_len, p, 0);
3902 p += 2;
3903
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003904 if (alpn_len > 0) {
3905 /* save chosen alpn */
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00003906 memcpy(p, session->ticket_alpn, alpn_len);
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003907 p += alpn_len;
3908 }
3909#endif /* MBEDTLS_SSL_EARLY_DATA && MBEDTLS_SSL_ALPN */
3910 }
3911#endif /* MBEDTLS_SSL_SRV_C */
3912
David Horstmanne59f9702024-02-29 16:08:57 +00003913#if defined(MBEDTLS_SSL_CLI_C)
3914 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
3915#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
3916 MBEDTLS_PUT_UINT16_BE(hostname_len, p, 0);
3917 p += 2;
3918 if (hostname_len > 0) {
3919 /* save host name */
3920 memcpy(p, session->hostname, hostname_len);
3921 p += hostname_len;
3922 }
3923#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
3924
3925#if defined(MBEDTLS_HAVE_TIME)
3926 MBEDTLS_PUT_UINT64_BE((uint64_t) session->ticket_reception_time, p, 0);
3927 p += 8;
3928#endif
3929 MBEDTLS_PUT_UINT32_BE(session->ticket_lifetime, p, 0);
3930 p += 4;
3931
3932 MBEDTLS_PUT_UINT16_BE(session->ticket_len, p, 0);
3933 p += 2;
3934
3935 if (session->ticket != NULL && session->ticket_len > 0) {
3936 memcpy(p, session->ticket, session->ticket_len);
3937 p += session->ticket_len;
3938 }
3939 }
3940#endif /* MBEDTLS_SSL_CLI_C */
3941 return 0;
3942}
3943
3944MBEDTLS_CHECK_RETURN_CRITICAL
3945static int ssl_tls13_session_load(mbedtls_ssl_session *session,
3946 const unsigned char *buf,
3947 size_t len)
3948{
3949 const unsigned char *p = buf;
3950 const unsigned char *end = buf + len;
3951
3952 if (end - p < 6) {
3953 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3954 }
3955 session->ticket_age_add = MBEDTLS_GET_UINT32_BE(p, 0);
3956 session->ticket_flags = p[4];
3957
3958 /* load resumption_key */
3959 session->resumption_key_len = p[5];
3960 p += 6;
3961
3962 if (end - p < session->resumption_key_len) {
3963 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3964 }
3965
3966 if (sizeof(session->resumption_key) < session->resumption_key_len) {
3967 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3968 }
3969 memcpy(session->resumption_key, p, session->resumption_key_len);
3970 p += session->resumption_key_len;
3971
3972#if defined(MBEDTLS_SSL_EARLY_DATA)
3973 if (end - p < 4) {
3974 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3975 }
3976 session->max_early_data_size = MBEDTLS_GET_UINT32_BE(p, 0);
3977 p += 4;
3978#endif
3979#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
3980 if (end - p < 2) {
3981 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3982 }
3983 session->record_size_limit = MBEDTLS_GET_UINT16_BE(p, 0);
3984 p += 2;
3985#endif /* MBEDTLS_SSL_RECORD_SIZE_LIMIT */
3986
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003987#if defined(MBEDTLS_SSL_SRV_C)
David Horstmanne59f9702024-02-29 16:08:57 +00003988 if (session->endpoint == MBEDTLS_SSL_IS_SERVER) {
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003989#if defined(MBEDTLS_HAVE_TIME)
David Horstmanne59f9702024-02-29 16:08:57 +00003990 if (end - p < 8) {
3991 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3992 }
3993 session->ticket_creation_time = MBEDTLS_GET_UINT64_BE(p, 0);
3994 p += 8;
David Horstmanne59f9702024-02-29 16:08:57 +00003995#endif /* MBEDTLS_HAVE_TIME */
3996
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003997#if defined(MBEDTLS_SSL_EARLY_DATA) && defined(MBEDTLS_SSL_ALPN)
Waleed Elmelegydaa4da72024-03-13 16:25:34 +00003998 size_t alpn_len;
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003999
Waleed Elmelegydaa4da72024-03-13 16:25:34 +00004000 if (end - p < 2) {
Waleed Elmelegy2824a202024-02-23 17:51:47 +00004001 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4002 }
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00004003
Waleed Elmelegydaa4da72024-03-13 16:25:34 +00004004 alpn_len = MBEDTLS_GET_UINT16_BE(p, 0);
4005 p += 2;
4006
4007 if (end - p < (long int) alpn_len) {
Waleed Elmelegy7dfba342024-03-12 16:22:39 +00004008 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4009 }
4010
Waleed Elmelegy2824a202024-02-23 17:51:47 +00004011 if (alpn_len > 0) {
Waleed Elmelegydaa4da72024-03-13 16:25:34 +00004012 int ret = mbedtls_ssl_session_set_ticket_alpn(session, (char *) p);
4013 if (ret != 0) {
4014 return ret;
Waleed Elmelegy2824a202024-02-23 17:51:47 +00004015 }
Waleed Elmelegy2824a202024-02-23 17:51:47 +00004016 p += alpn_len;
4017 }
4018#endif /* MBEDTLS_SSL_EARLY_DATA && MBEDTLS_SSL_ALPN */
4019 }
4020#endif /* MBEDTLS_SSL_SRV_C */
4021
David Horstmanne59f9702024-02-29 16:08:57 +00004022#if defined(MBEDTLS_SSL_CLI_C)
4023 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
4024#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
4025 size_t hostname_len;
4026 /* load host name */
4027 if (end - p < 2) {
4028 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4029 }
4030 hostname_len = MBEDTLS_GET_UINT16_BE(p, 0);
4031 p += 2;
4032
4033 if (end - p < (long int) hostname_len) {
4034 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4035 }
4036 if (hostname_len > 0) {
4037 session->hostname = mbedtls_calloc(1, hostname_len);
4038 if (session->hostname == NULL) {
4039 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
4040 }
4041 memcpy(session->hostname, p, hostname_len);
4042 p += hostname_len;
4043 }
4044#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
4045
4046#if defined(MBEDTLS_HAVE_TIME)
4047 if (end - p < 8) {
4048 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4049 }
4050 session->ticket_reception_time = MBEDTLS_GET_UINT64_BE(p, 0);
4051 p += 8;
4052#endif
4053 if (end - p < 4) {
4054 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4055 }
4056 session->ticket_lifetime = MBEDTLS_GET_UINT32_BE(p, 0);
4057 p += 4;
4058
4059 if (end - p < 2) {
4060 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4061 }
4062 session->ticket_len = MBEDTLS_GET_UINT16_BE(p, 0);
4063 p += 2;
4064
4065 if (end - p < (long int) session->ticket_len) {
4066 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4067 }
4068 if (session->ticket_len > 0) {
4069 session->ticket = mbedtls_calloc(1, session->ticket_len);
4070 if (session->ticket == NULL) {
4071 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
4072 }
4073 memcpy(session->ticket, p, session->ticket_len);
4074 p += session->ticket_len;
4075 }
4076 }
4077#endif /* MBEDTLS_SSL_CLI_C */
4078
4079 return 0;
4080
4081}
4082#else /* MBEDTLS_SSL_SESSION_TICKETS */
4083MBEDTLS_CHECK_RETURN_CRITICAL
4084static int ssl_tls13_session_save(const mbedtls_ssl_session *session,
4085 unsigned char *buf,
4086 size_t buf_len,
4087 size_t *olen)
4088{
4089 ((void) session);
4090 ((void) buf);
4091 ((void) buf_len);
4092 *olen = 0;
4093 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
4094}
4095
4096static int ssl_tls13_session_load(const mbedtls_ssl_session *session,
Norbert Fabritius93b2c322023-01-24 17:48:29 +01004097 const unsigned char *buf,
David Horstmanne59f9702024-02-29 16:08:57 +00004098 size_t buf_len)
4099{
4100 ((void) session);
4101 ((void) buf);
4102 ((void) buf_len);
4103 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
4104}
4105#endif /* !MBEDTLS_SSL_SESSION_TICKETS */
4106#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
4107
Paul Bakker5121ce52009-01-03 21:22:43 +00004108/*
Hanno Beckera835da52019-05-16 12:39:07 +01004109 * Define ticket header determining Mbed TLS version
4110 * and structure of the ticket.
4111 */
4112
Hanno Becker94ef3b32019-05-16 12:50:45 +01004113/*
Hanno Becker50b59662019-05-28 14:30:45 +01004114 * Define bitflag determining compile-time settings influencing
4115 * structure of serialized SSL sessions.
Hanno Becker94ef3b32019-05-16 12:50:45 +01004116 */
4117
Hanno Becker50b59662019-05-28 14:30:45 +01004118#if defined(MBEDTLS_HAVE_TIME)
Hanno Becker3e088662019-05-29 11:10:18 +01004119#define SSL_SERIALIZED_SESSION_CONFIG_TIME 1
Hanno Becker50b59662019-05-28 14:30:45 +01004120#else
Hanno Becker3e088662019-05-29 11:10:18 +01004121#define SSL_SERIALIZED_SESSION_CONFIG_TIME 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01004122#endif /* MBEDTLS_HAVE_TIME */
4123
4124#if defined(MBEDTLS_X509_CRT_PARSE_C)
Hanno Becker3e088662019-05-29 11:10:18 +01004125#define SSL_SERIALIZED_SESSION_CONFIG_CRT 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01004126#else
Hanno Becker3e088662019-05-29 11:10:18 +01004127#define SSL_SERIALIZED_SESSION_CONFIG_CRT 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01004128#endif /* MBEDTLS_X509_CRT_PARSE_C */
4129
David Horstmann5c5a32f2024-02-13 17:53:35 +00004130#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
David Horstmannf686f1d2024-03-01 11:20:32 +00004131#define SSL_SERIALIZED_SESSION_CONFIG_KEEP_PEER_CRT 1
David Horstmann5c5a32f2024-02-13 17:53:35 +00004132#else
David Horstmannf686f1d2024-03-01 11:20:32 +00004133#define SSL_SERIALIZED_SESSION_CONFIG_KEEP_PEER_CRT 0
David Horstmann5c5a32f2024-02-13 17:53:35 +00004134#endif /* MBEDTLS_SSL_SESSION_TICKETS */
4135
Hanno Becker94ef3b32019-05-16 12:50:45 +01004136#if defined(MBEDTLS_SSL_CLI_C) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Hanno Becker3e088662019-05-29 11:10:18 +01004137#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01004138#else
Hanno Becker3e088662019-05-29 11:10:18 +01004139#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01004140#endif /* MBEDTLS_SSL_CLI_C && MBEDTLS_SSL_SESSION_TICKETS */
4141
4142#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Hanno Becker3e088662019-05-29 11:10:18 +01004143#define SSL_SERIALIZED_SESSION_CONFIG_MFL 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01004144#else
Hanno Becker3e088662019-05-29 11:10:18 +01004145#define SSL_SERIALIZED_SESSION_CONFIG_MFL 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01004146#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
4147
Hanno Becker94ef3b32019-05-16 12:50:45 +01004148#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Hanno Becker3e088662019-05-29 11:10:18 +01004149#define SSL_SERIALIZED_SESSION_CONFIG_ETM 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01004150#else
Hanno Becker3e088662019-05-29 11:10:18 +01004151#define SSL_SERIALIZED_SESSION_CONFIG_ETM 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01004152#endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC */
4153
Hanno Becker94ef3b32019-05-16 12:50:45 +01004154#if defined(MBEDTLS_SSL_SESSION_TICKETS)
4155#define SSL_SERIALIZED_SESSION_CONFIG_TICKET 1
4156#else
4157#define SSL_SERIALIZED_SESSION_CONFIG_TICKET 0
4158#endif /* MBEDTLS_SSL_SESSION_TICKETS */
4159
David Horstmann92b258b2024-02-13 17:23:34 +00004160#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
4161#define SSL_SERIALIZED_SESSION_CONFIG_SNI 1
4162#else
4163#define SSL_SERIALIZED_SESSION_CONFIG_SNI 0
4164#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
4165
4166#if defined(MBEDTLS_SSL_EARLY_DATA)
4167#define SSL_SERIALIZED_SESSION_CONFIG_EARLY_DATA 1
4168#else
4169#define SSL_SERIALIZED_SESSION_CONFIG_EARLY_DATA 0
4170#endif /* MBEDTLS_SSL_EARLY_DATA */
4171
4172#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
4173#define SSL_SERIALIZED_SESSION_CONFIG_RECORD_SIZE 1
4174#else
4175#define SSL_SERIALIZED_SESSION_CONFIG_RECORD_SIZE 0
4176#endif /* MBEDTLS_SSL_RECORD_SIZE_LIMIT */
4177
Waleed Elmelegy7dfba342024-03-12 16:22:39 +00004178#if defined(MBEDTLS_SSL_ALPN) && defined(MBEDTLS_SSL_SRV_C) && \
4179 defined(MBEDTLS_SSL_EARLY_DATA)
Waleed Elmelegy11025632024-03-07 15:25:52 +00004180#define SSL_SERIALIZED_SESSION_CONFIG_ALPN 1
4181#else
4182#define SSL_SERIALIZED_SESSION_CONFIG_ALPN 0
4183#endif /* MBEDTLS_SSL_ALPN */
4184
Hanno Becker3e088662019-05-29 11:10:18 +01004185#define SSL_SERIALIZED_SESSION_CONFIG_TIME_BIT 0
4186#define SSL_SERIALIZED_SESSION_CONFIG_CRT_BIT 1
4187#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET_BIT 2
4188#define SSL_SERIALIZED_SESSION_CONFIG_MFL_BIT 3
Hanno Becker37bdbe62021-08-01 05:38:58 +01004189#define SSL_SERIALIZED_SESSION_CONFIG_ETM_BIT 4
4190#define SSL_SERIALIZED_SESSION_CONFIG_TICKET_BIT 5
David Horstmannf686f1d2024-03-01 11:20:32 +00004191#define SSL_SERIALIZED_SESSION_CONFIG_KEEP_PEER_CRT_BIT 6
David Horstmann92b258b2024-02-13 17:23:34 +00004192#define SSL_SERIALIZED_SESSION_CONFIG_SNI_BIT 7
4193#define SSL_SERIALIZED_SESSION_CONFIG_EARLY_DATA_BIT 8
4194#define SSL_SERIALIZED_SESSION_CONFIG_RECORD_SIZE_BIT 9
Waleed Elmelegy11025632024-03-07 15:25:52 +00004195#define SSL_SERIALIZED_SESSION_CONFIG_ALPN_BIT 10
Hanno Becker3e088662019-05-29 11:10:18 +01004196
Hanno Becker50b59662019-05-28 14:30:45 +01004197#define SSL_SERIALIZED_SESSION_CONFIG_BITFLAG \
Gilles Peskine449bd832023-01-11 14:50:10 +01004198 ((uint16_t) ( \
4199 (SSL_SERIALIZED_SESSION_CONFIG_TIME << SSL_SERIALIZED_SESSION_CONFIG_TIME_BIT) | \
4200 (SSL_SERIALIZED_SESSION_CONFIG_CRT << SSL_SERIALIZED_SESSION_CONFIG_CRT_BIT) | \
4201 (SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET << \
4202 SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET_BIT) | \
4203 (SSL_SERIALIZED_SESSION_CONFIG_MFL << SSL_SERIALIZED_SESSION_CONFIG_MFL_BIT) | \
4204 (SSL_SERIALIZED_SESSION_CONFIG_ETM << SSL_SERIALIZED_SESSION_CONFIG_ETM_BIT) | \
David Horstmann5c5a32f2024-02-13 17:53:35 +00004205 (SSL_SERIALIZED_SESSION_CONFIG_TICKET << SSL_SERIALIZED_SESSION_CONFIG_TICKET_BIT) | \
David Horstmann71fa1a92024-03-01 12:32:18 +00004206 (SSL_SERIALIZED_SESSION_CONFIG_KEEP_PEER_CRT << \
4207 SSL_SERIALIZED_SESSION_CONFIG_KEEP_PEER_CRT_BIT) | \
David Horstmann92b258b2024-02-13 17:23:34 +00004208 (SSL_SERIALIZED_SESSION_CONFIG_SNI << SSL_SERIALIZED_SESSION_CONFIG_SNI_BIT) | \
4209 (SSL_SERIALIZED_SESSION_CONFIG_EARLY_DATA << \
4210 SSL_SERIALIZED_SESSION_CONFIG_EARLY_DATA_BIT) | \
4211 (SSL_SERIALIZED_SESSION_CONFIG_RECORD_SIZE << \
Waleed Elmelegy11025632024-03-07 15:25:52 +00004212 SSL_SERIALIZED_SESSION_CONFIG_RECORD_SIZE_BIT) | \
Waleed Elmelegy75e33fa2024-03-07 16:57:58 +00004213 (SSL_SERIALIZED_SESSION_CONFIG_ALPN << \
Waleed Elmelegy11025632024-03-07 15:25:52 +00004214 SSL_SERIALIZED_SESSION_CONFIG_ALPN_BIT)))
Hanno Becker94ef3b32019-05-16 12:50:45 +01004215
Chien Wong4e9683e2023-12-28 17:07:43 +08004216static const unsigned char ssl_serialized_session_header[] = {
Hanno Becker94ef3b32019-05-16 12:50:45 +01004217 MBEDTLS_VERSION_MAJOR,
4218 MBEDTLS_VERSION_MINOR,
4219 MBEDTLS_VERSION_PATCH,
Gilles Peskine449bd832023-01-11 14:50:10 +01004220 MBEDTLS_BYTE_1(SSL_SERIALIZED_SESSION_CONFIG_BITFLAG),
4221 MBEDTLS_BYTE_0(SSL_SERIALIZED_SESSION_CONFIG_BITFLAG),
Hanno Beckerf8787072019-05-16 12:41:07 +01004222};
Hanno Beckera835da52019-05-16 12:39:07 +01004223
4224/*
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004225 * Serialize a session in the following format:
Manuel Pégourié-Gonnard35eb8022019-05-16 11:11:08 +02004226 * (in the presentation language of TLS, RFC 8446 section 3)
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004227 *
David Horstmanncb01b362024-02-29 17:31:46 +00004228 * TLS 1.2 session:
4229 *
4230 * struct {
4231 * #if defined(MBEDTLS_SSL_SESSION_TICKETS)
4232 * opaque ticket<0..2^24-1>; // length 0 means no ticket
4233 * uint32 ticket_lifetime;
4234 * #endif
4235 * } ClientOnlyData;
4236 *
4237 * struct {
4238 * #if defined(MBEDTLS_HAVE_TIME)
4239 * uint64 start_time;
4240 * #endif
4241 * uint8 session_id_len; // at most 32
4242 * opaque session_id[32];
4243 * opaque master[48]; // fixed length in the standard
4244 * uint32 verify_result;
4245 * #if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
4246 * opaque peer_cert<0..2^24-1>; // length 0 means no peer cert
4247 * #else
David Horstmann76ba26a2024-03-01 12:03:35 +00004248 * uint8 peer_cert_digest_type;
David Horstmanncb01b362024-02-29 17:31:46 +00004249 * opaque peer_cert_digest<0..2^8-1>
4250 * #endif
4251 * select (endpoint) {
4252 * case client: ClientOnlyData;
4253 * case server: uint64 ticket_creation_time;
4254 * };
4255 * #if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
4256 * uint8 mfl_code; // up to 255 according to standard
4257 * #endif
4258 * #if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
4259 * uint8 encrypt_then_mac; // 0 or 1
4260 * #endif
4261 * } serialized_session_tls12;
4262 *
4263 *
4264 * TLS 1.3 Session:
4265 *
4266 * struct {
4267 * #if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
4268 * opaque hostname<0..2^16-1>;
4269 * #endif
4270 * #if defined(MBEDTLS_HAVE_TIME)
4271 * uint64 ticket_reception_time;
4272 * #endif
4273 * uint32 ticket_lifetime;
4274 * opaque ticket<1..2^16-1>;
4275 * } ClientOnlyData;
4276 *
4277 * struct {
4278 * uint32 ticket_age_add;
4279 * uint8 ticket_flags;
4280 * opaque resumption_key<0..255>;
4281 * #if defined(MBEDTLS_SSL_EARLY_DATA)
4282 * uint32 max_early_data_size;
4283 * #endif
4284 * #if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
4285 * uint16 record_size_limit;
4286 * #endif
4287 * select ( endpoint ) {
4288 * case client: ClientOnlyData;
Waleed Elmelegy7dfba342024-03-12 16:22:39 +00004289 * case server:
David Horstmanncb01b362024-02-29 17:31:46 +00004290 * #if defined(MBEDTLS_HAVE_TIME)
Waleed Elmelegy7dfba342024-03-12 16:22:39 +00004291 * uint64 ticket_creation_time;
David Horstmanncb01b362024-02-29 17:31:46 +00004292 * #endif
Waleed Elmelegyfe9ae082024-03-07 15:47:31 +00004293 * #if defined(MBEDTLS_SSL_EARLY_DATA) && defined(MBEDTLS_SSL_ALPN)
Waleed Elmelegydaa4da72024-03-13 16:25:34 +00004294 * opaque ticket_alpn<0..256>;
David Horstmanncb01b362024-02-29 17:31:46 +00004295 * #endif
4296 * };
4297 * } serialized_session_tls13;
4298 *
4299 *
4300 * SSL session:
4301 *
4302 * struct {
Hanno Beckerdc28b6c2019-05-29 11:08:00 +01004303 *
Hanno Beckerdce50972021-08-01 05:39:23 +01004304 * opaque mbedtls_version[3]; // library version: major, minor, patch
4305 * opaque session_format[2]; // library-version specific 16-bit field
4306 * // determining the format of the remaining
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004307 * // serialized data.
Hanno Beckerdc28b6c2019-05-29 11:08:00 +01004308 *
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004309 * Note: When updating the format, remember to keep
4310 * these version+format bytes.
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004311 *
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004312 * // In this version, `session_format` determines
4313 * // the setting of those compile-time
4314 * // configuration options which influence
4315 * // the structure of mbedtls_ssl_session.
4316 *
Glenn Straussda7851c2022-03-14 13:29:48 -04004317 * uint8_t minor_ver; // Protocol minor version. Possible values:
Jerry Yu0c2a7382022-12-06 13:27:25 +08004318 * // - TLS 1.2 (0x0303)
4319 * // - TLS 1.3 (0x0304)
David Horstmann531aca22024-02-29 18:14:28 +00004320 * uint8_t endpoint;
4321 * uint16_t ciphersuite;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004322 *
Glenn Straussda7851c2022-03-14 13:29:48 -04004323 * select (serialized_session.tls_version) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004324 *
Glenn Straussda7851c2022-03-14 13:29:48 -04004325 * case MBEDTLS_SSL_VERSION_TLS1_2:
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004326 * serialized_session_tls12 data;
Jerry Yu0c2a7382022-12-06 13:27:25 +08004327 * case MBEDTLS_SSL_VERSION_TLS1_3:
Jerry Yuddda0502022-12-01 19:43:12 +08004328 * serialized_session_tls13 data;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004329 *
4330 * };
4331 *
4332 * } serialized_session;
4333 *
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004334 */
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004335
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004336MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004337static int ssl_session_save(const mbedtls_ssl_session *session,
4338 unsigned char omit_header,
4339 unsigned char *buf,
4340 size_t buf_len,
4341 size_t *olen)
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004342{
4343 unsigned char *p = buf;
4344 size_t used = 0;
Jerry Yu251a12e2022-07-13 15:15:48 +08004345 size_t remaining_len;
Jerry Yue36fdd62022-08-17 21:31:36 +08004346#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
4347 size_t out_len;
4348 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
4349#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01004350 if (session == NULL) {
4351 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
4352 }
Jerry Yu438ddd82022-07-07 06:55:50 +00004353
Gilles Peskine449bd832023-01-11 14:50:10 +01004354 if (!omit_header) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004355 /*
4356 * Add Mbed TLS version identifier
4357 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004358 used += sizeof(ssl_serialized_session_header);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004359
Gilles Peskine449bd832023-01-11 14:50:10 +01004360 if (used <= buf_len) {
4361 memcpy(p, ssl_serialized_session_header,
4362 sizeof(ssl_serialized_session_header));
4363 p += sizeof(ssl_serialized_session_header);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004364 }
4365 }
4366
4367 /*
Ronald Cron40a4ab02024-01-15 10:21:30 +01004368 * TLS version identifier, endpoint, ciphersuite
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004369 */
Ronald Cron40a4ab02024-01-15 10:21:30 +01004370 used += 1 /* TLS version */
4371 + 1 /* endpoint */
4372 + 2; /* ciphersuite */
Gilles Peskine449bd832023-01-11 14:50:10 +01004373 if (used <= buf_len) {
4374 *p++ = MBEDTLS_BYTE_0(session->tls_version);
Ronald Cron40a4ab02024-01-15 10:21:30 +01004375 *p++ = session->endpoint;
4376 MBEDTLS_PUT_UINT16_BE(session->ciphersuite, p, 0);
4377 p += 2;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004378 }
4379
4380 /* Forward to version-specific serialization routine. */
Jerry Yufca4d572022-07-21 10:37:48 +08004381 remaining_len = (buf_len >= used) ? buf_len - used : 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01004382 switch (session->tls_version) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004383#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01004384 case MBEDTLS_SSL_VERSION_TLS1_2:
4385 used += ssl_tls12_session_save(session, p, remaining_len);
4386 break;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004387#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
4388
Jerry Yu251a12e2022-07-13 15:15:48 +08004389#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004390 case MBEDTLS_SSL_VERSION_TLS1_3:
4391 ret = ssl_tls13_session_save(session, p, remaining_len, &out_len);
4392 if (ret != 0 && ret != MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL) {
4393 return ret;
4394 }
4395 used += out_len;
4396 break;
Jerry Yu251a12e2022-07-13 15:15:48 +08004397#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
4398
Gilles Peskine449bd832023-01-11 14:50:10 +01004399 default:
4400 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004401 }
4402
4403 *olen = used;
Gilles Peskine449bd832023-01-11 14:50:10 +01004404 if (used > buf_len) {
4405 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
4406 }
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004407
Gilles Peskine449bd832023-01-11 14:50:10 +01004408 return 0;
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004409}
4410
4411/*
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02004412 * Public wrapper for ssl_session_save()
4413 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004414int mbedtls_ssl_session_save(const mbedtls_ssl_session *session,
4415 unsigned char *buf,
4416 size_t buf_len,
4417 size_t *olen)
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02004418{
Gilles Peskine449bd832023-01-11 14:50:10 +01004419 return ssl_session_save(session, 0, buf, buf_len, olen);
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02004420}
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004421
Jerry Yuf1b23ca2022-02-18 11:48:47 +08004422/*
4423 * Deserialize session, see mbedtls_ssl_session_save() for format.
4424 *
4425 * This internal version is wrapped by a public function that cleans up in
4426 * case of error, and has an extra option omit_header.
4427 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004428MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004429static int ssl_session_load(mbedtls_ssl_session *session,
4430 unsigned char omit_header,
4431 const unsigned char *buf,
4432 size_t len)
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004433{
4434 const unsigned char *p = buf;
4435 const unsigned char * const end = buf + len;
Jerry Yu438ddd82022-07-07 06:55:50 +00004436 size_t remaining_len;
4437
4438
Gilles Peskine449bd832023-01-11 14:50:10 +01004439 if (session == NULL) {
4440 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
4441 }
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004442
Gilles Peskine449bd832023-01-11 14:50:10 +01004443 if (!omit_header) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004444 /*
4445 * Check Mbed TLS version identifier
4446 */
4447
Gilles Peskine449bd832023-01-11 14:50:10 +01004448 if ((size_t) (end - p) < sizeof(ssl_serialized_session_header)) {
4449 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004450 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004451
4452 if (memcmp(p, ssl_serialized_session_header,
4453 sizeof(ssl_serialized_session_header)) != 0) {
4454 return MBEDTLS_ERR_SSL_VERSION_MISMATCH;
4455 }
4456 p += sizeof(ssl_serialized_session_header);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004457 }
4458
4459 /*
Ronald Cron40a4ab02024-01-15 10:21:30 +01004460 * TLS version identifier, endpoint, ciphersuite
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004461 */
Ronald Cron40a4ab02024-01-15 10:21:30 +01004462 if (4 > (size_t) (end - p)) {
Gilles Peskine449bd832023-01-11 14:50:10 +01004463 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4464 }
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01004465 session->tls_version = (mbedtls_ssl_protocol_version) (0x0300 | *p++);
Ronald Cron40a4ab02024-01-15 10:21:30 +01004466 session->endpoint = *p++;
4467 session->ciphersuite = MBEDTLS_GET_UINT16_BE(p, 0);
4468 p += 2;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004469
4470 /* Dispatch according to TLS version. */
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00004471 remaining_len = (size_t) (end - p);
Gilles Peskine449bd832023-01-11 14:50:10 +01004472 switch (session->tls_version) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004473#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01004474 case MBEDTLS_SSL_VERSION_TLS1_2:
4475 return ssl_tls12_session_load(session, p, remaining_len);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004476#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
4477
Jerry Yu438ddd82022-07-07 06:55:50 +00004478#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004479 case MBEDTLS_SSL_VERSION_TLS1_3:
4480 return ssl_tls13_session_load(session, p, remaining_len);
Jerry Yu438ddd82022-07-07 06:55:50 +00004481#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
4482
Gilles Peskine449bd832023-01-11 14:50:10 +01004483 default:
4484 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004485 }
4486}
4487
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004488/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02004489 * Deserialize session: public wrapper for error cleaning
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02004490 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004491int mbedtls_ssl_session_load(mbedtls_ssl_session *session,
4492 const unsigned char *buf,
4493 size_t len)
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02004494{
Gilles Peskine449bd832023-01-11 14:50:10 +01004495 int ret = ssl_session_load(session, 0, buf, len);
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02004496
Gilles Peskine449bd832023-01-11 14:50:10 +01004497 if (ret != 0) {
4498 mbedtls_ssl_session_free(session);
4499 }
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02004500
Gilles Peskine449bd832023-01-11 14:50:10 +01004501 return ret;
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02004502}
4503
4504/*
Paul Bakker1961b702013-01-25 14:49:24 +01004505 * Perform a single step of the SSL handshake
Paul Bakker5121ce52009-01-03 21:22:43 +00004506 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004507MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004508static int ssl_prepare_handshake_step(mbedtls_ssl_context *ssl)
Hanno Becker41934dd2021-08-07 19:13:43 +01004509{
4510 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
4511
Ronald Cron66dbf912022-02-02 15:33:46 +01004512 /*
4513 * We may have not been able to send to the peer all the handshake data
Ronald Cron3f20b772022-03-08 16:00:02 +01004514 * that were written into the output buffer by the previous handshake step,
4515 * if the write to the network callback returned with the
Ronald Cron66dbf912022-02-02 15:33:46 +01004516 * #MBEDTLS_ERR_SSL_WANT_WRITE error code.
4517 * We proceed to the next handshake step only when all data from the
4518 * previous one have been sent to the peer, thus we make sure that this is
4519 * the case here by calling `mbedtls_ssl_flush_output()`. The function may
4520 * return with the #MBEDTLS_ERR_SSL_WANT_WRITE error code in which case
4521 * we have to wait before to go ahead.
4522 * In the case of TLS 1.3, handshake step handlers do not send data to the
4523 * peer. Data are only sent here and through
4524 * `mbedtls_ssl_handle_pending_alert` in case an error that triggered an
Andrzej Kurek5c65c572022-04-13 14:28:52 -04004525 * alert occurred.
Ronald Cron66dbf912022-02-02 15:33:46 +01004526 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004527 if ((ret = mbedtls_ssl_flush_output(ssl)) != 0) {
4528 return ret;
4529 }
Hanno Becker41934dd2021-08-07 19:13:43 +01004530
4531#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004532 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
4533 ssl->handshake->retransmit_state == MBEDTLS_SSL_RETRANS_SENDING) {
4534 if ((ret = mbedtls_ssl_flight_transmit(ssl)) != 0) {
4535 return ret;
4536 }
Hanno Becker41934dd2021-08-07 19:13:43 +01004537 }
4538#endif /* MBEDTLS_SSL_PROTO_DTLS */
4539
Gilles Peskine449bd832023-01-11 14:50:10 +01004540 return ret;
Hanno Becker41934dd2021-08-07 19:13:43 +01004541}
4542
Gilles Peskine449bd832023-01-11 14:50:10 +01004543int mbedtls_ssl_handshake_step(mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00004544{
Hanno Becker41934dd2021-08-07 19:13:43 +01004545 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00004546
Gilles Peskine449bd832023-01-11 14:50:10 +01004547 if (ssl == NULL ||
Hanno Becker41934dd2021-08-07 19:13:43 +01004548 ssl->conf == NULL ||
4549 ssl->handshake == NULL ||
Gilles Peskine449bd832023-01-11 14:50:10 +01004550 ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER) {
4551 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Becker41934dd2021-08-07 19:13:43 +01004552 }
4553
Gilles Peskine449bd832023-01-11 14:50:10 +01004554 ret = ssl_prepare_handshake_step(ssl);
4555 if (ret != 0) {
4556 return ret;
4557 }
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02004558
Gilles Peskine449bd832023-01-11 14:50:10 +01004559 ret = mbedtls_ssl_handle_pending_alert(ssl);
4560 if (ret != 0) {
Jerry Yue7047812021-09-13 19:26:39 +08004561 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01004562 }
Jerry Yue7047812021-09-13 19:26:39 +08004563
Tom Cosgrove2fdc7b32022-09-21 12:33:17 +01004564 /* If ssl->conf->endpoint is not one of MBEDTLS_SSL_IS_CLIENT or
4565 * MBEDTLS_SSL_IS_SERVER, this is the return code we give */
4566 ret = MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4567
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004568#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004569 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
4570 MBEDTLS_SSL_DEBUG_MSG(2, ("client state: %s",
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01004571 mbedtls_ssl_states_str((mbedtls_ssl_states) ssl->state)));
Jerry Yub9930e72021-08-06 17:11:51 +08004572
Gilles Peskine449bd832023-01-11 14:50:10 +01004573 switch (ssl->state) {
Ronald Cron9f0fba32022-02-10 16:45:15 +01004574 case MBEDTLS_SSL_HELLO_REQUEST:
4575 ssl->state = MBEDTLS_SSL_CLIENT_HELLO;
Tom Cosgrove87d9c6c2022-09-22 09:27:56 +01004576 ret = 0;
Ronald Cron9f0fba32022-02-10 16:45:15 +01004577 break;
Jerry Yub9930e72021-08-06 17:11:51 +08004578
Ronald Cron9f0fba32022-02-10 16:45:15 +01004579 case MBEDTLS_SSL_CLIENT_HELLO:
Gilles Peskine449bd832023-01-11 14:50:10 +01004580 ret = mbedtls_ssl_write_client_hello(ssl);
Ronald Cron9f0fba32022-02-10 16:45:15 +01004581 break;
4582
4583 default:
4584#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004585 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
4586 ret = mbedtls_ssl_tls13_handshake_client_step(ssl);
4587 } else {
4588 ret = mbedtls_ssl_handshake_client_step(ssl);
4589 }
Ronald Cron9f0fba32022-02-10 16:45:15 +01004590#elif defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01004591 ret = mbedtls_ssl_handshake_client_step(ssl);
Ronald Cron9f0fba32022-02-10 16:45:15 +01004592#else
Gilles Peskine449bd832023-01-11 14:50:10 +01004593 ret = mbedtls_ssl_tls13_handshake_client_step(ssl);
Ronald Cron9f0fba32022-02-10 16:45:15 +01004594#endif
4595 }
Jerry Yub9930e72021-08-06 17:11:51 +08004596 }
Ronald Cron6291b232023-03-08 15:51:25 +01004597#endif /* MBEDTLS_SSL_CLI_C */
4598
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004599#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004600 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Ronald Cron6291b232023-03-08 15:51:25 +01004601#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
4602 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Gilles Peskine449bd832023-01-11 14:50:10 +01004603 ret = mbedtls_ssl_tls13_handshake_server_step(ssl);
Ronald Cron6291b232023-03-08 15:51:25 +01004604 } else {
Gilles Peskine449bd832023-01-11 14:50:10 +01004605 ret = mbedtls_ssl_handshake_server_step(ssl);
4606 }
Ronald Cron6291b232023-03-08 15:51:25 +01004607#elif defined(MBEDTLS_SSL_PROTO_TLS1_2)
4608 ret = mbedtls_ssl_handshake_server_step(ssl);
4609#else
4610 ret = mbedtls_ssl_tls13_handshake_server_step(ssl);
Paul Bakker5121ce52009-01-03 21:22:43 +00004611#endif
Ronald Cron6291b232023-03-08 15:51:25 +01004612 }
4613#endif /* MBEDTLS_SSL_SRV_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00004614
Gilles Peskine449bd832023-01-11 14:50:10 +01004615 if (ret != 0) {
Jerry Yubbd5a3f2021-09-18 20:50:22 +08004616 /* handshake_step return error. And it is same
4617 * with alert_reason.
4618 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004619 if (ssl->send_alert) {
4620 ret = mbedtls_ssl_handle_pending_alert(ssl);
Jerry Yue7047812021-09-13 19:26:39 +08004621 goto cleanup;
4622 }
4623 }
4624
4625cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +01004626 return ret;
Paul Bakker1961b702013-01-25 14:49:24 +01004627}
4628
4629/*
4630 * Perform the SSL handshake
4631 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004632int mbedtls_ssl_handshake(mbedtls_ssl_context *ssl)
Paul Bakker1961b702013-01-25 14:49:24 +01004633{
4634 int ret = 0;
4635
Hanno Beckera817ea42020-10-20 15:20:23 +01004636 /* Sanity checks */
4637
Gilles Peskine449bd832023-01-11 14:50:10 +01004638 if (ssl == NULL || ssl->conf == NULL) {
4639 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4640 }
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02004641
Hanno Beckera817ea42020-10-20 15:20:23 +01004642#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004643 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
4644 (ssl->f_set_timer == NULL || ssl->f_get_timer == NULL)) {
4645 MBEDTLS_SSL_DEBUG_MSG(1, ("You must use "
4646 "mbedtls_ssl_set_timer_cb() for DTLS"));
4647 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Beckera817ea42020-10-20 15:20:23 +01004648 }
4649#endif /* MBEDTLS_SSL_PROTO_DTLS */
4650
Gilles Peskine449bd832023-01-11 14:50:10 +01004651 MBEDTLS_SSL_DEBUG_MSG(2, ("=> handshake"));
Paul Bakker1961b702013-01-25 14:49:24 +01004652
Hanno Beckera817ea42020-10-20 15:20:23 +01004653 /* Main handshake loop */
Gilles Peskine449bd832023-01-11 14:50:10 +01004654 while (ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER) {
4655 ret = mbedtls_ssl_handshake_step(ssl);
Paul Bakker1961b702013-01-25 14:49:24 +01004656
Gilles Peskine449bd832023-01-11 14:50:10 +01004657 if (ret != 0) {
Paul Bakker1961b702013-01-25 14:49:24 +01004658 break;
Gilles Peskine449bd832023-01-11 14:50:10 +01004659 }
Paul Bakker1961b702013-01-25 14:49:24 +01004660 }
4661
Gilles Peskine449bd832023-01-11 14:50:10 +01004662 MBEDTLS_SSL_DEBUG_MSG(2, ("<= handshake"));
Paul Bakker5121ce52009-01-03 21:22:43 +00004663
Gilles Peskine449bd832023-01-11 14:50:10 +01004664 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00004665}
4666
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004667#if defined(MBEDTLS_SSL_RENEGOTIATION)
4668#if defined(MBEDTLS_SSL_SRV_C)
Paul Bakker5121ce52009-01-03 21:22:43 +00004669/*
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004670 * Write HelloRequest to request renegotiation on server
Paul Bakker48916f92012-09-16 19:57:18 +00004671 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004672MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004673static int ssl_write_hello_request(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004674{
Janos Follath865b3eb2019-12-16 11:46:15 +00004675 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004676
Gilles Peskine449bd832023-01-11 14:50:10 +01004677 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write hello request"));
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004678
4679 ssl->out_msglen = 4;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004680 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
4681 ssl->out_msg[0] = MBEDTLS_SSL_HS_HELLO_REQUEST;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004682
Gilles Peskine449bd832023-01-11 14:50:10 +01004683 if ((ret = mbedtls_ssl_write_handshake_msg(ssl)) != 0) {
4684 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_handshake_msg", ret);
4685 return ret;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004686 }
4687
Gilles Peskine449bd832023-01-11 14:50:10 +01004688 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write hello request"));
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004689
Gilles Peskine449bd832023-01-11 14:50:10 +01004690 return 0;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004691}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004692#endif /* MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004693
4694/*
4695 * Actually renegotiate current connection, triggered by either:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004696 * - any side: calling mbedtls_ssl_renegotiate(),
4697 * - client: receiving a HelloRequest during mbedtls_ssl_read(),
4698 * - server: receiving any handshake message on server during mbedtls_ssl_read() after
Manuel Pégourié-Gonnard55e4ff22014-08-19 11:16:35 +02004699 * the initial handshake is completed.
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004700 * If the handshake doesn't complete due to waiting for I/O, it will continue
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004701 * during the next calls to mbedtls_ssl_renegotiate() or mbedtls_ssl_read() respectively.
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004702 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004703int mbedtls_ssl_start_renegotiation(mbedtls_ssl_context *ssl)
Paul Bakker48916f92012-09-16 19:57:18 +00004704{
Janos Follath865b3eb2019-12-16 11:46:15 +00004705 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker48916f92012-09-16 19:57:18 +00004706
Gilles Peskine449bd832023-01-11 14:50:10 +01004707 MBEDTLS_SSL_DEBUG_MSG(2, ("=> renegotiate"));
Paul Bakker48916f92012-09-16 19:57:18 +00004708
Gilles Peskine449bd832023-01-11 14:50:10 +01004709 if ((ret = ssl_handshake_init(ssl)) != 0) {
4710 return ret;
4711 }
Paul Bakker48916f92012-09-16 19:57:18 +00004712
Manuel Pégourié-Gonnard0557bd52014-08-19 19:18:39 +02004713 /* RFC 6347 4.2.2: "[...] the HelloRequest will have message_seq = 0 and
4714 * the ServerHello will have message_seq = 1" */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004715#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004716 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
4717 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING) {
4718 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02004719 ssl->handshake->out_msg_seq = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004720 } else {
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02004721 ssl->handshake->in_msg_seq = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004722 }
Manuel Pégourié-Gonnard0557bd52014-08-19 19:18:39 +02004723 }
4724#endif
4725
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004726 ssl->state = MBEDTLS_SSL_HELLO_REQUEST;
4727 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS;
Paul Bakker48916f92012-09-16 19:57:18 +00004728
Gilles Peskine449bd832023-01-11 14:50:10 +01004729 if ((ret = mbedtls_ssl_handshake(ssl)) != 0) {
4730 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_handshake", ret);
4731 return ret;
Paul Bakker48916f92012-09-16 19:57:18 +00004732 }
4733
Gilles Peskine449bd832023-01-11 14:50:10 +01004734 MBEDTLS_SSL_DEBUG_MSG(2, ("<= renegotiate"));
Paul Bakker48916f92012-09-16 19:57:18 +00004735
Gilles Peskine449bd832023-01-11 14:50:10 +01004736 return 0;
Paul Bakker48916f92012-09-16 19:57:18 +00004737}
4738
4739/*
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004740 * Renegotiate current connection on client,
4741 * or request renegotiation on server
4742 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004743int mbedtls_ssl_renegotiate(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004744{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004745 int ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004746
Gilles Peskine449bd832023-01-11 14:50:10 +01004747 if (ssl == NULL || ssl->conf == NULL) {
4748 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4749 }
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02004750
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004751#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004752 /* On server, just send the request */
Gilles Peskine449bd832023-01-11 14:50:10 +01004753 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
4754 if (mbedtls_ssl_is_handshake_over(ssl) == 0) {
4755 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4756 }
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004757
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004758 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_PENDING;
Manuel Pégourié-Gonnardf07f4212014-08-15 19:04:47 +02004759
4760 /* Did we already try/start sending HelloRequest? */
Gilles Peskine449bd832023-01-11 14:50:10 +01004761 if (ssl->out_left != 0) {
4762 return mbedtls_ssl_flush_output(ssl);
4763 }
Manuel Pégourié-Gonnardf07f4212014-08-15 19:04:47 +02004764
Gilles Peskine449bd832023-01-11 14:50:10 +01004765 return ssl_write_hello_request(ssl);
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004766 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004767#endif /* MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004768
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004769#if defined(MBEDTLS_SSL_CLI_C)
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004770 /*
4771 * On client, either start the renegotiation process or,
4772 * if already in progress, continue the handshake
4773 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004774 if (ssl->renego_status != MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS) {
4775 if (mbedtls_ssl_is_handshake_over(ssl) == 0) {
4776 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004777 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004778
4779 if ((ret = mbedtls_ssl_start_renegotiation(ssl)) != 0) {
4780 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_start_renegotiation", ret);
4781 return ret;
4782 }
4783 } else {
4784 if ((ret = mbedtls_ssl_handshake(ssl)) != 0) {
4785 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_handshake", ret);
4786 return ret;
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004787 }
4788 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004789#endif /* MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004790
Gilles Peskine449bd832023-01-11 14:50:10 +01004791 return ret;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004792}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004793#endif /* MBEDTLS_SSL_RENEGOTIATION */
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004794
Gilles Peskine449bd832023-01-11 14:50:10 +01004795void mbedtls_ssl_handshake_free(mbedtls_ssl_context *ssl)
Paul Bakker48916f92012-09-16 19:57:18 +00004796{
Gilles Peskine9b562d52018-04-25 20:32:43 +02004797 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
4798
Gilles Peskine449bd832023-01-11 14:50:10 +01004799 if (handshake == NULL) {
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004800 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01004801 }
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004802
Valerio Setti6f0441d2023-07-03 12:11:36 +02004803#if defined(MBEDTLS_PK_HAVE_ECC_KEYS)
Brett Warrene0edc842021-08-17 09:53:13 +01004804#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004805 if (ssl->handshake->group_list_heap_allocated) {
4806 mbedtls_free((void *) handshake->group_list);
4807 }
Brett Warrene0edc842021-08-17 09:53:13 +01004808 handshake->group_list = NULL;
4809#endif /* MBEDTLS_DEPRECATED_REMOVED */
Valerio Setti6f0441d2023-07-03 12:11:36 +02004810#endif /* MBEDTLS_PK_HAVE_ECC_KEYS */
Brett Warrene0edc842021-08-17 09:53:13 +01004811
Ronald Crone68ab4f2022-10-05 12:46:29 +02004812#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yuf017ee42022-01-12 15:49:48 +08004813#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004814 if (ssl->handshake->sig_algs_heap_allocated) {
4815 mbedtls_free((void *) handshake->sig_algs);
4816 }
Jerry Yuf017ee42022-01-12 15:49:48 +08004817 handshake->sig_algs = NULL;
4818#endif /* MBEDTLS_DEPRECATED_REMOVED */
Xiaofei Baic234ecf2022-02-08 09:59:23 +00004819#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004820 if (ssl->handshake->certificate_request_context) {
4821 mbedtls_free((void *) handshake->certificate_request_context);
Xiaofei Baic234ecf2022-02-08 09:59:23 +00004822 }
4823#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Ronald Crone68ab4f2022-10-05 12:46:29 +02004824#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Jerry Yuf017ee42022-01-12 15:49:48 +08004825
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02004826#if defined(MBEDTLS_SSL_ASYNC_PRIVATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01004827 if (ssl->conf->f_async_cancel != NULL && handshake->async_in_progress != 0) {
4828 ssl->conf->f_async_cancel(ssl);
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02004829 handshake->async_in_progress = 0;
4830 }
4831#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
4832
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01004833#if defined(MBEDTLS_MD_CAN_SHA256)
Andrzej Kurekeb342242019-01-29 09:14:33 -05004834#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01004835 psa_hash_abort(&handshake->fin_sha256_psa);
Andrzej Kurekeb342242019-01-29 09:14:33 -05004836#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01004837 mbedtls_md_free(&handshake->fin_sha256);
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02004838#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -05004839#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01004840#if defined(MBEDTLS_MD_CAN_SHA384)
Andrzej Kurekeb342242019-01-29 09:14:33 -05004841#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01004842 psa_hash_abort(&handshake->fin_sha384_psa);
Andrzej Kurekeb342242019-01-29 09:14:33 -05004843#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01004844 mbedtls_md_free(&handshake->fin_sha384);
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02004845#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -05004846#endif
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02004847
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004848#if defined(MBEDTLS_DHM_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004849 mbedtls_dhm_free(&handshake->dhm_ctx);
Paul Bakker48916f92012-09-16 19:57:18 +00004850#endif
Valerio Setti7aeec542023-07-05 18:57:21 +02004851#if !defined(MBEDTLS_USE_PSA_CRYPTO) && \
Valerio Setti6eb00542023-07-07 17:04:24 +02004852 defined(MBEDTLS_KEY_EXCHANGE_SOME_ECDH_OR_ECDHE_1_2_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004853 mbedtls_ecdh_free(&handshake->ecdh_ctx);
Paul Bakker61d113b2013-07-04 11:51:43 +02004854#endif
Valerio Setti02c25b52022-11-15 14:08:42 +01004855
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02004856#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Neil Armstrongca7d5062022-05-31 14:43:23 +02004857#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01004858 psa_pake_abort(&handshake->psa_pake_ctx);
Valerio Settieb3f7882022-12-08 18:42:58 +01004859 /*
4860 * Opaque keys are not stored in the handshake's data and it's the user
4861 * responsibility to destroy them. Clear ones, instead, are created by
4862 * the TLS library and should be destroyed at the same level
4863 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004864 if (!mbedtls_svc_key_id_is_null(handshake->psa_pake_password)) {
4865 psa_destroy_key(handshake->psa_pake_password);
Valerio Settieb3f7882022-12-08 18:42:58 +01004866 }
Neil Armstrongca7d5062022-05-31 14:43:23 +02004867 handshake->psa_pake_password = MBEDTLS_SVC_KEY_ID_INIT;
4868#else
Gilles Peskine449bd832023-01-11 14:50:10 +01004869 mbedtls_ecjpake_free(&handshake->ecjpake_ctx);
Neil Armstrongca7d5062022-05-31 14:43:23 +02004870#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard77c06462015-09-17 13:59:49 +02004871#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004872 mbedtls_free(handshake->ecjpake_cache);
Manuel Pégourié-Gonnard77c06462015-09-17 13:59:49 +02004873 handshake->ecjpake_cache = NULL;
4874 handshake->ecjpake_cache_len = 0;
4875#endif
Manuel Pégourié-Gonnard76cfd3f2015-09-15 12:10:54 +02004876#endif
Paul Bakker61d113b2013-07-04 11:51:43 +02004877
Valerio Setti7aeec542023-07-05 18:57:21 +02004878#if defined(MBEDTLS_KEY_EXCHANGE_SOME_ECDH_OR_ECDHE_ANY_ENABLED) || \
Valerio Setti45d56f32023-07-13 17:23:20 +02004879 defined(MBEDTLS_KEY_EXCHANGE_WITH_ECDSA_ANY_ENABLED) || \
Janos Follath4ae5c292016-02-10 11:27:43 +00004880 defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Paul Bakker9af723c2014-05-01 13:03:14 +02004881 /* explicit void pointer cast for buggy MS compiler */
Gilles Peskine449bd832023-01-11 14:50:10 +01004882 mbedtls_free((void *) handshake->curves_tls_id);
Manuel Pégourié-Gonnardd09453c2013-09-23 19:11:32 +02004883#endif
4884
Ronald Cron73fe8df2022-10-05 14:31:43 +02004885#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED)
Neil Armstrong501c9322022-05-03 09:35:09 +02004886#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01004887 if (!mbedtls_svc_key_id_is_null(ssl->handshake->psk_opaque)) {
Neil Armstrong501c9322022-05-03 09:35:09 +02004888 /* The maintenance of the external PSK key slot is the
4889 * user's responsibility. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004890 if (ssl->handshake->psk_opaque_is_internal) {
4891 psa_destroy_key(ssl->handshake->psk_opaque);
Neil Armstrong501c9322022-05-03 09:35:09 +02004892 ssl->handshake->psk_opaque_is_internal = 0;
4893 }
4894 ssl->handshake->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
4895 }
Neil Armstronge952a302022-05-03 10:22:14 +02004896#else
Gilles Peskine449bd832023-01-11 14:50:10 +01004897 if (handshake->psk != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01004898 mbedtls_zeroize_and_free(handshake->psk, handshake->psk_len);
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01004899 }
Neil Armstronge952a302022-05-03 10:22:14 +02004900#endif /* MBEDTLS_USE_PSA_CRYPTO */
Ronald Cron73fe8df2022-10-05 14:31:43 +02004901#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED */
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01004902
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004903#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
4904 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Manuel Pégourié-Gonnard83724542013-09-24 22:30:56 +02004905 /*
4906 * Free only the linked list wrapper, not the keys themselves
4907 * since the belong to the SNI callback
4908 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004909 ssl_key_cert_free(handshake->sni_key_cert);
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004910#endif /* MBEDTLS_X509_CRT_PARSE_C && MBEDTLS_SSL_SERVER_NAME_INDICATION */
Manuel Pégourié-Gonnard705fcca2013-09-23 20:04:20 +02004911
Gilles Peskineeccd8882020-03-10 12:19:08 +01004912#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004913 mbedtls_x509_crt_restart_free(&handshake->ecrs_ctx);
4914 if (handshake->ecrs_peer_cert != NULL) {
4915 mbedtls_x509_crt_free(handshake->ecrs_peer_cert);
4916 mbedtls_free(handshake->ecrs_peer_cert);
Hanno Becker3dad3112019-02-05 17:19:52 +00004917 }
Manuel Pégourié-Gonnard862cde52017-05-17 11:56:15 +02004918#endif
4919
Hanno Becker75173122019-02-06 16:18:31 +00004920#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
4921 !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01004922 mbedtls_pk_free(&handshake->peer_pubkey);
Hanno Becker75173122019-02-06 16:18:31 +00004923#endif /* MBEDTLS_X509_CRT_PARSE_C && !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
4924
XiaokangQian9b93c0d2022-02-09 06:02:25 +00004925#if defined(MBEDTLS_SSL_CLI_C) && \
Gilles Peskine449bd832023-01-11 14:50:10 +01004926 (defined(MBEDTLS_SSL_PROTO_DTLS) || defined(MBEDTLS_SSL_PROTO_TLS1_3))
4927 mbedtls_free(handshake->cookie);
XiaokangQian9b93c0d2022-02-09 06:02:25 +00004928#endif /* MBEDTLS_SSL_CLI_C &&
4929 ( MBEDTLS_SSL_PROTO_DTLS || MBEDTLS_SSL_PROTO_TLS1_3 ) */
XiaokangQian8499b6c2022-01-27 09:00:11 +00004930
4931#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004932 mbedtls_ssl_flight_free(handshake->flight);
4933 mbedtls_ssl_buffering_free(ssl);
XiaokangQian8499b6c2022-01-27 09:00:11 +00004934#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard74848812014-07-11 02:43:49 +02004935
Valerio Settiea59c432023-07-25 11:14:03 +02004936#if defined(MBEDTLS_KEY_EXCHANGE_SOME_XXDH_PSA_ANY_ENABLED)
Przemek Stekiel7ac93be2023-07-04 10:02:38 +02004937 if (handshake->xxdh_psa_privkey_is_external == 0) {
4938 psa_destroy_key(handshake->xxdh_psa_privkey);
Gilles Peskine449bd832023-01-11 14:50:10 +01004939 }
Valerio Settiea59c432023-07-25 11:14:03 +02004940#endif /* MBEDTLS_KEY_EXCHANGE_SOME_XXDH_PSA_ANY_ENABLED */
Hanno Becker4a63ed42019-01-08 11:39:35 +00004941
Ronald Cron6f135e12021-12-08 16:57:54 +01004942#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004943 mbedtls_ssl_transform_free(handshake->transform_handshake);
4944 mbedtls_free(handshake->transform_handshake);
Jerry Yu3d9b5902022-11-04 14:07:25 +08004945#if defined(MBEDTLS_SSL_EARLY_DATA)
Gilles Peskine449bd832023-01-11 14:50:10 +01004946 mbedtls_ssl_transform_free(handshake->transform_earlydata);
4947 mbedtls_free(handshake->transform_earlydata);
Jerry Yu3d9b5902022-11-04 14:07:25 +08004948#endif
Ronald Cron6f135e12021-12-08 16:57:54 +01004949#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yuba9c7272021-10-30 11:54:10 +08004950
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05004951
4952#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
4953 /* If the buffers are too big - reallocate. Because of the way Mbed TLS
4954 * processes datagrams and the fact that a datagram is allowed to have
4955 * several records in it, it is possible that the I/O buffers are not
4956 * empty at this stage */
Gilles Peskine449bd832023-01-11 14:50:10 +01004957 handle_buffer_resizing(ssl, 1, mbedtls_ssl_get_input_buflen(ssl),
4958 mbedtls_ssl_get_output_buflen(ssl));
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05004959#endif
Hanno Becker3aa186f2021-08-10 09:24:19 +01004960
Jerry Yuba9c7272021-10-30 11:54:10 +08004961 /* mbedtls_platform_zeroize MUST be last one in this function */
Gilles Peskine449bd832023-01-11 14:50:10 +01004962 mbedtls_platform_zeroize(handshake,
4963 sizeof(mbedtls_ssl_handshake_params));
Paul Bakker48916f92012-09-16 19:57:18 +00004964}
4965
Gilles Peskine449bd832023-01-11 14:50:10 +01004966void mbedtls_ssl_session_free(mbedtls_ssl_session *session)
Paul Bakker48916f92012-09-16 19:57:18 +00004967{
Gilles Peskine449bd832023-01-11 14:50:10 +01004968 if (session == NULL) {
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004969 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01004970 }
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004971
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004972#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004973 ssl_clear_peer_cert(session);
Paul Bakkered27a042013-04-18 22:46:23 +02004974#endif
Paul Bakker0a597072012-09-25 21:55:46 +00004975
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02004976#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
Xiaokang Qianbc663a02022-10-09 11:14:39 +00004977#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && \
4978 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01004979 mbedtls_free(session->hostname);
Xiaokang Qian281fd1b2022-09-20 11:35:41 +00004980#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01004981 mbedtls_free(session->ticket);
Paul Bakkera503a632013-08-14 13:48:06 +02004982#endif
Manuel Pégourié-Gonnard75d44012013-08-02 14:44:04 +02004983
Waleed Elmelegy2824a202024-02-23 17:51:47 +00004984#if defined(MBEDTLS_SSL_EARLY_DATA) && defined(MBEDTLS_SSL_ALPN) && \
4985 defined(MBEDTLS_SSL_SRV_C)
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00004986 mbedtls_free(session->ticket_alpn);
Paul Bakker5121ce52009-01-03 21:22:43 +00004987#endif
4988
Gilles Peskine449bd832023-01-11 14:50:10 +01004989 mbedtls_platform_zeroize(session, sizeof(mbedtls_ssl_session));
Paul Bakker5121ce52009-01-03 21:22:43 +00004990}
4991
Manuel Pégourié-Gonnard5c0e3772019-07-23 16:13:17 +02004992#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004993
4994#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
4995#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID 1u
4996#else
4997#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID 0u
4998#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
4999
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02005000#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT 1u
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02005001
5002#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
5003#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY 1u
5004#else
5005#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY 0u
5006#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
5007
5008#if defined(MBEDTLS_SSL_ALPN)
5009#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN 1u
5010#else
5011#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN 0u
5012#endif /* MBEDTLS_SSL_ALPN */
5013
5014#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID_BIT 0
5015#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT_BIT 1
5016#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY_BIT 2
5017#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN_BIT 3
5018
5019#define SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG \
Gilles Peskine449bd832023-01-11 14:50:10 +01005020 ((uint32_t) ( \
5021 (SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID << \
5022 SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID_BIT) | \
5023 (SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT << \
5024 SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT_BIT) | \
5025 (SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY << \
5026 SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY_BIT) | \
5027 (SSL_SERIALIZED_CONTEXT_CONFIG_ALPN << SSL_SERIALIZED_CONTEXT_CONFIG_ALPN_BIT) | \
5028 0u))
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02005029
Chien Wong4e9683e2023-12-28 17:07:43 +08005030static const unsigned char ssl_serialized_context_header[] = {
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005031 MBEDTLS_VERSION_MAJOR,
5032 MBEDTLS_VERSION_MINOR,
5033 MBEDTLS_VERSION_PATCH,
Gilles Peskine449bd832023-01-11 14:50:10 +01005034 MBEDTLS_BYTE_1(SSL_SERIALIZED_SESSION_CONFIG_BITFLAG),
5035 MBEDTLS_BYTE_0(SSL_SERIALIZED_SESSION_CONFIG_BITFLAG),
5036 MBEDTLS_BYTE_2(SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG),
5037 MBEDTLS_BYTE_1(SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG),
5038 MBEDTLS_BYTE_0(SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG),
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005039};
5040
Paul Bakker5121ce52009-01-03 21:22:43 +00005041/*
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005042 * Serialize a full SSL context
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02005043 *
5044 * The format of the serialized data is:
5045 * (in the presentation language of TLS, RFC 8446 section 3)
5046 *
5047 * // header
5048 * opaque mbedtls_version[3]; // major, minor, patch
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005049 * opaque context_format[5]; // version-specific field determining
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02005050 * // the format of the remaining
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005051 * // serialized data.
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02005052 * Note: When updating the format, remember to keep these
5053 * version+format bytes. (We may make their size part of the API.)
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02005054 *
5055 * // session sub-structure
5056 * opaque session<1..2^32-1>; // see mbedtls_ssl_session_save()
5057 * // transform sub-structure
5058 * uint8 random[64]; // ServerHello.random+ClientHello.random
5059 * uint8 in_cid<0..2^8-1> // Connection ID: expected incoming value
5060 * uint8 out_cid<0..2^8-1> // Connection ID: outgoing value to use
5061 * // fields from ssl_context
5062 * uint32 badmac_seen; // DTLS: number of records with failing MAC
5063 * uint64 in_window_top; // DTLS: last validated record seq_num
5064 * uint64 in_window; // DTLS: bitmask for replay protection
5065 * uint8 disable_datagram_packing; // DTLS: only one record per datagram
5066 * uint64 cur_out_ctr; // Record layer: outgoing sequence number
5067 * uint16 mtu; // DTLS: path mtu (max outgoing fragment size)
5068 * uint8 alpn_chosen<0..2^8-1> // ALPN: negotiated application protocol
5069 *
5070 * Note that many fields of the ssl_context or sub-structures are not
5071 * serialized, as they fall in one of the following categories:
5072 *
5073 * 1. forced value (eg in_left must be 0)
5074 * 2. pointer to dynamically-allocated memory (eg session, transform)
5075 * 3. value can be re-derived from other data (eg session keys from MS)
5076 * 4. value was temporary (eg content of input buffer)
5077 * 5. value will be provided by the user again (eg I/O callbacks and context)
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005078 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005079int mbedtls_ssl_context_save(mbedtls_ssl_context *ssl,
5080 unsigned char *buf,
5081 size_t buf_len,
5082 size_t *olen)
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005083{
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005084 unsigned char *p = buf;
5085 size_t used = 0;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005086 size_t session_len;
5087 int ret = 0;
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005088
Manuel Pégourié-Gonnard1aaf6692019-07-10 14:14:05 +02005089 /*
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02005090 * Enforce usage restrictions, see "return BAD_INPUT_DATA" in
5091 * this function's documentation.
5092 *
5093 * These are due to assumptions/limitations in the implementation. Some of
5094 * them are likely to stay (no handshake in progress) some might go away
5095 * (only DTLS) but are currently used to simplify the implementation.
Manuel Pégourié-Gonnard1aaf6692019-07-10 14:14:05 +02005096 */
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02005097 /* The initial handshake must be over */
Gilles Peskine449bd832023-01-11 14:50:10 +01005098 if (mbedtls_ssl_is_handshake_over(ssl) == 0) {
5099 MBEDTLS_SSL_DEBUG_MSG(1, ("Initial handshake isn't over"));
5100 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03005101 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005102 if (ssl->handshake != NULL) {
5103 MBEDTLS_SSL_DEBUG_MSG(1, ("Handshake isn't completed"));
5104 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03005105 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02005106 /* Double-check that sub-structures are indeed ready */
Gilles Peskine449bd832023-01-11 14:50:10 +01005107 if (ssl->transform == NULL || ssl->session == NULL) {
5108 MBEDTLS_SSL_DEBUG_MSG(1, ("Serialised structures aren't ready"));
5109 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03005110 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02005111 /* There must be no pending incoming or outgoing data */
Gilles Peskine449bd832023-01-11 14:50:10 +01005112 if (mbedtls_ssl_check_pending(ssl) != 0) {
5113 MBEDTLS_SSL_DEBUG_MSG(1, ("There is pending incoming data"));
5114 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03005115 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005116 if (ssl->out_left != 0) {
5117 MBEDTLS_SSL_DEBUG_MSG(1, ("There is pending outgoing data"));
5118 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03005119 }
Dave Rodgman556e8a32022-12-06 16:31:25 +00005120 /* Protocol must be DTLS, not TLS */
Gilles Peskine449bd832023-01-11 14:50:10 +01005121 if (ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
5122 MBEDTLS_SSL_DEBUG_MSG(1, ("Only DTLS is supported"));
5123 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03005124 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02005125 /* Version must be 1.2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005126 if (ssl->tls_version != MBEDTLS_SSL_VERSION_TLS1_2) {
5127 MBEDTLS_SSL_DEBUG_MSG(1, ("Only version 1.2 supported"));
5128 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03005129 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02005130 /* We must be using an AEAD ciphersuite */
Gilles Peskine449bd832023-01-11 14:50:10 +01005131 if (mbedtls_ssl_transform_uses_aead(ssl->transform) != 1) {
5132 MBEDTLS_SSL_DEBUG_MSG(1, ("Only AEAD ciphersuites supported"));
5133 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03005134 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02005135 /* Renegotiation must not be enabled */
5136#if defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01005137 if (ssl->conf->disable_renegotiation != MBEDTLS_SSL_RENEGOTIATION_DISABLED) {
5138 MBEDTLS_SSL_DEBUG_MSG(1, ("Renegotiation must not be enabled"));
5139 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03005140 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02005141#endif
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005142
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005143 /*
5144 * Version and format identifier
5145 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005146 used += sizeof(ssl_serialized_context_header);
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005147
Gilles Peskine449bd832023-01-11 14:50:10 +01005148 if (used <= buf_len) {
5149 memcpy(p, ssl_serialized_context_header,
5150 sizeof(ssl_serialized_context_header));
5151 p += sizeof(ssl_serialized_context_header);
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005152 }
5153
5154 /*
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005155 * Session (length + data)
5156 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005157 ret = ssl_session_save(ssl->session, 1, NULL, 0, &session_len);
5158 if (ret != MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL) {
5159 return ret;
5160 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005161
5162 used += 4 + session_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01005163 if (used <= buf_len) {
5164 MBEDTLS_PUT_UINT32_BE(session_len, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01005165 p += 4;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005166
Gilles Peskine449bd832023-01-11 14:50:10 +01005167 ret = ssl_session_save(ssl->session, 1,
5168 p, session_len, &session_len);
5169 if (ret != 0) {
5170 return ret;
5171 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005172
5173 p += session_len;
5174 }
5175
5176 /*
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005177 * Transform
5178 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005179 used += sizeof(ssl->transform->randbytes);
5180 if (used <= buf_len) {
5181 memcpy(p, ssl->transform->randbytes,
5182 sizeof(ssl->transform->randbytes));
5183 p += sizeof(ssl->transform->randbytes);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005184 }
5185
5186#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Dave Rodgmanc37ad442023-11-03 23:36:06 +00005187 used += 2U + ssl->transform->in_cid_len + ssl->transform->out_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01005188 if (used <= buf_len) {
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005189 *p++ = ssl->transform->in_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01005190 memcpy(p, ssl->transform->in_cid, ssl->transform->in_cid_len);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005191 p += ssl->transform->in_cid_len;
5192
5193 *p++ = ssl->transform->out_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01005194 memcpy(p, ssl->transform->out_cid, ssl->transform->out_cid_len);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005195 p += ssl->transform->out_cid_len;
5196 }
5197#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
5198
5199 /*
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005200 * Saved fields from top-level ssl_context structure
5201 */
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005202 used += 4;
Gilles Peskine449bd832023-01-11 14:50:10 +01005203 if (used <= buf_len) {
5204 MBEDTLS_PUT_UINT32_BE(ssl->badmac_seen, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01005205 p += 4;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005206 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005207
5208#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
5209 used += 16;
Gilles Peskine449bd832023-01-11 14:50:10 +01005210 if (used <= buf_len) {
5211 MBEDTLS_PUT_UINT64_BE(ssl->in_window_top, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01005212 p += 8;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005213
Gilles Peskine449bd832023-01-11 14:50:10 +01005214 MBEDTLS_PUT_UINT64_BE(ssl->in_window, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01005215 p += 8;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005216 }
5217#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
5218
5219#if defined(MBEDTLS_SSL_PROTO_DTLS)
5220 used += 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01005221 if (used <= buf_len) {
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005222 *p++ = ssl->disable_datagram_packing;
5223 }
5224#endif /* MBEDTLS_SSL_PROTO_DTLS */
5225
Jerry Yuae0b2e22021-10-08 15:21:19 +08005226 used += MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Gilles Peskine449bd832023-01-11 14:50:10 +01005227 if (used <= buf_len) {
5228 memcpy(p, ssl->cur_out_ctr, MBEDTLS_SSL_SEQUENCE_NUMBER_LEN);
Jerry Yuae0b2e22021-10-08 15:21:19 +08005229 p += MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005230 }
5231
5232#if defined(MBEDTLS_SSL_PROTO_DTLS)
5233 used += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01005234 if (used <= buf_len) {
5235 MBEDTLS_PUT_UINT16_BE(ssl->mtu, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01005236 p += 2;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005237 }
5238#endif /* MBEDTLS_SSL_PROTO_DTLS */
5239
5240#if defined(MBEDTLS_SSL_ALPN)
5241 {
5242 const uint8_t alpn_len = ssl->alpn_chosen
Gilles Peskine449bd832023-01-11 14:50:10 +01005243 ? (uint8_t) strlen(ssl->alpn_chosen)
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005244 : 0;
5245
5246 used += 1 + alpn_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01005247 if (used <= buf_len) {
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005248 *p++ = alpn_len;
5249
Gilles Peskine449bd832023-01-11 14:50:10 +01005250 if (ssl->alpn_chosen != NULL) {
5251 memcpy(p, ssl->alpn_chosen, alpn_len);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005252 p += alpn_len;
5253 }
5254 }
5255 }
5256#endif /* MBEDTLS_SSL_ALPN */
5257
5258 /*
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005259 * Done
5260 */
5261 *olen = used;
5262
Gilles Peskine449bd832023-01-11 14:50:10 +01005263 if (used > buf_len) {
5264 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
5265 }
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005266
Gilles Peskine449bd832023-01-11 14:50:10 +01005267 MBEDTLS_SSL_DEBUG_BUF(4, "saved context", buf, used);
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005268
Gilles Peskine449bd832023-01-11 14:50:10 +01005269 return mbedtls_ssl_session_reset_int(ssl, 0);
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005270}
5271
5272/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02005273 * Deserialize context, see mbedtls_ssl_context_save() for format.
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005274 *
5275 * This internal version is wrapped by a public function that cleans up in
5276 * case of error.
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005277 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005278MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01005279static int ssl_context_load(mbedtls_ssl_context *ssl,
5280 const unsigned char *buf,
5281 size_t len)
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005282{
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005283 const unsigned char *p = buf;
5284 const unsigned char * const end = buf + len;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005285 size_t session_len;
Janos Follath865b3eb2019-12-16 11:46:15 +00005286 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04005287#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Andrzej Kurek894edde2022-09-29 06:31:14 -04005288 tls_prf_fn prf_func = NULL;
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04005289#endif
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005290
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02005291 /*
5292 * The context should have been freshly setup or reset.
5293 * Give the user an error in case of obvious misuse.
Manuel Pégourié-Gonnard4ca930f2019-07-26 16:31:53 +02005294 * (Checking session is useful because it won't be NULL if we're
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02005295 * renegotiating, or if the user mistakenly loaded a session first.)
5296 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005297 if (ssl->state != MBEDTLS_SSL_HELLO_REQUEST ||
5298 ssl->session != NULL) {
5299 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02005300 }
5301
5302 /*
5303 * We can't check that the config matches the initial one, but we can at
5304 * least check it matches the requirements for serializing.
5305 */
Dave Rodgmane99b24d2023-09-14 15:45:03 +01005306 if (
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02005307#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard9a96fd72019-07-23 17:11:24 +02005308 ssl->conf->disable_renegotiation != MBEDTLS_SSL_RENEGOTIATION_DISABLED ||
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02005309#endif
Dave Rodgmane99b24d2023-09-14 15:45:03 +01005310 ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM ||
5311 ssl->conf->max_tls_version < MBEDTLS_SSL_VERSION_TLS1_2 ||
5312 ssl->conf->min_tls_version > MBEDTLS_SSL_VERSION_TLS1_2
5313 ) {
Gilles Peskine449bd832023-01-11 14:50:10 +01005314 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02005315 }
5316
Gilles Peskine449bd832023-01-11 14:50:10 +01005317 MBEDTLS_SSL_DEBUG_BUF(4, "context to load", buf, len);
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005318
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005319 /*
5320 * Check version identifier
5321 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005322 if ((size_t) (end - p) < sizeof(ssl_serialized_context_header)) {
5323 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005324 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005325
5326 if (memcmp(p, ssl_serialized_context_header,
5327 sizeof(ssl_serialized_context_header)) != 0) {
5328 return MBEDTLS_ERR_SSL_VERSION_MISMATCH;
5329 }
5330 p += sizeof(ssl_serialized_context_header);
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005331
5332 /*
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005333 * Session
5334 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005335 if ((size_t) (end - p) < 4) {
5336 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5337 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005338
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01005339 session_len = MBEDTLS_GET_UINT32_BE(p, 0);
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005340 p += 4;
5341
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02005342 /* This has been allocated by ssl_handshake_init(), called by
Hanno Becker43aefe22020-02-05 10:44:56 +00005343 * by either mbedtls_ssl_session_reset_int() or mbedtls_ssl_setup(). */
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02005344 ssl->session = ssl->session_negotiate;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005345 ssl->session_in = ssl->session;
5346 ssl->session_out = ssl->session;
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02005347 ssl->session_negotiate = NULL;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005348
Gilles Peskine449bd832023-01-11 14:50:10 +01005349 if ((size_t) (end - p) < session_len) {
5350 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5351 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005352
Gilles Peskine449bd832023-01-11 14:50:10 +01005353 ret = ssl_session_load(ssl->session, 1, p, session_len);
5354 if (ret != 0) {
5355 mbedtls_ssl_session_free(ssl->session);
5356 return ret;
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02005357 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005358
5359 p += session_len;
5360
5361 /*
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005362 * Transform
5363 */
5364
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02005365 /* This has been allocated by ssl_handshake_init(), called by
Hanno Becker43aefe22020-02-05 10:44:56 +00005366 * by either mbedtls_ssl_session_reset_int() or mbedtls_ssl_setup(). */
Jerry Yu2e199812022-12-01 18:57:19 +08005367#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02005368 ssl->transform = ssl->transform_negotiate;
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005369 ssl->transform_in = ssl->transform;
5370 ssl->transform_out = ssl->transform;
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02005371 ssl->transform_negotiate = NULL;
Jerry Yu2e199812022-12-01 18:57:19 +08005372#endif
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005373
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04005374#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005375 prf_func = ssl_tls12prf_from_cs(ssl->session->ciphersuite);
5376 if (prf_func == NULL) {
5377 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5378 }
Andrzej Kurek894edde2022-09-29 06:31:14 -04005379
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005380 /* Read random bytes and populate structure */
Gilles Peskine449bd832023-01-11 14:50:10 +01005381 if ((size_t) (end - p) < sizeof(ssl->transform->randbytes)) {
5382 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5383 }
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04005384
Gilles Peskine449bd832023-01-11 14:50:10 +01005385 ret = ssl_tls12_populate_transform(ssl->transform,
5386 ssl->session->ciphersuite,
5387 ssl->session->master,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02005388#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01005389 ssl->session->encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02005390#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01005391 prf_func,
5392 p, /* currently pointing to randbytes */
5393 MBEDTLS_SSL_VERSION_TLS1_2, /* (D)TLS 1.2 is forced */
5394 ssl->conf->endpoint,
5395 ssl);
5396 if (ret != 0) {
5397 return ret;
5398 }
Jerry Yu840fbb22022-02-17 14:59:29 +08005399#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005400 p += sizeof(ssl->transform->randbytes);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005401
5402#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
5403 /* Read connection IDs and store them */
Gilles Peskine449bd832023-01-11 14:50:10 +01005404 if ((size_t) (end - p) < 1) {
5405 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5406 }
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005407
5408 ssl->transform->in_cid_len = *p++;
5409
Gilles Peskine449bd832023-01-11 14:50:10 +01005410 if ((size_t) (end - p) < ssl->transform->in_cid_len + 1u) {
5411 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5412 }
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005413
Gilles Peskine449bd832023-01-11 14:50:10 +01005414 memcpy(ssl->transform->in_cid, p, ssl->transform->in_cid_len);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005415 p += ssl->transform->in_cid_len;
5416
5417 ssl->transform->out_cid_len = *p++;
5418
Gilles Peskine449bd832023-01-11 14:50:10 +01005419 if ((size_t) (end - p) < ssl->transform->out_cid_len) {
5420 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5421 }
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005422
Gilles Peskine449bd832023-01-11 14:50:10 +01005423 memcpy(ssl->transform->out_cid, p, ssl->transform->out_cid_len);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005424 p += ssl->transform->out_cid_len;
5425#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
5426
5427 /*
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005428 * Saved fields from top-level ssl_context structure
5429 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005430 if ((size_t) (end - p) < 4) {
5431 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5432 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005433
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01005434 ssl->badmac_seen = MBEDTLS_GET_UINT32_BE(p, 0);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005435 p += 4;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005436
5437#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Gilles Peskine449bd832023-01-11 14:50:10 +01005438 if ((size_t) (end - p) < 16) {
5439 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5440 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005441
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01005442 ssl->in_window_top = MBEDTLS_GET_UINT64_BE(p, 0);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005443 p += 8;
5444
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01005445 ssl->in_window = MBEDTLS_GET_UINT64_BE(p, 0);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005446 p += 8;
5447#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
5448
5449#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005450 if ((size_t) (end - p) < 1) {
5451 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5452 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005453
5454 ssl->disable_datagram_packing = *p++;
5455#endif /* MBEDTLS_SSL_PROTO_DTLS */
5456
Gilles Peskine449bd832023-01-11 14:50:10 +01005457 if ((size_t) (end - p) < sizeof(ssl->cur_out_ctr)) {
5458 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5459 }
5460 memcpy(ssl->cur_out_ctr, p, sizeof(ssl->cur_out_ctr));
5461 p += sizeof(ssl->cur_out_ctr);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005462
5463#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005464 if ((size_t) (end - p) < 2) {
5465 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5466 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005467
Dave Rodgmana3d0f612023-11-03 23:34:02 +00005468 ssl->mtu = MBEDTLS_GET_UINT16_BE(p, 0);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005469 p += 2;
5470#endif /* MBEDTLS_SSL_PROTO_DTLS */
5471
5472#if defined(MBEDTLS_SSL_ALPN)
5473 {
5474 uint8_t alpn_len;
5475 const char **cur;
5476
Gilles Peskine449bd832023-01-11 14:50:10 +01005477 if ((size_t) (end - p) < 1) {
5478 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5479 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005480
5481 alpn_len = *p++;
5482
Gilles Peskine449bd832023-01-11 14:50:10 +01005483 if (alpn_len != 0 && ssl->conf->alpn_list != NULL) {
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005484 /* alpn_chosen should point to an item in the configured list */
Gilles Peskine449bd832023-01-11 14:50:10 +01005485 for (cur = ssl->conf->alpn_list; *cur != NULL; cur++) {
5486 if (strlen(*cur) == alpn_len &&
Waleed Elmelegy131b2ff2024-03-14 01:39:39 +00005487 memcmp(p, *cur, alpn_len) == 0) {
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005488 ssl->alpn_chosen = *cur;
5489 break;
5490 }
5491 }
5492 }
5493
5494 /* can only happen on conf mismatch */
Gilles Peskine449bd832023-01-11 14:50:10 +01005495 if (alpn_len != 0 && ssl->alpn_chosen == NULL) {
5496 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5497 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005498
5499 p += alpn_len;
5500 }
5501#endif /* MBEDTLS_SSL_ALPN */
5502
5503 /*
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02005504 * Forced fields from top-level ssl_context structure
5505 *
5506 * Most of them already set to the correct value by mbedtls_ssl_init() and
5507 * mbedtls_ssl_reset(), so we only need to set the remaining ones.
5508 */
5509 ssl->state = MBEDTLS_SSL_HANDSHAKE_OVER;
Glenn Strauss60bfe602022-03-14 19:04:24 -04005510 ssl->tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02005511
Hanno Becker361b10d2019-08-30 10:42:49 +01005512 /* Adjust pointers for header fields of outgoing records to
5513 * the given transform, accounting for explicit IV and CID. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005514 mbedtls_ssl_update_out_pointers(ssl, ssl->transform);
Hanno Becker361b10d2019-08-30 10:42:49 +01005515
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02005516#if defined(MBEDTLS_SSL_PROTO_DTLS)
5517 ssl->in_epoch = 1;
5518#endif
5519
5520 /* mbedtls_ssl_reset() leaves the handshake sub-structure allocated,
5521 * which we don't want - otherwise we'd end up freeing the wrong transform
Hanno Beckerce5f5fd2020-02-05 10:47:44 +00005522 * by calling mbedtls_ssl_handshake_wrapup_free_hs_transform()
5523 * inappropriately. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005524 if (ssl->handshake != NULL) {
5525 mbedtls_ssl_handshake_free(ssl);
5526 mbedtls_free(ssl->handshake);
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02005527 ssl->handshake = NULL;
5528 }
5529
5530 /*
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005531 * Done - should have consumed entire buffer
5532 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005533 if (p != end) {
5534 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5535 }
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005536
Gilles Peskine449bd832023-01-11 14:50:10 +01005537 return 0;
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005538}
5539
5540/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02005541 * Deserialize context: public wrapper for error cleaning
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005542 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005543int mbedtls_ssl_context_load(mbedtls_ssl_context *context,
5544 const unsigned char *buf,
5545 size_t len)
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005546{
Gilles Peskine449bd832023-01-11 14:50:10 +01005547 int ret = ssl_context_load(context, buf, len);
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005548
Gilles Peskine449bd832023-01-11 14:50:10 +01005549 if (ret != 0) {
5550 mbedtls_ssl_free(context);
5551 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005552
Gilles Peskine449bd832023-01-11 14:50:10 +01005553 return ret;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005554}
Manuel Pégourié-Gonnard5c0e3772019-07-23 16:13:17 +02005555#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005556
5557/*
Paul Bakker5121ce52009-01-03 21:22:43 +00005558 * Free an SSL context
5559 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005560void mbedtls_ssl_free(mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00005561{
Gilles Peskine449bd832023-01-11 14:50:10 +01005562 if (ssl == NULL) {
Paul Bakkeraccaffe2014-06-26 13:37:14 +02005563 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01005564 }
Paul Bakkeraccaffe2014-06-26 13:37:14 +02005565
Gilles Peskine449bd832023-01-11 14:50:10 +01005566 MBEDTLS_SSL_DEBUG_MSG(2, ("=> free"));
Paul Bakker5121ce52009-01-03 21:22:43 +00005567
Gilles Peskine449bd832023-01-11 14:50:10 +01005568 if (ssl->out_buf != NULL) {
sander-visserb8aa2072020-05-06 22:05:13 +02005569#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
5570 size_t out_buf_len = ssl->out_buf_len;
5571#else
5572 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
5573#endif
5574
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005575 mbedtls_zeroize_and_free(ssl->out_buf, out_buf_len);
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05005576 ssl->out_buf = NULL;
Paul Bakker5121ce52009-01-03 21:22:43 +00005577 }
5578
Gilles Peskine449bd832023-01-11 14:50:10 +01005579 if (ssl->in_buf != NULL) {
sander-visserb8aa2072020-05-06 22:05:13 +02005580#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
5581 size_t in_buf_len = ssl->in_buf_len;
5582#else
5583 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
5584#endif
5585
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005586 mbedtls_zeroize_and_free(ssl->in_buf, in_buf_len);
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05005587 ssl->in_buf = NULL;
Paul Bakker5121ce52009-01-03 21:22:43 +00005588 }
5589
Gilles Peskine449bd832023-01-11 14:50:10 +01005590 if (ssl->transform) {
5591 mbedtls_ssl_transform_free(ssl->transform);
5592 mbedtls_free(ssl->transform);
Paul Bakker48916f92012-09-16 19:57:18 +00005593 }
5594
Gilles Peskine449bd832023-01-11 14:50:10 +01005595 if (ssl->handshake) {
5596 mbedtls_ssl_handshake_free(ssl);
5597 mbedtls_free(ssl->handshake);
Jerry Yu2e199812022-12-01 18:57:19 +08005598
5599#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005600 mbedtls_ssl_transform_free(ssl->transform_negotiate);
5601 mbedtls_free(ssl->transform_negotiate);
Jerry Yu2e199812022-12-01 18:57:19 +08005602#endif
5603
Gilles Peskine449bd832023-01-11 14:50:10 +01005604 mbedtls_ssl_session_free(ssl->session_negotiate);
5605 mbedtls_free(ssl->session_negotiate);
Paul Bakker48916f92012-09-16 19:57:18 +00005606 }
5607
Ronald Cron6f135e12021-12-08 16:57:54 +01005608#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01005609 mbedtls_ssl_transform_free(ssl->transform_application);
5610 mbedtls_free(ssl->transform_application);
Ronald Cron6f135e12021-12-08 16:57:54 +01005611#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker3aa186f2021-08-10 09:24:19 +01005612
Gilles Peskine449bd832023-01-11 14:50:10 +01005613 if (ssl->session) {
5614 mbedtls_ssl_session_free(ssl->session);
5615 mbedtls_free(ssl->session);
Paul Bakkerc0463502013-02-14 11:19:38 +01005616 }
5617
Manuel Pégourié-Gonnard55fab2d2015-05-11 16:15:19 +02005618#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005619 if (ssl->hostname != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005620 mbedtls_zeroize_and_free(ssl->hostname, strlen(ssl->hostname));
Paul Bakker5121ce52009-01-03 21:22:43 +00005621 }
Paul Bakker0be444a2013-08-27 21:55:01 +02005622#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00005623
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02005624#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005625 mbedtls_free(ssl->cli_id);
Manuel Pégourié-Gonnard43c02182014-07-22 17:32:01 +02005626#endif
5627
Gilles Peskine449bd832023-01-11 14:50:10 +01005628 MBEDTLS_SSL_DEBUG_MSG(2, ("<= free"));
Paul Bakker2da561c2009-02-05 18:00:28 +00005629
Paul Bakker86f04f42013-02-14 11:20:09 +01005630 /* Actually clear after last debug message */
Gilles Peskine449bd832023-01-11 14:50:10 +01005631 mbedtls_platform_zeroize(ssl, sizeof(mbedtls_ssl_context));
Paul Bakker5121ce52009-01-03 21:22:43 +00005632}
5633
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005634/*
Shaun Case8b0ecbc2021-12-20 21:14:10 -08005635 * Initialize mbedtls_ssl_config
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005636 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005637void mbedtls_ssl_config_init(mbedtls_ssl_config *conf)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005638{
Gilles Peskine449bd832023-01-11 14:50:10 +01005639 memset(conf, 0, sizeof(mbedtls_ssl_config));
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005640}
5641
Gilles Peskineae270bf2021-06-02 00:05:29 +02005642/* The selection should be the same as mbedtls_x509_crt_profile_default in
5643 * x509_crt.c, plus Montgomery curves for ECDHE. Here, the order matters:
Gilles Peskineb1940a72021-06-02 15:18:12 +02005644 * curves with a lower resource usage come first.
Gilles Peskineae270bf2021-06-02 00:05:29 +02005645 * See the documentation of mbedtls_ssl_conf_curves() for what we promise
Gilles Peskineb1940a72021-06-02 15:18:12 +02005646 * about this list.
5647 */
Chien Wong4e9683e2023-12-28 17:07:43 +08005648static const uint16_t ssl_preset_default_groups[] = {
Valerio Settidb6b4db2023-09-01 09:20:51 +02005649#if defined(MBEDTLS_ECP_HAVE_CURVE25519)
Brett Warrene0edc842021-08-17 09:53:13 +01005650 MBEDTLS_SSL_IANA_TLS_GROUP_X25519,
Gilles Peskineae270bf2021-06-02 00:05:29 +02005651#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005652#if defined(MBEDTLS_ECP_HAVE_SECP256R1)
Brett Warrene0edc842021-08-17 09:53:13 +01005653 MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1,
Gilles Peskineae270bf2021-06-02 00:05:29 +02005654#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005655#if defined(MBEDTLS_ECP_HAVE_SECP384R1)
Brett Warrene0edc842021-08-17 09:53:13 +01005656 MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02005657#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005658#if defined(MBEDTLS_ECP_HAVE_CURVE448)
Brett Warrene0edc842021-08-17 09:53:13 +01005659 MBEDTLS_SSL_IANA_TLS_GROUP_X448,
Gilles Peskineb1940a72021-06-02 15:18:12 +02005660#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005661#if defined(MBEDTLS_ECP_HAVE_SECP521R1)
Brett Warrene0edc842021-08-17 09:53:13 +01005662 MBEDTLS_SSL_IANA_TLS_GROUP_SECP521R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02005663#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005664#if defined(MBEDTLS_ECP_HAVE_BP256R1)
Brett Warrene0edc842021-08-17 09:53:13 +01005665 MBEDTLS_SSL_IANA_TLS_GROUP_BP256R1,
Gilles Peskineae270bf2021-06-02 00:05:29 +02005666#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005667#if defined(MBEDTLS_ECP_HAVE_BP384R1)
Brett Warrene0edc842021-08-17 09:53:13 +01005668 MBEDTLS_SSL_IANA_TLS_GROUP_BP384R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02005669#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005670#if defined(MBEDTLS_ECP_HAVE_BP512R1)
Brett Warrene0edc842021-08-17 09:53:13 +01005671 MBEDTLS_SSL_IANA_TLS_GROUP_BP512R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02005672#endif
Przemek Stekiel316c19e2023-05-31 15:25:11 +02005673#if defined(PSA_WANT_ALG_FFDH)
Przemek Stekiel383f4712022-12-12 14:48:57 +01005674 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE2048,
5675 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE3072,
5676 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE4096,
5677 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE6144,
5678 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE8192,
5679#endif
Brett Warrene0edc842021-08-17 09:53:13 +01005680 MBEDTLS_SSL_IANA_TLS_GROUP_NONE
Gilles Peskineae270bf2021-06-02 00:05:29 +02005681};
Gilles Peskineae270bf2021-06-02 00:05:29 +02005682
Alexey Tsvetkov2ca34372022-06-07 10:21:05 +03005683static const int ssl_preset_suiteb_ciphersuites[] = {
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005684 MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256,
5685 MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384,
5686 0
5687};
5688
Ronald Crone68ab4f2022-10-05 12:46:29 +02005689#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Hanno Becker9c6aa7b2021-08-10 13:50:43 +01005690
Jerry Yu909df7b2022-01-22 11:56:27 +08005691/* NOTICE:
Jerry Yu0b994b82022-01-25 17:22:12 +08005692 * For ssl_preset_*_sig_algs and ssl_tls12_preset_*_sig_algs, the following
Jerry Yu370e1462022-01-25 10:36:53 +08005693 * rules SHOULD be upheld.
5694 * - No duplicate entries.
5695 * - But if there is a good reason, do not change the order of the algorithms.
Jerry Yu09a99fc2022-07-28 14:22:17 +08005696 * - ssl_tls12_preset* is for TLS 1.2 use only.
Jerry Yu370e1462022-01-25 10:36:53 +08005697 * - ssl_preset_* is for TLS 1.3 only or hybrid TLS 1.3/1.2 handshakes.
Jerry Yu1a8b4812022-01-20 17:56:50 +08005698 */
Chien Wong4e9683e2023-12-28 17:07:43 +08005699static const uint16_t ssl_preset_default_sig_algs[] = {
Jerry Yu1a8b4812022-01-20 17:56:50 +08005700
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005701#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005702 defined(MBEDTLS_MD_CAN_SHA256) && \
Valerio Setticf29c5d2023-09-01 09:03:41 +02005703 defined(PSA_WANT_ECC_SECP_R1_256)
Jerry Yued5e9f42022-01-26 11:21:34 +08005704 MBEDTLS_TLS1_3_SIG_ECDSA_SECP256R1_SHA256,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005705 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256)
5706#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08005707
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005708#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005709 defined(MBEDTLS_MD_CAN_SHA384) && \
Valerio Setticf29c5d2023-09-01 09:03:41 +02005710 defined(PSA_WANT_ECC_SECP_R1_384)
Jerry Yu909df7b2022-01-22 11:56:27 +08005711 MBEDTLS_TLS1_3_SIG_ECDSA_SECP384R1_SHA384,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005712 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384)
5713#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08005714
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005715#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005716 defined(MBEDTLS_MD_CAN_SHA512) && \
Valerio Setticf29c5d2023-09-01 09:03:41 +02005717 defined(PSA_WANT_ECC_SECP_R1_521)
Jerry Yued5e9f42022-01-26 11:21:34 +08005718 MBEDTLS_TLS1_3_SIG_ECDSA_SECP521R1_SHA512,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005719 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA512)
5720#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08005721
Yanray Wang1136fad2023-11-22 16:54:31 +08005722#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && defined(MBEDTLS_MD_CAN_SHA512)
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005723 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA512,
Yanray Wang1136fad2023-11-22 16:54:31 +08005724#endif
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005725
Yanray Wang1136fad2023-11-22 16:54:31 +08005726#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && defined(MBEDTLS_MD_CAN_SHA384)
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005727 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA384,
Yanray Wang1136fad2023-11-22 16:54:31 +08005728#endif
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005729
Yanray Wang1136fad2023-11-22 16:54:31 +08005730#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && defined(MBEDTLS_MD_CAN_SHA256)
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005731 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256,
Yanray Wang1136fad2023-11-22 16:54:31 +08005732#endif
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005733
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005734#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_MD_CAN_SHA512)
Jerry Yu693a47a2022-06-23 14:02:28 +08005735 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA512,
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005736#endif /* MBEDTLS_RSA_C && MBEDTLS_MD_CAN_SHA512 */
Jerry Yu693a47a2022-06-23 14:02:28 +08005737
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005738#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_MD_CAN_SHA384)
Jerry Yu693a47a2022-06-23 14:02:28 +08005739 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA384,
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005740#endif /* MBEDTLS_RSA_C && MBEDTLS_MD_CAN_SHA384 */
Jerry Yu693a47a2022-06-23 14:02:28 +08005741
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005742#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_MD_CAN_SHA256)
Jerry Yu693a47a2022-06-23 14:02:28 +08005743 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA256,
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005744#endif /* MBEDTLS_RSA_C && MBEDTLS_MD_CAN_SHA256 */
Jerry Yu693a47a2022-06-23 14:02:28 +08005745
Gabor Mezei15b95a62022-05-09 16:37:58 +02005746 MBEDTLS_TLS_SIG_NONE
Jerry Yu909df7b2022-01-22 11:56:27 +08005747};
5748
5749/* NOTICE: see above */
5750#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
5751static uint16_t ssl_tls12_preset_default_sig_algs[] = {
Yanray Wang1136fad2023-11-22 16:54:31 +08005752
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005753#if defined(MBEDTLS_MD_CAN_SHA512)
Valerio Settie9646ec2023-08-02 20:02:28 +02005754#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005755 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA512),
Jerry Yu713013f2022-01-17 18:16:35 +08005756#endif
Jerry Yu09a99fc2022-07-28 14:22:17 +08005757#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT)
5758 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA512,
Yanray Wang1136fad2023-11-22 16:54:31 +08005759#endif
Gabor Mezeic1051b62022-05-10 13:13:58 +02005760#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005761 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA512),
Gabor Mezeic1051b62022-05-10 13:13:58 +02005762#endif
Yanray Wang1136fad2023-11-22 16:54:31 +08005763#endif /* MBEDTLS_MD_CAN_SHA512 */
5764
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005765#if defined(MBEDTLS_MD_CAN_SHA384)
Valerio Settie9646ec2023-08-02 20:02:28 +02005766#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005767 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384),
Jerry Yu11f0a9c2022-01-12 18:43:08 +08005768#endif
Jerry Yu09a99fc2022-07-28 14:22:17 +08005769#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT)
5770 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA384,
Yanray Wang1136fad2023-11-22 16:54:31 +08005771#endif
Gabor Mezeic1051b62022-05-10 13:13:58 +02005772#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005773 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA384),
Gabor Mezeic1051b62022-05-10 13:13:58 +02005774#endif
Yanray Wang1136fad2023-11-22 16:54:31 +08005775#endif /* MBEDTLS_MD_CAN_SHA384 */
5776
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005777#if defined(MBEDTLS_MD_CAN_SHA256)
Valerio Settie9646ec2023-08-02 20:02:28 +02005778#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005779 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256),
Jerry Yu11f0a9c2022-01-12 18:43:08 +08005780#endif
Jerry Yu09a99fc2022-07-28 14:22:17 +08005781#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT)
5782 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256,
Yanray Wang1136fad2023-11-22 16:54:31 +08005783#endif
Gabor Mezeic1051b62022-05-10 13:13:58 +02005784#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005785 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA256),
Gabor Mezeic1051b62022-05-10 13:13:58 +02005786#endif
Yanray Wang1136fad2023-11-22 16:54:31 +08005787#endif /* MBEDTLS_MD_CAN_SHA256 */
5788
Gabor Mezei15b95a62022-05-09 16:37:58 +02005789 MBEDTLS_TLS_SIG_NONE
Jerry Yu909df7b2022-01-22 11:56:27 +08005790};
5791#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Yanray Wang1136fad2023-11-22 16:54:31 +08005792
Jerry Yu909df7b2022-01-22 11:56:27 +08005793/* NOTICE: see above */
Chien Wong4e9683e2023-12-28 17:07:43 +08005794static const uint16_t ssl_preset_suiteb_sig_algs[] = {
Jerry Yu909df7b2022-01-22 11:56:27 +08005795
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005796#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Valerio Setti45d56f32023-07-13 17:23:20 +02005797 defined(MBEDTLS_MD_CAN_SHA256) && \
Valerio Settidb6b4db2023-09-01 09:20:51 +02005798 defined(MBEDTLS_ECP_HAVE_SECP256R1)
Jerry Yu909df7b2022-01-22 11:56:27 +08005799 MBEDTLS_TLS1_3_SIG_ECDSA_SECP256R1_SHA256,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005800 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256)
5801#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08005802
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005803#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Valerio Setti45d56f32023-07-13 17:23:20 +02005804 defined(MBEDTLS_MD_CAN_SHA384) && \
Valerio Settidb6b4db2023-09-01 09:20:51 +02005805 defined(MBEDTLS_ECP_HAVE_SECP384R1)
Jerry Yu53037892022-01-25 11:02:06 +08005806 MBEDTLS_TLS1_3_SIG_ECDSA_SECP384R1_SHA384,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005807 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384)
5808#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08005809
Gabor Mezei15b95a62022-05-09 16:37:58 +02005810 MBEDTLS_TLS_SIG_NONE
Jerry Yu713013f2022-01-17 18:16:35 +08005811};
Jerry Yu6106fdc2022-01-12 16:36:14 +08005812
Jerry Yu909df7b2022-01-22 11:56:27 +08005813/* NOTICE: see above */
5814#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
5815static uint16_t ssl_tls12_preset_suiteb_sig_algs[] = {
Yanray Wang1136fad2023-11-22 16:54:31 +08005816
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005817#if defined(MBEDTLS_MD_CAN_SHA256)
Valerio Settie9646ec2023-08-02 20:02:28 +02005818#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005819 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256),
Jerry Yu713013f2022-01-17 18:16:35 +08005820#endif
Yanray Wang1136fad2023-11-22 16:54:31 +08005821#endif /* MBEDTLS_MD_CAN_SHA256 */
Yanray Wang69ceb392023-11-22 16:32:39 +08005822
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005823#if defined(MBEDTLS_MD_CAN_SHA384)
Valerio Settie9646ec2023-08-02 20:02:28 +02005824#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005825 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384),
Jerry Yu18c833e2022-01-25 10:55:47 +08005826#endif
Yanray Wang1136fad2023-11-22 16:54:31 +08005827#endif /* MBEDTLS_MD_CAN_SHA384 */
5828
Gabor Mezei15b95a62022-05-09 16:37:58 +02005829 MBEDTLS_TLS_SIG_NONE
Hanno Becker9c6aa7b2021-08-10 13:50:43 +01005830};
Jerry Yu909df7b2022-01-22 11:56:27 +08005831#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
5832
Ronald Crone68ab4f2022-10-05 12:46:29 +02005833#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005834
Chien Wong4e9683e2023-12-28 17:07:43 +08005835static const uint16_t ssl_preset_suiteb_groups[] = {
Valerio Settidb6b4db2023-09-01 09:20:51 +02005836#if defined(MBEDTLS_ECP_HAVE_SECP256R1)
Brett Warrene0edc842021-08-17 09:53:13 +01005837 MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1,
Jaeden Amerod4311042019-06-03 08:27:16 +01005838#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005839#if defined(MBEDTLS_ECP_HAVE_SECP384R1)
Brett Warrene0edc842021-08-17 09:53:13 +01005840 MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1,
Jaeden Amerod4311042019-06-03 08:27:16 +01005841#endif
Brett Warrene0edc842021-08-17 09:53:13 +01005842 MBEDTLS_SSL_IANA_TLS_GROUP_NONE
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005843};
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005844
Ronald Crone68ab4f2022-10-05 12:46:29 +02005845#if defined(MBEDTLS_DEBUG_C) && defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu909df7b2022-01-22 11:56:27 +08005846/* Function for checking `ssl_preset_*_sig_algs` and `ssl_tls12_preset_*_sig_algs`
Jerry Yu370e1462022-01-25 10:36:53 +08005847 * to make sure there are no duplicated signature algorithm entries. */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005848MBEDTLS_CHECK_RETURN_CRITICAL
Chien Wong4e9683e2023-12-28 17:07:43 +08005849static int ssl_check_no_sig_alg_duplication(const uint16_t *sig_algs)
Jerry Yu1a8b4812022-01-20 17:56:50 +08005850{
5851 size_t i, j;
5852 int ret = 0;
Jerry Yu909df7b2022-01-22 11:56:27 +08005853
Gilles Peskine449bd832023-01-11 14:50:10 +01005854 for (i = 0; sig_algs[i] != MBEDTLS_TLS_SIG_NONE; i++) {
5855 for (j = 0; j < i; j++) {
5856 if (sig_algs[i] != sig_algs[j]) {
Jerry Yuf377d642022-01-25 10:43:59 +08005857 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01005858 }
5859 mbedtls_printf(" entry(%04x,%" MBEDTLS_PRINTF_SIZET
5860 ") is duplicated at %" MBEDTLS_PRINTF_SIZET "\n",
5861 sig_algs[i], j, i);
Jerry Yuf377d642022-01-25 10:43:59 +08005862 ret = -1;
Jerry Yu1a8b4812022-01-20 17:56:50 +08005863 }
5864 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005865 return ret;
Jerry Yu1a8b4812022-01-20 17:56:50 +08005866}
5867
Ronald Crone68ab4f2022-10-05 12:46:29 +02005868#endif /* MBEDTLS_DEBUG_C && MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Jerry Yu1a8b4812022-01-20 17:56:50 +08005869
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005870/*
Tillmann Karras588ad502015-09-25 04:27:22 +02005871 * Load default in mbedtls_ssl_config
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005872 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005873int mbedtls_ssl_config_defaults(mbedtls_ssl_config *conf,
5874 int endpoint, int transport, int preset)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005875{
Manuel Pégourié-Gonnard8b431fb2015-05-11 12:54:52 +02005876#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Janos Follath865b3eb2019-12-16 11:46:15 +00005877 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard8b431fb2015-05-11 12:54:52 +02005878#endif
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005879
Ronald Crone68ab4f2022-10-05 12:46:29 +02005880#if defined(MBEDTLS_DEBUG_C) && defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005881 if (ssl_check_no_sig_alg_duplication(ssl_preset_suiteb_sig_algs)) {
5882 mbedtls_printf("ssl_preset_suiteb_sig_algs has duplicated entries\n");
5883 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu1a8b4812022-01-20 17:56:50 +08005884 }
5885
Gilles Peskine449bd832023-01-11 14:50:10 +01005886 if (ssl_check_no_sig_alg_duplication(ssl_preset_default_sig_algs)) {
5887 mbedtls_printf("ssl_preset_default_sig_algs has duplicated entries\n");
5888 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu1a8b4812022-01-20 17:56:50 +08005889 }
Jerry Yu909df7b2022-01-22 11:56:27 +08005890
5891#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005892 if (ssl_check_no_sig_alg_duplication(ssl_tls12_preset_suiteb_sig_algs)) {
5893 mbedtls_printf("ssl_tls12_preset_suiteb_sig_algs has duplicated entries\n");
5894 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu909df7b2022-01-22 11:56:27 +08005895 }
5896
Gilles Peskine449bd832023-01-11 14:50:10 +01005897 if (ssl_check_no_sig_alg_duplication(ssl_tls12_preset_default_sig_algs)) {
5898 mbedtls_printf("ssl_tls12_preset_default_sig_algs has duplicated entries\n");
5899 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu909df7b2022-01-22 11:56:27 +08005900 }
5901#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Ronald Crone68ab4f2022-10-05 12:46:29 +02005902#endif /* MBEDTLS_DEBUG_C && MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Jerry Yu1a8b4812022-01-20 17:56:50 +08005903
Manuel Pégourié-Gonnard0de074f2015-05-14 12:58:01 +02005904 /* Use the functions here so that they are covered in tests,
5905 * but otherwise access member directly for efficiency */
Gilles Peskine449bd832023-01-11 14:50:10 +01005906 mbedtls_ssl_conf_endpoint(conf, endpoint);
5907 mbedtls_ssl_conf_transport(conf, transport);
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005908
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005909 /*
5910 * Things that are common to all presets
5911 */
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02005912#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005913 if (endpoint == MBEDTLS_SSL_IS_CLIENT) {
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02005914 conf->authmode = MBEDTLS_SSL_VERIFY_REQUIRED;
5915#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Ronald Crond67f8012024-08-28 07:45:57 +02005916 mbedtls_ssl_conf_session_tickets(conf, MBEDTLS_SSL_SESSION_TICKETS_ENABLED);
Ronald Cronbedddd72024-08-27 14:18:50 +02005917#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Ronald Crond67f8012024-08-28 07:45:57 +02005918 mbedtls_ssl_conf_enable_new_session_tickets(conf, MBEDTLS_SSL_NEW_SESSION_TICKETS_DISABLED);
Ronald Cronbedddd72024-08-27 14:18:50 +02005919#endif
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02005920#endif
5921 }
5922#endif
5923
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005924#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
5925 conf->encrypt_then_mac = MBEDTLS_SSL_ETM_ENABLED;
5926#endif
5927
5928#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
5929 conf->extended_ms = MBEDTLS_SSL_EXTENDED_MS_ENABLED;
5930#endif
5931
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02005932#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005933 conf->f_cookie_write = ssl_cookie_write_dummy;
5934 conf->f_cookie_check = ssl_cookie_check_dummy;
5935#endif
5936
5937#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
5938 conf->anti_replay = MBEDTLS_SSL_ANTI_REPLAY_ENABLED;
5939#endif
5940
Janos Follath088ce432017-04-10 12:42:31 +01005941#if defined(MBEDTLS_SSL_SRV_C)
5942 conf->cert_req_ca_list = MBEDTLS_SSL_CERT_REQ_CA_LIST_ENABLED;
TRodziewicz3946f792021-06-14 12:11:18 +02005943 conf->respect_cli_pref = MBEDTLS_SSL_SRV_CIPHERSUITE_ORDER_SERVER;
Janos Follath088ce432017-04-10 12:42:31 +01005944#endif
5945
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005946#if defined(MBEDTLS_SSL_PROTO_DTLS)
5947 conf->hs_timeout_min = MBEDTLS_SSL_DTLS_TIMEOUT_DFL_MIN;
5948 conf->hs_timeout_max = MBEDTLS_SSL_DTLS_TIMEOUT_DFL_MAX;
5949#endif
5950
5951#if defined(MBEDTLS_SSL_RENEGOTIATION)
5952 conf->renego_max_records = MBEDTLS_SSL_RENEGO_MAX_RECORDS_DEFAULT;
Gilles Peskine449bd832023-01-11 14:50:10 +01005953 memset(conf->renego_period, 0x00, 2);
5954 memset(conf->renego_period + 2, 0xFF, 6);
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005955#endif
5956
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005957#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005958 if (endpoint == MBEDTLS_SSL_IS_SERVER) {
Hanno Beckere2defad2021-07-24 05:59:17 +01005959 const unsigned char dhm_p[] =
5960 MBEDTLS_DHM_RFC3526_MODP_2048_P_BIN;
5961 const unsigned char dhm_g[] =
5962 MBEDTLS_DHM_RFC3526_MODP_2048_G_BIN;
Hanno Becker00d0a682017-10-04 13:14:29 +01005963
Gilles Peskine449bd832023-01-11 14:50:10 +01005964 if ((ret = mbedtls_ssl_conf_dh_param_bin(conf,
5965 dhm_p, sizeof(dhm_p),
5966 dhm_g, sizeof(dhm_g))) != 0) {
5967 return ret;
Hanno Beckere2defad2021-07-24 05:59:17 +01005968 }
5969 }
Manuel Pégourié-Gonnardbd990d62015-06-11 14:49:42 +02005970#endif
5971
Ronald Cron6f135e12021-12-08 16:57:54 +01005972#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yu6ee56aa2022-12-06 17:47:22 +08005973
5974#if defined(MBEDTLS_SSL_EARLY_DATA)
Yanray Wangd5ed36f2023-11-07 11:40:43 +08005975 mbedtls_ssl_conf_early_data(conf, MBEDTLS_SSL_EARLY_DATA_DISABLED);
Jerry Yu6ee56aa2022-12-06 17:47:22 +08005976#if defined(MBEDTLS_SSL_SRV_C)
Yanray Wang07517612023-11-07 11:47:36 +08005977 mbedtls_ssl_conf_max_early_data_size(conf, MBEDTLS_SSL_MAX_EARLY_DATA_SIZE);
Jerry Yu6ee56aa2022-12-06 17:47:22 +08005978#endif
5979#endif /* MBEDTLS_SSL_EARLY_DATA */
5980
Jerry Yud0766ec2022-09-22 10:46:57 +08005981#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Jerry Yu1ad7ace2022-08-09 13:28:39 +08005982 mbedtls_ssl_conf_new_session_tickets(
Gilles Peskine449bd832023-01-11 14:50:10 +01005983 conf, MBEDTLS_SSL_TLS1_3_DEFAULT_NEW_SESSION_TICKETS);
Jerry Yu1ad7ace2022-08-09 13:28:39 +08005984#endif
Hanno Becker71f1ed62021-07-24 06:01:47 +01005985 /*
5986 * Allow all TLS 1.3 key exchange modes by default.
5987 */
Xiaofei Bai746f9482021-11-12 08:53:56 +00005988 conf->tls13_kex_modes = MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_ALL;
Ronald Cron6f135e12021-12-08 16:57:54 +01005989#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker71f1ed62021-07-24 06:01:47 +01005990
Gilles Peskine449bd832023-01-11 14:50:10 +01005991 if (transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Glenn Strauss2dfcea22022-03-14 17:26:42 -04005992#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
XiaokangQian4d3a6042022-04-21 13:46:17 +00005993 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
XiaokangQian060d8672022-04-21 09:24:56 +00005994 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
XiaokangQian4d3a6042022-04-21 13:46:17 +00005995#else
Gilles Peskine449bd832023-01-11 14:50:10 +01005996 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
XiaokangQian060d8672022-04-21 09:24:56 +00005997#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01005998 } else {
XiaokangQian4d3a6042022-04-21 13:46:17 +00005999#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
Ronald Cron097ba142023-03-08 16:18:00 +01006000 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
6001 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
XiaokangQian4d3a6042022-04-21 13:46:17 +00006002#elif defined(MBEDTLS_SSL_PROTO_TLS1_3)
6003 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
6004 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
6005#elif defined(MBEDTLS_SSL_PROTO_TLS1_2)
6006 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
6007 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
6008#else
Gilles Peskine449bd832023-01-11 14:50:10 +01006009 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
XiaokangQian4d3a6042022-04-21 13:46:17 +00006010#endif
6011 }
Glenn Strauss2dfcea22022-03-14 17:26:42 -04006012
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02006013 /*
6014 * Preset-specific defaults
6015 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006016 switch (preset) {
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02006017 /*
6018 * NSA Suite B
6019 */
6020 case MBEDTLS_SSL_PRESET_SUITEB:
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02006021
Hanno Beckerd60b6c62021-04-29 12:04:11 +01006022 conf->ciphersuite_list = ssl_preset_suiteb_ciphersuites;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02006023
6024#if defined(MBEDTLS_X509_CRT_PARSE_C)
6025 conf->cert_profile = &mbedtls_x509_crt_profile_suiteb;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02006026#endif
6027
Ronald Crone68ab4f2022-10-05 12:46:29 +02006028#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu909df7b2022-01-22 11:56:27 +08006029#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01006030 if (mbedtls_ssl_conf_is_tls12_only(conf)) {
Jerry Yu909df7b2022-01-22 11:56:27 +08006031 conf->sig_algs = ssl_tls12_preset_suiteb_sig_algs;
Gilles Peskine449bd832023-01-11 14:50:10 +01006032 } else
Jerry Yu909df7b2022-01-22 11:56:27 +08006033#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006034 conf->sig_algs = ssl_preset_suiteb_sig_algs;
Ronald Crone68ab4f2022-10-05 12:46:29 +02006035#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02006036
Manuel Pégourié-Gonnardf07ce3b2023-09-22 11:53:41 +02006037#if defined(MBEDTLS_ECP_C) && !defined(MBEDTLS_DEPRECATED_REMOVED)
Brett Warrene0edc842021-08-17 09:53:13 +01006038 conf->curve_list = NULL;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02006039#endif
Brett Warrene0edc842021-08-17 09:53:13 +01006040 conf->group_list = ssl_preset_suiteb_groups;
Manuel Pégourié-Gonnardc98204e2015-08-11 04:21:01 +02006041 break;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02006042
6043 /*
6044 * Default
6045 */
6046 default:
Ronald Cronf6606552022-03-15 11:23:25 +01006047
Hanno Beckerd60b6c62021-04-29 12:04:11 +01006048 conf->ciphersuite_list = mbedtls_ssl_list_ciphersuites();
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02006049
6050#if defined(MBEDTLS_X509_CRT_PARSE_C)
6051 conf->cert_profile = &mbedtls_x509_crt_profile_default;
6052#endif
6053
Ronald Crone68ab4f2022-10-05 12:46:29 +02006054#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu909df7b2022-01-22 11:56:27 +08006055#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01006056 if (mbedtls_ssl_conf_is_tls12_only(conf)) {
Jerry Yu909df7b2022-01-22 11:56:27 +08006057 conf->sig_algs = ssl_tls12_preset_default_sig_algs;
Gilles Peskine449bd832023-01-11 14:50:10 +01006058 } else
Jerry Yu909df7b2022-01-22 11:56:27 +08006059#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006060 conf->sig_algs = ssl_preset_default_sig_algs;
Ronald Crone68ab4f2022-10-05 12:46:29 +02006061#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02006062
Manuel Pégourié-Gonnardf07ce3b2023-09-22 11:53:41 +02006063#if defined(MBEDTLS_ECP_C) && !defined(MBEDTLS_DEPRECATED_REMOVED)
Brett Warrene0edc842021-08-17 09:53:13 +01006064 conf->curve_list = NULL;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02006065#endif
Brett Warrene0edc842021-08-17 09:53:13 +01006066 conf->group_list = ssl_preset_default_groups;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02006067
6068#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_CLI_C)
6069 conf->dhm_min_bitlen = 1024;
6070#endif
6071 }
6072
Gilles Peskine449bd832023-01-11 14:50:10 +01006073 return 0;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02006074}
6075
6076/*
6077 * Free mbedtls_ssl_config
6078 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006079void mbedtls_ssl_config_free(mbedtls_ssl_config *conf)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02006080{
Troy-Butlerda73abc2024-04-02 13:37:31 -04006081 if (conf == NULL) {
6082 return;
6083 }
6084
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02006085#if defined(MBEDTLS_DHM_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01006086 mbedtls_mpi_free(&conf->dhm_P);
6087 mbedtls_mpi_free(&conf->dhm_G);
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02006088#endif
6089
Ronald Cron73fe8df2022-10-05 14:31:43 +02006090#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED)
Neil Armstrong501c9322022-05-03 09:35:09 +02006091#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01006092 if (!mbedtls_svc_key_id_is_null(conf->psk_opaque)) {
Neil Armstrong501c9322022-05-03 09:35:09 +02006093 conf->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
6094 }
Neil Armstrong8ecd6682022-05-05 11:40:35 +02006095#endif /* MBEDTLS_USE_PSA_CRYPTO */
Gilles Peskine449bd832023-01-11 14:50:10 +01006096 if (conf->psk != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01006097 mbedtls_zeroize_and_free(conf->psk, conf->psk_len);
Azim Khan27e8a122018-03-21 14:24:11 +00006098 conf->psk = NULL;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02006099 conf->psk_len = 0;
junyeonLEE316b1622017-12-20 16:29:30 +09006100 }
6101
Gilles Peskine449bd832023-01-11 14:50:10 +01006102 if (conf->psk_identity != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01006103 mbedtls_zeroize_and_free(conf->psk_identity, conf->psk_identity_len);
Azim Khan27e8a122018-03-21 14:24:11 +00006104 conf->psk_identity = NULL;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02006105 conf->psk_identity_len = 0;
6106 }
Ronald Cron73fe8df2022-10-05 14:31:43 +02006107#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED */
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02006108
6109#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01006110 ssl_key_cert_free(conf->key_cert);
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02006111#endif
6112
Gilles Peskine449bd832023-01-11 14:50:10 +01006113 mbedtls_platform_zeroize(conf, sizeof(mbedtls_ssl_config));
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02006114}
6115
Manuel Pégourié-Gonnard5674a972015-10-19 15:14:03 +02006116#if defined(MBEDTLS_PK_C) && \
Valerio Settie9646ec2023-08-02 20:02:28 +02006117 (defined(MBEDTLS_RSA_C) || defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED))
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02006118/*
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006119 * Convert between MBEDTLS_PK_XXX and SSL_SIG_XXX
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02006120 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006121unsigned char mbedtls_ssl_sig_from_pk(mbedtls_pk_context *pk)
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02006122{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006123#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01006124 if (mbedtls_pk_can_do(pk, MBEDTLS_PK_RSA)) {
6125 return MBEDTLS_SSL_SIG_RSA;
6126 }
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02006127#endif
Valerio Settie9646ec2023-08-02 20:02:28 +02006128#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01006129 if (mbedtls_pk_can_do(pk, MBEDTLS_PK_ECDSA)) {
6130 return MBEDTLS_SSL_SIG_ECDSA;
6131 }
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02006132#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01006133 return MBEDTLS_SSL_SIG_ANON;
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02006134}
6135
Gilles Peskine449bd832023-01-11 14:50:10 +01006136unsigned char mbedtls_ssl_sig_from_pk_alg(mbedtls_pk_type_t type)
Hanno Becker7e5437a2017-04-28 17:15:26 +01006137{
Gilles Peskine449bd832023-01-11 14:50:10 +01006138 switch (type) {
Hanno Becker7e5437a2017-04-28 17:15:26 +01006139 case MBEDTLS_PK_RSA:
Gilles Peskine449bd832023-01-11 14:50:10 +01006140 return MBEDTLS_SSL_SIG_RSA;
Hanno Becker7e5437a2017-04-28 17:15:26 +01006141 case MBEDTLS_PK_ECDSA:
6142 case MBEDTLS_PK_ECKEY:
Gilles Peskine449bd832023-01-11 14:50:10 +01006143 return MBEDTLS_SSL_SIG_ECDSA;
Hanno Becker7e5437a2017-04-28 17:15:26 +01006144 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006145 return MBEDTLS_SSL_SIG_ANON;
Hanno Becker7e5437a2017-04-28 17:15:26 +01006146 }
6147}
6148
Gilles Peskine449bd832023-01-11 14:50:10 +01006149mbedtls_pk_type_t mbedtls_ssl_pk_alg_from_sig(unsigned char sig)
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02006150{
Gilles Peskine449bd832023-01-11 14:50:10 +01006151 switch (sig) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006152#if defined(MBEDTLS_RSA_C)
6153 case MBEDTLS_SSL_SIG_RSA:
Gilles Peskine449bd832023-01-11 14:50:10 +01006154 return MBEDTLS_PK_RSA;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02006155#endif
Valerio Settie9646ec2023-08-02 20:02:28 +02006156#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006157 case MBEDTLS_SSL_SIG_ECDSA:
Gilles Peskine449bd832023-01-11 14:50:10 +01006158 return MBEDTLS_PK_ECDSA;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02006159#endif
6160 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006161 return MBEDTLS_PK_NONE;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02006162 }
6163}
Valerio Settie9646ec2023-08-02 20:02:28 +02006164#endif /* MBEDTLS_PK_C &&
6165 ( MBEDTLS_RSA_C || MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED ) */
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02006166
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02006167/*
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006168 * Convert from MBEDTLS_SSL_HASH_XXX to MBEDTLS_MD_XXX
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02006169 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006170mbedtls_md_type_t mbedtls_ssl_md_alg_from_hash(unsigned char hash)
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02006171{
Gilles Peskine449bd832023-01-11 14:50:10 +01006172 switch (hash) {
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006173#if defined(MBEDTLS_MD_CAN_MD5)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006174 case MBEDTLS_SSL_HASH_MD5:
Gilles Peskine449bd832023-01-11 14:50:10 +01006175 return MBEDTLS_MD_MD5;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02006176#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006177#if defined(MBEDTLS_MD_CAN_SHA1)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006178 case MBEDTLS_SSL_HASH_SHA1:
Gilles Peskine449bd832023-01-11 14:50:10 +01006179 return MBEDTLS_MD_SHA1;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02006180#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006181#if defined(MBEDTLS_MD_CAN_SHA224)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006182 case MBEDTLS_SSL_HASH_SHA224:
Gilles Peskine449bd832023-01-11 14:50:10 +01006183 return MBEDTLS_MD_SHA224;
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02006184#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006185#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006186 case MBEDTLS_SSL_HASH_SHA256:
Gilles Peskine449bd832023-01-11 14:50:10 +01006187 return MBEDTLS_MD_SHA256;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02006188#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006189#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006190 case MBEDTLS_SSL_HASH_SHA384:
Gilles Peskine449bd832023-01-11 14:50:10 +01006191 return MBEDTLS_MD_SHA384;
Mateusz Starzyk3352a532021-04-06 14:28:22 +02006192#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006193#if defined(MBEDTLS_MD_CAN_SHA512)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006194 case MBEDTLS_SSL_HASH_SHA512:
Gilles Peskine449bd832023-01-11 14:50:10 +01006195 return MBEDTLS_MD_SHA512;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02006196#endif
6197 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006198 return MBEDTLS_MD_NONE;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02006199 }
6200}
6201
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006202/*
6203 * Convert from MBEDTLS_MD_XXX to MBEDTLS_SSL_HASH_XXX
6204 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006205unsigned char mbedtls_ssl_hash_from_md_alg(int md)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006206{
Gilles Peskine449bd832023-01-11 14:50:10 +01006207 switch (md) {
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006208#if defined(MBEDTLS_MD_CAN_MD5)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006209 case MBEDTLS_MD_MD5:
Gilles Peskine449bd832023-01-11 14:50:10 +01006210 return MBEDTLS_SSL_HASH_MD5;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006211#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006212#if defined(MBEDTLS_MD_CAN_SHA1)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006213 case MBEDTLS_MD_SHA1:
Gilles Peskine449bd832023-01-11 14:50:10 +01006214 return MBEDTLS_SSL_HASH_SHA1;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006215#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006216#if defined(MBEDTLS_MD_CAN_SHA224)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006217 case MBEDTLS_MD_SHA224:
Gilles Peskine449bd832023-01-11 14:50:10 +01006218 return MBEDTLS_SSL_HASH_SHA224;
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02006219#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006220#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006221 case MBEDTLS_MD_SHA256:
Gilles Peskine449bd832023-01-11 14:50:10 +01006222 return MBEDTLS_SSL_HASH_SHA256;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006223#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006224#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006225 case MBEDTLS_MD_SHA384:
Gilles Peskine449bd832023-01-11 14:50:10 +01006226 return MBEDTLS_SSL_HASH_SHA384;
Mateusz Starzyk3352a532021-04-06 14:28:22 +02006227#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006228#if defined(MBEDTLS_MD_CAN_SHA512)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006229 case MBEDTLS_MD_SHA512:
Gilles Peskine449bd832023-01-11 14:50:10 +01006230 return MBEDTLS_SSL_HASH_SHA512;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006231#endif
6232 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006233 return MBEDTLS_SSL_HASH_NONE;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006234 }
6235}
6236
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01006237/*
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006238 * Check if a curve proposed by the peer is in our list.
Manuel Pégourié-Gonnard9d412d82015-06-17 12:10:46 +02006239 * Return 0 if we're willing to use it, -1 otherwise.
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01006240 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006241int mbedtls_ssl_check_curve_tls_id(const mbedtls_ssl_context *ssl, uint16_t tls_id)
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01006242{
Gilles Peskine449bd832023-01-11 14:50:10 +01006243 const uint16_t *group_list = mbedtls_ssl_get_groups(ssl);
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01006244
Gilles Peskine449bd832023-01-11 14:50:10 +01006245 if (group_list == NULL) {
6246 return -1;
Brett Warrene0edc842021-08-17 09:53:13 +01006247 }
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01006248
Gilles Peskine449bd832023-01-11 14:50:10 +01006249 for (; *group_list != 0; group_list++) {
6250 if (*group_list == tls_id) {
6251 return 0;
6252 }
6253 }
6254
6255 return -1;
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01006256}
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01006257
Valerio Setti49e69072023-06-27 17:27:51 +02006258#if defined(MBEDTLS_PK_HAVE_ECC_KEYS)
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01006259/*
6260 * Same as mbedtls_ssl_check_curve_tls_id() but with a mbedtls_ecp_group_id.
6261 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006262int mbedtls_ssl_check_curve(const mbedtls_ssl_context *ssl, mbedtls_ecp_group_id grp_id)
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01006263{
Gilles Peskine449bd832023-01-11 14:50:10 +01006264 uint16_t tls_id = mbedtls_ssl_get_tls_id_from_ecp_group_id(grp_id);
Leonid Rozenboim19e59732022-08-08 16:52:38 -07006265
Gilles Peskine449bd832023-01-11 14:50:10 +01006266 if (tls_id == 0) {
Leonid Rozenboim19e59732022-08-08 16:52:38 -07006267 return -1;
Gilles Peskine449bd832023-01-11 14:50:10 +01006268 }
Leonid Rozenboim19e59732022-08-08 16:52:38 -07006269
Gilles Peskine449bd832023-01-11 14:50:10 +01006270 return mbedtls_ssl_check_curve_tls_id(ssl, tls_id);
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01006271}
Valerio Setti49e69072023-06-27 17:27:51 +02006272#endif /* MBEDTLS_PK_HAVE_ECC_KEYS */
Valerio Setti67419f02023-01-04 16:12:42 +01006273
Valerio Setti18c9fed2022-12-30 17:44:24 +01006274static const struct {
6275 uint16_t tls_id;
6276 mbedtls_ecp_group_id ecp_group_id;
6277 psa_ecc_family_t psa_family;
6278 uint16_t bits;
Valerio Setti18c9fed2022-12-30 17:44:24 +01006279} tls_id_match_table[] =
6280{
Valerio Settidb6b4db2023-09-01 09:20:51 +02006281#if defined(MBEDTLS_ECP_HAVE_SECP521R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02006282 { 25, MBEDTLS_ECP_DP_SECP521R1, PSA_ECC_FAMILY_SECP_R1, 521 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006283#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02006284#if defined(MBEDTLS_ECP_HAVE_BP512R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02006285 { 28, MBEDTLS_ECP_DP_BP512R1, PSA_ECC_FAMILY_BRAINPOOL_P_R1, 512 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006286#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02006287#if defined(MBEDTLS_ECP_HAVE_SECP384R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02006288 { 24, MBEDTLS_ECP_DP_SECP384R1, PSA_ECC_FAMILY_SECP_R1, 384 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006289#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02006290#if defined(MBEDTLS_ECP_HAVE_BP384R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02006291 { 27, MBEDTLS_ECP_DP_BP384R1, PSA_ECC_FAMILY_BRAINPOOL_P_R1, 384 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006292#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02006293#if defined(MBEDTLS_ECP_HAVE_SECP256R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02006294 { 23, MBEDTLS_ECP_DP_SECP256R1, PSA_ECC_FAMILY_SECP_R1, 256 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006295#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02006296#if defined(MBEDTLS_ECP_HAVE_SECP256K1)
Valerio Settiacd32c02023-06-29 18:06:29 +02006297 { 22, MBEDTLS_ECP_DP_SECP256K1, PSA_ECC_FAMILY_SECP_K1, 256 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006298#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02006299#if defined(MBEDTLS_ECP_HAVE_BP256R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02006300 { 26, MBEDTLS_ECP_DP_BP256R1, PSA_ECC_FAMILY_BRAINPOOL_P_R1, 256 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006301#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02006302#if defined(MBEDTLS_ECP_HAVE_SECP224R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02006303 { 21, MBEDTLS_ECP_DP_SECP224R1, PSA_ECC_FAMILY_SECP_R1, 224 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006304#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02006305#if defined(MBEDTLS_ECP_HAVE_SECP224K1)
Valerio Settiacd32c02023-06-29 18:06:29 +02006306 { 20, MBEDTLS_ECP_DP_SECP224K1, PSA_ECC_FAMILY_SECP_K1, 224 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006307#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02006308#if defined(MBEDTLS_ECP_HAVE_SECP192R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02006309 { 19, MBEDTLS_ECP_DP_SECP192R1, PSA_ECC_FAMILY_SECP_R1, 192 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006310#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02006311#if defined(MBEDTLS_ECP_HAVE_SECP192K1)
Valerio Settiacd32c02023-06-29 18:06:29 +02006312 { 18, MBEDTLS_ECP_DP_SECP192K1, PSA_ECC_FAMILY_SECP_K1, 192 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006313#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02006314#if defined(MBEDTLS_ECP_HAVE_CURVE25519)
Valerio Settiacd32c02023-06-29 18:06:29 +02006315 { 29, MBEDTLS_ECP_DP_CURVE25519, PSA_ECC_FAMILY_MONTGOMERY, 255 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006316#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02006317#if defined(MBEDTLS_ECP_HAVE_CURVE448)
Valerio Settiacd32c02023-06-29 18:06:29 +02006318 { 30, MBEDTLS_ECP_DP_CURVE448, PSA_ECC_FAMILY_MONTGOMERY, 448 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006319#endif
Valerio Settiacd32c02023-06-29 18:06:29 +02006320 { 0, MBEDTLS_ECP_DP_NONE, 0, 0 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006321};
6322
Gilles Peskine449bd832023-01-11 14:50:10 +01006323int mbedtls_ssl_get_psa_curve_info_from_tls_id(uint16_t tls_id,
Przemek Stekielda4fba62023-06-02 14:52:28 +02006324 psa_key_type_t *type,
Gilles Peskine449bd832023-01-11 14:50:10 +01006325 size_t *bits)
Valerio Setti18c9fed2022-12-30 17:44:24 +01006326{
Gilles Peskine449bd832023-01-11 14:50:10 +01006327 for (int i = 0; tls_id_match_table[i].tls_id != 0; i++) {
6328 if (tls_id_match_table[i].tls_id == tls_id) {
Przemek Stekielda4fba62023-06-02 14:52:28 +02006329 if (type != NULL) {
6330 *type = PSA_KEY_TYPE_ECC_KEY_PAIR(tls_id_match_table[i].psa_family);
Gilles Peskine449bd832023-01-11 14:50:10 +01006331 }
6332 if (bits != NULL) {
Valerio Setti18c9fed2022-12-30 17:44:24 +01006333 *bits = tls_id_match_table[i].bits;
Gilles Peskine449bd832023-01-11 14:50:10 +01006334 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01006335 return PSA_SUCCESS;
6336 }
6337 }
6338
6339 return PSA_ERROR_NOT_SUPPORTED;
6340}
6341
Gilles Peskine449bd832023-01-11 14:50:10 +01006342mbedtls_ecp_group_id mbedtls_ssl_get_ecp_group_id_from_tls_id(uint16_t tls_id)
Valerio Setti18c9fed2022-12-30 17:44:24 +01006343{
Gilles Peskine449bd832023-01-11 14:50:10 +01006344 for (int i = 0; tls_id_match_table[i].tls_id != 0; i++) {
6345 if (tls_id_match_table[i].tls_id == tls_id) {
Valerio Setti18c9fed2022-12-30 17:44:24 +01006346 return tls_id_match_table[i].ecp_group_id;
Gilles Peskine449bd832023-01-11 14:50:10 +01006347 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01006348 }
6349
6350 return MBEDTLS_ECP_DP_NONE;
6351}
6352
Gilles Peskine449bd832023-01-11 14:50:10 +01006353uint16_t mbedtls_ssl_get_tls_id_from_ecp_group_id(mbedtls_ecp_group_id grp_id)
Valerio Setti18c9fed2022-12-30 17:44:24 +01006354{
Gilles Peskine449bd832023-01-11 14:50:10 +01006355 for (int i = 0; tls_id_match_table[i].ecp_group_id != MBEDTLS_ECP_DP_NONE;
6356 i++) {
6357 if (tls_id_match_table[i].ecp_group_id == grp_id) {
Valerio Setti18c9fed2022-12-30 17:44:24 +01006358 return tls_id_match_table[i].tls_id;
Gilles Peskine449bd832023-01-11 14:50:10 +01006359 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01006360 }
6361
6362 return 0;
6363}
6364
Valerio Setti67419f02023-01-04 16:12:42 +01006365#if defined(MBEDTLS_DEBUG_C)
Valerio Settiacd32c02023-06-29 18:06:29 +02006366static const struct {
6367 uint16_t tls_id;
6368 const char *name;
6369} tls_id_curve_name_table[] =
6370{
Valerio Setti54e23792023-07-07 10:49:27 +02006371 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP521R1, "secp521r1" },
6372 { MBEDTLS_SSL_IANA_TLS_GROUP_BP512R1, "brainpoolP512r1" },
6373 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1, "secp384r1" },
6374 { MBEDTLS_SSL_IANA_TLS_GROUP_BP384R1, "brainpoolP384r1" },
6375 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1, "secp256r1" },
6376 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP256K1, "secp256k1" },
6377 { MBEDTLS_SSL_IANA_TLS_GROUP_BP256R1, "brainpoolP256r1" },
6378 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP224R1, "secp224r1" },
6379 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP224K1, "secp224k1" },
6380 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP192R1, "secp192r1" },
6381 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP192K1, "secp192k1" },
6382 { MBEDTLS_SSL_IANA_TLS_GROUP_X25519, "x25519" },
6383 { MBEDTLS_SSL_IANA_TLS_GROUP_X448, "x448" },
Valerio Settiacd32c02023-06-29 18:06:29 +02006384 { 0, NULL },
6385};
6386
Gilles Peskine449bd832023-01-11 14:50:10 +01006387const char *mbedtls_ssl_get_curve_name_from_tls_id(uint16_t tls_id)
Valerio Setti18c9fed2022-12-30 17:44:24 +01006388{
Valerio Settiacd32c02023-06-29 18:06:29 +02006389 for (int i = 0; tls_id_curve_name_table[i].tls_id != 0; i++) {
6390 if (tls_id_curve_name_table[i].tls_id == tls_id) {
6391 return tls_id_curve_name_table[i].name;
Gilles Peskine449bd832023-01-11 14:50:10 +01006392 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01006393 }
6394
6395 return NULL;
6396}
Valerio Setti67419f02023-01-04 16:12:42 +01006397#endif
Valerio Setti18c9fed2022-12-30 17:44:24 +01006398
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006399#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01006400int mbedtls_ssl_check_cert_usage(const mbedtls_x509_crt *cert,
6401 const mbedtls_ssl_ciphersuite_t *ciphersuite,
6402 int cert_endpoint,
6403 uint32_t *flags)
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02006404{
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01006405 int ret = 0;
Dave Rodgmanc37ad442023-11-03 23:36:06 +00006406 unsigned int usage = 0;
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02006407 const char *ext_oid;
6408 size_t ext_len;
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02006409
Gilles Peskine449bd832023-01-11 14:50:10 +01006410 if (cert_endpoint == MBEDTLS_SSL_IS_SERVER) {
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02006411 /* Server part of the key exchange */
Gilles Peskine449bd832023-01-11 14:50:10 +01006412 switch (ciphersuite->key_exchange) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006413 case MBEDTLS_KEY_EXCHANGE_RSA:
6414 case MBEDTLS_KEY_EXCHANGE_RSA_PSK:
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01006415 usage = MBEDTLS_X509_KU_KEY_ENCIPHERMENT;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02006416 break;
6417
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006418 case MBEDTLS_KEY_EXCHANGE_DHE_RSA:
6419 case MBEDTLS_KEY_EXCHANGE_ECDHE_RSA:
6420 case MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA:
6421 usage = MBEDTLS_X509_KU_DIGITAL_SIGNATURE;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02006422 break;
6423
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006424 case MBEDTLS_KEY_EXCHANGE_ECDH_RSA:
6425 case MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA:
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01006426 usage = MBEDTLS_X509_KU_KEY_AGREEMENT;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02006427 break;
6428
6429 /* Don't use default: we want warnings when adding new values */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006430 case MBEDTLS_KEY_EXCHANGE_NONE:
6431 case MBEDTLS_KEY_EXCHANGE_PSK:
6432 case MBEDTLS_KEY_EXCHANGE_DHE_PSK:
6433 case MBEDTLS_KEY_EXCHANGE_ECDHE_PSK:
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +02006434 case MBEDTLS_KEY_EXCHANGE_ECJPAKE:
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02006435 usage = 0;
6436 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006437 } else {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006438 /* Client auth: we only implement rsa_sign and mbedtls_ecdsa_sign for now */
6439 usage = MBEDTLS_X509_KU_DIGITAL_SIGNATURE;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02006440 }
6441
Gilles Peskine449bd832023-01-11 14:50:10 +01006442 if (mbedtls_x509_crt_check_key_usage(cert, usage) != 0) {
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01006443 *flags |= MBEDTLS_X509_BADCERT_KEY_USAGE;
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01006444 ret = -1;
6445 }
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02006446
Gilles Peskine449bd832023-01-11 14:50:10 +01006447 if (cert_endpoint == MBEDTLS_SSL_IS_SERVER) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006448 ext_oid = MBEDTLS_OID_SERVER_AUTH;
Gilles Peskine449bd832023-01-11 14:50:10 +01006449 ext_len = MBEDTLS_OID_SIZE(MBEDTLS_OID_SERVER_AUTH);
6450 } else {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006451 ext_oid = MBEDTLS_OID_CLIENT_AUTH;
Gilles Peskine449bd832023-01-11 14:50:10 +01006452 ext_len = MBEDTLS_OID_SIZE(MBEDTLS_OID_CLIENT_AUTH);
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02006453 }
6454
Gilles Peskine449bd832023-01-11 14:50:10 +01006455 if (mbedtls_x509_crt_check_extended_key_usage(cert, ext_oid, ext_len) != 0) {
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01006456 *flags |= MBEDTLS_X509_BADCERT_EXT_KEY_USAGE;
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01006457 ret = -1;
6458 }
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02006459
Gilles Peskine449bd832023-01-11 14:50:10 +01006460 return ret;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02006461}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006462#endif /* MBEDTLS_X509_CRT_PARSE_C */
Manuel Pégourié-Gonnard3a306b92014-04-29 15:11:17 +02006463
Jerry Yu148165c2021-09-24 23:20:59 +08006464#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01006465int mbedtls_ssl_get_handshake_transcript(mbedtls_ssl_context *ssl,
6466 const mbedtls_md_type_t md,
6467 unsigned char *dst,
6468 size_t dst_len,
6469 size_t *olen)
Jerry Yu148165c2021-09-24 23:20:59 +08006470{
Ronald Cronf6893e12022-01-07 22:09:01 +01006471 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
6472 psa_hash_operation_t *hash_operation_to_clone;
6473 psa_hash_operation_t hash_operation = psa_hash_operation_init();
6474
Jerry Yu148165c2021-09-24 23:20:59 +08006475 *olen = 0;
Ronald Cronf6893e12022-01-07 22:09:01 +01006476
Gilles Peskine449bd832023-01-11 14:50:10 +01006477 switch (md) {
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006478#if defined(MBEDTLS_MD_CAN_SHA384)
Gilles Peskine449bd832023-01-11 14:50:10 +01006479 case MBEDTLS_MD_SHA384:
6480 hash_operation_to_clone = &ssl->handshake->fin_sha384_psa;
6481 break;
Ronald Cronf6893e12022-01-07 22:09:01 +01006482#endif
6483
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006484#if defined(MBEDTLS_MD_CAN_SHA256)
Gilles Peskine449bd832023-01-11 14:50:10 +01006485 case MBEDTLS_MD_SHA256:
6486 hash_operation_to_clone = &ssl->handshake->fin_sha256_psa;
6487 break;
Ronald Cronf6893e12022-01-07 22:09:01 +01006488#endif
6489
Gilles Peskine449bd832023-01-11 14:50:10 +01006490 default:
6491 goto exit;
6492 }
6493
6494 status = psa_hash_clone(hash_operation_to_clone, &hash_operation);
6495 if (status != PSA_SUCCESS) {
Ronald Cronf6893e12022-01-07 22:09:01 +01006496 goto exit;
6497 }
6498
Gilles Peskine449bd832023-01-11 14:50:10 +01006499 status = psa_hash_finish(&hash_operation, dst, dst_len, olen);
6500 if (status != PSA_SUCCESS) {
Ronald Cronf6893e12022-01-07 22:09:01 +01006501 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006502 }
Ronald Cronf6893e12022-01-07 22:09:01 +01006503
6504exit:
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006505#if !defined(MBEDTLS_MD_CAN_SHA384) && \
6506 !defined(MBEDTLS_MD_CAN_SHA256)
Andrzej Kurekeabeb302022-10-17 07:52:51 -04006507 (void) ssl;
6508#endif
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05006509 return PSA_TO_MBEDTLS_ERR(status);
Jerry Yu148165c2021-09-24 23:20:59 +08006510}
6511#else /* MBEDTLS_USE_PSA_CRYPTO */
6512
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006513#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006514MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006515static int ssl_get_handshake_transcript_sha384(mbedtls_ssl_context *ssl,
6516 unsigned char *dst,
6517 size_t dst_len,
6518 size_t *olen)
Jerry Yu24c0ec32021-09-09 14:21:07 +08006519{
Jerry Yu24c0ec32021-09-09 14:21:07 +08006520 int ret;
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01006521 mbedtls_md_context_t sha384;
Jerry Yu24c0ec32021-09-09 14:21:07 +08006522
Gilles Peskine449bd832023-01-11 14:50:10 +01006523 if (dst_len < 48) {
6524 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
6525 }
Jerry Yu24c0ec32021-09-09 14:21:07 +08006526
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01006527 mbedtls_md_init(&sha384);
6528 ret = mbedtls_md_setup(&sha384, mbedtls_md_info_from_type(MBEDTLS_MD_SHA384), 0);
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01006529 if (ret != 0) {
6530 goto exit;
6531 }
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01006532 ret = mbedtls_md_clone(&sha384, &ssl->handshake->fin_sha384);
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01006533 if (ret != 0) {
6534 goto exit;
6535 }
Jerry Yu24c0ec32021-09-09 14:21:07 +08006536
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01006537 if ((ret = mbedtls_md_finish(&sha384, dst)) != 0) {
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01006538 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_finish", ret);
Jerry Yu24c0ec32021-09-09 14:21:07 +08006539 goto exit;
6540 }
6541
6542 *olen = 48;
6543
6544exit:
6545
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01006546 mbedtls_md_free(&sha384);
Gilles Peskine449bd832023-01-11 14:50:10 +01006547 return ret;
Jerry Yu24c0ec32021-09-09 14:21:07 +08006548}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006549#endif /* MBEDTLS_MD_CAN_SHA384 */
Jerry Yu24c0ec32021-09-09 14:21:07 +08006550
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006551#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006552MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006553static int ssl_get_handshake_transcript_sha256(mbedtls_ssl_context *ssl,
6554 unsigned char *dst,
6555 size_t dst_len,
6556 size_t *olen)
Jerry Yu24c0ec32021-09-09 14:21:07 +08006557{
Jerry Yu24c0ec32021-09-09 14:21:07 +08006558 int ret;
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01006559 mbedtls_md_context_t sha256;
Jerry Yu24c0ec32021-09-09 14:21:07 +08006560
Gilles Peskine449bd832023-01-11 14:50:10 +01006561 if (dst_len < 32) {
6562 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
6563 }
Jerry Yu24c0ec32021-09-09 14:21:07 +08006564
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01006565 mbedtls_md_init(&sha256);
6566 ret = mbedtls_md_setup(&sha256, mbedtls_md_info_from_type(MBEDTLS_MD_SHA256), 0);
6567 if (ret != 0) {
6568 goto exit;
6569 }
6570 ret = mbedtls_md_clone(&sha256, &ssl->handshake->fin_sha256);
6571 if (ret != 0) {
6572 goto exit;
6573 }
Jerry Yuc5aef882021-12-23 20:15:02 +08006574
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01006575 if ((ret = mbedtls_md_finish(&sha256, dst)) != 0) {
6576 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_finish", ret);
Jerry Yu24c0ec32021-09-09 14:21:07 +08006577 goto exit;
6578 }
6579
6580 *olen = 32;
6581
6582exit:
6583
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01006584 mbedtls_md_free(&sha256);
Gilles Peskine449bd832023-01-11 14:50:10 +01006585 return ret;
Jerry Yu24c0ec32021-09-09 14:21:07 +08006586}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006587#endif /* MBEDTLS_MD_CAN_SHA256 */
Jerry Yu24c0ec32021-09-09 14:21:07 +08006588
Gilles Peskine449bd832023-01-11 14:50:10 +01006589int mbedtls_ssl_get_handshake_transcript(mbedtls_ssl_context *ssl,
6590 const mbedtls_md_type_t md,
6591 unsigned char *dst,
6592 size_t dst_len,
6593 size_t *olen)
Jerry Yu24c0ec32021-09-09 14:21:07 +08006594{
Gilles Peskine449bd832023-01-11 14:50:10 +01006595 switch (md) {
Jerry Yuc1ddeef2021-10-08 15:14:45 +08006596
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006597#if defined(MBEDTLS_MD_CAN_SHA384)
Gilles Peskine449bd832023-01-11 14:50:10 +01006598 case MBEDTLS_MD_SHA384:
6599 return ssl_get_handshake_transcript_sha384(ssl, dst, dst_len, olen);
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006600#endif /* MBEDTLS_MD_CAN_SHA384*/
Jerry Yuc1ddeef2021-10-08 15:14:45 +08006601
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006602#if defined(MBEDTLS_MD_CAN_SHA256)
Gilles Peskine449bd832023-01-11 14:50:10 +01006603 case MBEDTLS_MD_SHA256:
6604 return ssl_get_handshake_transcript_sha256(ssl, dst, dst_len, olen);
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006605#endif /* MBEDTLS_MD_CAN_SHA256*/
Jerry Yuc1ddeef2021-10-08 15:14:45 +08006606
Gilles Peskine449bd832023-01-11 14:50:10 +01006607 default:
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006608#if !defined(MBEDTLS_MD_CAN_SHA384) && \
6609 !defined(MBEDTLS_MD_CAN_SHA256)
Gilles Peskine449bd832023-01-11 14:50:10 +01006610 (void) ssl;
6611 (void) dst;
6612 (void) dst_len;
6613 (void) olen;
Andrzej Kurek409248a2022-10-24 10:33:21 -04006614#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01006615 break;
Jerry Yuc1ddeef2021-10-08 15:14:45 +08006616 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006617 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yu24c0ec32021-09-09 14:21:07 +08006618}
XiaokangQian647719a2021-12-07 09:16:29 +00006619
Jerry Yu148165c2021-09-24 23:20:59 +08006620#endif /* !MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu24c0ec32021-09-09 14:21:07 +08006621
Ronald Crone68ab4f2022-10-05 12:46:29 +02006622#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Gabor Mezei078e8032022-04-27 21:17:56 +02006623/* mbedtls_ssl_parse_sig_alg_ext()
6624 *
6625 * The `extension_data` field of signature algorithm contains a `SignatureSchemeList`
6626 * value (TLS 1.3 RFC8446):
6627 * enum {
6628 * ....
6629 * ecdsa_secp256r1_sha256( 0x0403 ),
6630 * ecdsa_secp384r1_sha384( 0x0503 ),
6631 * ecdsa_secp521r1_sha512( 0x0603 ),
6632 * ....
6633 * } SignatureScheme;
6634 *
6635 * struct {
6636 * SignatureScheme supported_signature_algorithms<2..2^16-2>;
6637 * } SignatureSchemeList;
6638 *
6639 * The `extension_data` field of signature algorithm contains a `SignatureAndHashAlgorithm`
6640 * value (TLS 1.2 RFC5246):
6641 * enum {
6642 * none(0), md5(1), sha1(2), sha224(3), sha256(4), sha384(5),
6643 * sha512(6), (255)
6644 * } HashAlgorithm;
6645 *
6646 * enum { anonymous(0), rsa(1), dsa(2), ecdsa(3), (255) }
6647 * SignatureAlgorithm;
6648 *
6649 * struct {
6650 * HashAlgorithm hash;
6651 * SignatureAlgorithm signature;
6652 * } SignatureAndHashAlgorithm;
6653 *
6654 * SignatureAndHashAlgorithm
6655 * supported_signature_algorithms<2..2^16-2>;
6656 *
6657 * The TLS 1.3 signature algorithm extension was defined to be a compatible
6658 * generalization of the TLS 1.2 signature algorithm extension.
6659 * `SignatureAndHashAlgorithm` field of TLS 1.2 can be represented by
6660 * `SignatureScheme` field of TLS 1.3
6661 *
6662 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006663int mbedtls_ssl_parse_sig_alg_ext(mbedtls_ssl_context *ssl,
6664 const unsigned char *buf,
6665 const unsigned char *end)
Gabor Mezei078e8032022-04-27 21:17:56 +02006666{
6667 const unsigned char *p = buf;
6668 size_t supported_sig_algs_len = 0;
6669 const unsigned char *supported_sig_algs_end;
6670 uint16_t sig_alg;
6671 uint32_t common_idx = 0;
6672
Gilles Peskine449bd832023-01-11 14:50:10 +01006673 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
6674 supported_sig_algs_len = MBEDTLS_GET_UINT16_BE(p, 0);
Gabor Mezei078e8032022-04-27 21:17:56 +02006675 p += 2;
6676
Gilles Peskine449bd832023-01-11 14:50:10 +01006677 memset(ssl->handshake->received_sig_algs, 0,
6678 sizeof(ssl->handshake->received_sig_algs));
Gabor Mezei078e8032022-04-27 21:17:56 +02006679
Gilles Peskine449bd832023-01-11 14:50:10 +01006680 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, supported_sig_algs_len);
Gabor Mezei078e8032022-04-27 21:17:56 +02006681 supported_sig_algs_end = p + supported_sig_algs_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01006682 while (p < supported_sig_algs_end) {
6683 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, supported_sig_algs_end, 2);
6684 sig_alg = MBEDTLS_GET_UINT16_BE(p, 0);
Gabor Mezei078e8032022-04-27 21:17:56 +02006685 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01006686 MBEDTLS_SSL_DEBUG_MSG(4, ("received signature algorithm: 0x%x %s",
6687 sig_alg,
6688 mbedtls_ssl_sig_alg_to_str(sig_alg)));
Jerry Yu2fe6c632022-06-29 10:02:38 +08006689#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01006690 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_2 &&
6691 (!(mbedtls_ssl_sig_alg_is_supported(ssl, sig_alg) &&
6692 mbedtls_ssl_sig_alg_is_offered(ssl, sig_alg)))) {
Gabor Mezei078e8032022-04-27 21:17:56 +02006693 continue;
Jerry Yu2fe6c632022-06-29 10:02:38 +08006694 }
6695#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gabor Mezei078e8032022-04-27 21:17:56 +02006696
Gilles Peskine449bd832023-01-11 14:50:10 +01006697 MBEDTLS_SSL_DEBUG_MSG(4, ("valid signature algorithm: %s",
6698 mbedtls_ssl_sig_alg_to_str(sig_alg)));
Gabor Mezei078e8032022-04-27 21:17:56 +02006699
Gilles Peskine449bd832023-01-11 14:50:10 +01006700 if (common_idx + 1 < MBEDTLS_RECEIVED_SIG_ALGS_SIZE) {
Gabor Mezei078e8032022-04-27 21:17:56 +02006701 ssl->handshake->received_sig_algs[common_idx] = sig_alg;
6702 common_idx += 1;
6703 }
6704 }
6705 /* Check that we consumed all the message. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006706 if (p != end) {
6707 MBEDTLS_SSL_DEBUG_MSG(1,
6708 ("Signature algorithms extension length misaligned"));
6709 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR,
6710 MBEDTLS_ERR_SSL_DECODE_ERROR);
6711 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Gabor Mezei078e8032022-04-27 21:17:56 +02006712 }
6713
Gilles Peskine449bd832023-01-11 14:50:10 +01006714 if (common_idx == 0) {
6715 MBEDTLS_SSL_DEBUG_MSG(3, ("no signature algorithm in common"));
6716 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE,
6717 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE);
6718 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Gabor Mezei078e8032022-04-27 21:17:56 +02006719 }
6720
Gabor Mezei15b95a62022-05-09 16:37:58 +02006721 ssl->handshake->received_sig_algs[common_idx] = MBEDTLS_TLS_SIG_NONE;
Gilles Peskine449bd832023-01-11 14:50:10 +01006722 return 0;
Gabor Mezei078e8032022-04-27 21:17:56 +02006723}
6724
Ronald Crone68ab4f2022-10-05 12:46:29 +02006725#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Gabor Mezei078e8032022-04-27 21:17:56 +02006726
Jerry Yudc7bd172022-02-17 13:44:15 +08006727#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
6728
6729#if defined(MBEDTLS_USE_PSA_CRYPTO)
6730
Gilles Peskine449bd832023-01-11 14:50:10 +01006731static psa_status_t setup_psa_key_derivation(psa_key_derivation_operation_t *derivation,
6732 mbedtls_svc_key_id_t key,
6733 psa_algorithm_t alg,
6734 const unsigned char *raw_psk, size_t raw_psk_length,
6735 const unsigned char *seed, size_t seed_length,
6736 const unsigned char *label, size_t label_length,
6737 const unsigned char *other_secret,
6738 size_t other_secret_length,
6739 size_t capacity)
Jerry Yudc7bd172022-02-17 13:44:15 +08006740{
6741 psa_status_t status;
6742
Gilles Peskine449bd832023-01-11 14:50:10 +01006743 status = psa_key_derivation_setup(derivation, alg);
6744 if (status != PSA_SUCCESS) {
6745 return status;
6746 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006747
Gilles Peskine449bd832023-01-11 14:50:10 +01006748 if (PSA_ALG_IS_TLS12_PRF(alg) || PSA_ALG_IS_TLS12_PSK_TO_MS(alg)) {
6749 status = psa_key_derivation_input_bytes(derivation,
6750 PSA_KEY_DERIVATION_INPUT_SEED,
6751 seed, seed_length);
6752 if (status != PSA_SUCCESS) {
6753 return status;
Przemek Stekiel1f027032022-04-05 17:12:11 +02006754 }
6755
Gilles Peskine449bd832023-01-11 14:50:10 +01006756 if (other_secret != NULL) {
6757 status = psa_key_derivation_input_bytes(derivation,
6758 PSA_KEY_DERIVATION_INPUT_OTHER_SECRET,
6759 other_secret, other_secret_length);
6760 if (status != PSA_SUCCESS) {
6761 return status;
6762 }
6763 }
6764
6765 if (mbedtls_svc_key_id_is_null(key)) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006766 status = psa_key_derivation_input_bytes(
6767 derivation, PSA_KEY_DERIVATION_INPUT_SECRET,
Gilles Peskine449bd832023-01-11 14:50:10 +01006768 raw_psk, raw_psk_length);
6769 } else {
Jerry Yudc7bd172022-02-17 13:44:15 +08006770 status = psa_key_derivation_input_key(
Gilles Peskine449bd832023-01-11 14:50:10 +01006771 derivation, PSA_KEY_DERIVATION_INPUT_SECRET, key);
Jerry Yudc7bd172022-02-17 13:44:15 +08006772 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006773 if (status != PSA_SUCCESS) {
6774 return status;
6775 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006776
Gilles Peskine449bd832023-01-11 14:50:10 +01006777 status = psa_key_derivation_input_bytes(derivation,
6778 PSA_KEY_DERIVATION_INPUT_LABEL,
6779 label, label_length);
6780 if (status != PSA_SUCCESS) {
6781 return status;
6782 }
6783 } else {
6784 return PSA_ERROR_NOT_SUPPORTED;
Jerry Yudc7bd172022-02-17 13:44:15 +08006785 }
6786
Gilles Peskine449bd832023-01-11 14:50:10 +01006787 status = psa_key_derivation_set_capacity(derivation, capacity);
6788 if (status != PSA_SUCCESS) {
6789 return status;
6790 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006791
Gilles Peskine449bd832023-01-11 14:50:10 +01006792 return PSA_SUCCESS;
Jerry Yudc7bd172022-02-17 13:44:15 +08006793}
6794
Andrzej Kurek57d10632022-10-24 10:32:01 -04006795#if defined(PSA_WANT_ALG_SHA_384) || \
6796 defined(PSA_WANT_ALG_SHA_256)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006797MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006798static int tls_prf_generic(mbedtls_md_type_t md_type,
6799 const unsigned char *secret, size_t slen,
6800 const char *label,
6801 const unsigned char *random, size_t rlen,
6802 unsigned char *dstbuf, size_t dlen)
Jerry Yudc7bd172022-02-17 13:44:15 +08006803{
6804 psa_status_t status;
6805 psa_algorithm_t alg;
6806 mbedtls_svc_key_id_t master_key = MBEDTLS_SVC_KEY_ID_INIT;
6807 psa_key_derivation_operation_t derivation =
6808 PSA_KEY_DERIVATION_OPERATION_INIT;
6809
Gilles Peskine449bd832023-01-11 14:50:10 +01006810 if (md_type == MBEDTLS_MD_SHA384) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006811 alg = PSA_ALG_TLS12_PRF(PSA_ALG_SHA_384);
Gilles Peskine449bd832023-01-11 14:50:10 +01006812 } else {
Jerry Yudc7bd172022-02-17 13:44:15 +08006813 alg = PSA_ALG_TLS12_PRF(PSA_ALG_SHA_256);
Gilles Peskine449bd832023-01-11 14:50:10 +01006814 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006815
6816 /* Normally a "secret" should be long enough to be impossible to
6817 * find by brute force, and in particular should not be empty. But
6818 * this PRF is also used to derive an IV, in particular in EAP-TLS,
6819 * and for this use case it makes sense to have a 0-length "secret".
6820 * Since the key API doesn't allow importing a key of length 0,
6821 * keep master_key=0, which setup_psa_key_derivation() understands
6822 * to mean a 0-length "secret" input. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006823 if (slen != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006824 psa_key_attributes_t key_attributes = psa_key_attributes_init();
Gilles Peskine449bd832023-01-11 14:50:10 +01006825 psa_set_key_usage_flags(&key_attributes, PSA_KEY_USAGE_DERIVE);
6826 psa_set_key_algorithm(&key_attributes, alg);
6827 psa_set_key_type(&key_attributes, PSA_KEY_TYPE_DERIVE);
Jerry Yudc7bd172022-02-17 13:44:15 +08006828
Gilles Peskine449bd832023-01-11 14:50:10 +01006829 status = psa_import_key(&key_attributes, secret, slen, &master_key);
6830 if (status != PSA_SUCCESS) {
6831 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
6832 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006833 }
6834
Gilles Peskine449bd832023-01-11 14:50:10 +01006835 status = setup_psa_key_derivation(&derivation,
6836 master_key, alg,
6837 NULL, 0,
6838 random, rlen,
6839 (unsigned char const *) label,
6840 (size_t) strlen(label),
6841 NULL, 0,
6842 dlen);
6843 if (status != PSA_SUCCESS) {
6844 psa_key_derivation_abort(&derivation);
6845 psa_destroy_key(master_key);
6846 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yudc7bd172022-02-17 13:44:15 +08006847 }
6848
Gilles Peskine449bd832023-01-11 14:50:10 +01006849 status = psa_key_derivation_output_bytes(&derivation, dstbuf, dlen);
6850 if (status != PSA_SUCCESS) {
6851 psa_key_derivation_abort(&derivation);
6852 psa_destroy_key(master_key);
6853 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yudc7bd172022-02-17 13:44:15 +08006854 }
6855
Gilles Peskine449bd832023-01-11 14:50:10 +01006856 status = psa_key_derivation_abort(&derivation);
6857 if (status != PSA_SUCCESS) {
6858 psa_destroy_key(master_key);
6859 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yudc7bd172022-02-17 13:44:15 +08006860 }
6861
Gilles Peskine449bd832023-01-11 14:50:10 +01006862 if (!mbedtls_svc_key_id_is_null(master_key)) {
6863 status = psa_destroy_key(master_key);
6864 }
6865 if (status != PSA_SUCCESS) {
6866 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
6867 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006868
Gilles Peskine449bd832023-01-11 14:50:10 +01006869 return 0;
Jerry Yudc7bd172022-02-17 13:44:15 +08006870}
Andrzej Kurek57d10632022-10-24 10:32:01 -04006871#endif /* PSA_WANT_ALG_SHA_256 || PSA_WANT_ALG_SHA_384 */
Jerry Yudc7bd172022-02-17 13:44:15 +08006872#else /* MBEDTLS_USE_PSA_CRYPTO */
6873
Andrzej Kurek57d10632022-10-24 10:32:01 -04006874#if defined(MBEDTLS_MD_C) && \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006875 (defined(MBEDTLS_MD_CAN_SHA256) || \
6876 defined(MBEDTLS_MD_CAN_SHA384))
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006877MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006878static int tls_prf_generic(mbedtls_md_type_t md_type,
6879 const unsigned char *secret, size_t slen,
6880 const char *label,
6881 const unsigned char *random, size_t rlen,
6882 unsigned char *dstbuf, size_t dlen)
Jerry Yudc7bd172022-02-17 13:44:15 +08006883{
6884 size_t nb;
6885 size_t i, j, k, md_len;
6886 unsigned char *tmp;
6887 size_t tmp_len = 0;
6888 unsigned char h_i[MBEDTLS_MD_MAX_SIZE];
6889 const mbedtls_md_info_t *md_info;
6890 mbedtls_md_context_t md_ctx;
6891 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6892
Gilles Peskine449bd832023-01-11 14:50:10 +01006893 mbedtls_md_init(&md_ctx);
Jerry Yudc7bd172022-02-17 13:44:15 +08006894
Gilles Peskine449bd832023-01-11 14:50:10 +01006895 if ((md_info = mbedtls_md_info_from_type(md_type)) == NULL) {
6896 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
6897 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006898
Gilles Peskine449bd832023-01-11 14:50:10 +01006899 md_len = mbedtls_md_get_size(md_info);
Jerry Yudc7bd172022-02-17 13:44:15 +08006900
Gilles Peskine449bd832023-01-11 14:50:10 +01006901 tmp_len = md_len + strlen(label) + rlen;
6902 tmp = mbedtls_calloc(1, tmp_len);
6903 if (tmp == NULL) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006904 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
6905 goto exit;
6906 }
6907
Gilles Peskine449bd832023-01-11 14:50:10 +01006908 nb = strlen(label);
6909 memcpy(tmp + md_len, label, nb);
6910 memcpy(tmp + md_len + nb, random, rlen);
Jerry Yudc7bd172022-02-17 13:44:15 +08006911 nb += rlen;
6912
6913 /*
6914 * Compute P_<hash>(secret, label + random)[0..dlen]
6915 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006916 if ((ret = mbedtls_md_setup(&md_ctx, md_info, 1)) != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006917 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006918 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006919
Gilles Peskine449bd832023-01-11 14:50:10 +01006920 ret = mbedtls_md_hmac_starts(&md_ctx, secret, slen);
6921 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006922 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006923 }
6924 ret = mbedtls_md_hmac_update(&md_ctx, tmp + md_len, nb);
6925 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006926 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006927 }
6928 ret = mbedtls_md_hmac_finish(&md_ctx, tmp);
6929 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006930 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006931 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006932
Gilles Peskine449bd832023-01-11 14:50:10 +01006933 for (i = 0; i < dlen; i += md_len) {
6934 ret = mbedtls_md_hmac_reset(&md_ctx);
6935 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006936 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006937 }
6938 ret = mbedtls_md_hmac_update(&md_ctx, tmp, md_len + nb);
6939 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006940 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006941 }
6942 ret = mbedtls_md_hmac_finish(&md_ctx, h_i);
6943 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006944 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006945 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006946
Gilles Peskine449bd832023-01-11 14:50:10 +01006947 ret = mbedtls_md_hmac_reset(&md_ctx);
6948 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006949 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006950 }
6951 ret = mbedtls_md_hmac_update(&md_ctx, tmp, md_len);
6952 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006953 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006954 }
6955 ret = mbedtls_md_hmac_finish(&md_ctx, tmp);
6956 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006957 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006958 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006959
Gilles Peskine449bd832023-01-11 14:50:10 +01006960 k = (i + md_len > dlen) ? dlen % md_len : md_len;
Jerry Yudc7bd172022-02-17 13:44:15 +08006961
Gilles Peskine449bd832023-01-11 14:50:10 +01006962 for (j = 0; j < k; j++) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006963 dstbuf[i + j] = h_i[j];
Gilles Peskine449bd832023-01-11 14:50:10 +01006964 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006965 }
6966
6967exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01006968 mbedtls_md_free(&md_ctx);
Jerry Yudc7bd172022-02-17 13:44:15 +08006969
Gilles Peskine449bd832023-01-11 14:50:10 +01006970 if (tmp != NULL) {
6971 mbedtls_platform_zeroize(tmp, tmp_len);
6972 }
Dave Rodgman29b9b2b2022-11-01 16:08:14 +00006973
Gilles Peskine449bd832023-01-11 14:50:10 +01006974 mbedtls_platform_zeroize(h_i, sizeof(h_i));
Jerry Yudc7bd172022-02-17 13:44:15 +08006975
Gilles Peskine449bd832023-01-11 14:50:10 +01006976 mbedtls_free(tmp);
Jerry Yudc7bd172022-02-17 13:44:15 +08006977
Gilles Peskine449bd832023-01-11 14:50:10 +01006978 return ret;
Jerry Yudc7bd172022-02-17 13:44:15 +08006979}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006980#endif /* MBEDTLS_MD_C && ( MBEDTLS_MD_CAN_SHA256 || MBEDTLS_MD_CAN_SHA384 ) */
Jerry Yudc7bd172022-02-17 13:44:15 +08006981#endif /* MBEDTLS_USE_PSA_CRYPTO */
6982
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006983#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006984MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006985static int tls_prf_sha256(const unsigned char *secret, size_t slen,
6986 const char *label,
6987 const unsigned char *random, size_t rlen,
6988 unsigned char *dstbuf, size_t dlen)
Jerry Yudc7bd172022-02-17 13:44:15 +08006989{
Gilles Peskine449bd832023-01-11 14:50:10 +01006990 return tls_prf_generic(MBEDTLS_MD_SHA256, secret, slen,
6991 label, random, rlen, dstbuf, dlen);
Jerry Yudc7bd172022-02-17 13:44:15 +08006992}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006993#endif /* MBEDTLS_MD_CAN_SHA256*/
Jerry Yudc7bd172022-02-17 13:44:15 +08006994
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006995#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006996MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006997static int tls_prf_sha384(const unsigned char *secret, size_t slen,
6998 const char *label,
6999 const unsigned char *random, size_t rlen,
7000 unsigned char *dstbuf, size_t dlen)
Jerry Yudc7bd172022-02-17 13:44:15 +08007001{
Gilles Peskine449bd832023-01-11 14:50:10 +01007002 return tls_prf_generic(MBEDTLS_MD_SHA384, secret, slen,
7003 label, random, rlen, dstbuf, dlen);
Jerry Yudc7bd172022-02-17 13:44:15 +08007004}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01007005#endif /* MBEDTLS_MD_CAN_SHA384*/
Jerry Yudc7bd172022-02-17 13:44:15 +08007006
Jerry Yuf009d862022-02-17 14:01:37 +08007007/*
7008 * Set appropriate PRF function and other SSL / TLS1.2 functions
7009 *
7010 * Inputs:
Jerry Yuf009d862022-02-17 14:01:37 +08007011 * - hash associated with the ciphersuite (only used by TLS 1.2)
7012 *
7013 * Outputs:
7014 * - the tls_prf, calc_verify and calc_finished members of handshake structure
7015 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007016MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007017static int ssl_set_handshake_prfs(mbedtls_ssl_handshake_params *handshake,
7018 mbedtls_md_type_t hash)
Jerry Yuf009d862022-02-17 14:01:37 +08007019{
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01007020#if defined(MBEDTLS_MD_CAN_SHA384)
Gilles Peskine449bd832023-01-11 14:50:10 +01007021 if (hash == MBEDTLS_MD_SHA384) {
Jerry Yuf009d862022-02-17 14:01:37 +08007022 handshake->tls_prf = tls_prf_sha384;
7023 handshake->calc_verify = ssl_calc_verify_tls_sha384;
7024 handshake->calc_finished = ssl_calc_finished_tls_sha384;
Gilles Peskine449bd832023-01-11 14:50:10 +01007025 } else
Jerry Yuf009d862022-02-17 14:01:37 +08007026#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01007027#if defined(MBEDTLS_MD_CAN_SHA256)
Jerry Yuf009d862022-02-17 14:01:37 +08007028 {
Ronald Cron81591aa2022-03-07 09:05:51 +01007029 (void) hash;
Jerry Yuf009d862022-02-17 14:01:37 +08007030 handshake->tls_prf = tls_prf_sha256;
7031 handshake->calc_verify = ssl_calc_verify_tls_sha256;
7032 handshake->calc_finished = ssl_calc_finished_tls_sha256;
7033 }
Ronald Cron81591aa2022-03-07 09:05:51 +01007034#else
Jerry Yuf009d862022-02-17 14:01:37 +08007035 {
Jerry Yuf009d862022-02-17 14:01:37 +08007036 (void) handshake;
Ronald Cron81591aa2022-03-07 09:05:51 +01007037 (void) hash;
Gilles Peskine449bd832023-01-11 14:50:10 +01007038 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yuf009d862022-02-17 14:01:37 +08007039 }
Ronald Cron81591aa2022-03-07 09:05:51 +01007040#endif
Jerry Yuf009d862022-02-17 14:01:37 +08007041
Gilles Peskine449bd832023-01-11 14:50:10 +01007042 return 0;
Jerry Yuf009d862022-02-17 14:01:37 +08007043}
Jerry Yud6ab2352022-02-17 14:03:43 +08007044
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007045/*
7046 * Compute master secret if needed
7047 *
7048 * Parameters:
7049 * [in/out] handshake
7050 * [in] resume, premaster, extended_ms, calc_verify, tls_prf
7051 * (PSA-PSK) ciphersuite_info, psk_opaque
7052 * [out] premaster (cleared)
7053 * [out] master
7054 * [in] ssl: optionally used for debugging, EMS and PSA-PSK
7055 * debug: conf->f_dbg, conf->p_dbg
7056 * EMS: passed to calc_verify (debug + session_negotiate)
Ronald Crona25cf582022-03-07 11:10:36 +01007057 * PSA-PSA: conf
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007058 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007059MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007060static int ssl_compute_master(mbedtls_ssl_handshake_params *handshake,
7061 unsigned char *master,
7062 const mbedtls_ssl_context *ssl)
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007063{
7064 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7065
7066 /* cf. RFC 5246, Section 8.1:
7067 * "The master secret is always exactly 48 bytes in length." */
7068 size_t const master_secret_len = 48;
7069
7070#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
7071 unsigned char session_hash[48];
7072#endif /* MBEDTLS_SSL_EXTENDED_MASTER_SECRET */
7073
7074 /* The label for the KDF used for key expansion.
7075 * This is either "master secret" or "extended master secret"
7076 * depending on whether the Extended Master Secret extension
7077 * is used. */
7078 char const *lbl = "master secret";
7079
Przemek Stekielae4ed302022-04-05 17:15:55 +02007080 /* The seed for the KDF used for key expansion.
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007081 * - If the Extended Master Secret extension is not used,
7082 * this is ClientHello.Random + ServerHello.Random
7083 * (see Sect. 8.1 in RFC 5246).
7084 * - If the Extended Master Secret extension is used,
7085 * this is the transcript of the handshake so far.
7086 * (see Sect. 4 in RFC 7627). */
Przemek Stekielae4ed302022-04-05 17:15:55 +02007087 unsigned char const *seed = handshake->randbytes;
7088 size_t seed_len = 64;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007089
7090#if !defined(MBEDTLS_DEBUG_C) && \
7091 !defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET) && \
7092 !(defined(MBEDTLS_USE_PSA_CRYPTO) && \
Gilles Peskine449bd832023-01-11 14:50:10 +01007093 defined(MBEDTLS_KEY_EXCHANGE_PSK_ENABLED))
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007094 ssl = NULL; /* make sure we don't use it except for those cases */
7095 (void) ssl;
7096#endif
7097
Gilles Peskine449bd832023-01-11 14:50:10 +01007098 if (handshake->resume != 0) {
7099 MBEDTLS_SSL_DEBUG_MSG(3, ("no premaster (session resumed)"));
7100 return 0;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007101 }
7102
7103#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
Gilles Peskine449bd832023-01-11 14:50:10 +01007104 if (handshake->extended_ms == MBEDTLS_SSL_EXTENDED_MS_ENABLED) {
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007105 lbl = "extended master secret";
Przemek Stekielae4ed302022-04-05 17:15:55 +02007106 seed = session_hash;
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01007107 ret = handshake->calc_verify(ssl, session_hash, &seed_len);
7108 if (ret != 0) {
7109 MBEDTLS_SSL_DEBUG_RET(1, "calc_verify", ret);
7110 }
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007111
Gilles Peskine449bd832023-01-11 14:50:10 +01007112 MBEDTLS_SSL_DEBUG_BUF(3, "session hash for extended master secret",
7113 session_hash, seed_len);
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007114 }
Przemek Stekiel169bf0b2022-04-29 07:53:29 +02007115#endif /* MBEDTLS_SSL_EXTENDED_MASTER_SECRET */
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007116
Przemek Stekiel99114f32022-04-22 11:20:09 +02007117#if defined(MBEDTLS_USE_PSA_CRYPTO) && \
Przemek Stekiel8a4b7fd2022-04-28 09:22:22 +02007118 defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007119 if (mbedtls_ssl_ciphersuite_uses_psk(handshake->ciphersuite_info) == 1) {
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007120 /* Perform PSK-to-MS expansion in a single step. */
7121 psa_status_t status;
7122 psa_algorithm_t alg;
7123 mbedtls_svc_key_id_t psk;
7124 psa_key_derivation_operation_t derivation =
7125 PSA_KEY_DERIVATION_OPERATION_INIT;
Dave Rodgman2eab4622023-10-05 13:30:37 +01007126 mbedtls_md_type_t hash_alg = (mbedtls_md_type_t) handshake->ciphersuite_info->mac;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007127
Gilles Peskine449bd832023-01-11 14:50:10 +01007128 MBEDTLS_SSL_DEBUG_MSG(2, ("perform PSA-based PSK-to-MS expansion"));
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007129
Gilles Peskine449bd832023-01-11 14:50:10 +01007130 psk = mbedtls_ssl_get_opaque_psk(ssl);
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007131
Gilles Peskine449bd832023-01-11 14:50:10 +01007132 if (hash_alg == MBEDTLS_MD_SHA384) {
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007133 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_384);
Gilles Peskine449bd832023-01-11 14:50:10 +01007134 } else {
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007135 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_256);
Gilles Peskine449bd832023-01-11 14:50:10 +01007136 }
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007137
Przemek Stekiel51a1f362022-04-13 08:57:06 +02007138 size_t other_secret_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01007139 unsigned char *other_secret = NULL;
Przemek Stekielc2033402022-04-05 17:19:41 +02007140
Gilles Peskine449bd832023-01-11 14:50:10 +01007141 switch (handshake->ciphersuite_info->key_exchange) {
Przemek Stekiel19b80f82022-04-14 08:29:31 +02007142 /* Provide other secret.
Przemek Stekiel51a1f362022-04-13 08:57:06 +02007143 * Other secret is stored in premaster, where first 2 bytes hold the
Przemek Stekiel19b80f82022-04-14 08:29:31 +02007144 * length of the other key.
Przemek Stekielc2033402022-04-05 17:19:41 +02007145 */
Przemek Stekiel19b80f82022-04-14 08:29:31 +02007146 case MBEDTLS_KEY_EXCHANGE_RSA_PSK:
Przemek Stekiel8abcee92022-04-28 09:16:28 +02007147 /* For RSA-PSK other key length is always 48 bytes. */
Przemek Stekiel19b80f82022-04-14 08:29:31 +02007148 other_secret_len = 48;
7149 other_secret = handshake->premaster + 2;
7150 break;
7151 case MBEDTLS_KEY_EXCHANGE_ECDHE_PSK:
Przemek Stekielb293aaa2022-04-19 12:22:38 +02007152 case MBEDTLS_KEY_EXCHANGE_DHE_PSK:
Przemek Stekiel19b80f82022-04-14 08:29:31 +02007153 other_secret_len = MBEDTLS_GET_UINT16_BE(handshake->premaster, 0);
7154 other_secret = handshake->premaster + 2;
7155 break;
7156 default:
7157 break;
Przemek Stekielc2033402022-04-05 17:19:41 +02007158 }
7159
Gilles Peskine449bd832023-01-11 14:50:10 +01007160 status = setup_psa_key_derivation(&derivation, psk, alg,
7161 ssl->conf->psk, ssl->conf->psk_len,
7162 seed, seed_len,
7163 (unsigned char const *) lbl,
7164 (size_t) strlen(lbl),
7165 other_secret, other_secret_len,
7166 master_secret_len);
7167 if (status != PSA_SUCCESS) {
7168 psa_key_derivation_abort(&derivation);
7169 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007170 }
7171
Gilles Peskine449bd832023-01-11 14:50:10 +01007172 status = psa_key_derivation_output_bytes(&derivation,
7173 master,
7174 master_secret_len);
7175 if (status != PSA_SUCCESS) {
7176 psa_key_derivation_abort(&derivation);
7177 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007178 }
7179
Gilles Peskine449bd832023-01-11 14:50:10 +01007180 status = psa_key_derivation_abort(&derivation);
7181 if (status != PSA_SUCCESS) {
7182 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
7183 }
7184 } else
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007185#endif
7186 {
Neil Armstrongca7d5062022-05-31 14:43:23 +02007187#if defined(MBEDTLS_USE_PSA_CRYPTO) && \
Gilles Peskine449bd832023-01-11 14:50:10 +01007188 defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
7189 if (handshake->ciphersuite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_ECJPAKE) {
Neil Armstrongca7d5062022-05-31 14:43:23 +02007190 psa_status_t status;
7191 psa_algorithm_t alg = PSA_ALG_TLS12_ECJPAKE_TO_PMS;
7192 psa_key_derivation_operation_t derivation =
7193 PSA_KEY_DERIVATION_OPERATION_INIT;
7194
Gilles Peskine449bd832023-01-11 14:50:10 +01007195 MBEDTLS_SSL_DEBUG_MSG(2, ("perform PSA-based PMS KDF for ECJPAKE"));
Neil Armstrongca7d5062022-05-31 14:43:23 +02007196
7197 handshake->pmslen = PSA_TLS12_ECJPAKE_TO_PMS_DATA_SIZE;
7198
Gilles Peskine449bd832023-01-11 14:50:10 +01007199 status = psa_key_derivation_setup(&derivation, alg);
7200 if (status != PSA_SUCCESS) {
7201 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Neil Armstrongca7d5062022-05-31 14:43:23 +02007202 }
7203
Gilles Peskine449bd832023-01-11 14:50:10 +01007204 status = psa_key_derivation_set_capacity(&derivation,
7205 PSA_TLS12_ECJPAKE_TO_PMS_DATA_SIZE);
7206 if (status != PSA_SUCCESS) {
7207 psa_key_derivation_abort(&derivation);
7208 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Neil Armstrongca7d5062022-05-31 14:43:23 +02007209 }
7210
Gilles Peskine449bd832023-01-11 14:50:10 +01007211 status = psa_pake_get_implicit_key(&handshake->psa_pake_ctx,
7212 &derivation);
7213 if (status != PSA_SUCCESS) {
7214 psa_key_derivation_abort(&derivation);
7215 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Neil Armstrongca7d5062022-05-31 14:43:23 +02007216 }
7217
Gilles Peskine449bd832023-01-11 14:50:10 +01007218 status = psa_key_derivation_output_bytes(&derivation,
7219 handshake->premaster,
7220 handshake->pmslen);
7221 if (status != PSA_SUCCESS) {
7222 psa_key_derivation_abort(&derivation);
7223 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
7224 }
7225
7226 status = psa_key_derivation_abort(&derivation);
7227 if (status != PSA_SUCCESS) {
7228 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Neil Armstrongca7d5062022-05-31 14:43:23 +02007229 }
7230 }
7231#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01007232 ret = handshake->tls_prf(handshake->premaster, handshake->pmslen,
7233 lbl, seed, seed_len,
7234 master,
7235 master_secret_len);
7236 if (ret != 0) {
7237 MBEDTLS_SSL_DEBUG_RET(1, "prf", ret);
7238 return ret;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007239 }
7240
Gilles Peskine449bd832023-01-11 14:50:10 +01007241 MBEDTLS_SSL_DEBUG_BUF(3, "premaster secret",
7242 handshake->premaster,
7243 handshake->pmslen);
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007244
Gilles Peskine449bd832023-01-11 14:50:10 +01007245 mbedtls_platform_zeroize(handshake->premaster,
7246 sizeof(handshake->premaster));
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007247 }
7248
Gilles Peskine449bd832023-01-11 14:50:10 +01007249 return 0;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007250}
7251
Gilles Peskine449bd832023-01-11 14:50:10 +01007252int mbedtls_ssl_derive_keys(mbedtls_ssl_context *ssl)
Jerry Yud62f87e2022-02-17 14:09:02 +08007253{
7254 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7255 const mbedtls_ssl_ciphersuite_t * const ciphersuite_info =
7256 ssl->handshake->ciphersuite_info;
7257
Gilles Peskine449bd832023-01-11 14:50:10 +01007258 MBEDTLS_SSL_DEBUG_MSG(2, ("=> derive keys"));
Jerry Yud62f87e2022-02-17 14:09:02 +08007259
7260 /* Set PRF, calc_verify and calc_finished function pointers */
Gilles Peskine449bd832023-01-11 14:50:10 +01007261 ret = ssl_set_handshake_prfs(ssl->handshake,
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01007262 (mbedtls_md_type_t) ciphersuite_info->mac);
Gilles Peskine449bd832023-01-11 14:50:10 +01007263 if (ret != 0) {
7264 MBEDTLS_SSL_DEBUG_RET(1, "ssl_set_handshake_prfs", ret);
7265 return ret;
Jerry Yud62f87e2022-02-17 14:09:02 +08007266 }
7267
7268 /* Compute master secret if needed */
Gilles Peskine449bd832023-01-11 14:50:10 +01007269 ret = ssl_compute_master(ssl->handshake,
7270 ssl->session_negotiate->master,
7271 ssl);
7272 if (ret != 0) {
7273 MBEDTLS_SSL_DEBUG_RET(1, "ssl_compute_master", ret);
7274 return ret;
Jerry Yud62f87e2022-02-17 14:09:02 +08007275 }
7276
7277 /* Swap the client and server random values:
7278 * - MS derivation wanted client+server (RFC 5246 8.1)
7279 * - key derivation wants server+client (RFC 5246 6.3) */
7280 {
7281 unsigned char tmp[64];
Gilles Peskine449bd832023-01-11 14:50:10 +01007282 memcpy(tmp, ssl->handshake->randbytes, 64);
7283 memcpy(ssl->handshake->randbytes, tmp + 32, 32);
7284 memcpy(ssl->handshake->randbytes + 32, tmp, 32);
7285 mbedtls_platform_zeroize(tmp, sizeof(tmp));
Jerry Yud62f87e2022-02-17 14:09:02 +08007286 }
7287
7288 /* Populate transform structure */
Gilles Peskine449bd832023-01-11 14:50:10 +01007289 ret = ssl_tls12_populate_transform(ssl->transform_negotiate,
7290 ssl->session_negotiate->ciphersuite,
7291 ssl->session_negotiate->master,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02007292#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01007293 ssl->session_negotiate->encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02007294#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01007295 ssl->handshake->tls_prf,
7296 ssl->handshake->randbytes,
7297 ssl->tls_version,
7298 ssl->conf->endpoint,
7299 ssl);
7300 if (ret != 0) {
7301 MBEDTLS_SSL_DEBUG_RET(1, "ssl_tls12_populate_transform", ret);
7302 return ret;
Jerry Yud62f87e2022-02-17 14:09:02 +08007303 }
7304
7305 /* We no longer need Server/ClientHello.random values */
Gilles Peskine449bd832023-01-11 14:50:10 +01007306 mbedtls_platform_zeroize(ssl->handshake->randbytes,
7307 sizeof(ssl->handshake->randbytes));
Jerry Yud62f87e2022-02-17 14:09:02 +08007308
Gilles Peskine449bd832023-01-11 14:50:10 +01007309 MBEDTLS_SSL_DEBUG_MSG(2, ("<= derive keys"));
Jerry Yud62f87e2022-02-17 14:09:02 +08007310
Gilles Peskine449bd832023-01-11 14:50:10 +01007311 return 0;
Jerry Yud62f87e2022-02-17 14:09:02 +08007312}
Jerry Yu8392e0d2022-02-17 14:10:24 +08007313
Gilles Peskine449bd832023-01-11 14:50:10 +01007314int mbedtls_ssl_set_calc_verify_md(mbedtls_ssl_context *ssl, int md)
Ronald Cron4dcbca92022-03-07 10:21:40 +01007315{
Gilles Peskine449bd832023-01-11 14:50:10 +01007316 switch (md) {
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01007317#if defined(MBEDTLS_MD_CAN_SHA384)
Ronald Cron4dcbca92022-03-07 10:21:40 +01007318 case MBEDTLS_SSL_HASH_SHA384:
7319 ssl->handshake->calc_verify = ssl_calc_verify_tls_sha384;
7320 break;
7321#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01007322#if defined(MBEDTLS_MD_CAN_SHA256)
Ronald Cron4dcbca92022-03-07 10:21:40 +01007323 case MBEDTLS_SSL_HASH_SHA256:
7324 ssl->handshake->calc_verify = ssl_calc_verify_tls_sha256;
7325 break;
7326#endif
7327 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01007328 return -1;
Ronald Cron4dcbca92022-03-07 10:21:40 +01007329 }
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01007330#if !defined(MBEDTLS_MD_CAN_SHA384) && \
7331 !defined(MBEDTLS_MD_CAN_SHA256)
Andrzej Kurekeabeb302022-10-17 07:52:51 -04007332 (void) ssl;
7333#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01007334 return 0;
Ronald Cron4dcbca92022-03-07 10:21:40 +01007335}
7336
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007337#if defined(MBEDTLS_USE_PSA_CRYPTO)
7338static int ssl_calc_verify_tls_psa(const mbedtls_ssl_context *ssl,
7339 const psa_hash_operation_t *hs_op,
7340 size_t buffer_size,
7341 unsigned char *hash,
7342 size_t *hlen)
7343{
7344 psa_status_t status;
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007345 psa_hash_operation_t cloned_op = psa_hash_operation_init();
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007346
7347#if !defined(MBEDTLS_DEBUG_C)
7348 (void) ssl;
7349#endif
7350 MBEDTLS_SSL_DEBUG_MSG(2, ("=> PSA calc verify"));
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007351 status = psa_hash_clone(hs_op, &cloned_op);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007352 if (status != PSA_SUCCESS) {
7353 goto exit;
7354 }
7355
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007356 status = psa_hash_finish(&cloned_op, hash, buffer_size, hlen);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007357 if (status != PSA_SUCCESS) {
7358 goto exit;
7359 }
7360
7361 MBEDTLS_SSL_DEBUG_BUF(3, "PSA calculated verify result", hash, *hlen);
7362 MBEDTLS_SSL_DEBUG_MSG(2, ("<= PSA calc verify"));
7363
7364exit:
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007365 psa_hash_abort(&cloned_op);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007366 return mbedtls_md_error_from_psa(status);
7367}
7368#else
7369static int ssl_calc_verify_tls_legacy(const mbedtls_ssl_context *ssl,
7370 const mbedtls_md_context_t *hs_ctx,
7371 unsigned char *hash,
7372 size_t *hlen)
7373{
7374 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007375 mbedtls_md_context_t cloned_ctx;
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007376
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007377 mbedtls_md_init(&cloned_ctx);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007378
7379#if !defined(MBEDTLS_DEBUG_C)
7380 (void) ssl;
7381#endif
7382 MBEDTLS_SSL_DEBUG_MSG(2, ("=> calc verify"));
7383
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007384 ret = mbedtls_md_setup(&cloned_ctx, mbedtls_md_info_from_ctx(hs_ctx), 0);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007385 if (ret != 0) {
7386 goto exit;
7387 }
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007388 ret = mbedtls_md_clone(&cloned_ctx, hs_ctx);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007389 if (ret != 0) {
7390 goto exit;
7391 }
7392
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007393 ret = mbedtls_md_finish(&cloned_ctx, hash);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007394 if (ret != 0) {
7395 goto exit;
7396 }
7397
7398 *hlen = mbedtls_md_get_size(mbedtls_md_info_from_ctx(hs_ctx));
7399
7400 MBEDTLS_SSL_DEBUG_BUF(3, "calculated verify result", hash, *hlen);
7401 MBEDTLS_SSL_DEBUG_MSG(2, ("<= calc verify"));
7402
7403exit:
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007404 mbedtls_md_free(&cloned_ctx);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007405 return ret;
7406}
7407#endif /* MBEDTLS_USE_PSA_CRYPTO */
7408
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01007409#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +01007410int ssl_calc_verify_tls_sha256(const mbedtls_ssl_context *ssl,
7411 unsigned char *hash,
7412 size_t *hlen)
Jerry Yu8392e0d2022-02-17 14:10:24 +08007413{
7414#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007415 return ssl_calc_verify_tls_psa(ssl, &ssl->handshake->fin_sha256_psa, 32,
7416 hash, hlen);
Jerry Yu8392e0d2022-02-17 14:10:24 +08007417#else
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007418 return ssl_calc_verify_tls_legacy(ssl, &ssl->handshake->fin_sha256,
7419 hash, hlen);
Jerry Yu8392e0d2022-02-17 14:10:24 +08007420#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu8392e0d2022-02-17 14:10:24 +08007421}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01007422#endif /* MBEDTLS_MD_CAN_SHA256 */
Jerry Yu8392e0d2022-02-17 14:10:24 +08007423
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01007424#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +01007425int ssl_calc_verify_tls_sha384(const mbedtls_ssl_context *ssl,
7426 unsigned char *hash,
7427 size_t *hlen)
Jerry Yuc1cb3842022-02-17 14:13:48 +08007428{
7429#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007430 return ssl_calc_verify_tls_psa(ssl, &ssl->handshake->fin_sha384_psa, 48,
7431 hash, hlen);
Jerry Yuc1cb3842022-02-17 14:13:48 +08007432#else
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007433 return ssl_calc_verify_tls_legacy(ssl, &ssl->handshake->fin_sha384,
7434 hash, hlen);
Jerry Yuc1cb3842022-02-17 14:13:48 +08007435#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yuc1cb3842022-02-17 14:13:48 +08007436}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01007437#endif /* MBEDTLS_MD_CAN_SHA384 */
Jerry Yuc1cb3842022-02-17 14:13:48 +08007438
Neil Armstrong80f6f322022-05-03 17:56:38 +02007439#if !defined(MBEDTLS_USE_PSA_CRYPTO) && \
7440 defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007441int mbedtls_ssl_psk_derive_premaster(mbedtls_ssl_context *ssl, mbedtls_key_exchange_type_t key_ex)
Jerry Yuce3dca42022-02-17 14:16:37 +08007442{
7443 unsigned char *p = ssl->handshake->premaster;
Gilles Peskine449bd832023-01-11 14:50:10 +01007444 unsigned char *end = p + sizeof(ssl->handshake->premaster);
Jerry Yuce3dca42022-02-17 14:16:37 +08007445 const unsigned char *psk = NULL;
7446 size_t psk_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01007447 int psk_ret = mbedtls_ssl_get_psk(ssl, &psk, &psk_len);
Jerry Yuce3dca42022-02-17 14:16:37 +08007448
Gilles Peskine449bd832023-01-11 14:50:10 +01007449 if (psk_ret == MBEDTLS_ERR_SSL_PRIVATE_KEY_REQUIRED) {
Jerry Yuce3dca42022-02-17 14:16:37 +08007450 /*
7451 * This should never happen because the existence of a PSK is always
Przemek Stekielb293aaa2022-04-19 12:22:38 +02007452 * checked before calling this function.
7453 *
7454 * The exception is opaque DHE-PSK. For DHE-PSK fill premaster with
Przemek Stekiel8abcee92022-04-28 09:16:28 +02007455 * the shared secret without PSK.
Jerry Yuce3dca42022-02-17 14:16:37 +08007456 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007457 if (key_ex != MBEDTLS_KEY_EXCHANGE_DHE_PSK) {
7458 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
7459 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Przemek Stekielb293aaa2022-04-19 12:22:38 +02007460 }
Jerry Yuce3dca42022-02-17 14:16:37 +08007461 }
7462
7463 /*
7464 * PMS = struct {
7465 * opaque other_secret<0..2^16-1>;
7466 * opaque psk<0..2^16-1>;
7467 * };
7468 * with "other_secret" depending on the particular key exchange
7469 */
7470#if defined(MBEDTLS_KEY_EXCHANGE_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007471 if (key_ex == MBEDTLS_KEY_EXCHANGE_PSK) {
7472 if (end - p < 2) {
7473 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
7474 }
Jerry Yuce3dca42022-02-17 14:16:37 +08007475
Gilles Peskine449bd832023-01-11 14:50:10 +01007476 MBEDTLS_PUT_UINT16_BE(psk_len, p, 0);
Jerry Yuce3dca42022-02-17 14:16:37 +08007477 p += 2;
7478
Gilles Peskine449bd832023-01-11 14:50:10 +01007479 if (end < p || (size_t) (end - p) < psk_len) {
7480 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
7481 }
Jerry Yuce3dca42022-02-17 14:16:37 +08007482
Gilles Peskine449bd832023-01-11 14:50:10 +01007483 memset(p, 0, psk_len);
Jerry Yuce3dca42022-02-17 14:16:37 +08007484 p += psk_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01007485 } else
Jerry Yuce3dca42022-02-17 14:16:37 +08007486#endif /* MBEDTLS_KEY_EXCHANGE_PSK_ENABLED */
7487#if defined(MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007488 if (key_ex == MBEDTLS_KEY_EXCHANGE_RSA_PSK) {
Jerry Yuce3dca42022-02-17 14:16:37 +08007489 /*
7490 * other_secret already set by the ClientKeyExchange message,
7491 * and is 48 bytes long
7492 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007493 if (end - p < 2) {
7494 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
7495 }
Jerry Yuce3dca42022-02-17 14:16:37 +08007496
7497 *p++ = 0;
7498 *p++ = 48;
7499 p += 48;
Gilles Peskine449bd832023-01-11 14:50:10 +01007500 } else
Jerry Yuce3dca42022-02-17 14:16:37 +08007501#endif /* MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED */
7502#if defined(MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007503 if (key_ex == MBEDTLS_KEY_EXCHANGE_DHE_PSK) {
Jerry Yuce3dca42022-02-17 14:16:37 +08007504 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7505 size_t len;
7506
7507 /* Write length only when we know the actual value */
Gilles Peskine449bd832023-01-11 14:50:10 +01007508 if ((ret = mbedtls_dhm_calc_secret(&ssl->handshake->dhm_ctx,
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00007509 p + 2, (size_t) (end - (p + 2)), &len,
Gilles Peskine449bd832023-01-11 14:50:10 +01007510 ssl->conf->f_rng, ssl->conf->p_rng)) != 0) {
7511 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_dhm_calc_secret", ret);
7512 return ret;
Jerry Yuce3dca42022-02-17 14:16:37 +08007513 }
Gilles Peskine449bd832023-01-11 14:50:10 +01007514 MBEDTLS_PUT_UINT16_BE(len, p, 0);
Jerry Yuce3dca42022-02-17 14:16:37 +08007515 p += 2 + len;
7516
Gilles Peskine449bd832023-01-11 14:50:10 +01007517 MBEDTLS_SSL_DEBUG_MPI(3, "DHM: K ", &ssl->handshake->dhm_ctx.K);
7518 } else
Jerry Yuce3dca42022-02-17 14:16:37 +08007519#endif /* MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED */
Neil Armstrong80f6f322022-05-03 17:56:38 +02007520#if defined(MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007521 if (key_ex == MBEDTLS_KEY_EXCHANGE_ECDHE_PSK) {
Jerry Yuce3dca42022-02-17 14:16:37 +08007522 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7523 size_t zlen;
7524
Gilles Peskine449bd832023-01-11 14:50:10 +01007525 if ((ret = mbedtls_ecdh_calc_secret(&ssl->handshake->ecdh_ctx, &zlen,
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00007526 p + 2, (size_t) (end - (p + 2)),
Gilles Peskine449bd832023-01-11 14:50:10 +01007527 ssl->conf->f_rng, ssl->conf->p_rng)) != 0) {
7528 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ecdh_calc_secret", ret);
7529 return ret;
Jerry Yuce3dca42022-02-17 14:16:37 +08007530 }
7531
Gilles Peskine449bd832023-01-11 14:50:10 +01007532 MBEDTLS_PUT_UINT16_BE(zlen, p, 0);
Jerry Yuce3dca42022-02-17 14:16:37 +08007533 p += 2 + zlen;
7534
Gilles Peskine449bd832023-01-11 14:50:10 +01007535 MBEDTLS_SSL_DEBUG_ECDH(3, &ssl->handshake->ecdh_ctx,
7536 MBEDTLS_DEBUG_ECDH_Z);
7537 } else
Neil Armstrong80f6f322022-05-03 17:56:38 +02007538#endif /* MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED */
Jerry Yuce3dca42022-02-17 14:16:37 +08007539 {
Gilles Peskine449bd832023-01-11 14:50:10 +01007540 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
7541 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yuce3dca42022-02-17 14:16:37 +08007542 }
7543
7544 /* opaque psk<0..2^16-1>; */
Gilles Peskine449bd832023-01-11 14:50:10 +01007545 if (end - p < 2) {
7546 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
7547 }
Jerry Yuce3dca42022-02-17 14:16:37 +08007548
Gilles Peskine449bd832023-01-11 14:50:10 +01007549 MBEDTLS_PUT_UINT16_BE(psk_len, p, 0);
Jerry Yuce3dca42022-02-17 14:16:37 +08007550 p += 2;
7551
Gilles Peskine449bd832023-01-11 14:50:10 +01007552 if (end < p || (size_t) (end - p) < psk_len) {
7553 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
7554 }
Jerry Yuce3dca42022-02-17 14:16:37 +08007555
Gilles Peskine449bd832023-01-11 14:50:10 +01007556 memcpy(p, psk, psk_len);
Jerry Yuce3dca42022-02-17 14:16:37 +08007557 p += psk_len;
7558
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00007559 ssl->handshake->pmslen = (size_t) (p - ssl->handshake->premaster);
Jerry Yuce3dca42022-02-17 14:16:37 +08007560
Gilles Peskine449bd832023-01-11 14:50:10 +01007561 return 0;
Jerry Yuce3dca42022-02-17 14:16:37 +08007562}
Neil Armstrong80f6f322022-05-03 17:56:38 +02007563#endif /* !MBEDTLS_USE_PSA_CRYPTO && MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
Jerry Yuc2c673d2022-02-17 14:20:39 +08007564
7565#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007566MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007567static int ssl_write_hello_request(mbedtls_ssl_context *ssl);
Jerry Yuc2c673d2022-02-17 14:20:39 +08007568
7569#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01007570int mbedtls_ssl_resend_hello_request(mbedtls_ssl_context *ssl)
Jerry Yuc2c673d2022-02-17 14:20:39 +08007571{
7572 /* If renegotiation is not enforced, retransmit until we would reach max
7573 * timeout if we were using the usual handshake doubling scheme */
Gilles Peskine449bd832023-01-11 14:50:10 +01007574 if (ssl->conf->renego_max_records < 0) {
Jerry Yuc2c673d2022-02-17 14:20:39 +08007575 uint32_t ratio = ssl->conf->hs_timeout_max / ssl->conf->hs_timeout_min + 1;
7576 unsigned char doublings = 1;
7577
Gilles Peskine449bd832023-01-11 14:50:10 +01007578 while (ratio != 0) {
Jerry Yuc2c673d2022-02-17 14:20:39 +08007579 ++doublings;
7580 ratio >>= 1;
7581 }
7582
Gilles Peskine449bd832023-01-11 14:50:10 +01007583 if (++ssl->renego_records_seen > doublings) {
7584 MBEDTLS_SSL_DEBUG_MSG(2, ("no longer retransmitting hello request"));
7585 return 0;
Jerry Yuc2c673d2022-02-17 14:20:39 +08007586 }
7587 }
7588
Gilles Peskine449bd832023-01-11 14:50:10 +01007589 return ssl_write_hello_request(ssl);
Jerry Yuc2c673d2022-02-17 14:20:39 +08007590}
7591#endif
7592#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_RENEGOTIATION */
Jerry Yud9526692022-02-17 14:23:47 +08007593
Jerry Yud9526692022-02-17 14:23:47 +08007594/*
7595 * Handshake functions
7596 */
7597#if !defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
7598/* No certificate support -> dummy functions */
Gilles Peskine449bd832023-01-11 14:50:10 +01007599int mbedtls_ssl_write_certificate(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08007600{
7601 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
7602 ssl->handshake->ciphersuite_info;
7603
Gilles Peskine449bd832023-01-11 14:50:10 +01007604 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007605
Gilles Peskine449bd832023-01-11 14:50:10 +01007606 if (!mbedtls_ssl_ciphersuite_uses_srv_cert(ciphersuite_info)) {
7607 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007608 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01007609 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007610 }
7611
Gilles Peskine449bd832023-01-11 14:50:10 +01007612 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
7613 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007614}
7615
Gilles Peskine449bd832023-01-11 14:50:10 +01007616int mbedtls_ssl_parse_certificate(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08007617{
7618 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
7619 ssl->handshake->ciphersuite_info;
7620
Gilles Peskine449bd832023-01-11 14:50:10 +01007621 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007622
Gilles Peskine449bd832023-01-11 14:50:10 +01007623 if (!mbedtls_ssl_ciphersuite_uses_srv_cert(ciphersuite_info)) {
7624 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007625 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01007626 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007627 }
7628
Gilles Peskine449bd832023-01-11 14:50:10 +01007629 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
7630 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007631}
7632
7633#else /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
7634/* Some certificate support -> implement write and parse */
7635
Gilles Peskine449bd832023-01-11 14:50:10 +01007636int mbedtls_ssl_write_certificate(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08007637{
7638 int ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
7639 size_t i, n;
7640 const mbedtls_x509_crt *crt;
7641 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
7642 ssl->handshake->ciphersuite_info;
7643
Gilles Peskine449bd832023-01-11 14:50:10 +01007644 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007645
Gilles Peskine449bd832023-01-11 14:50:10 +01007646 if (!mbedtls_ssl_ciphersuite_uses_srv_cert(ciphersuite_info)) {
7647 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007648 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01007649 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007650 }
7651
7652#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007653 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
7654 if (ssl->handshake->client_auth == 0) {
7655 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007656 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01007657 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007658 }
7659 }
7660#endif /* MBEDTLS_SSL_CLI_C */
7661#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007662 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
7663 if (mbedtls_ssl_own_cert(ssl) == NULL) {
Jerry Yud9526692022-02-17 14:23:47 +08007664 /* Should never happen because we shouldn't have picked the
7665 * ciphersuite if we don't have a certificate. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007666 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007667 }
7668 }
7669#endif
7670
Gilles Peskine449bd832023-01-11 14:50:10 +01007671 MBEDTLS_SSL_DEBUG_CRT(3, "own certificate", mbedtls_ssl_own_cert(ssl));
Jerry Yud9526692022-02-17 14:23:47 +08007672
7673 /*
7674 * 0 . 0 handshake type
7675 * 1 . 3 handshake length
7676 * 4 . 6 length of all certs
7677 * 7 . 9 length of cert. 1
7678 * 10 . n-1 peer certificate
7679 * n . n+2 length of cert. 2
7680 * n+3 . ... upper level cert, etc.
7681 */
7682 i = 7;
Gilles Peskine449bd832023-01-11 14:50:10 +01007683 crt = mbedtls_ssl_own_cert(ssl);
Jerry Yud9526692022-02-17 14:23:47 +08007684
Gilles Peskine449bd832023-01-11 14:50:10 +01007685 while (crt != NULL) {
Jerry Yud9526692022-02-17 14:23:47 +08007686 n = crt->raw.len;
Gilles Peskine449bd832023-01-11 14:50:10 +01007687 if (n > MBEDTLS_SSL_OUT_CONTENT_LEN - 3 - i) {
7688 MBEDTLS_SSL_DEBUG_MSG(1, ("certificate too large, %" MBEDTLS_PRINTF_SIZET
7689 " > %" MBEDTLS_PRINTF_SIZET,
7690 i + 3 + n, (size_t) MBEDTLS_SSL_OUT_CONTENT_LEN));
7691 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
Jerry Yud9526692022-02-17 14:23:47 +08007692 }
7693
Gilles Peskine449bd832023-01-11 14:50:10 +01007694 ssl->out_msg[i] = MBEDTLS_BYTE_2(n);
7695 ssl->out_msg[i + 1] = MBEDTLS_BYTE_1(n);
7696 ssl->out_msg[i + 2] = MBEDTLS_BYTE_0(n);
Jerry Yud9526692022-02-17 14:23:47 +08007697
Gilles Peskine449bd832023-01-11 14:50:10 +01007698 i += 3; memcpy(ssl->out_msg + i, crt->raw.p, n);
Jerry Yud9526692022-02-17 14:23:47 +08007699 i += n; crt = crt->next;
7700 }
7701
Gilles Peskine449bd832023-01-11 14:50:10 +01007702 ssl->out_msg[4] = MBEDTLS_BYTE_2(i - 7);
7703 ssl->out_msg[5] = MBEDTLS_BYTE_1(i - 7);
7704 ssl->out_msg[6] = MBEDTLS_BYTE_0(i - 7);
Jerry Yud9526692022-02-17 14:23:47 +08007705
7706 ssl->out_msglen = i;
7707 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
7708 ssl->out_msg[0] = MBEDTLS_SSL_HS_CERTIFICATE;
7709
7710 ssl->state++;
7711
Gilles Peskine449bd832023-01-11 14:50:10 +01007712 if ((ret = mbedtls_ssl_write_handshake_msg(ssl)) != 0) {
7713 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_handshake_msg", ret);
7714 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007715 }
7716
Gilles Peskine449bd832023-01-11 14:50:10 +01007717 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007718
Gilles Peskine449bd832023-01-11 14:50:10 +01007719 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007720}
7721
7722#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
7723
7724#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007725MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007726static int ssl_check_peer_crt_unchanged(mbedtls_ssl_context *ssl,
7727 unsigned char *crt_buf,
7728 size_t crt_buf_len)
Jerry Yud9526692022-02-17 14:23:47 +08007729{
7730 mbedtls_x509_crt const * const peer_crt = ssl->session->peer_cert;
7731
Gilles Peskine449bd832023-01-11 14:50:10 +01007732 if (peer_crt == NULL) {
7733 return -1;
7734 }
Jerry Yud9526692022-02-17 14:23:47 +08007735
Gilles Peskine449bd832023-01-11 14:50:10 +01007736 if (peer_crt->raw.len != crt_buf_len) {
7737 return -1;
7738 }
Jerry Yud9526692022-02-17 14:23:47 +08007739
Gilles Peskine449bd832023-01-11 14:50:10 +01007740 return memcmp(peer_crt->raw.p, crt_buf, peer_crt->raw.len);
Jerry Yud9526692022-02-17 14:23:47 +08007741}
7742#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007743MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007744static int ssl_check_peer_crt_unchanged(mbedtls_ssl_context *ssl,
7745 unsigned char *crt_buf,
7746 size_t crt_buf_len)
Jerry Yud9526692022-02-17 14:23:47 +08007747{
7748 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7749 unsigned char const * const peer_cert_digest =
7750 ssl->session->peer_cert_digest;
7751 mbedtls_md_type_t const peer_cert_digest_type =
7752 ssl->session->peer_cert_digest_type;
7753 mbedtls_md_info_t const * const digest_info =
Gilles Peskine449bd832023-01-11 14:50:10 +01007754 mbedtls_md_info_from_type(peer_cert_digest_type);
Jerry Yud9526692022-02-17 14:23:47 +08007755 unsigned char tmp_digest[MBEDTLS_SSL_PEER_CERT_DIGEST_MAX_LEN];
7756 size_t digest_len;
7757
Gilles Peskine449bd832023-01-11 14:50:10 +01007758 if (peer_cert_digest == NULL || digest_info == NULL) {
7759 return -1;
7760 }
Jerry Yud9526692022-02-17 14:23:47 +08007761
Gilles Peskine449bd832023-01-11 14:50:10 +01007762 digest_len = mbedtls_md_get_size(digest_info);
7763 if (digest_len > MBEDTLS_SSL_PEER_CERT_DIGEST_MAX_LEN) {
7764 return -1;
7765 }
Jerry Yud9526692022-02-17 14:23:47 +08007766
Gilles Peskine449bd832023-01-11 14:50:10 +01007767 ret = mbedtls_md(digest_info, crt_buf, crt_buf_len, tmp_digest);
7768 if (ret != 0) {
7769 return -1;
7770 }
Jerry Yud9526692022-02-17 14:23:47 +08007771
Gilles Peskine449bd832023-01-11 14:50:10 +01007772 return memcmp(tmp_digest, peer_cert_digest, digest_len);
Jerry Yud9526692022-02-17 14:23:47 +08007773}
7774#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7775#endif /* MBEDTLS_SSL_RENEGOTIATION && MBEDTLS_SSL_CLI_C */
7776
7777/*
7778 * Once the certificate message is read, parse it into a cert chain and
7779 * perform basic checks, but leave actual verification to the caller
7780 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007781MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007782static int ssl_parse_certificate_chain(mbedtls_ssl_context *ssl,
7783 mbedtls_x509_crt *chain)
Jerry Yud9526692022-02-17 14:23:47 +08007784{
7785 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7786#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007787 int crt_cnt = 0;
Jerry Yud9526692022-02-17 14:23:47 +08007788#endif
7789 size_t i, n;
7790 uint8_t alert;
7791
Gilles Peskine449bd832023-01-11 14:50:10 +01007792 if (ssl->in_msgtype != MBEDTLS_SSL_MSG_HANDSHAKE) {
7793 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7794 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7795 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
7796 return MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
Jerry Yud9526692022-02-17 14:23:47 +08007797 }
7798
Gilles Peskine449bd832023-01-11 14:50:10 +01007799 if (ssl->in_msg[0] != MBEDTLS_SSL_HS_CERTIFICATE) {
7800 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7801 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
7802 return MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
Jerry Yud9526692022-02-17 14:23:47 +08007803 }
7804
Gilles Peskine449bd832023-01-11 14:50:10 +01007805 if (ssl->in_hslen < mbedtls_ssl_hs_hdr_len(ssl) + 3 + 3) {
7806 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7807 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7808 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
7809 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007810 }
7811
Gilles Peskine449bd832023-01-11 14:50:10 +01007812 i = mbedtls_ssl_hs_hdr_len(ssl);
Jerry Yud9526692022-02-17 14:23:47 +08007813
7814 /*
7815 * Same message structure as in mbedtls_ssl_write_certificate()
7816 */
Dave Rodgmana3d0f612023-11-03 23:34:02 +00007817 n = MBEDTLS_GET_UINT16_BE(ssl->in_msg, i + 1);
Jerry Yud9526692022-02-17 14:23:47 +08007818
Gilles Peskine449bd832023-01-11 14:50:10 +01007819 if (ssl->in_msg[i] != 0 ||
7820 ssl->in_hslen != n + 3 + mbedtls_ssl_hs_hdr_len(ssl)) {
7821 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7822 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7823 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
7824 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007825 }
7826
7827 /* Make &ssl->in_msg[i] point to the beginning of the CRT chain. */
7828 i += 3;
7829
7830 /* Iterate through and parse the CRTs in the provided chain. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007831 while (i < ssl->in_hslen) {
Jerry Yud9526692022-02-17 14:23:47 +08007832 /* Check that there's room for the next CRT's length fields. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007833 if (i + 3 > ssl->in_hslen) {
7834 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7835 mbedtls_ssl_send_alert_message(ssl,
7836 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7837 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
7838 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007839 }
7840 /* In theory, the CRT can be up to 2**24 Bytes, but we don't support
7841 * anything beyond 2**16 ~ 64K. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007842 if (ssl->in_msg[i] != 0) {
7843 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7844 mbedtls_ssl_send_alert_message(ssl,
7845 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7846 MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT);
7847 return MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
Jerry Yud9526692022-02-17 14:23:47 +08007848 }
7849
7850 /* Read length of the next CRT in the chain. */
Dave Rodgmana3d0f612023-11-03 23:34:02 +00007851 n = MBEDTLS_GET_UINT16_BE(ssl->in_msg, i + 1);
Jerry Yud9526692022-02-17 14:23:47 +08007852 i += 3;
7853
Gilles Peskine449bd832023-01-11 14:50:10 +01007854 if (n < 128 || i + n > ssl->in_hslen) {
7855 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7856 mbedtls_ssl_send_alert_message(ssl,
7857 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7858 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
7859 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007860 }
7861
7862 /* Check if we're handling the first CRT in the chain. */
7863#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007864 if (crt_cnt++ == 0 &&
Jerry Yud9526692022-02-17 14:23:47 +08007865 ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
Gilles Peskine449bd832023-01-11 14:50:10 +01007866 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS) {
Jerry Yud9526692022-02-17 14:23:47 +08007867 /* During client-side renegotiation, check that the server's
7868 * end-CRTs hasn't changed compared to the initial handshake,
7869 * mitigating the triple handshake attack. On success, reuse
7870 * the original end-CRT instead of parsing it again. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007871 MBEDTLS_SSL_DEBUG_MSG(3, ("Check that peer CRT hasn't changed during renegotiation"));
7872 if (ssl_check_peer_crt_unchanged(ssl,
7873 &ssl->in_msg[i],
7874 n) != 0) {
7875 MBEDTLS_SSL_DEBUG_MSG(1, ("new server cert during renegotiation"));
7876 mbedtls_ssl_send_alert_message(ssl,
7877 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7878 MBEDTLS_SSL_ALERT_MSG_ACCESS_DENIED);
7879 return MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
Jerry Yud9526692022-02-17 14:23:47 +08007880 }
7881
7882 /* Now we can safely free the original chain. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007883 ssl_clear_peer_cert(ssl->session);
Jerry Yud9526692022-02-17 14:23:47 +08007884 }
7885#endif /* MBEDTLS_SSL_RENEGOTIATION && MBEDTLS_SSL_CLI_C */
7886
7887 /* Parse the next certificate in the chain. */
7888#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01007889 ret = mbedtls_x509_crt_parse_der(chain, ssl->in_msg + i, n);
Jerry Yud9526692022-02-17 14:23:47 +08007890#else
7891 /* If we don't need to store the CRT chain permanently, parse
7892 * it in-place from the input buffer instead of making a copy. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007893 ret = mbedtls_x509_crt_parse_der_nocopy(chain, ssl->in_msg + i, n);
Jerry Yud9526692022-02-17 14:23:47 +08007894#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Gilles Peskine449bd832023-01-11 14:50:10 +01007895 switch (ret) {
Jerry Yud9526692022-02-17 14:23:47 +08007896 case 0: /*ok*/
7897 case MBEDTLS_ERR_X509_UNKNOWN_SIG_ALG + MBEDTLS_ERR_OID_NOT_FOUND:
7898 /* Ignore certificate with an unknown algorithm: maybe a
7899 prior certificate was already trusted. */
7900 break;
7901
7902 case MBEDTLS_ERR_X509_ALLOC_FAILED:
7903 alert = MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR;
7904 goto crt_parse_der_failed;
7905
7906 case MBEDTLS_ERR_X509_UNKNOWN_VERSION:
7907 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
7908 goto crt_parse_der_failed;
7909
7910 default:
7911 alert = MBEDTLS_SSL_ALERT_MSG_BAD_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01007912crt_parse_der_failed:
7913 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL, alert);
7914 MBEDTLS_SSL_DEBUG_RET(1, " mbedtls_x509_crt_parse_der", ret);
7915 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007916 }
7917
7918 i += n;
7919 }
7920
Gilles Peskine449bd832023-01-11 14:50:10 +01007921 MBEDTLS_SSL_DEBUG_CRT(3, "peer certificate", chain);
7922 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007923}
7924
7925#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007926MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007927static int ssl_srv_check_client_no_crt_notification(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08007928{
Gilles Peskine449bd832023-01-11 14:50:10 +01007929 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
7930 return -1;
7931 }
Jerry Yud9526692022-02-17 14:23:47 +08007932
Gilles Peskine449bd832023-01-11 14:50:10 +01007933 if (ssl->in_hslen == 3 + mbedtls_ssl_hs_hdr_len(ssl) &&
Jerry Yud9526692022-02-17 14:23:47 +08007934 ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
7935 ssl->in_msg[0] == MBEDTLS_SSL_HS_CERTIFICATE &&
Gilles Peskine449bd832023-01-11 14:50:10 +01007936 memcmp(ssl->in_msg + mbedtls_ssl_hs_hdr_len(ssl), "\0\0\0", 3) == 0) {
7937 MBEDTLS_SSL_DEBUG_MSG(1, ("peer has no certificate"));
7938 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007939 }
Gilles Peskine449bd832023-01-11 14:50:10 +01007940 return -1;
Jerry Yud9526692022-02-17 14:23:47 +08007941}
7942#endif /* MBEDTLS_SSL_SRV_C */
7943
7944/* Check if a certificate message is expected.
7945 * Return either
7946 * - SSL_CERTIFICATE_EXPECTED, or
7947 * - SSL_CERTIFICATE_SKIP
7948 * indicating whether a Certificate message is expected or not.
7949 */
7950#define SSL_CERTIFICATE_EXPECTED 0
7951#define SSL_CERTIFICATE_SKIP 1
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007952MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007953static int ssl_parse_certificate_coordinate(mbedtls_ssl_context *ssl,
7954 int authmode)
Jerry Yud9526692022-02-17 14:23:47 +08007955{
7956 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
7957 ssl->handshake->ciphersuite_info;
7958
Gilles Peskine449bd832023-01-11 14:50:10 +01007959 if (!mbedtls_ssl_ciphersuite_uses_srv_cert(ciphersuite_info)) {
7960 return SSL_CERTIFICATE_SKIP;
7961 }
Jerry Yud9526692022-02-17 14:23:47 +08007962
7963#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007964 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
7965 if (ciphersuite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_RSA_PSK) {
7966 return SSL_CERTIFICATE_SKIP;
7967 }
Jerry Yud9526692022-02-17 14:23:47 +08007968
Gilles Peskine449bd832023-01-11 14:50:10 +01007969 if (authmode == MBEDTLS_SSL_VERIFY_NONE) {
Jerry Yud9526692022-02-17 14:23:47 +08007970 ssl->session_negotiate->verify_result =
7971 MBEDTLS_X509_BADCERT_SKIP_VERIFY;
Gilles Peskine449bd832023-01-11 14:50:10 +01007972 return SSL_CERTIFICATE_SKIP;
Jerry Yud9526692022-02-17 14:23:47 +08007973 }
7974 }
7975#else
7976 ((void) authmode);
7977#endif /* MBEDTLS_SSL_SRV_C */
7978
Gilles Peskine449bd832023-01-11 14:50:10 +01007979 return SSL_CERTIFICATE_EXPECTED;
Jerry Yud9526692022-02-17 14:23:47 +08007980}
7981
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007982MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007983static int ssl_parse_certificate_verify(mbedtls_ssl_context *ssl,
7984 int authmode,
7985 mbedtls_x509_crt *chain,
7986 void *rs_ctx)
Jerry Yud9526692022-02-17 14:23:47 +08007987{
7988 int ret = 0;
7989 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
7990 ssl->handshake->ciphersuite_info;
7991 int have_ca_chain = 0;
7992
7993 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *);
7994 void *p_vrfy;
7995
Gilles Peskine449bd832023-01-11 14:50:10 +01007996 if (authmode == MBEDTLS_SSL_VERIFY_NONE) {
7997 return 0;
7998 }
Jerry Yud9526692022-02-17 14:23:47 +08007999
Gilles Peskine449bd832023-01-11 14:50:10 +01008000 if (ssl->f_vrfy != NULL) {
8001 MBEDTLS_SSL_DEBUG_MSG(3, ("Use context-specific verification callback"));
Jerry Yud9526692022-02-17 14:23:47 +08008002 f_vrfy = ssl->f_vrfy;
8003 p_vrfy = ssl->p_vrfy;
Gilles Peskine449bd832023-01-11 14:50:10 +01008004 } else {
8005 MBEDTLS_SSL_DEBUG_MSG(3, ("Use configuration-specific verification callback"));
Jerry Yud9526692022-02-17 14:23:47 +08008006 f_vrfy = ssl->conf->f_vrfy;
8007 p_vrfy = ssl->conf->p_vrfy;
8008 }
8009
8010 /*
8011 * Main check: verify certificate
8012 */
8013#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
Gilles Peskine449bd832023-01-11 14:50:10 +01008014 if (ssl->conf->f_ca_cb != NULL) {
Jerry Yud9526692022-02-17 14:23:47 +08008015 ((void) rs_ctx);
8016 have_ca_chain = 1;
8017
Gilles Peskine449bd832023-01-11 14:50:10 +01008018 MBEDTLS_SSL_DEBUG_MSG(3, ("use CA callback for X.509 CRT verification"));
Jerry Yud9526692022-02-17 14:23:47 +08008019 ret = mbedtls_x509_crt_verify_with_ca_cb(
8020 chain,
8021 ssl->conf->f_ca_cb,
8022 ssl->conf->p_ca_cb,
8023 ssl->conf->cert_profile,
8024 ssl->hostname,
8025 &ssl->session_negotiate->verify_result,
Gilles Peskine449bd832023-01-11 14:50:10 +01008026 f_vrfy, p_vrfy);
8027 } else
Jerry Yud9526692022-02-17 14:23:47 +08008028#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
8029 {
8030 mbedtls_x509_crt *ca_chain;
8031 mbedtls_x509_crl *ca_crl;
8032
8033#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01008034 if (ssl->handshake->sni_ca_chain != NULL) {
Jerry Yud9526692022-02-17 14:23:47 +08008035 ca_chain = ssl->handshake->sni_ca_chain;
8036 ca_crl = ssl->handshake->sni_ca_crl;
Gilles Peskine449bd832023-01-11 14:50:10 +01008037 } else
Jerry Yud9526692022-02-17 14:23:47 +08008038#endif
8039 {
8040 ca_chain = ssl->conf->ca_chain;
8041 ca_crl = ssl->conf->ca_crl;
8042 }
8043
Gilles Peskine449bd832023-01-11 14:50:10 +01008044 if (ca_chain != NULL) {
Jerry Yud9526692022-02-17 14:23:47 +08008045 have_ca_chain = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01008046 }
Jerry Yud9526692022-02-17 14:23:47 +08008047
8048 ret = mbedtls_x509_crt_verify_restartable(
8049 chain,
8050 ca_chain, ca_crl,
8051 ssl->conf->cert_profile,
8052 ssl->hostname,
8053 &ssl->session_negotiate->verify_result,
Gilles Peskine449bd832023-01-11 14:50:10 +01008054 f_vrfy, p_vrfy, rs_ctx);
Jerry Yud9526692022-02-17 14:23:47 +08008055 }
8056
Gilles Peskine449bd832023-01-11 14:50:10 +01008057 if (ret != 0) {
8058 MBEDTLS_SSL_DEBUG_RET(1, "x509_verify_cert", ret);
Jerry Yud9526692022-02-17 14:23:47 +08008059 }
8060
8061#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01008062 if (ret == MBEDTLS_ERR_ECP_IN_PROGRESS) {
8063 return MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS;
8064 }
Jerry Yud9526692022-02-17 14:23:47 +08008065#endif
8066
8067 /*
8068 * Secondary checks: always done, but change 'ret' only if it was 0
8069 */
8070
Valerio Settiacd32c02023-06-29 18:06:29 +02008071#if defined(MBEDTLS_PK_HAVE_ECC_KEYS)
Jerry Yud9526692022-02-17 14:23:47 +08008072 {
8073 const mbedtls_pk_context *pk = &chain->pk;
8074
Manuel Pégourié-Gonnard66b0d612022-06-17 10:49:29 +02008075 /* If certificate uses an EC key, make sure the curve is OK.
8076 * This is a public key, so it can't be opaque, so can_do() is a good
8077 * enough check to ensure pk_ec() is safe to use here. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008078 if (mbedtls_pk_can_do(pk, MBEDTLS_PK_ECKEY)) {
Leonid Rozenboim19e59732022-08-08 16:52:38 -07008079 /* and in the unlikely case the above assumption no longer holds
8080 * we are making sure that pk_ec() here does not return a NULL
8081 */
Valerio Settif9362b72023-11-29 08:42:27 +01008082 mbedtls_ecp_group_id grp_id = mbedtls_pk_get_ec_group_id(pk);
Valerio Settid0405092023-05-24 13:16:40 +02008083 if (grp_id == MBEDTLS_ECP_DP_NONE) {
8084 MBEDTLS_SSL_DEBUG_MSG(1, ("invalid group ID"));
Gilles Peskine449bd832023-01-11 14:50:10 +01008085 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Leonid Rozenboim19e59732022-08-08 16:52:38 -07008086 }
Valerio Setti97207782023-05-18 18:59:06 +02008087 if (mbedtls_ssl_check_curve(ssl, grp_id) != 0) {
Leonid Rozenboim19e59732022-08-08 16:52:38 -07008088 ssl->session_negotiate->verify_result |=
8089 MBEDTLS_X509_BADCERT_BAD_KEY;
8090
Gilles Peskine449bd832023-01-11 14:50:10 +01008091 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate (EC key curve)"));
8092 if (ret == 0) {
Leonid Rozenboim19e59732022-08-08 16:52:38 -07008093 ret = MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
Gilles Peskine449bd832023-01-11 14:50:10 +01008094 }
Leonid Rozenboim19e59732022-08-08 16:52:38 -07008095 }
Jerry Yud9526692022-02-17 14:23:47 +08008096 }
8097 }
Valerio Settiacd32c02023-06-29 18:06:29 +02008098#endif /* MBEDTLS_PK_HAVE_ECC_KEYS */
Jerry Yud9526692022-02-17 14:23:47 +08008099
Gilles Peskine449bd832023-01-11 14:50:10 +01008100 if (mbedtls_ssl_check_cert_usage(chain,
8101 ciphersuite_info,
8102 !ssl->conf->endpoint,
8103 &ssl->session_negotiate->verify_result) != 0) {
8104 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate (usage extensions)"));
8105 if (ret == 0) {
Jerry Yud9526692022-02-17 14:23:47 +08008106 ret = MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
Gilles Peskine449bd832023-01-11 14:50:10 +01008107 }
Jerry Yud9526692022-02-17 14:23:47 +08008108 }
8109
8110 /* mbedtls_x509_crt_verify_with_profile is supposed to report a
8111 * verification failure through MBEDTLS_ERR_X509_CERT_VERIFY_FAILED,
8112 * with details encoded in the verification flags. All other kinds
8113 * of error codes, including those from the user provided f_vrfy
8114 * functions, are treated as fatal and lead to a failure of
8115 * ssl_parse_certificate even if verification was optional. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008116 if (authmode == MBEDTLS_SSL_VERIFY_OPTIONAL &&
8117 (ret == MBEDTLS_ERR_X509_CERT_VERIFY_FAILED ||
8118 ret == MBEDTLS_ERR_SSL_BAD_CERTIFICATE)) {
Jerry Yud9526692022-02-17 14:23:47 +08008119 ret = 0;
8120 }
8121
Gilles Peskine449bd832023-01-11 14:50:10 +01008122 if (have_ca_chain == 0 && authmode == MBEDTLS_SSL_VERIFY_REQUIRED) {
8123 MBEDTLS_SSL_DEBUG_MSG(1, ("got no CA chain"));
Jerry Yud9526692022-02-17 14:23:47 +08008124 ret = MBEDTLS_ERR_SSL_CA_CHAIN_REQUIRED;
8125 }
8126
Gilles Peskine449bd832023-01-11 14:50:10 +01008127 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08008128 uint8_t alert;
8129
8130 /* The certificate may have been rejected for several reasons.
8131 Pick one and send the corresponding alert. Which alert to send
8132 may be a subject of debate in some cases. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008133 if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_OTHER) {
Jerry Yud9526692022-02-17 14:23:47 +08008134 alert = MBEDTLS_SSL_ALERT_MSG_ACCESS_DENIED;
Gilles Peskine449bd832023-01-11 14:50:10 +01008135 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_CN_MISMATCH) {
Jerry Yud9526692022-02-17 14:23:47 +08008136 alert = MBEDTLS_SSL_ALERT_MSG_BAD_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01008137 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_KEY_USAGE) {
Jerry Yud9526692022-02-17 14:23:47 +08008138 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01008139 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_EXT_KEY_USAGE) {
Jerry Yud9526692022-02-17 14:23:47 +08008140 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01008141 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_NS_CERT_TYPE) {
Jerry Yud9526692022-02-17 14:23:47 +08008142 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01008143 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_BAD_PK) {
Jerry Yud9526692022-02-17 14:23:47 +08008144 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01008145 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_BAD_KEY) {
Jerry Yud9526692022-02-17 14:23:47 +08008146 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01008147 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_EXPIRED) {
Jerry Yud9526692022-02-17 14:23:47 +08008148 alert = MBEDTLS_SSL_ALERT_MSG_CERT_EXPIRED;
Gilles Peskine449bd832023-01-11 14:50:10 +01008149 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_REVOKED) {
Jerry Yud9526692022-02-17 14:23:47 +08008150 alert = MBEDTLS_SSL_ALERT_MSG_CERT_REVOKED;
Gilles Peskine449bd832023-01-11 14:50:10 +01008151 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_NOT_TRUSTED) {
Jerry Yud9526692022-02-17 14:23:47 +08008152 alert = MBEDTLS_SSL_ALERT_MSG_UNKNOWN_CA;
Gilles Peskine449bd832023-01-11 14:50:10 +01008153 } else {
Jerry Yud9526692022-02-17 14:23:47 +08008154 alert = MBEDTLS_SSL_ALERT_MSG_CERT_UNKNOWN;
Gilles Peskine449bd832023-01-11 14:50:10 +01008155 }
8156 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8157 alert);
Jerry Yud9526692022-02-17 14:23:47 +08008158 }
8159
8160#if defined(MBEDTLS_DEBUG_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008161 if (ssl->session_negotiate->verify_result != 0) {
8162 MBEDTLS_SSL_DEBUG_MSG(3, ("! Certificate verification flags %08x",
8163 (unsigned int) ssl->session_negotiate->verify_result));
8164 } else {
8165 MBEDTLS_SSL_DEBUG_MSG(3, ("Certificate verification flags clear"));
Jerry Yud9526692022-02-17 14:23:47 +08008166 }
8167#endif /* MBEDTLS_DEBUG_C */
8168
Gilles Peskine449bd832023-01-11 14:50:10 +01008169 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08008170}
8171
8172#if !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02008173MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01008174static int ssl_remember_peer_crt_digest(mbedtls_ssl_context *ssl,
8175 unsigned char *start, size_t len)
Jerry Yud9526692022-02-17 14:23:47 +08008176{
8177 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
8178 /* Remember digest of the peer's end-CRT. */
8179 ssl->session_negotiate->peer_cert_digest =
Gilles Peskine449bd832023-01-11 14:50:10 +01008180 mbedtls_calloc(1, MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN);
8181 if (ssl->session_negotiate->peer_cert_digest == NULL) {
8182 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc(%d bytes) failed",
8183 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN));
8184 mbedtls_ssl_send_alert_message(ssl,
8185 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8186 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR);
Jerry Yud9526692022-02-17 14:23:47 +08008187
Gilles Peskine449bd832023-01-11 14:50:10 +01008188 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
Jerry Yud9526692022-02-17 14:23:47 +08008189 }
8190
Gilles Peskine449bd832023-01-11 14:50:10 +01008191 ret = mbedtls_md(mbedtls_md_info_from_type(
8192 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE),
8193 start, len,
8194 ssl->session_negotiate->peer_cert_digest);
Jerry Yud9526692022-02-17 14:23:47 +08008195
8196 ssl->session_negotiate->peer_cert_digest_type =
8197 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE;
8198 ssl->session_negotiate->peer_cert_digest_len =
8199 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN;
8200
Gilles Peskine449bd832023-01-11 14:50:10 +01008201 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08008202}
8203
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02008204MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01008205static int ssl_remember_peer_pubkey(mbedtls_ssl_context *ssl,
8206 unsigned char *start, size_t len)
Jerry Yud9526692022-02-17 14:23:47 +08008207{
8208 unsigned char *end = start + len;
8209 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
8210
8211 /* Make a copy of the peer's raw public key. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008212 mbedtls_pk_init(&ssl->handshake->peer_pubkey);
8213 ret = mbedtls_pk_parse_subpubkey(&start, end,
8214 &ssl->handshake->peer_pubkey);
8215 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08008216 /* We should have parsed the public key before. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008217 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08008218 }
8219
Gilles Peskine449bd832023-01-11 14:50:10 +01008220 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08008221}
8222#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
8223
Gilles Peskine449bd832023-01-11 14:50:10 +01008224int mbedtls_ssl_parse_certificate(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08008225{
8226 int ret = 0;
8227 int crt_expected;
8228#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
8229 const int authmode = ssl->handshake->sni_authmode != MBEDTLS_SSL_VERIFY_UNSET
8230 ? ssl->handshake->sni_authmode
8231 : ssl->conf->authmode;
8232#else
8233 const int authmode = ssl->conf->authmode;
8234#endif
8235 void *rs_ctx = NULL;
8236 mbedtls_x509_crt *chain = NULL;
8237
Gilles Peskine449bd832023-01-11 14:50:10 +01008238 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08008239
Gilles Peskine449bd832023-01-11 14:50:10 +01008240 crt_expected = ssl_parse_certificate_coordinate(ssl, authmode);
8241 if (crt_expected == SSL_CERTIFICATE_SKIP) {
8242 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08008243 goto exit;
8244 }
8245
8246#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01008247 if (ssl->handshake->ecrs_enabled &&
8248 ssl->handshake->ecrs_state == ssl_ecrs_crt_verify) {
Jerry Yud9526692022-02-17 14:23:47 +08008249 chain = ssl->handshake->ecrs_peer_cert;
8250 ssl->handshake->ecrs_peer_cert = NULL;
8251 goto crt_verify;
8252 }
8253#endif
8254
Gilles Peskine449bd832023-01-11 14:50:10 +01008255 if ((ret = mbedtls_ssl_read_record(ssl, 1)) != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08008256 /* mbedtls_ssl_read_record may have sent an alert already. We
8257 let it decide whether to alert. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008258 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_read_record", ret);
Jerry Yud9526692022-02-17 14:23:47 +08008259 goto exit;
8260 }
8261
8262#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008263 if (ssl_srv_check_client_no_crt_notification(ssl) == 0) {
Jerry Yud9526692022-02-17 14:23:47 +08008264 ssl->session_negotiate->verify_result = MBEDTLS_X509_BADCERT_MISSING;
8265
Gilles Peskine449bd832023-01-11 14:50:10 +01008266 if (authmode != MBEDTLS_SSL_VERIFY_OPTIONAL) {
Jerry Yud9526692022-02-17 14:23:47 +08008267 ret = MBEDTLS_ERR_SSL_NO_CLIENT_CERTIFICATE;
Gilles Peskine449bd832023-01-11 14:50:10 +01008268 }
Jerry Yud9526692022-02-17 14:23:47 +08008269
8270 goto exit;
8271 }
8272#endif /* MBEDTLS_SSL_SRV_C */
8273
8274 /* Clear existing peer CRT structure in case we tried to
8275 * reuse a session but it failed, and allocate a new one. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008276 ssl_clear_peer_cert(ssl->session_negotiate);
Jerry Yud9526692022-02-17 14:23:47 +08008277
Gilles Peskine449bd832023-01-11 14:50:10 +01008278 chain = mbedtls_calloc(1, sizeof(mbedtls_x509_crt));
8279 if (chain == NULL) {
8280 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc(%" MBEDTLS_PRINTF_SIZET " bytes) failed",
8281 sizeof(mbedtls_x509_crt)));
8282 mbedtls_ssl_send_alert_message(ssl,
8283 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8284 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR);
Jerry Yud9526692022-02-17 14:23:47 +08008285
8286 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
8287 goto exit;
8288 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008289 mbedtls_x509_crt_init(chain);
Jerry Yud9526692022-02-17 14:23:47 +08008290
Gilles Peskine449bd832023-01-11 14:50:10 +01008291 ret = ssl_parse_certificate_chain(ssl, chain);
8292 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08008293 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01008294 }
Jerry Yud9526692022-02-17 14:23:47 +08008295
8296#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01008297 if (ssl->handshake->ecrs_enabled) {
Jerry Yud9526692022-02-17 14:23:47 +08008298 ssl->handshake->ecrs_state = ssl_ecrs_crt_verify;
Gilles Peskine449bd832023-01-11 14:50:10 +01008299 }
Jerry Yud9526692022-02-17 14:23:47 +08008300
8301crt_verify:
Gilles Peskine449bd832023-01-11 14:50:10 +01008302 if (ssl->handshake->ecrs_enabled) {
Jerry Yud9526692022-02-17 14:23:47 +08008303 rs_ctx = &ssl->handshake->ecrs_ctx;
Gilles Peskine449bd832023-01-11 14:50:10 +01008304 }
Jerry Yud9526692022-02-17 14:23:47 +08008305#endif
8306
Gilles Peskine449bd832023-01-11 14:50:10 +01008307 ret = ssl_parse_certificate_verify(ssl, authmode,
8308 chain, rs_ctx);
8309 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08008310 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01008311 }
Jerry Yud9526692022-02-17 14:23:47 +08008312
8313#if !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
8314 {
8315 unsigned char *crt_start, *pk_start;
8316 size_t crt_len, pk_len;
8317
8318 /* We parse the CRT chain without copying, so
8319 * these pointers point into the input buffer,
8320 * and are hence still valid after freeing the
8321 * CRT chain. */
8322
8323 crt_start = chain->raw.p;
8324 crt_len = chain->raw.len;
8325
8326 pk_start = chain->pk_raw.p;
8327 pk_len = chain->pk_raw.len;
8328
8329 /* Free the CRT structures before computing
8330 * digest and copying the peer's public key. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008331 mbedtls_x509_crt_free(chain);
8332 mbedtls_free(chain);
Jerry Yud9526692022-02-17 14:23:47 +08008333 chain = NULL;
8334
Gilles Peskine449bd832023-01-11 14:50:10 +01008335 ret = ssl_remember_peer_crt_digest(ssl, crt_start, crt_len);
8336 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08008337 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01008338 }
Jerry Yud9526692022-02-17 14:23:47 +08008339
Gilles Peskine449bd832023-01-11 14:50:10 +01008340 ret = ssl_remember_peer_pubkey(ssl, pk_start, pk_len);
8341 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08008342 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01008343 }
Jerry Yud9526692022-02-17 14:23:47 +08008344 }
8345#else /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
8346 /* Pass ownership to session structure. */
8347 ssl->session_negotiate->peer_cert = chain;
8348 chain = NULL;
8349#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
8350
Gilles Peskine449bd832023-01-11 14:50:10 +01008351 MBEDTLS_SSL_DEBUG_MSG(2, ("<= parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08008352
8353exit:
8354
Gilles Peskine449bd832023-01-11 14:50:10 +01008355 if (ret == 0) {
Jerry Yud9526692022-02-17 14:23:47 +08008356 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01008357 }
Jerry Yud9526692022-02-17 14:23:47 +08008358
8359#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01008360 if (ret == MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS) {
Jerry Yud9526692022-02-17 14:23:47 +08008361 ssl->handshake->ecrs_peer_cert = chain;
8362 chain = NULL;
8363 }
8364#endif
8365
Gilles Peskine449bd832023-01-11 14:50:10 +01008366 if (chain != NULL) {
8367 mbedtls_x509_crt_free(chain);
8368 mbedtls_free(chain);
Jerry Yud9526692022-02-17 14:23:47 +08008369 }
8370
Gilles Peskine449bd832023-01-11 14:50:10 +01008371 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08008372}
8373#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
8374
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008375static int ssl_calc_finished_tls_generic(mbedtls_ssl_context *ssl, void *ctx,
8376 unsigned char *padbuf, size_t hlen,
8377 unsigned char *buf, int from)
Jerry Yu615bd6f2022-02-17 14:25:15 +08008378{
Dave Rodgmanc37ad442023-11-03 23:36:06 +00008379 unsigned int len = 12;
Jerry Yu615bd6f2022-02-17 14:25:15 +08008380 const char *sender;
Jerry Yu615bd6f2022-02-17 14:25:15 +08008381#if defined(MBEDTLS_USE_PSA_CRYPTO)
Jerry Yu615bd6f2022-02-17 14:25:15 +08008382 psa_status_t status;
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008383 psa_hash_operation_t *hs_op = ctx;
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02008384 psa_hash_operation_t cloned_op = PSA_HASH_OPERATION_INIT;
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008385 size_t hash_size;
Jerry Yu615bd6f2022-02-17 14:25:15 +08008386#else
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01008387 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008388 mbedtls_md_context_t *hs_ctx = ctx;
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02008389 mbedtls_md_context_t cloned_ctx;
8390 mbedtls_md_init(&cloned_ctx);
Jerry Yu615bd6f2022-02-17 14:25:15 +08008391#endif
8392
8393 mbedtls_ssl_session *session = ssl->session_negotiate;
Gilles Peskine449bd832023-01-11 14:50:10 +01008394 if (!session) {
Jerry Yu615bd6f2022-02-17 14:25:15 +08008395 session = ssl->session;
Gilles Peskine449bd832023-01-11 14:50:10 +01008396 }
Jerry Yu615bd6f2022-02-17 14:25:15 +08008397
Gilles Peskine449bd832023-01-11 14:50:10 +01008398 sender = (from == MBEDTLS_SSL_IS_CLIENT)
Jerry Yu615bd6f2022-02-17 14:25:15 +08008399 ? "client finished"
8400 : "server finished";
8401
8402#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008403 MBEDTLS_SSL_DEBUG_MSG(2, ("=> calc PSA finished tls"));
Jerry Yu615bd6f2022-02-17 14:25:15 +08008404
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02008405 status = psa_hash_clone(hs_op, &cloned_op);
Gilles Peskine449bd832023-01-11 14:50:10 +01008406 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01008407 goto exit;
Jerry Yu615bd6f2022-02-17 14:25:15 +08008408 }
8409
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02008410 status = psa_hash_finish(&cloned_op, padbuf, hlen, &hash_size);
Gilles Peskine449bd832023-01-11 14:50:10 +01008411 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01008412 goto exit;
Jerry Yu615bd6f2022-02-17 14:25:15 +08008413 }
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008414 MBEDTLS_SSL_DEBUG_BUF(3, "PSA calculated padbuf", padbuf, hlen);
Jerry Yu615bd6f2022-02-17 14:25:15 +08008415#else
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008416 MBEDTLS_SSL_DEBUG_MSG(2, ("=> calc finished tls"));
Jerry Yu615bd6f2022-02-17 14:25:15 +08008417
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02008418 ret = mbedtls_md_setup(&cloned_ctx, mbedtls_md_info_from_ctx(hs_ctx), 0);
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01008419 if (ret != 0) {
8420 goto exit;
8421 }
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02008422 ret = mbedtls_md_clone(&cloned_ctx, hs_ctx);
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01008423 if (ret != 0) {
8424 goto exit;
8425 }
Jerry Yu615bd6f2022-02-17 14:25:15 +08008426
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02008427 ret = mbedtls_md_finish(&cloned_ctx, padbuf);
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008428 if (ret != 0) {
8429 goto exit;
8430 }
8431#endif /* MBEDTLS_USE_PSA_CRYPTO */
8432
8433 MBEDTLS_SSL_DEBUG_BUF(4, "finished output", padbuf, hlen);
8434
Jerry Yu615bd6f2022-02-17 14:25:15 +08008435 /*
8436 * TLSv1.2:
8437 * hash = PRF( master, finished_label,
8438 * Hash( handshake ) )[0.11]
8439 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008440 ssl->handshake->tls_prf(session->master, 48, sender,
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008441 padbuf, hlen, buf, len);
Jerry Yu615bd6f2022-02-17 14:25:15 +08008442
Gilles Peskine449bd832023-01-11 14:50:10 +01008443 MBEDTLS_SSL_DEBUG_BUF(3, "calc finished result", buf, len);
Jerry Yu615bd6f2022-02-17 14:25:15 +08008444
Paul Elliottecb95be2023-08-11 16:41:04 +01008445 mbedtls_platform_zeroize(padbuf, hlen);
Jerry Yu615bd6f2022-02-17 14:25:15 +08008446
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008447 MBEDTLS_SSL_DEBUG_MSG(2, ("<= calc finished"));
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01008448
8449exit:
8450#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02008451 psa_hash_abort(&cloned_op);
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +02008452 return mbedtls_md_error_from_psa(status);
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01008453#else
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02008454 mbedtls_md_free(&cloned_ctx);
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01008455 return ret;
8456#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu615bd6f2022-02-17 14:25:15 +08008457}
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008458
8459#if defined(MBEDTLS_MD_CAN_SHA256)
8460static int ssl_calc_finished_tls_sha256(
8461 mbedtls_ssl_context *ssl, unsigned char *buf, int from)
8462{
8463 unsigned char padbuf[32];
8464 return ssl_calc_finished_tls_generic(ssl,
8465#if defined(MBEDTLS_USE_PSA_CRYPTO)
8466 &ssl->handshake->fin_sha256_psa,
8467#else
8468 &ssl->handshake->fin_sha256,
8469#endif
8470 padbuf, sizeof(padbuf),
8471 buf, from);
8472}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01008473#endif /* MBEDTLS_MD_CAN_SHA256*/
Jerry Yu615bd6f2022-02-17 14:25:15 +08008474
Jerry Yub7ba49e2022-02-17 14:25:53 +08008475
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01008476#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +01008477static int ssl_calc_finished_tls_sha384(
Gilles Peskine449bd832023-01-11 14:50:10 +01008478 mbedtls_ssl_context *ssl, unsigned char *buf, int from)
Jerry Yub7ba49e2022-02-17 14:25:53 +08008479{
Jerry Yub7ba49e2022-02-17 14:25:53 +08008480 unsigned char padbuf[48];
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008481 return ssl_calc_finished_tls_generic(ssl,
Jerry Yub7ba49e2022-02-17 14:25:53 +08008482#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008483 &ssl->handshake->fin_sha384_psa,
Jerry Yub7ba49e2022-02-17 14:25:53 +08008484#else
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008485 &ssl->handshake->fin_sha384,
Jerry Yub7ba49e2022-02-17 14:25:53 +08008486#endif
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008487 padbuf, sizeof(padbuf),
8488 buf, from);
Jerry Yub7ba49e2022-02-17 14:25:53 +08008489}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01008490#endif /* MBEDTLS_MD_CAN_SHA384*/
Jerry Yub7ba49e2022-02-17 14:25:53 +08008491
Gilles Peskine449bd832023-01-11 14:50:10 +01008492void mbedtls_ssl_handshake_wrapup_free_hs_transform(mbedtls_ssl_context *ssl)
Jerry Yuaef00152022-02-17 14:27:31 +08008493{
Gilles Peskine449bd832023-01-11 14:50:10 +01008494 MBEDTLS_SSL_DEBUG_MSG(3, ("=> handshake wrapup: final free"));
Jerry Yuaef00152022-02-17 14:27:31 +08008495
8496 /*
8497 * Free our handshake params
8498 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008499 mbedtls_ssl_handshake_free(ssl);
8500 mbedtls_free(ssl->handshake);
Jerry Yuaef00152022-02-17 14:27:31 +08008501 ssl->handshake = NULL;
8502
8503 /*
Shaun Case8b0ecbc2021-12-20 21:14:10 -08008504 * Free the previous transform and switch in the current one
Jerry Yuaef00152022-02-17 14:27:31 +08008505 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008506 if (ssl->transform) {
8507 mbedtls_ssl_transform_free(ssl->transform);
8508 mbedtls_free(ssl->transform);
Jerry Yuaef00152022-02-17 14:27:31 +08008509 }
8510 ssl->transform = ssl->transform_negotiate;
8511 ssl->transform_negotiate = NULL;
8512
Gilles Peskine449bd832023-01-11 14:50:10 +01008513 MBEDTLS_SSL_DEBUG_MSG(3, ("<= handshake wrapup: final free"));
Jerry Yuaef00152022-02-17 14:27:31 +08008514}
8515
Gilles Peskine449bd832023-01-11 14:50:10 +01008516void mbedtls_ssl_handshake_wrapup(mbedtls_ssl_context *ssl)
Jerry Yu2a9fff52022-02-17 14:28:51 +08008517{
8518 int resume = ssl->handshake->resume;
8519
Gilles Peskine449bd832023-01-11 14:50:10 +01008520 MBEDTLS_SSL_DEBUG_MSG(3, ("=> handshake wrapup"));
Jerry Yu2a9fff52022-02-17 14:28:51 +08008521
8522#if defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01008523 if (ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS) {
Jerry Yu2a9fff52022-02-17 14:28:51 +08008524 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_DONE;
8525 ssl->renego_records_seen = 0;
8526 }
8527#endif
8528
8529 /*
8530 * Free the previous session and switch in the current one
8531 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008532 if (ssl->session) {
Jerry Yu2a9fff52022-02-17 14:28:51 +08008533#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
8534 /* RFC 7366 3.1: keep the EtM state */
8535 ssl->session_negotiate->encrypt_then_mac =
Gilles Peskine449bd832023-01-11 14:50:10 +01008536 ssl->session->encrypt_then_mac;
Jerry Yu2a9fff52022-02-17 14:28:51 +08008537#endif
8538
Gilles Peskine449bd832023-01-11 14:50:10 +01008539 mbedtls_ssl_session_free(ssl->session);
8540 mbedtls_free(ssl->session);
Jerry Yu2a9fff52022-02-17 14:28:51 +08008541 }
8542 ssl->session = ssl->session_negotiate;
8543 ssl->session_negotiate = NULL;
8544
8545 /*
8546 * Add cache entry
8547 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008548 if (ssl->conf->f_set_cache != NULL &&
Jerry Yu2a9fff52022-02-17 14:28:51 +08008549 ssl->session->id_len != 0 &&
Gilles Peskine449bd832023-01-11 14:50:10 +01008550 resume == 0) {
8551 if (ssl->conf->f_set_cache(ssl->conf->p_cache,
8552 ssl->session->id,
8553 ssl->session->id_len,
8554 ssl->session) != 0) {
8555 MBEDTLS_SSL_DEBUG_MSG(1, ("cache did not store session"));
8556 }
Jerry Yu2a9fff52022-02-17 14:28:51 +08008557 }
8558
8559#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01008560 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
8561 ssl->handshake->flight != NULL) {
Jerry Yu2a9fff52022-02-17 14:28:51 +08008562 /* Cancel handshake timer */
Gilles Peskine449bd832023-01-11 14:50:10 +01008563 mbedtls_ssl_set_timer(ssl, 0);
Jerry Yu2a9fff52022-02-17 14:28:51 +08008564
8565 /* Keep last flight around in case we need to resend it:
8566 * we need the handshake and transform structures for that */
Gilles Peskine449bd832023-01-11 14:50:10 +01008567 MBEDTLS_SSL_DEBUG_MSG(3, ("skip freeing handshake and transform"));
8568 } else
Jerry Yu2a9fff52022-02-17 14:28:51 +08008569#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01008570 mbedtls_ssl_handshake_wrapup_free_hs_transform(ssl);
Jerry Yu2a9fff52022-02-17 14:28:51 +08008571
Jerry Yu5ed73ff2022-10-27 13:08:42 +08008572 ssl->state = MBEDTLS_SSL_HANDSHAKE_OVER;
Jerry Yu2a9fff52022-02-17 14:28:51 +08008573
Gilles Peskine449bd832023-01-11 14:50:10 +01008574 MBEDTLS_SSL_DEBUG_MSG(3, ("<= handshake wrapup"));
Jerry Yu2a9fff52022-02-17 14:28:51 +08008575}
8576
Gilles Peskine449bd832023-01-11 14:50:10 +01008577int mbedtls_ssl_write_finished(mbedtls_ssl_context *ssl)
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008578{
Dave Rodgmanc37ad442023-11-03 23:36:06 +00008579 int ret;
8580 unsigned int hash_len;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008581
Gilles Peskine449bd832023-01-11 14:50:10 +01008582 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write finished"));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008583
Gilles Peskine449bd832023-01-11 14:50:10 +01008584 mbedtls_ssl_update_out_pointers(ssl, ssl->transform_negotiate);
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008585
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01008586 ret = ssl->handshake->calc_finished(ssl, ssl->out_msg + 4, ssl->conf->endpoint);
8587 if (ret != 0) {
8588 MBEDTLS_SSL_DEBUG_RET(1, "calc_finished", ret);
8589 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008590
8591 /*
8592 * RFC 5246 7.4.9 (Page 63) says 12 is the default length and ciphersuites
8593 * may define some other value. Currently (early 2016), no defined
8594 * ciphersuite does this (and this is unlikely to change as activity has
8595 * moved to TLS 1.3 now) so we can keep the hardcoded 12 here.
8596 */
8597 hash_len = 12;
8598
8599#if defined(MBEDTLS_SSL_RENEGOTIATION)
8600 ssl->verify_data_len = hash_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01008601 memcpy(ssl->own_verify_data, ssl->out_msg + 4, hash_len);
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008602#endif
8603
8604 ssl->out_msglen = 4 + hash_len;
8605 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
8606 ssl->out_msg[0] = MBEDTLS_SSL_HS_FINISHED;
8607
8608 /*
8609 * In case of session resuming, invert the client and server
8610 * ChangeCipherSpec messages order.
8611 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008612 if (ssl->handshake->resume != 0) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008613#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008614 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008615 ssl->state = MBEDTLS_SSL_HANDSHAKE_WRAPUP;
Gilles Peskine449bd832023-01-11 14:50:10 +01008616 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008617#endif
8618#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008619 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008620 ssl->state = MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC;
Gilles Peskine449bd832023-01-11 14:50:10 +01008621 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008622#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01008623 } else {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008624 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01008625 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008626
8627 /*
8628 * Switch to our negotiated transform and session parameters for outbound
8629 * data.
8630 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008631 MBEDTLS_SSL_DEBUG_MSG(3, ("switching to new transform spec for outbound data"));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008632
8633#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01008634 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008635 unsigned char i;
8636
8637 /* Remember current epoch settings for resending */
8638 ssl->handshake->alt_transform_out = ssl->transform_out;
Gilles Peskine449bd832023-01-11 14:50:10 +01008639 memcpy(ssl->handshake->alt_out_ctr, ssl->cur_out_ctr,
8640 sizeof(ssl->handshake->alt_out_ctr));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008641
8642 /* Set sequence_number to zero */
Gilles Peskine449bd832023-01-11 14:50:10 +01008643 memset(&ssl->cur_out_ctr[2], 0, sizeof(ssl->cur_out_ctr) - 2);
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008644
8645
8646 /* Increment epoch */
Gilles Peskine449bd832023-01-11 14:50:10 +01008647 for (i = 2; i > 0; i--) {
8648 if (++ssl->cur_out_ctr[i - 1] != 0) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008649 break;
Gilles Peskine449bd832023-01-11 14:50:10 +01008650 }
8651 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008652
8653 /* The loop goes to its end iff the counter is wrapping */
Gilles Peskine449bd832023-01-11 14:50:10 +01008654 if (i == 0) {
8655 MBEDTLS_SSL_DEBUG_MSG(1, ("DTLS epoch would wrap"));
8656 return MBEDTLS_ERR_SSL_COUNTER_WRAPPING;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008657 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008658 } else
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008659#endif /* MBEDTLS_SSL_PROTO_DTLS */
Gilles Peskine449bd832023-01-11 14:50:10 +01008660 memset(ssl->cur_out_ctr, 0, sizeof(ssl->cur_out_ctr));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008661
8662 ssl->transform_out = ssl->transform_negotiate;
8663 ssl->session_out = ssl->session_negotiate;
8664
8665#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01008666 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
8667 mbedtls_ssl_send_flight_completed(ssl);
8668 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008669#endif
8670
Gilles Peskine449bd832023-01-11 14:50:10 +01008671 if ((ret = mbedtls_ssl_write_handshake_msg(ssl)) != 0) {
8672 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_handshake_msg", ret);
8673 return ret;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008674 }
8675
8676#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01008677 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
8678 (ret = mbedtls_ssl_flight_transmit(ssl)) != 0) {
8679 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_flight_transmit", ret);
8680 return ret;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008681 }
8682#endif
8683
Gilles Peskine449bd832023-01-11 14:50:10 +01008684 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write finished"));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008685
Gilles Peskine449bd832023-01-11 14:50:10 +01008686 return 0;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008687}
8688
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008689#define SSL_MAX_HASH_LEN 12
8690
Gilles Peskine449bd832023-01-11 14:50:10 +01008691int mbedtls_ssl_parse_finished(mbedtls_ssl_context *ssl)
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008692{
8693 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
8694 unsigned int hash_len = 12;
8695 unsigned char buf[SSL_MAX_HASH_LEN];
8696
Gilles Peskine449bd832023-01-11 14:50:10 +01008697 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse finished"));
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008698
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01008699 ret = ssl->handshake->calc_finished(ssl, buf, ssl->conf->endpoint ^ 1);
8700 if (ret != 0) {
8701 MBEDTLS_SSL_DEBUG_RET(1, "calc_finished", ret);
8702 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008703
Gilles Peskine449bd832023-01-11 14:50:10 +01008704 if ((ret = mbedtls_ssl_read_record(ssl, 1)) != 0) {
8705 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_read_record", ret);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008706 goto exit;
8707 }
8708
Gilles Peskine449bd832023-01-11 14:50:10 +01008709 if (ssl->in_msgtype != MBEDTLS_SSL_MSG_HANDSHAKE) {
8710 MBEDTLS_SSL_DEBUG_MSG(1, ("bad finished message"));
8711 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8712 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008713 ret = MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
8714 goto exit;
8715 }
8716
Gilles Peskine449bd832023-01-11 14:50:10 +01008717 if (ssl->in_msg[0] != MBEDTLS_SSL_HS_FINISHED) {
8718 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8719 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008720 ret = MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
8721 goto exit;
8722 }
8723
Gilles Peskine449bd832023-01-11 14:50:10 +01008724 if (ssl->in_hslen != mbedtls_ssl_hs_hdr_len(ssl) + hash_len) {
8725 MBEDTLS_SSL_DEBUG_MSG(1, ("bad finished message"));
8726 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8727 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008728 ret = MBEDTLS_ERR_SSL_DECODE_ERROR;
8729 goto exit;
8730 }
8731
Gilles Peskine449bd832023-01-11 14:50:10 +01008732 if (mbedtls_ct_memcmp(ssl->in_msg + mbedtls_ssl_hs_hdr_len(ssl),
8733 buf, hash_len) != 0) {
8734 MBEDTLS_SSL_DEBUG_MSG(1, ("bad finished message"));
8735 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8736 MBEDTLS_SSL_ALERT_MSG_DECRYPT_ERROR);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008737 ret = MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
8738 goto exit;
8739 }
8740
8741#if defined(MBEDTLS_SSL_RENEGOTIATION)
8742 ssl->verify_data_len = hash_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01008743 memcpy(ssl->peer_verify_data, buf, hash_len);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008744#endif
8745
Gilles Peskine449bd832023-01-11 14:50:10 +01008746 if (ssl->handshake->resume != 0) {
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008747#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008748 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008749 ssl->state = MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC;
Gilles Peskine449bd832023-01-11 14:50:10 +01008750 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008751#endif
8752#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008753 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008754 ssl->state = MBEDTLS_SSL_HANDSHAKE_WRAPUP;
Gilles Peskine449bd832023-01-11 14:50:10 +01008755 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008756#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01008757 } else {
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008758 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01008759 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008760
8761#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01008762 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
8763 mbedtls_ssl_recv_flight_completed(ssl);
8764 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008765#endif
8766
Gilles Peskine449bd832023-01-11 14:50:10 +01008767 MBEDTLS_SSL_DEBUG_MSG(2, ("<= parse finished"));
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008768
8769exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01008770 mbedtls_platform_zeroize(buf, hash_len);
8771 return ret;
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008772}
8773
Jerry Yu392112c2022-02-17 14:34:10 +08008774#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
8775/*
8776 * Helper to get TLS 1.2 PRF from ciphersuite
8777 * (Duplicates bits of logic from ssl_set_handshake_prfs().)
8778 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008779static tls_prf_fn ssl_tls12prf_from_cs(int ciphersuite_id)
Jerry Yu392112c2022-02-17 14:34:10 +08008780{
Jerry Yu392112c2022-02-17 14:34:10 +08008781 const mbedtls_ssl_ciphersuite_t * const ciphersuite_info =
Gilles Peskine449bd832023-01-11 14:50:10 +01008782 mbedtls_ssl_ciphersuite_from_id(ciphersuite_id);
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01008783#if defined(MBEDTLS_MD_CAN_SHA384)
Gilles Peskine449bd832023-01-11 14:50:10 +01008784 if (ciphersuite_info != NULL && ciphersuite_info->mac == MBEDTLS_MD_SHA384) {
8785 return tls_prf_sha384;
8786 } else
Jerry Yu392112c2022-02-17 14:34:10 +08008787#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01008788#if defined(MBEDTLS_MD_CAN_SHA256)
Andrzej Kurek894edde2022-09-29 06:31:14 -04008789 {
Gilles Peskine449bd832023-01-11 14:50:10 +01008790 if (ciphersuite_info != NULL && ciphersuite_info->mac == MBEDTLS_MD_SHA256) {
8791 return tls_prf_sha256;
8792 }
Andrzej Kurek894edde2022-09-29 06:31:14 -04008793 }
8794#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01008795#if !defined(MBEDTLS_MD_CAN_SHA384) && \
8796 !defined(MBEDTLS_MD_CAN_SHA256)
Andrzej Kurek894edde2022-09-29 06:31:14 -04008797 (void) ciphersuite_info;
8798#endif
Andrzej Kurekeabeb302022-10-17 07:52:51 -04008799
Gilles Peskine449bd832023-01-11 14:50:10 +01008800 return NULL;
Jerry Yu392112c2022-02-17 14:34:10 +08008801}
8802#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
Jerry Yue93ffcd2022-02-17 14:37:06 +08008803
Gilles Peskine449bd832023-01-11 14:50:10 +01008804static mbedtls_tls_prf_types tls_prf_get_type(mbedtls_ssl_tls_prf_cb *tls_prf)
Jerry Yue93ffcd2022-02-17 14:37:06 +08008805{
8806 ((void) tls_prf);
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01008807#if defined(MBEDTLS_MD_CAN_SHA384)
Gilles Peskine449bd832023-01-11 14:50:10 +01008808 if (tls_prf == tls_prf_sha384) {
8809 return MBEDTLS_SSL_TLS_PRF_SHA384;
8810 } else
Jerry Yue93ffcd2022-02-17 14:37:06 +08008811#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01008812#if defined(MBEDTLS_MD_CAN_SHA256)
Gilles Peskine449bd832023-01-11 14:50:10 +01008813 if (tls_prf == tls_prf_sha256) {
8814 return MBEDTLS_SSL_TLS_PRF_SHA256;
8815 } else
Jerry Yue93ffcd2022-02-17 14:37:06 +08008816#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01008817 return MBEDTLS_SSL_TLS_PRF_NONE;
Jerry Yue93ffcd2022-02-17 14:37:06 +08008818}
8819
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008820/*
8821 * Populate a transform structure with session keys and all the other
8822 * necessary information.
8823 *
8824 * Parameters:
8825 * - [in/out]: transform: structure to populate
8826 * [in] must be just initialised with mbedtls_ssl_transform_init()
8827 * [out] fully populated, ready for use by mbedtls_ssl_{en,de}crypt_buf()
8828 * - [in] ciphersuite
8829 * - [in] master
8830 * - [in] encrypt_then_mac
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008831 * - [in] tls_prf: pointer to PRF to use for key derivation
8832 * - [in] randbytes: buffer holding ServerHello.random + ClientHello.random
Glenn Strauss07c64162022-03-14 12:34:51 -04008833 * - [in] tls_version: TLS version
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008834 * - [in] endpoint: client or server
8835 * - [in] ssl: used for:
8836 * - ssl->conf->{f,p}_export_keys
8837 * [in] optionally used for:
8838 * - MBEDTLS_DEBUG_C: ssl->conf->{f,p}_dbg
8839 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02008840MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01008841static int ssl_tls12_populate_transform(mbedtls_ssl_transform *transform,
8842 int ciphersuite,
8843 const unsigned char master[48],
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008844#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01008845 int encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008846#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01008847 ssl_tls_prf_t tls_prf,
8848 const unsigned char randbytes[64],
8849 mbedtls_ssl_protocol_version tls_version,
8850 unsigned endpoint,
8851 const mbedtls_ssl_context *ssl)
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008852{
8853 int ret = 0;
8854 unsigned char keyblk[256];
8855 unsigned char *key1;
8856 unsigned char *key2;
8857 unsigned char *mac_enc;
8858 unsigned char *mac_dec;
8859 size_t mac_key_len = 0;
8860 size_t iv_copy_len;
8861 size_t keylen;
8862 const mbedtls_ssl_ciphersuite_t *ciphersuite_info;
Neil Armstrong7fea33e2022-04-01 15:40:25 +02008863 mbedtls_ssl_mode_t ssl_mode;
Neil Armstronge4512952022-03-08 09:08:22 +01008864#if !defined(MBEDTLS_USE_PSA_CRYPTO)
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008865 const mbedtls_cipher_info_t *cipher_info;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008866 const mbedtls_md_info_t *md_info;
Neil Armstronge4512952022-03-08 09:08:22 +01008867#endif /* !MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008868
8869#if defined(MBEDTLS_USE_PSA_CRYPTO)
8870 psa_key_type_t key_type;
8871 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
8872 psa_algorithm_t alg;
Neil Armstronge4512952022-03-08 09:08:22 +01008873 psa_algorithm_t mac_alg = 0;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008874 size_t key_bits;
8875 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
8876#endif
8877
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008878 /*
8879 * Some data just needs copying into the structure
8880 */
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008881#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008882 transform->encrypt_then_mac = encrypt_then_mac;
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008883#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Glenn Strauss07c64162022-03-14 12:34:51 -04008884 transform->tls_version = tls_version;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008885
8886#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01008887 memcpy(transform->randbytes, randbytes, sizeof(transform->randbytes));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008888#endif
8889
8890#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01008891 if (tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008892 /* At the moment, we keep TLS <= 1.2 and TLS 1.3 transform
8893 * generation separate. This should never happen. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008894 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008895 }
8896#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
8897
8898 /*
8899 * Get various info structures
8900 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008901 ciphersuite_info = mbedtls_ssl_ciphersuite_from_id(ciphersuite);
8902 if (ciphersuite_info == NULL) {
8903 MBEDTLS_SSL_DEBUG_MSG(1, ("ciphersuite info for %d not found",
8904 ciphersuite));
8905 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008906 }
8907
Neil Armstrongab555e02022-04-04 11:07:59 +02008908 ssl_mode = mbedtls_ssl_get_mode_from_ciphersuite(
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008909#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01008910 encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008911#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01008912 ciphersuite_info);
Neil Armstrong7fea33e2022-04-01 15:40:25 +02008913
Gilles Peskine449bd832023-01-11 14:50:10 +01008914 if (ssl_mode == MBEDTLS_SSL_MODE_AEAD) {
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008915 transform->taglen =
8916 ciphersuite_info->flags & MBEDTLS_CIPHERSUITE_SHORT_TAG ? 8 : 16;
Gilles Peskine449bd832023-01-11 14:50:10 +01008917 }
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008918
8919#if defined(MBEDTLS_USE_PSA_CRYPTO)
Dave Rodgman2eab4622023-10-05 13:30:37 +01008920 if ((status = mbedtls_ssl_cipher_to_psa((mbedtls_cipher_type_t) ciphersuite_info->cipher,
Gilles Peskine449bd832023-01-11 14:50:10 +01008921 transform->taglen,
8922 &alg,
8923 &key_type,
8924 &key_bits)) != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008925 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01008926 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_cipher_to_psa", ret);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008927 goto end;
8928 }
8929#else
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01008930 cipher_info = mbedtls_cipher_info_from_type((mbedtls_cipher_type_t) ciphersuite_info->cipher);
Gilles Peskine449bd832023-01-11 14:50:10 +01008931 if (cipher_info == NULL) {
8932 MBEDTLS_SSL_DEBUG_MSG(1, ("cipher info for %u not found",
8933 ciphersuite_info->cipher));
8934 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008935 }
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008936#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008937
Neil Armstronge4512952022-03-08 09:08:22 +01008938#if defined(MBEDTLS_USE_PSA_CRYPTO)
Dave Rodgman2eab4622023-10-05 13:30:37 +01008939 mac_alg = mbedtls_md_psa_alg_from_type((mbedtls_md_type_t) ciphersuite_info->mac);
Gilles Peskine449bd832023-01-11 14:50:10 +01008940 if (mac_alg == 0) {
Manuel Pégourié-Gonnard2d6d9932023-03-28 11:38:08 +02008941 MBEDTLS_SSL_DEBUG_MSG(1, ("mbedtls_md_psa_alg_from_type for %u not found",
Gilles Peskine449bd832023-01-11 14:50:10 +01008942 (unsigned) ciphersuite_info->mac));
8943 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Neil Armstronge4512952022-03-08 09:08:22 +01008944 }
8945#else
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01008946 md_info = mbedtls_md_info_from_type((mbedtls_md_type_t) ciphersuite_info->mac);
Gilles Peskine449bd832023-01-11 14:50:10 +01008947 if (md_info == NULL) {
8948 MBEDTLS_SSL_DEBUG_MSG(1, ("mbedtls_md info for %u not found",
8949 (unsigned) ciphersuite_info->mac));
8950 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008951 }
Neil Armstronge4512952022-03-08 09:08:22 +01008952#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008953
8954#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
8955 /* Copy own and peer's CID if the use of the CID
8956 * extension has been negotiated. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008957 if (ssl->handshake->cid_in_use == MBEDTLS_SSL_CID_ENABLED) {
8958 MBEDTLS_SSL_DEBUG_MSG(3, ("Copy CIDs into SSL transform"));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008959
8960 transform->in_cid_len = ssl->own_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01008961 memcpy(transform->in_cid, ssl->own_cid, ssl->own_cid_len);
8962 MBEDTLS_SSL_DEBUG_BUF(3, "Incoming CID", transform->in_cid,
8963 transform->in_cid_len);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008964
8965 transform->out_cid_len = ssl->handshake->peer_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01008966 memcpy(transform->out_cid, ssl->handshake->peer_cid,
8967 ssl->handshake->peer_cid_len);
8968 MBEDTLS_SSL_DEBUG_BUF(3, "Outgoing CID", transform->out_cid,
8969 transform->out_cid_len);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008970 }
8971#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
8972
8973 /*
8974 * Compute key block using the PRF
8975 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008976 ret = tls_prf(master, 48, "key expansion", randbytes, 64, keyblk, 256);
8977 if (ret != 0) {
8978 MBEDTLS_SSL_DEBUG_RET(1, "prf", ret);
8979 return ret;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008980 }
8981
Gilles Peskine449bd832023-01-11 14:50:10 +01008982 MBEDTLS_SSL_DEBUG_MSG(3, ("ciphersuite = %s",
8983 mbedtls_ssl_get_ciphersuite_name(ciphersuite)));
8984 MBEDTLS_SSL_DEBUG_BUF(3, "master secret", master, 48);
8985 MBEDTLS_SSL_DEBUG_BUF(4, "random bytes", randbytes, 64);
8986 MBEDTLS_SSL_DEBUG_BUF(4, "key block", keyblk, 256);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008987
8988 /*
8989 * Determine the appropriate key, IV and MAC length.
8990 */
8991
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008992#if defined(MBEDTLS_USE_PSA_CRYPTO)
8993 keylen = PSA_BITS_TO_BYTES(key_bits);
8994#else
Gilles Peskine449bd832023-01-11 14:50:10 +01008995 keylen = mbedtls_cipher_info_get_key_bitlen(cipher_info) / 8;
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008996#endif
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008997
Valerio Settie5707042023-10-11 11:54:42 +02008998#if defined(MBEDTLS_SSL_HAVE_AEAD)
Gilles Peskine449bd832023-01-11 14:50:10 +01008999 if (ssl_mode == MBEDTLS_SSL_MODE_AEAD) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009000 size_t explicit_ivlen;
9001
9002 transform->maclen = 0;
9003 mac_key_len = 0;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009004
9005 /* All modes haves 96-bit IVs, but the length of the static parts vary
9006 * with mode and version:
9007 * - For GCM and CCM in TLS 1.2, there's a static IV of 4 Bytes
9008 * (to be concatenated with a dynamically chosen IV of 8 Bytes)
9009 * - For ChaChaPoly in TLS 1.2, and all modes in TLS 1.3, there's
9010 * a static IV of 12 Bytes (to be XOR'ed with the 8 Byte record
9011 * sequence number).
9012 */
9013 transform->ivlen = 12;
David Horstmann3b2276a2022-10-06 14:49:08 +01009014
9015 int is_chachapoly = 0;
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02009016#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01009017 is_chachapoly = (key_type == PSA_KEY_TYPE_CHACHA20);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02009018#else
Gilles Peskine449bd832023-01-11 14:50:10 +01009019 is_chachapoly = (mbedtls_cipher_info_get_mode(cipher_info)
9020 == MBEDTLS_MODE_CHACHAPOLY);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02009021#endif /* MBEDTLS_USE_PSA_CRYPTO */
David Horstmann3b2276a2022-10-06 14:49:08 +01009022
Gilles Peskine449bd832023-01-11 14:50:10 +01009023 if (is_chachapoly) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009024 transform->fixed_ivlen = 12;
Gilles Peskine449bd832023-01-11 14:50:10 +01009025 } else {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009026 transform->fixed_ivlen = 4;
Gilles Peskine449bd832023-01-11 14:50:10 +01009027 }
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009028
9029 /* Minimum length of encrypted record */
9030 explicit_ivlen = transform->ivlen - transform->fixed_ivlen;
9031 transform->minlen = explicit_ivlen + transform->taglen;
Gilles Peskine449bd832023-01-11 14:50:10 +01009032 } else
Valerio Settie5707042023-10-11 11:54:42 +02009033#endif /* MBEDTLS_SSL_HAVE_AEAD */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009034#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01009035 if (ssl_mode == MBEDTLS_SSL_MODE_STREAM ||
Neil Armstrong7fea33e2022-04-01 15:40:25 +02009036 ssl_mode == MBEDTLS_SSL_MODE_CBC ||
Gilles Peskine449bd832023-01-11 14:50:10 +01009037 ssl_mode == MBEDTLS_SSL_MODE_CBC_ETM) {
Neil Armstronge4512952022-03-08 09:08:22 +01009038#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01009039 size_t block_size = PSA_BLOCK_CIPHER_BLOCK_LENGTH(key_type);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02009040#else
Dave Rodgman85a88132023-06-24 11:41:50 +01009041 size_t block_size = mbedtls_cipher_info_get_block_size(cipher_info);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02009042#endif /* MBEDTLS_USE_PSA_CRYPTO */
9043
9044#if defined(MBEDTLS_USE_PSA_CRYPTO)
Neil Armstronge4512952022-03-08 09:08:22 +01009045 /* Get MAC length */
9046 mac_key_len = PSA_HASH_LENGTH(mac_alg);
9047#else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009048 /* Initialize HMAC contexts */
Gilles Peskine449bd832023-01-11 14:50:10 +01009049 if ((ret = mbedtls_md_setup(&transform->md_ctx_enc, md_info, 1)) != 0 ||
9050 (ret = mbedtls_md_setup(&transform->md_ctx_dec, md_info, 1)) != 0) {
9051 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_setup", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009052 goto end;
9053 }
9054
9055 /* Get MAC length */
Gilles Peskine449bd832023-01-11 14:50:10 +01009056 mac_key_len = mbedtls_md_get_size(md_info);
Neil Armstronge4512952022-03-08 09:08:22 +01009057#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009058 transform->maclen = mac_key_len;
9059
9060 /* IV length */
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02009061#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01009062 transform->ivlen = PSA_CIPHER_IV_LENGTH(key_type, alg);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02009063#else
Dave Rodgmanbb521fd2023-06-24 11:21:25 +01009064 transform->ivlen = mbedtls_cipher_info_get_iv_size(cipher_info);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02009065#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009066
9067 /* Minimum length */
Gilles Peskine449bd832023-01-11 14:50:10 +01009068 if (ssl_mode == MBEDTLS_SSL_MODE_STREAM) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009069 transform->minlen = transform->maclen;
Gilles Peskine449bd832023-01-11 14:50:10 +01009070 } else {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009071 /*
9072 * GenericBlockCipher:
9073 * 1. if EtM is in use: one block plus MAC
9074 * otherwise: * first multiple of blocklen greater than maclen
9075 * 2. IV
9076 */
9077#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01009078 if (ssl_mode == MBEDTLS_SSL_MODE_CBC_ETM) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009079 transform->minlen = transform->maclen
Gilles Peskine449bd832023-01-11 14:50:10 +01009080 + block_size;
9081 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009082#endif
9083 {
9084 transform->minlen = transform->maclen
Gilles Peskine449bd832023-01-11 14:50:10 +01009085 + block_size
9086 - transform->maclen % block_size;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009087 }
9088
Gilles Peskine449bd832023-01-11 14:50:10 +01009089 if (tls_version == MBEDTLS_SSL_VERSION_TLS1_2) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009090 transform->minlen += transform->ivlen;
Gilles Peskine449bd832023-01-11 14:50:10 +01009091 } else {
9092 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009093 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
9094 goto end;
9095 }
9096 }
Gilles Peskine449bd832023-01-11 14:50:10 +01009097 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009098#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
9099 {
Gilles Peskine449bd832023-01-11 14:50:10 +01009100 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
9101 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009102 }
9103
Gilles Peskine449bd832023-01-11 14:50:10 +01009104 MBEDTLS_SSL_DEBUG_MSG(3, ("keylen: %u, minlen: %u, ivlen: %u, maclen: %u",
9105 (unsigned) keylen,
9106 (unsigned) transform->minlen,
9107 (unsigned) transform->ivlen,
9108 (unsigned) transform->maclen));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009109
9110 /*
9111 * Finally setup the cipher contexts, IVs and MAC secrets.
9112 */
9113#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01009114 if (endpoint == MBEDTLS_SSL_IS_CLIENT) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009115 key1 = keyblk + mac_key_len * 2;
9116 key2 = keyblk + mac_key_len * 2 + keylen;
9117
9118 mac_enc = keyblk;
9119 mac_dec = keyblk + mac_key_len;
9120
Gilles Peskine449bd832023-01-11 14:50:10 +01009121 iv_copy_len = (transform->fixed_ivlen) ?
9122 transform->fixed_ivlen : transform->ivlen;
9123 memcpy(transform->iv_enc, key2 + keylen, iv_copy_len);
9124 memcpy(transform->iv_dec, key2 + keylen + iv_copy_len,
9125 iv_copy_len);
9126 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009127#endif /* MBEDTLS_SSL_CLI_C */
9128#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01009129 if (endpoint == MBEDTLS_SSL_IS_SERVER) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009130 key1 = keyblk + mac_key_len * 2 + keylen;
9131 key2 = keyblk + mac_key_len * 2;
9132
9133 mac_enc = keyblk + mac_key_len;
9134 mac_dec = keyblk;
9135
Gilles Peskine449bd832023-01-11 14:50:10 +01009136 iv_copy_len = (transform->fixed_ivlen) ?
9137 transform->fixed_ivlen : transform->ivlen;
9138 memcpy(transform->iv_dec, key1 + keylen, iv_copy_len);
9139 memcpy(transform->iv_enc, key1 + keylen + iv_copy_len,
9140 iv_copy_len);
9141 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009142#endif /* MBEDTLS_SSL_SRV_C */
9143 {
Gilles Peskine449bd832023-01-11 14:50:10 +01009144 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009145 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
9146 goto end;
9147 }
9148
Paul Elliott4fb19552023-10-18 12:15:30 +01009149 if (ssl->f_export_keys != NULL) {
Gilles Peskine449bd832023-01-11 14:50:10 +01009150 ssl->f_export_keys(ssl->p_export_keys,
9151 MBEDTLS_SSL_KEY_EXPORT_TLS12_MASTER_SECRET,
9152 master, 48,
9153 randbytes + 32,
9154 randbytes,
9155 tls_prf_get_type(tls_prf));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009156 }
9157
9158#if defined(MBEDTLS_USE_PSA_CRYPTO)
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009159 transform->psa_alg = alg;
9160
Gilles Peskine449bd832023-01-11 14:50:10 +01009161 if (alg != MBEDTLS_SSL_NULL_CIPHER) {
9162 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_ENCRYPT);
9163 psa_set_key_algorithm(&attributes, alg);
9164 psa_set_key_type(&attributes, key_type);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009165
Gilles Peskine449bd832023-01-11 14:50:10 +01009166 if ((status = psa_import_key(&attributes,
9167 key1,
9168 PSA_BITS_TO_BYTES(key_bits),
9169 &transform->psa_key_enc)) != PSA_SUCCESS) {
9170 MBEDTLS_SSL_DEBUG_RET(3, "psa_import_key", (int) status);
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05009171 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01009172 MBEDTLS_SSL_DEBUG_RET(1, "psa_import_key", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009173 goto end;
9174 }
9175
Gilles Peskine449bd832023-01-11 14:50:10 +01009176 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_DECRYPT);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009177
Gilles Peskine449bd832023-01-11 14:50:10 +01009178 if ((status = psa_import_key(&attributes,
9179 key2,
9180 PSA_BITS_TO_BYTES(key_bits),
9181 &transform->psa_key_dec)) != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05009182 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01009183 MBEDTLS_SSL_DEBUG_RET(1, "psa_import_key", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009184 goto end;
9185 }
9186 }
9187#else
Gilles Peskine449bd832023-01-11 14:50:10 +01009188 if ((ret = mbedtls_cipher_setup(&transform->cipher_ctx_enc,
9189 cipher_info)) != 0) {
9190 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_setup", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009191 goto end;
9192 }
9193
Gilles Peskine449bd832023-01-11 14:50:10 +01009194 if ((ret = mbedtls_cipher_setup(&transform->cipher_ctx_dec,
9195 cipher_info)) != 0) {
9196 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_setup", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009197 goto end;
9198 }
9199
Gilles Peskine449bd832023-01-11 14:50:10 +01009200 if ((ret = mbedtls_cipher_setkey(&transform->cipher_ctx_enc, key1,
9201 (int) mbedtls_cipher_info_get_key_bitlen(cipher_info),
9202 MBEDTLS_ENCRYPT)) != 0) {
9203 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_setkey", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009204 goto end;
9205 }
9206
Gilles Peskine449bd832023-01-11 14:50:10 +01009207 if ((ret = mbedtls_cipher_setkey(&transform->cipher_ctx_dec, key2,
9208 (int) mbedtls_cipher_info_get_key_bitlen(cipher_info),
9209 MBEDTLS_DECRYPT)) != 0) {
9210 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_setkey", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009211 goto end;
9212 }
9213
9214#if defined(MBEDTLS_CIPHER_MODE_CBC)
Gilles Peskine449bd832023-01-11 14:50:10 +01009215 if (mbedtls_cipher_info_get_mode(cipher_info) == MBEDTLS_MODE_CBC) {
9216 if ((ret = mbedtls_cipher_set_padding_mode(&transform->cipher_ctx_enc,
9217 MBEDTLS_PADDING_NONE)) != 0) {
9218 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_set_padding_mode", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009219 goto end;
9220 }
9221
Gilles Peskine449bd832023-01-11 14:50:10 +01009222 if ((ret = mbedtls_cipher_set_padding_mode(&transform->cipher_ctx_dec,
9223 MBEDTLS_PADDING_NONE)) != 0) {
9224 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_set_padding_mode", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009225 goto end;
9226 }
9227 }
9228#endif /* MBEDTLS_CIPHER_MODE_CBC */
9229#endif /* MBEDTLS_USE_PSA_CRYPTO */
9230
Neil Armstrong29c0c042022-03-17 17:47:28 +01009231#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
9232 /* For HMAC-based ciphersuites, initialize the HMAC transforms.
9233 For AEAD-based ciphersuites, there is nothing to do here. */
Gilles Peskine449bd832023-01-11 14:50:10 +01009234 if (mac_key_len != 0) {
Neil Armstrong29c0c042022-03-17 17:47:28 +01009235#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01009236 transform->psa_mac_alg = PSA_ALG_HMAC(mac_alg);
Neil Armstrong29c0c042022-03-17 17:47:28 +01009237
Gilles Peskine449bd832023-01-11 14:50:10 +01009238 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_SIGN_MESSAGE);
9239 psa_set_key_algorithm(&attributes, PSA_ALG_HMAC(mac_alg));
9240 psa_set_key_type(&attributes, PSA_KEY_TYPE_HMAC);
Neil Armstrong29c0c042022-03-17 17:47:28 +01009241
Gilles Peskine449bd832023-01-11 14:50:10 +01009242 if ((status = psa_import_key(&attributes,
9243 mac_enc, mac_key_len,
9244 &transform->psa_mac_enc)) != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05009245 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01009246 MBEDTLS_SSL_DEBUG_RET(1, "psa_import_mac_key", ret);
Neil Armstrong29c0c042022-03-17 17:47:28 +01009247 goto end;
9248 }
9249
Gilles Peskine449bd832023-01-11 14:50:10 +01009250 if ((transform->psa_alg == MBEDTLS_SSL_NULL_CIPHER) ||
9251 ((transform->psa_alg == PSA_ALG_CBC_NO_PADDING)
Andrzej Kurek8c95ac42022-08-17 16:17:00 -04009252#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01009253 && (transform->encrypt_then_mac == MBEDTLS_SSL_ETM_DISABLED)
Andrzej Kurek8c95ac42022-08-17 16:17:00 -04009254#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01009255 )) {
Neil Armstrong29c0c042022-03-17 17:47:28 +01009256 /* mbedtls_ct_hmac() requires the key to be exportable */
Gilles Peskine449bd832023-01-11 14:50:10 +01009257 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_EXPORT |
9258 PSA_KEY_USAGE_VERIFY_HASH);
9259 } else {
9260 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_VERIFY_HASH);
9261 }
Neil Armstrong29c0c042022-03-17 17:47:28 +01009262
Gilles Peskine449bd832023-01-11 14:50:10 +01009263 if ((status = psa_import_key(&attributes,
9264 mac_dec, mac_key_len,
9265 &transform->psa_mac_dec)) != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05009266 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01009267 MBEDTLS_SSL_DEBUG_RET(1, "psa_import_mac_key", ret);
Neil Armstrong29c0c042022-03-17 17:47:28 +01009268 goto end;
9269 }
9270#else
Gilles Peskine449bd832023-01-11 14:50:10 +01009271 ret = mbedtls_md_hmac_starts(&transform->md_ctx_enc, mac_enc, mac_key_len);
9272 if (ret != 0) {
Neil Armstrong29c0c042022-03-17 17:47:28 +01009273 goto end;
Gilles Peskine449bd832023-01-11 14:50:10 +01009274 }
9275 ret = mbedtls_md_hmac_starts(&transform->md_ctx_dec, mac_dec, mac_key_len);
9276 if (ret != 0) {
Neil Armstrong29c0c042022-03-17 17:47:28 +01009277 goto end;
Gilles Peskine449bd832023-01-11 14:50:10 +01009278 }
Neil Armstrong29c0c042022-03-17 17:47:28 +01009279#endif /* MBEDTLS_USE_PSA_CRYPTO */
9280 }
9281#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
9282
9283 ((void) mac_dec);
9284 ((void) mac_enc);
9285
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009286end:
Gilles Peskine449bd832023-01-11 14:50:10 +01009287 mbedtls_platform_zeroize(keyblk, sizeof(keyblk));
9288 return ret;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009289}
9290
Valerio Settia08b1a42022-11-17 15:10:02 +01009291#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED) && \
9292 defined(MBEDTLS_USE_PSA_CRYPTO)
Valerio Setti6b3dab02022-11-17 17:14:54 +01009293int mbedtls_psa_ecjpake_read_round(
Gilles Peskine449bd832023-01-11 14:50:10 +01009294 psa_pake_operation_t *pake_ctx,
9295 const unsigned char *buf,
9296 size_t len, mbedtls_ecjpake_rounds_t round)
Valerio Settia08b1a42022-11-17 15:10:02 +01009297{
9298 psa_status_t status;
9299 size_t input_offset = 0;
Valerio Setti819de862022-11-17 18:05:19 +01009300 /*
Valerio Setti6b3dab02022-11-17 17:14:54 +01009301 * At round one repeat the KEY_SHARE, ZK_PUBLIC & ZF_PROOF twice
9302 * At round two perform a single cycle
9303 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009304 unsigned int remaining_steps = (round == MBEDTLS_ECJPAKE_ROUND_ONE) ? 2 : 1;
Valerio Settia08b1a42022-11-17 15:10:02 +01009305
Gilles Peskine449bd832023-01-11 14:50:10 +01009306 for (; remaining_steps > 0; remaining_steps--) {
9307 for (psa_pake_step_t step = PSA_PAKE_STEP_KEY_SHARE;
Valerio Settia08b1a42022-11-17 15:10:02 +01009308 step <= PSA_PAKE_STEP_ZK_PROOF;
Gilles Peskine449bd832023-01-11 14:50:10 +01009309 ++step) {
Valerio Settia08b1a42022-11-17 15:10:02 +01009310 /* Length is stored at the first byte */
9311 size_t length = buf[input_offset];
9312 input_offset += 1;
9313
Gilles Peskine449bd832023-01-11 14:50:10 +01009314 if (input_offset + length > len) {
Valerio Settia08b1a42022-11-17 15:10:02 +01009315 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
9316 }
9317
Gilles Peskine449bd832023-01-11 14:50:10 +01009318 status = psa_pake_input(pake_ctx, step,
9319 buf + input_offset, length);
9320 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05009321 return PSA_TO_MBEDTLS_ERR(status);
Valerio Settia08b1a42022-11-17 15:10:02 +01009322 }
9323
9324 input_offset += length;
9325 }
9326 }
9327
Gilles Peskine449bd832023-01-11 14:50:10 +01009328 if (input_offset != len) {
Valerio Setti61ea17d2022-11-18 12:11:00 +01009329 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Gilles Peskine449bd832023-01-11 14:50:10 +01009330 }
Valerio Setti30ebe112022-11-17 16:23:34 +01009331
Gilles Peskine449bd832023-01-11 14:50:10 +01009332 return 0;
Valerio Settia08b1a42022-11-17 15:10:02 +01009333}
9334
Valerio Setti6b3dab02022-11-17 17:14:54 +01009335int mbedtls_psa_ecjpake_write_round(
Gilles Peskine449bd832023-01-11 14:50:10 +01009336 psa_pake_operation_t *pake_ctx,
9337 unsigned char *buf,
9338 size_t len, size_t *olen,
9339 mbedtls_ecjpake_rounds_t round)
Valerio Settia08b1a42022-11-17 15:10:02 +01009340{
9341 psa_status_t status;
9342 size_t output_offset = 0;
9343 size_t output_len;
Valerio Setti819de862022-11-17 18:05:19 +01009344 /*
Valerio Setti6b3dab02022-11-17 17:14:54 +01009345 * At round one repeat the KEY_SHARE, ZK_PUBLIC & ZF_PROOF twice
9346 * At round two perform a single cycle
9347 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009348 unsigned int remaining_steps = (round == MBEDTLS_ECJPAKE_ROUND_ONE) ? 2 : 1;
Valerio Settia08b1a42022-11-17 15:10:02 +01009349
Gilles Peskine449bd832023-01-11 14:50:10 +01009350 for (; remaining_steps > 0; remaining_steps--) {
9351 for (psa_pake_step_t step = PSA_PAKE_STEP_KEY_SHARE;
9352 step <= PSA_PAKE_STEP_ZK_PROOF;
9353 ++step) {
Valerio Setti79f6b6b2022-11-21 14:17:03 +01009354 /*
Valerio Settid4a9b1a2022-11-22 11:11:10 +01009355 * For each step, prepend 1 byte with the length of the data as
9356 * given by psa_pake_output().
Valerio Setti79f6b6b2022-11-21 14:17:03 +01009357 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009358 status = psa_pake_output(pake_ctx, step,
9359 buf + output_offset + 1,
9360 len - output_offset - 1,
9361 &output_len);
9362 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05009363 return PSA_TO_MBEDTLS_ERR(status);
Valerio Settia08b1a42022-11-17 15:10:02 +01009364 }
9365
Valerio Setti99d88c12022-11-22 16:03:43 +01009366 *(buf + output_offset) = (uint8_t) output_len;
Valerio Setti79f6b6b2022-11-21 14:17:03 +01009367
9368 output_offset += output_len + 1;
Valerio Settia08b1a42022-11-17 15:10:02 +01009369 }
9370 }
9371
9372 *olen = output_offset;
9373
Gilles Peskine449bd832023-01-11 14:50:10 +01009374 return 0;
Valerio Settia08b1a42022-11-17 15:10:02 +01009375}
Valerio Settia08b1a42022-11-17 15:10:02 +01009376#endif //MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED && MBEDTLS_USE_PSA_CRYPTO
9377
Jerry Yuee40f9d2022-02-17 14:55:16 +08009378#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01009379int mbedtls_ssl_get_key_exchange_md_tls1_2(mbedtls_ssl_context *ssl,
9380 unsigned char *hash, size_t *hashlen,
9381 unsigned char *data, size_t data_len,
9382 mbedtls_md_type_t md_alg)
Jerry Yuee40f9d2022-02-17 14:55:16 +08009383{
9384 psa_status_t status;
9385 psa_hash_operation_t hash_operation = PSA_HASH_OPERATION_INIT;
Manuel Pégourié-Gonnard2d6d9932023-03-28 11:38:08 +02009386 psa_algorithm_t hash_alg = mbedtls_md_psa_alg_from_type(md_alg);
Jerry Yuee40f9d2022-02-17 14:55:16 +08009387
Gilles Peskine449bd832023-01-11 14:50:10 +01009388 MBEDTLS_SSL_DEBUG_MSG(3, ("Perform PSA-based computation of digest of ServerKeyExchange"));
Jerry Yuee40f9d2022-02-17 14:55:16 +08009389
Gilles Peskine449bd832023-01-11 14:50:10 +01009390 if ((status = psa_hash_setup(&hash_operation,
9391 hash_alg)) != PSA_SUCCESS) {
9392 MBEDTLS_SSL_DEBUG_RET(1, "psa_hash_setup", status);
Jerry Yuee40f9d2022-02-17 14:55:16 +08009393 goto exit;
9394 }
9395
Gilles Peskine449bd832023-01-11 14:50:10 +01009396 if ((status = psa_hash_update(&hash_operation, ssl->handshake->randbytes,
9397 64)) != PSA_SUCCESS) {
9398 MBEDTLS_SSL_DEBUG_RET(1, "psa_hash_update", status);
Jerry Yuee40f9d2022-02-17 14:55:16 +08009399 goto exit;
9400 }
9401
Gilles Peskine449bd832023-01-11 14:50:10 +01009402 if ((status = psa_hash_update(&hash_operation,
9403 data, data_len)) != PSA_SUCCESS) {
9404 MBEDTLS_SSL_DEBUG_RET(1, "psa_hash_update", status);
Jerry Yuee40f9d2022-02-17 14:55:16 +08009405 goto exit;
9406 }
9407
Gilles Peskine449bd832023-01-11 14:50:10 +01009408 if ((status = psa_hash_finish(&hash_operation, hash, PSA_HASH_MAX_SIZE,
9409 hashlen)) != PSA_SUCCESS) {
9410 MBEDTLS_SSL_DEBUG_RET(1, "psa_hash_finish", status);
9411 goto exit;
Jerry Yuee40f9d2022-02-17 14:55:16 +08009412 }
9413
9414exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01009415 if (status != PSA_SUCCESS) {
9416 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
9417 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR);
9418 switch (status) {
Jerry Yuee40f9d2022-02-17 14:55:16 +08009419 case PSA_ERROR_NOT_SUPPORTED:
Gilles Peskine449bd832023-01-11 14:50:10 +01009420 return MBEDTLS_ERR_MD_FEATURE_UNAVAILABLE;
Jerry Yuee40f9d2022-02-17 14:55:16 +08009421 case PSA_ERROR_BAD_STATE: /* Intentional fallthrough */
9422 case PSA_ERROR_BUFFER_TOO_SMALL:
Gilles Peskine449bd832023-01-11 14:50:10 +01009423 return MBEDTLS_ERR_MD_BAD_INPUT_DATA;
Jerry Yuee40f9d2022-02-17 14:55:16 +08009424 case PSA_ERROR_INSUFFICIENT_MEMORY:
Gilles Peskine449bd832023-01-11 14:50:10 +01009425 return MBEDTLS_ERR_MD_ALLOC_FAILED;
Jerry Yuee40f9d2022-02-17 14:55:16 +08009426 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01009427 return MBEDTLS_ERR_PLATFORM_HW_ACCEL_FAILED;
Jerry Yuee40f9d2022-02-17 14:55:16 +08009428 }
9429 }
Gilles Peskine449bd832023-01-11 14:50:10 +01009430 return 0;
Jerry Yuee40f9d2022-02-17 14:55:16 +08009431}
9432
9433#else
9434
Gilles Peskine449bd832023-01-11 14:50:10 +01009435int mbedtls_ssl_get_key_exchange_md_tls1_2(mbedtls_ssl_context *ssl,
9436 unsigned char *hash, size_t *hashlen,
9437 unsigned char *data, size_t data_len,
9438 mbedtls_md_type_t md_alg)
Jerry Yuee40f9d2022-02-17 14:55:16 +08009439{
9440 int ret = 0;
9441 mbedtls_md_context_t ctx;
Gilles Peskine449bd832023-01-11 14:50:10 +01009442 const mbedtls_md_info_t *md_info = mbedtls_md_info_from_type(md_alg);
9443 *hashlen = mbedtls_md_get_size(md_info);
Jerry Yuee40f9d2022-02-17 14:55:16 +08009444
Gilles Peskine449bd832023-01-11 14:50:10 +01009445 MBEDTLS_SSL_DEBUG_MSG(3, ("Perform mbedtls-based computation of digest of ServerKeyExchange"));
Jerry Yuee40f9d2022-02-17 14:55:16 +08009446
Gilles Peskine449bd832023-01-11 14:50:10 +01009447 mbedtls_md_init(&ctx);
Jerry Yuee40f9d2022-02-17 14:55:16 +08009448
9449 /*
9450 * digitally-signed struct {
9451 * opaque client_random[32];
9452 * opaque server_random[32];
9453 * ServerDHParams params;
9454 * };
9455 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009456 if ((ret = mbedtls_md_setup(&ctx, md_info, 0)) != 0) {
9457 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_setup", ret);
Jerry Yuee40f9d2022-02-17 14:55:16 +08009458 goto exit;
9459 }
Gilles Peskine449bd832023-01-11 14:50:10 +01009460 if ((ret = mbedtls_md_starts(&ctx)) != 0) {
9461 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_starts", ret);
Jerry Yuee40f9d2022-02-17 14:55:16 +08009462 goto exit;
9463 }
Gilles Peskine449bd832023-01-11 14:50:10 +01009464 if ((ret = mbedtls_md_update(&ctx, ssl->handshake->randbytes, 64)) != 0) {
9465 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_update", ret);
Jerry Yuee40f9d2022-02-17 14:55:16 +08009466 goto exit;
9467 }
Gilles Peskine449bd832023-01-11 14:50:10 +01009468 if ((ret = mbedtls_md_update(&ctx, data, data_len)) != 0) {
9469 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_update", ret);
Jerry Yuee40f9d2022-02-17 14:55:16 +08009470 goto exit;
9471 }
Gilles Peskine449bd832023-01-11 14:50:10 +01009472 if ((ret = mbedtls_md_finish(&ctx, hash)) != 0) {
9473 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_finish", ret);
Jerry Yuee40f9d2022-02-17 14:55:16 +08009474 goto exit;
9475 }
9476
9477exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01009478 mbedtls_md_free(&ctx);
Jerry Yuee40f9d2022-02-17 14:55:16 +08009479
Gilles Peskine449bd832023-01-11 14:50:10 +01009480 if (ret != 0) {
9481 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
9482 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR);
9483 }
Jerry Yuee40f9d2022-02-17 14:55:16 +08009484
Gilles Peskine449bd832023-01-11 14:50:10 +01009485 return ret;
Jerry Yuee40f9d2022-02-17 14:55:16 +08009486}
9487#endif /* MBEDTLS_USE_PSA_CRYPTO */
9488
Jerry Yud9d91da2022-02-17 14:57:06 +08009489#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
9490
Gabor Mezeia3d016c2022-05-10 12:44:09 +02009491/* Find the preferred hash for a given signature algorithm. */
9492unsigned int mbedtls_ssl_tls12_get_preferred_hash_for_sig_alg(
Gilles Peskine449bd832023-01-11 14:50:10 +01009493 mbedtls_ssl_context *ssl,
9494 unsigned int sig_alg)
Jerry Yud9d91da2022-02-17 14:57:06 +08009495{
Gabor Mezei078e8032022-04-27 21:17:56 +02009496 unsigned int i;
Gabor Mezeia3d016c2022-05-10 12:44:09 +02009497 uint16_t *received_sig_algs = ssl->handshake->received_sig_algs;
Gabor Mezei078e8032022-04-27 21:17:56 +02009498
Gilles Peskine449bd832023-01-11 14:50:10 +01009499 if (sig_alg == MBEDTLS_SSL_SIG_ANON) {
9500 return MBEDTLS_SSL_HASH_NONE;
9501 }
Gabor Mezei078e8032022-04-27 21:17:56 +02009502
Gilles Peskine449bd832023-01-11 14:50:10 +01009503 for (i = 0; received_sig_algs[i] != MBEDTLS_TLS_SIG_NONE; i++) {
Neil Armstrong9f1176a2022-06-24 18:19:19 +02009504 unsigned int hash_alg_received =
Gilles Peskine449bd832023-01-11 14:50:10 +01009505 MBEDTLS_SSL_TLS12_HASH_ALG_FROM_SIG_AND_HASH_ALG(
9506 received_sig_algs[i]);
Neil Armstrong9f1176a2022-06-24 18:19:19 +02009507 unsigned int sig_alg_received =
Gilles Peskine449bd832023-01-11 14:50:10 +01009508 MBEDTLS_SSL_TLS12_SIG_ALG_FROM_SIG_AND_HASH_ALG(
9509 received_sig_algs[i]);
Neil Armstrong9f1176a2022-06-24 18:19:19 +02009510
Manuel Pégourié-Gonnard47bb3802023-06-05 12:40:32 +02009511 mbedtls_md_type_t md_alg =
9512 mbedtls_ssl_md_alg_from_hash((unsigned char) hash_alg_received);
9513 if (md_alg == MBEDTLS_MD_NONE) {
9514 continue;
9515 }
9516
Gilles Peskine449bd832023-01-11 14:50:10 +01009517 if (sig_alg == sig_alg_received) {
Neil Armstrong9f1176a2022-06-24 18:19:19 +02009518#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01009519 if (ssl->handshake->key_cert && ssl->handshake->key_cert->key) {
Neil Armstrong96eceb82022-06-30 18:05:05 +02009520 psa_algorithm_t psa_hash_alg =
Manuel Pégourié-Gonnard47bb3802023-06-05 12:40:32 +02009521 mbedtls_md_psa_alg_from_type(md_alg);
Neil Armstrong9f1176a2022-06-24 18:19:19 +02009522
Gilles Peskine449bd832023-01-11 14:50:10 +01009523 if (sig_alg_received == MBEDTLS_SSL_SIG_ECDSA &&
9524 !mbedtls_pk_can_do_ext(ssl->handshake->key_cert->key,
9525 PSA_ALG_ECDSA(psa_hash_alg),
9526 PSA_KEY_USAGE_SIGN_HASH)) {
Neil Armstrong9f1176a2022-06-24 18:19:19 +02009527 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01009528 }
Neil Armstrong9f1176a2022-06-24 18:19:19 +02009529
Gilles Peskine449bd832023-01-11 14:50:10 +01009530 if (sig_alg_received == MBEDTLS_SSL_SIG_RSA &&
9531 !mbedtls_pk_can_do_ext(ssl->handshake->key_cert->key,
9532 PSA_ALG_RSA_PKCS1V15_SIGN(
9533 psa_hash_alg),
9534 PSA_KEY_USAGE_SIGN_HASH)) {
Neil Armstrong9f1176a2022-06-24 18:19:19 +02009535 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01009536 }
Neil Armstrong9f1176a2022-06-24 18:19:19 +02009537 }
Neil Armstrong9f1176a2022-06-24 18:19:19 +02009538#endif /* MBEDTLS_USE_PSA_CRYPTO */
Neil Armstrong96eceb82022-06-30 18:05:05 +02009539
Gilles Peskine449bd832023-01-11 14:50:10 +01009540 return hash_alg_received;
Neil Armstrong9f1176a2022-06-24 18:19:19 +02009541 }
Jerry Yud9d91da2022-02-17 14:57:06 +08009542 }
Jerry Yud9d91da2022-02-17 14:57:06 +08009543
Gilles Peskine449bd832023-01-11 14:50:10 +01009544 return MBEDTLS_SSL_HASH_NONE;
Jerry Yud9d91da2022-02-17 14:57:06 +08009545}
9546
9547#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
9548
Jerry Yudc7bd172022-02-17 13:44:15 +08009549#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
9550
XiaokangQian75d40ef2022-04-20 11:05:24 +00009551int mbedtls_ssl_validate_ciphersuite(
9552 const mbedtls_ssl_context *ssl,
9553 const mbedtls_ssl_ciphersuite_t *suite_info,
9554 mbedtls_ssl_protocol_version min_tls_version,
Gilles Peskine449bd832023-01-11 14:50:10 +01009555 mbedtls_ssl_protocol_version max_tls_version)
XiaokangQian75d40ef2022-04-20 11:05:24 +00009556{
9557 (void) ssl;
9558
Gilles Peskine449bd832023-01-11 14:50:10 +01009559 if (suite_info == NULL) {
9560 return -1;
9561 }
XiaokangQian75d40ef2022-04-20 11:05:24 +00009562
Gilles Peskine449bd832023-01-11 14:50:10 +01009563 if ((suite_info->min_tls_version > max_tls_version) ||
9564 (suite_info->max_tls_version < min_tls_version)) {
9565 return -1;
XiaokangQian75d40ef2022-04-20 11:05:24 +00009566 }
9567
XiaokangQian060d8672022-04-21 09:24:56 +00009568#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_CLI_C)
XiaokangQian75d40ef2022-04-20 11:05:24 +00009569#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Neil Armstrongca7d5062022-05-31 14:43:23 +02009570#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01009571 if (suite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_ECJPAKE &&
9572 ssl->handshake->psa_pake_ctx_is_ok != 1)
Neil Armstrongca7d5062022-05-31 14:43:23 +02009573#else
Gilles Peskine449bd832023-01-11 14:50:10 +01009574 if (suite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_ECJPAKE &&
9575 mbedtls_ecjpake_check(&ssl->handshake->ecjpake_ctx) != 0)
Neil Armstrongca7d5062022-05-31 14:43:23 +02009576#endif /* MBEDTLS_USE_PSA_CRYPTO */
XiaokangQian75d40ef2022-04-20 11:05:24 +00009577 {
Gilles Peskine449bd832023-01-11 14:50:10 +01009578 return -1;
XiaokangQian75d40ef2022-04-20 11:05:24 +00009579 }
9580#endif
9581
9582 /* Don't suggest PSK-based ciphersuite if no PSK is available. */
9583#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01009584 if (mbedtls_ssl_ciphersuite_uses_psk(suite_info) &&
9585 mbedtls_ssl_conf_has_static_psk(ssl->conf) == 0) {
9586 return -1;
XiaokangQian75d40ef2022-04-20 11:05:24 +00009587 }
9588#endif /* MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
9589#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
9590
Gilles Peskine449bd832023-01-11 14:50:10 +01009591 return 0;
XiaokangQian75d40ef2022-04-20 11:05:24 +00009592}
9593
Ronald Crone68ab4f2022-10-05 12:46:29 +02009594#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
XiaokangQianeaf36512022-04-24 09:07:44 +00009595/*
9596 * Function for writing a signature algorithm extension.
9597 *
9598 * The `extension_data` field of signature algorithm contains a `SignatureSchemeList`
9599 * value (TLS 1.3 RFC8446):
9600 * enum {
9601 * ....
9602 * ecdsa_secp256r1_sha256( 0x0403 ),
9603 * ecdsa_secp384r1_sha384( 0x0503 ),
9604 * ecdsa_secp521r1_sha512( 0x0603 ),
9605 * ....
9606 * } SignatureScheme;
9607 *
9608 * struct {
9609 * SignatureScheme supported_signature_algorithms<2..2^16-2>;
9610 * } SignatureSchemeList;
9611 *
9612 * The `extension_data` field of signature algorithm contains a `SignatureAndHashAlgorithm`
9613 * value (TLS 1.2 RFC5246):
9614 * enum {
9615 * none(0), md5(1), sha1(2), sha224(3), sha256(4), sha384(5),
9616 * sha512(6), (255)
9617 * } HashAlgorithm;
9618 *
9619 * enum { anonymous(0), rsa(1), dsa(2), ecdsa(3), (255) }
9620 * SignatureAlgorithm;
9621 *
9622 * struct {
9623 * HashAlgorithm hash;
9624 * SignatureAlgorithm signature;
9625 * } SignatureAndHashAlgorithm;
9626 *
9627 * SignatureAndHashAlgorithm
9628 * supported_signature_algorithms<2..2^16-2>;
9629 *
9630 * The TLS 1.3 signature algorithm extension was defined to be a compatible
9631 * generalization of the TLS 1.2 signature algorithm extension.
9632 * `SignatureAndHashAlgorithm` field of TLS 1.2 can be represented by
9633 * `SignatureScheme` field of TLS 1.3
9634 *
9635 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009636int mbedtls_ssl_write_sig_alg_ext(mbedtls_ssl_context *ssl, unsigned char *buf,
9637 const unsigned char *end, size_t *out_len)
XiaokangQianeaf36512022-04-24 09:07:44 +00009638{
9639 unsigned char *p = buf;
9640 unsigned char *supported_sig_alg; /* Start of supported_signature_algorithms */
9641 size_t supported_sig_alg_len = 0; /* Length of supported_signature_algorithms */
9642
9643 *out_len = 0;
9644
Gilles Peskine449bd832023-01-11 14:50:10 +01009645 MBEDTLS_SSL_DEBUG_MSG(3, ("adding signature_algorithms extension"));
XiaokangQianeaf36512022-04-24 09:07:44 +00009646
9647 /* Check if we have space for header and length field:
9648 * - extension_type (2 bytes)
9649 * - extension_data_length (2 bytes)
9650 * - supported_signature_algorithms_length (2 bytes)
9651 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009652 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 6);
XiaokangQianeaf36512022-04-24 09:07:44 +00009653 p += 6;
9654
9655 /*
9656 * Write supported_signature_algorithms
9657 */
9658 supported_sig_alg = p;
Gilles Peskine449bd832023-01-11 14:50:10 +01009659 const uint16_t *sig_alg = mbedtls_ssl_get_sig_algs(ssl);
9660 if (sig_alg == NULL) {
9661 return MBEDTLS_ERR_SSL_BAD_CONFIG;
9662 }
XiaokangQianeaf36512022-04-24 09:07:44 +00009663
Gilles Peskine449bd832023-01-11 14:50:10 +01009664 for (; *sig_alg != MBEDTLS_TLS1_3_SIG_NONE; sig_alg++) {
9665 MBEDTLS_SSL_DEBUG_MSG(3, ("got signature scheme [%x] %s",
9666 *sig_alg,
9667 mbedtls_ssl_sig_alg_to_str(*sig_alg)));
9668 if (!mbedtls_ssl_sig_alg_is_supported(ssl, *sig_alg)) {
XiaokangQianeaf36512022-04-24 09:07:44 +00009669 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01009670 }
9671 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 2);
9672 MBEDTLS_PUT_UINT16_BE(*sig_alg, p, 0);
XiaokangQianeaf36512022-04-24 09:07:44 +00009673 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01009674 MBEDTLS_SSL_DEBUG_MSG(3, ("sent signature scheme [%x] %s",
9675 *sig_alg,
9676 mbedtls_ssl_sig_alg_to_str(*sig_alg)));
XiaokangQianeaf36512022-04-24 09:07:44 +00009677 }
9678
9679 /* Length of supported_signature_algorithms */
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00009680 supported_sig_alg_len = (size_t) (p - supported_sig_alg);
Gilles Peskine449bd832023-01-11 14:50:10 +01009681 if (supported_sig_alg_len == 0) {
9682 MBEDTLS_SSL_DEBUG_MSG(1, ("No signature algorithms defined."));
9683 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
XiaokangQianeaf36512022-04-24 09:07:44 +00009684 }
9685
Gilles Peskine449bd832023-01-11 14:50:10 +01009686 MBEDTLS_PUT_UINT16_BE(MBEDTLS_TLS_EXT_SIG_ALG, buf, 0);
9687 MBEDTLS_PUT_UINT16_BE(supported_sig_alg_len + 2, buf, 2);
9688 MBEDTLS_PUT_UINT16_BE(supported_sig_alg_len, buf, 4);
XiaokangQianeaf36512022-04-24 09:07:44 +00009689
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00009690 *out_len = (size_t) (p - buf);
XiaokangQianeaf36512022-04-24 09:07:44 +00009691
9692#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01009693 mbedtls_ssl_tls13_set_hs_sent_ext_mask(ssl, MBEDTLS_TLS_EXT_SIG_ALG);
XiaokangQianeaf36512022-04-24 09:07:44 +00009694#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yu0c354a22022-08-29 15:25:36 +08009695
Gilles Peskine449bd832023-01-11 14:50:10 +01009696 return 0;
XiaokangQianeaf36512022-04-24 09:07:44 +00009697}
Ronald Crone68ab4f2022-10-05 12:46:29 +02009698#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
XiaokangQianeaf36512022-04-24 09:07:44 +00009699
XiaokangQian40a35232022-05-07 09:02:40 +00009700#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
XiaokangQian9b2b7712022-05-17 02:57:00 +00009701/*
9702 * mbedtls_ssl_parse_server_name_ext
9703 *
9704 * Structure of server_name extension:
9705 *
9706 * enum {
9707 * host_name(0), (255)
9708 * } NameType;
9709 * opaque HostName<1..2^16-1>;
9710 *
9711 * struct {
9712 * NameType name_type;
9713 * select (name_type) {
9714 * case host_name: HostName;
9715 * } name;
9716 * } ServerName;
9717 * struct {
9718 * ServerName server_name_list<1..2^16-1>
9719 * } ServerNameList;
9720 */
Ronald Cronce7d76e2022-07-08 18:56:49 +02009721MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01009722int mbedtls_ssl_parse_server_name_ext(mbedtls_ssl_context *ssl,
9723 const unsigned char *buf,
9724 const unsigned char *end)
XiaokangQian40a35232022-05-07 09:02:40 +00009725{
9726 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
9727 const unsigned char *p = buf;
XiaokangQian9b2b7712022-05-17 02:57:00 +00009728 size_t server_name_list_len, hostname_len;
9729 const unsigned char *server_name_list_end;
XiaokangQian40a35232022-05-07 09:02:40 +00009730
Gilles Peskine449bd832023-01-11 14:50:10 +01009731 MBEDTLS_SSL_DEBUG_MSG(3, ("parse ServerName extension"));
XiaokangQian40a35232022-05-07 09:02:40 +00009732
Gilles Peskine449bd832023-01-11 14:50:10 +01009733 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
9734 server_name_list_len = MBEDTLS_GET_UINT16_BE(p, 0);
XiaokangQian40a35232022-05-07 09:02:40 +00009735 p += 2;
9736
Gilles Peskine449bd832023-01-11 14:50:10 +01009737 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, server_name_list_len);
XiaokangQian9b2b7712022-05-17 02:57:00 +00009738 server_name_list_end = p + server_name_list_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01009739 while (p < server_name_list_end) {
9740 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, server_name_list_end, 3);
9741 hostname_len = MBEDTLS_GET_UINT16_BE(p, 1);
9742 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, server_name_list_end,
9743 hostname_len + 3);
XiaokangQian40a35232022-05-07 09:02:40 +00009744
Gilles Peskine449bd832023-01-11 14:50:10 +01009745 if (p[0] == MBEDTLS_TLS_EXT_SERVERNAME_HOSTNAME) {
XiaokangQian75fe8c72022-06-15 09:42:45 +00009746 /* sni_name is intended to be used only during the parsing of the
9747 * ClientHello message (it is reset to NULL before the end of
9748 * the message parsing). Thus it is ok to just point to the
9749 * reception buffer and not make a copy of it.
9750 */
XiaokangQianf2a94202022-05-20 06:44:24 +00009751 ssl->handshake->sni_name = p + 3;
9752 ssl->handshake->sni_name_len = hostname_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01009753 if (ssl->conf->f_sni == NULL) {
9754 return 0;
XiaokangQian40a35232022-05-07 09:02:40 +00009755 }
Gilles Peskine449bd832023-01-11 14:50:10 +01009756 ret = ssl->conf->f_sni(ssl->conf->p_sni,
9757 ssl, p + 3, hostname_len);
9758 if (ret != 0) {
9759 MBEDTLS_SSL_DEBUG_RET(1, "ssl_sni_wrapper", ret);
9760 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_UNRECOGNIZED_NAME,
9761 MBEDTLS_ERR_SSL_UNRECOGNIZED_NAME);
9762 return MBEDTLS_ERR_SSL_UNRECOGNIZED_NAME;
9763 }
9764 return 0;
XiaokangQian40a35232022-05-07 09:02:40 +00009765 }
9766
9767 p += hostname_len + 3;
9768 }
9769
Gilles Peskine449bd832023-01-11 14:50:10 +01009770 return 0;
XiaokangQian40a35232022-05-07 09:02:40 +00009771}
9772#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
9773
XiaokangQianacb39922022-06-17 10:18:48 +00009774#if defined(MBEDTLS_SSL_ALPN)
Ronald Cronce7d76e2022-07-08 18:56:49 +02009775MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01009776int mbedtls_ssl_parse_alpn_ext(mbedtls_ssl_context *ssl,
9777 const unsigned char *buf,
9778 const unsigned char *end)
XiaokangQianacb39922022-06-17 10:18:48 +00009779{
9780 const unsigned char *p = buf;
XiaokangQianc7403452022-06-23 03:24:12 +00009781 size_t protocol_name_list_len;
XiaokangQian95d5f542022-06-24 02:29:26 +00009782 const unsigned char *protocol_name_list;
9783 const unsigned char *protocol_name_list_end;
XiaokangQianc7403452022-06-23 03:24:12 +00009784 size_t protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00009785
9786 /* If ALPN not configured, just ignore the extension */
Gilles Peskine449bd832023-01-11 14:50:10 +01009787 if (ssl->conf->alpn_list == NULL) {
9788 return 0;
9789 }
XiaokangQianacb39922022-06-17 10:18:48 +00009790
9791 /*
XiaokangQianc7403452022-06-23 03:24:12 +00009792 * RFC7301, section 3.1
9793 * opaque ProtocolName<1..2^8-1>;
XiaokangQianacb39922022-06-17 10:18:48 +00009794 *
XiaokangQianc7403452022-06-23 03:24:12 +00009795 * struct {
9796 * ProtocolName protocol_name_list<2..2^16-1>
9797 * } ProtocolNameList;
XiaokangQianacb39922022-06-17 10:18:48 +00009798 */
9799
XiaokangQianc7403452022-06-23 03:24:12 +00009800 /*
XiaokangQian0b776e22022-06-24 09:04:59 +00009801 * protocol_name_list_len 2 bytes
9802 * protocol_name_len 1 bytes
9803 * protocol_name >=1 byte
XiaokangQianc7403452022-06-23 03:24:12 +00009804 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009805 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 4);
XiaokangQianacb39922022-06-17 10:18:48 +00009806
Gilles Peskine449bd832023-01-11 14:50:10 +01009807 protocol_name_list_len = MBEDTLS_GET_UINT16_BE(p, 0);
XiaokangQianacb39922022-06-17 10:18:48 +00009808 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01009809 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, protocol_name_list_len);
XiaokangQian95d5f542022-06-24 02:29:26 +00009810 protocol_name_list = p;
9811 protocol_name_list_end = p + protocol_name_list_len;
XiaokangQianacb39922022-06-17 10:18:48 +00009812
9813 /* Validate peer's list (lengths) */
Gilles Peskine449bd832023-01-11 14:50:10 +01009814 while (p < protocol_name_list_end) {
XiaokangQian95d5f542022-06-24 02:29:26 +00009815 protocol_name_len = *p++;
Gilles Peskine449bd832023-01-11 14:50:10 +01009816 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, protocol_name_list_end,
9817 protocol_name_len);
9818 if (protocol_name_len == 0) {
XiaokangQian95d5f542022-06-24 02:29:26 +00009819 MBEDTLS_SSL_PEND_FATAL_ALERT(
9820 MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
Gilles Peskine449bd832023-01-11 14:50:10 +01009821 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
9822 return MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
XiaokangQian95d5f542022-06-24 02:29:26 +00009823 }
9824
9825 p += protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00009826 }
9827
9828 /* Use our order of preference */
Gilles Peskine449bd832023-01-11 14:50:10 +01009829 for (const char **alpn = ssl->conf->alpn_list; *alpn != NULL; alpn++) {
9830 size_t const alpn_len = strlen(*alpn);
XiaokangQian95d5f542022-06-24 02:29:26 +00009831 p = protocol_name_list;
Gilles Peskine449bd832023-01-11 14:50:10 +01009832 while (p < protocol_name_list_end) {
XiaokangQian95d5f542022-06-24 02:29:26 +00009833 protocol_name_len = *p++;
Gilles Peskine449bd832023-01-11 14:50:10 +01009834 if (protocol_name_len == alpn_len &&
9835 memcmp(p, *alpn, alpn_len) == 0) {
XiaokangQianacb39922022-06-17 10:18:48 +00009836 ssl->alpn_chosen = *alpn;
Gilles Peskine449bd832023-01-11 14:50:10 +01009837 return 0;
XiaokangQianacb39922022-06-17 10:18:48 +00009838 }
XiaokangQian95d5f542022-06-24 02:29:26 +00009839
9840 p += protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00009841 }
9842 }
9843
XiaokangQian95d5f542022-06-24 02:29:26 +00009844 /* If we get here, no match was found */
XiaokangQianacb39922022-06-17 10:18:48 +00009845 MBEDTLS_SSL_PEND_FATAL_ALERT(
Gilles Peskine449bd832023-01-11 14:50:10 +01009846 MBEDTLS_SSL_ALERT_MSG_NO_APPLICATION_PROTOCOL,
9847 MBEDTLS_ERR_SSL_NO_APPLICATION_PROTOCOL);
9848 return MBEDTLS_ERR_SSL_NO_APPLICATION_PROTOCOL;
XiaokangQianacb39922022-06-17 10:18:48 +00009849}
9850
Gilles Peskine449bd832023-01-11 14:50:10 +01009851int mbedtls_ssl_write_alpn_ext(mbedtls_ssl_context *ssl,
9852 unsigned char *buf,
9853 unsigned char *end,
9854 size_t *out_len)
XiaokangQianacb39922022-06-17 10:18:48 +00009855{
9856 unsigned char *p = buf;
XiaokangQian95d5f542022-06-24 02:29:26 +00009857 size_t protocol_name_len;
XiaokangQianc7403452022-06-23 03:24:12 +00009858 *out_len = 0;
XiaokangQianacb39922022-06-17 10:18:48 +00009859
Gilles Peskine449bd832023-01-11 14:50:10 +01009860 if (ssl->alpn_chosen == NULL) {
9861 return 0;
XiaokangQianacb39922022-06-17 10:18:48 +00009862 }
9863
Gilles Peskine449bd832023-01-11 14:50:10 +01009864 protocol_name_len = strlen(ssl->alpn_chosen);
9865 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 7 + protocol_name_len);
XiaokangQianacb39922022-06-17 10:18:48 +00009866
Gilles Peskine449bd832023-01-11 14:50:10 +01009867 MBEDTLS_SSL_DEBUG_MSG(3, ("server side, adding alpn extension"));
XiaokangQianacb39922022-06-17 10:18:48 +00009868 /*
9869 * 0 . 1 ext identifier
9870 * 2 . 3 ext length
9871 * 4 . 5 protocol list length
9872 * 6 . 6 protocol name length
9873 * 7 . 7+n protocol name
9874 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009875 MBEDTLS_PUT_UINT16_BE(MBEDTLS_TLS_EXT_ALPN, p, 0);
XiaokangQianacb39922022-06-17 10:18:48 +00009876
XiaokangQian95d5f542022-06-24 02:29:26 +00009877 *out_len = 7 + protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00009878
Gilles Peskine449bd832023-01-11 14:50:10 +01009879 MBEDTLS_PUT_UINT16_BE(protocol_name_len + 3, p, 2);
9880 MBEDTLS_PUT_UINT16_BE(protocol_name_len + 1, p, 4);
XiaokangQian0b776e22022-06-24 09:04:59 +00009881 /* Note: the length of the chosen protocol has been checked to be less
9882 * than 255 bytes in `mbedtls_ssl_conf_alpn_protocols`.
9883 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009884 p[6] = MBEDTLS_BYTE_0(protocol_name_len);
XiaokangQianacb39922022-06-17 10:18:48 +00009885
Gilles Peskine449bd832023-01-11 14:50:10 +01009886 memcpy(p + 7, ssl->alpn_chosen, protocol_name_len);
Jerry Yub95dd362022-11-08 21:19:34 +08009887
9888#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01009889 mbedtls_ssl_tls13_set_hs_sent_ext_mask(ssl, MBEDTLS_TLS_EXT_ALPN);
Jerry Yub95dd362022-11-08 21:19:34 +08009890#endif
9891
Gilles Peskine449bd832023-01-11 14:50:10 +01009892 return 0;
XiaokangQianacb39922022-06-17 10:18:48 +00009893}
9894#endif /* MBEDTLS_SSL_ALPN */
9895
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009896#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && \
Xiaokang Qian03409292022-10-12 02:49:52 +00009897 defined(MBEDTLS_SSL_SESSION_TICKETS) && \
Xiaokang Qianed0620c2022-10-12 06:58:13 +00009898 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION) && \
Xiaokang Qianed3afcd2022-10-12 08:31:11 +00009899 defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01009900int mbedtls_ssl_session_set_hostname(mbedtls_ssl_session *session,
9901 const char *hostname)
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009902{
9903 /* Initialize to suppress unnecessary compiler warning */
9904 size_t hostname_len = 0;
9905
9906 /* Check if new hostname is valid before
9907 * making any change to current one */
Gilles Peskine449bd832023-01-11 14:50:10 +01009908 if (hostname != NULL) {
9909 hostname_len = strlen(hostname);
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009910
Gilles Peskine449bd832023-01-11 14:50:10 +01009911 if (hostname_len > MBEDTLS_SSL_MAX_HOST_NAME_LEN) {
9912 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9913 }
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009914 }
9915
9916 /* Now it's clear that we will overwrite the old hostname,
9917 * so we can free it safely */
Gilles Peskine449bd832023-01-11 14:50:10 +01009918 if (session->hostname != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01009919 mbedtls_zeroize_and_free(session->hostname,
Gilles Peskine449bd832023-01-11 14:50:10 +01009920 strlen(session->hostname));
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009921 }
9922
9923 /* Passing NULL as hostname shall clear the old one */
Gilles Peskine449bd832023-01-11 14:50:10 +01009924 if (hostname == NULL) {
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009925 session->hostname = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01009926 } else {
9927 session->hostname = mbedtls_calloc(1, hostname_len + 1);
9928 if (session->hostname == NULL) {
9929 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
9930 }
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009931
Gilles Peskine449bd832023-01-11 14:50:10 +01009932 memcpy(session->hostname, hostname, hostname_len);
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009933 }
9934
Gilles Peskine449bd832023-01-11 14:50:10 +01009935 return 0;
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009936}
Xiaokang Qian03409292022-10-12 02:49:52 +00009937#endif /* MBEDTLS_SSL_PROTO_TLS1_3 &&
9938 MBEDTLS_SSL_SESSION_TICKETS &&
Xiaokang Qianed0620c2022-10-12 06:58:13 +00009939 MBEDTLS_SSL_SERVER_NAME_INDICATION &&
Xiaokang Qianed3afcd2022-10-12 08:31:11 +00009940 MBEDTLS_SSL_CLI_C */
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009941
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00009942#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_EARLY_DATA) && \
9943 defined(MBEDTLS_SSL_ALPN)
Waleed Elmelegy7dfba342024-03-12 16:22:39 +00009944int mbedtls_ssl_session_set_ticket_alpn(mbedtls_ssl_session *session,
9945 const char *alpn)
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00009946{
9947 size_t alpn_len = 0;
9948
9949 if (alpn != NULL) {
9950 alpn_len = strlen(alpn);
9951
9952 if (alpn_len > MBEDTLS_SSL_MAX_ALPN_NAME_LEN) {
9953 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9954 }
9955 }
9956
9957 if (session->ticket_alpn != NULL) {
9958 mbedtls_zeroize_and_free(session->ticket_alpn,
9959 strlen(session->ticket_alpn));
Waleed Elmelegy7dfba342024-03-12 16:22:39 +00009960 session->ticket_alpn = NULL;
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00009961 }
9962
Waleed Elmelegy7dfba342024-03-12 16:22:39 +00009963 if (alpn != NULL) {
9964 session->ticket_alpn = mbedtls_calloc(alpn_len + 1, 1);
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00009965 if (session->ticket_alpn == NULL) {
9966 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
9967 }
Waleed Elmelegy7dfba342024-03-12 16:22:39 +00009968 memcpy(session->ticket_alpn, alpn, alpn_len);
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00009969 }
9970
9971 return 0;
9972}
9973#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_EARLY_DATA && MBEDTLS_SSL_ALPN */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02009974#endif /* MBEDTLS_SSL_TLS_C */