blob: f39aba4b895cadae7bb635fdb8a6bcaebaec3b4a [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,
135 unsigned char own_cid[MBEDTLS_SSL_CID_OUT_LEN_MAX],
136 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;
1569
Gilles Peskine449bd832023-01-11 14:50:10 +01001570 mbedtls_ssl_session_reset_msg_layer(ssl, partial);
Hanno Beckerb0302c42021-08-03 09:39:42 +01001571
1572 /* Reset renegotiation state */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001573#if defined(MBEDTLS_SSL_RENEGOTIATION)
1574 ssl->renego_status = MBEDTLS_SSL_INITIAL_HANDSHAKE;
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001575 ssl->renego_records_seen = 0;
Paul Bakker48916f92012-09-16 19:57:18 +00001576
1577 ssl->verify_data_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01001578 memset(ssl->own_verify_data, 0, MBEDTLS_SSL_VERIFY_DATA_MAX_LEN);
1579 memset(ssl->peer_verify_data, 0, MBEDTLS_SSL_VERIFY_DATA_MAX_LEN);
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001580#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001581 ssl->secure_renegotiation = MBEDTLS_SSL_LEGACY_RENEGOTIATION;
Paul Bakker48916f92012-09-16 19:57:18 +00001582
Hanno Beckerb0302c42021-08-03 09:39:42 +01001583 ssl->session_in = NULL;
Hanno Becker78640902018-08-13 16:35:15 +01001584 ssl->session_out = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01001585 if (ssl->session) {
1586 mbedtls_ssl_session_free(ssl->session);
1587 mbedtls_free(ssl->session);
Paul Bakkerc0463502013-02-14 11:19:38 +01001588 ssl->session = NULL;
1589 }
1590
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001591#if defined(MBEDTLS_SSL_ALPN)
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001592 ssl->alpn_chosen = NULL;
1593#endif
1594
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001595#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
David Horstmann3b2276a2022-10-06 14:49:08 +01001596 int free_cli_id = 1;
Hanno Becker4ccbf062018-08-10 11:20:38 +01001597#if defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE)
Gilles Peskine449bd832023-01-11 14:50:10 +01001598 free_cli_id = (partial == 0);
Hanno Becker4ccbf062018-08-10 11:20:38 +01001599#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001600 if (free_cli_id) {
1601 mbedtls_free(ssl->cli_id);
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001602 ssl->cli_id = NULL;
1603 ssl->cli_id_len = 0;
1604 }
Manuel Pégourié-Gonnard43c02182014-07-22 17:32:01 +02001605#endif
1606
Gilles Peskine449bd832023-01-11 14:50:10 +01001607 if ((ret = ssl_handshake_init(ssl)) != 0) {
1608 return ret;
1609 }
Paul Bakker2770fbd2012-07-03 13:30:23 +00001610
Gilles Peskine449bd832023-01-11 14:50:10 +01001611 return 0;
Paul Bakker7eb013f2011-10-06 12:37:39 +00001612}
1613
Manuel Pégourié-Gonnard779e4292013-08-03 13:50:48 +02001614/*
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001615 * Reset an initialized and used SSL context for re-use while retaining
1616 * all application-set variables, function pointers and data.
1617 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001618int mbedtls_ssl_session_reset(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001619{
Gilles Peskine449bd832023-01-11 14:50:10 +01001620 return mbedtls_ssl_session_reset_int(ssl, 0);
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001621}
1622
1623/*
Paul Bakker5121ce52009-01-03 21:22:43 +00001624 * SSL set accessors
1625 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001626void mbedtls_ssl_conf_endpoint(mbedtls_ssl_config *conf, int endpoint)
Paul Bakker5121ce52009-01-03 21:22:43 +00001627{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001628 conf->endpoint = endpoint;
Paul Bakker5121ce52009-01-03 21:22:43 +00001629}
1630
Gilles Peskine449bd832023-01-11 14:50:10 +01001631void mbedtls_ssl_conf_transport(mbedtls_ssl_config *conf, int transport)
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001632{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001633 conf->transport = transport;
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001634}
1635
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001636#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Gilles Peskine449bd832023-01-11 14:50:10 +01001637void mbedtls_ssl_conf_dtls_anti_replay(mbedtls_ssl_config *conf, char mode)
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02001638{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001639 conf->anti_replay = mode;
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02001640}
1641#endif
1642
Gilles Peskine449bd832023-01-11 14:50:10 +01001643void mbedtls_ssl_conf_dtls_badmac_limit(mbedtls_ssl_config *conf, unsigned limit)
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001644{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001645 conf->badmac_limit = limit;
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001646}
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001647
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001648#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker04da1892018-08-14 13:22:10 +01001649
Gilles Peskine449bd832023-01-11 14:50:10 +01001650void mbedtls_ssl_set_datagram_packing(mbedtls_ssl_context *ssl,
1651 unsigned allow_packing)
Hanno Becker04da1892018-08-14 13:22:10 +01001652{
1653 ssl->disable_datagram_packing = !allow_packing;
1654}
1655
Gilles Peskine449bd832023-01-11 14:50:10 +01001656void mbedtls_ssl_conf_handshake_timeout(mbedtls_ssl_config *conf,
1657 uint32_t min, uint32_t max)
Manuel Pégourié-Gonnard905dd242014-10-01 12:03:55 +02001658{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001659 conf->hs_timeout_min = min;
1660 conf->hs_timeout_max = max;
Manuel Pégourié-Gonnard905dd242014-10-01 12:03:55 +02001661}
1662#endif
1663
Gilles Peskine449bd832023-01-11 14:50:10 +01001664void mbedtls_ssl_conf_authmode(mbedtls_ssl_config *conf, int authmode)
Paul Bakker5121ce52009-01-03 21:22:43 +00001665{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001666 conf->authmode = authmode;
Paul Bakker5121ce52009-01-03 21:22:43 +00001667}
1668
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001669#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001670void mbedtls_ssl_conf_verify(mbedtls_ssl_config *conf,
1671 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *),
1672 void *p_vrfy)
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001673{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001674 conf->f_vrfy = f_vrfy;
1675 conf->p_vrfy = p_vrfy;
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001676}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001677#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001678
Gilles Peskine449bd832023-01-11 14:50:10 +01001679void mbedtls_ssl_conf_rng(mbedtls_ssl_config *conf,
1680 int (*f_rng)(void *, unsigned char *, size_t),
1681 void *p_rng)
Paul Bakker5121ce52009-01-03 21:22:43 +00001682{
Manuel Pégourié-Gonnard750e4d72015-05-07 12:35:38 +01001683 conf->f_rng = f_rng;
1684 conf->p_rng = p_rng;
Paul Bakker5121ce52009-01-03 21:22:43 +00001685}
1686
Gilles Peskine449bd832023-01-11 14:50:10 +01001687void mbedtls_ssl_conf_dbg(mbedtls_ssl_config *conf,
1688 void (*f_dbg)(void *, int, const char *, int, const char *),
1689 void *p_dbg)
Paul Bakker5121ce52009-01-03 21:22:43 +00001690{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001691 conf->f_dbg = f_dbg;
1692 conf->p_dbg = p_dbg;
Paul Bakker5121ce52009-01-03 21:22:43 +00001693}
1694
Gilles Peskine449bd832023-01-11 14:50:10 +01001695void mbedtls_ssl_set_bio(mbedtls_ssl_context *ssl,
1696 void *p_bio,
1697 mbedtls_ssl_send_t *f_send,
1698 mbedtls_ssl_recv_t *f_recv,
1699 mbedtls_ssl_recv_timeout_t *f_recv_timeout)
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02001700{
1701 ssl->p_bio = p_bio;
1702 ssl->f_send = f_send;
1703 ssl->f_recv = f_recv;
1704 ssl->f_recv_timeout = f_recv_timeout;
Manuel Pégourié-Gonnard97fd52c2015-05-06 15:38:52 +01001705}
1706
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02001707#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01001708void mbedtls_ssl_set_mtu(mbedtls_ssl_context *ssl, uint16_t mtu)
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02001709{
1710 ssl->mtu = mtu;
1711}
1712#endif
1713
Gilles Peskine449bd832023-01-11 14:50:10 +01001714void mbedtls_ssl_conf_read_timeout(mbedtls_ssl_config *conf, uint32_t timeout)
Manuel Pégourié-Gonnard97fd52c2015-05-06 15:38:52 +01001715{
1716 conf->read_timeout = timeout;
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02001717}
1718
Gilles Peskine449bd832023-01-11 14:50:10 +01001719void mbedtls_ssl_set_timer_cb(mbedtls_ssl_context *ssl,
1720 void *p_timer,
1721 mbedtls_ssl_set_timer_t *f_set_timer,
1722 mbedtls_ssl_get_timer_t *f_get_timer)
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02001723{
1724 ssl->p_timer = p_timer;
1725 ssl->f_set_timer = f_set_timer;
1726 ssl->f_get_timer = f_get_timer;
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001727
1728 /* Make sure we start with no timer running */
Gilles Peskine449bd832023-01-11 14:50:10 +01001729 mbedtls_ssl_set_timer(ssl, 0);
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02001730}
1731
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001732#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001733void mbedtls_ssl_conf_session_cache(mbedtls_ssl_config *conf,
1734 void *p_cache,
1735 mbedtls_ssl_cache_get_t *f_get_cache,
1736 mbedtls_ssl_cache_set_t *f_set_cache)
Paul Bakker5121ce52009-01-03 21:22:43 +00001737{
Manuel Pégourié-Gonnard5cb33082015-05-06 18:06:26 +01001738 conf->p_cache = p_cache;
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001739 conf->f_get_cache = f_get_cache;
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001740 conf->f_set_cache = f_set_cache;
Paul Bakker5121ce52009-01-03 21:22:43 +00001741}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001742#endif /* MBEDTLS_SSL_SRV_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00001743
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001744#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001745int mbedtls_ssl_set_session(mbedtls_ssl_context *ssl, const mbedtls_ssl_session *session)
Paul Bakker5121ce52009-01-03 21:22:43 +00001746{
Janos Follath865b3eb2019-12-16 11:46:15 +00001747 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001748
Gilles Peskine449bd832023-01-11 14:50:10 +01001749 if (ssl == NULL ||
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001750 session == NULL ||
1751 ssl->session_negotiate == NULL ||
Gilles Peskine449bd832023-01-11 14:50:10 +01001752 ssl->conf->endpoint != MBEDTLS_SSL_IS_CLIENT) {
1753 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001754 }
1755
Gilles Peskine449bd832023-01-11 14:50:10 +01001756 if (ssl->handshake->resume == 1) {
1757 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
1758 }
Hanno Beckere810bbc2021-05-14 16:01:05 +01001759
Jerry Yu21092062022-10-10 21:21:31 +08001760#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01001761 if (session->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Ronald Cron233fcaa2024-04-04 14:05:21 +02001762#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Jerry Yu21092062022-10-10 21:21:31 +08001763 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
Gilles Peskine449bd832023-01-11 14:50:10 +01001764 mbedtls_ssl_ciphersuite_from_id(session->ciphersuite);
Jerry Yu21092062022-10-10 21:21:31 +08001765
Gilles Peskine449bd832023-01-11 14:50:10 +01001766 if (mbedtls_ssl_validate_ciphersuite(
Jerry Yu21092062022-10-10 21:21:31 +08001767 ssl, ciphersuite_info, MBEDTLS_SSL_VERSION_TLS1_3,
Gilles Peskine449bd832023-01-11 14:50:10 +01001768 MBEDTLS_SSL_VERSION_TLS1_3) != 0) {
1769 MBEDTLS_SSL_DEBUG_MSG(4, ("%d is not a valid TLS 1.3 ciphersuite.",
1770 session->ciphersuite));
1771 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jerry Yu21092062022-10-10 21:21:31 +08001772 }
Ronald Cron233fcaa2024-04-04 14:05:21 +02001773#else
1774 /*
1775 * If session tickets are not enabled, it is not possible to resume a
1776 * TLS 1.3 session, thus do not make any change to the SSL context in
1777 * the first place.
1778 */
1779 return 0;
1780#endif
Jerry Yu40afab62022-10-08 10:42:13 +08001781 }
Jerry Yu21092062022-10-10 21:21:31 +08001782#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yu40afab62022-10-08 10:42:13 +08001783
Gilles Peskine449bd832023-01-11 14:50:10 +01001784 if ((ret = mbedtls_ssl_session_copy(ssl->session_negotiate,
1785 session)) != 0) {
1786 return ret;
1787 }
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001788
Paul Bakker0a597072012-09-25 21:55:46 +00001789 ssl->handshake->resume = 1;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001790
Gilles Peskine449bd832023-01-11 14:50:10 +01001791 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00001792}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001793#endif /* MBEDTLS_SSL_CLI_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00001794
Gilles Peskine449bd832023-01-11 14:50:10 +01001795void mbedtls_ssl_conf_ciphersuites(mbedtls_ssl_config *conf,
1796 const int *ciphersuites)
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001797{
Hanno Beckerd60b6c62021-04-29 12:04:11 +01001798 conf->ciphersuite_list = ciphersuites;
Paul Bakker5121ce52009-01-03 21:22:43 +00001799}
1800
Ronald Cron6f135e12021-12-08 16:57:54 +01001801#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01001802void mbedtls_ssl_conf_tls13_key_exchange_modes(mbedtls_ssl_config *conf,
1803 const int kex_modes)
Hanno Becker71f1ed62021-07-24 06:01:47 +01001804{
Xiaofei Bai746f9482021-11-12 08:53:56 +00001805 conf->tls13_kex_modes = kex_modes & MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_ALL;
Hanno Becker71f1ed62021-07-24 06:01:47 +01001806}
Xiaokang Qian72de95d2022-10-25 02:54:33 +00001807
1808#if defined(MBEDTLS_SSL_EARLY_DATA)
Yanray Wangd5ed36f2023-11-07 11:40:43 +08001809void mbedtls_ssl_conf_early_data(mbedtls_ssl_config *conf,
1810 int early_data_enabled)
Xiaokang Qian72de95d2022-10-25 02:54:33 +00001811{
1812 conf->early_data_enabled = early_data_enabled;
1813}
Jerry Yucc4e0072022-11-22 17:22:22 +08001814
1815#if defined(MBEDTLS_SSL_SRV_C)
Yanray Wang07517612023-11-07 11:47:36 +08001816void mbedtls_ssl_conf_max_early_data_size(
Gilles Peskine449bd832023-01-11 14:50:10 +01001817 mbedtls_ssl_config *conf, uint32_t max_early_data_size)
Jerry Yucc4e0072022-11-22 17:22:22 +08001818{
Jerry Yu39da9852022-12-06 16:58:36 +08001819 conf->max_early_data_size = max_early_data_size;
Jerry Yucc4e0072022-11-22 17:22:22 +08001820}
1821#endif /* MBEDTLS_SSL_SRV_C */
1822
Xiaokang Qian72de95d2022-10-25 02:54:33 +00001823#endif /* MBEDTLS_SSL_EARLY_DATA */
Ronald Cron6f135e12021-12-08 16:57:54 +01001824#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker71f1ed62021-07-24 06:01:47 +01001825
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001826#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001827void mbedtls_ssl_conf_cert_profile(mbedtls_ssl_config *conf,
1828 const mbedtls_x509_crt_profile *profile)
Manuel Pégourié-Gonnard6e3ee3a2015-06-17 10:58:20 +02001829{
1830 conf->cert_profile = profile;
1831}
1832
Gilles Peskine449bd832023-01-11 14:50:10 +01001833static void ssl_key_cert_free(mbedtls_ssl_key_cert *key_cert)
Glenn Strauss36872db2022-01-22 05:06:31 -05001834{
1835 mbedtls_ssl_key_cert *cur = key_cert, *next;
1836
Gilles Peskine449bd832023-01-11 14:50:10 +01001837 while (cur != NULL) {
Glenn Strauss36872db2022-01-22 05:06:31 -05001838 next = cur->next;
Gilles Peskine449bd832023-01-11 14:50:10 +01001839 mbedtls_free(cur);
Glenn Strauss36872db2022-01-22 05:06:31 -05001840 cur = next;
1841 }
1842}
1843
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001844/* Append a new keycert entry to a (possibly empty) list */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001845MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001846static int ssl_append_key_cert(mbedtls_ssl_key_cert **head,
1847 mbedtls_x509_crt *cert,
1848 mbedtls_pk_context *key)
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001849{
niisato8ee24222018-06-25 19:05:48 +09001850 mbedtls_ssl_key_cert *new_cert;
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001851
Gilles Peskine449bd832023-01-11 14:50:10 +01001852 if (cert == NULL) {
Glenn Strauss36872db2022-01-22 05:06:31 -05001853 /* Free list if cert is null */
Gilles Peskine449bd832023-01-11 14:50:10 +01001854 ssl_key_cert_free(*head);
Glenn Strauss36872db2022-01-22 05:06:31 -05001855 *head = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01001856 return 0;
Glenn Strauss36872db2022-01-22 05:06:31 -05001857 }
1858
Gilles Peskine449bd832023-01-11 14:50:10 +01001859 new_cert = mbedtls_calloc(1, sizeof(mbedtls_ssl_key_cert));
1860 if (new_cert == NULL) {
1861 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
1862 }
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001863
niisato8ee24222018-06-25 19:05:48 +09001864 new_cert->cert = cert;
1865 new_cert->key = key;
1866 new_cert->next = NULL;
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001867
Glenn Strauss36872db2022-01-22 05:06:31 -05001868 /* Update head if the list was null, else add to the end */
Gilles Peskine449bd832023-01-11 14:50:10 +01001869 if (*head == NULL) {
niisato8ee24222018-06-25 19:05:48 +09001870 *head = new_cert;
Gilles Peskine449bd832023-01-11 14:50:10 +01001871 } else {
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001872 mbedtls_ssl_key_cert *cur = *head;
Gilles Peskine449bd832023-01-11 14:50:10 +01001873 while (cur->next != NULL) {
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001874 cur = cur->next;
Gilles Peskine449bd832023-01-11 14:50:10 +01001875 }
niisato8ee24222018-06-25 19:05:48 +09001876 cur->next = new_cert;
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001877 }
1878
Gilles Peskine449bd832023-01-11 14:50:10 +01001879 return 0;
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001880}
1881
Gilles Peskine449bd832023-01-11 14:50:10 +01001882int mbedtls_ssl_conf_own_cert(mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001883 mbedtls_x509_crt *own_cert,
Gilles Peskine449bd832023-01-11 14:50:10 +01001884 mbedtls_pk_context *pk_key)
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001885{
Gilles Peskine449bd832023-01-11 14:50:10 +01001886 return ssl_append_key_cert(&conf->key_cert, own_cert, pk_key);
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001887}
1888
Gilles Peskine449bd832023-01-11 14:50:10 +01001889void mbedtls_ssl_conf_ca_chain(mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01001890 mbedtls_x509_crt *ca_chain,
Gilles Peskine449bd832023-01-11 14:50:10 +01001891 mbedtls_x509_crl *ca_crl)
Paul Bakker5121ce52009-01-03 21:22:43 +00001892{
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01001893 conf->ca_chain = ca_chain;
1894 conf->ca_crl = ca_crl;
Hanno Becker5adaad92019-03-27 16:54:37 +00001895
1896#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
1897 /* mbedtls_ssl_conf_ca_chain() and mbedtls_ssl_conf_ca_cb()
1898 * cannot be used together. */
1899 conf->f_ca_cb = NULL;
1900 conf->p_ca_cb = NULL;
1901#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
Paul Bakker5121ce52009-01-03 21:22:43 +00001902}
Hanno Becker5adaad92019-03-27 16:54:37 +00001903
1904#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
Gilles Peskine449bd832023-01-11 14:50:10 +01001905void mbedtls_ssl_conf_ca_cb(mbedtls_ssl_config *conf,
1906 mbedtls_x509_crt_ca_cb_t f_ca_cb,
1907 void *p_ca_cb)
Hanno Becker5adaad92019-03-27 16:54:37 +00001908{
1909 conf->f_ca_cb = f_ca_cb;
1910 conf->p_ca_cb = p_ca_cb;
1911
1912 /* mbedtls_ssl_conf_ca_chain() and mbedtls_ssl_conf_ca_cb()
1913 * cannot be used together. */
1914 conf->ca_chain = NULL;
1915 conf->ca_crl = NULL;
1916}
1917#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001918#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkereb2c6582012-09-27 19:15:01 +00001919
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001920#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01001921const unsigned char *mbedtls_ssl_get_hs_sni(mbedtls_ssl_context *ssl,
1922 size_t *name_len)
Glenn Strauss69894072022-01-24 12:58:00 -05001923{
1924 *name_len = ssl->handshake->sni_name_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01001925 return ssl->handshake->sni_name;
Glenn Strauss69894072022-01-24 12:58:00 -05001926}
1927
Gilles Peskine449bd832023-01-11 14:50:10 +01001928int mbedtls_ssl_set_hs_own_cert(mbedtls_ssl_context *ssl,
1929 mbedtls_x509_crt *own_cert,
1930 mbedtls_pk_context *pk_key)
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001931{
Gilles Peskine449bd832023-01-11 14:50:10 +01001932 return ssl_append_key_cert(&ssl->handshake->sni_key_cert,
1933 own_cert, pk_key);
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001934}
Manuel Pégourié-Gonnard22bfa4b2015-05-11 08:46:37 +02001935
Gilles Peskine449bd832023-01-11 14:50:10 +01001936void mbedtls_ssl_set_hs_ca_chain(mbedtls_ssl_context *ssl,
1937 mbedtls_x509_crt *ca_chain,
1938 mbedtls_x509_crl *ca_crl)
Manuel Pégourié-Gonnard22bfa4b2015-05-11 08:46:37 +02001939{
1940 ssl->handshake->sni_ca_chain = ca_chain;
1941 ssl->handshake->sni_ca_crl = ca_crl;
1942}
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +02001943
Glenn Strauss999ef702022-03-11 01:37:23 -05001944#if defined(MBEDTLS_KEY_EXCHANGE_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01001945void mbedtls_ssl_set_hs_dn_hints(mbedtls_ssl_context *ssl,
1946 const mbedtls_x509_crt *crt)
Glenn Strauss999ef702022-03-11 01:37:23 -05001947{
1948 ssl->handshake->dn_hints = crt;
1949}
1950#endif /* MBEDTLS_KEY_EXCHANGE_CERT_REQ_ALLOWED_ENABLED */
1951
Gilles Peskine449bd832023-01-11 14:50:10 +01001952void mbedtls_ssl_set_hs_authmode(mbedtls_ssl_context *ssl,
1953 int authmode)
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +02001954{
1955 ssl->handshake->sni_authmode = authmode;
1956}
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001957#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
1958
Hanno Becker8927c832019-04-03 12:52:50 +01001959#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001960void mbedtls_ssl_set_verify(mbedtls_ssl_context *ssl,
1961 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *),
1962 void *p_vrfy)
Hanno Becker8927c832019-04-03 12:52:50 +01001963{
1964 ssl->f_vrfy = f_vrfy;
1965 ssl->p_vrfy = p_vrfy;
1966}
1967#endif
1968
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02001969#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02001970
Valerio Setti016f6822022-12-09 14:17:50 +01001971#if defined(MBEDTLS_USE_PSA_CRYPTO)
Przemek Stekielfde11282023-03-13 16:06:09 +01001972static const uint8_t jpake_server_id[] = { 's', 'e', 'r', 'v', 'e', 'r' };
1973static const uint8_t jpake_client_id[] = { 'c', 'l', 'i', 'e', 'n', 't' };
1974
Valerio Setti016f6822022-12-09 14:17:50 +01001975static psa_status_t mbedtls_ssl_set_hs_ecjpake_password_common(
Gilles Peskine449bd832023-01-11 14:50:10 +01001976 mbedtls_ssl_context *ssl,
1977 mbedtls_svc_key_id_t pwd)
Valerio Setti016f6822022-12-09 14:17:50 +01001978{
1979 psa_status_t status;
Valerio Setti016f6822022-12-09 14:17:50 +01001980 psa_pake_cipher_suite_t cipher_suite = psa_pake_cipher_suite_init();
Przemek Stekielfde11282023-03-13 16:06:09 +01001981 const uint8_t *user = NULL;
Przemek Stekiel4cd20312023-03-01 11:11:28 +01001982 size_t user_len = 0;
Przemek Stekielfde11282023-03-13 16:06:09 +01001983 const uint8_t *peer = NULL;
Przemek Stekiel4cd20312023-03-01 11:11:28 +01001984 size_t peer_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01001985 psa_pake_cs_set_algorithm(&cipher_suite, PSA_ALG_JPAKE);
1986 psa_pake_cs_set_primitive(&cipher_suite,
1987 PSA_PAKE_PRIMITIVE(PSA_PAKE_PRIMITIVE_TYPE_ECC,
1988 PSA_ECC_FAMILY_SECP_R1,
1989 256));
1990 psa_pake_cs_set_hash(&cipher_suite, PSA_ALG_SHA_256);
Valerio Setti016f6822022-12-09 14:17:50 +01001991
Gilles Peskine449bd832023-01-11 14:50:10 +01001992 status = psa_pake_setup(&ssl->handshake->psa_pake_ctx, &cipher_suite);
1993 if (status != PSA_SUCCESS) {
Valerio Setti016f6822022-12-09 14:17:50 +01001994 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001995 }
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02001996
Gilles Peskine449bd832023-01-11 14:50:10 +01001997 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Przemek Stekielfde11282023-03-13 16:06:09 +01001998 user = jpake_server_id;
1999 user_len = sizeof(jpake_server_id);
2000 peer = jpake_client_id;
2001 peer_len = sizeof(jpake_client_id);
Gilles Peskine449bd832023-01-11 14:50:10 +01002002 } else {
Przemek Stekielfde11282023-03-13 16:06:09 +01002003 user = jpake_client_id;
2004 user_len = sizeof(jpake_client_id);
2005 peer = jpake_server_id;
2006 peer_len = sizeof(jpake_server_id);
Gilles Peskine449bd832023-01-11 14:50:10 +01002007 }
Neil Armstrongca7d5062022-05-31 14:43:23 +02002008
Przemek Stekiel4cd20312023-03-01 11:11:28 +01002009 status = psa_pake_set_user(&ssl->handshake->psa_pake_ctx, user, user_len);
2010 if (status != PSA_SUCCESS) {
2011 return status;
2012 }
2013
2014 status = psa_pake_set_peer(&ssl->handshake->psa_pake_ctx, peer, peer_len);
Gilles Peskine449bd832023-01-11 14:50:10 +01002015 if (status != PSA_SUCCESS) {
Valerio Setti016f6822022-12-09 14:17:50 +01002016 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01002017 }
Valerio Setti016f6822022-12-09 14:17:50 +01002018
Gilles Peskine449bd832023-01-11 14:50:10 +01002019 status = psa_pake_set_password_key(&ssl->handshake->psa_pake_ctx, pwd);
2020 if (status != PSA_SUCCESS) {
Valerio Setti016f6822022-12-09 14:17:50 +01002021 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01002022 }
Valerio Setti016f6822022-12-09 14:17:50 +01002023
2024 ssl->handshake->psa_pake_ctx_is_ok = 1;
2025
Gilles Peskine449bd832023-01-11 14:50:10 +01002026 return PSA_SUCCESS;
Valerio Setti016f6822022-12-09 14:17:50 +01002027}
2028
Gilles Peskine449bd832023-01-11 14:50:10 +01002029int mbedtls_ssl_set_hs_ecjpake_password(mbedtls_ssl_context *ssl,
2030 const unsigned char *pw,
2031 size_t pw_len)
Valerio Setti016f6822022-12-09 14:17:50 +01002032{
2033 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
2034 psa_status_t status;
2035
Gilles Peskine449bd832023-01-11 14:50:10 +01002036 if (ssl->handshake == NULL || ssl->conf == NULL) {
2037 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Neil Armstrongca7d5062022-05-31 14:43:23 +02002038 }
2039
Gilles Peskine449bd832023-01-11 14:50:10 +01002040 /* Empty password is not valid */
2041 if ((pw == NULL) || (pw_len == 0)) {
2042 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2043 }
2044
2045 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_DERIVE);
2046 psa_set_key_algorithm(&attributes, PSA_ALG_JPAKE);
2047 psa_set_key_type(&attributes, PSA_KEY_TYPE_PASSWORD);
2048
2049 status = psa_import_key(&attributes, pw, pw_len,
2050 &ssl->handshake->psa_pake_password);
2051 if (status != PSA_SUCCESS) {
2052 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
2053 }
2054
2055 status = mbedtls_ssl_set_hs_ecjpake_password_common(ssl,
2056 ssl->handshake->psa_pake_password);
2057 if (status != PSA_SUCCESS) {
2058 psa_destroy_key(ssl->handshake->psa_pake_password);
2059 psa_pake_abort(&ssl->handshake->psa_pake_ctx);
2060 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
2061 }
2062
2063 return 0;
Valerio Setti02c25b52022-11-15 14:08:42 +01002064}
Valerio Settia9a97dc2022-11-28 18:26:16 +01002065
Gilles Peskine449bd832023-01-11 14:50:10 +01002066int mbedtls_ssl_set_hs_ecjpake_password_opaque(mbedtls_ssl_context *ssl,
2067 mbedtls_svc_key_id_t pwd)
Valerio Settia9a97dc2022-11-28 18:26:16 +01002068{
Valerio Settia9a97dc2022-11-28 18:26:16 +01002069 psa_status_t status;
2070
Gilles Peskine449bd832023-01-11 14:50:10 +01002071 if (ssl->handshake == NULL || ssl->conf == NULL) {
2072 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Neil Armstrongca7d5062022-05-31 14:43:23 +02002073 }
2074
Gilles Peskine449bd832023-01-11 14:50:10 +01002075 if (mbedtls_svc_key_id_is_null(pwd)) {
2076 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2077 }
2078
2079 status = mbedtls_ssl_set_hs_ecjpake_password_common(ssl, pwd);
2080 if (status != PSA_SUCCESS) {
2081 psa_pake_abort(&ssl->handshake->psa_pake_ctx);
2082 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
2083 }
2084
2085 return 0;
Valerio Setti02c25b52022-11-15 14:08:42 +01002086}
2087#else /* MBEDTLS_USE_PSA_CRYPTO */
Gilles Peskine449bd832023-01-11 14:50:10 +01002088int mbedtls_ssl_set_hs_ecjpake_password(mbedtls_ssl_context *ssl,
2089 const unsigned char *pw,
2090 size_t pw_len)
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002091{
2092 mbedtls_ecjpake_role role;
2093
Gilles Peskine449bd832023-01-11 14:50:10 +01002094 if (ssl->handshake == NULL || ssl->conf == NULL) {
2095 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2096 }
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002097
Valerio Settic689ed82022-12-07 14:40:38 +01002098 /* Empty password is not valid */
Gilles Peskine449bd832023-01-11 14:50:10 +01002099 if ((pw == NULL) || (pw_len == 0)) {
2100 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2101 }
Valerio Settic689ed82022-12-07 14:40:38 +01002102
Gilles Peskine449bd832023-01-11 14:50:10 +01002103 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002104 role = MBEDTLS_ECJPAKE_SERVER;
Gilles Peskine449bd832023-01-11 14:50:10 +01002105 } else {
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002106 role = MBEDTLS_ECJPAKE_CLIENT;
Gilles Peskine449bd832023-01-11 14:50:10 +01002107 }
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002108
Gilles Peskine449bd832023-01-11 14:50:10 +01002109 return mbedtls_ecjpake_setup(&ssl->handshake->ecjpake_ctx,
2110 role,
2111 MBEDTLS_MD_SHA256,
2112 MBEDTLS_ECP_DP_SECP256R1,
2113 pw, pw_len);
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002114}
Valerio Setti02c25b52022-11-15 14:08:42 +01002115#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02002116#endif /* MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED */
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002117
Ronald Cron73fe8df2022-10-05 14:31:43 +02002118#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01002119int mbedtls_ssl_conf_has_static_psk(mbedtls_ssl_config const *conf)
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002120{
Gilles Peskine449bd832023-01-11 14:50:10 +01002121 if (conf->psk_identity == NULL ||
2122 conf->psk_identity_len == 0) {
2123 return 0;
Ronald Crond29e13e2022-10-19 10:33:48 +02002124 }
2125
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002126#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01002127 if (!mbedtls_svc_key_id_is_null(conf->psk_opaque)) {
2128 return 1;
2129 }
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002130#endif /* MBEDTLS_USE_PSA_CRYPTO */
Ronald Crond29e13e2022-10-19 10:33:48 +02002131
Gilles Peskine449bd832023-01-11 14:50:10 +01002132 if (conf->psk != NULL && conf->psk_len != 0) {
2133 return 1;
2134 }
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002135
Gilles Peskine449bd832023-01-11 14:50:10 +01002136 return 0;
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002137}
2138
Gilles Peskine449bd832023-01-11 14:50:10 +01002139static void ssl_conf_remove_psk(mbedtls_ssl_config *conf)
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002140{
2141 /* Remove reference to existing PSK, if any. */
2142#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01002143 if (!mbedtls_svc_key_id_is_null(conf->psk_opaque)) {
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002144 /* The maintenance of the PSK key slot is the
2145 * user's responsibility. */
Ronald Croncf56a0a2020-08-04 09:51:30 +02002146 conf->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002147 }
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002148#endif /* MBEDTLS_USE_PSA_CRYPTO */
Gilles Peskine449bd832023-01-11 14:50:10 +01002149 if (conf->psk != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01002150 mbedtls_zeroize_and_free(conf->psk, conf->psk_len);
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002151 conf->psk = NULL;
2152 conf->psk_len = 0;
2153 }
2154
2155 /* Remove reference to PSK identity, if any. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002156 if (conf->psk_identity != NULL) {
2157 mbedtls_free(conf->psk_identity);
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002158 conf->psk_identity = NULL;
2159 conf->psk_identity_len = 0;
2160 }
2161}
2162
Hanno Becker7390c712018-11-15 13:33:04 +00002163/* This function assumes that PSK identity in the SSL config is unset.
2164 * It checks that the provided identity is well-formed and attempts
2165 * to make a copy of it in the SSL config.
2166 * On failure, the PSK identity in the config remains unset. */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002167MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002168static int ssl_conf_set_psk_identity(mbedtls_ssl_config *conf,
2169 unsigned char const *psk_identity,
2170 size_t psk_identity_len)
Paul Bakkerd4a56ec2013-04-16 18:05:29 +02002171{
Manuel Pégourié-Gonnardc6b5d832015-08-27 16:37:35 +02002172 /* Identity len will be encoded on two bytes */
Gilles Peskine449bd832023-01-11 14:50:10 +01002173 if (psk_identity == NULL ||
Ronald Cron2a87e9b2022-10-19 10:55:26 +02002174 psk_identity_len == 0 ||
Gilles Peskine449bd832023-01-11 14:50:10 +01002175 (psk_identity_len >> 16) != 0 ||
2176 psk_identity_len > MBEDTLS_SSL_OUT_CONTENT_LEN) {
2177 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnardc6b5d832015-08-27 16:37:35 +02002178 }
2179
Gilles Peskine449bd832023-01-11 14:50:10 +01002180 conf->psk_identity = mbedtls_calloc(1, psk_identity_len);
2181 if (conf->psk_identity == NULL) {
2182 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
2183 }
Paul Bakker6db455e2013-09-18 17:29:31 +02002184
Manuel Pégourié-Gonnard120fdbd2015-05-07 17:07:50 +01002185 conf->psk_identity_len = psk_identity_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01002186 memcpy(conf->psk_identity, psk_identity, conf->psk_identity_len);
Paul Bakker5ad403f2013-09-18 21:21:30 +02002187
Gilles Peskine449bd832023-01-11 14:50:10 +01002188 return 0;
Paul Bakker6db455e2013-09-18 17:29:31 +02002189}
2190
Gilles Peskine449bd832023-01-11 14:50:10 +01002191int mbedtls_ssl_conf_psk(mbedtls_ssl_config *conf,
2192 const unsigned char *psk, size_t psk_len,
2193 const unsigned char *psk_identity, size_t psk_identity_len)
Hanno Becker7390c712018-11-15 13:33:04 +00002194{
Janos Follath865b3eb2019-12-16 11:46:15 +00002195 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002196
2197 /* We currently only support one PSK, raw or opaque. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002198 if (mbedtls_ssl_conf_has_static_psk(conf)) {
2199 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
2200 }
Hanno Becker7390c712018-11-15 13:33:04 +00002201
2202 /* Check and set raw PSK */
Gilles Peskine449bd832023-01-11 14:50:10 +01002203 if (psk == NULL) {
2204 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2205 }
2206 if (psk_len == 0) {
2207 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2208 }
2209 if (psk_len > MBEDTLS_PSK_MAX_LEN) {
2210 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2211 }
Piotr Nowicki9926eaf2019-11-20 14:54:36 +01002212
Gilles Peskine449bd832023-01-11 14:50:10 +01002213 if ((conf->psk = mbedtls_calloc(1, psk_len)) == NULL) {
2214 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
2215 }
Hanno Becker7390c712018-11-15 13:33:04 +00002216 conf->psk_len = psk_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01002217 memcpy(conf->psk, psk, conf->psk_len);
Hanno Becker7390c712018-11-15 13:33:04 +00002218
2219 /* Check and set PSK Identity */
Gilles Peskine449bd832023-01-11 14:50:10 +01002220 ret = ssl_conf_set_psk_identity(conf, psk_identity, psk_identity_len);
2221 if (ret != 0) {
2222 ssl_conf_remove_psk(conf);
2223 }
Hanno Becker7390c712018-11-15 13:33:04 +00002224
Gilles Peskine449bd832023-01-11 14:50:10 +01002225 return ret;
Hanno Becker7390c712018-11-15 13:33:04 +00002226}
2227
Gilles Peskine449bd832023-01-11 14:50:10 +01002228static void ssl_remove_psk(mbedtls_ssl_context *ssl)
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002229{
2230#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01002231 if (!mbedtls_svc_key_id_is_null(ssl->handshake->psk_opaque)) {
Neil Armstrong501c9322022-05-03 09:35:09 +02002232 /* The maintenance of the external PSK key slot is the
2233 * user's responsibility. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002234 if (ssl->handshake->psk_opaque_is_internal) {
2235 psa_destroy_key(ssl->handshake->psk_opaque);
Neil Armstrong501c9322022-05-03 09:35:09 +02002236 ssl->handshake->psk_opaque_is_internal = 0;
2237 }
Ronald Croncf56a0a2020-08-04 09:51:30 +02002238 ssl->handshake->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002239 }
Neil Armstronge952a302022-05-03 10:22:14 +02002240#else
Gilles Peskine449bd832023-01-11 14:50:10 +01002241 if (ssl->handshake->psk != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01002242 mbedtls_zeroize_and_free(ssl->handshake->psk,
Gilles Peskine449bd832023-01-11 14:50:10 +01002243 ssl->handshake->psk_len);
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002244 ssl->handshake->psk_len = 0;
2245 }
Neil Armstronge952a302022-05-03 10:22:14 +02002246#endif /* MBEDTLS_USE_PSA_CRYPTO */
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002247}
2248
Gilles Peskine449bd832023-01-11 14:50:10 +01002249int mbedtls_ssl_set_hs_psk(mbedtls_ssl_context *ssl,
2250 const unsigned char *psk, size_t psk_len)
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002251{
Neil Armstrong501c9322022-05-03 09:35:09 +02002252#if defined(MBEDTLS_USE_PSA_CRYPTO)
2253 psa_key_attributes_t key_attributes = psa_key_attributes_init();
Jerry Yu5d01c052022-08-17 10:18:10 +08002254 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Jerry Yu24b8c812022-08-20 19:06:56 +08002255 psa_algorithm_t alg = PSA_ALG_NONE;
Jerry Yu5d01c052022-08-17 10:18:10 +08002256 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Neil Armstrong501c9322022-05-03 09:35:09 +02002257#endif /* MBEDTLS_USE_PSA_CRYPTO */
2258
Gilles Peskine449bd832023-01-11 14:50:10 +01002259 if (psk == NULL || ssl->handshake == NULL) {
2260 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2261 }
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002262
Gilles Peskine449bd832023-01-11 14:50:10 +01002263 if (psk_len > MBEDTLS_PSK_MAX_LEN) {
2264 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2265 }
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002266
Gilles Peskine449bd832023-01-11 14:50:10 +01002267 ssl_remove_psk(ssl);
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002268
Neil Armstrong501c9322022-05-03 09:35:09 +02002269#if defined(MBEDTLS_USE_PSA_CRYPTO)
Jerry Yuccc68a42022-07-26 16:39:20 +08002270#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01002271 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_2) {
2272 if (ssl->handshake->ciphersuite_info->mac == MBEDTLS_MD_SHA384) {
2273 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_384);
2274 } else {
2275 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_256);
2276 }
2277 psa_set_key_usage_flags(&key_attributes, PSA_KEY_USAGE_DERIVE);
Jerry Yuccc68a42022-07-26 16:39:20 +08002278 }
2279#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Neil Armstrong501c9322022-05-03 09:35:09 +02002280
Jerry Yu568ec252022-07-22 21:27:34 +08002281#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01002282 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
2283 alg = PSA_ALG_HKDF_EXTRACT(PSA_ALG_ANY_HASH);
2284 psa_set_key_usage_flags(&key_attributes,
2285 PSA_KEY_USAGE_DERIVE | PSA_KEY_USAGE_EXPORT);
Jerry Yuccc68a42022-07-26 16:39:20 +08002286 }
2287#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
2288
Gilles Peskine449bd832023-01-11 14:50:10 +01002289 psa_set_key_algorithm(&key_attributes, alg);
2290 psa_set_key_type(&key_attributes, PSA_KEY_TYPE_DERIVE);
Neil Armstrong501c9322022-05-03 09:35:09 +02002291
Gilles Peskine449bd832023-01-11 14:50:10 +01002292 status = psa_import_key(&key_attributes, psk, psk_len, &key);
2293 if (status != PSA_SUCCESS) {
2294 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
2295 }
Neil Armstrong501c9322022-05-03 09:35:09 +02002296
2297 /* Allow calling psa_destroy_key() on psk remove */
2298 ssl->handshake->psk_opaque_is_internal = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01002299 return mbedtls_ssl_set_hs_psk_opaque(ssl, key);
Neil Armstrong501c9322022-05-03 09:35:09 +02002300#else
Gilles Peskine449bd832023-01-11 14:50:10 +01002301 if ((ssl->handshake->psk = mbedtls_calloc(1, psk_len)) == NULL) {
2302 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
2303 }
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002304
2305 ssl->handshake->psk_len = psk_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01002306 memcpy(ssl->handshake->psk, psk, ssl->handshake->psk_len);
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002307
Gilles Peskine449bd832023-01-11 14:50:10 +01002308 return 0;
Neil Armstrong501c9322022-05-03 09:35:09 +02002309#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002310}
2311
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002312#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01002313int mbedtls_ssl_conf_psk_opaque(mbedtls_ssl_config *conf,
2314 mbedtls_svc_key_id_t psk,
2315 const unsigned char *psk_identity,
2316 size_t psk_identity_len)
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002317{
Janos Follath865b3eb2019-12-16 11:46:15 +00002318 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002319
2320 /* We currently only support one PSK, raw or opaque. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002321 if (mbedtls_ssl_conf_has_static_psk(conf)) {
2322 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
2323 }
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002324
Hanno Becker7390c712018-11-15 13:33:04 +00002325 /* Check and set opaque PSK */
Gilles Peskine449bd832023-01-11 14:50:10 +01002326 if (mbedtls_svc_key_id_is_null(psk)) {
2327 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2328 }
Ronald Croncf56a0a2020-08-04 09:51:30 +02002329 conf->psk_opaque = psk;
Hanno Becker7390c712018-11-15 13:33:04 +00002330
2331 /* Check and set PSK Identity */
Gilles Peskine449bd832023-01-11 14:50:10 +01002332 ret = ssl_conf_set_psk_identity(conf, psk_identity,
2333 psk_identity_len);
2334 if (ret != 0) {
2335 ssl_conf_remove_psk(conf);
2336 }
Hanno Becker7390c712018-11-15 13:33:04 +00002337
Gilles Peskine449bd832023-01-11 14:50:10 +01002338 return ret;
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002339}
2340
Gilles Peskine449bd832023-01-11 14:50:10 +01002341int mbedtls_ssl_set_hs_psk_opaque(mbedtls_ssl_context *ssl,
2342 mbedtls_svc_key_id_t psk)
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002343{
Gilles Peskine449bd832023-01-11 14:50:10 +01002344 if ((mbedtls_svc_key_id_is_null(psk)) ||
2345 (ssl->handshake == NULL)) {
2346 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2347 }
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002348
Gilles Peskine449bd832023-01-11 14:50:10 +01002349 ssl_remove_psk(ssl);
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002350 ssl->handshake->psk_opaque = psk;
Gilles Peskine449bd832023-01-11 14:50:10 +01002351 return 0;
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002352}
2353#endif /* MBEDTLS_USE_PSA_CRYPTO */
2354
Jerry Yu8897c072022-08-12 13:56:53 +08002355#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002356void mbedtls_ssl_conf_psk_cb(mbedtls_ssl_config *conf,
2357 int (*f_psk)(void *, mbedtls_ssl_context *, const unsigned char *,
2358 size_t),
2359 void *p_psk)
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002360{
2361 conf->f_psk = f_psk;
2362 conf->p_psk = p_psk;
2363}
Jerry Yu8897c072022-08-12 13:56:53 +08002364#endif /* MBEDTLS_SSL_SRV_C */
2365
Ronald Cron73fe8df2022-10-05 14:31:43 +02002366#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED */
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002367
2368#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine301711e2022-04-26 16:57:05 +02002369static mbedtls_ssl_mode_t mbedtls_ssl_get_base_mode(
Gilles Peskine449bd832023-01-11 14:50:10 +01002370 psa_algorithm_t alg)
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002371{
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002372#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01002373 if (alg == PSA_ALG_CBC_NO_PADDING) {
2374 return MBEDTLS_SSL_MODE_CBC;
2375 }
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002376#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
Gilles Peskine449bd832023-01-11 14:50:10 +01002377 if (PSA_ALG_IS_AEAD(alg)) {
2378 return MBEDTLS_SSL_MODE_AEAD;
2379 }
2380 return MBEDTLS_SSL_MODE_STREAM;
Gilles Peskine301711e2022-04-26 16:57:05 +02002381}
2382
2383#else /* MBEDTLS_USE_PSA_CRYPTO */
2384
2385static mbedtls_ssl_mode_t mbedtls_ssl_get_base_mode(
Gilles Peskine449bd832023-01-11 14:50:10 +01002386 mbedtls_cipher_mode_t mode)
Gilles Peskine301711e2022-04-26 16:57:05 +02002387{
2388#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01002389 if (mode == MBEDTLS_MODE_CBC) {
2390 return MBEDTLS_SSL_MODE_CBC;
2391 }
Gilles Peskine301711e2022-04-26 16:57:05 +02002392#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
2393
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002394#if defined(MBEDTLS_GCM_C) || \
2395 defined(MBEDTLS_CCM_C) || \
2396 defined(MBEDTLS_CHACHAPOLY_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002397 if (mode == MBEDTLS_MODE_GCM ||
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002398 mode == MBEDTLS_MODE_CCM ||
Gilles Peskine449bd832023-01-11 14:50:10 +01002399 mode == MBEDTLS_MODE_CHACHAPOLY) {
2400 return MBEDTLS_SSL_MODE_AEAD;
2401 }
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002402#endif /* MBEDTLS_GCM_C || MBEDTLS_CCM_C || MBEDTLS_CHACHAPOLY_C */
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002403
Gilles Peskine449bd832023-01-11 14:50:10 +01002404 return MBEDTLS_SSL_MODE_STREAM;
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002405}
Gilles Peskine301711e2022-04-26 16:57:05 +02002406#endif /* MBEDTLS_USE_PSA_CRYPTO */
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002407
Gilles Peskinee108d982022-04-26 16:50:40 +02002408static mbedtls_ssl_mode_t mbedtls_ssl_get_actual_mode(
2409 mbedtls_ssl_mode_t base_mode,
Gilles Peskine449bd832023-01-11 14:50:10 +01002410 int encrypt_then_mac)
Gilles Peskinee108d982022-04-26 16:50:40 +02002411{
2412#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01002413 if (encrypt_then_mac == MBEDTLS_SSL_ETM_ENABLED &&
2414 base_mode == MBEDTLS_SSL_MODE_CBC) {
2415 return MBEDTLS_SSL_MODE_CBC_ETM;
Gilles Peskinee108d982022-04-26 16:50:40 +02002416 }
2417#else
2418 (void) encrypt_then_mac;
2419#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002420 return base_mode;
Gilles Peskinee108d982022-04-26 16:50:40 +02002421}
2422
Neil Armstrongab555e02022-04-04 11:07:59 +02002423mbedtls_ssl_mode_t mbedtls_ssl_get_mode_from_transform(
Gilles Peskine449bd832023-01-11 14:50:10 +01002424 const mbedtls_ssl_transform *transform)
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002425{
Gilles Peskinee108d982022-04-26 16:50:40 +02002426 mbedtls_ssl_mode_t base_mode = mbedtls_ssl_get_base_mode(
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002427#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01002428 transform->psa_alg
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002429#else
Gilles Peskine449bd832023-01-11 14:50:10 +01002430 mbedtls_cipher_get_cipher_mode(&transform->cipher_ctx_enc)
Gilles Peskinee108d982022-04-26 16:50:40 +02002431#endif
2432 );
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002433
Gilles Peskinee108d982022-04-26 16:50:40 +02002434 int encrypt_then_mac = 0;
Neil Armstrongf2c82f02022-04-05 11:16:53 +02002435#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskinee108d982022-04-26 16:50:40 +02002436 encrypt_then_mac = transform->encrypt_then_mac;
2437#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002438 return mbedtls_ssl_get_actual_mode(base_mode, encrypt_then_mac);
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002439}
2440
Neil Armstrongab555e02022-04-04 11:07:59 +02002441mbedtls_ssl_mode_t mbedtls_ssl_get_mode_from_ciphersuite(
Neil Armstrongf2c82f02022-04-05 11:16:53 +02002442#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01002443 int encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02002444#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01002445 const mbedtls_ssl_ciphersuite_t *suite)
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002446{
Gilles Peskinee108d982022-04-26 16:50:40 +02002447 mbedtls_ssl_mode_t base_mode = MBEDTLS_SSL_MODE_STREAM;
2448
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002449#if defined(MBEDTLS_USE_PSA_CRYPTO)
2450 psa_status_t status;
2451 psa_algorithm_t alg;
2452 psa_key_type_t type;
2453 size_t size;
Dave Rodgman2eab4622023-10-05 13:30:37 +01002454 status = mbedtls_ssl_cipher_to_psa((mbedtls_cipher_type_t) suite->cipher,
2455 0, &alg, &type, &size);
Gilles Peskine449bd832023-01-11 14:50:10 +01002456 if (status == PSA_SUCCESS) {
2457 base_mode = mbedtls_ssl_get_base_mode(alg);
2458 }
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002459#else
2460 const mbedtls_cipher_info_t *cipher =
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01002461 mbedtls_cipher_info_from_type((mbedtls_cipher_type_t) suite->cipher);
Gilles Peskine449bd832023-01-11 14:50:10 +01002462 if (cipher != NULL) {
Gilles Peskinee108d982022-04-26 16:50:40 +02002463 base_mode =
2464 mbedtls_ssl_get_base_mode(
Gilles Peskine449bd832023-01-11 14:50:10 +01002465 mbedtls_cipher_info_get_mode(cipher));
Gilles Peskinee108d982022-04-26 16:50:40 +02002466 }
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002467#endif /* MBEDTLS_USE_PSA_CRYPTO */
2468
Gilles Peskinee108d982022-04-26 16:50:40 +02002469#if !defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
2470 int encrypt_then_mac = 0;
2471#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002472 return mbedtls_ssl_get_actual_mode(base_mode, encrypt_then_mac);
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002473}
2474
Neil Armstrong8395d7a2022-05-18 11:44:56 +02002475#if defined(MBEDTLS_USE_PSA_CRYPTO) || defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yu251a12e2022-07-13 15:15:48 +08002476
Gilles Peskine449bd832023-01-11 14:50:10 +01002477psa_status_t mbedtls_ssl_cipher_to_psa(mbedtls_cipher_type_t mbedtls_cipher_type,
2478 size_t taglen,
2479 psa_algorithm_t *alg,
2480 psa_key_type_t *key_type,
2481 size_t *key_size)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002482{
Yanray Wang19e4dc82023-11-16 18:02:05 +08002483#if !defined(MBEDTLS_SSL_HAVE_CCM)
2484 (void) taglen;
2485#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002486 switch (mbedtls_cipher_type) {
Yanray Wang1a369d62023-11-16 15:17:31 +08002487#if defined(MBEDTLS_SSL_HAVE_AES) && defined(MBEDTLS_SSL_HAVE_CBC)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002488 case MBEDTLS_CIPHER_AES_128_CBC:
2489 *alg = PSA_ALG_CBC_NO_PADDING;
2490 *key_type = PSA_KEY_TYPE_AES;
2491 *key_size = 128;
2492 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002493#endif
2494#if defined(MBEDTLS_SSL_HAVE_AES) && defined(MBEDTLS_SSL_HAVE_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002495 case MBEDTLS_CIPHER_AES_128_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002496 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002497 *key_type = PSA_KEY_TYPE_AES;
2498 *key_size = 128;
2499 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002500#endif
2501#if defined(MBEDTLS_SSL_HAVE_AES) && defined(MBEDTLS_SSL_HAVE_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002502 case MBEDTLS_CIPHER_AES_128_GCM:
2503 *alg = PSA_ALG_GCM;
2504 *key_type = PSA_KEY_TYPE_AES;
2505 *key_size = 128;
2506 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002507#endif
2508#if defined(MBEDTLS_SSL_HAVE_AES) && defined(MBEDTLS_SSL_HAVE_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002509 case MBEDTLS_CIPHER_AES_192_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002510 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002511 *key_type = PSA_KEY_TYPE_AES;
2512 *key_size = 192;
2513 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002514#endif
2515#if defined(MBEDTLS_SSL_HAVE_AES) && defined(MBEDTLS_SSL_HAVE_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002516 case MBEDTLS_CIPHER_AES_192_GCM:
2517 *alg = PSA_ALG_GCM;
2518 *key_type = PSA_KEY_TYPE_AES;
2519 *key_size = 192;
2520 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002521#endif
2522#if defined(MBEDTLS_SSL_HAVE_AES) && defined(MBEDTLS_SSL_HAVE_CBC)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002523 case MBEDTLS_CIPHER_AES_256_CBC:
2524 *alg = PSA_ALG_CBC_NO_PADDING;
2525 *key_type = PSA_KEY_TYPE_AES;
2526 *key_size = 256;
2527 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002528#endif
2529#if defined(MBEDTLS_SSL_HAVE_AES) && defined(MBEDTLS_SSL_HAVE_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002530 case MBEDTLS_CIPHER_AES_256_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002531 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002532 *key_type = PSA_KEY_TYPE_AES;
2533 *key_size = 256;
2534 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002535#endif
2536#if defined(MBEDTLS_SSL_HAVE_AES) && defined(MBEDTLS_SSL_HAVE_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002537 case MBEDTLS_CIPHER_AES_256_GCM:
2538 *alg = PSA_ALG_GCM;
2539 *key_type = PSA_KEY_TYPE_AES;
2540 *key_size = 256;
2541 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002542#endif
2543#if defined(MBEDTLS_SSL_HAVE_ARIA) && defined(MBEDTLS_SSL_HAVE_CBC)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002544 case MBEDTLS_CIPHER_ARIA_128_CBC:
2545 *alg = PSA_ALG_CBC_NO_PADDING;
2546 *key_type = PSA_KEY_TYPE_ARIA;
2547 *key_size = 128;
2548 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002549#endif
2550#if defined(MBEDTLS_SSL_HAVE_ARIA) && defined(MBEDTLS_SSL_HAVE_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002551 case MBEDTLS_CIPHER_ARIA_128_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002552 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002553 *key_type = PSA_KEY_TYPE_ARIA;
2554 *key_size = 128;
2555 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002556#endif
2557#if defined(MBEDTLS_SSL_HAVE_ARIA) && defined(MBEDTLS_SSL_HAVE_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002558 case MBEDTLS_CIPHER_ARIA_128_GCM:
2559 *alg = PSA_ALG_GCM;
2560 *key_type = PSA_KEY_TYPE_ARIA;
2561 *key_size = 128;
2562 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002563#endif
2564#if defined(MBEDTLS_SSL_HAVE_ARIA) && defined(MBEDTLS_SSL_HAVE_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002565 case MBEDTLS_CIPHER_ARIA_192_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002566 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002567 *key_type = PSA_KEY_TYPE_ARIA;
2568 *key_size = 192;
2569 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002570#endif
2571#if defined(MBEDTLS_SSL_HAVE_ARIA) && defined(MBEDTLS_SSL_HAVE_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002572 case MBEDTLS_CIPHER_ARIA_192_GCM:
2573 *alg = PSA_ALG_GCM;
2574 *key_type = PSA_KEY_TYPE_ARIA;
2575 *key_size = 192;
2576 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002577#endif
2578#if defined(MBEDTLS_SSL_HAVE_ARIA) && defined(MBEDTLS_SSL_HAVE_CBC)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002579 case MBEDTLS_CIPHER_ARIA_256_CBC:
2580 *alg = PSA_ALG_CBC_NO_PADDING;
2581 *key_type = PSA_KEY_TYPE_ARIA;
2582 *key_size = 256;
2583 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002584#endif
2585#if defined(MBEDTLS_SSL_HAVE_ARIA) && defined(MBEDTLS_SSL_HAVE_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002586 case MBEDTLS_CIPHER_ARIA_256_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002587 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002588 *key_type = PSA_KEY_TYPE_ARIA;
2589 *key_size = 256;
2590 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002591#endif
2592#if defined(MBEDTLS_SSL_HAVE_ARIA) && defined(MBEDTLS_SSL_HAVE_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002593 case MBEDTLS_CIPHER_ARIA_256_GCM:
2594 *alg = PSA_ALG_GCM;
2595 *key_type = PSA_KEY_TYPE_ARIA;
2596 *key_size = 256;
2597 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002598#endif
2599#if defined(MBEDTLS_SSL_HAVE_CAMELLIA) && defined(MBEDTLS_SSL_HAVE_CBC)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002600 case MBEDTLS_CIPHER_CAMELLIA_128_CBC:
2601 *alg = PSA_ALG_CBC_NO_PADDING;
2602 *key_type = PSA_KEY_TYPE_CAMELLIA;
2603 *key_size = 128;
2604 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002605#endif
2606#if defined(MBEDTLS_SSL_HAVE_CAMELLIA) && defined(MBEDTLS_SSL_HAVE_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002607 case MBEDTLS_CIPHER_CAMELLIA_128_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002608 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002609 *key_type = PSA_KEY_TYPE_CAMELLIA;
2610 *key_size = 128;
2611 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002612#endif
2613#if defined(MBEDTLS_SSL_HAVE_CAMELLIA) && defined(MBEDTLS_SSL_HAVE_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002614 case MBEDTLS_CIPHER_CAMELLIA_128_GCM:
2615 *alg = PSA_ALG_GCM;
2616 *key_type = PSA_KEY_TYPE_CAMELLIA;
2617 *key_size = 128;
2618 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002619#endif
2620#if defined(MBEDTLS_SSL_HAVE_CAMELLIA) && defined(MBEDTLS_SSL_HAVE_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002621 case MBEDTLS_CIPHER_CAMELLIA_192_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002622 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002623 *key_type = PSA_KEY_TYPE_CAMELLIA;
2624 *key_size = 192;
2625 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002626#endif
2627#if defined(MBEDTLS_SSL_HAVE_CAMELLIA) && defined(MBEDTLS_SSL_HAVE_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002628 case MBEDTLS_CIPHER_CAMELLIA_192_GCM:
2629 *alg = PSA_ALG_GCM;
2630 *key_type = PSA_KEY_TYPE_CAMELLIA;
2631 *key_size = 192;
2632 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002633#endif
2634#if defined(MBEDTLS_SSL_HAVE_CAMELLIA) && defined(MBEDTLS_SSL_HAVE_CBC)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002635 case MBEDTLS_CIPHER_CAMELLIA_256_CBC:
2636 *alg = PSA_ALG_CBC_NO_PADDING;
2637 *key_type = PSA_KEY_TYPE_CAMELLIA;
2638 *key_size = 256;
2639 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002640#endif
2641#if defined(MBEDTLS_SSL_HAVE_CAMELLIA) && defined(MBEDTLS_SSL_HAVE_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002642 case MBEDTLS_CIPHER_CAMELLIA_256_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002643 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002644 *key_type = PSA_KEY_TYPE_CAMELLIA;
2645 *key_size = 256;
2646 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002647#endif
2648#if defined(MBEDTLS_SSL_HAVE_CAMELLIA) && defined(MBEDTLS_SSL_HAVE_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002649 case MBEDTLS_CIPHER_CAMELLIA_256_GCM:
2650 *alg = PSA_ALG_GCM;
2651 *key_type = PSA_KEY_TYPE_CAMELLIA;
2652 *key_size = 256;
2653 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002654#endif
2655#if defined(MBEDTLS_SSL_HAVE_CHACHAPOLY)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002656 case MBEDTLS_CIPHER_CHACHA20_POLY1305:
2657 *alg = PSA_ALG_CHACHA20_POLY1305;
2658 *key_type = PSA_KEY_TYPE_CHACHA20;
2659 *key_size = 256;
2660 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002661#endif
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002662 case MBEDTLS_CIPHER_NULL:
2663 *alg = MBEDTLS_SSL_NULL_CIPHER;
2664 *key_type = 0;
2665 *key_size = 0;
2666 break;
2667 default:
2668 return PSA_ERROR_NOT_SUPPORTED;
2669 }
2670
2671 return PSA_SUCCESS;
2672}
Neil Armstrong8395d7a2022-05-18 11:44:56 +02002673#endif /* MBEDTLS_USE_PSA_CRYPTO || MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002674
Manuel Pégourié-Gonnardcf141ca2015-05-20 10:35:51 +02002675#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002676int mbedtls_ssl_conf_dh_param_bin(mbedtls_ssl_config *conf,
2677 const unsigned char *dhm_P, size_t P_len,
2678 const unsigned char *dhm_G, size_t G_len)
Hanno Beckera90658f2017-10-04 15:29:08 +01002679{
Janos Follath865b3eb2019-12-16 11:46:15 +00002680 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Beckera90658f2017-10-04 15:29:08 +01002681
Gilles Peskine449bd832023-01-11 14:50:10 +01002682 mbedtls_mpi_free(&conf->dhm_P);
2683 mbedtls_mpi_free(&conf->dhm_G);
Glenn Strausscee11292021-12-20 01:43:17 -05002684
Gilles Peskine449bd832023-01-11 14:50:10 +01002685 if ((ret = mbedtls_mpi_read_binary(&conf->dhm_P, dhm_P, P_len)) != 0 ||
2686 (ret = mbedtls_mpi_read_binary(&conf->dhm_G, dhm_G, G_len)) != 0) {
2687 mbedtls_mpi_free(&conf->dhm_P);
2688 mbedtls_mpi_free(&conf->dhm_G);
2689 return ret;
Hanno Beckera90658f2017-10-04 15:29:08 +01002690 }
2691
Gilles Peskine449bd832023-01-11 14:50:10 +01002692 return 0;
Hanno Beckera90658f2017-10-04 15:29:08 +01002693}
Paul Bakker5121ce52009-01-03 21:22:43 +00002694
Gilles Peskine449bd832023-01-11 14:50:10 +01002695int mbedtls_ssl_conf_dh_param_ctx(mbedtls_ssl_config *conf, mbedtls_dhm_context *dhm_ctx)
Paul Bakker1b57b062011-01-06 15:48:19 +00002696{
Janos Follath865b3eb2019-12-16 11:46:15 +00002697 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker1b57b062011-01-06 15:48:19 +00002698
Gilles Peskine449bd832023-01-11 14:50:10 +01002699 mbedtls_mpi_free(&conf->dhm_P);
2700 mbedtls_mpi_free(&conf->dhm_G);
Glenn Strausscee11292021-12-20 01:43:17 -05002701
Gilles Peskine449bd832023-01-11 14:50:10 +01002702 if ((ret = mbedtls_dhm_get_value(dhm_ctx, MBEDTLS_DHM_PARAM_P,
2703 &conf->dhm_P)) != 0 ||
2704 (ret = mbedtls_dhm_get_value(dhm_ctx, MBEDTLS_DHM_PARAM_G,
2705 &conf->dhm_G)) != 0) {
2706 mbedtls_mpi_free(&conf->dhm_P);
2707 mbedtls_mpi_free(&conf->dhm_G);
2708 return ret;
Manuel Pégourié-Gonnard1028b742015-05-06 17:33:07 +01002709 }
Paul Bakker1b57b062011-01-06 15:48:19 +00002710
Gilles Peskine449bd832023-01-11 14:50:10 +01002711 return 0;
Paul Bakker1b57b062011-01-06 15:48:19 +00002712}
Manuel Pégourié-Gonnardcf141ca2015-05-20 10:35:51 +02002713#endif /* MBEDTLS_DHM_C && MBEDTLS_SSL_SRV_C */
Paul Bakker1b57b062011-01-06 15:48:19 +00002714
Manuel Pégourié-Gonnardbd990d62015-06-11 14:49:42 +02002715#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_CLI_C)
2716/*
2717 * Set the minimum length for Diffie-Hellman parameters
2718 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002719void mbedtls_ssl_conf_dhm_min_bitlen(mbedtls_ssl_config *conf,
2720 unsigned int bitlen)
Manuel Pégourié-Gonnardbd990d62015-06-11 14:49:42 +02002721{
2722 conf->dhm_min_bitlen = bitlen;
2723}
2724#endif /* MBEDTLS_DHM_C && MBEDTLS_SSL_CLI_C */
2725
Ronald Crone68ab4f2022-10-05 12:46:29 +02002726#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu7ddc38c2022-01-19 11:08:05 +08002727#if !defined(MBEDTLS_DEPRECATED_REMOVED) && defined(MBEDTLS_SSL_PROTO_TLS1_2)
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02002728/*
2729 * Set allowed/preferred hashes for handshake signatures
2730 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002731void mbedtls_ssl_conf_sig_hashes(mbedtls_ssl_config *conf,
2732 const int *hashes)
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02002733{
2734 conf->sig_hashes = hashes;
2735}
Jerry Yu7ddc38c2022-01-19 11:08:05 +08002736#endif /* !MBEDTLS_DEPRECATED_REMOVED && MBEDTLS_SSL_PROTO_TLS1_2 */
Hanno Becker1cd6e002021-08-10 13:27:10 +01002737
Jerry Yuf017ee42022-01-12 15:49:48 +08002738/* Configure allowed signature algorithms for handshake */
Gilles Peskine449bd832023-01-11 14:50:10 +01002739void mbedtls_ssl_conf_sig_algs(mbedtls_ssl_config *conf,
2740 const uint16_t *sig_algs)
Hanno Becker1cd6e002021-08-10 13:27:10 +01002741{
Jerry Yuf017ee42022-01-12 15:49:48 +08002742#if !defined(MBEDTLS_DEPRECATED_REMOVED)
2743 conf->sig_hashes = NULL;
2744#endif /* !MBEDTLS_DEPRECATED_REMOVED */
2745 conf->sig_algs = sig_algs;
Hanno Becker1cd6e002021-08-10 13:27:10 +01002746}
Ronald Crone68ab4f2022-10-05 12:46:29 +02002747#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02002748
Manuel Pégourié-Gonnardf07ce3b2023-09-22 11:53:41 +02002749#if defined(MBEDTLS_ECP_C)
Brett Warrene0edc842021-08-17 09:53:13 +01002750#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002751/*
2752 * Set the allowed elliptic curves
Brett Warrene0edc842021-08-17 09:53:13 +01002753 *
2754 * mbedtls_ssl_setup() takes the provided list
2755 * and translates it to a list of IANA TLS group identifiers,
2756 * stored in ssl->handshake->group_list.
2757 *
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002758 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002759void mbedtls_ssl_conf_curves(mbedtls_ssl_config *conf,
2760 const mbedtls_ecp_group_id *curve_list)
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002761{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002762 conf->curve_list = curve_list;
Brett Warrene0edc842021-08-17 09:53:13 +01002763 conf->group_list = NULL;
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002764}
Brett Warrene0edc842021-08-17 09:53:13 +01002765#endif /* MBEDTLS_DEPRECATED_REMOVED */
Manuel Pégourié-Gonnardf07ce3b2023-09-22 11:53:41 +02002766#endif /* MBEDTLS_ECP_C */
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002767
Brett Warrene0edc842021-08-17 09:53:13 +01002768/*
2769 * Set the allowed groups
2770 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002771void mbedtls_ssl_conf_groups(mbedtls_ssl_config *conf,
2772 const uint16_t *group_list)
Brett Warrene0edc842021-08-17 09:53:13 +01002773{
Manuel Pégourié-Gonnardf07ce3b2023-09-22 11:53:41 +02002774#if defined(MBEDTLS_ECP_C) && !defined(MBEDTLS_DEPRECATED_REMOVED)
Brett Warrene0edc842021-08-17 09:53:13 +01002775 conf->curve_list = NULL;
2776#endif
2777 conf->group_list = group_list;
2778}
2779
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01002780#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002781int mbedtls_ssl_set_hostname(mbedtls_ssl_context *ssl, const char *hostname)
Paul Bakker5121ce52009-01-03 21:22:43 +00002782{
Hanno Becker947194e2017-04-07 13:25:49 +01002783 /* Initialize to suppress unnecessary compiler warning */
2784 size_t hostname_len = 0;
2785
2786 /* Check if new hostname is valid before
2787 * making any change to current one */
Gilles Peskine449bd832023-01-11 14:50:10 +01002788 if (hostname != NULL) {
2789 hostname_len = strlen(hostname);
Hanno Becker947194e2017-04-07 13:25:49 +01002790
Gilles Peskine449bd832023-01-11 14:50:10 +01002791 if (hostname_len > MBEDTLS_SSL_MAX_HOST_NAME_LEN) {
2792 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2793 }
Hanno Becker947194e2017-04-07 13:25:49 +01002794 }
2795
2796 /* Now it's clear that we will overwrite the old hostname,
2797 * so we can free it safely */
2798
Gilles Peskine449bd832023-01-11 14:50:10 +01002799 if (ssl->hostname != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01002800 mbedtls_zeroize_and_free(ssl->hostname, strlen(ssl->hostname));
Hanno Becker947194e2017-04-07 13:25:49 +01002801 }
2802
2803 /* Passing NULL as hostname shall clear the old one */
Manuel Pégourié-Gonnardba26c242015-05-06 10:47:06 +01002804
Gilles Peskine449bd832023-01-11 14:50:10 +01002805 if (hostname == NULL) {
Hanno Becker947194e2017-04-07 13:25:49 +01002806 ssl->hostname = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01002807 } else {
2808 ssl->hostname = mbedtls_calloc(1, hostname_len + 1);
2809 if (ssl->hostname == NULL) {
2810 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
2811 }
Paul Bakker75c1a6f2013-08-19 14:25:29 +02002812
Gilles Peskine449bd832023-01-11 14:50:10 +01002813 memcpy(ssl->hostname, hostname, hostname_len);
Paul Bakker75c1a6f2013-08-19 14:25:29 +02002814
Hanno Becker947194e2017-04-07 13:25:49 +01002815 ssl->hostname[hostname_len] = '\0';
2816 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002817
Gilles Peskine449bd832023-01-11 14:50:10 +01002818 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00002819}
Hanno Becker1a9a51c2017-04-07 13:02:16 +01002820#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00002821
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01002822#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01002823void mbedtls_ssl_conf_sni(mbedtls_ssl_config *conf,
2824 int (*f_sni)(void *, mbedtls_ssl_context *,
2825 const unsigned char *, size_t),
2826 void *p_sni)
Paul Bakker5701cdc2012-09-27 21:49:42 +00002827{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002828 conf->f_sni = f_sni;
2829 conf->p_sni = p_sni;
Paul Bakker5701cdc2012-09-27 21:49:42 +00002830}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002831#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
Paul Bakker5701cdc2012-09-27 21:49:42 +00002832
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002833#if defined(MBEDTLS_SSL_ALPN)
Gilles Peskine449bd832023-01-11 14:50:10 +01002834int mbedtls_ssl_conf_alpn_protocols(mbedtls_ssl_config *conf, const char **protos)
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002835{
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002836 size_t cur_len, tot_len;
2837 const char **p;
2838
2839 /*
Brian J Murray1903fb32016-11-06 04:45:15 -08002840 * RFC 7301 3.1: "Empty strings MUST NOT be included and byte strings
2841 * MUST NOT be truncated."
2842 * We check lengths now rather than later.
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002843 */
2844 tot_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01002845 for (p = protos; *p != NULL; p++) {
2846 cur_len = strlen(*p);
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002847 tot_len += cur_len;
2848
Gilles Peskine449bd832023-01-11 14:50:10 +01002849 if ((cur_len == 0) ||
2850 (cur_len > MBEDTLS_SSL_MAX_ALPN_NAME_LEN) ||
2851 (tot_len > MBEDTLS_SSL_MAX_ALPN_LIST_LEN)) {
2852 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2853 }
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002854 }
2855
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002856 conf->alpn_list = protos;
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002857
Gilles Peskine449bd832023-01-11 14:50:10 +01002858 return 0;
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002859}
2860
Gilles Peskine449bd832023-01-11 14:50:10 +01002861const char *mbedtls_ssl_get_alpn_protocol(const mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002862{
Gilles Peskine449bd832023-01-11 14:50:10 +01002863 return ssl->alpn_chosen;
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002864}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002865#endif /* MBEDTLS_SSL_ALPN */
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002866
Johan Pascalb62bb512015-12-03 21:56:45 +01002867#if defined(MBEDTLS_SSL_DTLS_SRTP)
Gilles Peskine449bd832023-01-11 14:50:10 +01002868void mbedtls_ssl_conf_srtp_mki_value_supported(mbedtls_ssl_config *conf,
2869 int support_mki_value)
Ron Eldor591f1622018-01-22 12:30:04 +02002870{
2871 conf->dtls_srtp_mki_support = support_mki_value;
2872}
2873
Gilles Peskine449bd832023-01-11 14:50:10 +01002874int mbedtls_ssl_dtls_srtp_set_mki_value(mbedtls_ssl_context *ssl,
2875 unsigned char *mki_value,
2876 uint16_t mki_len)
Ron Eldor591f1622018-01-22 12:30:04 +02002877{
Gilles Peskine449bd832023-01-11 14:50:10 +01002878 if (mki_len > MBEDTLS_TLS_SRTP_MAX_MKI_LENGTH) {
2879 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Ron Eldora9788042018-12-05 11:04:31 +02002880 }
Ron Eldor591f1622018-01-22 12:30:04 +02002881
Gilles Peskine449bd832023-01-11 14:50:10 +01002882 if (ssl->conf->dtls_srtp_mki_support == MBEDTLS_SSL_DTLS_SRTP_MKI_UNSUPPORTED) {
2883 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Ron Eldora9788042018-12-05 11:04:31 +02002884 }
Ron Eldor591f1622018-01-22 12:30:04 +02002885
Gilles Peskine449bd832023-01-11 14:50:10 +01002886 memcpy(ssl->dtls_srtp_info.mki_value, mki_value, mki_len);
Ron Eldor591f1622018-01-22 12:30:04 +02002887 ssl->dtls_srtp_info.mki_len = mki_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01002888 return 0;
Ron Eldor591f1622018-01-22 12:30:04 +02002889}
2890
Gilles Peskine449bd832023-01-11 14:50:10 +01002891int mbedtls_ssl_conf_dtls_srtp_protection_profiles(mbedtls_ssl_config *conf,
2892 const mbedtls_ssl_srtp_profile *profiles)
Johan Pascalb62bb512015-12-03 21:56:45 +01002893{
Johan Pascal253d0262020-09-22 13:04:45 +02002894 const mbedtls_ssl_srtp_profile *p;
2895 size_t list_size = 0;
Johan Pascalb62bb512015-12-03 21:56:45 +01002896
Johan Pascal253d0262020-09-22 13:04:45 +02002897 /* check the profiles list: all entry must be valid,
2898 * its size cannot be more than the total number of supported profiles, currently 4 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002899 for (p = profiles; *p != MBEDTLS_TLS_SRTP_UNSET &&
2900 list_size <= MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH;
2901 p++) {
2902 if (mbedtls_ssl_check_srtp_profile_value(*p) != MBEDTLS_TLS_SRTP_UNSET) {
Johan Pascal76fdf1d2020-10-22 23:31:00 +02002903 list_size++;
Gilles Peskine449bd832023-01-11 14:50:10 +01002904 } else {
Johan Pascal76fdf1d2020-10-22 23:31:00 +02002905 /* unsupported value, stop parsing and set the size to an error value */
2906 list_size = MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH + 1;
Johan Pascalb62bb512015-12-03 21:56:45 +01002907 }
2908 }
2909
Gilles Peskine449bd832023-01-11 14:50:10 +01002910 if (list_size > MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH) {
2911 conf->dtls_srtp_profile_list = NULL;
2912 conf->dtls_srtp_profile_list_len = 0;
2913 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Johan Pascal253d0262020-09-22 13:04:45 +02002914 }
2915
Johan Pascal9bc97ca2020-09-21 23:44:45 +02002916 conf->dtls_srtp_profile_list = profiles;
Johan Pascal253d0262020-09-22 13:04:45 +02002917 conf->dtls_srtp_profile_list_len = list_size;
Johan Pascalb62bb512015-12-03 21:56:45 +01002918
Gilles Peskine449bd832023-01-11 14:50:10 +01002919 return 0;
Johan Pascalb62bb512015-12-03 21:56:45 +01002920}
2921
Gilles Peskine449bd832023-01-11 14:50:10 +01002922void mbedtls_ssl_get_dtls_srtp_negotiation_result(const mbedtls_ssl_context *ssl,
2923 mbedtls_dtls_srtp_info *dtls_srtp_info)
Johan Pascalb62bb512015-12-03 21:56:45 +01002924{
Johan Pascal2258a4f2020-10-28 13:53:09 +01002925 dtls_srtp_info->chosen_dtls_srtp_profile = ssl->dtls_srtp_info.chosen_dtls_srtp_profile;
2926 /* do not copy the mki value if there is no chosen profile */
Gilles Peskine449bd832023-01-11 14:50:10 +01002927 if (dtls_srtp_info->chosen_dtls_srtp_profile == MBEDTLS_TLS_SRTP_UNSET) {
Johan Pascal2258a4f2020-10-28 13:53:09 +01002928 dtls_srtp_info->mki_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01002929 } else {
Johan Pascal2258a4f2020-10-28 13:53:09 +01002930 dtls_srtp_info->mki_len = ssl->dtls_srtp_info.mki_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01002931 memcpy(dtls_srtp_info->mki_value, ssl->dtls_srtp_info.mki_value,
2932 ssl->dtls_srtp_info.mki_len);
Johan Pascal2258a4f2020-10-28 13:53:09 +01002933 }
Johan Pascalb62bb512015-12-03 21:56:45 +01002934}
Johan Pascalb62bb512015-12-03 21:56:45 +01002935#endif /* MBEDTLS_SSL_DTLS_SRTP */
2936
Aditya Patwardhan3096f332022-07-26 14:31:46 +05302937#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Gilles Peskine449bd832023-01-11 14:50:10 +01002938void mbedtls_ssl_conf_max_version(mbedtls_ssl_config *conf, int major, int minor)
Paul Bakker490ecc82011-10-06 13:04:09 +00002939{
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01002940 conf->max_tls_version = (mbedtls_ssl_protocol_version) ((major << 8) | minor);
Paul Bakker490ecc82011-10-06 13:04:09 +00002941}
2942
Gilles Peskine449bd832023-01-11 14:50:10 +01002943void mbedtls_ssl_conf_min_version(mbedtls_ssl_config *conf, int major, int minor)
Paul Bakker1d29fb52012-09-28 13:28:45 +00002944{
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01002945 conf->min_tls_version = (mbedtls_ssl_protocol_version) ((major << 8) | minor);
Paul Bakker1d29fb52012-09-28 13:28:45 +00002946}
Aditya Patwardhan3096f332022-07-26 14:31:46 +05302947#endif /* MBEDTLS_DEPRECATED_REMOVED */
Paul Bakker1d29fb52012-09-28 13:28:45 +00002948
Janos Follath088ce432017-04-10 12:42:31 +01002949#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002950void mbedtls_ssl_conf_cert_req_ca_list(mbedtls_ssl_config *conf,
2951 char cert_req_ca_list)
Janos Follath088ce432017-04-10 12:42:31 +01002952{
2953 conf->cert_req_ca_list = cert_req_ca_list;
2954}
2955#endif
2956
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002957#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01002958void mbedtls_ssl_conf_encrypt_then_mac(mbedtls_ssl_config *conf, char etm)
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01002959{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002960 conf->encrypt_then_mac = etm;
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01002961}
2962#endif
2963
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002964#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
Gilles Peskine449bd832023-01-11 14:50:10 +01002965void mbedtls_ssl_conf_extended_master_secret(mbedtls_ssl_config *conf, char ems)
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02002966{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002967 conf->extended_ms = ems;
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02002968}
2969#endif
2970
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002971#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01002972int mbedtls_ssl_conf_max_frag_len(mbedtls_ssl_config *conf, unsigned char mfl_code)
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002973{
Gilles Peskine449bd832023-01-11 14:50:10 +01002974 if (mfl_code >= MBEDTLS_SSL_MAX_FRAG_LEN_INVALID ||
2975 ssl_mfl_code_to_length(mfl_code) > MBEDTLS_TLS_EXT_ADV_CONTENT_LEN) {
2976 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002977 }
2978
Manuel Pégourié-Gonnard6bf89d62015-05-05 17:01:57 +01002979 conf->mfl_code = mfl_code;
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002980
Gilles Peskine449bd832023-01-11 14:50:10 +01002981 return 0;
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002982}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002983#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002984
Gilles Peskine449bd832023-01-11 14:50:10 +01002985void mbedtls_ssl_conf_legacy_renegotiation(mbedtls_ssl_config *conf, int allow_legacy)
Paul Bakker48916f92012-09-16 19:57:18 +00002986{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002987 conf->allow_legacy_renegotiation = allow_legacy;
Paul Bakker48916f92012-09-16 19:57:18 +00002988}
2989
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002990#if defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01002991void mbedtls_ssl_conf_renegotiation(mbedtls_ssl_config *conf, int renegotiation)
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01002992{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002993 conf->disable_renegotiation = renegotiation;
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01002994}
2995
Gilles Peskine449bd832023-01-11 14:50:10 +01002996void mbedtls_ssl_conf_renegotiation_enforced(mbedtls_ssl_config *conf, int max_records)
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02002997{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002998 conf->renego_max_records = max_records;
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02002999}
3000
Gilles Peskine449bd832023-01-11 14:50:10 +01003001void mbedtls_ssl_conf_renegotiation_period(mbedtls_ssl_config *conf,
3002 const unsigned char period[8])
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01003003{
Gilles Peskine449bd832023-01-11 14:50:10 +01003004 memcpy(conf->renego_period, period, 8);
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01003005}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003006#endif /* MBEDTLS_SSL_RENEGOTIATION */
Paul Bakker5121ce52009-01-03 21:22:43 +00003007
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003008#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02003009#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01003010void mbedtls_ssl_conf_session_tickets(mbedtls_ssl_config *conf, int use_tickets)
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02003011{
Manuel Pégourié-Gonnard2b494452015-05-06 10:05:11 +01003012 conf->session_tickets = use_tickets;
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02003013}
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02003014#endif
Paul Bakker606b4ba2013-08-14 16:52:14 +02003015
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02003016#if defined(MBEDTLS_SSL_SRV_C)
Jerry Yu1ad7ace2022-08-09 13:28:39 +08003017
Jerry Yud0766ec2022-09-22 10:46:57 +08003018#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003019void mbedtls_ssl_conf_new_session_tickets(mbedtls_ssl_config *conf,
3020 uint16_t num_tickets)
Jerry Yu1ad7ace2022-08-09 13:28:39 +08003021{
Jerry Yud0766ec2022-09-22 10:46:57 +08003022 conf->new_session_tickets_count = num_tickets;
Jerry Yu1ad7ace2022-08-09 13:28:39 +08003023}
3024#endif
3025
Gilles Peskine449bd832023-01-11 14:50:10 +01003026void mbedtls_ssl_conf_session_tickets_cb(mbedtls_ssl_config *conf,
3027 mbedtls_ssl_ticket_write_t *f_ticket_write,
3028 mbedtls_ssl_ticket_parse_t *f_ticket_parse,
3029 void *p_ticket)
Paul Bakker606b4ba2013-08-14 16:52:14 +02003030{
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02003031 conf->f_ticket_write = f_ticket_write;
3032 conf->f_ticket_parse = f_ticket_parse;
3033 conf->p_ticket = p_ticket;
Paul Bakker606b4ba2013-08-14 16:52:14 +02003034}
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02003035#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003036#endif /* MBEDTLS_SSL_SESSION_TICKETS */
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02003037
Gilles Peskine449bd832023-01-11 14:50:10 +01003038void mbedtls_ssl_set_export_keys_cb(mbedtls_ssl_context *ssl,
3039 mbedtls_ssl_export_keys_t *f_export_keys,
3040 void *p_export_keys)
Robert Cragie4feb7ae2015-10-02 13:33:37 +01003041{
Hanno Becker7e6c1782021-06-08 09:24:55 +01003042 ssl->f_export_keys = f_export_keys;
3043 ssl->p_export_keys = p_export_keys;
Ron Eldorf5cc10d2019-05-07 18:33:40 +03003044}
Robert Cragie4feb7ae2015-10-02 13:33:37 +01003045
Gilles Peskineb74a1c72018-04-24 13:09:22 +02003046#if defined(MBEDTLS_SSL_ASYNC_PRIVATE)
Gilles Peskine8bf79f62018-01-05 21:11:53 +01003047void mbedtls_ssl_conf_async_private_cb(
3048 mbedtls_ssl_config *conf,
3049 mbedtls_ssl_async_sign_t *f_async_sign,
3050 mbedtls_ssl_async_decrypt_t *f_async_decrypt,
3051 mbedtls_ssl_async_resume_t *f_async_resume,
3052 mbedtls_ssl_async_cancel_t *f_async_cancel,
Gilles Peskine449bd832023-01-11 14:50:10 +01003053 void *async_config_data)
Gilles Peskine8bf79f62018-01-05 21:11:53 +01003054{
3055 conf->f_async_sign_start = f_async_sign;
3056 conf->f_async_decrypt_start = f_async_decrypt;
3057 conf->f_async_resume = f_async_resume;
3058 conf->f_async_cancel = f_async_cancel;
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003059 conf->p_async_config_data = async_config_data;
3060}
3061
Gilles Peskine449bd832023-01-11 14:50:10 +01003062void *mbedtls_ssl_conf_get_async_config_data(const mbedtls_ssl_config *conf)
Gilles Peskine8f97af72018-04-26 11:46:10 +02003063{
Gilles Peskine449bd832023-01-11 14:50:10 +01003064 return conf->p_async_config_data;
Gilles Peskine8f97af72018-04-26 11:46:10 +02003065}
3066
Gilles Peskine449bd832023-01-11 14:50:10 +01003067void *mbedtls_ssl_get_async_operation_data(const mbedtls_ssl_context *ssl)
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003068{
Gilles Peskine449bd832023-01-11 14:50:10 +01003069 if (ssl->handshake == NULL) {
3070 return NULL;
3071 } else {
3072 return ssl->handshake->user_async_ctx;
3073 }
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003074}
3075
Gilles Peskine449bd832023-01-11 14:50:10 +01003076void mbedtls_ssl_set_async_operation_data(mbedtls_ssl_context *ssl,
3077 void *ctx)
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003078{
Gilles Peskine449bd832023-01-11 14:50:10 +01003079 if (ssl->handshake != NULL) {
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003080 ssl->handshake->user_async_ctx = ctx;
Gilles Peskine449bd832023-01-11 14:50:10 +01003081 }
Gilles Peskine8bf79f62018-01-05 21:11:53 +01003082}
Gilles Peskineb74a1c72018-04-24 13:09:22 +02003083#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
Gilles Peskine8bf79f62018-01-05 21:11:53 +01003084
Paul Bakker5121ce52009-01-03 21:22:43 +00003085/*
3086 * SSL get accessors
3087 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003088uint32_t mbedtls_ssl_get_verify_result(const mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00003089{
Gilles Peskine449bd832023-01-11 14:50:10 +01003090 if (ssl->session != NULL) {
3091 return ssl->session->verify_result;
3092 }
Manuel Pégourié-Gonnarde89163c2015-01-23 14:30:57 +00003093
Gilles Peskine449bd832023-01-11 14:50:10 +01003094 if (ssl->session_negotiate != NULL) {
3095 return ssl->session_negotiate->verify_result;
3096 }
Manuel Pégourié-Gonnarde89163c2015-01-23 14:30:57 +00003097
Gilles Peskine449bd832023-01-11 14:50:10 +01003098 return 0xFFFFFFFF;
Paul Bakker5121ce52009-01-03 21:22:43 +00003099}
3100
Gilles Peskine449bd832023-01-11 14:50:10 +01003101int mbedtls_ssl_get_ciphersuite_id_from_ssl(const mbedtls_ssl_context *ssl)
Glenn Strauss8f526902022-01-13 00:04:49 -05003102{
Gilles Peskine449bd832023-01-11 14:50:10 +01003103 if (ssl == NULL || ssl->session == NULL) {
3104 return 0;
3105 }
Glenn Strauss8f526902022-01-13 00:04:49 -05003106
Gilles Peskine449bd832023-01-11 14:50:10 +01003107 return ssl->session->ciphersuite;
Glenn Strauss8f526902022-01-13 00:04:49 -05003108}
3109
Gilles Peskine449bd832023-01-11 14:50:10 +01003110const char *mbedtls_ssl_get_ciphersuite(const mbedtls_ssl_context *ssl)
Paul Bakker72f62662011-01-16 21:27:44 +00003111{
Gilles Peskine449bd832023-01-11 14:50:10 +01003112 if (ssl == NULL || ssl->session == NULL) {
3113 return NULL;
3114 }
Paul Bakker926c8e42013-03-06 10:23:34 +01003115
Gilles Peskine449bd832023-01-11 14:50:10 +01003116 return mbedtls_ssl_get_ciphersuite_name(ssl->session->ciphersuite);
Paul Bakker72f62662011-01-16 21:27:44 +00003117}
3118
Gilles Peskine449bd832023-01-11 14:50:10 +01003119const char *mbedtls_ssl_get_version(const mbedtls_ssl_context *ssl)
Paul Bakker43ca69c2011-01-15 17:35:19 +00003120{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003121#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003122 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
3123 switch (ssl->tls_version) {
Glenn Strauss60bfe602022-03-14 19:04:24 -04003124 case MBEDTLS_SSL_VERSION_TLS1_2:
Gilles Peskine449bd832023-01-11 14:50:10 +01003125 return "DTLSv1.2";
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01003126 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01003127 return "unknown (DTLS)";
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01003128 }
3129 }
3130#endif
3131
Gilles Peskine449bd832023-01-11 14:50:10 +01003132 switch (ssl->tls_version) {
Glenn Strauss60bfe602022-03-14 19:04:24 -04003133 case MBEDTLS_SSL_VERSION_TLS1_2:
Gilles Peskine449bd832023-01-11 14:50:10 +01003134 return "TLSv1.2";
Glenn Strauss60bfe602022-03-14 19:04:24 -04003135 case MBEDTLS_SSL_VERSION_TLS1_3:
Gilles Peskine449bd832023-01-11 14:50:10 +01003136 return "TLSv1.3";
Paul Bakker43ca69c2011-01-15 17:35:19 +00003137 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01003138 return "unknown";
Paul Bakker43ca69c2011-01-15 17:35:19 +00003139 }
Paul Bakker43ca69c2011-01-15 17:35:19 +00003140}
3141
Waleed Elmelegy6a971fd2023-12-28 17:48:16 +00003142#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
3143
3144size_t mbedtls_ssl_get_output_record_size_limit(const mbedtls_ssl_context *ssl)
3145{
3146 const size_t max_len = MBEDTLS_SSL_OUT_CONTENT_LEN;
3147 size_t record_size_limit = max_len;
3148
3149 if (ssl->session != NULL &&
3150 ssl->session->record_size_limit >= MBEDTLS_SSL_RECORD_SIZE_LIMIT_MIN &&
3151 ssl->session->record_size_limit < max_len) {
3152 record_size_limit = ssl->session->record_size_limit;
3153 }
3154
3155 // TODO: this is currently untested
3156 /* During a handshake, use the value being negotiated */
3157 if (ssl->session_negotiate != NULL &&
3158 ssl->session_negotiate->record_size_limit >= MBEDTLS_SSL_RECORD_SIZE_LIMIT_MIN &&
3159 ssl->session_negotiate->record_size_limit < max_len) {
3160 record_size_limit = ssl->session_negotiate->record_size_limit;
3161 }
3162
3163 return record_size_limit;
3164}
3165#endif /* MBEDTLS_SSL_RECORD_SIZE_LIMIT */
3166
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02003167#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01003168size_t mbedtls_ssl_get_input_max_frag_len(const mbedtls_ssl_context *ssl)
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003169{
David Horstmann95d516f2021-05-04 18:36:56 +01003170 size_t max_len = MBEDTLS_SSL_IN_CONTENT_LEN;
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003171 size_t read_mfl;
3172
Jerry Yuddda0502022-12-01 19:43:12 +08003173#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003174 /* Use the configured MFL for the client if we're past SERVER_HELLO_DONE */
Gilles Peskine449bd832023-01-11 14:50:10 +01003175 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
3176 ssl->state >= MBEDTLS_SSL_SERVER_HELLO_DONE) {
3177 return ssl_mfl_code_to_length(ssl->conf->mfl_code);
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003178 }
Jerry Yuddda0502022-12-01 19:43:12 +08003179#endif
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003180
3181 /* Check if a smaller max length was negotiated */
Gilles Peskine449bd832023-01-11 14:50:10 +01003182 if (ssl->session_out != NULL) {
3183 read_mfl = ssl_mfl_code_to_length(ssl->session_out->mfl_code);
3184 if (read_mfl < max_len) {
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003185 max_len = read_mfl;
3186 }
3187 }
3188
Jerry Yuddda0502022-12-01 19:43:12 +08003189 /* During a handshake, use the value being negotiated */
Gilles Peskine449bd832023-01-11 14:50:10 +01003190 if (ssl->session_negotiate != NULL) {
3191 read_mfl = ssl_mfl_code_to_length(ssl->session_negotiate->mfl_code);
3192 if (read_mfl < max_len) {
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003193 max_len = read_mfl;
3194 }
3195 }
3196
Gilles Peskine449bd832023-01-11 14:50:10 +01003197 return max_len;
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003198}
3199
Gilles Peskine449bd832023-01-11 14:50:10 +01003200size_t mbedtls_ssl_get_output_max_frag_len(const mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02003201{
3202 size_t max_len;
3203
3204 /*
3205 * Assume mfl_code is correct since it was checked when set
3206 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003207 max_len = ssl_mfl_code_to_length(ssl->conf->mfl_code);
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02003208
Manuel Pégourié-Gonnard2cb17e22017-09-19 13:00:47 +02003209 /* Check if a smaller max length was negotiated */
Gilles Peskine449bd832023-01-11 14:50:10 +01003210 if (ssl->session_out != NULL &&
3211 ssl_mfl_code_to_length(ssl->session_out->mfl_code) < max_len) {
3212 max_len = ssl_mfl_code_to_length(ssl->session_out->mfl_code);
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02003213 }
3214
Manuel Pégourié-Gonnard2cb17e22017-09-19 13:00:47 +02003215 /* During a handshake, use the value being negotiated */
Gilles Peskine449bd832023-01-11 14:50:10 +01003216 if (ssl->session_negotiate != NULL &&
3217 ssl_mfl_code_to_length(ssl->session_negotiate->mfl_code) < max_len) {
3218 max_len = ssl_mfl_code_to_length(ssl->session_negotiate->mfl_code);
Manuel Pégourié-Gonnard2cb17e22017-09-19 13:00:47 +02003219 }
3220
Gilles Peskine449bd832023-01-11 14:50:10 +01003221 return max_len;
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02003222}
3223#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
3224
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003225#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003226size_t mbedtls_ssl_get_current_mtu(const mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003227{
Andrzej Kurekef43ce62018-10-09 08:24:12 -04003228 /* Return unlimited mtu for client hello messages to avoid fragmentation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01003229 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
3230 (ssl->state == MBEDTLS_SSL_CLIENT_HELLO ||
3231 ssl->state == MBEDTLS_SSL_SERVER_HELLO)) {
3232 return 0;
3233 }
Andrzej Kurekef43ce62018-10-09 08:24:12 -04003234
Gilles Peskine449bd832023-01-11 14:50:10 +01003235 if (ssl->handshake == NULL || ssl->handshake->mtu == 0) {
3236 return ssl->mtu;
3237 }
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003238
Gilles Peskine449bd832023-01-11 14:50:10 +01003239 if (ssl->mtu == 0) {
3240 return ssl->handshake->mtu;
3241 }
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003242
Gilles Peskine449bd832023-01-11 14:50:10 +01003243 return ssl->mtu < ssl->handshake->mtu ?
3244 ssl->mtu : ssl->handshake->mtu;
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003245}
3246#endif /* MBEDTLS_SSL_PROTO_DTLS */
3247
Gilles Peskine449bd832023-01-11 14:50:10 +01003248int mbedtls_ssl_get_max_out_record_payload(const mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003249{
3250 size_t max_len = MBEDTLS_SSL_OUT_CONTENT_LEN;
3251
Manuel Pégourié-Gonnard000281e2018-08-21 11:20:58 +02003252#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH) && \
Jan Brucknerf482dcc2023-03-15 09:09:06 +01003253 !defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT) && \
Manuel Pégourié-Gonnard000281e2018-08-21 11:20:58 +02003254 !defined(MBEDTLS_SSL_PROTO_DTLS)
3255 (void) ssl;
3256#endif
3257
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003258#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01003259 const size_t mfl = mbedtls_ssl_get_output_max_frag_len(ssl);
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003260
Gilles Peskine449bd832023-01-11 14:50:10 +01003261 if (max_len > mfl) {
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003262 max_len = mfl;
Gilles Peskine449bd832023-01-11 14:50:10 +01003263 }
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003264#endif
3265
Jan Brucknerf482dcc2023-03-15 09:09:06 +01003266#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
3267 const size_t record_size_limit = mbedtls_ssl_get_output_record_size_limit(ssl);
3268
3269 if (max_len > record_size_limit) {
3270 max_len = record_size_limit;
3271 }
3272#endif
3273
Waleed Elmelegy6a971fd2023-12-28 17:48:16 +00003274 if (ssl->transform_out != NULL &&
3275 ssl->transform_out->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Waleed Elmelegyf5017902024-01-09 14:18:34 +00003276 /*
3277 * In TLS 1.3 case, when records are protected, `max_len` as computed
3278 * above is the maximum length of the TLSInnerPlaintext structure that
3279 * along the plaintext payload contains the inner content type (one byte)
3280 * and some zero padding. Given the algorithm used for padding
3281 * in mbedtls_ssl_encrypt_buf(), compute the maximum length for
3282 * the plaintext payload. Round down to a multiple of
3283 * MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY and
3284 * subtract 1.
Waleed Elmelegy6a971fd2023-12-28 17:48:16 +00003285 */
3286 max_len = ((max_len / MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY) *
3287 MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY) - 1;
3288 }
3289
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003290#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003291 if (mbedtls_ssl_get_current_mtu(ssl) != 0) {
3292 const size_t mtu = mbedtls_ssl_get_current_mtu(ssl);
3293 const int ret = mbedtls_ssl_get_record_expansion(ssl);
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003294 const size_t overhead = (size_t) ret;
3295
Gilles Peskine449bd832023-01-11 14:50:10 +01003296 if (ret < 0) {
3297 return ret;
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003298 }
3299
Gilles Peskine449bd832023-01-11 14:50:10 +01003300 if (mtu <= overhead) {
3301 MBEDTLS_SSL_DEBUG_MSG(1, ("MTU too low for record expansion"));
3302 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
3303 }
3304
3305 if (max_len > mtu - overhead) {
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003306 max_len = mtu - overhead;
Gilles Peskine449bd832023-01-11 14:50:10 +01003307 }
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003308 }
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003309#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003310
Hanno Becker0defedb2018-08-10 12:35:02 +01003311#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH) && \
Waleed Elmelegy049cd302023-12-20 17:28:31 +00003312 !defined(MBEDTLS_SSL_PROTO_DTLS) && \
3313 !defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
Hanno Becker0defedb2018-08-10 12:35:02 +01003314 ((void) ssl);
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003315#endif
3316
Gilles Peskine449bd832023-01-11 14:50:10 +01003317 return (int) max_len;
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003318}
3319
Gilles Peskine449bd832023-01-11 14:50:10 +01003320int mbedtls_ssl_get_max_in_record_payload(const mbedtls_ssl_context *ssl)
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003321{
3322 size_t max_len = MBEDTLS_SSL_IN_CONTENT_LEN;
3323
3324#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
3325 (void) ssl;
3326#endif
3327
3328#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01003329 const size_t mfl = mbedtls_ssl_get_input_max_frag_len(ssl);
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003330
Gilles Peskine449bd832023-01-11 14:50:10 +01003331 if (max_len > mfl) {
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003332 max_len = mfl;
Gilles Peskine449bd832023-01-11 14:50:10 +01003333 }
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003334#endif
3335
Gilles Peskine449bd832023-01-11 14:50:10 +01003336 return (int) max_len;
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003337}
3338
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003339#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01003340const mbedtls_x509_crt *mbedtls_ssl_get_peer_cert(const mbedtls_ssl_context *ssl)
Paul Bakkerb0550d92012-10-30 07:51:03 +00003341{
Gilles Peskine449bd832023-01-11 14:50:10 +01003342 if (ssl == NULL || ssl->session == NULL) {
3343 return NULL;
3344 }
Paul Bakkerb0550d92012-10-30 07:51:03 +00003345
Hanno Beckere6824572019-02-07 13:18:46 +00003346#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01003347 return ssl->session->peer_cert;
Hanno Beckere6824572019-02-07 13:18:46 +00003348#else
Gilles Peskine449bd832023-01-11 14:50:10 +01003349 return NULL;
Hanno Beckere6824572019-02-07 13:18:46 +00003350#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Paul Bakkerb0550d92012-10-30 07:51:03 +00003351}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003352#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkerb0550d92012-10-30 07:51:03 +00003353
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003354#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01003355int mbedtls_ssl_get_session(const mbedtls_ssl_context *ssl,
3356 mbedtls_ssl_session *dst)
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003357{
Hanno Beckere810bbc2021-05-14 16:01:05 +01003358 int ret;
3359
Gilles Peskine449bd832023-01-11 14:50:10 +01003360 if (ssl == NULL ||
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003361 dst == NULL ||
3362 ssl->session == NULL ||
Gilles Peskine449bd832023-01-11 14:50:10 +01003363 ssl->conf->endpoint != MBEDTLS_SSL_IS_CLIENT) {
3364 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003365 }
3366
Hanno Beckere810bbc2021-05-14 16:01:05 +01003367 /* Since Mbed TLS 3.0, mbedtls_ssl_get_session() is no longer
3368 * idempotent: Each session can only be exported once.
3369 *
3370 * (This is in preparation for TLS 1.3 support where we will
3371 * need the ability to export multiple sessions (aka tickets),
3372 * which will be achieved by calling mbedtls_ssl_get_session()
3373 * multiple times until it fails.)
3374 *
3375 * Check whether we have already exported the current session,
3376 * and fail if so.
3377 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003378 if (ssl->session->exported == 1) {
3379 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
3380 }
Hanno Beckere810bbc2021-05-14 16:01:05 +01003381
Gilles Peskine449bd832023-01-11 14:50:10 +01003382 ret = mbedtls_ssl_session_copy(dst, ssl->session);
3383 if (ret != 0) {
3384 return ret;
3385 }
Hanno Beckere810bbc2021-05-14 16:01:05 +01003386
3387 /* Remember that we've exported the session. */
3388 ssl->session->exported = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01003389 return 0;
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003390}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003391#endif /* MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003392
David Horstmanncb01b362024-02-29 17:31:46 +00003393#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
3394
3395/* Serialization of TLS 1.2 sessions
David Horstmanne59f9702024-02-29 16:08:57 +00003396 *
David Horstmanncb01b362024-02-29 17:31:46 +00003397 * For more detail, see the description of ssl_session_save().
David Horstmanne59f9702024-02-29 16:08:57 +00003398 */
3399static size_t ssl_tls12_session_save(const mbedtls_ssl_session *session,
3400 unsigned char *buf,
3401 size_t buf_len)
3402{
3403 unsigned char *p = buf;
3404 size_t used = 0;
3405
3406#if defined(MBEDTLS_HAVE_TIME)
3407 uint64_t start;
3408#endif
3409#if defined(MBEDTLS_X509_CRT_PARSE_C)
3410#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
3411 size_t cert_len;
3412#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3413#endif /* MBEDTLS_X509_CRT_PARSE_C */
3414
3415 /*
3416 * Time
3417 */
3418#if defined(MBEDTLS_HAVE_TIME)
3419 used += 8;
3420
3421 if (used <= buf_len) {
3422 start = (uint64_t) session->start;
3423
3424 MBEDTLS_PUT_UINT64_BE(start, p, 0);
3425 p += 8;
3426 }
3427#endif /* MBEDTLS_HAVE_TIME */
3428
3429 /*
3430 * Basic mandatory fields
3431 */
3432 used += 1 /* id_len */
3433 + sizeof(session->id)
3434 + sizeof(session->master)
3435 + 4; /* verify_result */
3436
3437 if (used <= buf_len) {
3438 *p++ = MBEDTLS_BYTE_0(session->id_len);
3439 memcpy(p, session->id, 32);
3440 p += 32;
3441
3442 memcpy(p, session->master, 48);
3443 p += 48;
3444
3445 MBEDTLS_PUT_UINT32_BE(session->verify_result, p, 0);
3446 p += 4;
3447 }
3448
3449 /*
3450 * Peer's end-entity certificate
3451 */
3452#if defined(MBEDTLS_X509_CRT_PARSE_C)
3453#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
3454 if (session->peer_cert == NULL) {
3455 cert_len = 0;
3456 } else {
3457 cert_len = session->peer_cert->raw.len;
3458 }
3459
3460 used += 3 + cert_len;
3461
3462 if (used <= buf_len) {
3463 *p++ = MBEDTLS_BYTE_2(cert_len);
3464 *p++ = MBEDTLS_BYTE_1(cert_len);
3465 *p++ = MBEDTLS_BYTE_0(cert_len);
3466
3467 if (session->peer_cert != NULL) {
3468 memcpy(p, session->peer_cert->raw.p, cert_len);
3469 p += cert_len;
3470 }
3471 }
3472#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3473 if (session->peer_cert_digest != NULL) {
3474 used += 1 /* type */ + 1 /* length */ + session->peer_cert_digest_len;
3475 if (used <= buf_len) {
3476 *p++ = (unsigned char) session->peer_cert_digest_type;
3477 *p++ = (unsigned char) session->peer_cert_digest_len;
3478 memcpy(p, session->peer_cert_digest,
3479 session->peer_cert_digest_len);
3480 p += session->peer_cert_digest_len;
3481 }
3482 } else {
3483 used += 2;
3484 if (used <= buf_len) {
3485 *p++ = (unsigned char) MBEDTLS_MD_NONE;
3486 *p++ = 0;
3487 }
3488 }
3489#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3490#endif /* MBEDTLS_X509_CRT_PARSE_C */
3491
3492 /*
3493 * Session ticket if any, plus associated data
3494 */
3495#if defined(MBEDTLS_SSL_SESSION_TICKETS)
3496#if defined(MBEDTLS_SSL_CLI_C)
3497 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
3498 used += 3 + session->ticket_len + 4; /* len + ticket + lifetime */
3499
3500 if (used <= buf_len) {
3501 *p++ = MBEDTLS_BYTE_2(session->ticket_len);
3502 *p++ = MBEDTLS_BYTE_1(session->ticket_len);
3503 *p++ = MBEDTLS_BYTE_0(session->ticket_len);
3504
3505 if (session->ticket != NULL) {
3506 memcpy(p, session->ticket, session->ticket_len);
3507 p += session->ticket_len;
3508 }
3509
3510 MBEDTLS_PUT_UINT32_BE(session->ticket_lifetime, p, 0);
3511 p += 4;
3512 }
3513 }
3514#endif /* MBEDTLS_SSL_CLI_C */
3515#if defined(MBEDTLS_HAVE_TIME) && defined(MBEDTLS_SSL_SRV_C)
3516 if (session->endpoint == MBEDTLS_SSL_IS_SERVER) {
3517 used += 8;
3518
3519 if (used <= buf_len) {
3520 MBEDTLS_PUT_UINT64_BE((uint64_t) session->ticket_creation_time, p, 0);
3521 p += 8;
3522 }
3523 }
3524#endif /* MBEDTLS_HAVE_TIME && MBEDTLS_SSL_SRV_C */
3525#endif /* MBEDTLS_SSL_SESSION_TICKETS */
3526
3527 /*
3528 * Misc extension-related info
3529 */
3530#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
3531 used += 1;
3532
3533 if (used <= buf_len) {
3534 *p++ = session->mfl_code;
3535 }
3536#endif
3537
3538#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
3539 used += 1;
3540
3541 if (used <= buf_len) {
3542 *p++ = MBEDTLS_BYTE_0(session->encrypt_then_mac);
3543 }
3544#endif
3545
3546 return used;
3547}
3548
3549MBEDTLS_CHECK_RETURN_CRITICAL
3550static int ssl_tls12_session_load(mbedtls_ssl_session *session,
3551 const unsigned char *buf,
3552 size_t len)
3553{
3554#if defined(MBEDTLS_HAVE_TIME)
3555 uint64_t start;
3556#endif
3557#if defined(MBEDTLS_X509_CRT_PARSE_C)
3558#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
3559 size_t cert_len;
3560#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3561#endif /* MBEDTLS_X509_CRT_PARSE_C */
3562
3563 const unsigned char *p = buf;
3564 const unsigned char * const end = buf + len;
3565
3566 /*
3567 * Time
3568 */
3569#if defined(MBEDTLS_HAVE_TIME)
3570 if (8 > (size_t) (end - p)) {
3571 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3572 }
3573
3574 start = MBEDTLS_GET_UINT64_BE(p, 0);
3575 p += 8;
3576
3577 session->start = (time_t) start;
3578#endif /* MBEDTLS_HAVE_TIME */
3579
3580 /*
3581 * Basic mandatory fields
3582 */
3583 if (1 + 32 + 48 + 4 > (size_t) (end - p)) {
3584 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3585 }
3586
3587 session->id_len = *p++;
3588 memcpy(session->id, p, 32);
3589 p += 32;
3590
3591 memcpy(session->master, p, 48);
3592 p += 48;
3593
3594 session->verify_result = MBEDTLS_GET_UINT32_BE(p, 0);
3595 p += 4;
3596
3597 /* Immediately clear invalid pointer values that have been read, in case
3598 * we exit early before we replaced them with valid ones. */
3599#if defined(MBEDTLS_X509_CRT_PARSE_C)
3600#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
3601 session->peer_cert = NULL;
3602#else
3603 session->peer_cert_digest = NULL;
3604#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3605#endif /* MBEDTLS_X509_CRT_PARSE_C */
3606#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
3607 session->ticket = NULL;
3608#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
3609
3610 /*
3611 * Peer certificate
3612 */
3613#if defined(MBEDTLS_X509_CRT_PARSE_C)
3614#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
3615 /* Deserialize CRT from the end of the ticket. */
3616 if (3 > (size_t) (end - p)) {
3617 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3618 }
3619
3620 cert_len = MBEDTLS_GET_UINT24_BE(p, 0);
3621 p += 3;
3622
3623 if (cert_len != 0) {
3624 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
3625
3626 if (cert_len > (size_t) (end - p)) {
3627 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3628 }
3629
3630 session->peer_cert = mbedtls_calloc(1, sizeof(mbedtls_x509_crt));
3631
3632 if (session->peer_cert == NULL) {
3633 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
3634 }
3635
3636 mbedtls_x509_crt_init(session->peer_cert);
3637
3638 if ((ret = mbedtls_x509_crt_parse_der(session->peer_cert,
3639 p, cert_len)) != 0) {
3640 mbedtls_x509_crt_free(session->peer_cert);
3641 mbedtls_free(session->peer_cert);
3642 session->peer_cert = NULL;
3643 return ret;
3644 }
3645
3646 p += cert_len;
3647 }
3648#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3649 /* Deserialize CRT digest from the end of the ticket. */
3650 if (2 > (size_t) (end - p)) {
3651 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3652 }
3653
3654 session->peer_cert_digest_type = (mbedtls_md_type_t) *p++;
3655 session->peer_cert_digest_len = (size_t) *p++;
3656
3657 if (session->peer_cert_digest_len != 0) {
3658 const mbedtls_md_info_t *md_info =
3659 mbedtls_md_info_from_type(session->peer_cert_digest_type);
3660 if (md_info == NULL) {
3661 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3662 }
3663 if (session->peer_cert_digest_len != mbedtls_md_get_size(md_info)) {
3664 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3665 }
3666
3667 if (session->peer_cert_digest_len > (size_t) (end - p)) {
3668 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3669 }
3670
3671 session->peer_cert_digest =
3672 mbedtls_calloc(1, session->peer_cert_digest_len);
3673 if (session->peer_cert_digest == NULL) {
3674 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
3675 }
3676
3677 memcpy(session->peer_cert_digest, p,
3678 session->peer_cert_digest_len);
3679 p += session->peer_cert_digest_len;
3680 }
3681#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3682#endif /* MBEDTLS_X509_CRT_PARSE_C */
3683
3684 /*
3685 * Session ticket and associated data
3686 */
3687#if defined(MBEDTLS_SSL_SESSION_TICKETS)
3688#if defined(MBEDTLS_SSL_CLI_C)
3689 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
3690 if (3 > (size_t) (end - p)) {
3691 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3692 }
3693
3694 session->ticket_len = MBEDTLS_GET_UINT24_BE(p, 0);
3695 p += 3;
3696
3697 if (session->ticket_len != 0) {
3698 if (session->ticket_len > (size_t) (end - p)) {
3699 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3700 }
3701
3702 session->ticket = mbedtls_calloc(1, session->ticket_len);
3703 if (session->ticket == NULL) {
3704 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
3705 }
3706
3707 memcpy(session->ticket, p, session->ticket_len);
3708 p += session->ticket_len;
3709 }
3710
3711 if (4 > (size_t) (end - p)) {
3712 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3713 }
3714
3715 session->ticket_lifetime = MBEDTLS_GET_UINT32_BE(p, 0);
3716 p += 4;
3717 }
3718#endif /* MBEDTLS_SSL_CLI_C */
3719#if defined(MBEDTLS_HAVE_TIME) && defined(MBEDTLS_SSL_SRV_C)
3720 if (session->endpoint == MBEDTLS_SSL_IS_SERVER) {
3721 if (8 > (size_t) (end - p)) {
3722 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3723 }
3724 session->ticket_creation_time = MBEDTLS_GET_UINT64_BE(p, 0);
3725 p += 8;
3726 }
3727#endif /* MBEDTLS_HAVE_TIME && MBEDTLS_SSL_SRV_C */
3728#endif /* MBEDTLS_SSL_SESSION_TICKETS */
3729
3730 /*
3731 * Misc extension-related info
3732 */
3733#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
3734 if (1 > (size_t) (end - p)) {
3735 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3736 }
3737
3738 session->mfl_code = *p++;
3739#endif
3740
3741#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
3742 if (1 > (size_t) (end - p)) {
3743 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3744 }
3745
3746 session->encrypt_then_mac = *p++;
3747#endif
3748
3749 /* Done, should have consumed entire buffer */
3750 if (p != end) {
3751 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3752 }
3753
3754 return 0;
3755}
3756
3757#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
3758
3759#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
3760/* Serialization of TLS 1.3 sessions:
3761 *
Waleed Elmelegy11025632024-03-07 15:25:52 +00003762 * For more detail, see the description of ssl_session_save().
David Horstmanne59f9702024-02-29 16:08:57 +00003763 */
3764#if defined(MBEDTLS_SSL_SESSION_TICKETS)
3765MBEDTLS_CHECK_RETURN_CRITICAL
3766static int ssl_tls13_session_save(const mbedtls_ssl_session *session,
3767 unsigned char *buf,
3768 size_t buf_len,
3769 size_t *olen)
3770{
3771 unsigned char *p = buf;
3772#if defined(MBEDTLS_SSL_CLI_C) && \
3773 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
3774 size_t hostname_len = (session->hostname == NULL) ?
3775 0 : strlen(session->hostname) + 1;
3776#endif
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003777
3778#if defined(MBEDTLS_SSL_SRV_C) && \
3779 defined(MBEDTLS_SSL_EARLY_DATA) && defined(MBEDTLS_SSL_ALPN)
Waleed Elmelegydaa4da72024-03-13 16:25:34 +00003780 const size_t alpn_len = (session->ticket_alpn == NULL) ?
Waleed Elmelegyb28ab0a2024-03-13 16:48:28 +00003781 0 : strlen(session->ticket_alpn) + 1;
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003782#endif
David Horstmanne59f9702024-02-29 16:08:57 +00003783 size_t needed = 4 /* ticket_age_add */
3784 + 1 /* ticket_flags */
3785 + 1; /* resumption_key length */
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003786
David Horstmanne59f9702024-02-29 16:08:57 +00003787 *olen = 0;
3788
3789 if (session->resumption_key_len > MBEDTLS_SSL_TLS1_3_TICKET_RESUMPTION_KEY_LEN) {
3790 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3791 }
3792 needed += session->resumption_key_len; /* resumption_key */
3793
3794#if defined(MBEDTLS_SSL_EARLY_DATA)
3795 needed += 4; /* max_early_data_size */
3796#endif
3797#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
3798 needed += 2; /* record_size_limit */
3799#endif /* MBEDTLS_SSL_RECORD_SIZE_LIMIT */
3800
3801#if defined(MBEDTLS_HAVE_TIME)
3802 needed += 8; /* ticket_creation_time or ticket_reception_time */
3803#endif
3804
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003805#if defined(MBEDTLS_SSL_SRV_C)
3806 if (session->endpoint == MBEDTLS_SSL_IS_SERVER) {
3807#if defined(MBEDTLS_SSL_EARLY_DATA) && defined(MBEDTLS_SSL_ALPN)
Waleed Elmelegydaa4da72024-03-13 16:25:34 +00003808 needed += 2 /* alpn_len */
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003809 + alpn_len; /* alpn */
3810#endif
3811 }
3812#endif /* MBEDTLS_SSL_SRV_C */
3813
David Horstmanne59f9702024-02-29 16:08:57 +00003814#if defined(MBEDTLS_SSL_CLI_C)
3815 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
3816#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
3817 needed += 2 /* hostname_len */
3818 + hostname_len; /* hostname */
3819#endif
3820
3821 needed += 4 /* ticket_lifetime */
3822 + 2; /* ticket_len */
3823
3824 /* Check size_t overflow */
3825 if (session->ticket_len > SIZE_MAX - needed) {
3826 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3827 }
3828
3829 needed += session->ticket_len; /* ticket */
3830 }
3831#endif /* MBEDTLS_SSL_CLI_C */
3832
3833 *olen = needed;
3834 if (needed > buf_len) {
3835 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
3836 }
3837
3838 MBEDTLS_PUT_UINT32_BE(session->ticket_age_add, p, 0);
3839 p[4] = session->ticket_flags;
3840
3841 /* save resumption_key */
3842 p[5] = session->resumption_key_len;
3843 p += 6;
3844 memcpy(p, session->resumption_key, session->resumption_key_len);
3845 p += session->resumption_key_len;
3846
3847#if defined(MBEDTLS_SSL_EARLY_DATA)
3848 MBEDTLS_PUT_UINT32_BE(session->max_early_data_size, p, 0);
3849 p += 4;
3850#endif
3851#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
3852 MBEDTLS_PUT_UINT16_BE(session->record_size_limit, p, 0);
3853 p += 2;
3854#endif /* MBEDTLS_SSL_RECORD_SIZE_LIMIT */
3855
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003856#if defined(MBEDTLS_SSL_SRV_C)
David Horstmanne59f9702024-02-29 16:08:57 +00003857 if (session->endpoint == MBEDTLS_SSL_IS_SERVER) {
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003858#if defined(MBEDTLS_HAVE_TIME)
David Horstmanne59f9702024-02-29 16:08:57 +00003859 MBEDTLS_PUT_UINT64_BE((uint64_t) session->ticket_creation_time, p, 0);
3860 p += 8;
David Horstmanne59f9702024-02-29 16:08:57 +00003861#endif /* MBEDTLS_HAVE_TIME */
3862
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003863#if defined(MBEDTLS_SSL_EARLY_DATA) && defined(MBEDTLS_SSL_ALPN)
Waleed Elmelegydaa4da72024-03-13 16:25:34 +00003864 MBEDTLS_PUT_UINT16_BE(alpn_len, p, 0);
3865 p += 2;
3866
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003867 if (alpn_len > 0) {
3868 /* save chosen alpn */
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00003869 memcpy(p, session->ticket_alpn, alpn_len);
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003870 p += alpn_len;
3871 }
3872#endif /* MBEDTLS_SSL_EARLY_DATA && MBEDTLS_SSL_ALPN */
3873 }
3874#endif /* MBEDTLS_SSL_SRV_C */
3875
David Horstmanne59f9702024-02-29 16:08:57 +00003876#if defined(MBEDTLS_SSL_CLI_C)
3877 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
3878#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
3879 MBEDTLS_PUT_UINT16_BE(hostname_len, p, 0);
3880 p += 2;
3881 if (hostname_len > 0) {
3882 /* save host name */
3883 memcpy(p, session->hostname, hostname_len);
3884 p += hostname_len;
3885 }
3886#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
3887
3888#if defined(MBEDTLS_HAVE_TIME)
3889 MBEDTLS_PUT_UINT64_BE((uint64_t) session->ticket_reception_time, p, 0);
3890 p += 8;
3891#endif
3892 MBEDTLS_PUT_UINT32_BE(session->ticket_lifetime, p, 0);
3893 p += 4;
3894
3895 MBEDTLS_PUT_UINT16_BE(session->ticket_len, p, 0);
3896 p += 2;
3897
3898 if (session->ticket != NULL && session->ticket_len > 0) {
3899 memcpy(p, session->ticket, session->ticket_len);
3900 p += session->ticket_len;
3901 }
3902 }
3903#endif /* MBEDTLS_SSL_CLI_C */
3904 return 0;
3905}
3906
3907MBEDTLS_CHECK_RETURN_CRITICAL
3908static int ssl_tls13_session_load(mbedtls_ssl_session *session,
3909 const unsigned char *buf,
3910 size_t len)
3911{
3912 const unsigned char *p = buf;
3913 const unsigned char *end = buf + len;
3914
3915 if (end - p < 6) {
3916 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3917 }
3918 session->ticket_age_add = MBEDTLS_GET_UINT32_BE(p, 0);
3919 session->ticket_flags = p[4];
3920
3921 /* load resumption_key */
3922 session->resumption_key_len = p[5];
3923 p += 6;
3924
3925 if (end - p < session->resumption_key_len) {
3926 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3927 }
3928
3929 if (sizeof(session->resumption_key) < session->resumption_key_len) {
3930 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3931 }
3932 memcpy(session->resumption_key, p, session->resumption_key_len);
3933 p += session->resumption_key_len;
3934
3935#if defined(MBEDTLS_SSL_EARLY_DATA)
3936 if (end - p < 4) {
3937 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3938 }
3939 session->max_early_data_size = MBEDTLS_GET_UINT32_BE(p, 0);
3940 p += 4;
3941#endif
3942#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
3943 if (end - p < 2) {
3944 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3945 }
3946 session->record_size_limit = MBEDTLS_GET_UINT16_BE(p, 0);
3947 p += 2;
3948#endif /* MBEDTLS_SSL_RECORD_SIZE_LIMIT */
3949
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003950#if defined(MBEDTLS_SSL_SRV_C)
David Horstmanne59f9702024-02-29 16:08:57 +00003951 if (session->endpoint == MBEDTLS_SSL_IS_SERVER) {
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003952#if defined(MBEDTLS_HAVE_TIME)
David Horstmanne59f9702024-02-29 16:08:57 +00003953 if (end - p < 8) {
3954 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3955 }
3956 session->ticket_creation_time = MBEDTLS_GET_UINT64_BE(p, 0);
3957 p += 8;
David Horstmanne59f9702024-02-29 16:08:57 +00003958#endif /* MBEDTLS_HAVE_TIME */
3959
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003960#if defined(MBEDTLS_SSL_EARLY_DATA) && defined(MBEDTLS_SSL_ALPN)
Waleed Elmelegydaa4da72024-03-13 16:25:34 +00003961 size_t alpn_len;
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003962
Waleed Elmelegydaa4da72024-03-13 16:25:34 +00003963 if (end - p < 2) {
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003964 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3965 }
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00003966
Waleed Elmelegydaa4da72024-03-13 16:25:34 +00003967 alpn_len = MBEDTLS_GET_UINT16_BE(p, 0);
3968 p += 2;
3969
3970 if (end - p < (long int) alpn_len) {
Waleed Elmelegy7dfba342024-03-12 16:22:39 +00003971 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3972 }
3973
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003974 if (alpn_len > 0) {
Waleed Elmelegydaa4da72024-03-13 16:25:34 +00003975 int ret = mbedtls_ssl_session_set_ticket_alpn(session, (char *) p);
3976 if (ret != 0) {
3977 return ret;
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003978 }
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003979 p += alpn_len;
3980 }
3981#endif /* MBEDTLS_SSL_EARLY_DATA && MBEDTLS_SSL_ALPN */
3982 }
3983#endif /* MBEDTLS_SSL_SRV_C */
3984
David Horstmanne59f9702024-02-29 16:08:57 +00003985#if defined(MBEDTLS_SSL_CLI_C)
3986 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
3987#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
3988 size_t hostname_len;
3989 /* load host name */
3990 if (end - p < 2) {
3991 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3992 }
3993 hostname_len = MBEDTLS_GET_UINT16_BE(p, 0);
3994 p += 2;
3995
3996 if (end - p < (long int) hostname_len) {
3997 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3998 }
3999 if (hostname_len > 0) {
4000 session->hostname = mbedtls_calloc(1, hostname_len);
4001 if (session->hostname == NULL) {
4002 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
4003 }
4004 memcpy(session->hostname, p, hostname_len);
4005 p += hostname_len;
4006 }
4007#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
4008
4009#if defined(MBEDTLS_HAVE_TIME)
4010 if (end - p < 8) {
4011 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4012 }
4013 session->ticket_reception_time = MBEDTLS_GET_UINT64_BE(p, 0);
4014 p += 8;
4015#endif
4016 if (end - p < 4) {
4017 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4018 }
4019 session->ticket_lifetime = MBEDTLS_GET_UINT32_BE(p, 0);
4020 p += 4;
4021
4022 if (end - p < 2) {
4023 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4024 }
4025 session->ticket_len = MBEDTLS_GET_UINT16_BE(p, 0);
4026 p += 2;
4027
4028 if (end - p < (long int) session->ticket_len) {
4029 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4030 }
4031 if (session->ticket_len > 0) {
4032 session->ticket = mbedtls_calloc(1, session->ticket_len);
4033 if (session->ticket == NULL) {
4034 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
4035 }
4036 memcpy(session->ticket, p, session->ticket_len);
4037 p += session->ticket_len;
4038 }
4039 }
4040#endif /* MBEDTLS_SSL_CLI_C */
4041
4042 return 0;
4043
4044}
4045#else /* MBEDTLS_SSL_SESSION_TICKETS */
4046MBEDTLS_CHECK_RETURN_CRITICAL
4047static int ssl_tls13_session_save(const mbedtls_ssl_session *session,
4048 unsigned char *buf,
4049 size_t buf_len,
4050 size_t *olen)
4051{
4052 ((void) session);
4053 ((void) buf);
4054 ((void) buf_len);
4055 *olen = 0;
4056 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
4057}
4058
4059static int ssl_tls13_session_load(const mbedtls_ssl_session *session,
Norbert Fabritiusd36913a2023-01-24 17:48:29 +01004060 const unsigned char *buf,
David Horstmanne59f9702024-02-29 16:08:57 +00004061 size_t buf_len)
4062{
4063 ((void) session);
4064 ((void) buf);
4065 ((void) buf_len);
4066 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
4067}
4068#endif /* !MBEDTLS_SSL_SESSION_TICKETS */
4069#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
4070
Paul Bakker5121ce52009-01-03 21:22:43 +00004071/*
Hanno Beckera835da52019-05-16 12:39:07 +01004072 * Define ticket header determining Mbed TLS version
4073 * and structure of the ticket.
4074 */
4075
Hanno Becker94ef3b32019-05-16 12:50:45 +01004076/*
Hanno Becker50b59662019-05-28 14:30:45 +01004077 * Define bitflag determining compile-time settings influencing
4078 * structure of serialized SSL sessions.
Hanno Becker94ef3b32019-05-16 12:50:45 +01004079 */
4080
Hanno Becker50b59662019-05-28 14:30:45 +01004081#if defined(MBEDTLS_HAVE_TIME)
Hanno Becker3e088662019-05-29 11:10:18 +01004082#define SSL_SERIALIZED_SESSION_CONFIG_TIME 1
Hanno Becker50b59662019-05-28 14:30:45 +01004083#else
Hanno Becker3e088662019-05-29 11:10:18 +01004084#define SSL_SERIALIZED_SESSION_CONFIG_TIME 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01004085#endif /* MBEDTLS_HAVE_TIME */
4086
4087#if defined(MBEDTLS_X509_CRT_PARSE_C)
Hanno Becker3e088662019-05-29 11:10:18 +01004088#define SSL_SERIALIZED_SESSION_CONFIG_CRT 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01004089#else
Hanno Becker3e088662019-05-29 11:10:18 +01004090#define SSL_SERIALIZED_SESSION_CONFIG_CRT 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01004091#endif /* MBEDTLS_X509_CRT_PARSE_C */
4092
David Horstmann5c5a32f2024-02-13 17:53:35 +00004093#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
David Horstmannf686f1d2024-03-01 11:20:32 +00004094#define SSL_SERIALIZED_SESSION_CONFIG_KEEP_PEER_CRT 1
David Horstmann5c5a32f2024-02-13 17:53:35 +00004095#else
David Horstmannf686f1d2024-03-01 11:20:32 +00004096#define SSL_SERIALIZED_SESSION_CONFIG_KEEP_PEER_CRT 0
David Horstmann5c5a32f2024-02-13 17:53:35 +00004097#endif /* MBEDTLS_SSL_SESSION_TICKETS */
4098
Hanno Becker94ef3b32019-05-16 12:50:45 +01004099#if defined(MBEDTLS_SSL_CLI_C) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Hanno Becker3e088662019-05-29 11:10:18 +01004100#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01004101#else
Hanno Becker3e088662019-05-29 11:10:18 +01004102#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01004103#endif /* MBEDTLS_SSL_CLI_C && MBEDTLS_SSL_SESSION_TICKETS */
4104
4105#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Hanno Becker3e088662019-05-29 11:10:18 +01004106#define SSL_SERIALIZED_SESSION_CONFIG_MFL 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01004107#else
Hanno Becker3e088662019-05-29 11:10:18 +01004108#define SSL_SERIALIZED_SESSION_CONFIG_MFL 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01004109#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
4110
Hanno Becker94ef3b32019-05-16 12:50:45 +01004111#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Hanno Becker3e088662019-05-29 11:10:18 +01004112#define SSL_SERIALIZED_SESSION_CONFIG_ETM 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01004113#else
Hanno Becker3e088662019-05-29 11:10:18 +01004114#define SSL_SERIALIZED_SESSION_CONFIG_ETM 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01004115#endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC */
4116
Hanno Becker94ef3b32019-05-16 12:50:45 +01004117#if defined(MBEDTLS_SSL_SESSION_TICKETS)
4118#define SSL_SERIALIZED_SESSION_CONFIG_TICKET 1
4119#else
4120#define SSL_SERIALIZED_SESSION_CONFIG_TICKET 0
4121#endif /* MBEDTLS_SSL_SESSION_TICKETS */
4122
David Horstmann92b258b2024-02-13 17:23:34 +00004123#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
4124#define SSL_SERIALIZED_SESSION_CONFIG_SNI 1
4125#else
4126#define SSL_SERIALIZED_SESSION_CONFIG_SNI 0
4127#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
4128
4129#if defined(MBEDTLS_SSL_EARLY_DATA)
4130#define SSL_SERIALIZED_SESSION_CONFIG_EARLY_DATA 1
4131#else
4132#define SSL_SERIALIZED_SESSION_CONFIG_EARLY_DATA 0
4133#endif /* MBEDTLS_SSL_EARLY_DATA */
4134
4135#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
4136#define SSL_SERIALIZED_SESSION_CONFIG_RECORD_SIZE 1
4137#else
4138#define SSL_SERIALIZED_SESSION_CONFIG_RECORD_SIZE 0
4139#endif /* MBEDTLS_SSL_RECORD_SIZE_LIMIT */
4140
Waleed Elmelegy7dfba342024-03-12 16:22:39 +00004141#if defined(MBEDTLS_SSL_ALPN) && defined(MBEDTLS_SSL_SRV_C) && \
4142 defined(MBEDTLS_SSL_EARLY_DATA)
Waleed Elmelegy11025632024-03-07 15:25:52 +00004143#define SSL_SERIALIZED_SESSION_CONFIG_ALPN 1
4144#else
4145#define SSL_SERIALIZED_SESSION_CONFIG_ALPN 0
4146#endif /* MBEDTLS_SSL_ALPN */
4147
Hanno Becker3e088662019-05-29 11:10:18 +01004148#define SSL_SERIALIZED_SESSION_CONFIG_TIME_BIT 0
4149#define SSL_SERIALIZED_SESSION_CONFIG_CRT_BIT 1
4150#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET_BIT 2
4151#define SSL_SERIALIZED_SESSION_CONFIG_MFL_BIT 3
Hanno Becker37bdbe62021-08-01 05:38:58 +01004152#define SSL_SERIALIZED_SESSION_CONFIG_ETM_BIT 4
4153#define SSL_SERIALIZED_SESSION_CONFIG_TICKET_BIT 5
David Horstmannf686f1d2024-03-01 11:20:32 +00004154#define SSL_SERIALIZED_SESSION_CONFIG_KEEP_PEER_CRT_BIT 6
David Horstmann92b258b2024-02-13 17:23:34 +00004155#define SSL_SERIALIZED_SESSION_CONFIG_SNI_BIT 7
4156#define SSL_SERIALIZED_SESSION_CONFIG_EARLY_DATA_BIT 8
4157#define SSL_SERIALIZED_SESSION_CONFIG_RECORD_SIZE_BIT 9
Waleed Elmelegy11025632024-03-07 15:25:52 +00004158#define SSL_SERIALIZED_SESSION_CONFIG_ALPN_BIT 10
Hanno Becker3e088662019-05-29 11:10:18 +01004159
Hanno Becker50b59662019-05-28 14:30:45 +01004160#define SSL_SERIALIZED_SESSION_CONFIG_BITFLAG \
Gilles Peskine449bd832023-01-11 14:50:10 +01004161 ((uint16_t) ( \
4162 (SSL_SERIALIZED_SESSION_CONFIG_TIME << SSL_SERIALIZED_SESSION_CONFIG_TIME_BIT) | \
4163 (SSL_SERIALIZED_SESSION_CONFIG_CRT << SSL_SERIALIZED_SESSION_CONFIG_CRT_BIT) | \
4164 (SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET << \
4165 SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET_BIT) | \
4166 (SSL_SERIALIZED_SESSION_CONFIG_MFL << SSL_SERIALIZED_SESSION_CONFIG_MFL_BIT) | \
4167 (SSL_SERIALIZED_SESSION_CONFIG_ETM << SSL_SERIALIZED_SESSION_CONFIG_ETM_BIT) | \
David Horstmann5c5a32f2024-02-13 17:53:35 +00004168 (SSL_SERIALIZED_SESSION_CONFIG_TICKET << SSL_SERIALIZED_SESSION_CONFIG_TICKET_BIT) | \
David Horstmann71fa1a92024-03-01 12:32:18 +00004169 (SSL_SERIALIZED_SESSION_CONFIG_KEEP_PEER_CRT << \
4170 SSL_SERIALIZED_SESSION_CONFIG_KEEP_PEER_CRT_BIT) | \
David Horstmann92b258b2024-02-13 17:23:34 +00004171 (SSL_SERIALIZED_SESSION_CONFIG_SNI << SSL_SERIALIZED_SESSION_CONFIG_SNI_BIT) | \
4172 (SSL_SERIALIZED_SESSION_CONFIG_EARLY_DATA << \
4173 SSL_SERIALIZED_SESSION_CONFIG_EARLY_DATA_BIT) | \
4174 (SSL_SERIALIZED_SESSION_CONFIG_RECORD_SIZE << \
Waleed Elmelegy11025632024-03-07 15:25:52 +00004175 SSL_SERIALIZED_SESSION_CONFIG_RECORD_SIZE_BIT) | \
Waleed Elmelegy75e33fa2024-03-07 16:57:58 +00004176 (SSL_SERIALIZED_SESSION_CONFIG_ALPN << \
Waleed Elmelegy11025632024-03-07 15:25:52 +00004177 SSL_SERIALIZED_SESSION_CONFIG_ALPN_BIT)))
Hanno Becker94ef3b32019-05-16 12:50:45 +01004178
Chien Wong4e9683e2023-12-28 17:07:43 +08004179static const unsigned char ssl_serialized_session_header[] = {
Hanno Becker94ef3b32019-05-16 12:50:45 +01004180 MBEDTLS_VERSION_MAJOR,
4181 MBEDTLS_VERSION_MINOR,
4182 MBEDTLS_VERSION_PATCH,
Gilles Peskine449bd832023-01-11 14:50:10 +01004183 MBEDTLS_BYTE_1(SSL_SERIALIZED_SESSION_CONFIG_BITFLAG),
4184 MBEDTLS_BYTE_0(SSL_SERIALIZED_SESSION_CONFIG_BITFLAG),
Hanno Beckerf8787072019-05-16 12:41:07 +01004185};
Hanno Beckera835da52019-05-16 12:39:07 +01004186
4187/*
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004188 * Serialize a session in the following format:
Manuel Pégourié-Gonnard35eb8022019-05-16 11:11:08 +02004189 * (in the presentation language of TLS, RFC 8446 section 3)
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004190 *
David Horstmanncb01b362024-02-29 17:31:46 +00004191 * TLS 1.2 session:
4192 *
4193 * struct {
4194 * #if defined(MBEDTLS_SSL_SESSION_TICKETS)
4195 * opaque ticket<0..2^24-1>; // length 0 means no ticket
4196 * uint32 ticket_lifetime;
4197 * #endif
4198 * } ClientOnlyData;
4199 *
4200 * struct {
4201 * #if defined(MBEDTLS_HAVE_TIME)
4202 * uint64 start_time;
4203 * #endif
4204 * uint8 session_id_len; // at most 32
4205 * opaque session_id[32];
4206 * opaque master[48]; // fixed length in the standard
4207 * uint32 verify_result;
4208 * #if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
4209 * opaque peer_cert<0..2^24-1>; // length 0 means no peer cert
4210 * #else
David Horstmann76ba26a2024-03-01 12:03:35 +00004211 * uint8 peer_cert_digest_type;
David Horstmanncb01b362024-02-29 17:31:46 +00004212 * opaque peer_cert_digest<0..2^8-1>
4213 * #endif
4214 * select (endpoint) {
4215 * case client: ClientOnlyData;
4216 * case server: uint64 ticket_creation_time;
4217 * };
4218 * #if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
4219 * uint8 mfl_code; // up to 255 according to standard
4220 * #endif
4221 * #if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
4222 * uint8 encrypt_then_mac; // 0 or 1
4223 * #endif
4224 * } serialized_session_tls12;
4225 *
4226 *
4227 * TLS 1.3 Session:
4228 *
4229 * struct {
4230 * #if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
4231 * opaque hostname<0..2^16-1>;
4232 * #endif
4233 * #if defined(MBEDTLS_HAVE_TIME)
4234 * uint64 ticket_reception_time;
4235 * #endif
4236 * uint32 ticket_lifetime;
4237 * opaque ticket<1..2^16-1>;
4238 * } ClientOnlyData;
4239 *
4240 * struct {
4241 * uint32 ticket_age_add;
4242 * uint8 ticket_flags;
4243 * opaque resumption_key<0..255>;
4244 * #if defined(MBEDTLS_SSL_EARLY_DATA)
4245 * uint32 max_early_data_size;
4246 * #endif
4247 * #if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
4248 * uint16 record_size_limit;
4249 * #endif
4250 * select ( endpoint ) {
4251 * case client: ClientOnlyData;
Waleed Elmelegy7dfba342024-03-12 16:22:39 +00004252 * case server:
David Horstmanncb01b362024-02-29 17:31:46 +00004253 * #if defined(MBEDTLS_HAVE_TIME)
Waleed Elmelegy7dfba342024-03-12 16:22:39 +00004254 * uint64 ticket_creation_time;
David Horstmanncb01b362024-02-29 17:31:46 +00004255 * #endif
Waleed Elmelegyfe9ae082024-03-07 15:47:31 +00004256 * #if defined(MBEDTLS_SSL_EARLY_DATA) && defined(MBEDTLS_SSL_ALPN)
Waleed Elmelegydaa4da72024-03-13 16:25:34 +00004257 * opaque ticket_alpn<0..256>;
Waleed Elmelegyfe9ae082024-03-07 15:47:31 +00004258 * #endif
David Horstmanncb01b362024-02-29 17:31:46 +00004259 * };
4260 * } serialized_session_tls13;
4261 *
4262 *
4263 * SSL session:
4264 *
4265 * struct {
Hanno Beckerdc28b6c2019-05-29 11:08:00 +01004266 *
Hanno Beckerdce50972021-08-01 05:39:23 +01004267 * opaque mbedtls_version[3]; // library version: major, minor, patch
4268 * opaque session_format[2]; // library-version specific 16-bit field
4269 * // determining the format of the remaining
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004270 * // serialized data.
Hanno Beckerdc28b6c2019-05-29 11:08:00 +01004271 *
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004272 * Note: When updating the format, remember to keep
4273 * these version+format bytes.
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004274 *
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004275 * // In this version, `session_format` determines
4276 * // the setting of those compile-time
4277 * // configuration options which influence
4278 * // the structure of mbedtls_ssl_session.
4279 *
Glenn Straussda7851c2022-03-14 13:29:48 -04004280 * uint8_t minor_ver; // Protocol minor version. Possible values:
Jerry Yu0c2a7382022-12-06 13:27:25 +08004281 * // - TLS 1.2 (0x0303)
4282 * // - TLS 1.3 (0x0304)
David Horstmann531aca22024-02-29 18:14:28 +00004283 * uint8_t endpoint;
4284 * uint16_t ciphersuite;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004285 *
Glenn Straussda7851c2022-03-14 13:29:48 -04004286 * select (serialized_session.tls_version) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004287 *
Glenn Straussda7851c2022-03-14 13:29:48 -04004288 * case MBEDTLS_SSL_VERSION_TLS1_2:
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004289 * serialized_session_tls12 data;
Jerry Yu0c2a7382022-12-06 13:27:25 +08004290 * case MBEDTLS_SSL_VERSION_TLS1_3:
Jerry Yuddda0502022-12-01 19:43:12 +08004291 * serialized_session_tls13 data;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004292 *
4293 * };
4294 *
4295 * } serialized_session;
4296 *
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004297 */
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004298
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004299MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004300static int ssl_session_save(const mbedtls_ssl_session *session,
4301 unsigned char omit_header,
4302 unsigned char *buf,
4303 size_t buf_len,
4304 size_t *olen)
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004305{
4306 unsigned char *p = buf;
4307 size_t used = 0;
Jerry Yu251a12e2022-07-13 15:15:48 +08004308 size_t remaining_len;
Jerry Yue36fdd62022-08-17 21:31:36 +08004309#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
4310 size_t out_len;
4311 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
4312#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01004313 if (session == NULL) {
4314 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
4315 }
Jerry Yu438ddd82022-07-07 06:55:50 +00004316
Gilles Peskine449bd832023-01-11 14:50:10 +01004317 if (!omit_header) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004318 /*
4319 * Add Mbed TLS version identifier
4320 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004321 used += sizeof(ssl_serialized_session_header);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004322
Gilles Peskine449bd832023-01-11 14:50:10 +01004323 if (used <= buf_len) {
4324 memcpy(p, ssl_serialized_session_header,
4325 sizeof(ssl_serialized_session_header));
4326 p += sizeof(ssl_serialized_session_header);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004327 }
4328 }
4329
4330 /*
Ronald Cron40a4ab02024-01-15 10:21:30 +01004331 * TLS version identifier, endpoint, ciphersuite
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004332 */
Ronald Cron40a4ab02024-01-15 10:21:30 +01004333 used += 1 /* TLS version */
4334 + 1 /* endpoint */
4335 + 2; /* ciphersuite */
Gilles Peskine449bd832023-01-11 14:50:10 +01004336 if (used <= buf_len) {
4337 *p++ = MBEDTLS_BYTE_0(session->tls_version);
Ronald Cron40a4ab02024-01-15 10:21:30 +01004338 *p++ = session->endpoint;
4339 MBEDTLS_PUT_UINT16_BE(session->ciphersuite, p, 0);
4340 p += 2;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004341 }
4342
4343 /* Forward to version-specific serialization routine. */
Jerry Yufca4d572022-07-21 10:37:48 +08004344 remaining_len = (buf_len >= used) ? buf_len - used : 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01004345 switch (session->tls_version) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004346#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01004347 case MBEDTLS_SSL_VERSION_TLS1_2:
4348 used += ssl_tls12_session_save(session, p, remaining_len);
4349 break;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004350#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
4351
Jerry Yu251a12e2022-07-13 15:15:48 +08004352#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004353 case MBEDTLS_SSL_VERSION_TLS1_3:
4354 ret = ssl_tls13_session_save(session, p, remaining_len, &out_len);
4355 if (ret != 0 && ret != MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL) {
4356 return ret;
4357 }
4358 used += out_len;
4359 break;
Jerry Yu251a12e2022-07-13 15:15:48 +08004360#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
4361
Gilles Peskine449bd832023-01-11 14:50:10 +01004362 default:
4363 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004364 }
4365
4366 *olen = used;
Gilles Peskine449bd832023-01-11 14:50:10 +01004367 if (used > buf_len) {
4368 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
4369 }
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004370
Gilles Peskine449bd832023-01-11 14:50:10 +01004371 return 0;
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004372}
4373
4374/*
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02004375 * Public wrapper for ssl_session_save()
4376 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004377int mbedtls_ssl_session_save(const mbedtls_ssl_session *session,
4378 unsigned char *buf,
4379 size_t buf_len,
4380 size_t *olen)
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02004381{
Gilles Peskine449bd832023-01-11 14:50:10 +01004382 return ssl_session_save(session, 0, buf, buf_len, olen);
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02004383}
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004384
Jerry Yuf1b23ca2022-02-18 11:48:47 +08004385/*
4386 * Deserialize session, see mbedtls_ssl_session_save() for format.
4387 *
4388 * This internal version is wrapped by a public function that cleans up in
4389 * case of error, and has an extra option omit_header.
4390 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004391MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004392static int ssl_session_load(mbedtls_ssl_session *session,
4393 unsigned char omit_header,
4394 const unsigned char *buf,
4395 size_t len)
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004396{
4397 const unsigned char *p = buf;
4398 const unsigned char * const end = buf + len;
Jerry Yu438ddd82022-07-07 06:55:50 +00004399 size_t remaining_len;
4400
4401
Gilles Peskine449bd832023-01-11 14:50:10 +01004402 if (session == NULL) {
4403 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
4404 }
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004405
Gilles Peskine449bd832023-01-11 14:50:10 +01004406 if (!omit_header) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004407 /*
4408 * Check Mbed TLS version identifier
4409 */
4410
Gilles Peskine449bd832023-01-11 14:50:10 +01004411 if ((size_t) (end - p) < sizeof(ssl_serialized_session_header)) {
4412 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004413 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004414
4415 if (memcmp(p, ssl_serialized_session_header,
4416 sizeof(ssl_serialized_session_header)) != 0) {
4417 return MBEDTLS_ERR_SSL_VERSION_MISMATCH;
4418 }
4419 p += sizeof(ssl_serialized_session_header);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004420 }
4421
4422 /*
Ronald Cron40a4ab02024-01-15 10:21:30 +01004423 * TLS version identifier, endpoint, ciphersuite
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004424 */
Ronald Cron40a4ab02024-01-15 10:21:30 +01004425 if (4 > (size_t) (end - p)) {
Gilles Peskine449bd832023-01-11 14:50:10 +01004426 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4427 }
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01004428 session->tls_version = (mbedtls_ssl_protocol_version) (0x0300 | *p++);
Ronald Cron40a4ab02024-01-15 10:21:30 +01004429 session->endpoint = *p++;
4430 session->ciphersuite = MBEDTLS_GET_UINT16_BE(p, 0);
4431 p += 2;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004432
4433 /* Dispatch according to TLS version. */
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00004434 remaining_len = (size_t) (end - p);
Gilles Peskine449bd832023-01-11 14:50:10 +01004435 switch (session->tls_version) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004436#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01004437 case MBEDTLS_SSL_VERSION_TLS1_2:
4438 return ssl_tls12_session_load(session, p, remaining_len);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004439#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
4440
Jerry Yu438ddd82022-07-07 06:55:50 +00004441#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004442 case MBEDTLS_SSL_VERSION_TLS1_3:
4443 return ssl_tls13_session_load(session, p, remaining_len);
Jerry Yu438ddd82022-07-07 06:55:50 +00004444#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
4445
Gilles Peskine449bd832023-01-11 14:50:10 +01004446 default:
4447 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004448 }
4449}
4450
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004451/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02004452 * Deserialize session: public wrapper for error cleaning
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02004453 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004454int mbedtls_ssl_session_load(mbedtls_ssl_session *session,
4455 const unsigned char *buf,
4456 size_t len)
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02004457{
Gilles Peskine449bd832023-01-11 14:50:10 +01004458 int ret = ssl_session_load(session, 0, buf, len);
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02004459
Gilles Peskine449bd832023-01-11 14:50:10 +01004460 if (ret != 0) {
4461 mbedtls_ssl_session_free(session);
4462 }
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02004463
Gilles Peskine449bd832023-01-11 14:50:10 +01004464 return ret;
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02004465}
4466
4467/*
Paul Bakker1961b702013-01-25 14:49:24 +01004468 * Perform a single step of the SSL handshake
Paul Bakker5121ce52009-01-03 21:22:43 +00004469 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004470MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004471static int ssl_prepare_handshake_step(mbedtls_ssl_context *ssl)
Hanno Becker41934dd2021-08-07 19:13:43 +01004472{
4473 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
4474
Ronald Cron66dbf912022-02-02 15:33:46 +01004475 /*
4476 * We may have not been able to send to the peer all the handshake data
Ronald Cron3f20b772022-03-08 16:00:02 +01004477 * that were written into the output buffer by the previous handshake step,
4478 * if the write to the network callback returned with the
Ronald Cron66dbf912022-02-02 15:33:46 +01004479 * #MBEDTLS_ERR_SSL_WANT_WRITE error code.
4480 * We proceed to the next handshake step only when all data from the
4481 * previous one have been sent to the peer, thus we make sure that this is
4482 * the case here by calling `mbedtls_ssl_flush_output()`. The function may
4483 * return with the #MBEDTLS_ERR_SSL_WANT_WRITE error code in which case
4484 * we have to wait before to go ahead.
4485 * In the case of TLS 1.3, handshake step handlers do not send data to the
4486 * peer. Data are only sent here and through
4487 * `mbedtls_ssl_handle_pending_alert` in case an error that triggered an
Andrzej Kurek5c65c572022-04-13 14:28:52 -04004488 * alert occurred.
Ronald Cron66dbf912022-02-02 15:33:46 +01004489 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004490 if ((ret = mbedtls_ssl_flush_output(ssl)) != 0) {
4491 return ret;
4492 }
Hanno Becker41934dd2021-08-07 19:13:43 +01004493
4494#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004495 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
4496 ssl->handshake->retransmit_state == MBEDTLS_SSL_RETRANS_SENDING) {
4497 if ((ret = mbedtls_ssl_flight_transmit(ssl)) != 0) {
4498 return ret;
4499 }
Hanno Becker41934dd2021-08-07 19:13:43 +01004500 }
4501#endif /* MBEDTLS_SSL_PROTO_DTLS */
4502
Gilles Peskine449bd832023-01-11 14:50:10 +01004503 return ret;
Hanno Becker41934dd2021-08-07 19:13:43 +01004504}
4505
Gilles Peskine449bd832023-01-11 14:50:10 +01004506int mbedtls_ssl_handshake_step(mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00004507{
Hanno Becker41934dd2021-08-07 19:13:43 +01004508 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00004509
Gilles Peskine449bd832023-01-11 14:50:10 +01004510 if (ssl == NULL ||
Hanno Becker41934dd2021-08-07 19:13:43 +01004511 ssl->conf == NULL ||
4512 ssl->handshake == NULL ||
Gilles Peskine449bd832023-01-11 14:50:10 +01004513 ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER) {
4514 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Becker41934dd2021-08-07 19:13:43 +01004515 }
4516
Gilles Peskine449bd832023-01-11 14:50:10 +01004517 ret = ssl_prepare_handshake_step(ssl);
4518 if (ret != 0) {
4519 return ret;
4520 }
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02004521
Gilles Peskine449bd832023-01-11 14:50:10 +01004522 ret = mbedtls_ssl_handle_pending_alert(ssl);
4523 if (ret != 0) {
Jerry Yue7047812021-09-13 19:26:39 +08004524 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01004525 }
Jerry Yue7047812021-09-13 19:26:39 +08004526
Tom Cosgrove2fdc7b32022-09-21 12:33:17 +01004527 /* If ssl->conf->endpoint is not one of MBEDTLS_SSL_IS_CLIENT or
4528 * MBEDTLS_SSL_IS_SERVER, this is the return code we give */
4529 ret = MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4530
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004531#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004532 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
4533 MBEDTLS_SSL_DEBUG_MSG(2, ("client state: %s",
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01004534 mbedtls_ssl_states_str((mbedtls_ssl_states) ssl->state)));
Jerry Yub9930e72021-08-06 17:11:51 +08004535
Gilles Peskine449bd832023-01-11 14:50:10 +01004536 switch (ssl->state) {
Ronald Cron9f0fba32022-02-10 16:45:15 +01004537 case MBEDTLS_SSL_HELLO_REQUEST:
4538 ssl->state = MBEDTLS_SSL_CLIENT_HELLO;
Tom Cosgrove87d9c6c2022-09-22 09:27:56 +01004539 ret = 0;
Ronald Cron9f0fba32022-02-10 16:45:15 +01004540 break;
Jerry Yub9930e72021-08-06 17:11:51 +08004541
Ronald Cron9f0fba32022-02-10 16:45:15 +01004542 case MBEDTLS_SSL_CLIENT_HELLO:
Gilles Peskine449bd832023-01-11 14:50:10 +01004543 ret = mbedtls_ssl_write_client_hello(ssl);
Ronald Cron9f0fba32022-02-10 16:45:15 +01004544 break;
4545
4546 default:
4547#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004548 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
4549 ret = mbedtls_ssl_tls13_handshake_client_step(ssl);
4550 } else {
4551 ret = mbedtls_ssl_handshake_client_step(ssl);
4552 }
Ronald Cron9f0fba32022-02-10 16:45:15 +01004553#elif defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01004554 ret = mbedtls_ssl_handshake_client_step(ssl);
Ronald Cron9f0fba32022-02-10 16:45:15 +01004555#else
Gilles Peskine449bd832023-01-11 14:50:10 +01004556 ret = mbedtls_ssl_tls13_handshake_client_step(ssl);
Ronald Cron9f0fba32022-02-10 16:45:15 +01004557#endif
4558 }
Jerry Yub9930e72021-08-06 17:11:51 +08004559 }
Ronald Cron6291b232023-03-08 15:51:25 +01004560#endif /* MBEDTLS_SSL_CLI_C */
4561
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004562#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004563 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Ronald Cron6291b232023-03-08 15:51:25 +01004564#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
4565 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Gilles Peskine449bd832023-01-11 14:50:10 +01004566 ret = mbedtls_ssl_tls13_handshake_server_step(ssl);
Ronald Cron6291b232023-03-08 15:51:25 +01004567 } else {
Gilles Peskine449bd832023-01-11 14:50:10 +01004568 ret = mbedtls_ssl_handshake_server_step(ssl);
4569 }
Ronald Cron6291b232023-03-08 15:51:25 +01004570#elif defined(MBEDTLS_SSL_PROTO_TLS1_2)
4571 ret = mbedtls_ssl_handshake_server_step(ssl);
4572#else
4573 ret = mbedtls_ssl_tls13_handshake_server_step(ssl);
Paul Bakker5121ce52009-01-03 21:22:43 +00004574#endif
Ronald Cron6291b232023-03-08 15:51:25 +01004575 }
4576#endif /* MBEDTLS_SSL_SRV_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00004577
Gilles Peskine449bd832023-01-11 14:50:10 +01004578 if (ret != 0) {
Jerry Yubbd5a3f2021-09-18 20:50:22 +08004579 /* handshake_step return error. And it is same
4580 * with alert_reason.
4581 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004582 if (ssl->send_alert) {
4583 ret = mbedtls_ssl_handle_pending_alert(ssl);
Jerry Yue7047812021-09-13 19:26:39 +08004584 goto cleanup;
4585 }
4586 }
4587
4588cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +01004589 return ret;
Paul Bakker1961b702013-01-25 14:49:24 +01004590}
4591
4592/*
4593 * Perform the SSL handshake
4594 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004595int mbedtls_ssl_handshake(mbedtls_ssl_context *ssl)
Paul Bakker1961b702013-01-25 14:49:24 +01004596{
4597 int ret = 0;
4598
Hanno Beckera817ea42020-10-20 15:20:23 +01004599 /* Sanity checks */
4600
Gilles Peskine449bd832023-01-11 14:50:10 +01004601 if (ssl == NULL || ssl->conf == NULL) {
4602 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4603 }
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02004604
Hanno Beckera817ea42020-10-20 15:20:23 +01004605#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004606 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
4607 (ssl->f_set_timer == NULL || ssl->f_get_timer == NULL)) {
4608 MBEDTLS_SSL_DEBUG_MSG(1, ("You must use "
4609 "mbedtls_ssl_set_timer_cb() for DTLS"));
4610 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Beckera817ea42020-10-20 15:20:23 +01004611 }
4612#endif /* MBEDTLS_SSL_PROTO_DTLS */
4613
Gilles Peskine449bd832023-01-11 14:50:10 +01004614 MBEDTLS_SSL_DEBUG_MSG(2, ("=> handshake"));
Paul Bakker1961b702013-01-25 14:49:24 +01004615
Hanno Beckera817ea42020-10-20 15:20:23 +01004616 /* Main handshake loop */
Gilles Peskine449bd832023-01-11 14:50:10 +01004617 while (ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER) {
4618 ret = mbedtls_ssl_handshake_step(ssl);
Paul Bakker1961b702013-01-25 14:49:24 +01004619
Gilles Peskine449bd832023-01-11 14:50:10 +01004620 if (ret != 0) {
Paul Bakker1961b702013-01-25 14:49:24 +01004621 break;
Gilles Peskine449bd832023-01-11 14:50:10 +01004622 }
Paul Bakker1961b702013-01-25 14:49:24 +01004623 }
4624
Gilles Peskine449bd832023-01-11 14:50:10 +01004625 MBEDTLS_SSL_DEBUG_MSG(2, ("<= handshake"));
Paul Bakker5121ce52009-01-03 21:22:43 +00004626
Gilles Peskine449bd832023-01-11 14:50:10 +01004627 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00004628}
4629
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004630#if defined(MBEDTLS_SSL_RENEGOTIATION)
4631#if defined(MBEDTLS_SSL_SRV_C)
Paul Bakker5121ce52009-01-03 21:22:43 +00004632/*
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004633 * Write HelloRequest to request renegotiation on server
Paul Bakker48916f92012-09-16 19:57:18 +00004634 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004635MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004636static int ssl_write_hello_request(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004637{
Janos Follath865b3eb2019-12-16 11:46:15 +00004638 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004639
Gilles Peskine449bd832023-01-11 14:50:10 +01004640 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write hello request"));
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004641
4642 ssl->out_msglen = 4;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004643 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
4644 ssl->out_msg[0] = MBEDTLS_SSL_HS_HELLO_REQUEST;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004645
Gilles Peskine449bd832023-01-11 14:50:10 +01004646 if ((ret = mbedtls_ssl_write_handshake_msg(ssl)) != 0) {
4647 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_handshake_msg", ret);
4648 return ret;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004649 }
4650
Gilles Peskine449bd832023-01-11 14:50:10 +01004651 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write hello request"));
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004652
Gilles Peskine449bd832023-01-11 14:50:10 +01004653 return 0;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004654}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004655#endif /* MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004656
4657/*
4658 * Actually renegotiate current connection, triggered by either:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004659 * - any side: calling mbedtls_ssl_renegotiate(),
4660 * - client: receiving a HelloRequest during mbedtls_ssl_read(),
4661 * - server: receiving any handshake message on server during mbedtls_ssl_read() after
Manuel Pégourié-Gonnard55e4ff22014-08-19 11:16:35 +02004662 * the initial handshake is completed.
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004663 * If the handshake doesn't complete due to waiting for I/O, it will continue
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004664 * during the next calls to mbedtls_ssl_renegotiate() or mbedtls_ssl_read() respectively.
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004665 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004666int mbedtls_ssl_start_renegotiation(mbedtls_ssl_context *ssl)
Paul Bakker48916f92012-09-16 19:57:18 +00004667{
Janos Follath865b3eb2019-12-16 11:46:15 +00004668 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker48916f92012-09-16 19:57:18 +00004669
Gilles Peskine449bd832023-01-11 14:50:10 +01004670 MBEDTLS_SSL_DEBUG_MSG(2, ("=> renegotiate"));
Paul Bakker48916f92012-09-16 19:57:18 +00004671
Gilles Peskine449bd832023-01-11 14:50:10 +01004672 if ((ret = ssl_handshake_init(ssl)) != 0) {
4673 return ret;
4674 }
Paul Bakker48916f92012-09-16 19:57:18 +00004675
Manuel Pégourié-Gonnard0557bd52014-08-19 19:18:39 +02004676 /* RFC 6347 4.2.2: "[...] the HelloRequest will have message_seq = 0 and
4677 * the ServerHello will have message_seq = 1" */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004678#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004679 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
4680 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING) {
4681 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02004682 ssl->handshake->out_msg_seq = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004683 } else {
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02004684 ssl->handshake->in_msg_seq = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004685 }
Manuel Pégourié-Gonnard0557bd52014-08-19 19:18:39 +02004686 }
4687#endif
4688
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004689 ssl->state = MBEDTLS_SSL_HELLO_REQUEST;
4690 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS;
Paul Bakker48916f92012-09-16 19:57:18 +00004691
Gilles Peskine449bd832023-01-11 14:50:10 +01004692 if ((ret = mbedtls_ssl_handshake(ssl)) != 0) {
4693 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_handshake", ret);
4694 return ret;
Paul Bakker48916f92012-09-16 19:57:18 +00004695 }
4696
Gilles Peskine449bd832023-01-11 14:50:10 +01004697 MBEDTLS_SSL_DEBUG_MSG(2, ("<= renegotiate"));
Paul Bakker48916f92012-09-16 19:57:18 +00004698
Gilles Peskine449bd832023-01-11 14:50:10 +01004699 return 0;
Paul Bakker48916f92012-09-16 19:57:18 +00004700}
4701
4702/*
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004703 * Renegotiate current connection on client,
4704 * or request renegotiation on server
4705 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004706int mbedtls_ssl_renegotiate(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004707{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004708 int ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004709
Gilles Peskine449bd832023-01-11 14:50:10 +01004710 if (ssl == NULL || ssl->conf == NULL) {
4711 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4712 }
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02004713
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004714#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004715 /* On server, just send the request */
Gilles Peskine449bd832023-01-11 14:50:10 +01004716 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
4717 if (mbedtls_ssl_is_handshake_over(ssl) == 0) {
4718 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4719 }
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004720
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004721 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_PENDING;
Manuel Pégourié-Gonnardf07f4212014-08-15 19:04:47 +02004722
4723 /* Did we already try/start sending HelloRequest? */
Gilles Peskine449bd832023-01-11 14:50:10 +01004724 if (ssl->out_left != 0) {
4725 return mbedtls_ssl_flush_output(ssl);
4726 }
Manuel Pégourié-Gonnardf07f4212014-08-15 19:04:47 +02004727
Gilles Peskine449bd832023-01-11 14:50:10 +01004728 return ssl_write_hello_request(ssl);
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004729 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004730#endif /* MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004731
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004732#if defined(MBEDTLS_SSL_CLI_C)
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004733 /*
4734 * On client, either start the renegotiation process or,
4735 * if already in progress, continue the handshake
4736 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004737 if (ssl->renego_status != MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS) {
4738 if (mbedtls_ssl_is_handshake_over(ssl) == 0) {
4739 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004740 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004741
4742 if ((ret = mbedtls_ssl_start_renegotiation(ssl)) != 0) {
4743 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_start_renegotiation", ret);
4744 return ret;
4745 }
4746 } else {
4747 if ((ret = mbedtls_ssl_handshake(ssl)) != 0) {
4748 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_handshake", ret);
4749 return ret;
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004750 }
4751 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004752#endif /* MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004753
Gilles Peskine449bd832023-01-11 14:50:10 +01004754 return ret;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004755}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004756#endif /* MBEDTLS_SSL_RENEGOTIATION */
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004757
Gilles Peskine449bd832023-01-11 14:50:10 +01004758void mbedtls_ssl_handshake_free(mbedtls_ssl_context *ssl)
Paul Bakker48916f92012-09-16 19:57:18 +00004759{
Gilles Peskine9b562d52018-04-25 20:32:43 +02004760 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
4761
Gilles Peskine449bd832023-01-11 14:50:10 +01004762 if (handshake == NULL) {
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004763 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01004764 }
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004765
Valerio Setti6f0441d2023-07-03 12:11:36 +02004766#if defined(MBEDTLS_PK_HAVE_ECC_KEYS)
Brett Warrene0edc842021-08-17 09:53:13 +01004767#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004768 if (ssl->handshake->group_list_heap_allocated) {
4769 mbedtls_free((void *) handshake->group_list);
4770 }
Brett Warrene0edc842021-08-17 09:53:13 +01004771 handshake->group_list = NULL;
4772#endif /* MBEDTLS_DEPRECATED_REMOVED */
Valerio Setti6f0441d2023-07-03 12:11:36 +02004773#endif /* MBEDTLS_PK_HAVE_ECC_KEYS */
Brett Warrene0edc842021-08-17 09:53:13 +01004774
Ronald Crone68ab4f2022-10-05 12:46:29 +02004775#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yuf017ee42022-01-12 15:49:48 +08004776#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004777 if (ssl->handshake->sig_algs_heap_allocated) {
4778 mbedtls_free((void *) handshake->sig_algs);
4779 }
Jerry Yuf017ee42022-01-12 15:49:48 +08004780 handshake->sig_algs = NULL;
4781#endif /* MBEDTLS_DEPRECATED_REMOVED */
Xiaofei Baic234ecf2022-02-08 09:59:23 +00004782#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004783 if (ssl->handshake->certificate_request_context) {
4784 mbedtls_free((void *) handshake->certificate_request_context);
Xiaofei Baic234ecf2022-02-08 09:59:23 +00004785 }
4786#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Ronald Crone68ab4f2022-10-05 12:46:29 +02004787#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Jerry Yuf017ee42022-01-12 15:49:48 +08004788
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02004789#if defined(MBEDTLS_SSL_ASYNC_PRIVATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01004790 if (ssl->conf->f_async_cancel != NULL && handshake->async_in_progress != 0) {
4791 ssl->conf->f_async_cancel(ssl);
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02004792 handshake->async_in_progress = 0;
4793 }
4794#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
4795
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01004796#if defined(MBEDTLS_MD_CAN_SHA256)
Andrzej Kurekeb342242019-01-29 09:14:33 -05004797#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01004798 psa_hash_abort(&handshake->fin_sha256_psa);
Andrzej Kurekeb342242019-01-29 09:14:33 -05004799#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01004800 mbedtls_md_free(&handshake->fin_sha256);
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02004801#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -05004802#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01004803#if defined(MBEDTLS_MD_CAN_SHA384)
Andrzej Kurekeb342242019-01-29 09:14:33 -05004804#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01004805 psa_hash_abort(&handshake->fin_sha384_psa);
Andrzej Kurekeb342242019-01-29 09:14:33 -05004806#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01004807 mbedtls_md_free(&handshake->fin_sha384);
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02004808#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -05004809#endif
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02004810
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004811#if defined(MBEDTLS_DHM_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004812 mbedtls_dhm_free(&handshake->dhm_ctx);
Paul Bakker48916f92012-09-16 19:57:18 +00004813#endif
Valerio Setti7aeec542023-07-05 18:57:21 +02004814#if !defined(MBEDTLS_USE_PSA_CRYPTO) && \
Valerio Setti6eb00542023-07-07 17:04:24 +02004815 defined(MBEDTLS_KEY_EXCHANGE_SOME_ECDH_OR_ECDHE_1_2_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004816 mbedtls_ecdh_free(&handshake->ecdh_ctx);
Paul Bakker61d113b2013-07-04 11:51:43 +02004817#endif
Valerio Setti02c25b52022-11-15 14:08:42 +01004818
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02004819#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Neil Armstrongca7d5062022-05-31 14:43:23 +02004820#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01004821 psa_pake_abort(&handshake->psa_pake_ctx);
Valerio Settieb3f7882022-12-08 18:42:58 +01004822 /*
4823 * Opaque keys are not stored in the handshake's data and it's the user
4824 * responsibility to destroy them. Clear ones, instead, are created by
4825 * the TLS library and should be destroyed at the same level
4826 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004827 if (!mbedtls_svc_key_id_is_null(handshake->psa_pake_password)) {
4828 psa_destroy_key(handshake->psa_pake_password);
Valerio Settieb3f7882022-12-08 18:42:58 +01004829 }
Neil Armstrongca7d5062022-05-31 14:43:23 +02004830 handshake->psa_pake_password = MBEDTLS_SVC_KEY_ID_INIT;
4831#else
Gilles Peskine449bd832023-01-11 14:50:10 +01004832 mbedtls_ecjpake_free(&handshake->ecjpake_ctx);
Neil Armstrongca7d5062022-05-31 14:43:23 +02004833#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard77c06462015-09-17 13:59:49 +02004834#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004835 mbedtls_free(handshake->ecjpake_cache);
Manuel Pégourié-Gonnard77c06462015-09-17 13:59:49 +02004836 handshake->ecjpake_cache = NULL;
4837 handshake->ecjpake_cache_len = 0;
4838#endif
Manuel Pégourié-Gonnard76cfd3f2015-09-15 12:10:54 +02004839#endif
Paul Bakker61d113b2013-07-04 11:51:43 +02004840
Valerio Setti7aeec542023-07-05 18:57:21 +02004841#if defined(MBEDTLS_KEY_EXCHANGE_SOME_ECDH_OR_ECDHE_ANY_ENABLED) || \
Valerio Setti45d56f32023-07-13 17:23:20 +02004842 defined(MBEDTLS_KEY_EXCHANGE_WITH_ECDSA_ANY_ENABLED) || \
Janos Follath4ae5c292016-02-10 11:27:43 +00004843 defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Paul Bakker9af723c2014-05-01 13:03:14 +02004844 /* explicit void pointer cast for buggy MS compiler */
Gilles Peskine449bd832023-01-11 14:50:10 +01004845 mbedtls_free((void *) handshake->curves_tls_id);
Manuel Pégourié-Gonnardd09453c2013-09-23 19:11:32 +02004846#endif
4847
Ronald Cron73fe8df2022-10-05 14:31:43 +02004848#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED)
Neil Armstrong501c9322022-05-03 09:35:09 +02004849#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01004850 if (!mbedtls_svc_key_id_is_null(ssl->handshake->psk_opaque)) {
Neil Armstrong501c9322022-05-03 09:35:09 +02004851 /* The maintenance of the external PSK key slot is the
4852 * user's responsibility. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004853 if (ssl->handshake->psk_opaque_is_internal) {
4854 psa_destroy_key(ssl->handshake->psk_opaque);
Neil Armstrong501c9322022-05-03 09:35:09 +02004855 ssl->handshake->psk_opaque_is_internal = 0;
4856 }
4857 ssl->handshake->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
4858 }
Neil Armstronge952a302022-05-03 10:22:14 +02004859#else
Gilles Peskine449bd832023-01-11 14:50:10 +01004860 if (handshake->psk != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01004861 mbedtls_zeroize_and_free(handshake->psk, handshake->psk_len);
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01004862 }
Neil Armstronge952a302022-05-03 10:22:14 +02004863#endif /* MBEDTLS_USE_PSA_CRYPTO */
Ronald Cron73fe8df2022-10-05 14:31:43 +02004864#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED */
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01004865
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004866#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
4867 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Manuel Pégourié-Gonnard83724542013-09-24 22:30:56 +02004868 /*
4869 * Free only the linked list wrapper, not the keys themselves
4870 * since the belong to the SNI callback
4871 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004872 ssl_key_cert_free(handshake->sni_key_cert);
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004873#endif /* MBEDTLS_X509_CRT_PARSE_C && MBEDTLS_SSL_SERVER_NAME_INDICATION */
Manuel Pégourié-Gonnard705fcca2013-09-23 20:04:20 +02004874
Gilles Peskineeccd8882020-03-10 12:19:08 +01004875#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004876 mbedtls_x509_crt_restart_free(&handshake->ecrs_ctx);
4877 if (handshake->ecrs_peer_cert != NULL) {
4878 mbedtls_x509_crt_free(handshake->ecrs_peer_cert);
4879 mbedtls_free(handshake->ecrs_peer_cert);
Hanno Becker3dad3112019-02-05 17:19:52 +00004880 }
Manuel Pégourié-Gonnard862cde52017-05-17 11:56:15 +02004881#endif
4882
Hanno Becker75173122019-02-06 16:18:31 +00004883#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
4884 !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01004885 mbedtls_pk_free(&handshake->peer_pubkey);
Hanno Becker75173122019-02-06 16:18:31 +00004886#endif /* MBEDTLS_X509_CRT_PARSE_C && !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
4887
XiaokangQian9b93c0d2022-02-09 06:02:25 +00004888#if defined(MBEDTLS_SSL_CLI_C) && \
Gilles Peskine449bd832023-01-11 14:50:10 +01004889 (defined(MBEDTLS_SSL_PROTO_DTLS) || defined(MBEDTLS_SSL_PROTO_TLS1_3))
4890 mbedtls_free(handshake->cookie);
XiaokangQian9b93c0d2022-02-09 06:02:25 +00004891#endif /* MBEDTLS_SSL_CLI_C &&
4892 ( MBEDTLS_SSL_PROTO_DTLS || MBEDTLS_SSL_PROTO_TLS1_3 ) */
XiaokangQian8499b6c2022-01-27 09:00:11 +00004893
4894#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004895 mbedtls_ssl_flight_free(handshake->flight);
4896 mbedtls_ssl_buffering_free(ssl);
XiaokangQian8499b6c2022-01-27 09:00:11 +00004897#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard74848812014-07-11 02:43:49 +02004898
Valerio Settiea59c432023-07-25 11:14:03 +02004899#if defined(MBEDTLS_KEY_EXCHANGE_SOME_XXDH_PSA_ANY_ENABLED)
Przemek Stekiel7ac93be2023-07-04 10:02:38 +02004900 if (handshake->xxdh_psa_privkey_is_external == 0) {
4901 psa_destroy_key(handshake->xxdh_psa_privkey);
Gilles Peskine449bd832023-01-11 14:50:10 +01004902 }
Valerio Settiea59c432023-07-25 11:14:03 +02004903#endif /* MBEDTLS_KEY_EXCHANGE_SOME_XXDH_PSA_ANY_ENABLED */
Hanno Becker4a63ed42019-01-08 11:39:35 +00004904
Ronald Cron6f135e12021-12-08 16:57:54 +01004905#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004906 mbedtls_ssl_transform_free(handshake->transform_handshake);
4907 mbedtls_free(handshake->transform_handshake);
Jerry Yu3d9b5902022-11-04 14:07:25 +08004908#if defined(MBEDTLS_SSL_EARLY_DATA)
Gilles Peskine449bd832023-01-11 14:50:10 +01004909 mbedtls_ssl_transform_free(handshake->transform_earlydata);
4910 mbedtls_free(handshake->transform_earlydata);
Jerry Yu3d9b5902022-11-04 14:07:25 +08004911#endif
Ronald Cron6f135e12021-12-08 16:57:54 +01004912#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yuba9c7272021-10-30 11:54:10 +08004913
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05004914
4915#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
4916 /* If the buffers are too big - reallocate. Because of the way Mbed TLS
4917 * processes datagrams and the fact that a datagram is allowed to have
4918 * several records in it, it is possible that the I/O buffers are not
4919 * empty at this stage */
Gilles Peskine449bd832023-01-11 14:50:10 +01004920 handle_buffer_resizing(ssl, 1, mbedtls_ssl_get_input_buflen(ssl),
4921 mbedtls_ssl_get_output_buflen(ssl));
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05004922#endif
Hanno Becker3aa186f2021-08-10 09:24:19 +01004923
Jerry Yuba9c7272021-10-30 11:54:10 +08004924 /* mbedtls_platform_zeroize MUST be last one in this function */
Gilles Peskine449bd832023-01-11 14:50:10 +01004925 mbedtls_platform_zeroize(handshake,
4926 sizeof(mbedtls_ssl_handshake_params));
Paul Bakker48916f92012-09-16 19:57:18 +00004927}
4928
Gilles Peskine449bd832023-01-11 14:50:10 +01004929void mbedtls_ssl_session_free(mbedtls_ssl_session *session)
Paul Bakker48916f92012-09-16 19:57:18 +00004930{
Gilles Peskine449bd832023-01-11 14:50:10 +01004931 if (session == NULL) {
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004932 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01004933 }
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004934
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004935#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004936 ssl_clear_peer_cert(session);
Paul Bakkered27a042013-04-18 22:46:23 +02004937#endif
Paul Bakker0a597072012-09-25 21:55:46 +00004938
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02004939#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
Xiaokang Qianbc663a02022-10-09 11:14:39 +00004940#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && \
4941 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01004942 mbedtls_free(session->hostname);
Xiaokang Qian281fd1b2022-09-20 11:35:41 +00004943#endif
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00004944 mbedtls_free(session->ticket);
4945#endif
4946
Waleed Elmelegy2824a202024-02-23 17:51:47 +00004947#if defined(MBEDTLS_SSL_EARLY_DATA) && defined(MBEDTLS_SSL_ALPN) && \
4948 defined(MBEDTLS_SSL_SRV_C)
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00004949 mbedtls_free(session->ticket_alpn);
Paul Bakkera503a632013-08-14 13:48:06 +02004950#endif
Manuel Pégourié-Gonnard75d44012013-08-02 14:44:04 +02004951
Gilles Peskine449bd832023-01-11 14:50:10 +01004952 mbedtls_platform_zeroize(session, sizeof(mbedtls_ssl_session));
Paul Bakker48916f92012-09-16 19:57:18 +00004953}
4954
Manuel Pégourié-Gonnard5c0e3772019-07-23 16:13:17 +02004955#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004956
4957#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
4958#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID 1u
4959#else
4960#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID 0u
4961#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
4962
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004963#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT 1u
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004964
4965#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
4966#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY 1u
4967#else
4968#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY 0u
4969#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
4970
4971#if defined(MBEDTLS_SSL_ALPN)
4972#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN 1u
4973#else
4974#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN 0u
4975#endif /* MBEDTLS_SSL_ALPN */
4976
4977#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID_BIT 0
4978#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT_BIT 1
4979#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY_BIT 2
4980#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN_BIT 3
4981
4982#define SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG \
Gilles Peskine449bd832023-01-11 14:50:10 +01004983 ((uint32_t) ( \
4984 (SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID << \
4985 SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID_BIT) | \
4986 (SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT << \
4987 SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT_BIT) | \
4988 (SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY << \
4989 SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY_BIT) | \
4990 (SSL_SERIALIZED_CONTEXT_CONFIG_ALPN << SSL_SERIALIZED_CONTEXT_CONFIG_ALPN_BIT) | \
4991 0u))
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004992
Chien Wong4e9683e2023-12-28 17:07:43 +08004993static const unsigned char ssl_serialized_context_header[] = {
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004994 MBEDTLS_VERSION_MAJOR,
4995 MBEDTLS_VERSION_MINOR,
4996 MBEDTLS_VERSION_PATCH,
Gilles Peskine449bd832023-01-11 14:50:10 +01004997 MBEDTLS_BYTE_1(SSL_SERIALIZED_SESSION_CONFIG_BITFLAG),
4998 MBEDTLS_BYTE_0(SSL_SERIALIZED_SESSION_CONFIG_BITFLAG),
4999 MBEDTLS_BYTE_2(SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG),
5000 MBEDTLS_BYTE_1(SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG),
5001 MBEDTLS_BYTE_0(SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG),
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005002};
5003
Paul Bakker5121ce52009-01-03 21:22:43 +00005004/*
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005005 * Serialize a full SSL context
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02005006 *
5007 * The format of the serialized data is:
5008 * (in the presentation language of TLS, RFC 8446 section 3)
5009 *
5010 * // header
5011 * opaque mbedtls_version[3]; // major, minor, patch
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005012 * opaque context_format[5]; // version-specific field determining
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02005013 * // the format of the remaining
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005014 * // serialized data.
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02005015 * Note: When updating the format, remember to keep these
5016 * version+format bytes. (We may make their size part of the API.)
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02005017 *
5018 * // session sub-structure
5019 * opaque session<1..2^32-1>; // see mbedtls_ssl_session_save()
5020 * // transform sub-structure
5021 * uint8 random[64]; // ServerHello.random+ClientHello.random
5022 * uint8 in_cid<0..2^8-1> // Connection ID: expected incoming value
5023 * uint8 out_cid<0..2^8-1> // Connection ID: outgoing value to use
5024 * // fields from ssl_context
5025 * uint32 badmac_seen; // DTLS: number of records with failing MAC
5026 * uint64 in_window_top; // DTLS: last validated record seq_num
5027 * uint64 in_window; // DTLS: bitmask for replay protection
5028 * uint8 disable_datagram_packing; // DTLS: only one record per datagram
5029 * uint64 cur_out_ctr; // Record layer: outgoing sequence number
5030 * uint16 mtu; // DTLS: path mtu (max outgoing fragment size)
5031 * uint8 alpn_chosen<0..2^8-1> // ALPN: negotiated application protocol
5032 *
5033 * Note that many fields of the ssl_context or sub-structures are not
5034 * serialized, as they fall in one of the following categories:
5035 *
5036 * 1. forced value (eg in_left must be 0)
5037 * 2. pointer to dynamically-allocated memory (eg session, transform)
5038 * 3. value can be re-derived from other data (eg session keys from MS)
5039 * 4. value was temporary (eg content of input buffer)
5040 * 5. value will be provided by the user again (eg I/O callbacks and context)
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005041 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005042int mbedtls_ssl_context_save(mbedtls_ssl_context *ssl,
5043 unsigned char *buf,
5044 size_t buf_len,
5045 size_t *olen)
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005046{
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005047 unsigned char *p = buf;
5048 size_t used = 0;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005049 size_t session_len;
5050 int ret = 0;
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005051
Manuel Pégourié-Gonnard1aaf6692019-07-10 14:14:05 +02005052 /*
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02005053 * Enforce usage restrictions, see "return BAD_INPUT_DATA" in
5054 * this function's documentation.
5055 *
5056 * These are due to assumptions/limitations in the implementation. Some of
5057 * them are likely to stay (no handshake in progress) some might go away
5058 * (only DTLS) but are currently used to simplify the implementation.
Manuel Pégourié-Gonnard1aaf6692019-07-10 14:14:05 +02005059 */
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02005060 /* The initial handshake must be over */
Gilles Peskine449bd832023-01-11 14:50:10 +01005061 if (mbedtls_ssl_is_handshake_over(ssl) == 0) {
5062 MBEDTLS_SSL_DEBUG_MSG(1, ("Initial handshake isn't over"));
5063 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03005064 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005065 if (ssl->handshake != NULL) {
5066 MBEDTLS_SSL_DEBUG_MSG(1, ("Handshake isn't completed"));
5067 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03005068 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02005069 /* Double-check that sub-structures are indeed ready */
Gilles Peskine449bd832023-01-11 14:50:10 +01005070 if (ssl->transform == NULL || ssl->session == NULL) {
5071 MBEDTLS_SSL_DEBUG_MSG(1, ("Serialised structures aren't ready"));
5072 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03005073 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02005074 /* There must be no pending incoming or outgoing data */
Gilles Peskine449bd832023-01-11 14:50:10 +01005075 if (mbedtls_ssl_check_pending(ssl) != 0) {
5076 MBEDTLS_SSL_DEBUG_MSG(1, ("There is pending incoming data"));
5077 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03005078 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005079 if (ssl->out_left != 0) {
5080 MBEDTLS_SSL_DEBUG_MSG(1, ("There is pending outgoing data"));
5081 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03005082 }
Dave Rodgman556e8a32022-12-06 16:31:25 +00005083 /* Protocol must be DTLS, not TLS */
Gilles Peskine449bd832023-01-11 14:50:10 +01005084 if (ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
5085 MBEDTLS_SSL_DEBUG_MSG(1, ("Only DTLS is supported"));
5086 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03005087 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02005088 /* Version must be 1.2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005089 if (ssl->tls_version != MBEDTLS_SSL_VERSION_TLS1_2) {
5090 MBEDTLS_SSL_DEBUG_MSG(1, ("Only version 1.2 supported"));
5091 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03005092 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02005093 /* We must be using an AEAD ciphersuite */
Gilles Peskine449bd832023-01-11 14:50:10 +01005094 if (mbedtls_ssl_transform_uses_aead(ssl->transform) != 1) {
5095 MBEDTLS_SSL_DEBUG_MSG(1, ("Only AEAD ciphersuites supported"));
5096 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03005097 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02005098 /* Renegotiation must not be enabled */
5099#if defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01005100 if (ssl->conf->disable_renegotiation != MBEDTLS_SSL_RENEGOTIATION_DISABLED) {
5101 MBEDTLS_SSL_DEBUG_MSG(1, ("Renegotiation must not be enabled"));
5102 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03005103 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02005104#endif
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005105
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005106 /*
5107 * Version and format identifier
5108 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005109 used += sizeof(ssl_serialized_context_header);
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005110
Gilles Peskine449bd832023-01-11 14:50:10 +01005111 if (used <= buf_len) {
5112 memcpy(p, ssl_serialized_context_header,
5113 sizeof(ssl_serialized_context_header));
5114 p += sizeof(ssl_serialized_context_header);
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005115 }
5116
5117 /*
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005118 * Session (length + data)
5119 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005120 ret = ssl_session_save(ssl->session, 1, NULL, 0, &session_len);
5121 if (ret != MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL) {
5122 return ret;
5123 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005124
5125 used += 4 + session_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01005126 if (used <= buf_len) {
5127 MBEDTLS_PUT_UINT32_BE(session_len, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01005128 p += 4;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005129
Gilles Peskine449bd832023-01-11 14:50:10 +01005130 ret = ssl_session_save(ssl->session, 1,
5131 p, session_len, &session_len);
5132 if (ret != 0) {
5133 return ret;
5134 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005135
5136 p += session_len;
5137 }
5138
5139 /*
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005140 * Transform
5141 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005142 used += sizeof(ssl->transform->randbytes);
5143 if (used <= buf_len) {
5144 memcpy(p, ssl->transform->randbytes,
5145 sizeof(ssl->transform->randbytes));
5146 p += sizeof(ssl->transform->randbytes);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005147 }
5148
5149#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Dave Rodgmanc37ad442023-11-03 23:36:06 +00005150 used += 2U + ssl->transform->in_cid_len + ssl->transform->out_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01005151 if (used <= buf_len) {
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005152 *p++ = ssl->transform->in_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01005153 memcpy(p, ssl->transform->in_cid, ssl->transform->in_cid_len);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005154 p += ssl->transform->in_cid_len;
5155
5156 *p++ = ssl->transform->out_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01005157 memcpy(p, ssl->transform->out_cid, ssl->transform->out_cid_len);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005158 p += ssl->transform->out_cid_len;
5159 }
5160#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
5161
5162 /*
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005163 * Saved fields from top-level ssl_context structure
5164 */
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005165 used += 4;
Gilles Peskine449bd832023-01-11 14:50:10 +01005166 if (used <= buf_len) {
5167 MBEDTLS_PUT_UINT32_BE(ssl->badmac_seen, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01005168 p += 4;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005169 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005170
5171#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
5172 used += 16;
Gilles Peskine449bd832023-01-11 14:50:10 +01005173 if (used <= buf_len) {
5174 MBEDTLS_PUT_UINT64_BE(ssl->in_window_top, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01005175 p += 8;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005176
Gilles Peskine449bd832023-01-11 14:50:10 +01005177 MBEDTLS_PUT_UINT64_BE(ssl->in_window, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01005178 p += 8;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005179 }
5180#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
5181
5182#if defined(MBEDTLS_SSL_PROTO_DTLS)
5183 used += 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01005184 if (used <= buf_len) {
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005185 *p++ = ssl->disable_datagram_packing;
5186 }
5187#endif /* MBEDTLS_SSL_PROTO_DTLS */
5188
Jerry Yuae0b2e22021-10-08 15:21:19 +08005189 used += MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Gilles Peskine449bd832023-01-11 14:50:10 +01005190 if (used <= buf_len) {
5191 memcpy(p, ssl->cur_out_ctr, MBEDTLS_SSL_SEQUENCE_NUMBER_LEN);
Jerry Yuae0b2e22021-10-08 15:21:19 +08005192 p += MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005193 }
5194
5195#if defined(MBEDTLS_SSL_PROTO_DTLS)
5196 used += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01005197 if (used <= buf_len) {
5198 MBEDTLS_PUT_UINT16_BE(ssl->mtu, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01005199 p += 2;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005200 }
5201#endif /* MBEDTLS_SSL_PROTO_DTLS */
5202
5203#if defined(MBEDTLS_SSL_ALPN)
5204 {
5205 const uint8_t alpn_len = ssl->alpn_chosen
Gilles Peskine449bd832023-01-11 14:50:10 +01005206 ? (uint8_t) strlen(ssl->alpn_chosen)
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005207 : 0;
5208
5209 used += 1 + alpn_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01005210 if (used <= buf_len) {
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005211 *p++ = alpn_len;
5212
Gilles Peskine449bd832023-01-11 14:50:10 +01005213 if (ssl->alpn_chosen != NULL) {
5214 memcpy(p, ssl->alpn_chosen, alpn_len);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005215 p += alpn_len;
5216 }
5217 }
5218 }
5219#endif /* MBEDTLS_SSL_ALPN */
5220
5221 /*
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005222 * Done
5223 */
5224 *olen = used;
5225
Gilles Peskine449bd832023-01-11 14:50:10 +01005226 if (used > buf_len) {
5227 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
5228 }
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005229
Gilles Peskine449bd832023-01-11 14:50:10 +01005230 MBEDTLS_SSL_DEBUG_BUF(4, "saved context", buf, used);
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005231
Gilles Peskine449bd832023-01-11 14:50:10 +01005232 return mbedtls_ssl_session_reset_int(ssl, 0);
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005233}
5234
5235/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02005236 * Deserialize context, see mbedtls_ssl_context_save() for format.
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005237 *
5238 * This internal version is wrapped by a public function that cleans up in
5239 * case of error.
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005240 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005241MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01005242static int ssl_context_load(mbedtls_ssl_context *ssl,
5243 const unsigned char *buf,
5244 size_t len)
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005245{
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005246 const unsigned char *p = buf;
5247 const unsigned char * const end = buf + len;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005248 size_t session_len;
Janos Follath865b3eb2019-12-16 11:46:15 +00005249 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04005250#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Andrzej Kurek894edde2022-09-29 06:31:14 -04005251 tls_prf_fn prf_func = NULL;
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04005252#endif
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005253
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02005254 /*
5255 * The context should have been freshly setup or reset.
5256 * Give the user an error in case of obvious misuse.
Manuel Pégourié-Gonnard4ca930f2019-07-26 16:31:53 +02005257 * (Checking session is useful because it won't be NULL if we're
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02005258 * renegotiating, or if the user mistakenly loaded a session first.)
5259 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005260 if (ssl->state != MBEDTLS_SSL_HELLO_REQUEST ||
5261 ssl->session != NULL) {
5262 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02005263 }
5264
5265 /*
5266 * We can't check that the config matches the initial one, but we can at
5267 * least check it matches the requirements for serializing.
5268 */
Dave Rodgmane99b24d2023-09-14 15:45:03 +01005269 if (
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02005270#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard9a96fd72019-07-23 17:11:24 +02005271 ssl->conf->disable_renegotiation != MBEDTLS_SSL_RENEGOTIATION_DISABLED ||
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02005272#endif
Dave Rodgmane99b24d2023-09-14 15:45:03 +01005273 ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM ||
5274 ssl->conf->max_tls_version < MBEDTLS_SSL_VERSION_TLS1_2 ||
5275 ssl->conf->min_tls_version > MBEDTLS_SSL_VERSION_TLS1_2
5276 ) {
Gilles Peskine449bd832023-01-11 14:50:10 +01005277 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02005278 }
5279
Gilles Peskine449bd832023-01-11 14:50:10 +01005280 MBEDTLS_SSL_DEBUG_BUF(4, "context to load", buf, len);
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005281
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005282 /*
5283 * Check version identifier
5284 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005285 if ((size_t) (end - p) < sizeof(ssl_serialized_context_header)) {
5286 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005287 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005288
5289 if (memcmp(p, ssl_serialized_context_header,
5290 sizeof(ssl_serialized_context_header)) != 0) {
5291 return MBEDTLS_ERR_SSL_VERSION_MISMATCH;
5292 }
5293 p += sizeof(ssl_serialized_context_header);
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005294
5295 /*
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005296 * Session
5297 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005298 if ((size_t) (end - p) < 4) {
5299 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5300 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005301
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01005302 session_len = MBEDTLS_GET_UINT32_BE(p, 0);
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005303 p += 4;
5304
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02005305 /* This has been allocated by ssl_handshake_init(), called by
Hanno Becker43aefe22020-02-05 10:44:56 +00005306 * by either mbedtls_ssl_session_reset_int() or mbedtls_ssl_setup(). */
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02005307 ssl->session = ssl->session_negotiate;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005308 ssl->session_in = ssl->session;
5309 ssl->session_out = ssl->session;
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02005310 ssl->session_negotiate = NULL;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005311
Gilles Peskine449bd832023-01-11 14:50:10 +01005312 if ((size_t) (end - p) < session_len) {
5313 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5314 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005315
Gilles Peskine449bd832023-01-11 14:50:10 +01005316 ret = ssl_session_load(ssl->session, 1, p, session_len);
5317 if (ret != 0) {
5318 mbedtls_ssl_session_free(ssl->session);
5319 return ret;
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02005320 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005321
5322 p += session_len;
5323
5324 /*
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005325 * Transform
5326 */
5327
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02005328 /* This has been allocated by ssl_handshake_init(), called by
Hanno Becker43aefe22020-02-05 10:44:56 +00005329 * by either mbedtls_ssl_session_reset_int() or mbedtls_ssl_setup(). */
Jerry Yu2e199812022-12-01 18:57:19 +08005330#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02005331 ssl->transform = ssl->transform_negotiate;
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005332 ssl->transform_in = ssl->transform;
5333 ssl->transform_out = ssl->transform;
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02005334 ssl->transform_negotiate = NULL;
Jerry Yu2e199812022-12-01 18:57:19 +08005335#endif
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005336
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04005337#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005338 prf_func = ssl_tls12prf_from_cs(ssl->session->ciphersuite);
5339 if (prf_func == NULL) {
5340 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5341 }
Andrzej Kurek894edde2022-09-29 06:31:14 -04005342
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005343 /* Read random bytes and populate structure */
Gilles Peskine449bd832023-01-11 14:50:10 +01005344 if ((size_t) (end - p) < sizeof(ssl->transform->randbytes)) {
5345 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5346 }
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04005347
Gilles Peskine449bd832023-01-11 14:50:10 +01005348 ret = ssl_tls12_populate_transform(ssl->transform,
5349 ssl->session->ciphersuite,
5350 ssl->session->master,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02005351#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01005352 ssl->session->encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02005353#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01005354 prf_func,
5355 p, /* currently pointing to randbytes */
5356 MBEDTLS_SSL_VERSION_TLS1_2, /* (D)TLS 1.2 is forced */
5357 ssl->conf->endpoint,
5358 ssl);
5359 if (ret != 0) {
5360 return ret;
5361 }
Jerry Yu840fbb22022-02-17 14:59:29 +08005362#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005363 p += sizeof(ssl->transform->randbytes);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005364
5365#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
5366 /* Read connection IDs and store them */
Gilles Peskine449bd832023-01-11 14:50:10 +01005367 if ((size_t) (end - p) < 1) {
5368 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5369 }
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005370
5371 ssl->transform->in_cid_len = *p++;
5372
Gilles Peskine449bd832023-01-11 14:50:10 +01005373 if ((size_t) (end - p) < ssl->transform->in_cid_len + 1u) {
5374 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5375 }
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005376
Gilles Peskine449bd832023-01-11 14:50:10 +01005377 memcpy(ssl->transform->in_cid, p, ssl->transform->in_cid_len);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005378 p += ssl->transform->in_cid_len;
5379
5380 ssl->transform->out_cid_len = *p++;
5381
Gilles Peskine449bd832023-01-11 14:50:10 +01005382 if ((size_t) (end - p) < ssl->transform->out_cid_len) {
5383 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5384 }
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005385
Gilles Peskine449bd832023-01-11 14:50:10 +01005386 memcpy(ssl->transform->out_cid, p, ssl->transform->out_cid_len);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005387 p += ssl->transform->out_cid_len;
5388#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
5389
5390 /*
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005391 * Saved fields from top-level ssl_context structure
5392 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005393 if ((size_t) (end - p) < 4) {
5394 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5395 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005396
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01005397 ssl->badmac_seen = MBEDTLS_GET_UINT32_BE(p, 0);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005398 p += 4;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005399
5400#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Gilles Peskine449bd832023-01-11 14:50:10 +01005401 if ((size_t) (end - p) < 16) {
5402 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5403 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005404
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01005405 ssl->in_window_top = MBEDTLS_GET_UINT64_BE(p, 0);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005406 p += 8;
5407
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01005408 ssl->in_window = MBEDTLS_GET_UINT64_BE(p, 0);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005409 p += 8;
5410#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
5411
5412#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005413 if ((size_t) (end - p) < 1) {
5414 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5415 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005416
5417 ssl->disable_datagram_packing = *p++;
5418#endif /* MBEDTLS_SSL_PROTO_DTLS */
5419
Gilles Peskine449bd832023-01-11 14:50:10 +01005420 if ((size_t) (end - p) < sizeof(ssl->cur_out_ctr)) {
5421 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5422 }
5423 memcpy(ssl->cur_out_ctr, p, sizeof(ssl->cur_out_ctr));
5424 p += sizeof(ssl->cur_out_ctr);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005425
5426#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005427 if ((size_t) (end - p) < 2) {
5428 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5429 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005430
Dave Rodgmana3d0f612023-11-03 23:34:02 +00005431 ssl->mtu = MBEDTLS_GET_UINT16_BE(p, 0);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005432 p += 2;
5433#endif /* MBEDTLS_SSL_PROTO_DTLS */
5434
5435#if defined(MBEDTLS_SSL_ALPN)
5436 {
5437 uint8_t alpn_len;
5438 const char **cur;
5439
Gilles Peskine449bd832023-01-11 14:50:10 +01005440 if ((size_t) (end - p) < 1) {
5441 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5442 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005443
5444 alpn_len = *p++;
5445
Gilles Peskine449bd832023-01-11 14:50:10 +01005446 if (alpn_len != 0 && ssl->conf->alpn_list != NULL) {
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005447 /* alpn_chosen should point to an item in the configured list */
Gilles Peskine449bd832023-01-11 14:50:10 +01005448 for (cur = ssl->conf->alpn_list; *cur != NULL; cur++) {
5449 if (strlen(*cur) == alpn_len &&
Waleed Elmelegy131b2ff2024-03-14 01:39:39 +00005450 memcmp(p, *cur, alpn_len) == 0) {
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005451 ssl->alpn_chosen = *cur;
5452 break;
5453 }
5454 }
5455 }
5456
5457 /* can only happen on conf mismatch */
Gilles Peskine449bd832023-01-11 14:50:10 +01005458 if (alpn_len != 0 && ssl->alpn_chosen == NULL) {
5459 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5460 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005461
5462 p += alpn_len;
5463 }
5464#endif /* MBEDTLS_SSL_ALPN */
5465
5466 /*
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02005467 * Forced fields from top-level ssl_context structure
5468 *
5469 * Most of them already set to the correct value by mbedtls_ssl_init() and
5470 * mbedtls_ssl_reset(), so we only need to set the remaining ones.
5471 */
5472 ssl->state = MBEDTLS_SSL_HANDSHAKE_OVER;
Glenn Strauss60bfe602022-03-14 19:04:24 -04005473 ssl->tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02005474
Hanno Becker361b10d2019-08-30 10:42:49 +01005475 /* Adjust pointers for header fields of outgoing records to
5476 * the given transform, accounting for explicit IV and CID. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005477 mbedtls_ssl_update_out_pointers(ssl, ssl->transform);
Hanno Becker361b10d2019-08-30 10:42:49 +01005478
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02005479#if defined(MBEDTLS_SSL_PROTO_DTLS)
5480 ssl->in_epoch = 1;
5481#endif
5482
5483 /* mbedtls_ssl_reset() leaves the handshake sub-structure allocated,
5484 * which we don't want - otherwise we'd end up freeing the wrong transform
Hanno Beckerce5f5fd2020-02-05 10:47:44 +00005485 * by calling mbedtls_ssl_handshake_wrapup_free_hs_transform()
5486 * inappropriately. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005487 if (ssl->handshake != NULL) {
5488 mbedtls_ssl_handshake_free(ssl);
5489 mbedtls_free(ssl->handshake);
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02005490 ssl->handshake = NULL;
5491 }
5492
5493 /*
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005494 * Done - should have consumed entire buffer
5495 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005496 if (p != end) {
5497 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5498 }
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005499
Gilles Peskine449bd832023-01-11 14:50:10 +01005500 return 0;
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005501}
5502
5503/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02005504 * Deserialize context: public wrapper for error cleaning
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005505 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005506int mbedtls_ssl_context_load(mbedtls_ssl_context *context,
5507 const unsigned char *buf,
5508 size_t len)
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005509{
Gilles Peskine449bd832023-01-11 14:50:10 +01005510 int ret = ssl_context_load(context, buf, len);
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005511
Gilles Peskine449bd832023-01-11 14:50:10 +01005512 if (ret != 0) {
5513 mbedtls_ssl_free(context);
5514 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005515
Gilles Peskine449bd832023-01-11 14:50:10 +01005516 return ret;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005517}
Manuel Pégourié-Gonnard5c0e3772019-07-23 16:13:17 +02005518#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005519
5520/*
Paul Bakker5121ce52009-01-03 21:22:43 +00005521 * Free an SSL context
5522 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005523void mbedtls_ssl_free(mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00005524{
Gilles Peskine449bd832023-01-11 14:50:10 +01005525 if (ssl == NULL) {
Paul Bakkeraccaffe2014-06-26 13:37:14 +02005526 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01005527 }
Paul Bakkeraccaffe2014-06-26 13:37:14 +02005528
Gilles Peskine449bd832023-01-11 14:50:10 +01005529 MBEDTLS_SSL_DEBUG_MSG(2, ("=> free"));
Paul Bakker5121ce52009-01-03 21:22:43 +00005530
Gilles Peskine449bd832023-01-11 14:50:10 +01005531 if (ssl->out_buf != NULL) {
sander-visserb8aa2072020-05-06 22:05:13 +02005532#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
5533 size_t out_buf_len = ssl->out_buf_len;
5534#else
5535 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
5536#endif
5537
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005538 mbedtls_zeroize_and_free(ssl->out_buf, out_buf_len);
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05005539 ssl->out_buf = NULL;
Paul Bakker5121ce52009-01-03 21:22:43 +00005540 }
5541
Gilles Peskine449bd832023-01-11 14:50:10 +01005542 if (ssl->in_buf != NULL) {
sander-visserb8aa2072020-05-06 22:05:13 +02005543#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
5544 size_t in_buf_len = ssl->in_buf_len;
5545#else
5546 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
5547#endif
5548
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005549 mbedtls_zeroize_and_free(ssl->in_buf, in_buf_len);
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05005550 ssl->in_buf = NULL;
Paul Bakker5121ce52009-01-03 21:22:43 +00005551 }
5552
Gilles Peskine449bd832023-01-11 14:50:10 +01005553 if (ssl->transform) {
5554 mbedtls_ssl_transform_free(ssl->transform);
5555 mbedtls_free(ssl->transform);
Paul Bakker48916f92012-09-16 19:57:18 +00005556 }
5557
Gilles Peskine449bd832023-01-11 14:50:10 +01005558 if (ssl->handshake) {
5559 mbedtls_ssl_handshake_free(ssl);
5560 mbedtls_free(ssl->handshake);
Jerry Yu2e199812022-12-01 18:57:19 +08005561
5562#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005563 mbedtls_ssl_transform_free(ssl->transform_negotiate);
5564 mbedtls_free(ssl->transform_negotiate);
Jerry Yu2e199812022-12-01 18:57:19 +08005565#endif
5566
Gilles Peskine449bd832023-01-11 14:50:10 +01005567 mbedtls_ssl_session_free(ssl->session_negotiate);
5568 mbedtls_free(ssl->session_negotiate);
Paul Bakker48916f92012-09-16 19:57:18 +00005569 }
5570
Ronald Cron6f135e12021-12-08 16:57:54 +01005571#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01005572 mbedtls_ssl_transform_free(ssl->transform_application);
5573 mbedtls_free(ssl->transform_application);
Ronald Cron6f135e12021-12-08 16:57:54 +01005574#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker3aa186f2021-08-10 09:24:19 +01005575
Gilles Peskine449bd832023-01-11 14:50:10 +01005576 if (ssl->session) {
5577 mbedtls_ssl_session_free(ssl->session);
5578 mbedtls_free(ssl->session);
Paul Bakkerc0463502013-02-14 11:19:38 +01005579 }
5580
Manuel Pégourié-Gonnard55fab2d2015-05-11 16:15:19 +02005581#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005582 if (ssl->hostname != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005583 mbedtls_zeroize_and_free(ssl->hostname, strlen(ssl->hostname));
Paul Bakker5121ce52009-01-03 21:22:43 +00005584 }
Paul Bakker0be444a2013-08-27 21:55:01 +02005585#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00005586
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02005587#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005588 mbedtls_free(ssl->cli_id);
Manuel Pégourié-Gonnard43c02182014-07-22 17:32:01 +02005589#endif
5590
Gilles Peskine449bd832023-01-11 14:50:10 +01005591 MBEDTLS_SSL_DEBUG_MSG(2, ("<= free"));
Paul Bakker2da561c2009-02-05 18:00:28 +00005592
Paul Bakker86f04f42013-02-14 11:20:09 +01005593 /* Actually clear after last debug message */
Gilles Peskine449bd832023-01-11 14:50:10 +01005594 mbedtls_platform_zeroize(ssl, sizeof(mbedtls_ssl_context));
Paul Bakker5121ce52009-01-03 21:22:43 +00005595}
5596
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005597/*
Shaun Case8b0ecbc2021-12-20 21:14:10 -08005598 * Initialize mbedtls_ssl_config
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005599 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005600void mbedtls_ssl_config_init(mbedtls_ssl_config *conf)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005601{
Gilles Peskine449bd832023-01-11 14:50:10 +01005602 memset(conf, 0, sizeof(mbedtls_ssl_config));
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005603}
5604
Gilles Peskineae270bf2021-06-02 00:05:29 +02005605/* The selection should be the same as mbedtls_x509_crt_profile_default in
5606 * x509_crt.c, plus Montgomery curves for ECDHE. Here, the order matters:
Gilles Peskineb1940a72021-06-02 15:18:12 +02005607 * curves with a lower resource usage come first.
Gilles Peskineae270bf2021-06-02 00:05:29 +02005608 * See the documentation of mbedtls_ssl_conf_curves() for what we promise
Gilles Peskineb1940a72021-06-02 15:18:12 +02005609 * about this list.
5610 */
Chien Wong4e9683e2023-12-28 17:07:43 +08005611static const uint16_t ssl_preset_default_groups[] = {
Valerio Settidb6b4db2023-09-01 09:20:51 +02005612#if defined(MBEDTLS_ECP_HAVE_CURVE25519)
Brett Warrene0edc842021-08-17 09:53:13 +01005613 MBEDTLS_SSL_IANA_TLS_GROUP_X25519,
Gilles Peskineae270bf2021-06-02 00:05:29 +02005614#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005615#if defined(MBEDTLS_ECP_HAVE_SECP256R1)
Brett Warrene0edc842021-08-17 09:53:13 +01005616 MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1,
Gilles Peskineae270bf2021-06-02 00:05:29 +02005617#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005618#if defined(MBEDTLS_ECP_HAVE_SECP384R1)
Brett Warrene0edc842021-08-17 09:53:13 +01005619 MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02005620#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005621#if defined(MBEDTLS_ECP_HAVE_CURVE448)
Brett Warrene0edc842021-08-17 09:53:13 +01005622 MBEDTLS_SSL_IANA_TLS_GROUP_X448,
Gilles Peskineb1940a72021-06-02 15:18:12 +02005623#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005624#if defined(MBEDTLS_ECP_HAVE_SECP521R1)
Brett Warrene0edc842021-08-17 09:53:13 +01005625 MBEDTLS_SSL_IANA_TLS_GROUP_SECP521R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02005626#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005627#if defined(MBEDTLS_ECP_HAVE_BP256R1)
Brett Warrene0edc842021-08-17 09:53:13 +01005628 MBEDTLS_SSL_IANA_TLS_GROUP_BP256R1,
Gilles Peskineae270bf2021-06-02 00:05:29 +02005629#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005630#if defined(MBEDTLS_ECP_HAVE_BP384R1)
Brett Warrene0edc842021-08-17 09:53:13 +01005631 MBEDTLS_SSL_IANA_TLS_GROUP_BP384R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02005632#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005633#if defined(MBEDTLS_ECP_HAVE_BP512R1)
Brett Warrene0edc842021-08-17 09:53:13 +01005634 MBEDTLS_SSL_IANA_TLS_GROUP_BP512R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02005635#endif
Przemek Stekiel316c19e2023-05-31 15:25:11 +02005636#if defined(PSA_WANT_ALG_FFDH)
Przemek Stekiel383f4712022-12-12 14:48:57 +01005637 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE2048,
5638 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE3072,
5639 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE4096,
5640 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE6144,
5641 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE8192,
5642#endif
Brett Warrene0edc842021-08-17 09:53:13 +01005643 MBEDTLS_SSL_IANA_TLS_GROUP_NONE
Gilles Peskineae270bf2021-06-02 00:05:29 +02005644};
Gilles Peskineae270bf2021-06-02 00:05:29 +02005645
Alexey Tsvetkov2ca34372022-06-07 10:21:05 +03005646static const int ssl_preset_suiteb_ciphersuites[] = {
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005647 MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256,
5648 MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384,
5649 0
5650};
5651
Ronald Crone68ab4f2022-10-05 12:46:29 +02005652#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Hanno Becker9c6aa7b2021-08-10 13:50:43 +01005653
Jerry Yu909df7b2022-01-22 11:56:27 +08005654/* NOTICE:
Jerry Yu0b994b82022-01-25 17:22:12 +08005655 * For ssl_preset_*_sig_algs and ssl_tls12_preset_*_sig_algs, the following
Jerry Yu370e1462022-01-25 10:36:53 +08005656 * rules SHOULD be upheld.
5657 * - No duplicate entries.
5658 * - But if there is a good reason, do not change the order of the algorithms.
Jerry Yu09a99fc2022-07-28 14:22:17 +08005659 * - ssl_tls12_preset* is for TLS 1.2 use only.
Jerry Yu370e1462022-01-25 10:36:53 +08005660 * - ssl_preset_* is for TLS 1.3 only or hybrid TLS 1.3/1.2 handshakes.
Jerry Yu1a8b4812022-01-20 17:56:50 +08005661 */
Chien Wong4e9683e2023-12-28 17:07:43 +08005662static const uint16_t ssl_preset_default_sig_algs[] = {
Jerry Yu1a8b4812022-01-20 17:56:50 +08005663
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005664#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005665 defined(MBEDTLS_MD_CAN_SHA256) && \
Valerio Setticf29c5d2023-09-01 09:03:41 +02005666 defined(PSA_WANT_ECC_SECP_R1_256)
Jerry Yued5e9f42022-01-26 11:21:34 +08005667 MBEDTLS_TLS1_3_SIG_ECDSA_SECP256R1_SHA256,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005668 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256)
5669#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08005670
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005671#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005672 defined(MBEDTLS_MD_CAN_SHA384) && \
Valerio Setticf29c5d2023-09-01 09:03:41 +02005673 defined(PSA_WANT_ECC_SECP_R1_384)
Jerry Yu909df7b2022-01-22 11:56:27 +08005674 MBEDTLS_TLS1_3_SIG_ECDSA_SECP384R1_SHA384,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005675 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384)
5676#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08005677
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005678#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005679 defined(MBEDTLS_MD_CAN_SHA512) && \
Valerio Setticf29c5d2023-09-01 09:03:41 +02005680 defined(PSA_WANT_ECC_SECP_R1_521)
Jerry Yued5e9f42022-01-26 11:21:34 +08005681 MBEDTLS_TLS1_3_SIG_ECDSA_SECP521R1_SHA512,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005682 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA512)
5683#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08005684
Yanray Wang1136fad2023-11-22 16:54:31 +08005685#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && defined(MBEDTLS_MD_CAN_SHA512)
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005686 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA512,
Yanray Wang1136fad2023-11-22 16:54:31 +08005687#endif
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005688
Yanray Wang1136fad2023-11-22 16:54:31 +08005689#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && defined(MBEDTLS_MD_CAN_SHA384)
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005690 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA384,
Yanray Wang1136fad2023-11-22 16:54:31 +08005691#endif
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005692
Yanray Wang1136fad2023-11-22 16:54:31 +08005693#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && defined(MBEDTLS_MD_CAN_SHA256)
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005694 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256,
Yanray Wang1136fad2023-11-22 16:54:31 +08005695#endif
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005696
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005697#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_MD_CAN_SHA512)
Jerry Yu693a47a2022-06-23 14:02:28 +08005698 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA512,
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005699#endif /* MBEDTLS_RSA_C && MBEDTLS_MD_CAN_SHA512 */
Jerry Yu693a47a2022-06-23 14:02:28 +08005700
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005701#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_MD_CAN_SHA384)
Jerry Yu693a47a2022-06-23 14:02:28 +08005702 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA384,
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005703#endif /* MBEDTLS_RSA_C && MBEDTLS_MD_CAN_SHA384 */
Jerry Yu693a47a2022-06-23 14:02:28 +08005704
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005705#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_MD_CAN_SHA256)
Jerry Yu693a47a2022-06-23 14:02:28 +08005706 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA256,
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005707#endif /* MBEDTLS_RSA_C && MBEDTLS_MD_CAN_SHA256 */
Jerry Yu693a47a2022-06-23 14:02:28 +08005708
Gabor Mezei15b95a62022-05-09 16:37:58 +02005709 MBEDTLS_TLS_SIG_NONE
Jerry Yu909df7b2022-01-22 11:56:27 +08005710};
5711
5712/* NOTICE: see above */
5713#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
5714static uint16_t ssl_tls12_preset_default_sig_algs[] = {
Yanray Wang1136fad2023-11-22 16:54:31 +08005715
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005716#if defined(MBEDTLS_MD_CAN_SHA512)
Valerio Settie9646ec2023-08-02 20:02:28 +02005717#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005718 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA512),
Jerry Yu713013f2022-01-17 18:16:35 +08005719#endif
Jerry Yu09a99fc2022-07-28 14:22:17 +08005720#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT)
5721 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA512,
Yanray Wang1136fad2023-11-22 16:54:31 +08005722#endif
Gabor Mezeic1051b62022-05-10 13:13:58 +02005723#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005724 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA512),
Gabor Mezeic1051b62022-05-10 13:13:58 +02005725#endif
Yanray Wang1136fad2023-11-22 16:54:31 +08005726#endif /* MBEDTLS_MD_CAN_SHA512 */
5727
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005728#if defined(MBEDTLS_MD_CAN_SHA384)
Valerio Settie9646ec2023-08-02 20:02:28 +02005729#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005730 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384),
Jerry Yu11f0a9c2022-01-12 18:43:08 +08005731#endif
Jerry Yu09a99fc2022-07-28 14:22:17 +08005732#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT)
5733 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA384,
Yanray Wang1136fad2023-11-22 16:54:31 +08005734#endif
Gabor Mezeic1051b62022-05-10 13:13:58 +02005735#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005736 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA384),
Gabor Mezeic1051b62022-05-10 13:13:58 +02005737#endif
Yanray Wang1136fad2023-11-22 16:54:31 +08005738#endif /* MBEDTLS_MD_CAN_SHA384 */
5739
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005740#if defined(MBEDTLS_MD_CAN_SHA256)
Valerio Settie9646ec2023-08-02 20:02:28 +02005741#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005742 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256),
Jerry Yu11f0a9c2022-01-12 18:43:08 +08005743#endif
Jerry Yu09a99fc2022-07-28 14:22:17 +08005744#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT)
5745 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256,
Yanray Wang1136fad2023-11-22 16:54:31 +08005746#endif
Gabor Mezeic1051b62022-05-10 13:13:58 +02005747#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005748 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA256),
Gabor Mezeic1051b62022-05-10 13:13:58 +02005749#endif
Yanray Wang1136fad2023-11-22 16:54:31 +08005750#endif /* MBEDTLS_MD_CAN_SHA256 */
5751
Gabor Mezei15b95a62022-05-09 16:37:58 +02005752 MBEDTLS_TLS_SIG_NONE
Jerry Yu909df7b2022-01-22 11:56:27 +08005753};
5754#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Yanray Wang1136fad2023-11-22 16:54:31 +08005755
Jerry Yu909df7b2022-01-22 11:56:27 +08005756/* NOTICE: see above */
Chien Wong4e9683e2023-12-28 17:07:43 +08005757static const uint16_t ssl_preset_suiteb_sig_algs[] = {
Jerry Yu909df7b2022-01-22 11:56:27 +08005758
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005759#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Valerio Setti45d56f32023-07-13 17:23:20 +02005760 defined(MBEDTLS_MD_CAN_SHA256) && \
Valerio Settidb6b4db2023-09-01 09:20:51 +02005761 defined(MBEDTLS_ECP_HAVE_SECP256R1)
Jerry Yu909df7b2022-01-22 11:56:27 +08005762 MBEDTLS_TLS1_3_SIG_ECDSA_SECP256R1_SHA256,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005763 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256)
5764#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08005765
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005766#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Valerio Setti45d56f32023-07-13 17:23:20 +02005767 defined(MBEDTLS_MD_CAN_SHA384) && \
Valerio Settidb6b4db2023-09-01 09:20:51 +02005768 defined(MBEDTLS_ECP_HAVE_SECP384R1)
Jerry Yu53037892022-01-25 11:02:06 +08005769 MBEDTLS_TLS1_3_SIG_ECDSA_SECP384R1_SHA384,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005770 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384)
5771#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08005772
Gabor Mezei15b95a62022-05-09 16:37:58 +02005773 MBEDTLS_TLS_SIG_NONE
Jerry Yu713013f2022-01-17 18:16:35 +08005774};
Jerry Yu6106fdc2022-01-12 16:36:14 +08005775
Jerry Yu909df7b2022-01-22 11:56:27 +08005776/* NOTICE: see above */
5777#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
5778static uint16_t ssl_tls12_preset_suiteb_sig_algs[] = {
Yanray Wang1136fad2023-11-22 16:54:31 +08005779
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005780#if defined(MBEDTLS_MD_CAN_SHA256)
Valerio Settie9646ec2023-08-02 20:02:28 +02005781#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005782 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256),
Jerry Yu713013f2022-01-17 18:16:35 +08005783#endif
Yanray Wang1136fad2023-11-22 16:54:31 +08005784#endif /* MBEDTLS_MD_CAN_SHA256 */
Yanray Wang69ceb392023-11-22 16:32:39 +08005785
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005786#if defined(MBEDTLS_MD_CAN_SHA384)
Valerio Settie9646ec2023-08-02 20:02:28 +02005787#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005788 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384),
Jerry Yu18c833e2022-01-25 10:55:47 +08005789#endif
Yanray Wang1136fad2023-11-22 16:54:31 +08005790#endif /* MBEDTLS_MD_CAN_SHA384 */
5791
Gabor Mezei15b95a62022-05-09 16:37:58 +02005792 MBEDTLS_TLS_SIG_NONE
Hanno Becker9c6aa7b2021-08-10 13:50:43 +01005793};
Jerry Yu909df7b2022-01-22 11:56:27 +08005794#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
5795
Ronald Crone68ab4f2022-10-05 12:46:29 +02005796#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005797
Chien Wong4e9683e2023-12-28 17:07:43 +08005798static const uint16_t ssl_preset_suiteb_groups[] = {
Valerio Settidb6b4db2023-09-01 09:20:51 +02005799#if defined(MBEDTLS_ECP_HAVE_SECP256R1)
Brett Warrene0edc842021-08-17 09:53:13 +01005800 MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1,
Jaeden Amerod4311042019-06-03 08:27:16 +01005801#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005802#if defined(MBEDTLS_ECP_HAVE_SECP384R1)
Brett Warrene0edc842021-08-17 09:53:13 +01005803 MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1,
Jaeden Amerod4311042019-06-03 08:27:16 +01005804#endif
Brett Warrene0edc842021-08-17 09:53:13 +01005805 MBEDTLS_SSL_IANA_TLS_GROUP_NONE
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005806};
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005807
Ronald Crone68ab4f2022-10-05 12:46:29 +02005808#if defined(MBEDTLS_DEBUG_C) && defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu909df7b2022-01-22 11:56:27 +08005809/* Function for checking `ssl_preset_*_sig_algs` and `ssl_tls12_preset_*_sig_algs`
Jerry Yu370e1462022-01-25 10:36:53 +08005810 * to make sure there are no duplicated signature algorithm entries. */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005811MBEDTLS_CHECK_RETURN_CRITICAL
Chien Wong4e9683e2023-12-28 17:07:43 +08005812static int ssl_check_no_sig_alg_duplication(const uint16_t *sig_algs)
Jerry Yu1a8b4812022-01-20 17:56:50 +08005813{
5814 size_t i, j;
5815 int ret = 0;
Jerry Yu909df7b2022-01-22 11:56:27 +08005816
Gilles Peskine449bd832023-01-11 14:50:10 +01005817 for (i = 0; sig_algs[i] != MBEDTLS_TLS_SIG_NONE; i++) {
5818 for (j = 0; j < i; j++) {
5819 if (sig_algs[i] != sig_algs[j]) {
Jerry Yuf377d642022-01-25 10:43:59 +08005820 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01005821 }
5822 mbedtls_printf(" entry(%04x,%" MBEDTLS_PRINTF_SIZET
5823 ") is duplicated at %" MBEDTLS_PRINTF_SIZET "\n",
5824 sig_algs[i], j, i);
Jerry Yuf377d642022-01-25 10:43:59 +08005825 ret = -1;
Jerry Yu1a8b4812022-01-20 17:56:50 +08005826 }
5827 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005828 return ret;
Jerry Yu1a8b4812022-01-20 17:56:50 +08005829}
5830
Ronald Crone68ab4f2022-10-05 12:46:29 +02005831#endif /* MBEDTLS_DEBUG_C && MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Jerry Yu1a8b4812022-01-20 17:56:50 +08005832
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005833/*
Tillmann Karras588ad502015-09-25 04:27:22 +02005834 * Load default in mbedtls_ssl_config
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005835 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005836int mbedtls_ssl_config_defaults(mbedtls_ssl_config *conf,
5837 int endpoint, int transport, int preset)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005838{
Manuel Pégourié-Gonnard8b431fb2015-05-11 12:54:52 +02005839#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Janos Follath865b3eb2019-12-16 11:46:15 +00005840 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard8b431fb2015-05-11 12:54:52 +02005841#endif
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005842
Ronald Crone68ab4f2022-10-05 12:46:29 +02005843#if defined(MBEDTLS_DEBUG_C) && defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005844 if (ssl_check_no_sig_alg_duplication(ssl_preset_suiteb_sig_algs)) {
5845 mbedtls_printf("ssl_preset_suiteb_sig_algs has duplicated entries\n");
5846 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu1a8b4812022-01-20 17:56:50 +08005847 }
5848
Gilles Peskine449bd832023-01-11 14:50:10 +01005849 if (ssl_check_no_sig_alg_duplication(ssl_preset_default_sig_algs)) {
5850 mbedtls_printf("ssl_preset_default_sig_algs has duplicated entries\n");
5851 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu1a8b4812022-01-20 17:56:50 +08005852 }
Jerry Yu909df7b2022-01-22 11:56:27 +08005853
5854#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005855 if (ssl_check_no_sig_alg_duplication(ssl_tls12_preset_suiteb_sig_algs)) {
5856 mbedtls_printf("ssl_tls12_preset_suiteb_sig_algs has duplicated entries\n");
5857 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu909df7b2022-01-22 11:56:27 +08005858 }
5859
Gilles Peskine449bd832023-01-11 14:50:10 +01005860 if (ssl_check_no_sig_alg_duplication(ssl_tls12_preset_default_sig_algs)) {
5861 mbedtls_printf("ssl_tls12_preset_default_sig_algs has duplicated entries\n");
5862 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu909df7b2022-01-22 11:56:27 +08005863 }
5864#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Ronald Crone68ab4f2022-10-05 12:46:29 +02005865#endif /* MBEDTLS_DEBUG_C && MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Jerry Yu1a8b4812022-01-20 17:56:50 +08005866
Manuel Pégourié-Gonnard0de074f2015-05-14 12:58:01 +02005867 /* Use the functions here so that they are covered in tests,
5868 * but otherwise access member directly for efficiency */
Gilles Peskine449bd832023-01-11 14:50:10 +01005869 mbedtls_ssl_conf_endpoint(conf, endpoint);
5870 mbedtls_ssl_conf_transport(conf, transport);
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005871
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005872 /*
5873 * Things that are common to all presets
5874 */
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02005875#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005876 if (endpoint == MBEDTLS_SSL_IS_CLIENT) {
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02005877 conf->authmode = MBEDTLS_SSL_VERIFY_REQUIRED;
5878#if defined(MBEDTLS_SSL_SESSION_TICKETS)
5879 conf->session_tickets = MBEDTLS_SSL_SESSION_TICKETS_ENABLED;
5880#endif
5881 }
5882#endif
5883
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005884#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
5885 conf->encrypt_then_mac = MBEDTLS_SSL_ETM_ENABLED;
5886#endif
5887
5888#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
5889 conf->extended_ms = MBEDTLS_SSL_EXTENDED_MS_ENABLED;
5890#endif
5891
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02005892#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005893 conf->f_cookie_write = ssl_cookie_write_dummy;
5894 conf->f_cookie_check = ssl_cookie_check_dummy;
5895#endif
5896
5897#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
5898 conf->anti_replay = MBEDTLS_SSL_ANTI_REPLAY_ENABLED;
5899#endif
5900
Janos Follath088ce432017-04-10 12:42:31 +01005901#if defined(MBEDTLS_SSL_SRV_C)
5902 conf->cert_req_ca_list = MBEDTLS_SSL_CERT_REQ_CA_LIST_ENABLED;
TRodziewicz3946f792021-06-14 12:11:18 +02005903 conf->respect_cli_pref = MBEDTLS_SSL_SRV_CIPHERSUITE_ORDER_SERVER;
Janos Follath088ce432017-04-10 12:42:31 +01005904#endif
5905
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005906#if defined(MBEDTLS_SSL_PROTO_DTLS)
5907 conf->hs_timeout_min = MBEDTLS_SSL_DTLS_TIMEOUT_DFL_MIN;
5908 conf->hs_timeout_max = MBEDTLS_SSL_DTLS_TIMEOUT_DFL_MAX;
5909#endif
5910
5911#if defined(MBEDTLS_SSL_RENEGOTIATION)
5912 conf->renego_max_records = MBEDTLS_SSL_RENEGO_MAX_RECORDS_DEFAULT;
Gilles Peskine449bd832023-01-11 14:50:10 +01005913 memset(conf->renego_period, 0x00, 2);
5914 memset(conf->renego_period + 2, 0xFF, 6);
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005915#endif
5916
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005917#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005918 if (endpoint == MBEDTLS_SSL_IS_SERVER) {
Hanno Beckere2defad2021-07-24 05:59:17 +01005919 const unsigned char dhm_p[] =
5920 MBEDTLS_DHM_RFC3526_MODP_2048_P_BIN;
5921 const unsigned char dhm_g[] =
5922 MBEDTLS_DHM_RFC3526_MODP_2048_G_BIN;
Hanno Becker00d0a682017-10-04 13:14:29 +01005923
Gilles Peskine449bd832023-01-11 14:50:10 +01005924 if ((ret = mbedtls_ssl_conf_dh_param_bin(conf,
5925 dhm_p, sizeof(dhm_p),
5926 dhm_g, sizeof(dhm_g))) != 0) {
5927 return ret;
Hanno Beckere2defad2021-07-24 05:59:17 +01005928 }
5929 }
Manuel Pégourié-Gonnardbd990d62015-06-11 14:49:42 +02005930#endif
5931
Ronald Cron6f135e12021-12-08 16:57:54 +01005932#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yu6ee56aa2022-12-06 17:47:22 +08005933
5934#if defined(MBEDTLS_SSL_EARLY_DATA)
Yanray Wangd5ed36f2023-11-07 11:40:43 +08005935 mbedtls_ssl_conf_early_data(conf, MBEDTLS_SSL_EARLY_DATA_DISABLED);
Jerry Yu6ee56aa2022-12-06 17:47:22 +08005936#if defined(MBEDTLS_SSL_SRV_C)
Yanray Wang07517612023-11-07 11:47:36 +08005937 mbedtls_ssl_conf_max_early_data_size(conf, MBEDTLS_SSL_MAX_EARLY_DATA_SIZE);
Jerry Yu6ee56aa2022-12-06 17:47:22 +08005938#endif
5939#endif /* MBEDTLS_SSL_EARLY_DATA */
5940
Jerry Yud0766ec2022-09-22 10:46:57 +08005941#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Jerry Yu1ad7ace2022-08-09 13:28:39 +08005942 mbedtls_ssl_conf_new_session_tickets(
Gilles Peskine449bd832023-01-11 14:50:10 +01005943 conf, MBEDTLS_SSL_TLS1_3_DEFAULT_NEW_SESSION_TICKETS);
Jerry Yu1ad7ace2022-08-09 13:28:39 +08005944#endif
Hanno Becker71f1ed62021-07-24 06:01:47 +01005945 /*
5946 * Allow all TLS 1.3 key exchange modes by default.
5947 */
Xiaofei Bai746f9482021-11-12 08:53:56 +00005948 conf->tls13_kex_modes = MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_ALL;
Ronald Cron6f135e12021-12-08 16:57:54 +01005949#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker71f1ed62021-07-24 06:01:47 +01005950
Gilles Peskine449bd832023-01-11 14:50:10 +01005951 if (transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Glenn Strauss2dfcea22022-03-14 17:26:42 -04005952#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
XiaokangQian4d3a6042022-04-21 13:46:17 +00005953 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
XiaokangQian060d8672022-04-21 09:24:56 +00005954 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
XiaokangQian4d3a6042022-04-21 13:46:17 +00005955#else
Gilles Peskine449bd832023-01-11 14:50:10 +01005956 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
XiaokangQian060d8672022-04-21 09:24:56 +00005957#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01005958 } else {
XiaokangQian4d3a6042022-04-21 13:46:17 +00005959#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
Ronald Cron097ba142023-03-08 16:18:00 +01005960 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
5961 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
XiaokangQian4d3a6042022-04-21 13:46:17 +00005962#elif defined(MBEDTLS_SSL_PROTO_TLS1_3)
5963 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
5964 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
5965#elif defined(MBEDTLS_SSL_PROTO_TLS1_2)
5966 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
5967 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
5968#else
Gilles Peskine449bd832023-01-11 14:50:10 +01005969 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
XiaokangQian4d3a6042022-04-21 13:46:17 +00005970#endif
5971 }
Glenn Strauss2dfcea22022-03-14 17:26:42 -04005972
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005973 /*
5974 * Preset-specific defaults
5975 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005976 switch (preset) {
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005977 /*
5978 * NSA Suite B
5979 */
5980 case MBEDTLS_SSL_PRESET_SUITEB:
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005981
Hanno Beckerd60b6c62021-04-29 12:04:11 +01005982 conf->ciphersuite_list = ssl_preset_suiteb_ciphersuites;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005983
5984#if defined(MBEDTLS_X509_CRT_PARSE_C)
5985 conf->cert_profile = &mbedtls_x509_crt_profile_suiteb;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005986#endif
5987
Ronald Crone68ab4f2022-10-05 12:46:29 +02005988#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu909df7b2022-01-22 11:56:27 +08005989#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005990 if (mbedtls_ssl_conf_is_tls12_only(conf)) {
Jerry Yu909df7b2022-01-22 11:56:27 +08005991 conf->sig_algs = ssl_tls12_preset_suiteb_sig_algs;
Gilles Peskine449bd832023-01-11 14:50:10 +01005992 } else
Jerry Yu909df7b2022-01-22 11:56:27 +08005993#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005994 conf->sig_algs = ssl_preset_suiteb_sig_algs;
Ronald Crone68ab4f2022-10-05 12:46:29 +02005995#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005996
Manuel Pégourié-Gonnardf07ce3b2023-09-22 11:53:41 +02005997#if defined(MBEDTLS_ECP_C) && !defined(MBEDTLS_DEPRECATED_REMOVED)
Brett Warrene0edc842021-08-17 09:53:13 +01005998 conf->curve_list = NULL;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005999#endif
Brett Warrene0edc842021-08-17 09:53:13 +01006000 conf->group_list = ssl_preset_suiteb_groups;
Manuel Pégourié-Gonnardc98204e2015-08-11 04:21:01 +02006001 break;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02006002
6003 /*
6004 * Default
6005 */
6006 default:
Ronald Cronf6606552022-03-15 11:23:25 +01006007
Hanno Beckerd60b6c62021-04-29 12:04:11 +01006008 conf->ciphersuite_list = mbedtls_ssl_list_ciphersuites();
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02006009
6010#if defined(MBEDTLS_X509_CRT_PARSE_C)
6011 conf->cert_profile = &mbedtls_x509_crt_profile_default;
6012#endif
6013
Ronald Crone68ab4f2022-10-05 12:46:29 +02006014#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu909df7b2022-01-22 11:56:27 +08006015#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01006016 if (mbedtls_ssl_conf_is_tls12_only(conf)) {
Jerry Yu909df7b2022-01-22 11:56:27 +08006017 conf->sig_algs = ssl_tls12_preset_default_sig_algs;
Gilles Peskine449bd832023-01-11 14:50:10 +01006018 } else
Jerry Yu909df7b2022-01-22 11:56:27 +08006019#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006020 conf->sig_algs = ssl_preset_default_sig_algs;
Ronald Crone68ab4f2022-10-05 12:46:29 +02006021#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02006022
Manuel Pégourié-Gonnardf07ce3b2023-09-22 11:53:41 +02006023#if defined(MBEDTLS_ECP_C) && !defined(MBEDTLS_DEPRECATED_REMOVED)
Brett Warrene0edc842021-08-17 09:53:13 +01006024 conf->curve_list = NULL;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02006025#endif
Brett Warrene0edc842021-08-17 09:53:13 +01006026 conf->group_list = ssl_preset_default_groups;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02006027
6028#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_CLI_C)
6029 conf->dhm_min_bitlen = 1024;
6030#endif
6031 }
6032
Gilles Peskine449bd832023-01-11 14:50:10 +01006033 return 0;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02006034}
6035
6036/*
6037 * Free mbedtls_ssl_config
6038 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006039void mbedtls_ssl_config_free(mbedtls_ssl_config *conf)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02006040{
6041#if defined(MBEDTLS_DHM_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01006042 mbedtls_mpi_free(&conf->dhm_P);
6043 mbedtls_mpi_free(&conf->dhm_G);
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02006044#endif
6045
Ronald Cron73fe8df2022-10-05 14:31:43 +02006046#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED)
Neil Armstrong501c9322022-05-03 09:35:09 +02006047#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01006048 if (!mbedtls_svc_key_id_is_null(conf->psk_opaque)) {
Neil Armstrong501c9322022-05-03 09:35:09 +02006049 conf->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
6050 }
Neil Armstrong8ecd6682022-05-05 11:40:35 +02006051#endif /* MBEDTLS_USE_PSA_CRYPTO */
Gilles Peskine449bd832023-01-11 14:50:10 +01006052 if (conf->psk != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01006053 mbedtls_zeroize_and_free(conf->psk, conf->psk_len);
Azim Khan27e8a122018-03-21 14:24:11 +00006054 conf->psk = NULL;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02006055 conf->psk_len = 0;
junyeonLEE316b1622017-12-20 16:29:30 +09006056 }
6057
Gilles Peskine449bd832023-01-11 14:50:10 +01006058 if (conf->psk_identity != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01006059 mbedtls_zeroize_and_free(conf->psk_identity, conf->psk_identity_len);
Azim Khan27e8a122018-03-21 14:24:11 +00006060 conf->psk_identity = NULL;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02006061 conf->psk_identity_len = 0;
6062 }
Ronald Cron73fe8df2022-10-05 14:31:43 +02006063#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED */
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02006064
6065#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01006066 ssl_key_cert_free(conf->key_cert);
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02006067#endif
6068
Gilles Peskine449bd832023-01-11 14:50:10 +01006069 mbedtls_platform_zeroize(conf, sizeof(mbedtls_ssl_config));
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02006070}
6071
Manuel Pégourié-Gonnard5674a972015-10-19 15:14:03 +02006072#if defined(MBEDTLS_PK_C) && \
Valerio Settie9646ec2023-08-02 20:02:28 +02006073 (defined(MBEDTLS_RSA_C) || defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED))
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02006074/*
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006075 * Convert between MBEDTLS_PK_XXX and SSL_SIG_XXX
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02006076 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006077unsigned char mbedtls_ssl_sig_from_pk(mbedtls_pk_context *pk)
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02006078{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006079#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01006080 if (mbedtls_pk_can_do(pk, MBEDTLS_PK_RSA)) {
6081 return MBEDTLS_SSL_SIG_RSA;
6082 }
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02006083#endif
Valerio Settie9646ec2023-08-02 20:02:28 +02006084#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01006085 if (mbedtls_pk_can_do(pk, MBEDTLS_PK_ECDSA)) {
6086 return MBEDTLS_SSL_SIG_ECDSA;
6087 }
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02006088#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01006089 return MBEDTLS_SSL_SIG_ANON;
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02006090}
6091
Gilles Peskine449bd832023-01-11 14:50:10 +01006092unsigned char mbedtls_ssl_sig_from_pk_alg(mbedtls_pk_type_t type)
Hanno Becker7e5437a2017-04-28 17:15:26 +01006093{
Gilles Peskine449bd832023-01-11 14:50:10 +01006094 switch (type) {
Hanno Becker7e5437a2017-04-28 17:15:26 +01006095 case MBEDTLS_PK_RSA:
Gilles Peskine449bd832023-01-11 14:50:10 +01006096 return MBEDTLS_SSL_SIG_RSA;
Hanno Becker7e5437a2017-04-28 17:15:26 +01006097 case MBEDTLS_PK_ECDSA:
6098 case MBEDTLS_PK_ECKEY:
Gilles Peskine449bd832023-01-11 14:50:10 +01006099 return MBEDTLS_SSL_SIG_ECDSA;
Hanno Becker7e5437a2017-04-28 17:15:26 +01006100 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006101 return MBEDTLS_SSL_SIG_ANON;
Hanno Becker7e5437a2017-04-28 17:15:26 +01006102 }
6103}
6104
Gilles Peskine449bd832023-01-11 14:50:10 +01006105mbedtls_pk_type_t mbedtls_ssl_pk_alg_from_sig(unsigned char sig)
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02006106{
Gilles Peskine449bd832023-01-11 14:50:10 +01006107 switch (sig) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006108#if defined(MBEDTLS_RSA_C)
6109 case MBEDTLS_SSL_SIG_RSA:
Gilles Peskine449bd832023-01-11 14:50:10 +01006110 return MBEDTLS_PK_RSA;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02006111#endif
Valerio Settie9646ec2023-08-02 20:02:28 +02006112#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006113 case MBEDTLS_SSL_SIG_ECDSA:
Gilles Peskine449bd832023-01-11 14:50:10 +01006114 return MBEDTLS_PK_ECDSA;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02006115#endif
6116 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006117 return MBEDTLS_PK_NONE;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02006118 }
6119}
Valerio Settie9646ec2023-08-02 20:02:28 +02006120#endif /* MBEDTLS_PK_C &&
6121 ( MBEDTLS_RSA_C || MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED ) */
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02006122
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02006123/*
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006124 * Convert from MBEDTLS_SSL_HASH_XXX to MBEDTLS_MD_XXX
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02006125 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006126mbedtls_md_type_t mbedtls_ssl_md_alg_from_hash(unsigned char hash)
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02006127{
Gilles Peskine449bd832023-01-11 14:50:10 +01006128 switch (hash) {
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006129#if defined(MBEDTLS_MD_CAN_MD5)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006130 case MBEDTLS_SSL_HASH_MD5:
Gilles Peskine449bd832023-01-11 14:50:10 +01006131 return MBEDTLS_MD_MD5;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02006132#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006133#if defined(MBEDTLS_MD_CAN_SHA1)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006134 case MBEDTLS_SSL_HASH_SHA1:
Gilles Peskine449bd832023-01-11 14:50:10 +01006135 return MBEDTLS_MD_SHA1;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02006136#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006137#if defined(MBEDTLS_MD_CAN_SHA224)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006138 case MBEDTLS_SSL_HASH_SHA224:
Gilles Peskine449bd832023-01-11 14:50:10 +01006139 return MBEDTLS_MD_SHA224;
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02006140#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006141#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006142 case MBEDTLS_SSL_HASH_SHA256:
Gilles Peskine449bd832023-01-11 14:50:10 +01006143 return MBEDTLS_MD_SHA256;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02006144#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006145#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006146 case MBEDTLS_SSL_HASH_SHA384:
Gilles Peskine449bd832023-01-11 14:50:10 +01006147 return MBEDTLS_MD_SHA384;
Mateusz Starzyk3352a532021-04-06 14:28:22 +02006148#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006149#if defined(MBEDTLS_MD_CAN_SHA512)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006150 case MBEDTLS_SSL_HASH_SHA512:
Gilles Peskine449bd832023-01-11 14:50:10 +01006151 return MBEDTLS_MD_SHA512;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02006152#endif
6153 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006154 return MBEDTLS_MD_NONE;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02006155 }
6156}
6157
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006158/*
6159 * Convert from MBEDTLS_MD_XXX to MBEDTLS_SSL_HASH_XXX
6160 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006161unsigned char mbedtls_ssl_hash_from_md_alg(int md)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006162{
Gilles Peskine449bd832023-01-11 14:50:10 +01006163 switch (md) {
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006164#if defined(MBEDTLS_MD_CAN_MD5)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006165 case MBEDTLS_MD_MD5:
Gilles Peskine449bd832023-01-11 14:50:10 +01006166 return MBEDTLS_SSL_HASH_MD5;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006167#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006168#if defined(MBEDTLS_MD_CAN_SHA1)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006169 case MBEDTLS_MD_SHA1:
Gilles Peskine449bd832023-01-11 14:50:10 +01006170 return MBEDTLS_SSL_HASH_SHA1;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006171#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006172#if defined(MBEDTLS_MD_CAN_SHA224)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006173 case MBEDTLS_MD_SHA224:
Gilles Peskine449bd832023-01-11 14:50:10 +01006174 return MBEDTLS_SSL_HASH_SHA224;
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02006175#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006176#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006177 case MBEDTLS_MD_SHA256:
Gilles Peskine449bd832023-01-11 14:50:10 +01006178 return MBEDTLS_SSL_HASH_SHA256;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006179#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006180#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006181 case MBEDTLS_MD_SHA384:
Gilles Peskine449bd832023-01-11 14:50:10 +01006182 return MBEDTLS_SSL_HASH_SHA384;
Mateusz Starzyk3352a532021-04-06 14:28:22 +02006183#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006184#if defined(MBEDTLS_MD_CAN_SHA512)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006185 case MBEDTLS_MD_SHA512:
Gilles Peskine449bd832023-01-11 14:50:10 +01006186 return MBEDTLS_SSL_HASH_SHA512;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006187#endif
6188 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006189 return MBEDTLS_SSL_HASH_NONE;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006190 }
6191}
6192
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01006193/*
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006194 * Check if a curve proposed by the peer is in our list.
Manuel Pégourié-Gonnard9d412d82015-06-17 12:10:46 +02006195 * Return 0 if we're willing to use it, -1 otherwise.
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01006196 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006197int mbedtls_ssl_check_curve_tls_id(const mbedtls_ssl_context *ssl, uint16_t tls_id)
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01006198{
Gilles Peskine449bd832023-01-11 14:50:10 +01006199 const uint16_t *group_list = mbedtls_ssl_get_groups(ssl);
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01006200
Gilles Peskine449bd832023-01-11 14:50:10 +01006201 if (group_list == NULL) {
6202 return -1;
Brett Warrene0edc842021-08-17 09:53:13 +01006203 }
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01006204
Gilles Peskine449bd832023-01-11 14:50:10 +01006205 for (; *group_list != 0; group_list++) {
6206 if (*group_list == tls_id) {
6207 return 0;
6208 }
6209 }
6210
6211 return -1;
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01006212}
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01006213
Valerio Setti49e69072023-06-27 17:27:51 +02006214#if defined(MBEDTLS_PK_HAVE_ECC_KEYS)
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01006215/*
6216 * Same as mbedtls_ssl_check_curve_tls_id() but with a mbedtls_ecp_group_id.
6217 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006218int mbedtls_ssl_check_curve(const mbedtls_ssl_context *ssl, mbedtls_ecp_group_id grp_id)
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01006219{
Gilles Peskine449bd832023-01-11 14:50:10 +01006220 uint16_t tls_id = mbedtls_ssl_get_tls_id_from_ecp_group_id(grp_id);
Leonid Rozenboim19e59732022-08-08 16:52:38 -07006221
Gilles Peskine449bd832023-01-11 14:50:10 +01006222 if (tls_id == 0) {
Leonid Rozenboim19e59732022-08-08 16:52:38 -07006223 return -1;
Gilles Peskine449bd832023-01-11 14:50:10 +01006224 }
Leonid Rozenboim19e59732022-08-08 16:52:38 -07006225
Gilles Peskine449bd832023-01-11 14:50:10 +01006226 return mbedtls_ssl_check_curve_tls_id(ssl, tls_id);
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01006227}
Valerio Setti49e69072023-06-27 17:27:51 +02006228#endif /* MBEDTLS_PK_HAVE_ECC_KEYS */
Valerio Setti67419f02023-01-04 16:12:42 +01006229
Valerio Setti18c9fed2022-12-30 17:44:24 +01006230static const struct {
6231 uint16_t tls_id;
6232 mbedtls_ecp_group_id ecp_group_id;
6233 psa_ecc_family_t psa_family;
6234 uint16_t bits;
Valerio Setti18c9fed2022-12-30 17:44:24 +01006235} tls_id_match_table[] =
6236{
Valerio Settidb6b4db2023-09-01 09:20:51 +02006237#if defined(MBEDTLS_ECP_HAVE_SECP521R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02006238 { 25, MBEDTLS_ECP_DP_SECP521R1, PSA_ECC_FAMILY_SECP_R1, 521 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006239#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02006240#if defined(MBEDTLS_ECP_HAVE_BP512R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02006241 { 28, MBEDTLS_ECP_DP_BP512R1, PSA_ECC_FAMILY_BRAINPOOL_P_R1, 512 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006242#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02006243#if defined(MBEDTLS_ECP_HAVE_SECP384R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02006244 { 24, MBEDTLS_ECP_DP_SECP384R1, PSA_ECC_FAMILY_SECP_R1, 384 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006245#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02006246#if defined(MBEDTLS_ECP_HAVE_BP384R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02006247 { 27, MBEDTLS_ECP_DP_BP384R1, PSA_ECC_FAMILY_BRAINPOOL_P_R1, 384 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006248#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02006249#if defined(MBEDTLS_ECP_HAVE_SECP256R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02006250 { 23, MBEDTLS_ECP_DP_SECP256R1, PSA_ECC_FAMILY_SECP_R1, 256 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006251#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02006252#if defined(MBEDTLS_ECP_HAVE_SECP256K1)
Valerio Settiacd32c02023-06-29 18:06:29 +02006253 { 22, MBEDTLS_ECP_DP_SECP256K1, PSA_ECC_FAMILY_SECP_K1, 256 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006254#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02006255#if defined(MBEDTLS_ECP_HAVE_BP256R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02006256 { 26, MBEDTLS_ECP_DP_BP256R1, PSA_ECC_FAMILY_BRAINPOOL_P_R1, 256 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006257#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02006258#if defined(MBEDTLS_ECP_HAVE_SECP224R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02006259 { 21, MBEDTLS_ECP_DP_SECP224R1, PSA_ECC_FAMILY_SECP_R1, 224 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006260#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02006261#if defined(MBEDTLS_ECP_HAVE_SECP224K1)
Valerio Settiacd32c02023-06-29 18:06:29 +02006262 { 20, MBEDTLS_ECP_DP_SECP224K1, PSA_ECC_FAMILY_SECP_K1, 224 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006263#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02006264#if defined(MBEDTLS_ECP_HAVE_SECP192R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02006265 { 19, MBEDTLS_ECP_DP_SECP192R1, PSA_ECC_FAMILY_SECP_R1, 192 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006266#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02006267#if defined(MBEDTLS_ECP_HAVE_SECP192K1)
Valerio Settiacd32c02023-06-29 18:06:29 +02006268 { 18, MBEDTLS_ECP_DP_SECP192K1, PSA_ECC_FAMILY_SECP_K1, 192 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006269#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02006270#if defined(MBEDTLS_ECP_HAVE_CURVE25519)
Valerio Settiacd32c02023-06-29 18:06:29 +02006271 { 29, MBEDTLS_ECP_DP_CURVE25519, PSA_ECC_FAMILY_MONTGOMERY, 255 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006272#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02006273#if defined(MBEDTLS_ECP_HAVE_CURVE448)
Valerio Settiacd32c02023-06-29 18:06:29 +02006274 { 30, MBEDTLS_ECP_DP_CURVE448, PSA_ECC_FAMILY_MONTGOMERY, 448 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006275#endif
Valerio Settiacd32c02023-06-29 18:06:29 +02006276 { 0, MBEDTLS_ECP_DP_NONE, 0, 0 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006277};
6278
Gilles Peskine449bd832023-01-11 14:50:10 +01006279int mbedtls_ssl_get_psa_curve_info_from_tls_id(uint16_t tls_id,
Przemek Stekielda4fba62023-06-02 14:52:28 +02006280 psa_key_type_t *type,
Gilles Peskine449bd832023-01-11 14:50:10 +01006281 size_t *bits)
Valerio Setti18c9fed2022-12-30 17:44:24 +01006282{
Gilles Peskine449bd832023-01-11 14:50:10 +01006283 for (int i = 0; tls_id_match_table[i].tls_id != 0; i++) {
6284 if (tls_id_match_table[i].tls_id == tls_id) {
Przemek Stekielda4fba62023-06-02 14:52:28 +02006285 if (type != NULL) {
6286 *type = PSA_KEY_TYPE_ECC_KEY_PAIR(tls_id_match_table[i].psa_family);
Gilles Peskine449bd832023-01-11 14:50:10 +01006287 }
6288 if (bits != NULL) {
Valerio Setti18c9fed2022-12-30 17:44:24 +01006289 *bits = tls_id_match_table[i].bits;
Gilles Peskine449bd832023-01-11 14:50:10 +01006290 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01006291 return PSA_SUCCESS;
6292 }
6293 }
6294
6295 return PSA_ERROR_NOT_SUPPORTED;
6296}
6297
Gilles Peskine449bd832023-01-11 14:50:10 +01006298mbedtls_ecp_group_id mbedtls_ssl_get_ecp_group_id_from_tls_id(uint16_t tls_id)
Valerio Setti18c9fed2022-12-30 17:44:24 +01006299{
Gilles Peskine449bd832023-01-11 14:50:10 +01006300 for (int i = 0; tls_id_match_table[i].tls_id != 0; i++) {
6301 if (tls_id_match_table[i].tls_id == tls_id) {
Valerio Setti18c9fed2022-12-30 17:44:24 +01006302 return tls_id_match_table[i].ecp_group_id;
Gilles Peskine449bd832023-01-11 14:50:10 +01006303 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01006304 }
6305
6306 return MBEDTLS_ECP_DP_NONE;
6307}
6308
Gilles Peskine449bd832023-01-11 14:50:10 +01006309uint16_t mbedtls_ssl_get_tls_id_from_ecp_group_id(mbedtls_ecp_group_id grp_id)
Valerio Setti18c9fed2022-12-30 17:44:24 +01006310{
Gilles Peskine449bd832023-01-11 14:50:10 +01006311 for (int i = 0; tls_id_match_table[i].ecp_group_id != MBEDTLS_ECP_DP_NONE;
6312 i++) {
6313 if (tls_id_match_table[i].ecp_group_id == grp_id) {
Valerio Setti18c9fed2022-12-30 17:44:24 +01006314 return tls_id_match_table[i].tls_id;
Gilles Peskine449bd832023-01-11 14:50:10 +01006315 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01006316 }
6317
6318 return 0;
6319}
6320
Valerio Setti67419f02023-01-04 16:12:42 +01006321#if defined(MBEDTLS_DEBUG_C)
Valerio Settiacd32c02023-06-29 18:06:29 +02006322static const struct {
6323 uint16_t tls_id;
6324 const char *name;
6325} tls_id_curve_name_table[] =
6326{
Valerio Setti54e23792023-07-07 10:49:27 +02006327 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP521R1, "secp521r1" },
6328 { MBEDTLS_SSL_IANA_TLS_GROUP_BP512R1, "brainpoolP512r1" },
6329 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1, "secp384r1" },
6330 { MBEDTLS_SSL_IANA_TLS_GROUP_BP384R1, "brainpoolP384r1" },
6331 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1, "secp256r1" },
6332 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP256K1, "secp256k1" },
6333 { MBEDTLS_SSL_IANA_TLS_GROUP_BP256R1, "brainpoolP256r1" },
6334 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP224R1, "secp224r1" },
6335 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP224K1, "secp224k1" },
6336 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP192R1, "secp192r1" },
6337 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP192K1, "secp192k1" },
6338 { MBEDTLS_SSL_IANA_TLS_GROUP_X25519, "x25519" },
6339 { MBEDTLS_SSL_IANA_TLS_GROUP_X448, "x448" },
Valerio Settiacd32c02023-06-29 18:06:29 +02006340 { 0, NULL },
6341};
6342
Gilles Peskine449bd832023-01-11 14:50:10 +01006343const char *mbedtls_ssl_get_curve_name_from_tls_id(uint16_t tls_id)
Valerio Setti18c9fed2022-12-30 17:44:24 +01006344{
Valerio Settiacd32c02023-06-29 18:06:29 +02006345 for (int i = 0; tls_id_curve_name_table[i].tls_id != 0; i++) {
6346 if (tls_id_curve_name_table[i].tls_id == tls_id) {
6347 return tls_id_curve_name_table[i].name;
Gilles Peskine449bd832023-01-11 14:50:10 +01006348 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01006349 }
6350
6351 return NULL;
6352}
Valerio Setti67419f02023-01-04 16:12:42 +01006353#endif
Valerio Setti18c9fed2022-12-30 17:44:24 +01006354
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006355#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01006356int mbedtls_ssl_check_cert_usage(const mbedtls_x509_crt *cert,
6357 const mbedtls_ssl_ciphersuite_t *ciphersuite,
6358 int cert_endpoint,
6359 uint32_t *flags)
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02006360{
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01006361 int ret = 0;
Dave Rodgmanc37ad442023-11-03 23:36:06 +00006362 unsigned int usage = 0;
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02006363 const char *ext_oid;
6364 size_t ext_len;
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02006365
Gilles Peskine449bd832023-01-11 14:50:10 +01006366 if (cert_endpoint == MBEDTLS_SSL_IS_SERVER) {
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02006367 /* Server part of the key exchange */
Gilles Peskine449bd832023-01-11 14:50:10 +01006368 switch (ciphersuite->key_exchange) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006369 case MBEDTLS_KEY_EXCHANGE_RSA:
6370 case MBEDTLS_KEY_EXCHANGE_RSA_PSK:
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01006371 usage = MBEDTLS_X509_KU_KEY_ENCIPHERMENT;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02006372 break;
6373
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006374 case MBEDTLS_KEY_EXCHANGE_DHE_RSA:
6375 case MBEDTLS_KEY_EXCHANGE_ECDHE_RSA:
6376 case MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA:
6377 usage = MBEDTLS_X509_KU_DIGITAL_SIGNATURE;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02006378 break;
6379
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006380 case MBEDTLS_KEY_EXCHANGE_ECDH_RSA:
6381 case MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA:
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01006382 usage = MBEDTLS_X509_KU_KEY_AGREEMENT;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02006383 break;
6384
6385 /* Don't use default: we want warnings when adding new values */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006386 case MBEDTLS_KEY_EXCHANGE_NONE:
6387 case MBEDTLS_KEY_EXCHANGE_PSK:
6388 case MBEDTLS_KEY_EXCHANGE_DHE_PSK:
6389 case MBEDTLS_KEY_EXCHANGE_ECDHE_PSK:
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +02006390 case MBEDTLS_KEY_EXCHANGE_ECJPAKE:
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02006391 usage = 0;
6392 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006393 } else {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006394 /* Client auth: we only implement rsa_sign and mbedtls_ecdsa_sign for now */
6395 usage = MBEDTLS_X509_KU_DIGITAL_SIGNATURE;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02006396 }
6397
Gilles Peskine449bd832023-01-11 14:50:10 +01006398 if (mbedtls_x509_crt_check_key_usage(cert, usage) != 0) {
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01006399 *flags |= MBEDTLS_X509_BADCERT_KEY_USAGE;
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01006400 ret = -1;
6401 }
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02006402
Gilles Peskine449bd832023-01-11 14:50:10 +01006403 if (cert_endpoint == MBEDTLS_SSL_IS_SERVER) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006404 ext_oid = MBEDTLS_OID_SERVER_AUTH;
Gilles Peskine449bd832023-01-11 14:50:10 +01006405 ext_len = MBEDTLS_OID_SIZE(MBEDTLS_OID_SERVER_AUTH);
6406 } else {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006407 ext_oid = MBEDTLS_OID_CLIENT_AUTH;
Gilles Peskine449bd832023-01-11 14:50:10 +01006408 ext_len = MBEDTLS_OID_SIZE(MBEDTLS_OID_CLIENT_AUTH);
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02006409 }
6410
Gilles Peskine449bd832023-01-11 14:50:10 +01006411 if (mbedtls_x509_crt_check_extended_key_usage(cert, ext_oid, ext_len) != 0) {
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01006412 *flags |= MBEDTLS_X509_BADCERT_EXT_KEY_USAGE;
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01006413 ret = -1;
6414 }
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02006415
Gilles Peskine449bd832023-01-11 14:50:10 +01006416 return ret;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02006417}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006418#endif /* MBEDTLS_X509_CRT_PARSE_C */
Manuel Pégourié-Gonnard3a306b92014-04-29 15:11:17 +02006419
Jerry Yu148165c2021-09-24 23:20:59 +08006420#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01006421int mbedtls_ssl_get_handshake_transcript(mbedtls_ssl_context *ssl,
6422 const mbedtls_md_type_t md,
6423 unsigned char *dst,
6424 size_t dst_len,
6425 size_t *olen)
Jerry Yu148165c2021-09-24 23:20:59 +08006426{
Ronald Cronf6893e12022-01-07 22:09:01 +01006427 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
6428 psa_hash_operation_t *hash_operation_to_clone;
6429 psa_hash_operation_t hash_operation = psa_hash_operation_init();
6430
Jerry Yu148165c2021-09-24 23:20:59 +08006431 *olen = 0;
Ronald Cronf6893e12022-01-07 22:09:01 +01006432
Gilles Peskine449bd832023-01-11 14:50:10 +01006433 switch (md) {
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006434#if defined(MBEDTLS_MD_CAN_SHA384)
Gilles Peskine449bd832023-01-11 14:50:10 +01006435 case MBEDTLS_MD_SHA384:
6436 hash_operation_to_clone = &ssl->handshake->fin_sha384_psa;
6437 break;
Ronald Cronf6893e12022-01-07 22:09:01 +01006438#endif
6439
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006440#if defined(MBEDTLS_MD_CAN_SHA256)
Gilles Peskine449bd832023-01-11 14:50:10 +01006441 case MBEDTLS_MD_SHA256:
6442 hash_operation_to_clone = &ssl->handshake->fin_sha256_psa;
6443 break;
Ronald Cronf6893e12022-01-07 22:09:01 +01006444#endif
6445
Gilles Peskine449bd832023-01-11 14:50:10 +01006446 default:
6447 goto exit;
6448 }
6449
6450 status = psa_hash_clone(hash_operation_to_clone, &hash_operation);
6451 if (status != PSA_SUCCESS) {
Ronald Cronf6893e12022-01-07 22:09:01 +01006452 goto exit;
6453 }
6454
Gilles Peskine449bd832023-01-11 14:50:10 +01006455 status = psa_hash_finish(&hash_operation, dst, dst_len, olen);
6456 if (status != PSA_SUCCESS) {
Ronald Cronf6893e12022-01-07 22:09:01 +01006457 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006458 }
Ronald Cronf6893e12022-01-07 22:09:01 +01006459
6460exit:
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006461#if !defined(MBEDTLS_MD_CAN_SHA384) && \
6462 !defined(MBEDTLS_MD_CAN_SHA256)
Andrzej Kurekeabeb302022-10-17 07:52:51 -04006463 (void) ssl;
6464#endif
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05006465 return PSA_TO_MBEDTLS_ERR(status);
Jerry Yu148165c2021-09-24 23:20:59 +08006466}
6467#else /* MBEDTLS_USE_PSA_CRYPTO */
6468
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006469#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006470MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006471static int ssl_get_handshake_transcript_sha384(mbedtls_ssl_context *ssl,
6472 unsigned char *dst,
6473 size_t dst_len,
6474 size_t *olen)
Jerry Yu24c0ec32021-09-09 14:21:07 +08006475{
Jerry Yu24c0ec32021-09-09 14:21:07 +08006476 int ret;
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01006477 mbedtls_md_context_t sha384;
Jerry Yu24c0ec32021-09-09 14:21:07 +08006478
Gilles Peskine449bd832023-01-11 14:50:10 +01006479 if (dst_len < 48) {
6480 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
6481 }
Jerry Yu24c0ec32021-09-09 14:21:07 +08006482
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01006483 mbedtls_md_init(&sha384);
6484 ret = mbedtls_md_setup(&sha384, mbedtls_md_info_from_type(MBEDTLS_MD_SHA384), 0);
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01006485 if (ret != 0) {
6486 goto exit;
6487 }
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01006488 ret = mbedtls_md_clone(&sha384, &ssl->handshake->fin_sha384);
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01006489 if (ret != 0) {
6490 goto exit;
6491 }
Jerry Yu24c0ec32021-09-09 14:21:07 +08006492
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01006493 if ((ret = mbedtls_md_finish(&sha384, dst)) != 0) {
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01006494 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_finish", ret);
Jerry Yu24c0ec32021-09-09 14:21:07 +08006495 goto exit;
6496 }
6497
6498 *olen = 48;
6499
6500exit:
6501
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01006502 mbedtls_md_free(&sha384);
Gilles Peskine449bd832023-01-11 14:50:10 +01006503 return ret;
Jerry Yu24c0ec32021-09-09 14:21:07 +08006504}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006505#endif /* MBEDTLS_MD_CAN_SHA384 */
Jerry Yu24c0ec32021-09-09 14:21:07 +08006506
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006507#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006508MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006509static int ssl_get_handshake_transcript_sha256(mbedtls_ssl_context *ssl,
6510 unsigned char *dst,
6511 size_t dst_len,
6512 size_t *olen)
Jerry Yu24c0ec32021-09-09 14:21:07 +08006513{
Jerry Yu24c0ec32021-09-09 14:21:07 +08006514 int ret;
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01006515 mbedtls_md_context_t sha256;
Jerry Yu24c0ec32021-09-09 14:21:07 +08006516
Gilles Peskine449bd832023-01-11 14:50:10 +01006517 if (dst_len < 32) {
6518 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
6519 }
Jerry Yu24c0ec32021-09-09 14:21:07 +08006520
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01006521 mbedtls_md_init(&sha256);
6522 ret = mbedtls_md_setup(&sha256, mbedtls_md_info_from_type(MBEDTLS_MD_SHA256), 0);
6523 if (ret != 0) {
6524 goto exit;
6525 }
6526 ret = mbedtls_md_clone(&sha256, &ssl->handshake->fin_sha256);
6527 if (ret != 0) {
6528 goto exit;
6529 }
Jerry Yuc5aef882021-12-23 20:15:02 +08006530
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01006531 if ((ret = mbedtls_md_finish(&sha256, dst)) != 0) {
6532 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_finish", ret);
Jerry Yu24c0ec32021-09-09 14:21:07 +08006533 goto exit;
6534 }
6535
6536 *olen = 32;
6537
6538exit:
6539
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01006540 mbedtls_md_free(&sha256);
Gilles Peskine449bd832023-01-11 14:50:10 +01006541 return ret;
Jerry Yu24c0ec32021-09-09 14:21:07 +08006542}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006543#endif /* MBEDTLS_MD_CAN_SHA256 */
Jerry Yu24c0ec32021-09-09 14:21:07 +08006544
Gilles Peskine449bd832023-01-11 14:50:10 +01006545int mbedtls_ssl_get_handshake_transcript(mbedtls_ssl_context *ssl,
6546 const mbedtls_md_type_t md,
6547 unsigned char *dst,
6548 size_t dst_len,
6549 size_t *olen)
Jerry Yu24c0ec32021-09-09 14:21:07 +08006550{
Gilles Peskine449bd832023-01-11 14:50:10 +01006551 switch (md) {
Jerry Yuc1ddeef2021-10-08 15:14:45 +08006552
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006553#if defined(MBEDTLS_MD_CAN_SHA384)
Gilles Peskine449bd832023-01-11 14:50:10 +01006554 case MBEDTLS_MD_SHA384:
6555 return ssl_get_handshake_transcript_sha384(ssl, dst, dst_len, olen);
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006556#endif /* MBEDTLS_MD_CAN_SHA384*/
Jerry Yuc1ddeef2021-10-08 15:14:45 +08006557
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006558#if defined(MBEDTLS_MD_CAN_SHA256)
Gilles Peskine449bd832023-01-11 14:50:10 +01006559 case MBEDTLS_MD_SHA256:
6560 return ssl_get_handshake_transcript_sha256(ssl, dst, dst_len, olen);
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006561#endif /* MBEDTLS_MD_CAN_SHA256*/
Jerry Yuc1ddeef2021-10-08 15:14:45 +08006562
Gilles Peskine449bd832023-01-11 14:50:10 +01006563 default:
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006564#if !defined(MBEDTLS_MD_CAN_SHA384) && \
6565 !defined(MBEDTLS_MD_CAN_SHA256)
Gilles Peskine449bd832023-01-11 14:50:10 +01006566 (void) ssl;
6567 (void) dst;
6568 (void) dst_len;
6569 (void) olen;
Andrzej Kurek409248a2022-10-24 10:33:21 -04006570#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01006571 break;
Jerry Yuc1ddeef2021-10-08 15:14:45 +08006572 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006573 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yu24c0ec32021-09-09 14:21:07 +08006574}
XiaokangQian647719a2021-12-07 09:16:29 +00006575
Jerry Yu148165c2021-09-24 23:20:59 +08006576#endif /* !MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu24c0ec32021-09-09 14:21:07 +08006577
Ronald Crone68ab4f2022-10-05 12:46:29 +02006578#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Gabor Mezei078e8032022-04-27 21:17:56 +02006579/* mbedtls_ssl_parse_sig_alg_ext()
6580 *
6581 * The `extension_data` field of signature algorithm contains a `SignatureSchemeList`
6582 * value (TLS 1.3 RFC8446):
6583 * enum {
6584 * ....
6585 * ecdsa_secp256r1_sha256( 0x0403 ),
6586 * ecdsa_secp384r1_sha384( 0x0503 ),
6587 * ecdsa_secp521r1_sha512( 0x0603 ),
6588 * ....
6589 * } SignatureScheme;
6590 *
6591 * struct {
6592 * SignatureScheme supported_signature_algorithms<2..2^16-2>;
6593 * } SignatureSchemeList;
6594 *
6595 * The `extension_data` field of signature algorithm contains a `SignatureAndHashAlgorithm`
6596 * value (TLS 1.2 RFC5246):
6597 * enum {
6598 * none(0), md5(1), sha1(2), sha224(3), sha256(4), sha384(5),
6599 * sha512(6), (255)
6600 * } HashAlgorithm;
6601 *
6602 * enum { anonymous(0), rsa(1), dsa(2), ecdsa(3), (255) }
6603 * SignatureAlgorithm;
6604 *
6605 * struct {
6606 * HashAlgorithm hash;
6607 * SignatureAlgorithm signature;
6608 * } SignatureAndHashAlgorithm;
6609 *
6610 * SignatureAndHashAlgorithm
6611 * supported_signature_algorithms<2..2^16-2>;
6612 *
6613 * The TLS 1.3 signature algorithm extension was defined to be a compatible
6614 * generalization of the TLS 1.2 signature algorithm extension.
6615 * `SignatureAndHashAlgorithm` field of TLS 1.2 can be represented by
6616 * `SignatureScheme` field of TLS 1.3
6617 *
6618 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006619int mbedtls_ssl_parse_sig_alg_ext(mbedtls_ssl_context *ssl,
6620 const unsigned char *buf,
6621 const unsigned char *end)
Gabor Mezei078e8032022-04-27 21:17:56 +02006622{
6623 const unsigned char *p = buf;
6624 size_t supported_sig_algs_len = 0;
6625 const unsigned char *supported_sig_algs_end;
6626 uint16_t sig_alg;
6627 uint32_t common_idx = 0;
6628
Gilles Peskine449bd832023-01-11 14:50:10 +01006629 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
6630 supported_sig_algs_len = MBEDTLS_GET_UINT16_BE(p, 0);
Gabor Mezei078e8032022-04-27 21:17:56 +02006631 p += 2;
6632
Gilles Peskine449bd832023-01-11 14:50:10 +01006633 memset(ssl->handshake->received_sig_algs, 0,
6634 sizeof(ssl->handshake->received_sig_algs));
Gabor Mezei078e8032022-04-27 21:17:56 +02006635
Gilles Peskine449bd832023-01-11 14:50:10 +01006636 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, supported_sig_algs_len);
Gabor Mezei078e8032022-04-27 21:17:56 +02006637 supported_sig_algs_end = p + supported_sig_algs_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01006638 while (p < supported_sig_algs_end) {
6639 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, supported_sig_algs_end, 2);
6640 sig_alg = MBEDTLS_GET_UINT16_BE(p, 0);
Gabor Mezei078e8032022-04-27 21:17:56 +02006641 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01006642 MBEDTLS_SSL_DEBUG_MSG(4, ("received signature algorithm: 0x%x %s",
6643 sig_alg,
6644 mbedtls_ssl_sig_alg_to_str(sig_alg)));
Jerry Yu2fe6c632022-06-29 10:02:38 +08006645#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01006646 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_2 &&
6647 (!(mbedtls_ssl_sig_alg_is_supported(ssl, sig_alg) &&
6648 mbedtls_ssl_sig_alg_is_offered(ssl, sig_alg)))) {
Gabor Mezei078e8032022-04-27 21:17:56 +02006649 continue;
Jerry Yu2fe6c632022-06-29 10:02:38 +08006650 }
6651#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gabor Mezei078e8032022-04-27 21:17:56 +02006652
Gilles Peskine449bd832023-01-11 14:50:10 +01006653 MBEDTLS_SSL_DEBUG_MSG(4, ("valid signature algorithm: %s",
6654 mbedtls_ssl_sig_alg_to_str(sig_alg)));
Gabor Mezei078e8032022-04-27 21:17:56 +02006655
Gilles Peskine449bd832023-01-11 14:50:10 +01006656 if (common_idx + 1 < MBEDTLS_RECEIVED_SIG_ALGS_SIZE) {
Gabor Mezei078e8032022-04-27 21:17:56 +02006657 ssl->handshake->received_sig_algs[common_idx] = sig_alg;
6658 common_idx += 1;
6659 }
6660 }
6661 /* Check that we consumed all the message. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006662 if (p != end) {
6663 MBEDTLS_SSL_DEBUG_MSG(1,
6664 ("Signature algorithms extension length misaligned"));
6665 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR,
6666 MBEDTLS_ERR_SSL_DECODE_ERROR);
6667 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Gabor Mezei078e8032022-04-27 21:17:56 +02006668 }
6669
Gilles Peskine449bd832023-01-11 14:50:10 +01006670 if (common_idx == 0) {
6671 MBEDTLS_SSL_DEBUG_MSG(3, ("no signature algorithm in common"));
6672 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE,
6673 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE);
6674 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Gabor Mezei078e8032022-04-27 21:17:56 +02006675 }
6676
Gabor Mezei15b95a62022-05-09 16:37:58 +02006677 ssl->handshake->received_sig_algs[common_idx] = MBEDTLS_TLS_SIG_NONE;
Gilles Peskine449bd832023-01-11 14:50:10 +01006678 return 0;
Gabor Mezei078e8032022-04-27 21:17:56 +02006679}
6680
Ronald Crone68ab4f2022-10-05 12:46:29 +02006681#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Gabor Mezei078e8032022-04-27 21:17:56 +02006682
Jerry Yudc7bd172022-02-17 13:44:15 +08006683#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
6684
6685#if defined(MBEDTLS_USE_PSA_CRYPTO)
6686
Gilles Peskine449bd832023-01-11 14:50:10 +01006687static psa_status_t setup_psa_key_derivation(psa_key_derivation_operation_t *derivation,
6688 mbedtls_svc_key_id_t key,
6689 psa_algorithm_t alg,
6690 const unsigned char *raw_psk, size_t raw_psk_length,
6691 const unsigned char *seed, size_t seed_length,
6692 const unsigned char *label, size_t label_length,
6693 const unsigned char *other_secret,
6694 size_t other_secret_length,
6695 size_t capacity)
Jerry Yudc7bd172022-02-17 13:44:15 +08006696{
6697 psa_status_t status;
6698
Gilles Peskine449bd832023-01-11 14:50:10 +01006699 status = psa_key_derivation_setup(derivation, alg);
6700 if (status != PSA_SUCCESS) {
6701 return status;
6702 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006703
Gilles Peskine449bd832023-01-11 14:50:10 +01006704 if (PSA_ALG_IS_TLS12_PRF(alg) || PSA_ALG_IS_TLS12_PSK_TO_MS(alg)) {
6705 status = psa_key_derivation_input_bytes(derivation,
6706 PSA_KEY_DERIVATION_INPUT_SEED,
6707 seed, seed_length);
6708 if (status != PSA_SUCCESS) {
6709 return status;
Przemek Stekiel1f027032022-04-05 17:12:11 +02006710 }
6711
Gilles Peskine449bd832023-01-11 14:50:10 +01006712 if (other_secret != NULL) {
6713 status = psa_key_derivation_input_bytes(derivation,
6714 PSA_KEY_DERIVATION_INPUT_OTHER_SECRET,
6715 other_secret, other_secret_length);
6716 if (status != PSA_SUCCESS) {
6717 return status;
6718 }
6719 }
6720
6721 if (mbedtls_svc_key_id_is_null(key)) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006722 status = psa_key_derivation_input_bytes(
6723 derivation, PSA_KEY_DERIVATION_INPUT_SECRET,
Gilles Peskine449bd832023-01-11 14:50:10 +01006724 raw_psk, raw_psk_length);
6725 } else {
Jerry Yudc7bd172022-02-17 13:44:15 +08006726 status = psa_key_derivation_input_key(
Gilles Peskine449bd832023-01-11 14:50:10 +01006727 derivation, PSA_KEY_DERIVATION_INPUT_SECRET, key);
Jerry Yudc7bd172022-02-17 13:44:15 +08006728 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006729 if (status != PSA_SUCCESS) {
6730 return status;
6731 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006732
Gilles Peskine449bd832023-01-11 14:50:10 +01006733 status = psa_key_derivation_input_bytes(derivation,
6734 PSA_KEY_DERIVATION_INPUT_LABEL,
6735 label, label_length);
6736 if (status != PSA_SUCCESS) {
6737 return status;
6738 }
6739 } else {
6740 return PSA_ERROR_NOT_SUPPORTED;
Jerry Yudc7bd172022-02-17 13:44:15 +08006741 }
6742
Gilles Peskine449bd832023-01-11 14:50:10 +01006743 status = psa_key_derivation_set_capacity(derivation, capacity);
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 return PSA_SUCCESS;
Jerry Yudc7bd172022-02-17 13:44:15 +08006749}
6750
Andrzej Kurek57d10632022-10-24 10:32:01 -04006751#if defined(PSA_WANT_ALG_SHA_384) || \
6752 defined(PSA_WANT_ALG_SHA_256)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006753MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006754static int tls_prf_generic(mbedtls_md_type_t md_type,
6755 const unsigned char *secret, size_t slen,
6756 const char *label,
6757 const unsigned char *random, size_t rlen,
6758 unsigned char *dstbuf, size_t dlen)
Jerry Yudc7bd172022-02-17 13:44:15 +08006759{
6760 psa_status_t status;
6761 psa_algorithm_t alg;
6762 mbedtls_svc_key_id_t master_key = MBEDTLS_SVC_KEY_ID_INIT;
6763 psa_key_derivation_operation_t derivation =
6764 PSA_KEY_DERIVATION_OPERATION_INIT;
6765
Gilles Peskine449bd832023-01-11 14:50:10 +01006766 if (md_type == MBEDTLS_MD_SHA384) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006767 alg = PSA_ALG_TLS12_PRF(PSA_ALG_SHA_384);
Gilles Peskine449bd832023-01-11 14:50:10 +01006768 } else {
Jerry Yudc7bd172022-02-17 13:44:15 +08006769 alg = PSA_ALG_TLS12_PRF(PSA_ALG_SHA_256);
Gilles Peskine449bd832023-01-11 14:50:10 +01006770 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006771
6772 /* Normally a "secret" should be long enough to be impossible to
6773 * find by brute force, and in particular should not be empty. But
6774 * this PRF is also used to derive an IV, in particular in EAP-TLS,
6775 * and for this use case it makes sense to have a 0-length "secret".
6776 * Since the key API doesn't allow importing a key of length 0,
6777 * keep master_key=0, which setup_psa_key_derivation() understands
6778 * to mean a 0-length "secret" input. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006779 if (slen != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006780 psa_key_attributes_t key_attributes = psa_key_attributes_init();
Gilles Peskine449bd832023-01-11 14:50:10 +01006781 psa_set_key_usage_flags(&key_attributes, PSA_KEY_USAGE_DERIVE);
6782 psa_set_key_algorithm(&key_attributes, alg);
6783 psa_set_key_type(&key_attributes, PSA_KEY_TYPE_DERIVE);
Jerry Yudc7bd172022-02-17 13:44:15 +08006784
Gilles Peskine449bd832023-01-11 14:50:10 +01006785 status = psa_import_key(&key_attributes, secret, slen, &master_key);
6786 if (status != PSA_SUCCESS) {
6787 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
6788 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006789 }
6790
Gilles Peskine449bd832023-01-11 14:50:10 +01006791 status = setup_psa_key_derivation(&derivation,
6792 master_key, alg,
6793 NULL, 0,
6794 random, rlen,
6795 (unsigned char const *) label,
6796 (size_t) strlen(label),
6797 NULL, 0,
6798 dlen);
6799 if (status != PSA_SUCCESS) {
6800 psa_key_derivation_abort(&derivation);
6801 psa_destroy_key(master_key);
6802 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yudc7bd172022-02-17 13:44:15 +08006803 }
6804
Gilles Peskine449bd832023-01-11 14:50:10 +01006805 status = psa_key_derivation_output_bytes(&derivation, dstbuf, dlen);
6806 if (status != PSA_SUCCESS) {
6807 psa_key_derivation_abort(&derivation);
6808 psa_destroy_key(master_key);
6809 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yudc7bd172022-02-17 13:44:15 +08006810 }
6811
Gilles Peskine449bd832023-01-11 14:50:10 +01006812 status = psa_key_derivation_abort(&derivation);
6813 if (status != PSA_SUCCESS) {
6814 psa_destroy_key(master_key);
6815 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yudc7bd172022-02-17 13:44:15 +08006816 }
6817
Gilles Peskine449bd832023-01-11 14:50:10 +01006818 if (!mbedtls_svc_key_id_is_null(master_key)) {
6819 status = psa_destroy_key(master_key);
6820 }
6821 if (status != PSA_SUCCESS) {
6822 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
6823 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006824
Gilles Peskine449bd832023-01-11 14:50:10 +01006825 return 0;
Jerry Yudc7bd172022-02-17 13:44:15 +08006826}
Andrzej Kurek57d10632022-10-24 10:32:01 -04006827#endif /* PSA_WANT_ALG_SHA_256 || PSA_WANT_ALG_SHA_384 */
Jerry Yudc7bd172022-02-17 13:44:15 +08006828#else /* MBEDTLS_USE_PSA_CRYPTO */
6829
Andrzej Kurek57d10632022-10-24 10:32:01 -04006830#if defined(MBEDTLS_MD_C) && \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006831 (defined(MBEDTLS_MD_CAN_SHA256) || \
6832 defined(MBEDTLS_MD_CAN_SHA384))
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006833MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006834static int tls_prf_generic(mbedtls_md_type_t md_type,
6835 const unsigned char *secret, size_t slen,
6836 const char *label,
6837 const unsigned char *random, size_t rlen,
6838 unsigned char *dstbuf, size_t dlen)
Jerry Yudc7bd172022-02-17 13:44:15 +08006839{
6840 size_t nb;
6841 size_t i, j, k, md_len;
6842 unsigned char *tmp;
6843 size_t tmp_len = 0;
6844 unsigned char h_i[MBEDTLS_MD_MAX_SIZE];
6845 const mbedtls_md_info_t *md_info;
6846 mbedtls_md_context_t md_ctx;
6847 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6848
Gilles Peskine449bd832023-01-11 14:50:10 +01006849 mbedtls_md_init(&md_ctx);
Jerry Yudc7bd172022-02-17 13:44:15 +08006850
Gilles Peskine449bd832023-01-11 14:50:10 +01006851 if ((md_info = mbedtls_md_info_from_type(md_type)) == NULL) {
6852 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
6853 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006854
Gilles Peskine449bd832023-01-11 14:50:10 +01006855 md_len = mbedtls_md_get_size(md_info);
Jerry Yudc7bd172022-02-17 13:44:15 +08006856
Gilles Peskine449bd832023-01-11 14:50:10 +01006857 tmp_len = md_len + strlen(label) + rlen;
6858 tmp = mbedtls_calloc(1, tmp_len);
6859 if (tmp == NULL) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006860 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
6861 goto exit;
6862 }
6863
Gilles Peskine449bd832023-01-11 14:50:10 +01006864 nb = strlen(label);
6865 memcpy(tmp + md_len, label, nb);
6866 memcpy(tmp + md_len + nb, random, rlen);
Jerry Yudc7bd172022-02-17 13:44:15 +08006867 nb += rlen;
6868
6869 /*
6870 * Compute P_<hash>(secret, label + random)[0..dlen]
6871 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006872 if ((ret = mbedtls_md_setup(&md_ctx, md_info, 1)) != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006873 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006874 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006875
Gilles Peskine449bd832023-01-11 14:50:10 +01006876 ret = mbedtls_md_hmac_starts(&md_ctx, secret, slen);
6877 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006878 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006879 }
6880 ret = mbedtls_md_hmac_update(&md_ctx, tmp + md_len, nb);
6881 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006882 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006883 }
6884 ret = mbedtls_md_hmac_finish(&md_ctx, tmp);
6885 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006886 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006887 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006888
Gilles Peskine449bd832023-01-11 14:50:10 +01006889 for (i = 0; i < dlen; i += md_len) {
6890 ret = mbedtls_md_hmac_reset(&md_ctx);
6891 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006892 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006893 }
6894 ret = mbedtls_md_hmac_update(&md_ctx, tmp, md_len + nb);
6895 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006896 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006897 }
6898 ret = mbedtls_md_hmac_finish(&md_ctx, h_i);
6899 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006900 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006901 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006902
Gilles Peskine449bd832023-01-11 14:50:10 +01006903 ret = mbedtls_md_hmac_reset(&md_ctx);
6904 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006905 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006906 }
6907 ret = mbedtls_md_hmac_update(&md_ctx, tmp, md_len);
6908 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006909 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006910 }
6911 ret = mbedtls_md_hmac_finish(&md_ctx, tmp);
6912 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006913 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006914 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006915
Gilles Peskine449bd832023-01-11 14:50:10 +01006916 k = (i + md_len > dlen) ? dlen % md_len : md_len;
Jerry Yudc7bd172022-02-17 13:44:15 +08006917
Gilles Peskine449bd832023-01-11 14:50:10 +01006918 for (j = 0; j < k; j++) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006919 dstbuf[i + j] = h_i[j];
Gilles Peskine449bd832023-01-11 14:50:10 +01006920 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006921 }
6922
6923exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01006924 mbedtls_md_free(&md_ctx);
Jerry Yudc7bd172022-02-17 13:44:15 +08006925
Gilles Peskine449bd832023-01-11 14:50:10 +01006926 if (tmp != NULL) {
6927 mbedtls_platform_zeroize(tmp, tmp_len);
6928 }
Dave Rodgman29b9b2b2022-11-01 16:08:14 +00006929
Gilles Peskine449bd832023-01-11 14:50:10 +01006930 mbedtls_platform_zeroize(h_i, sizeof(h_i));
Jerry Yudc7bd172022-02-17 13:44:15 +08006931
Gilles Peskine449bd832023-01-11 14:50:10 +01006932 mbedtls_free(tmp);
Jerry Yudc7bd172022-02-17 13:44:15 +08006933
Gilles Peskine449bd832023-01-11 14:50:10 +01006934 return ret;
Jerry Yudc7bd172022-02-17 13:44:15 +08006935}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006936#endif /* MBEDTLS_MD_C && ( MBEDTLS_MD_CAN_SHA256 || MBEDTLS_MD_CAN_SHA384 ) */
Jerry Yudc7bd172022-02-17 13:44:15 +08006937#endif /* MBEDTLS_USE_PSA_CRYPTO */
6938
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006939#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006940MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006941static int tls_prf_sha256(const unsigned char *secret, size_t slen,
6942 const char *label,
6943 const unsigned char *random, size_t rlen,
6944 unsigned char *dstbuf, size_t dlen)
Jerry Yudc7bd172022-02-17 13:44:15 +08006945{
Gilles Peskine449bd832023-01-11 14:50:10 +01006946 return tls_prf_generic(MBEDTLS_MD_SHA256, secret, slen,
6947 label, random, rlen, dstbuf, dlen);
Jerry Yudc7bd172022-02-17 13:44:15 +08006948}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006949#endif /* MBEDTLS_MD_CAN_SHA256*/
Jerry Yudc7bd172022-02-17 13:44:15 +08006950
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006951#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006952MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006953static int tls_prf_sha384(const unsigned char *secret, size_t slen,
6954 const char *label,
6955 const unsigned char *random, size_t rlen,
6956 unsigned char *dstbuf, size_t dlen)
Jerry Yudc7bd172022-02-17 13:44:15 +08006957{
Gilles Peskine449bd832023-01-11 14:50:10 +01006958 return tls_prf_generic(MBEDTLS_MD_SHA384, secret, slen,
6959 label, random, rlen, dstbuf, dlen);
Jerry Yudc7bd172022-02-17 13:44:15 +08006960}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006961#endif /* MBEDTLS_MD_CAN_SHA384*/
Jerry Yudc7bd172022-02-17 13:44:15 +08006962
Jerry Yuf009d862022-02-17 14:01:37 +08006963/*
6964 * Set appropriate PRF function and other SSL / TLS1.2 functions
6965 *
6966 * Inputs:
Jerry Yuf009d862022-02-17 14:01:37 +08006967 * - hash associated with the ciphersuite (only used by TLS 1.2)
6968 *
6969 * Outputs:
6970 * - the tls_prf, calc_verify and calc_finished members of handshake structure
6971 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006972MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006973static int ssl_set_handshake_prfs(mbedtls_ssl_handshake_params *handshake,
6974 mbedtls_md_type_t hash)
Jerry Yuf009d862022-02-17 14:01:37 +08006975{
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006976#if defined(MBEDTLS_MD_CAN_SHA384)
Gilles Peskine449bd832023-01-11 14:50:10 +01006977 if (hash == MBEDTLS_MD_SHA384) {
Jerry Yuf009d862022-02-17 14:01:37 +08006978 handshake->tls_prf = tls_prf_sha384;
6979 handshake->calc_verify = ssl_calc_verify_tls_sha384;
6980 handshake->calc_finished = ssl_calc_finished_tls_sha384;
Gilles Peskine449bd832023-01-11 14:50:10 +01006981 } else
Jerry Yuf009d862022-02-17 14:01:37 +08006982#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006983#if defined(MBEDTLS_MD_CAN_SHA256)
Jerry Yuf009d862022-02-17 14:01:37 +08006984 {
Ronald Cron81591aa2022-03-07 09:05:51 +01006985 (void) hash;
Jerry Yuf009d862022-02-17 14:01:37 +08006986 handshake->tls_prf = tls_prf_sha256;
6987 handshake->calc_verify = ssl_calc_verify_tls_sha256;
6988 handshake->calc_finished = ssl_calc_finished_tls_sha256;
6989 }
Ronald Cron81591aa2022-03-07 09:05:51 +01006990#else
Jerry Yuf009d862022-02-17 14:01:37 +08006991 {
Jerry Yuf009d862022-02-17 14:01:37 +08006992 (void) handshake;
Ronald Cron81591aa2022-03-07 09:05:51 +01006993 (void) hash;
Gilles Peskine449bd832023-01-11 14:50:10 +01006994 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yuf009d862022-02-17 14:01:37 +08006995 }
Ronald Cron81591aa2022-03-07 09:05:51 +01006996#endif
Jerry Yuf009d862022-02-17 14:01:37 +08006997
Gilles Peskine449bd832023-01-11 14:50:10 +01006998 return 0;
Jerry Yuf009d862022-02-17 14:01:37 +08006999}
Jerry Yud6ab2352022-02-17 14:03:43 +08007000
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007001/*
7002 * Compute master secret if needed
7003 *
7004 * Parameters:
7005 * [in/out] handshake
7006 * [in] resume, premaster, extended_ms, calc_verify, tls_prf
7007 * (PSA-PSK) ciphersuite_info, psk_opaque
7008 * [out] premaster (cleared)
7009 * [out] master
7010 * [in] ssl: optionally used for debugging, EMS and PSA-PSK
7011 * debug: conf->f_dbg, conf->p_dbg
7012 * EMS: passed to calc_verify (debug + session_negotiate)
Ronald Crona25cf582022-03-07 11:10:36 +01007013 * PSA-PSA: conf
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007014 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007015MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007016static int ssl_compute_master(mbedtls_ssl_handshake_params *handshake,
7017 unsigned char *master,
7018 const mbedtls_ssl_context *ssl)
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007019{
7020 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7021
7022 /* cf. RFC 5246, Section 8.1:
7023 * "The master secret is always exactly 48 bytes in length." */
7024 size_t const master_secret_len = 48;
7025
7026#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
7027 unsigned char session_hash[48];
7028#endif /* MBEDTLS_SSL_EXTENDED_MASTER_SECRET */
7029
7030 /* The label for the KDF used for key expansion.
7031 * This is either "master secret" or "extended master secret"
7032 * depending on whether the Extended Master Secret extension
7033 * is used. */
7034 char const *lbl = "master secret";
7035
Przemek Stekielae4ed302022-04-05 17:15:55 +02007036 /* The seed for the KDF used for key expansion.
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007037 * - If the Extended Master Secret extension is not used,
7038 * this is ClientHello.Random + ServerHello.Random
7039 * (see Sect. 8.1 in RFC 5246).
7040 * - If the Extended Master Secret extension is used,
7041 * this is the transcript of the handshake so far.
7042 * (see Sect. 4 in RFC 7627). */
Przemek Stekielae4ed302022-04-05 17:15:55 +02007043 unsigned char const *seed = handshake->randbytes;
7044 size_t seed_len = 64;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007045
7046#if !defined(MBEDTLS_DEBUG_C) && \
7047 !defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET) && \
7048 !(defined(MBEDTLS_USE_PSA_CRYPTO) && \
Gilles Peskine449bd832023-01-11 14:50:10 +01007049 defined(MBEDTLS_KEY_EXCHANGE_PSK_ENABLED))
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007050 ssl = NULL; /* make sure we don't use it except for those cases */
7051 (void) ssl;
7052#endif
7053
Gilles Peskine449bd832023-01-11 14:50:10 +01007054 if (handshake->resume != 0) {
7055 MBEDTLS_SSL_DEBUG_MSG(3, ("no premaster (session resumed)"));
7056 return 0;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007057 }
7058
7059#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
Gilles Peskine449bd832023-01-11 14:50:10 +01007060 if (handshake->extended_ms == MBEDTLS_SSL_EXTENDED_MS_ENABLED) {
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007061 lbl = "extended master secret";
Przemek Stekielae4ed302022-04-05 17:15:55 +02007062 seed = session_hash;
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01007063 ret = handshake->calc_verify(ssl, session_hash, &seed_len);
7064 if (ret != 0) {
7065 MBEDTLS_SSL_DEBUG_RET(1, "calc_verify", ret);
7066 }
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007067
Gilles Peskine449bd832023-01-11 14:50:10 +01007068 MBEDTLS_SSL_DEBUG_BUF(3, "session hash for extended master secret",
7069 session_hash, seed_len);
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007070 }
Przemek Stekiel169bf0b2022-04-29 07:53:29 +02007071#endif /* MBEDTLS_SSL_EXTENDED_MASTER_SECRET */
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007072
Przemek Stekiel99114f32022-04-22 11:20:09 +02007073#if defined(MBEDTLS_USE_PSA_CRYPTO) && \
Przemek Stekiel8a4b7fd2022-04-28 09:22:22 +02007074 defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007075 if (mbedtls_ssl_ciphersuite_uses_psk(handshake->ciphersuite_info) == 1) {
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007076 /* Perform PSK-to-MS expansion in a single step. */
7077 psa_status_t status;
7078 psa_algorithm_t alg;
7079 mbedtls_svc_key_id_t psk;
7080 psa_key_derivation_operation_t derivation =
7081 PSA_KEY_DERIVATION_OPERATION_INIT;
Dave Rodgman2eab4622023-10-05 13:30:37 +01007082 mbedtls_md_type_t hash_alg = (mbedtls_md_type_t) handshake->ciphersuite_info->mac;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007083
Gilles Peskine449bd832023-01-11 14:50:10 +01007084 MBEDTLS_SSL_DEBUG_MSG(2, ("perform PSA-based PSK-to-MS expansion"));
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007085
Gilles Peskine449bd832023-01-11 14:50:10 +01007086 psk = mbedtls_ssl_get_opaque_psk(ssl);
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007087
Gilles Peskine449bd832023-01-11 14:50:10 +01007088 if (hash_alg == MBEDTLS_MD_SHA384) {
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007089 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_384);
Gilles Peskine449bd832023-01-11 14:50:10 +01007090 } else {
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007091 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_256);
Gilles Peskine449bd832023-01-11 14:50:10 +01007092 }
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007093
Przemek Stekiel51a1f362022-04-13 08:57:06 +02007094 size_t other_secret_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01007095 unsigned char *other_secret = NULL;
Przemek Stekielc2033402022-04-05 17:19:41 +02007096
Gilles Peskine449bd832023-01-11 14:50:10 +01007097 switch (handshake->ciphersuite_info->key_exchange) {
Przemek Stekiel19b80f82022-04-14 08:29:31 +02007098 /* Provide other secret.
Przemek Stekiel51a1f362022-04-13 08:57:06 +02007099 * Other secret is stored in premaster, where first 2 bytes hold the
Przemek Stekiel19b80f82022-04-14 08:29:31 +02007100 * length of the other key.
Przemek Stekielc2033402022-04-05 17:19:41 +02007101 */
Przemek Stekiel19b80f82022-04-14 08:29:31 +02007102 case MBEDTLS_KEY_EXCHANGE_RSA_PSK:
Przemek Stekiel8abcee92022-04-28 09:16:28 +02007103 /* For RSA-PSK other key length is always 48 bytes. */
Przemek Stekiel19b80f82022-04-14 08:29:31 +02007104 other_secret_len = 48;
7105 other_secret = handshake->premaster + 2;
7106 break;
7107 case MBEDTLS_KEY_EXCHANGE_ECDHE_PSK:
Przemek Stekielb293aaa2022-04-19 12:22:38 +02007108 case MBEDTLS_KEY_EXCHANGE_DHE_PSK:
Przemek Stekiel19b80f82022-04-14 08:29:31 +02007109 other_secret_len = MBEDTLS_GET_UINT16_BE(handshake->premaster, 0);
7110 other_secret = handshake->premaster + 2;
7111 break;
7112 default:
7113 break;
Przemek Stekielc2033402022-04-05 17:19:41 +02007114 }
7115
Gilles Peskine449bd832023-01-11 14:50:10 +01007116 status = setup_psa_key_derivation(&derivation, psk, alg,
7117 ssl->conf->psk, ssl->conf->psk_len,
7118 seed, seed_len,
7119 (unsigned char const *) lbl,
7120 (size_t) strlen(lbl),
7121 other_secret, other_secret_len,
7122 master_secret_len);
7123 if (status != PSA_SUCCESS) {
7124 psa_key_derivation_abort(&derivation);
7125 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007126 }
7127
Gilles Peskine449bd832023-01-11 14:50:10 +01007128 status = psa_key_derivation_output_bytes(&derivation,
7129 master,
7130 master_secret_len);
7131 if (status != PSA_SUCCESS) {
7132 psa_key_derivation_abort(&derivation);
7133 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007134 }
7135
Gilles Peskine449bd832023-01-11 14:50:10 +01007136 status = psa_key_derivation_abort(&derivation);
7137 if (status != PSA_SUCCESS) {
7138 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
7139 }
7140 } else
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007141#endif
7142 {
Neil Armstrongca7d5062022-05-31 14:43:23 +02007143#if defined(MBEDTLS_USE_PSA_CRYPTO) && \
Gilles Peskine449bd832023-01-11 14:50:10 +01007144 defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
7145 if (handshake->ciphersuite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_ECJPAKE) {
Neil Armstrongca7d5062022-05-31 14:43:23 +02007146 psa_status_t status;
7147 psa_algorithm_t alg = PSA_ALG_TLS12_ECJPAKE_TO_PMS;
7148 psa_key_derivation_operation_t derivation =
7149 PSA_KEY_DERIVATION_OPERATION_INIT;
7150
Gilles Peskine449bd832023-01-11 14:50:10 +01007151 MBEDTLS_SSL_DEBUG_MSG(2, ("perform PSA-based PMS KDF for ECJPAKE"));
Neil Armstrongca7d5062022-05-31 14:43:23 +02007152
7153 handshake->pmslen = PSA_TLS12_ECJPAKE_TO_PMS_DATA_SIZE;
7154
Gilles Peskine449bd832023-01-11 14:50:10 +01007155 status = psa_key_derivation_setup(&derivation, alg);
7156 if (status != PSA_SUCCESS) {
7157 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Neil Armstrongca7d5062022-05-31 14:43:23 +02007158 }
7159
Gilles Peskine449bd832023-01-11 14:50:10 +01007160 status = psa_key_derivation_set_capacity(&derivation,
7161 PSA_TLS12_ECJPAKE_TO_PMS_DATA_SIZE);
7162 if (status != PSA_SUCCESS) {
7163 psa_key_derivation_abort(&derivation);
7164 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Neil Armstrongca7d5062022-05-31 14:43:23 +02007165 }
7166
Gilles Peskine449bd832023-01-11 14:50:10 +01007167 status = psa_pake_get_implicit_key(&handshake->psa_pake_ctx,
7168 &derivation);
7169 if (status != PSA_SUCCESS) {
7170 psa_key_derivation_abort(&derivation);
7171 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Neil Armstrongca7d5062022-05-31 14:43:23 +02007172 }
7173
Gilles Peskine449bd832023-01-11 14:50:10 +01007174 status = psa_key_derivation_output_bytes(&derivation,
7175 handshake->premaster,
7176 handshake->pmslen);
7177 if (status != PSA_SUCCESS) {
7178 psa_key_derivation_abort(&derivation);
7179 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
7180 }
7181
7182 status = psa_key_derivation_abort(&derivation);
7183 if (status != PSA_SUCCESS) {
7184 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Neil Armstrongca7d5062022-05-31 14:43:23 +02007185 }
7186 }
7187#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01007188 ret = handshake->tls_prf(handshake->premaster, handshake->pmslen,
7189 lbl, seed, seed_len,
7190 master,
7191 master_secret_len);
7192 if (ret != 0) {
7193 MBEDTLS_SSL_DEBUG_RET(1, "prf", ret);
7194 return ret;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007195 }
7196
Gilles Peskine449bd832023-01-11 14:50:10 +01007197 MBEDTLS_SSL_DEBUG_BUF(3, "premaster secret",
7198 handshake->premaster,
7199 handshake->pmslen);
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007200
Gilles Peskine449bd832023-01-11 14:50:10 +01007201 mbedtls_platform_zeroize(handshake->premaster,
7202 sizeof(handshake->premaster));
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007203 }
7204
Gilles Peskine449bd832023-01-11 14:50:10 +01007205 return 0;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007206}
7207
Gilles Peskine449bd832023-01-11 14:50:10 +01007208int mbedtls_ssl_derive_keys(mbedtls_ssl_context *ssl)
Jerry Yud62f87e2022-02-17 14:09:02 +08007209{
7210 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7211 const mbedtls_ssl_ciphersuite_t * const ciphersuite_info =
7212 ssl->handshake->ciphersuite_info;
7213
Gilles Peskine449bd832023-01-11 14:50:10 +01007214 MBEDTLS_SSL_DEBUG_MSG(2, ("=> derive keys"));
Jerry Yud62f87e2022-02-17 14:09:02 +08007215
7216 /* Set PRF, calc_verify and calc_finished function pointers */
Gilles Peskine449bd832023-01-11 14:50:10 +01007217 ret = ssl_set_handshake_prfs(ssl->handshake,
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01007218 (mbedtls_md_type_t) ciphersuite_info->mac);
Gilles Peskine449bd832023-01-11 14:50:10 +01007219 if (ret != 0) {
7220 MBEDTLS_SSL_DEBUG_RET(1, "ssl_set_handshake_prfs", ret);
7221 return ret;
Jerry Yud62f87e2022-02-17 14:09:02 +08007222 }
7223
7224 /* Compute master secret if needed */
Gilles Peskine449bd832023-01-11 14:50:10 +01007225 ret = ssl_compute_master(ssl->handshake,
7226 ssl->session_negotiate->master,
7227 ssl);
7228 if (ret != 0) {
7229 MBEDTLS_SSL_DEBUG_RET(1, "ssl_compute_master", ret);
7230 return ret;
Jerry Yud62f87e2022-02-17 14:09:02 +08007231 }
7232
7233 /* Swap the client and server random values:
7234 * - MS derivation wanted client+server (RFC 5246 8.1)
7235 * - key derivation wants server+client (RFC 5246 6.3) */
7236 {
7237 unsigned char tmp[64];
Gilles Peskine449bd832023-01-11 14:50:10 +01007238 memcpy(tmp, ssl->handshake->randbytes, 64);
7239 memcpy(ssl->handshake->randbytes, tmp + 32, 32);
7240 memcpy(ssl->handshake->randbytes + 32, tmp, 32);
7241 mbedtls_platform_zeroize(tmp, sizeof(tmp));
Jerry Yud62f87e2022-02-17 14:09:02 +08007242 }
7243
7244 /* Populate transform structure */
Gilles Peskine449bd832023-01-11 14:50:10 +01007245 ret = ssl_tls12_populate_transform(ssl->transform_negotiate,
7246 ssl->session_negotiate->ciphersuite,
7247 ssl->session_negotiate->master,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02007248#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01007249 ssl->session_negotiate->encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02007250#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01007251 ssl->handshake->tls_prf,
7252 ssl->handshake->randbytes,
7253 ssl->tls_version,
7254 ssl->conf->endpoint,
7255 ssl);
7256 if (ret != 0) {
7257 MBEDTLS_SSL_DEBUG_RET(1, "ssl_tls12_populate_transform", ret);
7258 return ret;
Jerry Yud62f87e2022-02-17 14:09:02 +08007259 }
7260
7261 /* We no longer need Server/ClientHello.random values */
Gilles Peskine449bd832023-01-11 14:50:10 +01007262 mbedtls_platform_zeroize(ssl->handshake->randbytes,
7263 sizeof(ssl->handshake->randbytes));
Jerry Yud62f87e2022-02-17 14:09:02 +08007264
Gilles Peskine449bd832023-01-11 14:50:10 +01007265 MBEDTLS_SSL_DEBUG_MSG(2, ("<= derive keys"));
Jerry Yud62f87e2022-02-17 14:09:02 +08007266
Gilles Peskine449bd832023-01-11 14:50:10 +01007267 return 0;
Jerry Yud62f87e2022-02-17 14:09:02 +08007268}
Jerry Yu8392e0d2022-02-17 14:10:24 +08007269
Gilles Peskine449bd832023-01-11 14:50:10 +01007270int mbedtls_ssl_set_calc_verify_md(mbedtls_ssl_context *ssl, int md)
Ronald Cron4dcbca92022-03-07 10:21:40 +01007271{
Gilles Peskine449bd832023-01-11 14:50:10 +01007272 switch (md) {
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01007273#if defined(MBEDTLS_MD_CAN_SHA384)
Ronald Cron4dcbca92022-03-07 10:21:40 +01007274 case MBEDTLS_SSL_HASH_SHA384:
7275 ssl->handshake->calc_verify = ssl_calc_verify_tls_sha384;
7276 break;
7277#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01007278#if defined(MBEDTLS_MD_CAN_SHA256)
Ronald Cron4dcbca92022-03-07 10:21:40 +01007279 case MBEDTLS_SSL_HASH_SHA256:
7280 ssl->handshake->calc_verify = ssl_calc_verify_tls_sha256;
7281 break;
7282#endif
7283 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01007284 return -1;
Ronald Cron4dcbca92022-03-07 10:21:40 +01007285 }
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01007286#if !defined(MBEDTLS_MD_CAN_SHA384) && \
7287 !defined(MBEDTLS_MD_CAN_SHA256)
Andrzej Kurekeabeb302022-10-17 07:52:51 -04007288 (void) ssl;
7289#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01007290 return 0;
Ronald Cron4dcbca92022-03-07 10:21:40 +01007291}
7292
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007293#if defined(MBEDTLS_USE_PSA_CRYPTO)
7294static int ssl_calc_verify_tls_psa(const mbedtls_ssl_context *ssl,
7295 const psa_hash_operation_t *hs_op,
7296 size_t buffer_size,
7297 unsigned char *hash,
7298 size_t *hlen)
7299{
7300 psa_status_t status;
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007301 psa_hash_operation_t cloned_op = psa_hash_operation_init();
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007302
7303#if !defined(MBEDTLS_DEBUG_C)
7304 (void) ssl;
7305#endif
7306 MBEDTLS_SSL_DEBUG_MSG(2, ("=> PSA calc verify"));
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007307 status = psa_hash_clone(hs_op, &cloned_op);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007308 if (status != PSA_SUCCESS) {
7309 goto exit;
7310 }
7311
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007312 status = psa_hash_finish(&cloned_op, hash, buffer_size, hlen);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007313 if (status != PSA_SUCCESS) {
7314 goto exit;
7315 }
7316
7317 MBEDTLS_SSL_DEBUG_BUF(3, "PSA calculated verify result", hash, *hlen);
7318 MBEDTLS_SSL_DEBUG_MSG(2, ("<= PSA calc verify"));
7319
7320exit:
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007321 psa_hash_abort(&cloned_op);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007322 return mbedtls_md_error_from_psa(status);
7323}
7324#else
7325static int ssl_calc_verify_tls_legacy(const mbedtls_ssl_context *ssl,
7326 const mbedtls_md_context_t *hs_ctx,
7327 unsigned char *hash,
7328 size_t *hlen)
7329{
7330 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007331 mbedtls_md_context_t cloned_ctx;
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007332
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007333 mbedtls_md_init(&cloned_ctx);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007334
7335#if !defined(MBEDTLS_DEBUG_C)
7336 (void) ssl;
7337#endif
7338 MBEDTLS_SSL_DEBUG_MSG(2, ("=> calc verify"));
7339
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007340 ret = mbedtls_md_setup(&cloned_ctx, mbedtls_md_info_from_ctx(hs_ctx), 0);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007341 if (ret != 0) {
7342 goto exit;
7343 }
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007344 ret = mbedtls_md_clone(&cloned_ctx, hs_ctx);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007345 if (ret != 0) {
7346 goto exit;
7347 }
7348
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007349 ret = mbedtls_md_finish(&cloned_ctx, hash);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007350 if (ret != 0) {
7351 goto exit;
7352 }
7353
7354 *hlen = mbedtls_md_get_size(mbedtls_md_info_from_ctx(hs_ctx));
7355
7356 MBEDTLS_SSL_DEBUG_BUF(3, "calculated verify result", hash, *hlen);
7357 MBEDTLS_SSL_DEBUG_MSG(2, ("<= calc verify"));
7358
7359exit:
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007360 mbedtls_md_free(&cloned_ctx);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007361 return ret;
7362}
7363#endif /* MBEDTLS_USE_PSA_CRYPTO */
7364
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01007365#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +01007366int ssl_calc_verify_tls_sha256(const mbedtls_ssl_context *ssl,
7367 unsigned char *hash,
7368 size_t *hlen)
Jerry Yu8392e0d2022-02-17 14:10:24 +08007369{
7370#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007371 return ssl_calc_verify_tls_psa(ssl, &ssl->handshake->fin_sha256_psa, 32,
7372 hash, hlen);
Jerry Yu8392e0d2022-02-17 14:10:24 +08007373#else
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007374 return ssl_calc_verify_tls_legacy(ssl, &ssl->handshake->fin_sha256,
7375 hash, hlen);
Jerry Yu8392e0d2022-02-17 14:10:24 +08007376#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu8392e0d2022-02-17 14:10:24 +08007377}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01007378#endif /* MBEDTLS_MD_CAN_SHA256 */
Jerry Yu8392e0d2022-02-17 14:10:24 +08007379
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01007380#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +01007381int ssl_calc_verify_tls_sha384(const mbedtls_ssl_context *ssl,
7382 unsigned char *hash,
7383 size_t *hlen)
Jerry Yuc1cb3842022-02-17 14:13:48 +08007384{
7385#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007386 return ssl_calc_verify_tls_psa(ssl, &ssl->handshake->fin_sha384_psa, 48,
7387 hash, hlen);
Jerry Yuc1cb3842022-02-17 14:13:48 +08007388#else
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007389 return ssl_calc_verify_tls_legacy(ssl, &ssl->handshake->fin_sha384,
7390 hash, hlen);
Jerry Yuc1cb3842022-02-17 14:13:48 +08007391#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yuc1cb3842022-02-17 14:13:48 +08007392}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01007393#endif /* MBEDTLS_MD_CAN_SHA384 */
Jerry Yuc1cb3842022-02-17 14:13:48 +08007394
Neil Armstrong80f6f322022-05-03 17:56:38 +02007395#if !defined(MBEDTLS_USE_PSA_CRYPTO) && \
7396 defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007397int mbedtls_ssl_psk_derive_premaster(mbedtls_ssl_context *ssl, mbedtls_key_exchange_type_t key_ex)
Jerry Yuce3dca42022-02-17 14:16:37 +08007398{
7399 unsigned char *p = ssl->handshake->premaster;
Gilles Peskine449bd832023-01-11 14:50:10 +01007400 unsigned char *end = p + sizeof(ssl->handshake->premaster);
Jerry Yuce3dca42022-02-17 14:16:37 +08007401 const unsigned char *psk = NULL;
7402 size_t psk_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01007403 int psk_ret = mbedtls_ssl_get_psk(ssl, &psk, &psk_len);
Jerry Yuce3dca42022-02-17 14:16:37 +08007404
Gilles Peskine449bd832023-01-11 14:50:10 +01007405 if (psk_ret == MBEDTLS_ERR_SSL_PRIVATE_KEY_REQUIRED) {
Jerry Yuce3dca42022-02-17 14:16:37 +08007406 /*
7407 * This should never happen because the existence of a PSK is always
Przemek Stekielb293aaa2022-04-19 12:22:38 +02007408 * checked before calling this function.
7409 *
7410 * The exception is opaque DHE-PSK. For DHE-PSK fill premaster with
Przemek Stekiel8abcee92022-04-28 09:16:28 +02007411 * the shared secret without PSK.
Jerry Yuce3dca42022-02-17 14:16:37 +08007412 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007413 if (key_ex != MBEDTLS_KEY_EXCHANGE_DHE_PSK) {
7414 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
7415 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Przemek Stekielb293aaa2022-04-19 12:22:38 +02007416 }
Jerry Yuce3dca42022-02-17 14:16:37 +08007417 }
7418
7419 /*
7420 * PMS = struct {
7421 * opaque other_secret<0..2^16-1>;
7422 * opaque psk<0..2^16-1>;
7423 * };
7424 * with "other_secret" depending on the particular key exchange
7425 */
7426#if defined(MBEDTLS_KEY_EXCHANGE_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007427 if (key_ex == MBEDTLS_KEY_EXCHANGE_PSK) {
7428 if (end - p < 2) {
7429 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
7430 }
Jerry Yuce3dca42022-02-17 14:16:37 +08007431
Gilles Peskine449bd832023-01-11 14:50:10 +01007432 MBEDTLS_PUT_UINT16_BE(psk_len, p, 0);
Jerry Yuce3dca42022-02-17 14:16:37 +08007433 p += 2;
7434
Gilles Peskine449bd832023-01-11 14:50:10 +01007435 if (end < p || (size_t) (end - p) < psk_len) {
7436 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
7437 }
Jerry Yuce3dca42022-02-17 14:16:37 +08007438
Gilles Peskine449bd832023-01-11 14:50:10 +01007439 memset(p, 0, psk_len);
Jerry Yuce3dca42022-02-17 14:16:37 +08007440 p += psk_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01007441 } else
Jerry Yuce3dca42022-02-17 14:16:37 +08007442#endif /* MBEDTLS_KEY_EXCHANGE_PSK_ENABLED */
7443#if defined(MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007444 if (key_ex == MBEDTLS_KEY_EXCHANGE_RSA_PSK) {
Jerry Yuce3dca42022-02-17 14:16:37 +08007445 /*
7446 * other_secret already set by the ClientKeyExchange message,
7447 * and is 48 bytes long
7448 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007449 if (end - p < 2) {
7450 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
7451 }
Jerry Yuce3dca42022-02-17 14:16:37 +08007452
7453 *p++ = 0;
7454 *p++ = 48;
7455 p += 48;
Gilles Peskine449bd832023-01-11 14:50:10 +01007456 } else
Jerry Yuce3dca42022-02-17 14:16:37 +08007457#endif /* MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED */
7458#if defined(MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007459 if (key_ex == MBEDTLS_KEY_EXCHANGE_DHE_PSK) {
Jerry Yuce3dca42022-02-17 14:16:37 +08007460 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7461 size_t len;
7462
7463 /* Write length only when we know the actual value */
Gilles Peskine449bd832023-01-11 14:50:10 +01007464 if ((ret = mbedtls_dhm_calc_secret(&ssl->handshake->dhm_ctx,
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00007465 p + 2, (size_t) (end - (p + 2)), &len,
Gilles Peskine449bd832023-01-11 14:50:10 +01007466 ssl->conf->f_rng, ssl->conf->p_rng)) != 0) {
7467 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_dhm_calc_secret", ret);
7468 return ret;
Jerry Yuce3dca42022-02-17 14:16:37 +08007469 }
Gilles Peskine449bd832023-01-11 14:50:10 +01007470 MBEDTLS_PUT_UINT16_BE(len, p, 0);
Jerry Yuce3dca42022-02-17 14:16:37 +08007471 p += 2 + len;
7472
Gilles Peskine449bd832023-01-11 14:50:10 +01007473 MBEDTLS_SSL_DEBUG_MPI(3, "DHM: K ", &ssl->handshake->dhm_ctx.K);
7474 } else
Jerry Yuce3dca42022-02-17 14:16:37 +08007475#endif /* MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED */
Neil Armstrong80f6f322022-05-03 17:56:38 +02007476#if defined(MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007477 if (key_ex == MBEDTLS_KEY_EXCHANGE_ECDHE_PSK) {
Jerry Yuce3dca42022-02-17 14:16:37 +08007478 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7479 size_t zlen;
7480
Gilles Peskine449bd832023-01-11 14:50:10 +01007481 if ((ret = mbedtls_ecdh_calc_secret(&ssl->handshake->ecdh_ctx, &zlen,
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00007482 p + 2, (size_t) (end - (p + 2)),
Gilles Peskine449bd832023-01-11 14:50:10 +01007483 ssl->conf->f_rng, ssl->conf->p_rng)) != 0) {
7484 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ecdh_calc_secret", ret);
7485 return ret;
Jerry Yuce3dca42022-02-17 14:16:37 +08007486 }
7487
Gilles Peskine449bd832023-01-11 14:50:10 +01007488 MBEDTLS_PUT_UINT16_BE(zlen, p, 0);
Jerry Yuce3dca42022-02-17 14:16:37 +08007489 p += 2 + zlen;
7490
Gilles Peskine449bd832023-01-11 14:50:10 +01007491 MBEDTLS_SSL_DEBUG_ECDH(3, &ssl->handshake->ecdh_ctx,
7492 MBEDTLS_DEBUG_ECDH_Z);
7493 } else
Neil Armstrong80f6f322022-05-03 17:56:38 +02007494#endif /* MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED */
Jerry Yuce3dca42022-02-17 14:16:37 +08007495 {
Gilles Peskine449bd832023-01-11 14:50:10 +01007496 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
7497 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yuce3dca42022-02-17 14:16:37 +08007498 }
7499
7500 /* opaque psk<0..2^16-1>; */
Gilles Peskine449bd832023-01-11 14:50:10 +01007501 if (end - p < 2) {
7502 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
7503 }
Jerry Yuce3dca42022-02-17 14:16:37 +08007504
Gilles Peskine449bd832023-01-11 14:50:10 +01007505 MBEDTLS_PUT_UINT16_BE(psk_len, p, 0);
Jerry Yuce3dca42022-02-17 14:16:37 +08007506 p += 2;
7507
Gilles Peskine449bd832023-01-11 14:50:10 +01007508 if (end < p || (size_t) (end - p) < psk_len) {
7509 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
7510 }
Jerry Yuce3dca42022-02-17 14:16:37 +08007511
Gilles Peskine449bd832023-01-11 14:50:10 +01007512 memcpy(p, psk, psk_len);
Jerry Yuce3dca42022-02-17 14:16:37 +08007513 p += psk_len;
7514
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00007515 ssl->handshake->pmslen = (size_t) (p - ssl->handshake->premaster);
Jerry Yuce3dca42022-02-17 14:16:37 +08007516
Gilles Peskine449bd832023-01-11 14:50:10 +01007517 return 0;
Jerry Yuce3dca42022-02-17 14:16:37 +08007518}
Neil Armstrong80f6f322022-05-03 17:56:38 +02007519#endif /* !MBEDTLS_USE_PSA_CRYPTO && MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
Jerry Yuc2c673d2022-02-17 14:20:39 +08007520
7521#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007522MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007523static int ssl_write_hello_request(mbedtls_ssl_context *ssl);
Jerry Yuc2c673d2022-02-17 14:20:39 +08007524
7525#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01007526int mbedtls_ssl_resend_hello_request(mbedtls_ssl_context *ssl)
Jerry Yuc2c673d2022-02-17 14:20:39 +08007527{
7528 /* If renegotiation is not enforced, retransmit until we would reach max
7529 * timeout if we were using the usual handshake doubling scheme */
Gilles Peskine449bd832023-01-11 14:50:10 +01007530 if (ssl->conf->renego_max_records < 0) {
Jerry Yuc2c673d2022-02-17 14:20:39 +08007531 uint32_t ratio = ssl->conf->hs_timeout_max / ssl->conf->hs_timeout_min + 1;
7532 unsigned char doublings = 1;
7533
Gilles Peskine449bd832023-01-11 14:50:10 +01007534 while (ratio != 0) {
Jerry Yuc2c673d2022-02-17 14:20:39 +08007535 ++doublings;
7536 ratio >>= 1;
7537 }
7538
Gilles Peskine449bd832023-01-11 14:50:10 +01007539 if (++ssl->renego_records_seen > doublings) {
7540 MBEDTLS_SSL_DEBUG_MSG(2, ("no longer retransmitting hello request"));
7541 return 0;
Jerry Yuc2c673d2022-02-17 14:20:39 +08007542 }
7543 }
7544
Gilles Peskine449bd832023-01-11 14:50:10 +01007545 return ssl_write_hello_request(ssl);
Jerry Yuc2c673d2022-02-17 14:20:39 +08007546}
7547#endif
7548#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_RENEGOTIATION */
Jerry Yud9526692022-02-17 14:23:47 +08007549
Jerry Yud9526692022-02-17 14:23:47 +08007550/*
7551 * Handshake functions
7552 */
7553#if !defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
7554/* No certificate support -> dummy functions */
Gilles Peskine449bd832023-01-11 14:50:10 +01007555int mbedtls_ssl_write_certificate(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08007556{
7557 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
7558 ssl->handshake->ciphersuite_info;
7559
Gilles Peskine449bd832023-01-11 14:50:10 +01007560 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007561
Gilles Peskine449bd832023-01-11 14:50:10 +01007562 if (!mbedtls_ssl_ciphersuite_uses_srv_cert(ciphersuite_info)) {
7563 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007564 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01007565 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007566 }
7567
Gilles Peskine449bd832023-01-11 14:50:10 +01007568 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
7569 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007570}
7571
Gilles Peskine449bd832023-01-11 14:50:10 +01007572int mbedtls_ssl_parse_certificate(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08007573{
7574 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
7575 ssl->handshake->ciphersuite_info;
7576
Gilles Peskine449bd832023-01-11 14:50:10 +01007577 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007578
Gilles Peskine449bd832023-01-11 14:50:10 +01007579 if (!mbedtls_ssl_ciphersuite_uses_srv_cert(ciphersuite_info)) {
7580 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007581 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01007582 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007583 }
7584
Gilles Peskine449bd832023-01-11 14:50:10 +01007585 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
7586 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007587}
7588
7589#else /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
7590/* Some certificate support -> implement write and parse */
7591
Gilles Peskine449bd832023-01-11 14:50:10 +01007592int mbedtls_ssl_write_certificate(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08007593{
7594 int ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
7595 size_t i, n;
7596 const mbedtls_x509_crt *crt;
7597 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
7598 ssl->handshake->ciphersuite_info;
7599
Gilles Peskine449bd832023-01-11 14:50:10 +01007600 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007601
Gilles Peskine449bd832023-01-11 14:50:10 +01007602 if (!mbedtls_ssl_ciphersuite_uses_srv_cert(ciphersuite_info)) {
7603 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007604 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01007605 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007606 }
7607
7608#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007609 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
7610 if (ssl->handshake->client_auth == 0) {
7611 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007612 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01007613 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007614 }
7615 }
7616#endif /* MBEDTLS_SSL_CLI_C */
7617#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007618 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
7619 if (mbedtls_ssl_own_cert(ssl) == NULL) {
Jerry Yud9526692022-02-17 14:23:47 +08007620 /* Should never happen because we shouldn't have picked the
7621 * ciphersuite if we don't have a certificate. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007622 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007623 }
7624 }
7625#endif
7626
Gilles Peskine449bd832023-01-11 14:50:10 +01007627 MBEDTLS_SSL_DEBUG_CRT(3, "own certificate", mbedtls_ssl_own_cert(ssl));
Jerry Yud9526692022-02-17 14:23:47 +08007628
7629 /*
7630 * 0 . 0 handshake type
7631 * 1 . 3 handshake length
7632 * 4 . 6 length of all certs
7633 * 7 . 9 length of cert. 1
7634 * 10 . n-1 peer certificate
7635 * n . n+2 length of cert. 2
7636 * n+3 . ... upper level cert, etc.
7637 */
7638 i = 7;
Gilles Peskine449bd832023-01-11 14:50:10 +01007639 crt = mbedtls_ssl_own_cert(ssl);
Jerry Yud9526692022-02-17 14:23:47 +08007640
Gilles Peskine449bd832023-01-11 14:50:10 +01007641 while (crt != NULL) {
Jerry Yud9526692022-02-17 14:23:47 +08007642 n = crt->raw.len;
Gilles Peskine449bd832023-01-11 14:50:10 +01007643 if (n > MBEDTLS_SSL_OUT_CONTENT_LEN - 3 - i) {
7644 MBEDTLS_SSL_DEBUG_MSG(1, ("certificate too large, %" MBEDTLS_PRINTF_SIZET
7645 " > %" MBEDTLS_PRINTF_SIZET,
7646 i + 3 + n, (size_t) MBEDTLS_SSL_OUT_CONTENT_LEN));
7647 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
Jerry Yud9526692022-02-17 14:23:47 +08007648 }
7649
Gilles Peskine449bd832023-01-11 14:50:10 +01007650 ssl->out_msg[i] = MBEDTLS_BYTE_2(n);
7651 ssl->out_msg[i + 1] = MBEDTLS_BYTE_1(n);
7652 ssl->out_msg[i + 2] = MBEDTLS_BYTE_0(n);
Jerry Yud9526692022-02-17 14:23:47 +08007653
Gilles Peskine449bd832023-01-11 14:50:10 +01007654 i += 3; memcpy(ssl->out_msg + i, crt->raw.p, n);
Jerry Yud9526692022-02-17 14:23:47 +08007655 i += n; crt = crt->next;
7656 }
7657
Gilles Peskine449bd832023-01-11 14:50:10 +01007658 ssl->out_msg[4] = MBEDTLS_BYTE_2(i - 7);
7659 ssl->out_msg[5] = MBEDTLS_BYTE_1(i - 7);
7660 ssl->out_msg[6] = MBEDTLS_BYTE_0(i - 7);
Jerry Yud9526692022-02-17 14:23:47 +08007661
7662 ssl->out_msglen = i;
7663 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
7664 ssl->out_msg[0] = MBEDTLS_SSL_HS_CERTIFICATE;
7665
7666 ssl->state++;
7667
Gilles Peskine449bd832023-01-11 14:50:10 +01007668 if ((ret = mbedtls_ssl_write_handshake_msg(ssl)) != 0) {
7669 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_handshake_msg", ret);
7670 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007671 }
7672
Gilles Peskine449bd832023-01-11 14:50:10 +01007673 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007674
Gilles Peskine449bd832023-01-11 14:50:10 +01007675 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007676}
7677
7678#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
7679
7680#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007681MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007682static int ssl_check_peer_crt_unchanged(mbedtls_ssl_context *ssl,
7683 unsigned char *crt_buf,
7684 size_t crt_buf_len)
Jerry Yud9526692022-02-17 14:23:47 +08007685{
7686 mbedtls_x509_crt const * const peer_crt = ssl->session->peer_cert;
7687
Gilles Peskine449bd832023-01-11 14:50:10 +01007688 if (peer_crt == NULL) {
7689 return -1;
7690 }
Jerry Yud9526692022-02-17 14:23:47 +08007691
Gilles Peskine449bd832023-01-11 14:50:10 +01007692 if (peer_crt->raw.len != crt_buf_len) {
7693 return -1;
7694 }
Jerry Yud9526692022-02-17 14:23:47 +08007695
Gilles Peskine449bd832023-01-11 14:50:10 +01007696 return memcmp(peer_crt->raw.p, crt_buf, peer_crt->raw.len);
Jerry Yud9526692022-02-17 14:23:47 +08007697}
7698#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007699MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007700static int ssl_check_peer_crt_unchanged(mbedtls_ssl_context *ssl,
7701 unsigned char *crt_buf,
7702 size_t crt_buf_len)
Jerry Yud9526692022-02-17 14:23:47 +08007703{
7704 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7705 unsigned char const * const peer_cert_digest =
7706 ssl->session->peer_cert_digest;
7707 mbedtls_md_type_t const peer_cert_digest_type =
7708 ssl->session->peer_cert_digest_type;
7709 mbedtls_md_info_t const * const digest_info =
Gilles Peskine449bd832023-01-11 14:50:10 +01007710 mbedtls_md_info_from_type(peer_cert_digest_type);
Jerry Yud9526692022-02-17 14:23:47 +08007711 unsigned char tmp_digest[MBEDTLS_SSL_PEER_CERT_DIGEST_MAX_LEN];
7712 size_t digest_len;
7713
Gilles Peskine449bd832023-01-11 14:50:10 +01007714 if (peer_cert_digest == NULL || digest_info == NULL) {
7715 return -1;
7716 }
Jerry Yud9526692022-02-17 14:23:47 +08007717
Gilles Peskine449bd832023-01-11 14:50:10 +01007718 digest_len = mbedtls_md_get_size(digest_info);
7719 if (digest_len > MBEDTLS_SSL_PEER_CERT_DIGEST_MAX_LEN) {
7720 return -1;
7721 }
Jerry Yud9526692022-02-17 14:23:47 +08007722
Gilles Peskine449bd832023-01-11 14:50:10 +01007723 ret = mbedtls_md(digest_info, crt_buf, crt_buf_len, tmp_digest);
7724 if (ret != 0) {
7725 return -1;
7726 }
Jerry Yud9526692022-02-17 14:23:47 +08007727
Gilles Peskine449bd832023-01-11 14:50:10 +01007728 return memcmp(tmp_digest, peer_cert_digest, digest_len);
Jerry Yud9526692022-02-17 14:23:47 +08007729}
7730#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7731#endif /* MBEDTLS_SSL_RENEGOTIATION && MBEDTLS_SSL_CLI_C */
7732
7733/*
7734 * Once the certificate message is read, parse it into a cert chain and
7735 * perform basic checks, but leave actual verification to the caller
7736 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007737MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007738static int ssl_parse_certificate_chain(mbedtls_ssl_context *ssl,
7739 mbedtls_x509_crt *chain)
Jerry Yud9526692022-02-17 14:23:47 +08007740{
7741 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7742#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007743 int crt_cnt = 0;
Jerry Yud9526692022-02-17 14:23:47 +08007744#endif
7745 size_t i, n;
7746 uint8_t alert;
7747
Gilles Peskine449bd832023-01-11 14:50:10 +01007748 if (ssl->in_msgtype != MBEDTLS_SSL_MSG_HANDSHAKE) {
7749 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7750 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7751 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
7752 return MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
Jerry Yud9526692022-02-17 14:23:47 +08007753 }
7754
Gilles Peskine449bd832023-01-11 14:50:10 +01007755 if (ssl->in_msg[0] != MBEDTLS_SSL_HS_CERTIFICATE) {
7756 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7757 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
7758 return MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
Jerry Yud9526692022-02-17 14:23:47 +08007759 }
7760
Gilles Peskine449bd832023-01-11 14:50:10 +01007761 if (ssl->in_hslen < mbedtls_ssl_hs_hdr_len(ssl) + 3 + 3) {
7762 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7763 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7764 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
7765 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007766 }
7767
Gilles Peskine449bd832023-01-11 14:50:10 +01007768 i = mbedtls_ssl_hs_hdr_len(ssl);
Jerry Yud9526692022-02-17 14:23:47 +08007769
7770 /*
7771 * Same message structure as in mbedtls_ssl_write_certificate()
7772 */
Dave Rodgmana3d0f612023-11-03 23:34:02 +00007773 n = MBEDTLS_GET_UINT16_BE(ssl->in_msg, i + 1);
Jerry Yud9526692022-02-17 14:23:47 +08007774
Gilles Peskine449bd832023-01-11 14:50:10 +01007775 if (ssl->in_msg[i] != 0 ||
7776 ssl->in_hslen != n + 3 + mbedtls_ssl_hs_hdr_len(ssl)) {
7777 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7778 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7779 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
7780 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007781 }
7782
7783 /* Make &ssl->in_msg[i] point to the beginning of the CRT chain. */
7784 i += 3;
7785
7786 /* Iterate through and parse the CRTs in the provided chain. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007787 while (i < ssl->in_hslen) {
Jerry Yud9526692022-02-17 14:23:47 +08007788 /* Check that there's room for the next CRT's length fields. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007789 if (i + 3 > ssl->in_hslen) {
7790 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7791 mbedtls_ssl_send_alert_message(ssl,
7792 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7793 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
7794 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007795 }
7796 /* In theory, the CRT can be up to 2**24 Bytes, but we don't support
7797 * anything beyond 2**16 ~ 64K. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007798 if (ssl->in_msg[i] != 0) {
7799 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7800 mbedtls_ssl_send_alert_message(ssl,
7801 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7802 MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT);
7803 return MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
Jerry Yud9526692022-02-17 14:23:47 +08007804 }
7805
7806 /* Read length of the next CRT in the chain. */
Dave Rodgmana3d0f612023-11-03 23:34:02 +00007807 n = MBEDTLS_GET_UINT16_BE(ssl->in_msg, i + 1);
Jerry Yud9526692022-02-17 14:23:47 +08007808 i += 3;
7809
Gilles Peskine449bd832023-01-11 14:50:10 +01007810 if (n < 128 || i + n > ssl->in_hslen) {
7811 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7812 mbedtls_ssl_send_alert_message(ssl,
7813 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7814 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
7815 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007816 }
7817
7818 /* Check if we're handling the first CRT in the chain. */
7819#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007820 if (crt_cnt++ == 0 &&
Jerry Yud9526692022-02-17 14:23:47 +08007821 ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
Gilles Peskine449bd832023-01-11 14:50:10 +01007822 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS) {
Jerry Yud9526692022-02-17 14:23:47 +08007823 /* During client-side renegotiation, check that the server's
7824 * end-CRTs hasn't changed compared to the initial handshake,
7825 * mitigating the triple handshake attack. On success, reuse
7826 * the original end-CRT instead of parsing it again. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007827 MBEDTLS_SSL_DEBUG_MSG(3, ("Check that peer CRT hasn't changed during renegotiation"));
7828 if (ssl_check_peer_crt_unchanged(ssl,
7829 &ssl->in_msg[i],
7830 n) != 0) {
7831 MBEDTLS_SSL_DEBUG_MSG(1, ("new server cert during renegotiation"));
7832 mbedtls_ssl_send_alert_message(ssl,
7833 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7834 MBEDTLS_SSL_ALERT_MSG_ACCESS_DENIED);
7835 return MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
Jerry Yud9526692022-02-17 14:23:47 +08007836 }
7837
7838 /* Now we can safely free the original chain. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007839 ssl_clear_peer_cert(ssl->session);
Jerry Yud9526692022-02-17 14:23:47 +08007840 }
7841#endif /* MBEDTLS_SSL_RENEGOTIATION && MBEDTLS_SSL_CLI_C */
7842
7843 /* Parse the next certificate in the chain. */
7844#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01007845 ret = mbedtls_x509_crt_parse_der(chain, ssl->in_msg + i, n);
Jerry Yud9526692022-02-17 14:23:47 +08007846#else
7847 /* If we don't need to store the CRT chain permanently, parse
7848 * it in-place from the input buffer instead of making a copy. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007849 ret = mbedtls_x509_crt_parse_der_nocopy(chain, ssl->in_msg + i, n);
Jerry Yud9526692022-02-17 14:23:47 +08007850#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Gilles Peskine449bd832023-01-11 14:50:10 +01007851 switch (ret) {
Jerry Yud9526692022-02-17 14:23:47 +08007852 case 0: /*ok*/
7853 case MBEDTLS_ERR_X509_UNKNOWN_SIG_ALG + MBEDTLS_ERR_OID_NOT_FOUND:
7854 /* Ignore certificate with an unknown algorithm: maybe a
7855 prior certificate was already trusted. */
7856 break;
7857
7858 case MBEDTLS_ERR_X509_ALLOC_FAILED:
7859 alert = MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR;
7860 goto crt_parse_der_failed;
7861
7862 case MBEDTLS_ERR_X509_UNKNOWN_VERSION:
7863 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
7864 goto crt_parse_der_failed;
7865
7866 default:
7867 alert = MBEDTLS_SSL_ALERT_MSG_BAD_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01007868crt_parse_der_failed:
7869 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL, alert);
7870 MBEDTLS_SSL_DEBUG_RET(1, " mbedtls_x509_crt_parse_der", ret);
7871 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007872 }
7873
7874 i += n;
7875 }
7876
Gilles Peskine449bd832023-01-11 14:50:10 +01007877 MBEDTLS_SSL_DEBUG_CRT(3, "peer certificate", chain);
7878 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007879}
7880
7881#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007882MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007883static int ssl_srv_check_client_no_crt_notification(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08007884{
Gilles Peskine449bd832023-01-11 14:50:10 +01007885 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
7886 return -1;
7887 }
Jerry Yud9526692022-02-17 14:23:47 +08007888
Gilles Peskine449bd832023-01-11 14:50:10 +01007889 if (ssl->in_hslen == 3 + mbedtls_ssl_hs_hdr_len(ssl) &&
Jerry Yud9526692022-02-17 14:23:47 +08007890 ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
7891 ssl->in_msg[0] == MBEDTLS_SSL_HS_CERTIFICATE &&
Gilles Peskine449bd832023-01-11 14:50:10 +01007892 memcmp(ssl->in_msg + mbedtls_ssl_hs_hdr_len(ssl), "\0\0\0", 3) == 0) {
7893 MBEDTLS_SSL_DEBUG_MSG(1, ("peer has no certificate"));
7894 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007895 }
Gilles Peskine449bd832023-01-11 14:50:10 +01007896 return -1;
Jerry Yud9526692022-02-17 14:23:47 +08007897}
7898#endif /* MBEDTLS_SSL_SRV_C */
7899
7900/* Check if a certificate message is expected.
7901 * Return either
7902 * - SSL_CERTIFICATE_EXPECTED, or
7903 * - SSL_CERTIFICATE_SKIP
7904 * indicating whether a Certificate message is expected or not.
7905 */
7906#define SSL_CERTIFICATE_EXPECTED 0
7907#define SSL_CERTIFICATE_SKIP 1
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007908MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007909static int ssl_parse_certificate_coordinate(mbedtls_ssl_context *ssl,
7910 int authmode)
Jerry Yud9526692022-02-17 14:23:47 +08007911{
7912 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
7913 ssl->handshake->ciphersuite_info;
7914
Gilles Peskine449bd832023-01-11 14:50:10 +01007915 if (!mbedtls_ssl_ciphersuite_uses_srv_cert(ciphersuite_info)) {
7916 return SSL_CERTIFICATE_SKIP;
7917 }
Jerry Yud9526692022-02-17 14:23:47 +08007918
7919#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007920 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
7921 if (ciphersuite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_RSA_PSK) {
7922 return SSL_CERTIFICATE_SKIP;
7923 }
Jerry Yud9526692022-02-17 14:23:47 +08007924
Gilles Peskine449bd832023-01-11 14:50:10 +01007925 if (authmode == MBEDTLS_SSL_VERIFY_NONE) {
Jerry Yud9526692022-02-17 14:23:47 +08007926 ssl->session_negotiate->verify_result =
7927 MBEDTLS_X509_BADCERT_SKIP_VERIFY;
Gilles Peskine449bd832023-01-11 14:50:10 +01007928 return SSL_CERTIFICATE_SKIP;
Jerry Yud9526692022-02-17 14:23:47 +08007929 }
7930 }
7931#else
7932 ((void) authmode);
7933#endif /* MBEDTLS_SSL_SRV_C */
7934
Gilles Peskine449bd832023-01-11 14:50:10 +01007935 return SSL_CERTIFICATE_EXPECTED;
Jerry Yud9526692022-02-17 14:23:47 +08007936}
7937
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007938MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007939static int ssl_parse_certificate_verify(mbedtls_ssl_context *ssl,
7940 int authmode,
7941 mbedtls_x509_crt *chain,
7942 void *rs_ctx)
Jerry Yud9526692022-02-17 14:23:47 +08007943{
7944 int ret = 0;
7945 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
7946 ssl->handshake->ciphersuite_info;
7947 int have_ca_chain = 0;
7948
7949 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *);
7950 void *p_vrfy;
7951
Gilles Peskine449bd832023-01-11 14:50:10 +01007952 if (authmode == MBEDTLS_SSL_VERIFY_NONE) {
7953 return 0;
7954 }
Jerry Yud9526692022-02-17 14:23:47 +08007955
Gilles Peskine449bd832023-01-11 14:50:10 +01007956 if (ssl->f_vrfy != NULL) {
7957 MBEDTLS_SSL_DEBUG_MSG(3, ("Use context-specific verification callback"));
Jerry Yud9526692022-02-17 14:23:47 +08007958 f_vrfy = ssl->f_vrfy;
7959 p_vrfy = ssl->p_vrfy;
Gilles Peskine449bd832023-01-11 14:50:10 +01007960 } else {
7961 MBEDTLS_SSL_DEBUG_MSG(3, ("Use configuration-specific verification callback"));
Jerry Yud9526692022-02-17 14:23:47 +08007962 f_vrfy = ssl->conf->f_vrfy;
7963 p_vrfy = ssl->conf->p_vrfy;
7964 }
7965
7966 /*
7967 * Main check: verify certificate
7968 */
7969#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
Gilles Peskine449bd832023-01-11 14:50:10 +01007970 if (ssl->conf->f_ca_cb != NULL) {
Jerry Yud9526692022-02-17 14:23:47 +08007971 ((void) rs_ctx);
7972 have_ca_chain = 1;
7973
Gilles Peskine449bd832023-01-11 14:50:10 +01007974 MBEDTLS_SSL_DEBUG_MSG(3, ("use CA callback for X.509 CRT verification"));
Jerry Yud9526692022-02-17 14:23:47 +08007975 ret = mbedtls_x509_crt_verify_with_ca_cb(
7976 chain,
7977 ssl->conf->f_ca_cb,
7978 ssl->conf->p_ca_cb,
7979 ssl->conf->cert_profile,
7980 ssl->hostname,
7981 &ssl->session_negotiate->verify_result,
Gilles Peskine449bd832023-01-11 14:50:10 +01007982 f_vrfy, p_vrfy);
7983 } else
Jerry Yud9526692022-02-17 14:23:47 +08007984#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
7985 {
7986 mbedtls_x509_crt *ca_chain;
7987 mbedtls_x509_crl *ca_crl;
7988
7989#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01007990 if (ssl->handshake->sni_ca_chain != NULL) {
Jerry Yud9526692022-02-17 14:23:47 +08007991 ca_chain = ssl->handshake->sni_ca_chain;
7992 ca_crl = ssl->handshake->sni_ca_crl;
Gilles Peskine449bd832023-01-11 14:50:10 +01007993 } else
Jerry Yud9526692022-02-17 14:23:47 +08007994#endif
7995 {
7996 ca_chain = ssl->conf->ca_chain;
7997 ca_crl = ssl->conf->ca_crl;
7998 }
7999
Gilles Peskine449bd832023-01-11 14:50:10 +01008000 if (ca_chain != NULL) {
Jerry Yud9526692022-02-17 14:23:47 +08008001 have_ca_chain = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01008002 }
Jerry Yud9526692022-02-17 14:23:47 +08008003
8004 ret = mbedtls_x509_crt_verify_restartable(
8005 chain,
8006 ca_chain, ca_crl,
8007 ssl->conf->cert_profile,
8008 ssl->hostname,
8009 &ssl->session_negotiate->verify_result,
Gilles Peskine449bd832023-01-11 14:50:10 +01008010 f_vrfy, p_vrfy, rs_ctx);
Jerry Yud9526692022-02-17 14:23:47 +08008011 }
8012
Gilles Peskine449bd832023-01-11 14:50:10 +01008013 if (ret != 0) {
8014 MBEDTLS_SSL_DEBUG_RET(1, "x509_verify_cert", ret);
Jerry Yud9526692022-02-17 14:23:47 +08008015 }
8016
8017#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01008018 if (ret == MBEDTLS_ERR_ECP_IN_PROGRESS) {
8019 return MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS;
8020 }
Jerry Yud9526692022-02-17 14:23:47 +08008021#endif
8022
8023 /*
8024 * Secondary checks: always done, but change 'ret' only if it was 0
8025 */
8026
Valerio Settiacd32c02023-06-29 18:06:29 +02008027#if defined(MBEDTLS_PK_HAVE_ECC_KEYS)
Jerry Yud9526692022-02-17 14:23:47 +08008028 {
8029 const mbedtls_pk_context *pk = &chain->pk;
8030
Manuel Pégourié-Gonnard66b0d612022-06-17 10:49:29 +02008031 /* If certificate uses an EC key, make sure the curve is OK.
8032 * This is a public key, so it can't be opaque, so can_do() is a good
8033 * enough check to ensure pk_ec() is safe to use here. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008034 if (mbedtls_pk_can_do(pk, MBEDTLS_PK_ECKEY)) {
Leonid Rozenboim19e59732022-08-08 16:52:38 -07008035 /* and in the unlikely case the above assumption no longer holds
8036 * we are making sure that pk_ec() here does not return a NULL
8037 */
Valerio Settif9362b72023-11-29 08:42:27 +01008038 mbedtls_ecp_group_id grp_id = mbedtls_pk_get_ec_group_id(pk);
Valerio Settid0405092023-05-24 13:16:40 +02008039 if (grp_id == MBEDTLS_ECP_DP_NONE) {
8040 MBEDTLS_SSL_DEBUG_MSG(1, ("invalid group ID"));
Gilles Peskine449bd832023-01-11 14:50:10 +01008041 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Leonid Rozenboim19e59732022-08-08 16:52:38 -07008042 }
Valerio Setti97207782023-05-18 18:59:06 +02008043 if (mbedtls_ssl_check_curve(ssl, grp_id) != 0) {
Leonid Rozenboim19e59732022-08-08 16:52:38 -07008044 ssl->session_negotiate->verify_result |=
8045 MBEDTLS_X509_BADCERT_BAD_KEY;
8046
Gilles Peskine449bd832023-01-11 14:50:10 +01008047 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate (EC key curve)"));
8048 if (ret == 0) {
Leonid Rozenboim19e59732022-08-08 16:52:38 -07008049 ret = MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
Gilles Peskine449bd832023-01-11 14:50:10 +01008050 }
Leonid Rozenboim19e59732022-08-08 16:52:38 -07008051 }
Jerry Yud9526692022-02-17 14:23:47 +08008052 }
8053 }
Valerio Settiacd32c02023-06-29 18:06:29 +02008054#endif /* MBEDTLS_PK_HAVE_ECC_KEYS */
Jerry Yud9526692022-02-17 14:23:47 +08008055
Gilles Peskine449bd832023-01-11 14:50:10 +01008056 if (mbedtls_ssl_check_cert_usage(chain,
8057 ciphersuite_info,
8058 !ssl->conf->endpoint,
8059 &ssl->session_negotiate->verify_result) != 0) {
8060 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate (usage extensions)"));
8061 if (ret == 0) {
Jerry Yud9526692022-02-17 14:23:47 +08008062 ret = MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
Gilles Peskine449bd832023-01-11 14:50:10 +01008063 }
Jerry Yud9526692022-02-17 14:23:47 +08008064 }
8065
8066 /* mbedtls_x509_crt_verify_with_profile is supposed to report a
8067 * verification failure through MBEDTLS_ERR_X509_CERT_VERIFY_FAILED,
8068 * with details encoded in the verification flags. All other kinds
8069 * of error codes, including those from the user provided f_vrfy
8070 * functions, are treated as fatal and lead to a failure of
8071 * ssl_parse_certificate even if verification was optional. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008072 if (authmode == MBEDTLS_SSL_VERIFY_OPTIONAL &&
8073 (ret == MBEDTLS_ERR_X509_CERT_VERIFY_FAILED ||
8074 ret == MBEDTLS_ERR_SSL_BAD_CERTIFICATE)) {
Jerry Yud9526692022-02-17 14:23:47 +08008075 ret = 0;
8076 }
8077
Gilles Peskine449bd832023-01-11 14:50:10 +01008078 if (have_ca_chain == 0 && authmode == MBEDTLS_SSL_VERIFY_REQUIRED) {
8079 MBEDTLS_SSL_DEBUG_MSG(1, ("got no CA chain"));
Jerry Yud9526692022-02-17 14:23:47 +08008080 ret = MBEDTLS_ERR_SSL_CA_CHAIN_REQUIRED;
8081 }
8082
Gilles Peskine449bd832023-01-11 14:50:10 +01008083 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08008084 uint8_t alert;
8085
8086 /* The certificate may have been rejected for several reasons.
8087 Pick one and send the corresponding alert. Which alert to send
8088 may be a subject of debate in some cases. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008089 if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_OTHER) {
Jerry Yud9526692022-02-17 14:23:47 +08008090 alert = MBEDTLS_SSL_ALERT_MSG_ACCESS_DENIED;
Gilles Peskine449bd832023-01-11 14:50:10 +01008091 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_CN_MISMATCH) {
Jerry Yud9526692022-02-17 14:23:47 +08008092 alert = MBEDTLS_SSL_ALERT_MSG_BAD_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01008093 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_KEY_USAGE) {
Jerry Yud9526692022-02-17 14:23:47 +08008094 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01008095 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_EXT_KEY_USAGE) {
Jerry Yud9526692022-02-17 14:23:47 +08008096 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01008097 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_NS_CERT_TYPE) {
Jerry Yud9526692022-02-17 14:23:47 +08008098 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01008099 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_BAD_PK) {
Jerry Yud9526692022-02-17 14:23:47 +08008100 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01008101 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_BAD_KEY) {
Jerry Yud9526692022-02-17 14:23:47 +08008102 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01008103 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_EXPIRED) {
Jerry Yud9526692022-02-17 14:23:47 +08008104 alert = MBEDTLS_SSL_ALERT_MSG_CERT_EXPIRED;
Gilles Peskine449bd832023-01-11 14:50:10 +01008105 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_REVOKED) {
Jerry Yud9526692022-02-17 14:23:47 +08008106 alert = MBEDTLS_SSL_ALERT_MSG_CERT_REVOKED;
Gilles Peskine449bd832023-01-11 14:50:10 +01008107 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_NOT_TRUSTED) {
Jerry Yud9526692022-02-17 14:23:47 +08008108 alert = MBEDTLS_SSL_ALERT_MSG_UNKNOWN_CA;
Gilles Peskine449bd832023-01-11 14:50:10 +01008109 } else {
Jerry Yud9526692022-02-17 14:23:47 +08008110 alert = MBEDTLS_SSL_ALERT_MSG_CERT_UNKNOWN;
Gilles Peskine449bd832023-01-11 14:50:10 +01008111 }
8112 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8113 alert);
Jerry Yud9526692022-02-17 14:23:47 +08008114 }
8115
8116#if defined(MBEDTLS_DEBUG_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008117 if (ssl->session_negotiate->verify_result != 0) {
8118 MBEDTLS_SSL_DEBUG_MSG(3, ("! Certificate verification flags %08x",
8119 (unsigned int) ssl->session_negotiate->verify_result));
8120 } else {
8121 MBEDTLS_SSL_DEBUG_MSG(3, ("Certificate verification flags clear"));
Jerry Yud9526692022-02-17 14:23:47 +08008122 }
8123#endif /* MBEDTLS_DEBUG_C */
8124
Gilles Peskine449bd832023-01-11 14:50:10 +01008125 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08008126}
8127
8128#if !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02008129MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01008130static int ssl_remember_peer_crt_digest(mbedtls_ssl_context *ssl,
8131 unsigned char *start, size_t len)
Jerry Yud9526692022-02-17 14:23:47 +08008132{
8133 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
8134 /* Remember digest of the peer's end-CRT. */
8135 ssl->session_negotiate->peer_cert_digest =
Gilles Peskine449bd832023-01-11 14:50:10 +01008136 mbedtls_calloc(1, MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN);
8137 if (ssl->session_negotiate->peer_cert_digest == NULL) {
8138 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc(%d bytes) failed",
8139 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN));
8140 mbedtls_ssl_send_alert_message(ssl,
8141 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8142 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR);
Jerry Yud9526692022-02-17 14:23:47 +08008143
Gilles Peskine449bd832023-01-11 14:50:10 +01008144 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
Jerry Yud9526692022-02-17 14:23:47 +08008145 }
8146
Gilles Peskine449bd832023-01-11 14:50:10 +01008147 ret = mbedtls_md(mbedtls_md_info_from_type(
8148 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE),
8149 start, len,
8150 ssl->session_negotiate->peer_cert_digest);
Jerry Yud9526692022-02-17 14:23:47 +08008151
8152 ssl->session_negotiate->peer_cert_digest_type =
8153 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE;
8154 ssl->session_negotiate->peer_cert_digest_len =
8155 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN;
8156
Gilles Peskine449bd832023-01-11 14:50:10 +01008157 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08008158}
8159
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02008160MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01008161static int ssl_remember_peer_pubkey(mbedtls_ssl_context *ssl,
8162 unsigned char *start, size_t len)
Jerry Yud9526692022-02-17 14:23:47 +08008163{
8164 unsigned char *end = start + len;
8165 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
8166
8167 /* Make a copy of the peer's raw public key. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008168 mbedtls_pk_init(&ssl->handshake->peer_pubkey);
8169 ret = mbedtls_pk_parse_subpubkey(&start, end,
8170 &ssl->handshake->peer_pubkey);
8171 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08008172 /* We should have parsed the public key before. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008173 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08008174 }
8175
Gilles Peskine449bd832023-01-11 14:50:10 +01008176 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08008177}
8178#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
8179
Gilles Peskine449bd832023-01-11 14:50:10 +01008180int mbedtls_ssl_parse_certificate(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08008181{
8182 int ret = 0;
8183 int crt_expected;
8184#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
8185 const int authmode = ssl->handshake->sni_authmode != MBEDTLS_SSL_VERIFY_UNSET
8186 ? ssl->handshake->sni_authmode
8187 : ssl->conf->authmode;
8188#else
8189 const int authmode = ssl->conf->authmode;
8190#endif
8191 void *rs_ctx = NULL;
8192 mbedtls_x509_crt *chain = NULL;
8193
Gilles Peskine449bd832023-01-11 14:50:10 +01008194 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08008195
Gilles Peskine449bd832023-01-11 14:50:10 +01008196 crt_expected = ssl_parse_certificate_coordinate(ssl, authmode);
8197 if (crt_expected == SSL_CERTIFICATE_SKIP) {
8198 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08008199 goto exit;
8200 }
8201
8202#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01008203 if (ssl->handshake->ecrs_enabled &&
8204 ssl->handshake->ecrs_state == ssl_ecrs_crt_verify) {
Jerry Yud9526692022-02-17 14:23:47 +08008205 chain = ssl->handshake->ecrs_peer_cert;
8206 ssl->handshake->ecrs_peer_cert = NULL;
8207 goto crt_verify;
8208 }
8209#endif
8210
Gilles Peskine449bd832023-01-11 14:50:10 +01008211 if ((ret = mbedtls_ssl_read_record(ssl, 1)) != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08008212 /* mbedtls_ssl_read_record may have sent an alert already. We
8213 let it decide whether to alert. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008214 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_read_record", ret);
Jerry Yud9526692022-02-17 14:23:47 +08008215 goto exit;
8216 }
8217
8218#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008219 if (ssl_srv_check_client_no_crt_notification(ssl) == 0) {
Jerry Yud9526692022-02-17 14:23:47 +08008220 ssl->session_negotiate->verify_result = MBEDTLS_X509_BADCERT_MISSING;
8221
Gilles Peskine449bd832023-01-11 14:50:10 +01008222 if (authmode != MBEDTLS_SSL_VERIFY_OPTIONAL) {
Jerry Yud9526692022-02-17 14:23:47 +08008223 ret = MBEDTLS_ERR_SSL_NO_CLIENT_CERTIFICATE;
Gilles Peskine449bd832023-01-11 14:50:10 +01008224 }
Jerry Yud9526692022-02-17 14:23:47 +08008225
8226 goto exit;
8227 }
8228#endif /* MBEDTLS_SSL_SRV_C */
8229
8230 /* Clear existing peer CRT structure in case we tried to
8231 * reuse a session but it failed, and allocate a new one. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008232 ssl_clear_peer_cert(ssl->session_negotiate);
Jerry Yud9526692022-02-17 14:23:47 +08008233
Gilles Peskine449bd832023-01-11 14:50:10 +01008234 chain = mbedtls_calloc(1, sizeof(mbedtls_x509_crt));
8235 if (chain == NULL) {
8236 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc(%" MBEDTLS_PRINTF_SIZET " bytes) failed",
8237 sizeof(mbedtls_x509_crt)));
8238 mbedtls_ssl_send_alert_message(ssl,
8239 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8240 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR);
Jerry Yud9526692022-02-17 14:23:47 +08008241
8242 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
8243 goto exit;
8244 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008245 mbedtls_x509_crt_init(chain);
Jerry Yud9526692022-02-17 14:23:47 +08008246
Gilles Peskine449bd832023-01-11 14:50:10 +01008247 ret = ssl_parse_certificate_chain(ssl, chain);
8248 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08008249 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01008250 }
Jerry Yud9526692022-02-17 14:23:47 +08008251
8252#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01008253 if (ssl->handshake->ecrs_enabled) {
Jerry Yud9526692022-02-17 14:23:47 +08008254 ssl->handshake->ecrs_state = ssl_ecrs_crt_verify;
Gilles Peskine449bd832023-01-11 14:50:10 +01008255 }
Jerry Yud9526692022-02-17 14:23:47 +08008256
8257crt_verify:
Gilles Peskine449bd832023-01-11 14:50:10 +01008258 if (ssl->handshake->ecrs_enabled) {
Jerry Yud9526692022-02-17 14:23:47 +08008259 rs_ctx = &ssl->handshake->ecrs_ctx;
Gilles Peskine449bd832023-01-11 14:50:10 +01008260 }
Jerry Yud9526692022-02-17 14:23:47 +08008261#endif
8262
Gilles Peskine449bd832023-01-11 14:50:10 +01008263 ret = ssl_parse_certificate_verify(ssl, authmode,
8264 chain, rs_ctx);
8265 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08008266 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01008267 }
Jerry Yud9526692022-02-17 14:23:47 +08008268
8269#if !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
8270 {
8271 unsigned char *crt_start, *pk_start;
8272 size_t crt_len, pk_len;
8273
8274 /* We parse the CRT chain without copying, so
8275 * these pointers point into the input buffer,
8276 * and are hence still valid after freeing the
8277 * CRT chain. */
8278
8279 crt_start = chain->raw.p;
8280 crt_len = chain->raw.len;
8281
8282 pk_start = chain->pk_raw.p;
8283 pk_len = chain->pk_raw.len;
8284
8285 /* Free the CRT structures before computing
8286 * digest and copying the peer's public key. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008287 mbedtls_x509_crt_free(chain);
8288 mbedtls_free(chain);
Jerry Yud9526692022-02-17 14:23:47 +08008289 chain = NULL;
8290
Gilles Peskine449bd832023-01-11 14:50:10 +01008291 ret = ssl_remember_peer_crt_digest(ssl, crt_start, crt_len);
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
Gilles Peskine449bd832023-01-11 14:50:10 +01008296 ret = ssl_remember_peer_pubkey(ssl, pk_start, pk_len);
8297 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08008298 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01008299 }
Jerry Yud9526692022-02-17 14:23:47 +08008300 }
8301#else /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
8302 /* Pass ownership to session structure. */
8303 ssl->session_negotiate->peer_cert = chain;
8304 chain = NULL;
8305#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
8306
Gilles Peskine449bd832023-01-11 14:50:10 +01008307 MBEDTLS_SSL_DEBUG_MSG(2, ("<= parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08008308
8309exit:
8310
Gilles Peskine449bd832023-01-11 14:50:10 +01008311 if (ret == 0) {
Jerry Yud9526692022-02-17 14:23:47 +08008312 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01008313 }
Jerry Yud9526692022-02-17 14:23:47 +08008314
8315#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01008316 if (ret == MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS) {
Jerry Yud9526692022-02-17 14:23:47 +08008317 ssl->handshake->ecrs_peer_cert = chain;
8318 chain = NULL;
8319 }
8320#endif
8321
Gilles Peskine449bd832023-01-11 14:50:10 +01008322 if (chain != NULL) {
8323 mbedtls_x509_crt_free(chain);
8324 mbedtls_free(chain);
Jerry Yud9526692022-02-17 14:23:47 +08008325 }
8326
Gilles Peskine449bd832023-01-11 14:50:10 +01008327 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08008328}
8329#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
8330
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008331static int ssl_calc_finished_tls_generic(mbedtls_ssl_context *ssl, void *ctx,
8332 unsigned char *padbuf, size_t hlen,
8333 unsigned char *buf, int from)
Jerry Yu615bd6f2022-02-17 14:25:15 +08008334{
Dave Rodgmanc37ad442023-11-03 23:36:06 +00008335 unsigned int len = 12;
Jerry Yu615bd6f2022-02-17 14:25:15 +08008336 const char *sender;
Jerry Yu615bd6f2022-02-17 14:25:15 +08008337#if defined(MBEDTLS_USE_PSA_CRYPTO)
Jerry Yu615bd6f2022-02-17 14:25:15 +08008338 psa_status_t status;
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008339 psa_hash_operation_t *hs_op = ctx;
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02008340 psa_hash_operation_t cloned_op = PSA_HASH_OPERATION_INIT;
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008341 size_t hash_size;
Jerry Yu615bd6f2022-02-17 14:25:15 +08008342#else
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01008343 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008344 mbedtls_md_context_t *hs_ctx = ctx;
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02008345 mbedtls_md_context_t cloned_ctx;
8346 mbedtls_md_init(&cloned_ctx);
Jerry Yu615bd6f2022-02-17 14:25:15 +08008347#endif
8348
8349 mbedtls_ssl_session *session = ssl->session_negotiate;
Gilles Peskine449bd832023-01-11 14:50:10 +01008350 if (!session) {
Jerry Yu615bd6f2022-02-17 14:25:15 +08008351 session = ssl->session;
Gilles Peskine449bd832023-01-11 14:50:10 +01008352 }
Jerry Yu615bd6f2022-02-17 14:25:15 +08008353
Gilles Peskine449bd832023-01-11 14:50:10 +01008354 sender = (from == MBEDTLS_SSL_IS_CLIENT)
Jerry Yu615bd6f2022-02-17 14:25:15 +08008355 ? "client finished"
8356 : "server finished";
8357
8358#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008359 MBEDTLS_SSL_DEBUG_MSG(2, ("=> calc PSA finished tls"));
Jerry Yu615bd6f2022-02-17 14:25:15 +08008360
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02008361 status = psa_hash_clone(hs_op, &cloned_op);
Gilles Peskine449bd832023-01-11 14:50:10 +01008362 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01008363 goto exit;
Jerry Yu615bd6f2022-02-17 14:25:15 +08008364 }
8365
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02008366 status = psa_hash_finish(&cloned_op, padbuf, hlen, &hash_size);
Gilles Peskine449bd832023-01-11 14:50:10 +01008367 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01008368 goto exit;
Jerry Yu615bd6f2022-02-17 14:25:15 +08008369 }
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008370 MBEDTLS_SSL_DEBUG_BUF(3, "PSA calculated padbuf", padbuf, hlen);
Jerry Yu615bd6f2022-02-17 14:25:15 +08008371#else
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008372 MBEDTLS_SSL_DEBUG_MSG(2, ("=> calc finished tls"));
Jerry Yu615bd6f2022-02-17 14:25:15 +08008373
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02008374 ret = mbedtls_md_setup(&cloned_ctx, mbedtls_md_info_from_ctx(hs_ctx), 0);
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01008375 if (ret != 0) {
8376 goto exit;
8377 }
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02008378 ret = mbedtls_md_clone(&cloned_ctx, hs_ctx);
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01008379 if (ret != 0) {
8380 goto exit;
8381 }
Jerry Yu615bd6f2022-02-17 14:25:15 +08008382
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02008383 ret = mbedtls_md_finish(&cloned_ctx, padbuf);
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008384 if (ret != 0) {
8385 goto exit;
8386 }
8387#endif /* MBEDTLS_USE_PSA_CRYPTO */
8388
8389 MBEDTLS_SSL_DEBUG_BUF(4, "finished output", padbuf, hlen);
8390
Jerry Yu615bd6f2022-02-17 14:25:15 +08008391 /*
8392 * TLSv1.2:
8393 * hash = PRF( master, finished_label,
8394 * Hash( handshake ) )[0.11]
8395 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008396 ssl->handshake->tls_prf(session->master, 48, sender,
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008397 padbuf, hlen, buf, len);
Jerry Yu615bd6f2022-02-17 14:25:15 +08008398
Gilles Peskine449bd832023-01-11 14:50:10 +01008399 MBEDTLS_SSL_DEBUG_BUF(3, "calc finished result", buf, len);
Jerry Yu615bd6f2022-02-17 14:25:15 +08008400
Paul Elliottecb95be2023-08-11 16:41:04 +01008401 mbedtls_platform_zeroize(padbuf, hlen);
Jerry Yu615bd6f2022-02-17 14:25:15 +08008402
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008403 MBEDTLS_SSL_DEBUG_MSG(2, ("<= calc finished"));
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01008404
8405exit:
8406#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02008407 psa_hash_abort(&cloned_op);
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +02008408 return mbedtls_md_error_from_psa(status);
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01008409#else
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02008410 mbedtls_md_free(&cloned_ctx);
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01008411 return ret;
8412#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu615bd6f2022-02-17 14:25:15 +08008413}
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008414
8415#if defined(MBEDTLS_MD_CAN_SHA256)
8416static int ssl_calc_finished_tls_sha256(
8417 mbedtls_ssl_context *ssl, unsigned char *buf, int from)
8418{
8419 unsigned char padbuf[32];
8420 return ssl_calc_finished_tls_generic(ssl,
8421#if defined(MBEDTLS_USE_PSA_CRYPTO)
8422 &ssl->handshake->fin_sha256_psa,
8423#else
8424 &ssl->handshake->fin_sha256,
8425#endif
8426 padbuf, sizeof(padbuf),
8427 buf, from);
8428}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01008429#endif /* MBEDTLS_MD_CAN_SHA256*/
Jerry Yu615bd6f2022-02-17 14:25:15 +08008430
Jerry Yub7ba49e2022-02-17 14:25:53 +08008431
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01008432#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +01008433static int ssl_calc_finished_tls_sha384(
Gilles Peskine449bd832023-01-11 14:50:10 +01008434 mbedtls_ssl_context *ssl, unsigned char *buf, int from)
Jerry Yub7ba49e2022-02-17 14:25:53 +08008435{
Jerry Yub7ba49e2022-02-17 14:25:53 +08008436 unsigned char padbuf[48];
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008437 return ssl_calc_finished_tls_generic(ssl,
Jerry Yub7ba49e2022-02-17 14:25:53 +08008438#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008439 &ssl->handshake->fin_sha384_psa,
Jerry Yub7ba49e2022-02-17 14:25:53 +08008440#else
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008441 &ssl->handshake->fin_sha384,
Jerry Yub7ba49e2022-02-17 14:25:53 +08008442#endif
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008443 padbuf, sizeof(padbuf),
8444 buf, from);
Jerry Yub7ba49e2022-02-17 14:25:53 +08008445}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01008446#endif /* MBEDTLS_MD_CAN_SHA384*/
Jerry Yub7ba49e2022-02-17 14:25:53 +08008447
Gilles Peskine449bd832023-01-11 14:50:10 +01008448void mbedtls_ssl_handshake_wrapup_free_hs_transform(mbedtls_ssl_context *ssl)
Jerry Yuaef00152022-02-17 14:27:31 +08008449{
Gilles Peskine449bd832023-01-11 14:50:10 +01008450 MBEDTLS_SSL_DEBUG_MSG(3, ("=> handshake wrapup: final free"));
Jerry Yuaef00152022-02-17 14:27:31 +08008451
8452 /*
8453 * Free our handshake params
8454 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008455 mbedtls_ssl_handshake_free(ssl);
8456 mbedtls_free(ssl->handshake);
Jerry Yuaef00152022-02-17 14:27:31 +08008457 ssl->handshake = NULL;
8458
8459 /*
Shaun Case8b0ecbc2021-12-20 21:14:10 -08008460 * Free the previous transform and switch in the current one
Jerry Yuaef00152022-02-17 14:27:31 +08008461 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008462 if (ssl->transform) {
8463 mbedtls_ssl_transform_free(ssl->transform);
8464 mbedtls_free(ssl->transform);
Jerry Yuaef00152022-02-17 14:27:31 +08008465 }
8466 ssl->transform = ssl->transform_negotiate;
8467 ssl->transform_negotiate = NULL;
8468
Gilles Peskine449bd832023-01-11 14:50:10 +01008469 MBEDTLS_SSL_DEBUG_MSG(3, ("<= handshake wrapup: final free"));
Jerry Yuaef00152022-02-17 14:27:31 +08008470}
8471
Gilles Peskine449bd832023-01-11 14:50:10 +01008472void mbedtls_ssl_handshake_wrapup(mbedtls_ssl_context *ssl)
Jerry Yu2a9fff52022-02-17 14:28:51 +08008473{
8474 int resume = ssl->handshake->resume;
8475
Gilles Peskine449bd832023-01-11 14:50:10 +01008476 MBEDTLS_SSL_DEBUG_MSG(3, ("=> handshake wrapup"));
Jerry Yu2a9fff52022-02-17 14:28:51 +08008477
8478#if defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01008479 if (ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS) {
Jerry Yu2a9fff52022-02-17 14:28:51 +08008480 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_DONE;
8481 ssl->renego_records_seen = 0;
8482 }
8483#endif
8484
8485 /*
8486 * Free the previous session and switch in the current one
8487 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008488 if (ssl->session) {
Jerry Yu2a9fff52022-02-17 14:28:51 +08008489#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
8490 /* RFC 7366 3.1: keep the EtM state */
8491 ssl->session_negotiate->encrypt_then_mac =
Gilles Peskine449bd832023-01-11 14:50:10 +01008492 ssl->session->encrypt_then_mac;
Jerry Yu2a9fff52022-02-17 14:28:51 +08008493#endif
8494
Gilles Peskine449bd832023-01-11 14:50:10 +01008495 mbedtls_ssl_session_free(ssl->session);
8496 mbedtls_free(ssl->session);
Jerry Yu2a9fff52022-02-17 14:28:51 +08008497 }
8498 ssl->session = ssl->session_negotiate;
8499 ssl->session_negotiate = NULL;
8500
8501 /*
8502 * Add cache entry
8503 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008504 if (ssl->conf->f_set_cache != NULL &&
Jerry Yu2a9fff52022-02-17 14:28:51 +08008505 ssl->session->id_len != 0 &&
Gilles Peskine449bd832023-01-11 14:50:10 +01008506 resume == 0) {
8507 if (ssl->conf->f_set_cache(ssl->conf->p_cache,
8508 ssl->session->id,
8509 ssl->session->id_len,
8510 ssl->session) != 0) {
8511 MBEDTLS_SSL_DEBUG_MSG(1, ("cache did not store session"));
8512 }
Jerry Yu2a9fff52022-02-17 14:28:51 +08008513 }
8514
8515#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01008516 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
8517 ssl->handshake->flight != NULL) {
Jerry Yu2a9fff52022-02-17 14:28:51 +08008518 /* Cancel handshake timer */
Gilles Peskine449bd832023-01-11 14:50:10 +01008519 mbedtls_ssl_set_timer(ssl, 0);
Jerry Yu2a9fff52022-02-17 14:28:51 +08008520
8521 /* Keep last flight around in case we need to resend it:
8522 * we need the handshake and transform structures for that */
Gilles Peskine449bd832023-01-11 14:50:10 +01008523 MBEDTLS_SSL_DEBUG_MSG(3, ("skip freeing handshake and transform"));
8524 } else
Jerry Yu2a9fff52022-02-17 14:28:51 +08008525#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01008526 mbedtls_ssl_handshake_wrapup_free_hs_transform(ssl);
Jerry Yu2a9fff52022-02-17 14:28:51 +08008527
Jerry Yu5ed73ff2022-10-27 13:08:42 +08008528 ssl->state = MBEDTLS_SSL_HANDSHAKE_OVER;
Jerry Yu2a9fff52022-02-17 14:28:51 +08008529
Gilles Peskine449bd832023-01-11 14:50:10 +01008530 MBEDTLS_SSL_DEBUG_MSG(3, ("<= handshake wrapup"));
Jerry Yu2a9fff52022-02-17 14:28:51 +08008531}
8532
Gilles Peskine449bd832023-01-11 14:50:10 +01008533int mbedtls_ssl_write_finished(mbedtls_ssl_context *ssl)
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008534{
Dave Rodgmanc37ad442023-11-03 23:36:06 +00008535 int ret;
8536 unsigned int hash_len;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008537
Gilles Peskine449bd832023-01-11 14:50:10 +01008538 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write finished"));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008539
Gilles Peskine449bd832023-01-11 14:50:10 +01008540 mbedtls_ssl_update_out_pointers(ssl, ssl->transform_negotiate);
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008541
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01008542 ret = ssl->handshake->calc_finished(ssl, ssl->out_msg + 4, ssl->conf->endpoint);
8543 if (ret != 0) {
8544 MBEDTLS_SSL_DEBUG_RET(1, "calc_finished", ret);
8545 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008546
8547 /*
8548 * RFC 5246 7.4.9 (Page 63) says 12 is the default length and ciphersuites
8549 * may define some other value. Currently (early 2016), no defined
8550 * ciphersuite does this (and this is unlikely to change as activity has
8551 * moved to TLS 1.3 now) so we can keep the hardcoded 12 here.
8552 */
8553 hash_len = 12;
8554
8555#if defined(MBEDTLS_SSL_RENEGOTIATION)
8556 ssl->verify_data_len = hash_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01008557 memcpy(ssl->own_verify_data, ssl->out_msg + 4, hash_len);
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008558#endif
8559
8560 ssl->out_msglen = 4 + hash_len;
8561 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
8562 ssl->out_msg[0] = MBEDTLS_SSL_HS_FINISHED;
8563
8564 /*
8565 * In case of session resuming, invert the client and server
8566 * ChangeCipherSpec messages order.
8567 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008568 if (ssl->handshake->resume != 0) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008569#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008570 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008571 ssl->state = MBEDTLS_SSL_HANDSHAKE_WRAPUP;
Gilles Peskine449bd832023-01-11 14:50:10 +01008572 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008573#endif
8574#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008575 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008576 ssl->state = MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC;
Gilles Peskine449bd832023-01-11 14:50:10 +01008577 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008578#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01008579 } else {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008580 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01008581 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008582
8583 /*
8584 * Switch to our negotiated transform and session parameters for outbound
8585 * data.
8586 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008587 MBEDTLS_SSL_DEBUG_MSG(3, ("switching to new transform spec for outbound data"));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008588
8589#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01008590 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008591 unsigned char i;
8592
8593 /* Remember current epoch settings for resending */
8594 ssl->handshake->alt_transform_out = ssl->transform_out;
Gilles Peskine449bd832023-01-11 14:50:10 +01008595 memcpy(ssl->handshake->alt_out_ctr, ssl->cur_out_ctr,
8596 sizeof(ssl->handshake->alt_out_ctr));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008597
8598 /* Set sequence_number to zero */
Gilles Peskine449bd832023-01-11 14:50:10 +01008599 memset(&ssl->cur_out_ctr[2], 0, sizeof(ssl->cur_out_ctr) - 2);
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008600
8601
8602 /* Increment epoch */
Gilles Peskine449bd832023-01-11 14:50:10 +01008603 for (i = 2; i > 0; i--) {
8604 if (++ssl->cur_out_ctr[i - 1] != 0) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008605 break;
Gilles Peskine449bd832023-01-11 14:50:10 +01008606 }
8607 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008608
8609 /* The loop goes to its end iff the counter is wrapping */
Gilles Peskine449bd832023-01-11 14:50:10 +01008610 if (i == 0) {
8611 MBEDTLS_SSL_DEBUG_MSG(1, ("DTLS epoch would wrap"));
8612 return MBEDTLS_ERR_SSL_COUNTER_WRAPPING;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008613 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008614 } else
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008615#endif /* MBEDTLS_SSL_PROTO_DTLS */
Gilles Peskine449bd832023-01-11 14:50:10 +01008616 memset(ssl->cur_out_ctr, 0, sizeof(ssl->cur_out_ctr));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008617
8618 ssl->transform_out = ssl->transform_negotiate;
8619 ssl->session_out = ssl->session_negotiate;
8620
8621#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01008622 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
8623 mbedtls_ssl_send_flight_completed(ssl);
8624 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008625#endif
8626
Gilles Peskine449bd832023-01-11 14:50:10 +01008627 if ((ret = mbedtls_ssl_write_handshake_msg(ssl)) != 0) {
8628 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_handshake_msg", ret);
8629 return ret;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008630 }
8631
8632#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01008633 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
8634 (ret = mbedtls_ssl_flight_transmit(ssl)) != 0) {
8635 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_flight_transmit", ret);
8636 return ret;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008637 }
8638#endif
8639
Gilles Peskine449bd832023-01-11 14:50:10 +01008640 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write finished"));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008641
Gilles Peskine449bd832023-01-11 14:50:10 +01008642 return 0;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008643}
8644
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008645#define SSL_MAX_HASH_LEN 12
8646
Gilles Peskine449bd832023-01-11 14:50:10 +01008647int mbedtls_ssl_parse_finished(mbedtls_ssl_context *ssl)
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008648{
8649 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
8650 unsigned int hash_len = 12;
8651 unsigned char buf[SSL_MAX_HASH_LEN];
8652
Gilles Peskine449bd832023-01-11 14:50:10 +01008653 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse finished"));
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008654
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01008655 ret = ssl->handshake->calc_finished(ssl, buf, ssl->conf->endpoint ^ 1);
8656 if (ret != 0) {
8657 MBEDTLS_SSL_DEBUG_RET(1, "calc_finished", ret);
8658 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008659
Gilles Peskine449bd832023-01-11 14:50:10 +01008660 if ((ret = mbedtls_ssl_read_record(ssl, 1)) != 0) {
8661 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_read_record", ret);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008662 goto exit;
8663 }
8664
Gilles Peskine449bd832023-01-11 14:50:10 +01008665 if (ssl->in_msgtype != MBEDTLS_SSL_MSG_HANDSHAKE) {
8666 MBEDTLS_SSL_DEBUG_MSG(1, ("bad finished message"));
8667 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8668 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008669 ret = MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
8670 goto exit;
8671 }
8672
Gilles Peskine449bd832023-01-11 14:50:10 +01008673 if (ssl->in_msg[0] != MBEDTLS_SSL_HS_FINISHED) {
8674 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8675 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008676 ret = MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
8677 goto exit;
8678 }
8679
Gilles Peskine449bd832023-01-11 14:50:10 +01008680 if (ssl->in_hslen != mbedtls_ssl_hs_hdr_len(ssl) + hash_len) {
8681 MBEDTLS_SSL_DEBUG_MSG(1, ("bad finished message"));
8682 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8683 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008684 ret = MBEDTLS_ERR_SSL_DECODE_ERROR;
8685 goto exit;
8686 }
8687
Gilles Peskine449bd832023-01-11 14:50:10 +01008688 if (mbedtls_ct_memcmp(ssl->in_msg + mbedtls_ssl_hs_hdr_len(ssl),
8689 buf, hash_len) != 0) {
8690 MBEDTLS_SSL_DEBUG_MSG(1, ("bad finished message"));
8691 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8692 MBEDTLS_SSL_ALERT_MSG_DECRYPT_ERROR);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008693 ret = MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
8694 goto exit;
8695 }
8696
8697#if defined(MBEDTLS_SSL_RENEGOTIATION)
8698 ssl->verify_data_len = hash_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01008699 memcpy(ssl->peer_verify_data, buf, hash_len);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008700#endif
8701
Gilles Peskine449bd832023-01-11 14:50:10 +01008702 if (ssl->handshake->resume != 0) {
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008703#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008704 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008705 ssl->state = MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC;
Gilles Peskine449bd832023-01-11 14:50:10 +01008706 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008707#endif
8708#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008709 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008710 ssl->state = MBEDTLS_SSL_HANDSHAKE_WRAPUP;
Gilles Peskine449bd832023-01-11 14:50:10 +01008711 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008712#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01008713 } else {
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008714 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01008715 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008716
8717#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01008718 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
8719 mbedtls_ssl_recv_flight_completed(ssl);
8720 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008721#endif
8722
Gilles Peskine449bd832023-01-11 14:50:10 +01008723 MBEDTLS_SSL_DEBUG_MSG(2, ("<= parse finished"));
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008724
8725exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01008726 mbedtls_platform_zeroize(buf, hash_len);
8727 return ret;
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008728}
8729
Jerry Yu392112c2022-02-17 14:34:10 +08008730#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
8731/*
8732 * Helper to get TLS 1.2 PRF from ciphersuite
8733 * (Duplicates bits of logic from ssl_set_handshake_prfs().)
8734 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008735static tls_prf_fn ssl_tls12prf_from_cs(int ciphersuite_id)
Jerry Yu392112c2022-02-17 14:34:10 +08008736{
Jerry Yu392112c2022-02-17 14:34:10 +08008737 const mbedtls_ssl_ciphersuite_t * const ciphersuite_info =
Gilles Peskine449bd832023-01-11 14:50:10 +01008738 mbedtls_ssl_ciphersuite_from_id(ciphersuite_id);
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01008739#if defined(MBEDTLS_MD_CAN_SHA384)
Gilles Peskine449bd832023-01-11 14:50:10 +01008740 if (ciphersuite_info != NULL && ciphersuite_info->mac == MBEDTLS_MD_SHA384) {
8741 return tls_prf_sha384;
8742 } else
Jerry Yu392112c2022-02-17 14:34:10 +08008743#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01008744#if defined(MBEDTLS_MD_CAN_SHA256)
Andrzej Kurek894edde2022-09-29 06:31:14 -04008745 {
Gilles Peskine449bd832023-01-11 14:50:10 +01008746 if (ciphersuite_info != NULL && ciphersuite_info->mac == MBEDTLS_MD_SHA256) {
8747 return tls_prf_sha256;
8748 }
Andrzej Kurek894edde2022-09-29 06:31:14 -04008749 }
8750#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01008751#if !defined(MBEDTLS_MD_CAN_SHA384) && \
8752 !defined(MBEDTLS_MD_CAN_SHA256)
Andrzej Kurek894edde2022-09-29 06:31:14 -04008753 (void) ciphersuite_info;
8754#endif
Andrzej Kurekeabeb302022-10-17 07:52:51 -04008755
Gilles Peskine449bd832023-01-11 14:50:10 +01008756 return NULL;
Jerry Yu392112c2022-02-17 14:34:10 +08008757}
8758#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
Jerry Yue93ffcd2022-02-17 14:37:06 +08008759
Gilles Peskine449bd832023-01-11 14:50:10 +01008760static mbedtls_tls_prf_types tls_prf_get_type(mbedtls_ssl_tls_prf_cb *tls_prf)
Jerry Yue93ffcd2022-02-17 14:37:06 +08008761{
8762 ((void) tls_prf);
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01008763#if defined(MBEDTLS_MD_CAN_SHA384)
Gilles Peskine449bd832023-01-11 14:50:10 +01008764 if (tls_prf == tls_prf_sha384) {
8765 return MBEDTLS_SSL_TLS_PRF_SHA384;
8766 } else
Jerry Yue93ffcd2022-02-17 14:37:06 +08008767#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01008768#if defined(MBEDTLS_MD_CAN_SHA256)
Gilles Peskine449bd832023-01-11 14:50:10 +01008769 if (tls_prf == tls_prf_sha256) {
8770 return MBEDTLS_SSL_TLS_PRF_SHA256;
8771 } else
Jerry Yue93ffcd2022-02-17 14:37:06 +08008772#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01008773 return MBEDTLS_SSL_TLS_PRF_NONE;
Jerry Yue93ffcd2022-02-17 14:37:06 +08008774}
8775
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008776/*
8777 * Populate a transform structure with session keys and all the other
8778 * necessary information.
8779 *
8780 * Parameters:
8781 * - [in/out]: transform: structure to populate
8782 * [in] must be just initialised with mbedtls_ssl_transform_init()
8783 * [out] fully populated, ready for use by mbedtls_ssl_{en,de}crypt_buf()
8784 * - [in] ciphersuite
8785 * - [in] master
8786 * - [in] encrypt_then_mac
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008787 * - [in] tls_prf: pointer to PRF to use for key derivation
8788 * - [in] randbytes: buffer holding ServerHello.random + ClientHello.random
Glenn Strauss07c64162022-03-14 12:34:51 -04008789 * - [in] tls_version: TLS version
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008790 * - [in] endpoint: client or server
8791 * - [in] ssl: used for:
8792 * - ssl->conf->{f,p}_export_keys
8793 * [in] optionally used for:
8794 * - MBEDTLS_DEBUG_C: ssl->conf->{f,p}_dbg
8795 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02008796MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01008797static int ssl_tls12_populate_transform(mbedtls_ssl_transform *transform,
8798 int ciphersuite,
8799 const unsigned char master[48],
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008800#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01008801 int encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008802#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01008803 ssl_tls_prf_t tls_prf,
8804 const unsigned char randbytes[64],
8805 mbedtls_ssl_protocol_version tls_version,
8806 unsigned endpoint,
8807 const mbedtls_ssl_context *ssl)
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008808{
8809 int ret = 0;
8810 unsigned char keyblk[256];
8811 unsigned char *key1;
8812 unsigned char *key2;
8813 unsigned char *mac_enc;
8814 unsigned char *mac_dec;
8815 size_t mac_key_len = 0;
8816 size_t iv_copy_len;
8817 size_t keylen;
8818 const mbedtls_ssl_ciphersuite_t *ciphersuite_info;
Neil Armstrong7fea33e2022-04-01 15:40:25 +02008819 mbedtls_ssl_mode_t ssl_mode;
Neil Armstronge4512952022-03-08 09:08:22 +01008820#if !defined(MBEDTLS_USE_PSA_CRYPTO)
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008821 const mbedtls_cipher_info_t *cipher_info;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008822 const mbedtls_md_info_t *md_info;
Neil Armstronge4512952022-03-08 09:08:22 +01008823#endif /* !MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008824
8825#if defined(MBEDTLS_USE_PSA_CRYPTO)
8826 psa_key_type_t key_type;
8827 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
8828 psa_algorithm_t alg;
Neil Armstronge4512952022-03-08 09:08:22 +01008829 psa_algorithm_t mac_alg = 0;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008830 size_t key_bits;
8831 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
8832#endif
8833
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008834 /*
8835 * Some data just needs copying into the structure
8836 */
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008837#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008838 transform->encrypt_then_mac = encrypt_then_mac;
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008839#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Glenn Strauss07c64162022-03-14 12:34:51 -04008840 transform->tls_version = tls_version;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008841
8842#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01008843 memcpy(transform->randbytes, randbytes, sizeof(transform->randbytes));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008844#endif
8845
8846#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01008847 if (tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008848 /* At the moment, we keep TLS <= 1.2 and TLS 1.3 transform
8849 * generation separate. This should never happen. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008850 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008851 }
8852#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
8853
8854 /*
8855 * Get various info structures
8856 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008857 ciphersuite_info = mbedtls_ssl_ciphersuite_from_id(ciphersuite);
8858 if (ciphersuite_info == NULL) {
8859 MBEDTLS_SSL_DEBUG_MSG(1, ("ciphersuite info for %d not found",
8860 ciphersuite));
8861 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008862 }
8863
Neil Armstrongab555e02022-04-04 11:07:59 +02008864 ssl_mode = mbedtls_ssl_get_mode_from_ciphersuite(
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008865#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01008866 encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008867#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01008868 ciphersuite_info);
Neil Armstrong7fea33e2022-04-01 15:40:25 +02008869
Gilles Peskine449bd832023-01-11 14:50:10 +01008870 if (ssl_mode == MBEDTLS_SSL_MODE_AEAD) {
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008871 transform->taglen =
8872 ciphersuite_info->flags & MBEDTLS_CIPHERSUITE_SHORT_TAG ? 8 : 16;
Gilles Peskine449bd832023-01-11 14:50:10 +01008873 }
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008874
8875#if defined(MBEDTLS_USE_PSA_CRYPTO)
Dave Rodgman2eab4622023-10-05 13:30:37 +01008876 if ((status = mbedtls_ssl_cipher_to_psa((mbedtls_cipher_type_t) ciphersuite_info->cipher,
Gilles Peskine449bd832023-01-11 14:50:10 +01008877 transform->taglen,
8878 &alg,
8879 &key_type,
8880 &key_bits)) != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008881 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01008882 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_cipher_to_psa", ret);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008883 goto end;
8884 }
8885#else
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01008886 cipher_info = mbedtls_cipher_info_from_type((mbedtls_cipher_type_t) ciphersuite_info->cipher);
Gilles Peskine449bd832023-01-11 14:50:10 +01008887 if (cipher_info == NULL) {
8888 MBEDTLS_SSL_DEBUG_MSG(1, ("cipher info for %u not found",
8889 ciphersuite_info->cipher));
8890 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008891 }
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008892#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008893
Neil Armstronge4512952022-03-08 09:08:22 +01008894#if defined(MBEDTLS_USE_PSA_CRYPTO)
Dave Rodgman2eab4622023-10-05 13:30:37 +01008895 mac_alg = mbedtls_md_psa_alg_from_type((mbedtls_md_type_t) ciphersuite_info->mac);
Gilles Peskine449bd832023-01-11 14:50:10 +01008896 if (mac_alg == 0) {
Manuel Pégourié-Gonnard2d6d9932023-03-28 11:38:08 +02008897 MBEDTLS_SSL_DEBUG_MSG(1, ("mbedtls_md_psa_alg_from_type for %u not found",
Gilles Peskine449bd832023-01-11 14:50:10 +01008898 (unsigned) ciphersuite_info->mac));
8899 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Neil Armstronge4512952022-03-08 09:08:22 +01008900 }
8901#else
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01008902 md_info = mbedtls_md_info_from_type((mbedtls_md_type_t) ciphersuite_info->mac);
Gilles Peskine449bd832023-01-11 14:50:10 +01008903 if (md_info == NULL) {
8904 MBEDTLS_SSL_DEBUG_MSG(1, ("mbedtls_md info for %u not found",
8905 (unsigned) ciphersuite_info->mac));
8906 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008907 }
Neil Armstronge4512952022-03-08 09:08:22 +01008908#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008909
8910#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
8911 /* Copy own and peer's CID if the use of the CID
8912 * extension has been negotiated. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008913 if (ssl->handshake->cid_in_use == MBEDTLS_SSL_CID_ENABLED) {
8914 MBEDTLS_SSL_DEBUG_MSG(3, ("Copy CIDs into SSL transform"));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008915
8916 transform->in_cid_len = ssl->own_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01008917 memcpy(transform->in_cid, ssl->own_cid, ssl->own_cid_len);
8918 MBEDTLS_SSL_DEBUG_BUF(3, "Incoming CID", transform->in_cid,
8919 transform->in_cid_len);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008920
8921 transform->out_cid_len = ssl->handshake->peer_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01008922 memcpy(transform->out_cid, ssl->handshake->peer_cid,
8923 ssl->handshake->peer_cid_len);
8924 MBEDTLS_SSL_DEBUG_BUF(3, "Outgoing CID", transform->out_cid,
8925 transform->out_cid_len);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008926 }
8927#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
8928
8929 /*
8930 * Compute key block using the PRF
8931 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008932 ret = tls_prf(master, 48, "key expansion", randbytes, 64, keyblk, 256);
8933 if (ret != 0) {
8934 MBEDTLS_SSL_DEBUG_RET(1, "prf", ret);
8935 return ret;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008936 }
8937
Gilles Peskine449bd832023-01-11 14:50:10 +01008938 MBEDTLS_SSL_DEBUG_MSG(3, ("ciphersuite = %s",
8939 mbedtls_ssl_get_ciphersuite_name(ciphersuite)));
8940 MBEDTLS_SSL_DEBUG_BUF(3, "master secret", master, 48);
8941 MBEDTLS_SSL_DEBUG_BUF(4, "random bytes", randbytes, 64);
8942 MBEDTLS_SSL_DEBUG_BUF(4, "key block", keyblk, 256);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008943
8944 /*
8945 * Determine the appropriate key, IV and MAC length.
8946 */
8947
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008948#if defined(MBEDTLS_USE_PSA_CRYPTO)
8949 keylen = PSA_BITS_TO_BYTES(key_bits);
8950#else
Gilles Peskine449bd832023-01-11 14:50:10 +01008951 keylen = mbedtls_cipher_info_get_key_bitlen(cipher_info) / 8;
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008952#endif
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008953
Valerio Settie5707042023-10-11 11:54:42 +02008954#if defined(MBEDTLS_SSL_HAVE_AEAD)
Gilles Peskine449bd832023-01-11 14:50:10 +01008955 if (ssl_mode == MBEDTLS_SSL_MODE_AEAD) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008956 size_t explicit_ivlen;
8957
8958 transform->maclen = 0;
8959 mac_key_len = 0;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008960
8961 /* All modes haves 96-bit IVs, but the length of the static parts vary
8962 * with mode and version:
8963 * - For GCM and CCM in TLS 1.2, there's a static IV of 4 Bytes
8964 * (to be concatenated with a dynamically chosen IV of 8 Bytes)
8965 * - For ChaChaPoly in TLS 1.2, and all modes in TLS 1.3, there's
8966 * a static IV of 12 Bytes (to be XOR'ed with the 8 Byte record
8967 * sequence number).
8968 */
8969 transform->ivlen = 12;
David Horstmann3b2276a2022-10-06 14:49:08 +01008970
8971 int is_chachapoly = 0;
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008972#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01008973 is_chachapoly = (key_type == PSA_KEY_TYPE_CHACHA20);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008974#else
Gilles Peskine449bd832023-01-11 14:50:10 +01008975 is_chachapoly = (mbedtls_cipher_info_get_mode(cipher_info)
8976 == MBEDTLS_MODE_CHACHAPOLY);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008977#endif /* MBEDTLS_USE_PSA_CRYPTO */
David Horstmann3b2276a2022-10-06 14:49:08 +01008978
Gilles Peskine449bd832023-01-11 14:50:10 +01008979 if (is_chachapoly) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008980 transform->fixed_ivlen = 12;
Gilles Peskine449bd832023-01-11 14:50:10 +01008981 } else {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008982 transform->fixed_ivlen = 4;
Gilles Peskine449bd832023-01-11 14:50:10 +01008983 }
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008984
8985 /* Minimum length of encrypted record */
8986 explicit_ivlen = transform->ivlen - transform->fixed_ivlen;
8987 transform->minlen = explicit_ivlen + transform->taglen;
Gilles Peskine449bd832023-01-11 14:50:10 +01008988 } else
Valerio Settie5707042023-10-11 11:54:42 +02008989#endif /* MBEDTLS_SSL_HAVE_AEAD */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008990#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01008991 if (ssl_mode == MBEDTLS_SSL_MODE_STREAM ||
Neil Armstrong7fea33e2022-04-01 15:40:25 +02008992 ssl_mode == MBEDTLS_SSL_MODE_CBC ||
Gilles Peskine449bd832023-01-11 14:50:10 +01008993 ssl_mode == MBEDTLS_SSL_MODE_CBC_ETM) {
Neil Armstronge4512952022-03-08 09:08:22 +01008994#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01008995 size_t block_size = PSA_BLOCK_CIPHER_BLOCK_LENGTH(key_type);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008996#else
Dave Rodgman85a88132023-06-24 11:41:50 +01008997 size_t block_size = mbedtls_cipher_info_get_block_size(cipher_info);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008998#endif /* MBEDTLS_USE_PSA_CRYPTO */
8999
9000#if defined(MBEDTLS_USE_PSA_CRYPTO)
Neil Armstronge4512952022-03-08 09:08:22 +01009001 /* Get MAC length */
9002 mac_key_len = PSA_HASH_LENGTH(mac_alg);
9003#else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009004 /* Initialize HMAC contexts */
Gilles Peskine449bd832023-01-11 14:50:10 +01009005 if ((ret = mbedtls_md_setup(&transform->md_ctx_enc, md_info, 1)) != 0 ||
9006 (ret = mbedtls_md_setup(&transform->md_ctx_dec, md_info, 1)) != 0) {
9007 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_setup", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009008 goto end;
9009 }
9010
9011 /* Get MAC length */
Gilles Peskine449bd832023-01-11 14:50:10 +01009012 mac_key_len = mbedtls_md_get_size(md_info);
Neil Armstronge4512952022-03-08 09:08:22 +01009013#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009014 transform->maclen = mac_key_len;
9015
9016 /* IV length */
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02009017#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01009018 transform->ivlen = PSA_CIPHER_IV_LENGTH(key_type, alg);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02009019#else
Dave Rodgmanbb521fd2023-06-24 11:21:25 +01009020 transform->ivlen = mbedtls_cipher_info_get_iv_size(cipher_info);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02009021#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009022
9023 /* Minimum length */
Gilles Peskine449bd832023-01-11 14:50:10 +01009024 if (ssl_mode == MBEDTLS_SSL_MODE_STREAM) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009025 transform->minlen = transform->maclen;
Gilles Peskine449bd832023-01-11 14:50:10 +01009026 } else {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009027 /*
9028 * GenericBlockCipher:
9029 * 1. if EtM is in use: one block plus MAC
9030 * otherwise: * first multiple of blocklen greater than maclen
9031 * 2. IV
9032 */
9033#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01009034 if (ssl_mode == MBEDTLS_SSL_MODE_CBC_ETM) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009035 transform->minlen = transform->maclen
Gilles Peskine449bd832023-01-11 14:50:10 +01009036 + block_size;
9037 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009038#endif
9039 {
9040 transform->minlen = transform->maclen
Gilles Peskine449bd832023-01-11 14:50:10 +01009041 + block_size
9042 - transform->maclen % block_size;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009043 }
9044
Gilles Peskine449bd832023-01-11 14:50:10 +01009045 if (tls_version == MBEDTLS_SSL_VERSION_TLS1_2) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009046 transform->minlen += transform->ivlen;
Gilles Peskine449bd832023-01-11 14:50:10 +01009047 } else {
9048 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009049 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
9050 goto end;
9051 }
9052 }
Gilles Peskine449bd832023-01-11 14:50:10 +01009053 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009054#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
9055 {
Gilles Peskine449bd832023-01-11 14:50:10 +01009056 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
9057 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009058 }
9059
Gilles Peskine449bd832023-01-11 14:50:10 +01009060 MBEDTLS_SSL_DEBUG_MSG(3, ("keylen: %u, minlen: %u, ivlen: %u, maclen: %u",
9061 (unsigned) keylen,
9062 (unsigned) transform->minlen,
9063 (unsigned) transform->ivlen,
9064 (unsigned) transform->maclen));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009065
9066 /*
9067 * Finally setup the cipher contexts, IVs and MAC secrets.
9068 */
9069#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01009070 if (endpoint == MBEDTLS_SSL_IS_CLIENT) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009071 key1 = keyblk + mac_key_len * 2;
9072 key2 = keyblk + mac_key_len * 2 + keylen;
9073
9074 mac_enc = keyblk;
9075 mac_dec = keyblk + mac_key_len;
9076
Gilles Peskine449bd832023-01-11 14:50:10 +01009077 iv_copy_len = (transform->fixed_ivlen) ?
9078 transform->fixed_ivlen : transform->ivlen;
9079 memcpy(transform->iv_enc, key2 + keylen, iv_copy_len);
9080 memcpy(transform->iv_dec, key2 + keylen + iv_copy_len,
9081 iv_copy_len);
9082 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009083#endif /* MBEDTLS_SSL_CLI_C */
9084#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01009085 if (endpoint == MBEDTLS_SSL_IS_SERVER) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009086 key1 = keyblk + mac_key_len * 2 + keylen;
9087 key2 = keyblk + mac_key_len * 2;
9088
9089 mac_enc = keyblk + mac_key_len;
9090 mac_dec = keyblk;
9091
Gilles Peskine449bd832023-01-11 14:50:10 +01009092 iv_copy_len = (transform->fixed_ivlen) ?
9093 transform->fixed_ivlen : transform->ivlen;
9094 memcpy(transform->iv_dec, key1 + keylen, iv_copy_len);
9095 memcpy(transform->iv_enc, key1 + keylen + iv_copy_len,
9096 iv_copy_len);
9097 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009098#endif /* MBEDTLS_SSL_SRV_C */
9099 {
Gilles Peskine449bd832023-01-11 14:50:10 +01009100 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009101 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
9102 goto end;
9103 }
9104
Paul Elliott4fb19552023-10-18 12:15:30 +01009105 if (ssl->f_export_keys != NULL) {
Gilles Peskine449bd832023-01-11 14:50:10 +01009106 ssl->f_export_keys(ssl->p_export_keys,
9107 MBEDTLS_SSL_KEY_EXPORT_TLS12_MASTER_SECRET,
9108 master, 48,
9109 randbytes + 32,
9110 randbytes,
9111 tls_prf_get_type(tls_prf));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009112 }
9113
9114#if defined(MBEDTLS_USE_PSA_CRYPTO)
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009115 transform->psa_alg = alg;
9116
Gilles Peskine449bd832023-01-11 14:50:10 +01009117 if (alg != MBEDTLS_SSL_NULL_CIPHER) {
9118 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_ENCRYPT);
9119 psa_set_key_algorithm(&attributes, alg);
9120 psa_set_key_type(&attributes, key_type);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009121
Gilles Peskine449bd832023-01-11 14:50:10 +01009122 if ((status = psa_import_key(&attributes,
9123 key1,
9124 PSA_BITS_TO_BYTES(key_bits),
9125 &transform->psa_key_enc)) != PSA_SUCCESS) {
9126 MBEDTLS_SSL_DEBUG_RET(3, "psa_import_key", (int) status);
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05009127 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01009128 MBEDTLS_SSL_DEBUG_RET(1, "psa_import_key", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009129 goto end;
9130 }
9131
Gilles Peskine449bd832023-01-11 14:50:10 +01009132 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_DECRYPT);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009133
Gilles Peskine449bd832023-01-11 14:50:10 +01009134 if ((status = psa_import_key(&attributes,
9135 key2,
9136 PSA_BITS_TO_BYTES(key_bits),
9137 &transform->psa_key_dec)) != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05009138 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01009139 MBEDTLS_SSL_DEBUG_RET(1, "psa_import_key", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009140 goto end;
9141 }
9142 }
9143#else
Gilles Peskine449bd832023-01-11 14:50:10 +01009144 if ((ret = mbedtls_cipher_setup(&transform->cipher_ctx_enc,
9145 cipher_info)) != 0) {
9146 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_setup", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009147 goto end;
9148 }
9149
Gilles Peskine449bd832023-01-11 14:50:10 +01009150 if ((ret = mbedtls_cipher_setup(&transform->cipher_ctx_dec,
9151 cipher_info)) != 0) {
9152 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_setup", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009153 goto end;
9154 }
9155
Gilles Peskine449bd832023-01-11 14:50:10 +01009156 if ((ret = mbedtls_cipher_setkey(&transform->cipher_ctx_enc, key1,
9157 (int) mbedtls_cipher_info_get_key_bitlen(cipher_info),
9158 MBEDTLS_ENCRYPT)) != 0) {
9159 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_setkey", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009160 goto end;
9161 }
9162
Gilles Peskine449bd832023-01-11 14:50:10 +01009163 if ((ret = mbedtls_cipher_setkey(&transform->cipher_ctx_dec, key2,
9164 (int) mbedtls_cipher_info_get_key_bitlen(cipher_info),
9165 MBEDTLS_DECRYPT)) != 0) {
9166 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_setkey", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009167 goto end;
9168 }
9169
9170#if defined(MBEDTLS_CIPHER_MODE_CBC)
Gilles Peskine449bd832023-01-11 14:50:10 +01009171 if (mbedtls_cipher_info_get_mode(cipher_info) == MBEDTLS_MODE_CBC) {
9172 if ((ret = mbedtls_cipher_set_padding_mode(&transform->cipher_ctx_enc,
9173 MBEDTLS_PADDING_NONE)) != 0) {
9174 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_set_padding_mode", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009175 goto end;
9176 }
9177
Gilles Peskine449bd832023-01-11 14:50:10 +01009178 if ((ret = mbedtls_cipher_set_padding_mode(&transform->cipher_ctx_dec,
9179 MBEDTLS_PADDING_NONE)) != 0) {
9180 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_set_padding_mode", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009181 goto end;
9182 }
9183 }
9184#endif /* MBEDTLS_CIPHER_MODE_CBC */
9185#endif /* MBEDTLS_USE_PSA_CRYPTO */
9186
Neil Armstrong29c0c042022-03-17 17:47:28 +01009187#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
9188 /* For HMAC-based ciphersuites, initialize the HMAC transforms.
9189 For AEAD-based ciphersuites, there is nothing to do here. */
Gilles Peskine449bd832023-01-11 14:50:10 +01009190 if (mac_key_len != 0) {
Neil Armstrong29c0c042022-03-17 17:47:28 +01009191#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01009192 transform->psa_mac_alg = PSA_ALG_HMAC(mac_alg);
Neil Armstrong29c0c042022-03-17 17:47:28 +01009193
Gilles Peskine449bd832023-01-11 14:50:10 +01009194 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_SIGN_MESSAGE);
9195 psa_set_key_algorithm(&attributes, PSA_ALG_HMAC(mac_alg));
9196 psa_set_key_type(&attributes, PSA_KEY_TYPE_HMAC);
Neil Armstrong29c0c042022-03-17 17:47:28 +01009197
Gilles Peskine449bd832023-01-11 14:50:10 +01009198 if ((status = psa_import_key(&attributes,
9199 mac_enc, mac_key_len,
9200 &transform->psa_mac_enc)) != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05009201 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01009202 MBEDTLS_SSL_DEBUG_RET(1, "psa_import_mac_key", ret);
Neil Armstrong29c0c042022-03-17 17:47:28 +01009203 goto end;
9204 }
9205
Gilles Peskine449bd832023-01-11 14:50:10 +01009206 if ((transform->psa_alg == MBEDTLS_SSL_NULL_CIPHER) ||
9207 ((transform->psa_alg == PSA_ALG_CBC_NO_PADDING)
Andrzej Kurek8c95ac42022-08-17 16:17:00 -04009208#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01009209 && (transform->encrypt_then_mac == MBEDTLS_SSL_ETM_DISABLED)
Andrzej Kurek8c95ac42022-08-17 16:17:00 -04009210#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01009211 )) {
Neil Armstrong29c0c042022-03-17 17:47:28 +01009212 /* mbedtls_ct_hmac() requires the key to be exportable */
Gilles Peskine449bd832023-01-11 14:50:10 +01009213 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_EXPORT |
9214 PSA_KEY_USAGE_VERIFY_HASH);
9215 } else {
9216 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_VERIFY_HASH);
9217 }
Neil Armstrong29c0c042022-03-17 17:47:28 +01009218
Gilles Peskine449bd832023-01-11 14:50:10 +01009219 if ((status = psa_import_key(&attributes,
9220 mac_dec, mac_key_len,
9221 &transform->psa_mac_dec)) != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05009222 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01009223 MBEDTLS_SSL_DEBUG_RET(1, "psa_import_mac_key", ret);
Neil Armstrong29c0c042022-03-17 17:47:28 +01009224 goto end;
9225 }
9226#else
Gilles Peskine449bd832023-01-11 14:50:10 +01009227 ret = mbedtls_md_hmac_starts(&transform->md_ctx_enc, mac_enc, mac_key_len);
9228 if (ret != 0) {
Neil Armstrong29c0c042022-03-17 17:47:28 +01009229 goto end;
Gilles Peskine449bd832023-01-11 14:50:10 +01009230 }
9231 ret = mbedtls_md_hmac_starts(&transform->md_ctx_dec, mac_dec, mac_key_len);
9232 if (ret != 0) {
Neil Armstrong29c0c042022-03-17 17:47:28 +01009233 goto end;
Gilles Peskine449bd832023-01-11 14:50:10 +01009234 }
Neil Armstrong29c0c042022-03-17 17:47:28 +01009235#endif /* MBEDTLS_USE_PSA_CRYPTO */
9236 }
9237#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
9238
9239 ((void) mac_dec);
9240 ((void) mac_enc);
9241
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009242end:
Gilles Peskine449bd832023-01-11 14:50:10 +01009243 mbedtls_platform_zeroize(keyblk, sizeof(keyblk));
9244 return ret;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009245}
9246
Valerio Settia08b1a42022-11-17 15:10:02 +01009247#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED) && \
9248 defined(MBEDTLS_USE_PSA_CRYPTO)
Valerio Setti6b3dab02022-11-17 17:14:54 +01009249int mbedtls_psa_ecjpake_read_round(
Gilles Peskine449bd832023-01-11 14:50:10 +01009250 psa_pake_operation_t *pake_ctx,
9251 const unsigned char *buf,
9252 size_t len, mbedtls_ecjpake_rounds_t round)
Valerio Settia08b1a42022-11-17 15:10:02 +01009253{
9254 psa_status_t status;
9255 size_t input_offset = 0;
Valerio Setti819de862022-11-17 18:05:19 +01009256 /*
Valerio Setti6b3dab02022-11-17 17:14:54 +01009257 * At round one repeat the KEY_SHARE, ZK_PUBLIC & ZF_PROOF twice
9258 * At round two perform a single cycle
9259 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009260 unsigned int remaining_steps = (round == MBEDTLS_ECJPAKE_ROUND_ONE) ? 2 : 1;
Valerio Settia08b1a42022-11-17 15:10:02 +01009261
Gilles Peskine449bd832023-01-11 14:50:10 +01009262 for (; remaining_steps > 0; remaining_steps--) {
9263 for (psa_pake_step_t step = PSA_PAKE_STEP_KEY_SHARE;
Valerio Settia08b1a42022-11-17 15:10:02 +01009264 step <= PSA_PAKE_STEP_ZK_PROOF;
Gilles Peskine449bd832023-01-11 14:50:10 +01009265 ++step) {
Valerio Settia08b1a42022-11-17 15:10:02 +01009266 /* Length is stored at the first byte */
9267 size_t length = buf[input_offset];
9268 input_offset += 1;
9269
Gilles Peskine449bd832023-01-11 14:50:10 +01009270 if (input_offset + length > len) {
Valerio Settia08b1a42022-11-17 15:10:02 +01009271 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
9272 }
9273
Gilles Peskine449bd832023-01-11 14:50:10 +01009274 status = psa_pake_input(pake_ctx, step,
9275 buf + input_offset, length);
9276 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05009277 return PSA_TO_MBEDTLS_ERR(status);
Valerio Settia08b1a42022-11-17 15:10:02 +01009278 }
9279
9280 input_offset += length;
9281 }
9282 }
9283
Gilles Peskine449bd832023-01-11 14:50:10 +01009284 if (input_offset != len) {
Valerio Setti61ea17d2022-11-18 12:11:00 +01009285 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Gilles Peskine449bd832023-01-11 14:50:10 +01009286 }
Valerio Setti30ebe112022-11-17 16:23:34 +01009287
Gilles Peskine449bd832023-01-11 14:50:10 +01009288 return 0;
Valerio Settia08b1a42022-11-17 15:10:02 +01009289}
9290
Valerio Setti6b3dab02022-11-17 17:14:54 +01009291int mbedtls_psa_ecjpake_write_round(
Gilles Peskine449bd832023-01-11 14:50:10 +01009292 psa_pake_operation_t *pake_ctx,
9293 unsigned char *buf,
9294 size_t len, size_t *olen,
9295 mbedtls_ecjpake_rounds_t round)
Valerio Settia08b1a42022-11-17 15:10:02 +01009296{
9297 psa_status_t status;
9298 size_t output_offset = 0;
9299 size_t output_len;
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;
9308 step <= PSA_PAKE_STEP_ZK_PROOF;
9309 ++step) {
Valerio Setti79f6b6b2022-11-21 14:17:03 +01009310 /*
Valerio Settid4a9b1a2022-11-22 11:11:10 +01009311 * For each step, prepend 1 byte with the length of the data as
9312 * given by psa_pake_output().
Valerio Setti79f6b6b2022-11-21 14:17:03 +01009313 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009314 status = psa_pake_output(pake_ctx, step,
9315 buf + output_offset + 1,
9316 len - output_offset - 1,
9317 &output_len);
9318 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05009319 return PSA_TO_MBEDTLS_ERR(status);
Valerio Settia08b1a42022-11-17 15:10:02 +01009320 }
9321
Valerio Setti99d88c12022-11-22 16:03:43 +01009322 *(buf + output_offset) = (uint8_t) output_len;
Valerio Setti79f6b6b2022-11-21 14:17:03 +01009323
9324 output_offset += output_len + 1;
Valerio Settia08b1a42022-11-17 15:10:02 +01009325 }
9326 }
9327
9328 *olen = output_offset;
9329
Gilles Peskine449bd832023-01-11 14:50:10 +01009330 return 0;
Valerio Settia08b1a42022-11-17 15:10:02 +01009331}
Valerio Settia08b1a42022-11-17 15:10:02 +01009332#endif //MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED && MBEDTLS_USE_PSA_CRYPTO
9333
Jerry Yuee40f9d2022-02-17 14:55:16 +08009334#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01009335int mbedtls_ssl_get_key_exchange_md_tls1_2(mbedtls_ssl_context *ssl,
9336 unsigned char *hash, size_t *hashlen,
9337 unsigned char *data, size_t data_len,
9338 mbedtls_md_type_t md_alg)
Jerry Yuee40f9d2022-02-17 14:55:16 +08009339{
9340 psa_status_t status;
9341 psa_hash_operation_t hash_operation = PSA_HASH_OPERATION_INIT;
Manuel Pégourié-Gonnard2d6d9932023-03-28 11:38:08 +02009342 psa_algorithm_t hash_alg = mbedtls_md_psa_alg_from_type(md_alg);
Jerry Yuee40f9d2022-02-17 14:55:16 +08009343
Gilles Peskine449bd832023-01-11 14:50:10 +01009344 MBEDTLS_SSL_DEBUG_MSG(3, ("Perform PSA-based computation of digest of ServerKeyExchange"));
Jerry Yuee40f9d2022-02-17 14:55:16 +08009345
Gilles Peskine449bd832023-01-11 14:50:10 +01009346 if ((status = psa_hash_setup(&hash_operation,
9347 hash_alg)) != PSA_SUCCESS) {
9348 MBEDTLS_SSL_DEBUG_RET(1, "psa_hash_setup", status);
Jerry Yuee40f9d2022-02-17 14:55:16 +08009349 goto exit;
9350 }
9351
Gilles Peskine449bd832023-01-11 14:50:10 +01009352 if ((status = psa_hash_update(&hash_operation, ssl->handshake->randbytes,
9353 64)) != PSA_SUCCESS) {
9354 MBEDTLS_SSL_DEBUG_RET(1, "psa_hash_update", status);
Jerry Yuee40f9d2022-02-17 14:55:16 +08009355 goto exit;
9356 }
9357
Gilles Peskine449bd832023-01-11 14:50:10 +01009358 if ((status = psa_hash_update(&hash_operation,
9359 data, data_len)) != PSA_SUCCESS) {
9360 MBEDTLS_SSL_DEBUG_RET(1, "psa_hash_update", status);
Jerry Yuee40f9d2022-02-17 14:55:16 +08009361 goto exit;
9362 }
9363
Gilles Peskine449bd832023-01-11 14:50:10 +01009364 if ((status = psa_hash_finish(&hash_operation, hash, PSA_HASH_MAX_SIZE,
9365 hashlen)) != PSA_SUCCESS) {
9366 MBEDTLS_SSL_DEBUG_RET(1, "psa_hash_finish", status);
9367 goto exit;
Jerry Yuee40f9d2022-02-17 14:55:16 +08009368 }
9369
9370exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01009371 if (status != PSA_SUCCESS) {
9372 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
9373 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR);
9374 switch (status) {
Jerry Yuee40f9d2022-02-17 14:55:16 +08009375 case PSA_ERROR_NOT_SUPPORTED:
Gilles Peskine449bd832023-01-11 14:50:10 +01009376 return MBEDTLS_ERR_MD_FEATURE_UNAVAILABLE;
Jerry Yuee40f9d2022-02-17 14:55:16 +08009377 case PSA_ERROR_BAD_STATE: /* Intentional fallthrough */
9378 case PSA_ERROR_BUFFER_TOO_SMALL:
Gilles Peskine449bd832023-01-11 14:50:10 +01009379 return MBEDTLS_ERR_MD_BAD_INPUT_DATA;
Jerry Yuee40f9d2022-02-17 14:55:16 +08009380 case PSA_ERROR_INSUFFICIENT_MEMORY:
Gilles Peskine449bd832023-01-11 14:50:10 +01009381 return MBEDTLS_ERR_MD_ALLOC_FAILED;
Jerry Yuee40f9d2022-02-17 14:55:16 +08009382 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01009383 return MBEDTLS_ERR_PLATFORM_HW_ACCEL_FAILED;
Jerry Yuee40f9d2022-02-17 14:55:16 +08009384 }
9385 }
Gilles Peskine449bd832023-01-11 14:50:10 +01009386 return 0;
Jerry Yuee40f9d2022-02-17 14:55:16 +08009387}
9388
9389#else
9390
Gilles Peskine449bd832023-01-11 14:50:10 +01009391int mbedtls_ssl_get_key_exchange_md_tls1_2(mbedtls_ssl_context *ssl,
9392 unsigned char *hash, size_t *hashlen,
9393 unsigned char *data, size_t data_len,
9394 mbedtls_md_type_t md_alg)
Jerry Yuee40f9d2022-02-17 14:55:16 +08009395{
9396 int ret = 0;
9397 mbedtls_md_context_t ctx;
Gilles Peskine449bd832023-01-11 14:50:10 +01009398 const mbedtls_md_info_t *md_info = mbedtls_md_info_from_type(md_alg);
9399 *hashlen = mbedtls_md_get_size(md_info);
Jerry Yuee40f9d2022-02-17 14:55:16 +08009400
Gilles Peskine449bd832023-01-11 14:50:10 +01009401 MBEDTLS_SSL_DEBUG_MSG(3, ("Perform mbedtls-based computation of digest of ServerKeyExchange"));
Jerry Yuee40f9d2022-02-17 14:55:16 +08009402
Gilles Peskine449bd832023-01-11 14:50:10 +01009403 mbedtls_md_init(&ctx);
Jerry Yuee40f9d2022-02-17 14:55:16 +08009404
9405 /*
9406 * digitally-signed struct {
9407 * opaque client_random[32];
9408 * opaque server_random[32];
9409 * ServerDHParams params;
9410 * };
9411 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009412 if ((ret = mbedtls_md_setup(&ctx, md_info, 0)) != 0) {
9413 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_setup", ret);
Jerry Yuee40f9d2022-02-17 14:55:16 +08009414 goto exit;
9415 }
Gilles Peskine449bd832023-01-11 14:50:10 +01009416 if ((ret = mbedtls_md_starts(&ctx)) != 0) {
9417 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_starts", ret);
Jerry Yuee40f9d2022-02-17 14:55:16 +08009418 goto exit;
9419 }
Gilles Peskine449bd832023-01-11 14:50:10 +01009420 if ((ret = mbedtls_md_update(&ctx, ssl->handshake->randbytes, 64)) != 0) {
9421 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_update", ret);
Jerry Yuee40f9d2022-02-17 14:55:16 +08009422 goto exit;
9423 }
Gilles Peskine449bd832023-01-11 14:50:10 +01009424 if ((ret = mbedtls_md_update(&ctx, data, data_len)) != 0) {
9425 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_update", ret);
Jerry Yuee40f9d2022-02-17 14:55:16 +08009426 goto exit;
9427 }
Gilles Peskine449bd832023-01-11 14:50:10 +01009428 if ((ret = mbedtls_md_finish(&ctx, hash)) != 0) {
9429 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_finish", ret);
Jerry Yuee40f9d2022-02-17 14:55:16 +08009430 goto exit;
9431 }
9432
9433exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01009434 mbedtls_md_free(&ctx);
Jerry Yuee40f9d2022-02-17 14:55:16 +08009435
Gilles Peskine449bd832023-01-11 14:50:10 +01009436 if (ret != 0) {
9437 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
9438 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR);
9439 }
Jerry Yuee40f9d2022-02-17 14:55:16 +08009440
Gilles Peskine449bd832023-01-11 14:50:10 +01009441 return ret;
Jerry Yuee40f9d2022-02-17 14:55:16 +08009442}
9443#endif /* MBEDTLS_USE_PSA_CRYPTO */
9444
Jerry Yud9d91da2022-02-17 14:57:06 +08009445#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
9446
Gabor Mezeia3d016c2022-05-10 12:44:09 +02009447/* Find the preferred hash for a given signature algorithm. */
9448unsigned int mbedtls_ssl_tls12_get_preferred_hash_for_sig_alg(
Gilles Peskine449bd832023-01-11 14:50:10 +01009449 mbedtls_ssl_context *ssl,
9450 unsigned int sig_alg)
Jerry Yud9d91da2022-02-17 14:57:06 +08009451{
Gabor Mezei078e8032022-04-27 21:17:56 +02009452 unsigned int i;
Gabor Mezeia3d016c2022-05-10 12:44:09 +02009453 uint16_t *received_sig_algs = ssl->handshake->received_sig_algs;
Gabor Mezei078e8032022-04-27 21:17:56 +02009454
Gilles Peskine449bd832023-01-11 14:50:10 +01009455 if (sig_alg == MBEDTLS_SSL_SIG_ANON) {
9456 return MBEDTLS_SSL_HASH_NONE;
9457 }
Gabor Mezei078e8032022-04-27 21:17:56 +02009458
Gilles Peskine449bd832023-01-11 14:50:10 +01009459 for (i = 0; received_sig_algs[i] != MBEDTLS_TLS_SIG_NONE; i++) {
Neil Armstrong9f1176a2022-06-24 18:19:19 +02009460 unsigned int hash_alg_received =
Gilles Peskine449bd832023-01-11 14:50:10 +01009461 MBEDTLS_SSL_TLS12_HASH_ALG_FROM_SIG_AND_HASH_ALG(
9462 received_sig_algs[i]);
Neil Armstrong9f1176a2022-06-24 18:19:19 +02009463 unsigned int sig_alg_received =
Gilles Peskine449bd832023-01-11 14:50:10 +01009464 MBEDTLS_SSL_TLS12_SIG_ALG_FROM_SIG_AND_HASH_ALG(
9465 received_sig_algs[i]);
Neil Armstrong9f1176a2022-06-24 18:19:19 +02009466
Manuel Pégourié-Gonnard47bb3802023-06-05 12:40:32 +02009467 mbedtls_md_type_t md_alg =
9468 mbedtls_ssl_md_alg_from_hash((unsigned char) hash_alg_received);
9469 if (md_alg == MBEDTLS_MD_NONE) {
9470 continue;
9471 }
9472
Gilles Peskine449bd832023-01-11 14:50:10 +01009473 if (sig_alg == sig_alg_received) {
Neil Armstrong9f1176a2022-06-24 18:19:19 +02009474#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01009475 if (ssl->handshake->key_cert && ssl->handshake->key_cert->key) {
Neil Armstrong96eceb82022-06-30 18:05:05 +02009476 psa_algorithm_t psa_hash_alg =
Manuel Pégourié-Gonnard47bb3802023-06-05 12:40:32 +02009477 mbedtls_md_psa_alg_from_type(md_alg);
Neil Armstrong9f1176a2022-06-24 18:19:19 +02009478
Gilles Peskine449bd832023-01-11 14:50:10 +01009479 if (sig_alg_received == MBEDTLS_SSL_SIG_ECDSA &&
9480 !mbedtls_pk_can_do_ext(ssl->handshake->key_cert->key,
9481 PSA_ALG_ECDSA(psa_hash_alg),
9482 PSA_KEY_USAGE_SIGN_HASH)) {
Neil Armstrong9f1176a2022-06-24 18:19:19 +02009483 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01009484 }
Neil Armstrong9f1176a2022-06-24 18:19:19 +02009485
Gilles Peskine449bd832023-01-11 14:50:10 +01009486 if (sig_alg_received == MBEDTLS_SSL_SIG_RSA &&
9487 !mbedtls_pk_can_do_ext(ssl->handshake->key_cert->key,
9488 PSA_ALG_RSA_PKCS1V15_SIGN(
9489 psa_hash_alg),
9490 PSA_KEY_USAGE_SIGN_HASH)) {
Neil Armstrong9f1176a2022-06-24 18:19:19 +02009491 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01009492 }
Neil Armstrong9f1176a2022-06-24 18:19:19 +02009493 }
Neil Armstrong9f1176a2022-06-24 18:19:19 +02009494#endif /* MBEDTLS_USE_PSA_CRYPTO */
Neil Armstrong96eceb82022-06-30 18:05:05 +02009495
Gilles Peskine449bd832023-01-11 14:50:10 +01009496 return hash_alg_received;
Neil Armstrong9f1176a2022-06-24 18:19:19 +02009497 }
Jerry Yud9d91da2022-02-17 14:57:06 +08009498 }
Jerry Yud9d91da2022-02-17 14:57:06 +08009499
Gilles Peskine449bd832023-01-11 14:50:10 +01009500 return MBEDTLS_SSL_HASH_NONE;
Jerry Yud9d91da2022-02-17 14:57:06 +08009501}
9502
9503#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
9504
Jerry Yudc7bd172022-02-17 13:44:15 +08009505#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
9506
XiaokangQian75d40ef2022-04-20 11:05:24 +00009507int mbedtls_ssl_validate_ciphersuite(
9508 const mbedtls_ssl_context *ssl,
9509 const mbedtls_ssl_ciphersuite_t *suite_info,
9510 mbedtls_ssl_protocol_version min_tls_version,
Gilles Peskine449bd832023-01-11 14:50:10 +01009511 mbedtls_ssl_protocol_version max_tls_version)
XiaokangQian75d40ef2022-04-20 11:05:24 +00009512{
9513 (void) ssl;
9514
Gilles Peskine449bd832023-01-11 14:50:10 +01009515 if (suite_info == NULL) {
9516 return -1;
9517 }
XiaokangQian75d40ef2022-04-20 11:05:24 +00009518
Gilles Peskine449bd832023-01-11 14:50:10 +01009519 if ((suite_info->min_tls_version > max_tls_version) ||
9520 (suite_info->max_tls_version < min_tls_version)) {
9521 return -1;
XiaokangQian75d40ef2022-04-20 11:05:24 +00009522 }
9523
XiaokangQian060d8672022-04-21 09:24:56 +00009524#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_CLI_C)
XiaokangQian75d40ef2022-04-20 11:05:24 +00009525#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Neil Armstrongca7d5062022-05-31 14:43:23 +02009526#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01009527 if (suite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_ECJPAKE &&
9528 ssl->handshake->psa_pake_ctx_is_ok != 1)
Neil Armstrongca7d5062022-05-31 14:43:23 +02009529#else
Gilles Peskine449bd832023-01-11 14:50:10 +01009530 if (suite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_ECJPAKE &&
9531 mbedtls_ecjpake_check(&ssl->handshake->ecjpake_ctx) != 0)
Neil Armstrongca7d5062022-05-31 14:43:23 +02009532#endif /* MBEDTLS_USE_PSA_CRYPTO */
XiaokangQian75d40ef2022-04-20 11:05:24 +00009533 {
Gilles Peskine449bd832023-01-11 14:50:10 +01009534 return -1;
XiaokangQian75d40ef2022-04-20 11:05:24 +00009535 }
9536#endif
9537
9538 /* Don't suggest PSK-based ciphersuite if no PSK is available. */
9539#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01009540 if (mbedtls_ssl_ciphersuite_uses_psk(suite_info) &&
9541 mbedtls_ssl_conf_has_static_psk(ssl->conf) == 0) {
9542 return -1;
XiaokangQian75d40ef2022-04-20 11:05:24 +00009543 }
9544#endif /* MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
9545#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
9546
Gilles Peskine449bd832023-01-11 14:50:10 +01009547 return 0;
XiaokangQian75d40ef2022-04-20 11:05:24 +00009548}
9549
Ronald Crone68ab4f2022-10-05 12:46:29 +02009550#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
XiaokangQianeaf36512022-04-24 09:07:44 +00009551/*
9552 * Function for writing a signature algorithm extension.
9553 *
9554 * The `extension_data` field of signature algorithm contains a `SignatureSchemeList`
9555 * value (TLS 1.3 RFC8446):
9556 * enum {
9557 * ....
9558 * ecdsa_secp256r1_sha256( 0x0403 ),
9559 * ecdsa_secp384r1_sha384( 0x0503 ),
9560 * ecdsa_secp521r1_sha512( 0x0603 ),
9561 * ....
9562 * } SignatureScheme;
9563 *
9564 * struct {
9565 * SignatureScheme supported_signature_algorithms<2..2^16-2>;
9566 * } SignatureSchemeList;
9567 *
9568 * The `extension_data` field of signature algorithm contains a `SignatureAndHashAlgorithm`
9569 * value (TLS 1.2 RFC5246):
9570 * enum {
9571 * none(0), md5(1), sha1(2), sha224(3), sha256(4), sha384(5),
9572 * sha512(6), (255)
9573 * } HashAlgorithm;
9574 *
9575 * enum { anonymous(0), rsa(1), dsa(2), ecdsa(3), (255) }
9576 * SignatureAlgorithm;
9577 *
9578 * struct {
9579 * HashAlgorithm hash;
9580 * SignatureAlgorithm signature;
9581 * } SignatureAndHashAlgorithm;
9582 *
9583 * SignatureAndHashAlgorithm
9584 * supported_signature_algorithms<2..2^16-2>;
9585 *
9586 * The TLS 1.3 signature algorithm extension was defined to be a compatible
9587 * generalization of the TLS 1.2 signature algorithm extension.
9588 * `SignatureAndHashAlgorithm` field of TLS 1.2 can be represented by
9589 * `SignatureScheme` field of TLS 1.3
9590 *
9591 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009592int mbedtls_ssl_write_sig_alg_ext(mbedtls_ssl_context *ssl, unsigned char *buf,
9593 const unsigned char *end, size_t *out_len)
XiaokangQianeaf36512022-04-24 09:07:44 +00009594{
9595 unsigned char *p = buf;
9596 unsigned char *supported_sig_alg; /* Start of supported_signature_algorithms */
9597 size_t supported_sig_alg_len = 0; /* Length of supported_signature_algorithms */
9598
9599 *out_len = 0;
9600
Gilles Peskine449bd832023-01-11 14:50:10 +01009601 MBEDTLS_SSL_DEBUG_MSG(3, ("adding signature_algorithms extension"));
XiaokangQianeaf36512022-04-24 09:07:44 +00009602
9603 /* Check if we have space for header and length field:
9604 * - extension_type (2 bytes)
9605 * - extension_data_length (2 bytes)
9606 * - supported_signature_algorithms_length (2 bytes)
9607 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009608 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 6);
XiaokangQianeaf36512022-04-24 09:07:44 +00009609 p += 6;
9610
9611 /*
9612 * Write supported_signature_algorithms
9613 */
9614 supported_sig_alg = p;
Gilles Peskine449bd832023-01-11 14:50:10 +01009615 const uint16_t *sig_alg = mbedtls_ssl_get_sig_algs(ssl);
9616 if (sig_alg == NULL) {
9617 return MBEDTLS_ERR_SSL_BAD_CONFIG;
9618 }
XiaokangQianeaf36512022-04-24 09:07:44 +00009619
Gilles Peskine449bd832023-01-11 14:50:10 +01009620 for (; *sig_alg != MBEDTLS_TLS1_3_SIG_NONE; sig_alg++) {
9621 MBEDTLS_SSL_DEBUG_MSG(3, ("got signature scheme [%x] %s",
9622 *sig_alg,
9623 mbedtls_ssl_sig_alg_to_str(*sig_alg)));
9624 if (!mbedtls_ssl_sig_alg_is_supported(ssl, *sig_alg)) {
XiaokangQianeaf36512022-04-24 09:07:44 +00009625 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01009626 }
9627 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 2);
9628 MBEDTLS_PUT_UINT16_BE(*sig_alg, p, 0);
XiaokangQianeaf36512022-04-24 09:07:44 +00009629 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01009630 MBEDTLS_SSL_DEBUG_MSG(3, ("sent signature scheme [%x] %s",
9631 *sig_alg,
9632 mbedtls_ssl_sig_alg_to_str(*sig_alg)));
XiaokangQianeaf36512022-04-24 09:07:44 +00009633 }
9634
9635 /* Length of supported_signature_algorithms */
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00009636 supported_sig_alg_len = (size_t) (p - supported_sig_alg);
Gilles Peskine449bd832023-01-11 14:50:10 +01009637 if (supported_sig_alg_len == 0) {
9638 MBEDTLS_SSL_DEBUG_MSG(1, ("No signature algorithms defined."));
9639 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
XiaokangQianeaf36512022-04-24 09:07:44 +00009640 }
9641
Gilles Peskine449bd832023-01-11 14:50:10 +01009642 MBEDTLS_PUT_UINT16_BE(MBEDTLS_TLS_EXT_SIG_ALG, buf, 0);
9643 MBEDTLS_PUT_UINT16_BE(supported_sig_alg_len + 2, buf, 2);
9644 MBEDTLS_PUT_UINT16_BE(supported_sig_alg_len, buf, 4);
XiaokangQianeaf36512022-04-24 09:07:44 +00009645
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00009646 *out_len = (size_t) (p - buf);
XiaokangQianeaf36512022-04-24 09:07:44 +00009647
9648#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01009649 mbedtls_ssl_tls13_set_hs_sent_ext_mask(ssl, MBEDTLS_TLS_EXT_SIG_ALG);
XiaokangQianeaf36512022-04-24 09:07:44 +00009650#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yu0c354a22022-08-29 15:25:36 +08009651
Gilles Peskine449bd832023-01-11 14:50:10 +01009652 return 0;
XiaokangQianeaf36512022-04-24 09:07:44 +00009653}
Ronald Crone68ab4f2022-10-05 12:46:29 +02009654#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
XiaokangQianeaf36512022-04-24 09:07:44 +00009655
XiaokangQian40a35232022-05-07 09:02:40 +00009656#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
XiaokangQian9b2b7712022-05-17 02:57:00 +00009657/*
9658 * mbedtls_ssl_parse_server_name_ext
9659 *
9660 * Structure of server_name extension:
9661 *
9662 * enum {
9663 * host_name(0), (255)
9664 * } NameType;
9665 * opaque HostName<1..2^16-1>;
9666 *
9667 * struct {
9668 * NameType name_type;
9669 * select (name_type) {
9670 * case host_name: HostName;
9671 * } name;
9672 * } ServerName;
9673 * struct {
9674 * ServerName server_name_list<1..2^16-1>
9675 * } ServerNameList;
9676 */
Ronald Cronce7d76e2022-07-08 18:56:49 +02009677MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01009678int mbedtls_ssl_parse_server_name_ext(mbedtls_ssl_context *ssl,
9679 const unsigned char *buf,
9680 const unsigned char *end)
XiaokangQian40a35232022-05-07 09:02:40 +00009681{
9682 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
9683 const unsigned char *p = buf;
XiaokangQian9b2b7712022-05-17 02:57:00 +00009684 size_t server_name_list_len, hostname_len;
9685 const unsigned char *server_name_list_end;
XiaokangQian40a35232022-05-07 09:02:40 +00009686
Gilles Peskine449bd832023-01-11 14:50:10 +01009687 MBEDTLS_SSL_DEBUG_MSG(3, ("parse ServerName extension"));
XiaokangQian40a35232022-05-07 09:02:40 +00009688
Gilles Peskine449bd832023-01-11 14:50:10 +01009689 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
9690 server_name_list_len = MBEDTLS_GET_UINT16_BE(p, 0);
XiaokangQian40a35232022-05-07 09:02:40 +00009691 p += 2;
9692
Gilles Peskine449bd832023-01-11 14:50:10 +01009693 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, server_name_list_len);
XiaokangQian9b2b7712022-05-17 02:57:00 +00009694 server_name_list_end = p + server_name_list_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01009695 while (p < server_name_list_end) {
9696 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, server_name_list_end, 3);
9697 hostname_len = MBEDTLS_GET_UINT16_BE(p, 1);
9698 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, server_name_list_end,
9699 hostname_len + 3);
XiaokangQian40a35232022-05-07 09:02:40 +00009700
Gilles Peskine449bd832023-01-11 14:50:10 +01009701 if (p[0] == MBEDTLS_TLS_EXT_SERVERNAME_HOSTNAME) {
XiaokangQian75fe8c72022-06-15 09:42:45 +00009702 /* sni_name is intended to be used only during the parsing of the
9703 * ClientHello message (it is reset to NULL before the end of
9704 * the message parsing). Thus it is ok to just point to the
9705 * reception buffer and not make a copy of it.
9706 */
XiaokangQianf2a94202022-05-20 06:44:24 +00009707 ssl->handshake->sni_name = p + 3;
9708 ssl->handshake->sni_name_len = hostname_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01009709 if (ssl->conf->f_sni == NULL) {
9710 return 0;
XiaokangQian40a35232022-05-07 09:02:40 +00009711 }
Gilles Peskine449bd832023-01-11 14:50:10 +01009712 ret = ssl->conf->f_sni(ssl->conf->p_sni,
9713 ssl, p + 3, hostname_len);
9714 if (ret != 0) {
9715 MBEDTLS_SSL_DEBUG_RET(1, "ssl_sni_wrapper", ret);
9716 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_UNRECOGNIZED_NAME,
9717 MBEDTLS_ERR_SSL_UNRECOGNIZED_NAME);
9718 return MBEDTLS_ERR_SSL_UNRECOGNIZED_NAME;
9719 }
9720 return 0;
XiaokangQian40a35232022-05-07 09:02:40 +00009721 }
9722
9723 p += hostname_len + 3;
9724 }
9725
Gilles Peskine449bd832023-01-11 14:50:10 +01009726 return 0;
XiaokangQian40a35232022-05-07 09:02:40 +00009727}
9728#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
9729
XiaokangQianacb39922022-06-17 10:18:48 +00009730#if defined(MBEDTLS_SSL_ALPN)
Ronald Cronce7d76e2022-07-08 18:56:49 +02009731MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01009732int mbedtls_ssl_parse_alpn_ext(mbedtls_ssl_context *ssl,
9733 const unsigned char *buf,
9734 const unsigned char *end)
XiaokangQianacb39922022-06-17 10:18:48 +00009735{
9736 const unsigned char *p = buf;
XiaokangQianc7403452022-06-23 03:24:12 +00009737 size_t protocol_name_list_len;
XiaokangQian95d5f542022-06-24 02:29:26 +00009738 const unsigned char *protocol_name_list;
9739 const unsigned char *protocol_name_list_end;
XiaokangQianc7403452022-06-23 03:24:12 +00009740 size_t protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00009741
9742 /* If ALPN not configured, just ignore the extension */
Gilles Peskine449bd832023-01-11 14:50:10 +01009743 if (ssl->conf->alpn_list == NULL) {
9744 return 0;
9745 }
XiaokangQianacb39922022-06-17 10:18:48 +00009746
9747 /*
XiaokangQianc7403452022-06-23 03:24:12 +00009748 * RFC7301, section 3.1
9749 * opaque ProtocolName<1..2^8-1>;
XiaokangQianacb39922022-06-17 10:18:48 +00009750 *
XiaokangQianc7403452022-06-23 03:24:12 +00009751 * struct {
9752 * ProtocolName protocol_name_list<2..2^16-1>
9753 * } ProtocolNameList;
XiaokangQianacb39922022-06-17 10:18:48 +00009754 */
9755
XiaokangQianc7403452022-06-23 03:24:12 +00009756 /*
XiaokangQian0b776e22022-06-24 09:04:59 +00009757 * protocol_name_list_len 2 bytes
9758 * protocol_name_len 1 bytes
9759 * protocol_name >=1 byte
XiaokangQianc7403452022-06-23 03:24:12 +00009760 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009761 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 4);
XiaokangQianacb39922022-06-17 10:18:48 +00009762
Gilles Peskine449bd832023-01-11 14:50:10 +01009763 protocol_name_list_len = MBEDTLS_GET_UINT16_BE(p, 0);
XiaokangQianacb39922022-06-17 10:18:48 +00009764 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01009765 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, protocol_name_list_len);
XiaokangQian95d5f542022-06-24 02:29:26 +00009766 protocol_name_list = p;
9767 protocol_name_list_end = p + protocol_name_list_len;
XiaokangQianacb39922022-06-17 10:18:48 +00009768
9769 /* Validate peer's list (lengths) */
Gilles Peskine449bd832023-01-11 14:50:10 +01009770 while (p < protocol_name_list_end) {
XiaokangQian95d5f542022-06-24 02:29:26 +00009771 protocol_name_len = *p++;
Gilles Peskine449bd832023-01-11 14:50:10 +01009772 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, protocol_name_list_end,
9773 protocol_name_len);
9774 if (protocol_name_len == 0) {
XiaokangQian95d5f542022-06-24 02:29:26 +00009775 MBEDTLS_SSL_PEND_FATAL_ALERT(
9776 MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
Gilles Peskine449bd832023-01-11 14:50:10 +01009777 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
9778 return MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
XiaokangQian95d5f542022-06-24 02:29:26 +00009779 }
9780
9781 p += protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00009782 }
9783
9784 /* Use our order of preference */
Gilles Peskine449bd832023-01-11 14:50:10 +01009785 for (const char **alpn = ssl->conf->alpn_list; *alpn != NULL; alpn++) {
9786 size_t const alpn_len = strlen(*alpn);
XiaokangQian95d5f542022-06-24 02:29:26 +00009787 p = protocol_name_list;
Gilles Peskine449bd832023-01-11 14:50:10 +01009788 while (p < protocol_name_list_end) {
XiaokangQian95d5f542022-06-24 02:29:26 +00009789 protocol_name_len = *p++;
Gilles Peskine449bd832023-01-11 14:50:10 +01009790 if (protocol_name_len == alpn_len &&
9791 memcmp(p, *alpn, alpn_len) == 0) {
XiaokangQianacb39922022-06-17 10:18:48 +00009792 ssl->alpn_chosen = *alpn;
Gilles Peskine449bd832023-01-11 14:50:10 +01009793 return 0;
XiaokangQianacb39922022-06-17 10:18:48 +00009794 }
XiaokangQian95d5f542022-06-24 02:29:26 +00009795
9796 p += protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00009797 }
9798 }
9799
XiaokangQian95d5f542022-06-24 02:29:26 +00009800 /* If we get here, no match was found */
XiaokangQianacb39922022-06-17 10:18:48 +00009801 MBEDTLS_SSL_PEND_FATAL_ALERT(
Gilles Peskine449bd832023-01-11 14:50:10 +01009802 MBEDTLS_SSL_ALERT_MSG_NO_APPLICATION_PROTOCOL,
9803 MBEDTLS_ERR_SSL_NO_APPLICATION_PROTOCOL);
9804 return MBEDTLS_ERR_SSL_NO_APPLICATION_PROTOCOL;
XiaokangQianacb39922022-06-17 10:18:48 +00009805}
9806
Gilles Peskine449bd832023-01-11 14:50:10 +01009807int mbedtls_ssl_write_alpn_ext(mbedtls_ssl_context *ssl,
9808 unsigned char *buf,
9809 unsigned char *end,
9810 size_t *out_len)
XiaokangQianacb39922022-06-17 10:18:48 +00009811{
9812 unsigned char *p = buf;
XiaokangQian95d5f542022-06-24 02:29:26 +00009813 size_t protocol_name_len;
XiaokangQianc7403452022-06-23 03:24:12 +00009814 *out_len = 0;
XiaokangQianacb39922022-06-17 10:18:48 +00009815
Gilles Peskine449bd832023-01-11 14:50:10 +01009816 if (ssl->alpn_chosen == NULL) {
9817 return 0;
XiaokangQianacb39922022-06-17 10:18:48 +00009818 }
9819
Gilles Peskine449bd832023-01-11 14:50:10 +01009820 protocol_name_len = strlen(ssl->alpn_chosen);
9821 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 7 + protocol_name_len);
XiaokangQianacb39922022-06-17 10:18:48 +00009822
Gilles Peskine449bd832023-01-11 14:50:10 +01009823 MBEDTLS_SSL_DEBUG_MSG(3, ("server side, adding alpn extension"));
XiaokangQianacb39922022-06-17 10:18:48 +00009824 /*
9825 * 0 . 1 ext identifier
9826 * 2 . 3 ext length
9827 * 4 . 5 protocol list length
9828 * 6 . 6 protocol name length
9829 * 7 . 7+n protocol name
9830 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009831 MBEDTLS_PUT_UINT16_BE(MBEDTLS_TLS_EXT_ALPN, p, 0);
XiaokangQianacb39922022-06-17 10:18:48 +00009832
XiaokangQian95d5f542022-06-24 02:29:26 +00009833 *out_len = 7 + protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00009834
Gilles Peskine449bd832023-01-11 14:50:10 +01009835 MBEDTLS_PUT_UINT16_BE(protocol_name_len + 3, p, 2);
9836 MBEDTLS_PUT_UINT16_BE(protocol_name_len + 1, p, 4);
XiaokangQian0b776e22022-06-24 09:04:59 +00009837 /* Note: the length of the chosen protocol has been checked to be less
9838 * than 255 bytes in `mbedtls_ssl_conf_alpn_protocols`.
9839 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009840 p[6] = MBEDTLS_BYTE_0(protocol_name_len);
XiaokangQianacb39922022-06-17 10:18:48 +00009841
Gilles Peskine449bd832023-01-11 14:50:10 +01009842 memcpy(p + 7, ssl->alpn_chosen, protocol_name_len);
Jerry Yub95dd362022-11-08 21:19:34 +08009843
9844#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01009845 mbedtls_ssl_tls13_set_hs_sent_ext_mask(ssl, MBEDTLS_TLS_EXT_ALPN);
Jerry Yub95dd362022-11-08 21:19:34 +08009846#endif
9847
Gilles Peskine449bd832023-01-11 14:50:10 +01009848 return 0;
XiaokangQianacb39922022-06-17 10:18:48 +00009849}
9850#endif /* MBEDTLS_SSL_ALPN */
9851
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009852#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && \
Xiaokang Qian03409292022-10-12 02:49:52 +00009853 defined(MBEDTLS_SSL_SESSION_TICKETS) && \
Xiaokang Qianed0620c2022-10-12 06:58:13 +00009854 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION) && \
Xiaokang Qianed3afcd2022-10-12 08:31:11 +00009855 defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01009856int mbedtls_ssl_session_set_hostname(mbedtls_ssl_session *session,
9857 const char *hostname)
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009858{
9859 /* Initialize to suppress unnecessary compiler warning */
9860 size_t hostname_len = 0;
9861
9862 /* Check if new hostname is valid before
9863 * making any change to current one */
Gilles Peskine449bd832023-01-11 14:50:10 +01009864 if (hostname != NULL) {
9865 hostname_len = strlen(hostname);
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009866
Gilles Peskine449bd832023-01-11 14:50:10 +01009867 if (hostname_len > MBEDTLS_SSL_MAX_HOST_NAME_LEN) {
9868 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9869 }
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009870 }
9871
9872 /* Now it's clear that we will overwrite the old hostname,
9873 * so we can free it safely */
Gilles Peskine449bd832023-01-11 14:50:10 +01009874 if (session->hostname != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01009875 mbedtls_zeroize_and_free(session->hostname,
Gilles Peskine449bd832023-01-11 14:50:10 +01009876 strlen(session->hostname));
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009877 }
9878
9879 /* Passing NULL as hostname shall clear the old one */
Gilles Peskine449bd832023-01-11 14:50:10 +01009880 if (hostname == NULL) {
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009881 session->hostname = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01009882 } else {
9883 session->hostname = mbedtls_calloc(1, hostname_len + 1);
9884 if (session->hostname == NULL) {
9885 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
9886 }
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009887
Gilles Peskine449bd832023-01-11 14:50:10 +01009888 memcpy(session->hostname, hostname, hostname_len);
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009889 }
9890
Gilles Peskine449bd832023-01-11 14:50:10 +01009891 return 0;
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009892}
Xiaokang Qian03409292022-10-12 02:49:52 +00009893#endif /* MBEDTLS_SSL_PROTO_TLS1_3 &&
9894 MBEDTLS_SSL_SESSION_TICKETS &&
Xiaokang Qianed0620c2022-10-12 06:58:13 +00009895 MBEDTLS_SSL_SERVER_NAME_INDICATION &&
Xiaokang Qianed3afcd2022-10-12 08:31:11 +00009896 MBEDTLS_SSL_CLI_C */
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009897
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00009898#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_EARLY_DATA) && \
9899 defined(MBEDTLS_SSL_ALPN)
Waleed Elmelegy7dfba342024-03-12 16:22:39 +00009900int mbedtls_ssl_session_set_ticket_alpn(mbedtls_ssl_session *session,
9901 const char *alpn)
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00009902{
9903 size_t alpn_len = 0;
9904
9905 if (alpn != NULL) {
9906 alpn_len = strlen(alpn);
9907
9908 if (alpn_len > MBEDTLS_SSL_MAX_ALPN_NAME_LEN) {
9909 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9910 }
9911 }
9912
9913 if (session->ticket_alpn != NULL) {
9914 mbedtls_zeroize_and_free(session->ticket_alpn,
9915 strlen(session->ticket_alpn));
Waleed Elmelegy7dfba342024-03-12 16:22:39 +00009916 session->ticket_alpn = NULL;
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00009917 }
9918
Waleed Elmelegy7dfba342024-03-12 16:22:39 +00009919 if (alpn != NULL) {
9920 session->ticket_alpn = mbedtls_calloc(alpn_len + 1, 1);
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00009921 if (session->ticket_alpn == NULL) {
9922 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
9923 }
Waleed Elmelegy7dfba342024-03-12 16:22:39 +00009924 memcpy(session->ticket_alpn, alpn, alpn_len);
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00009925 }
9926
9927 return 0;
9928}
9929#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_EARLY_DATA && MBEDTLS_SSL_ALPN */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02009930#endif /* MBEDTLS_SSL_TLS_C */