blob: ac53853a5beb5205f0a8c36a613c6e8fc8641582 [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) {
Jerry Yu21092062022-10-10 21:21:31 +08001762 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
Gilles Peskine449bd832023-01-11 14:50:10 +01001763 mbedtls_ssl_ciphersuite_from_id(session->ciphersuite);
Jerry Yu21092062022-10-10 21:21:31 +08001764
Gilles Peskine449bd832023-01-11 14:50:10 +01001765 if (mbedtls_ssl_validate_ciphersuite(
Jerry Yu21092062022-10-10 21:21:31 +08001766 ssl, ciphersuite_info, MBEDTLS_SSL_VERSION_TLS1_3,
Gilles Peskine449bd832023-01-11 14:50:10 +01001767 MBEDTLS_SSL_VERSION_TLS1_3) != 0) {
1768 MBEDTLS_SSL_DEBUG_MSG(4, ("%d is not a valid TLS 1.3 ciphersuite.",
1769 session->ciphersuite));
1770 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jerry Yu21092062022-10-10 21:21:31 +08001771 }
Jerry Yu40afab62022-10-08 10:42:13 +08001772 }
Jerry Yu21092062022-10-10 21:21:31 +08001773#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yu40afab62022-10-08 10:42:13 +08001774
Gilles Peskine449bd832023-01-11 14:50:10 +01001775 if ((ret = mbedtls_ssl_session_copy(ssl->session_negotiate,
1776 session)) != 0) {
1777 return ret;
1778 }
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001779
Paul Bakker0a597072012-09-25 21:55:46 +00001780 ssl->handshake->resume = 1;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001781
Gilles Peskine449bd832023-01-11 14:50:10 +01001782 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00001783}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001784#endif /* MBEDTLS_SSL_CLI_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00001785
Gilles Peskine449bd832023-01-11 14:50:10 +01001786void mbedtls_ssl_conf_ciphersuites(mbedtls_ssl_config *conf,
1787 const int *ciphersuites)
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001788{
Hanno Beckerd60b6c62021-04-29 12:04:11 +01001789 conf->ciphersuite_list = ciphersuites;
Paul Bakker5121ce52009-01-03 21:22:43 +00001790}
1791
Ronald Cron6f135e12021-12-08 16:57:54 +01001792#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01001793void mbedtls_ssl_conf_tls13_key_exchange_modes(mbedtls_ssl_config *conf,
1794 const int kex_modes)
Hanno Becker71f1ed62021-07-24 06:01:47 +01001795{
Xiaofei Bai746f9482021-11-12 08:53:56 +00001796 conf->tls13_kex_modes = kex_modes & MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_ALL;
Hanno Becker71f1ed62021-07-24 06:01:47 +01001797}
Xiaokang Qian72de95d2022-10-25 02:54:33 +00001798
1799#if defined(MBEDTLS_SSL_EARLY_DATA)
Yanray Wangd5ed36f2023-11-07 11:40:43 +08001800void mbedtls_ssl_conf_early_data(mbedtls_ssl_config *conf,
1801 int early_data_enabled)
Xiaokang Qian72de95d2022-10-25 02:54:33 +00001802{
1803 conf->early_data_enabled = early_data_enabled;
1804}
Jerry Yucc4e0072022-11-22 17:22:22 +08001805
1806#if defined(MBEDTLS_SSL_SRV_C)
Yanray Wang07517612023-11-07 11:47:36 +08001807void mbedtls_ssl_conf_max_early_data_size(
Gilles Peskine449bd832023-01-11 14:50:10 +01001808 mbedtls_ssl_config *conf, uint32_t max_early_data_size)
Jerry Yucc4e0072022-11-22 17:22:22 +08001809{
Jerry Yu39da9852022-12-06 16:58:36 +08001810 conf->max_early_data_size = max_early_data_size;
Jerry Yucc4e0072022-11-22 17:22:22 +08001811}
1812#endif /* MBEDTLS_SSL_SRV_C */
1813
Xiaokang Qian72de95d2022-10-25 02:54:33 +00001814#endif /* MBEDTLS_SSL_EARLY_DATA */
Ronald Cron6f135e12021-12-08 16:57:54 +01001815#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker71f1ed62021-07-24 06:01:47 +01001816
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001817#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001818void mbedtls_ssl_conf_cert_profile(mbedtls_ssl_config *conf,
1819 const mbedtls_x509_crt_profile *profile)
Manuel Pégourié-Gonnard6e3ee3a2015-06-17 10:58:20 +02001820{
1821 conf->cert_profile = profile;
1822}
1823
Gilles Peskine449bd832023-01-11 14:50:10 +01001824static void ssl_key_cert_free(mbedtls_ssl_key_cert *key_cert)
Glenn Strauss36872db2022-01-22 05:06:31 -05001825{
1826 mbedtls_ssl_key_cert *cur = key_cert, *next;
1827
Gilles Peskine449bd832023-01-11 14:50:10 +01001828 while (cur != NULL) {
Glenn Strauss36872db2022-01-22 05:06:31 -05001829 next = cur->next;
Gilles Peskine449bd832023-01-11 14:50:10 +01001830 mbedtls_free(cur);
Glenn Strauss36872db2022-01-22 05:06:31 -05001831 cur = next;
1832 }
1833}
1834
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001835/* Append a new keycert entry to a (possibly empty) list */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001836MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001837static int ssl_append_key_cert(mbedtls_ssl_key_cert **head,
1838 mbedtls_x509_crt *cert,
1839 mbedtls_pk_context *key)
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001840{
niisato8ee24222018-06-25 19:05:48 +09001841 mbedtls_ssl_key_cert *new_cert;
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001842
Gilles Peskine449bd832023-01-11 14:50:10 +01001843 if (cert == NULL) {
Glenn Strauss36872db2022-01-22 05:06:31 -05001844 /* Free list if cert is null */
Gilles Peskine449bd832023-01-11 14:50:10 +01001845 ssl_key_cert_free(*head);
Glenn Strauss36872db2022-01-22 05:06:31 -05001846 *head = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01001847 return 0;
Glenn Strauss36872db2022-01-22 05:06:31 -05001848 }
1849
Gilles Peskine449bd832023-01-11 14:50:10 +01001850 new_cert = mbedtls_calloc(1, sizeof(mbedtls_ssl_key_cert));
1851 if (new_cert == NULL) {
1852 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
1853 }
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001854
niisato8ee24222018-06-25 19:05:48 +09001855 new_cert->cert = cert;
1856 new_cert->key = key;
1857 new_cert->next = NULL;
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001858
Glenn Strauss36872db2022-01-22 05:06:31 -05001859 /* Update head if the list was null, else add to the end */
Gilles Peskine449bd832023-01-11 14:50:10 +01001860 if (*head == NULL) {
niisato8ee24222018-06-25 19:05:48 +09001861 *head = new_cert;
Gilles Peskine449bd832023-01-11 14:50:10 +01001862 } else {
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001863 mbedtls_ssl_key_cert *cur = *head;
Gilles Peskine449bd832023-01-11 14:50:10 +01001864 while (cur->next != NULL) {
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001865 cur = cur->next;
Gilles Peskine449bd832023-01-11 14:50:10 +01001866 }
niisato8ee24222018-06-25 19:05:48 +09001867 cur->next = new_cert;
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001868 }
1869
Gilles Peskine449bd832023-01-11 14:50:10 +01001870 return 0;
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001871}
1872
Gilles Peskine449bd832023-01-11 14:50:10 +01001873int mbedtls_ssl_conf_own_cert(mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001874 mbedtls_x509_crt *own_cert,
Gilles Peskine449bd832023-01-11 14:50:10 +01001875 mbedtls_pk_context *pk_key)
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001876{
Gilles Peskine449bd832023-01-11 14:50:10 +01001877 return ssl_append_key_cert(&conf->key_cert, own_cert, pk_key);
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001878}
1879
Gilles Peskine449bd832023-01-11 14:50:10 +01001880void mbedtls_ssl_conf_ca_chain(mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01001881 mbedtls_x509_crt *ca_chain,
Gilles Peskine449bd832023-01-11 14:50:10 +01001882 mbedtls_x509_crl *ca_crl)
Paul Bakker5121ce52009-01-03 21:22:43 +00001883{
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01001884 conf->ca_chain = ca_chain;
1885 conf->ca_crl = ca_crl;
Hanno Becker5adaad92019-03-27 16:54:37 +00001886
1887#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
1888 /* mbedtls_ssl_conf_ca_chain() and mbedtls_ssl_conf_ca_cb()
1889 * cannot be used together. */
1890 conf->f_ca_cb = NULL;
1891 conf->p_ca_cb = NULL;
1892#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
Paul Bakker5121ce52009-01-03 21:22:43 +00001893}
Hanno Becker5adaad92019-03-27 16:54:37 +00001894
1895#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
Gilles Peskine449bd832023-01-11 14:50:10 +01001896void mbedtls_ssl_conf_ca_cb(mbedtls_ssl_config *conf,
1897 mbedtls_x509_crt_ca_cb_t f_ca_cb,
1898 void *p_ca_cb)
Hanno Becker5adaad92019-03-27 16:54:37 +00001899{
1900 conf->f_ca_cb = f_ca_cb;
1901 conf->p_ca_cb = p_ca_cb;
1902
1903 /* mbedtls_ssl_conf_ca_chain() and mbedtls_ssl_conf_ca_cb()
1904 * cannot be used together. */
1905 conf->ca_chain = NULL;
1906 conf->ca_crl = NULL;
1907}
1908#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001909#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkereb2c6582012-09-27 19:15:01 +00001910
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001911#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01001912const unsigned char *mbedtls_ssl_get_hs_sni(mbedtls_ssl_context *ssl,
1913 size_t *name_len)
Glenn Strauss69894072022-01-24 12:58:00 -05001914{
1915 *name_len = ssl->handshake->sni_name_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01001916 return ssl->handshake->sni_name;
Glenn Strauss69894072022-01-24 12:58:00 -05001917}
1918
Gilles Peskine449bd832023-01-11 14:50:10 +01001919int mbedtls_ssl_set_hs_own_cert(mbedtls_ssl_context *ssl,
1920 mbedtls_x509_crt *own_cert,
1921 mbedtls_pk_context *pk_key)
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001922{
Gilles Peskine449bd832023-01-11 14:50:10 +01001923 return ssl_append_key_cert(&ssl->handshake->sni_key_cert,
1924 own_cert, pk_key);
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001925}
Manuel Pégourié-Gonnard22bfa4b2015-05-11 08:46:37 +02001926
Gilles Peskine449bd832023-01-11 14:50:10 +01001927void mbedtls_ssl_set_hs_ca_chain(mbedtls_ssl_context *ssl,
1928 mbedtls_x509_crt *ca_chain,
1929 mbedtls_x509_crl *ca_crl)
Manuel Pégourié-Gonnard22bfa4b2015-05-11 08:46:37 +02001930{
1931 ssl->handshake->sni_ca_chain = ca_chain;
1932 ssl->handshake->sni_ca_crl = ca_crl;
1933}
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +02001934
Glenn Strauss999ef702022-03-11 01:37:23 -05001935#if defined(MBEDTLS_KEY_EXCHANGE_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01001936void mbedtls_ssl_set_hs_dn_hints(mbedtls_ssl_context *ssl,
1937 const mbedtls_x509_crt *crt)
Glenn Strauss999ef702022-03-11 01:37:23 -05001938{
1939 ssl->handshake->dn_hints = crt;
1940}
1941#endif /* MBEDTLS_KEY_EXCHANGE_CERT_REQ_ALLOWED_ENABLED */
1942
Gilles Peskine449bd832023-01-11 14:50:10 +01001943void mbedtls_ssl_set_hs_authmode(mbedtls_ssl_context *ssl,
1944 int authmode)
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +02001945{
1946 ssl->handshake->sni_authmode = authmode;
1947}
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001948#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
1949
Hanno Becker8927c832019-04-03 12:52:50 +01001950#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001951void mbedtls_ssl_set_verify(mbedtls_ssl_context *ssl,
1952 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *),
1953 void *p_vrfy)
Hanno Becker8927c832019-04-03 12:52:50 +01001954{
1955 ssl->f_vrfy = f_vrfy;
1956 ssl->p_vrfy = p_vrfy;
1957}
1958#endif
1959
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02001960#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02001961
Valerio Setti016f6822022-12-09 14:17:50 +01001962#if defined(MBEDTLS_USE_PSA_CRYPTO)
Przemek Stekielfde11282023-03-13 16:06:09 +01001963static const uint8_t jpake_server_id[] = { 's', 'e', 'r', 'v', 'e', 'r' };
1964static const uint8_t jpake_client_id[] = { 'c', 'l', 'i', 'e', 'n', 't' };
1965
Valerio Setti016f6822022-12-09 14:17:50 +01001966static psa_status_t mbedtls_ssl_set_hs_ecjpake_password_common(
Gilles Peskine449bd832023-01-11 14:50:10 +01001967 mbedtls_ssl_context *ssl,
1968 mbedtls_svc_key_id_t pwd)
Valerio Setti016f6822022-12-09 14:17:50 +01001969{
1970 psa_status_t status;
Valerio Setti016f6822022-12-09 14:17:50 +01001971 psa_pake_cipher_suite_t cipher_suite = psa_pake_cipher_suite_init();
Przemek Stekielfde11282023-03-13 16:06:09 +01001972 const uint8_t *user = NULL;
Przemek Stekiel4cd20312023-03-01 11:11:28 +01001973 size_t user_len = 0;
Przemek Stekielfde11282023-03-13 16:06:09 +01001974 const uint8_t *peer = NULL;
Przemek Stekiel4cd20312023-03-01 11:11:28 +01001975 size_t peer_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01001976 psa_pake_cs_set_algorithm(&cipher_suite, PSA_ALG_JPAKE);
1977 psa_pake_cs_set_primitive(&cipher_suite,
1978 PSA_PAKE_PRIMITIVE(PSA_PAKE_PRIMITIVE_TYPE_ECC,
1979 PSA_ECC_FAMILY_SECP_R1,
1980 256));
1981 psa_pake_cs_set_hash(&cipher_suite, PSA_ALG_SHA_256);
Valerio Setti016f6822022-12-09 14:17:50 +01001982
Gilles Peskine449bd832023-01-11 14:50:10 +01001983 status = psa_pake_setup(&ssl->handshake->psa_pake_ctx, &cipher_suite);
1984 if (status != PSA_SUCCESS) {
Valerio Setti016f6822022-12-09 14:17:50 +01001985 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001986 }
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02001987
Gilles Peskine449bd832023-01-11 14:50:10 +01001988 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Przemek Stekielfde11282023-03-13 16:06:09 +01001989 user = jpake_server_id;
1990 user_len = sizeof(jpake_server_id);
1991 peer = jpake_client_id;
1992 peer_len = sizeof(jpake_client_id);
Gilles Peskine449bd832023-01-11 14:50:10 +01001993 } else {
Przemek Stekielfde11282023-03-13 16:06:09 +01001994 user = jpake_client_id;
1995 user_len = sizeof(jpake_client_id);
1996 peer = jpake_server_id;
1997 peer_len = sizeof(jpake_server_id);
Gilles Peskine449bd832023-01-11 14:50:10 +01001998 }
Neil Armstrongca7d5062022-05-31 14:43:23 +02001999
Przemek Stekiel4cd20312023-03-01 11:11:28 +01002000 status = psa_pake_set_user(&ssl->handshake->psa_pake_ctx, user, user_len);
2001 if (status != PSA_SUCCESS) {
2002 return status;
2003 }
2004
2005 status = psa_pake_set_peer(&ssl->handshake->psa_pake_ctx, peer, peer_len);
Gilles Peskine449bd832023-01-11 14:50:10 +01002006 if (status != PSA_SUCCESS) {
Valerio Setti016f6822022-12-09 14:17:50 +01002007 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01002008 }
Valerio Setti016f6822022-12-09 14:17:50 +01002009
Gilles Peskine449bd832023-01-11 14:50:10 +01002010 status = psa_pake_set_password_key(&ssl->handshake->psa_pake_ctx, pwd);
2011 if (status != PSA_SUCCESS) {
Valerio Setti016f6822022-12-09 14:17:50 +01002012 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01002013 }
Valerio Setti016f6822022-12-09 14:17:50 +01002014
2015 ssl->handshake->psa_pake_ctx_is_ok = 1;
2016
Gilles Peskine449bd832023-01-11 14:50:10 +01002017 return PSA_SUCCESS;
Valerio Setti016f6822022-12-09 14:17:50 +01002018}
2019
Gilles Peskine449bd832023-01-11 14:50:10 +01002020int mbedtls_ssl_set_hs_ecjpake_password(mbedtls_ssl_context *ssl,
2021 const unsigned char *pw,
2022 size_t pw_len)
Valerio Setti016f6822022-12-09 14:17:50 +01002023{
2024 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
2025 psa_status_t status;
2026
Gilles Peskine449bd832023-01-11 14:50:10 +01002027 if (ssl->handshake == NULL || ssl->conf == NULL) {
2028 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Neil Armstrongca7d5062022-05-31 14:43:23 +02002029 }
2030
Gilles Peskine449bd832023-01-11 14:50:10 +01002031 /* Empty password is not valid */
2032 if ((pw == NULL) || (pw_len == 0)) {
2033 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2034 }
2035
2036 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_DERIVE);
2037 psa_set_key_algorithm(&attributes, PSA_ALG_JPAKE);
2038 psa_set_key_type(&attributes, PSA_KEY_TYPE_PASSWORD);
2039
2040 status = psa_import_key(&attributes, pw, pw_len,
2041 &ssl->handshake->psa_pake_password);
2042 if (status != PSA_SUCCESS) {
2043 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
2044 }
2045
2046 status = mbedtls_ssl_set_hs_ecjpake_password_common(ssl,
2047 ssl->handshake->psa_pake_password);
2048 if (status != PSA_SUCCESS) {
2049 psa_destroy_key(ssl->handshake->psa_pake_password);
2050 psa_pake_abort(&ssl->handshake->psa_pake_ctx);
2051 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
2052 }
2053
2054 return 0;
Valerio Setti02c25b52022-11-15 14:08:42 +01002055}
Valerio Settia9a97dc2022-11-28 18:26:16 +01002056
Gilles Peskine449bd832023-01-11 14:50:10 +01002057int mbedtls_ssl_set_hs_ecjpake_password_opaque(mbedtls_ssl_context *ssl,
2058 mbedtls_svc_key_id_t pwd)
Valerio Settia9a97dc2022-11-28 18:26:16 +01002059{
Valerio Settia9a97dc2022-11-28 18:26:16 +01002060 psa_status_t status;
2061
Gilles Peskine449bd832023-01-11 14:50:10 +01002062 if (ssl->handshake == NULL || ssl->conf == NULL) {
2063 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Neil Armstrongca7d5062022-05-31 14:43:23 +02002064 }
2065
Gilles Peskine449bd832023-01-11 14:50:10 +01002066 if (mbedtls_svc_key_id_is_null(pwd)) {
2067 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2068 }
2069
2070 status = mbedtls_ssl_set_hs_ecjpake_password_common(ssl, pwd);
2071 if (status != PSA_SUCCESS) {
2072 psa_pake_abort(&ssl->handshake->psa_pake_ctx);
2073 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
2074 }
2075
2076 return 0;
Valerio Setti02c25b52022-11-15 14:08:42 +01002077}
2078#else /* MBEDTLS_USE_PSA_CRYPTO */
Gilles Peskine449bd832023-01-11 14:50:10 +01002079int mbedtls_ssl_set_hs_ecjpake_password(mbedtls_ssl_context *ssl,
2080 const unsigned char *pw,
2081 size_t pw_len)
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002082{
2083 mbedtls_ecjpake_role role;
2084
Gilles Peskine449bd832023-01-11 14:50:10 +01002085 if (ssl->handshake == NULL || ssl->conf == NULL) {
2086 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2087 }
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002088
Valerio Settic689ed82022-12-07 14:40:38 +01002089 /* Empty password is not valid */
Gilles Peskine449bd832023-01-11 14:50:10 +01002090 if ((pw == NULL) || (pw_len == 0)) {
2091 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2092 }
Valerio Settic689ed82022-12-07 14:40:38 +01002093
Gilles Peskine449bd832023-01-11 14:50:10 +01002094 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002095 role = MBEDTLS_ECJPAKE_SERVER;
Gilles Peskine449bd832023-01-11 14:50:10 +01002096 } else {
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002097 role = MBEDTLS_ECJPAKE_CLIENT;
Gilles Peskine449bd832023-01-11 14:50:10 +01002098 }
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002099
Gilles Peskine449bd832023-01-11 14:50:10 +01002100 return mbedtls_ecjpake_setup(&ssl->handshake->ecjpake_ctx,
2101 role,
2102 MBEDTLS_MD_SHA256,
2103 MBEDTLS_ECP_DP_SECP256R1,
2104 pw, pw_len);
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002105}
Valerio Setti02c25b52022-11-15 14:08:42 +01002106#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02002107#endif /* MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED */
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002108
Ronald Cron73fe8df2022-10-05 14:31:43 +02002109#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01002110int mbedtls_ssl_conf_has_static_psk(mbedtls_ssl_config const *conf)
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002111{
Gilles Peskine449bd832023-01-11 14:50:10 +01002112 if (conf->psk_identity == NULL ||
2113 conf->psk_identity_len == 0) {
2114 return 0;
Ronald Crond29e13e2022-10-19 10:33:48 +02002115 }
2116
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002117#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01002118 if (!mbedtls_svc_key_id_is_null(conf->psk_opaque)) {
2119 return 1;
2120 }
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002121#endif /* MBEDTLS_USE_PSA_CRYPTO */
Ronald Crond29e13e2022-10-19 10:33:48 +02002122
Gilles Peskine449bd832023-01-11 14:50:10 +01002123 if (conf->psk != NULL && conf->psk_len != 0) {
2124 return 1;
2125 }
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002126
Gilles Peskine449bd832023-01-11 14:50:10 +01002127 return 0;
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002128}
2129
Gilles Peskine449bd832023-01-11 14:50:10 +01002130static void ssl_conf_remove_psk(mbedtls_ssl_config *conf)
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002131{
2132 /* Remove reference to existing PSK, if any. */
2133#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01002134 if (!mbedtls_svc_key_id_is_null(conf->psk_opaque)) {
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002135 /* The maintenance of the PSK key slot is the
2136 * user's responsibility. */
Ronald Croncf56a0a2020-08-04 09:51:30 +02002137 conf->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002138 }
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002139#endif /* MBEDTLS_USE_PSA_CRYPTO */
Gilles Peskine449bd832023-01-11 14:50:10 +01002140 if (conf->psk != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01002141 mbedtls_zeroize_and_free(conf->psk, conf->psk_len);
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002142 conf->psk = NULL;
2143 conf->psk_len = 0;
2144 }
2145
2146 /* Remove reference to PSK identity, if any. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002147 if (conf->psk_identity != NULL) {
2148 mbedtls_free(conf->psk_identity);
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002149 conf->psk_identity = NULL;
2150 conf->psk_identity_len = 0;
2151 }
2152}
2153
Hanno Becker7390c712018-11-15 13:33:04 +00002154/* This function assumes that PSK identity in the SSL config is unset.
2155 * It checks that the provided identity is well-formed and attempts
2156 * to make a copy of it in the SSL config.
2157 * On failure, the PSK identity in the config remains unset. */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002158MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002159static int ssl_conf_set_psk_identity(mbedtls_ssl_config *conf,
2160 unsigned char const *psk_identity,
2161 size_t psk_identity_len)
Paul Bakkerd4a56ec2013-04-16 18:05:29 +02002162{
Manuel Pégourié-Gonnardc6b5d832015-08-27 16:37:35 +02002163 /* Identity len will be encoded on two bytes */
Gilles Peskine449bd832023-01-11 14:50:10 +01002164 if (psk_identity == NULL ||
Ronald Cron2a87e9b2022-10-19 10:55:26 +02002165 psk_identity_len == 0 ||
Gilles Peskine449bd832023-01-11 14:50:10 +01002166 (psk_identity_len >> 16) != 0 ||
2167 psk_identity_len > MBEDTLS_SSL_OUT_CONTENT_LEN) {
2168 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnardc6b5d832015-08-27 16:37:35 +02002169 }
2170
Gilles Peskine449bd832023-01-11 14:50:10 +01002171 conf->psk_identity = mbedtls_calloc(1, psk_identity_len);
2172 if (conf->psk_identity == NULL) {
2173 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
2174 }
Paul Bakker6db455e2013-09-18 17:29:31 +02002175
Manuel Pégourié-Gonnard120fdbd2015-05-07 17:07:50 +01002176 conf->psk_identity_len = psk_identity_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01002177 memcpy(conf->psk_identity, psk_identity, conf->psk_identity_len);
Paul Bakker5ad403f2013-09-18 21:21:30 +02002178
Gilles Peskine449bd832023-01-11 14:50:10 +01002179 return 0;
Paul Bakker6db455e2013-09-18 17:29:31 +02002180}
2181
Gilles Peskine449bd832023-01-11 14:50:10 +01002182int mbedtls_ssl_conf_psk(mbedtls_ssl_config *conf,
2183 const unsigned char *psk, size_t psk_len,
2184 const unsigned char *psk_identity, size_t psk_identity_len)
Hanno Becker7390c712018-11-15 13:33:04 +00002185{
Janos Follath865b3eb2019-12-16 11:46:15 +00002186 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002187
2188 /* We currently only support one PSK, raw or opaque. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002189 if (mbedtls_ssl_conf_has_static_psk(conf)) {
2190 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
2191 }
Hanno Becker7390c712018-11-15 13:33:04 +00002192
2193 /* Check and set raw PSK */
Gilles Peskine449bd832023-01-11 14:50:10 +01002194 if (psk == NULL) {
2195 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2196 }
2197 if (psk_len == 0) {
2198 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2199 }
2200 if (psk_len > MBEDTLS_PSK_MAX_LEN) {
2201 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2202 }
Piotr Nowicki9926eaf2019-11-20 14:54:36 +01002203
Gilles Peskine449bd832023-01-11 14:50:10 +01002204 if ((conf->psk = mbedtls_calloc(1, psk_len)) == NULL) {
2205 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
2206 }
Hanno Becker7390c712018-11-15 13:33:04 +00002207 conf->psk_len = psk_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01002208 memcpy(conf->psk, psk, conf->psk_len);
Hanno Becker7390c712018-11-15 13:33:04 +00002209
2210 /* Check and set PSK Identity */
Gilles Peskine449bd832023-01-11 14:50:10 +01002211 ret = ssl_conf_set_psk_identity(conf, psk_identity, psk_identity_len);
2212 if (ret != 0) {
2213 ssl_conf_remove_psk(conf);
2214 }
Hanno Becker7390c712018-11-15 13:33:04 +00002215
Gilles Peskine449bd832023-01-11 14:50:10 +01002216 return ret;
Hanno Becker7390c712018-11-15 13:33:04 +00002217}
2218
Gilles Peskine449bd832023-01-11 14:50:10 +01002219static void ssl_remove_psk(mbedtls_ssl_context *ssl)
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002220{
2221#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01002222 if (!mbedtls_svc_key_id_is_null(ssl->handshake->psk_opaque)) {
Neil Armstrong501c9322022-05-03 09:35:09 +02002223 /* The maintenance of the external PSK key slot is the
2224 * user's responsibility. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002225 if (ssl->handshake->psk_opaque_is_internal) {
2226 psa_destroy_key(ssl->handshake->psk_opaque);
Neil Armstrong501c9322022-05-03 09:35:09 +02002227 ssl->handshake->psk_opaque_is_internal = 0;
2228 }
Ronald Croncf56a0a2020-08-04 09:51:30 +02002229 ssl->handshake->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002230 }
Neil Armstronge952a302022-05-03 10:22:14 +02002231#else
Gilles Peskine449bd832023-01-11 14:50:10 +01002232 if (ssl->handshake->psk != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01002233 mbedtls_zeroize_and_free(ssl->handshake->psk,
Gilles Peskine449bd832023-01-11 14:50:10 +01002234 ssl->handshake->psk_len);
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002235 ssl->handshake->psk_len = 0;
2236 }
Neil Armstronge952a302022-05-03 10:22:14 +02002237#endif /* MBEDTLS_USE_PSA_CRYPTO */
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002238}
2239
Gilles Peskine449bd832023-01-11 14:50:10 +01002240int mbedtls_ssl_set_hs_psk(mbedtls_ssl_context *ssl,
2241 const unsigned char *psk, size_t psk_len)
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002242{
Neil Armstrong501c9322022-05-03 09:35:09 +02002243#if defined(MBEDTLS_USE_PSA_CRYPTO)
2244 psa_key_attributes_t key_attributes = psa_key_attributes_init();
Jerry Yu5d01c052022-08-17 10:18:10 +08002245 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Jerry Yu24b8c812022-08-20 19:06:56 +08002246 psa_algorithm_t alg = PSA_ALG_NONE;
Jerry Yu5d01c052022-08-17 10:18:10 +08002247 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Neil Armstrong501c9322022-05-03 09:35:09 +02002248#endif /* MBEDTLS_USE_PSA_CRYPTO */
2249
Gilles Peskine449bd832023-01-11 14:50:10 +01002250 if (psk == NULL || ssl->handshake == NULL) {
2251 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2252 }
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002253
Gilles Peskine449bd832023-01-11 14:50:10 +01002254 if (psk_len > MBEDTLS_PSK_MAX_LEN) {
2255 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2256 }
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002257
Gilles Peskine449bd832023-01-11 14:50:10 +01002258 ssl_remove_psk(ssl);
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002259
Neil Armstrong501c9322022-05-03 09:35:09 +02002260#if defined(MBEDTLS_USE_PSA_CRYPTO)
Jerry Yuccc68a42022-07-26 16:39:20 +08002261#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01002262 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_2) {
2263 if (ssl->handshake->ciphersuite_info->mac == MBEDTLS_MD_SHA384) {
2264 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_384);
2265 } else {
2266 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_256);
2267 }
2268 psa_set_key_usage_flags(&key_attributes, PSA_KEY_USAGE_DERIVE);
Jerry Yuccc68a42022-07-26 16:39:20 +08002269 }
2270#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Neil Armstrong501c9322022-05-03 09:35:09 +02002271
Jerry Yu568ec252022-07-22 21:27:34 +08002272#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01002273 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
2274 alg = PSA_ALG_HKDF_EXTRACT(PSA_ALG_ANY_HASH);
2275 psa_set_key_usage_flags(&key_attributes,
2276 PSA_KEY_USAGE_DERIVE | PSA_KEY_USAGE_EXPORT);
Jerry Yuccc68a42022-07-26 16:39:20 +08002277 }
2278#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
2279
Gilles Peskine449bd832023-01-11 14:50:10 +01002280 psa_set_key_algorithm(&key_attributes, alg);
2281 psa_set_key_type(&key_attributes, PSA_KEY_TYPE_DERIVE);
Neil Armstrong501c9322022-05-03 09:35:09 +02002282
Gilles Peskine449bd832023-01-11 14:50:10 +01002283 status = psa_import_key(&key_attributes, psk, psk_len, &key);
2284 if (status != PSA_SUCCESS) {
2285 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
2286 }
Neil Armstrong501c9322022-05-03 09:35:09 +02002287
2288 /* Allow calling psa_destroy_key() on psk remove */
2289 ssl->handshake->psk_opaque_is_internal = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01002290 return mbedtls_ssl_set_hs_psk_opaque(ssl, key);
Neil Armstrong501c9322022-05-03 09:35:09 +02002291#else
Gilles Peskine449bd832023-01-11 14:50:10 +01002292 if ((ssl->handshake->psk = mbedtls_calloc(1, psk_len)) == NULL) {
2293 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
2294 }
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002295
2296 ssl->handshake->psk_len = psk_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01002297 memcpy(ssl->handshake->psk, psk, ssl->handshake->psk_len);
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002298
Gilles Peskine449bd832023-01-11 14:50:10 +01002299 return 0;
Neil Armstrong501c9322022-05-03 09:35:09 +02002300#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002301}
2302
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002303#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01002304int mbedtls_ssl_conf_psk_opaque(mbedtls_ssl_config *conf,
2305 mbedtls_svc_key_id_t psk,
2306 const unsigned char *psk_identity,
2307 size_t psk_identity_len)
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002308{
Janos Follath865b3eb2019-12-16 11:46:15 +00002309 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002310
2311 /* We currently only support one PSK, raw or opaque. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002312 if (mbedtls_ssl_conf_has_static_psk(conf)) {
2313 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
2314 }
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002315
Hanno Becker7390c712018-11-15 13:33:04 +00002316 /* Check and set opaque PSK */
Gilles Peskine449bd832023-01-11 14:50:10 +01002317 if (mbedtls_svc_key_id_is_null(psk)) {
2318 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2319 }
Ronald Croncf56a0a2020-08-04 09:51:30 +02002320 conf->psk_opaque = psk;
Hanno Becker7390c712018-11-15 13:33:04 +00002321
2322 /* Check and set PSK Identity */
Gilles Peskine449bd832023-01-11 14:50:10 +01002323 ret = ssl_conf_set_psk_identity(conf, psk_identity,
2324 psk_identity_len);
2325 if (ret != 0) {
2326 ssl_conf_remove_psk(conf);
2327 }
Hanno Becker7390c712018-11-15 13:33:04 +00002328
Gilles Peskine449bd832023-01-11 14:50:10 +01002329 return ret;
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002330}
2331
Gilles Peskine449bd832023-01-11 14:50:10 +01002332int mbedtls_ssl_set_hs_psk_opaque(mbedtls_ssl_context *ssl,
2333 mbedtls_svc_key_id_t psk)
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002334{
Gilles Peskine449bd832023-01-11 14:50:10 +01002335 if ((mbedtls_svc_key_id_is_null(psk)) ||
2336 (ssl->handshake == NULL)) {
2337 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2338 }
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002339
Gilles Peskine449bd832023-01-11 14:50:10 +01002340 ssl_remove_psk(ssl);
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002341 ssl->handshake->psk_opaque = psk;
Gilles Peskine449bd832023-01-11 14:50:10 +01002342 return 0;
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002343}
2344#endif /* MBEDTLS_USE_PSA_CRYPTO */
2345
Jerry Yu8897c072022-08-12 13:56:53 +08002346#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002347void mbedtls_ssl_conf_psk_cb(mbedtls_ssl_config *conf,
2348 int (*f_psk)(void *, mbedtls_ssl_context *, const unsigned char *,
2349 size_t),
2350 void *p_psk)
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002351{
2352 conf->f_psk = f_psk;
2353 conf->p_psk = p_psk;
2354}
Jerry Yu8897c072022-08-12 13:56:53 +08002355#endif /* MBEDTLS_SSL_SRV_C */
2356
Ronald Cron73fe8df2022-10-05 14:31:43 +02002357#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED */
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002358
2359#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine301711e2022-04-26 16:57:05 +02002360static mbedtls_ssl_mode_t mbedtls_ssl_get_base_mode(
Gilles Peskine449bd832023-01-11 14:50:10 +01002361 psa_algorithm_t alg)
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002362{
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002363#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01002364 if (alg == PSA_ALG_CBC_NO_PADDING) {
2365 return MBEDTLS_SSL_MODE_CBC;
2366 }
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002367#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
Gilles Peskine449bd832023-01-11 14:50:10 +01002368 if (PSA_ALG_IS_AEAD(alg)) {
2369 return MBEDTLS_SSL_MODE_AEAD;
2370 }
2371 return MBEDTLS_SSL_MODE_STREAM;
Gilles Peskine301711e2022-04-26 16:57:05 +02002372}
2373
2374#else /* MBEDTLS_USE_PSA_CRYPTO */
2375
2376static mbedtls_ssl_mode_t mbedtls_ssl_get_base_mode(
Gilles Peskine449bd832023-01-11 14:50:10 +01002377 mbedtls_cipher_mode_t mode)
Gilles Peskine301711e2022-04-26 16:57:05 +02002378{
2379#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01002380 if (mode == MBEDTLS_MODE_CBC) {
2381 return MBEDTLS_SSL_MODE_CBC;
2382 }
Gilles Peskine301711e2022-04-26 16:57:05 +02002383#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
2384
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002385#if defined(MBEDTLS_GCM_C) || \
2386 defined(MBEDTLS_CCM_C) || \
2387 defined(MBEDTLS_CHACHAPOLY_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002388 if (mode == MBEDTLS_MODE_GCM ||
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002389 mode == MBEDTLS_MODE_CCM ||
Gilles Peskine449bd832023-01-11 14:50:10 +01002390 mode == MBEDTLS_MODE_CHACHAPOLY) {
2391 return MBEDTLS_SSL_MODE_AEAD;
2392 }
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002393#endif /* MBEDTLS_GCM_C || MBEDTLS_CCM_C || MBEDTLS_CHACHAPOLY_C */
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002394
Gilles Peskine449bd832023-01-11 14:50:10 +01002395 return MBEDTLS_SSL_MODE_STREAM;
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002396}
Gilles Peskine301711e2022-04-26 16:57:05 +02002397#endif /* MBEDTLS_USE_PSA_CRYPTO */
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002398
Gilles Peskinee108d982022-04-26 16:50:40 +02002399static mbedtls_ssl_mode_t mbedtls_ssl_get_actual_mode(
2400 mbedtls_ssl_mode_t base_mode,
Gilles Peskine449bd832023-01-11 14:50:10 +01002401 int encrypt_then_mac)
Gilles Peskinee108d982022-04-26 16:50:40 +02002402{
2403#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01002404 if (encrypt_then_mac == MBEDTLS_SSL_ETM_ENABLED &&
2405 base_mode == MBEDTLS_SSL_MODE_CBC) {
2406 return MBEDTLS_SSL_MODE_CBC_ETM;
Gilles Peskinee108d982022-04-26 16:50:40 +02002407 }
2408#else
2409 (void) encrypt_then_mac;
2410#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002411 return base_mode;
Gilles Peskinee108d982022-04-26 16:50:40 +02002412}
2413
Neil Armstrongab555e02022-04-04 11:07:59 +02002414mbedtls_ssl_mode_t mbedtls_ssl_get_mode_from_transform(
Gilles Peskine449bd832023-01-11 14:50:10 +01002415 const mbedtls_ssl_transform *transform)
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002416{
Gilles Peskinee108d982022-04-26 16:50:40 +02002417 mbedtls_ssl_mode_t base_mode = mbedtls_ssl_get_base_mode(
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002418#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01002419 transform->psa_alg
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002420#else
Gilles Peskine449bd832023-01-11 14:50:10 +01002421 mbedtls_cipher_get_cipher_mode(&transform->cipher_ctx_enc)
Gilles Peskinee108d982022-04-26 16:50:40 +02002422#endif
2423 );
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002424
Gilles Peskinee108d982022-04-26 16:50:40 +02002425 int encrypt_then_mac = 0;
Neil Armstrongf2c82f02022-04-05 11:16:53 +02002426#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskinee108d982022-04-26 16:50:40 +02002427 encrypt_then_mac = transform->encrypt_then_mac;
2428#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002429 return mbedtls_ssl_get_actual_mode(base_mode, encrypt_then_mac);
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002430}
2431
Neil Armstrongab555e02022-04-04 11:07:59 +02002432mbedtls_ssl_mode_t mbedtls_ssl_get_mode_from_ciphersuite(
Neil Armstrongf2c82f02022-04-05 11:16:53 +02002433#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01002434 int encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02002435#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01002436 const mbedtls_ssl_ciphersuite_t *suite)
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002437{
Gilles Peskinee108d982022-04-26 16:50:40 +02002438 mbedtls_ssl_mode_t base_mode = MBEDTLS_SSL_MODE_STREAM;
2439
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002440#if defined(MBEDTLS_USE_PSA_CRYPTO)
2441 psa_status_t status;
2442 psa_algorithm_t alg;
2443 psa_key_type_t type;
2444 size_t size;
Dave Rodgman2eab4622023-10-05 13:30:37 +01002445 status = mbedtls_ssl_cipher_to_psa((mbedtls_cipher_type_t) suite->cipher,
2446 0, &alg, &type, &size);
Gilles Peskine449bd832023-01-11 14:50:10 +01002447 if (status == PSA_SUCCESS) {
2448 base_mode = mbedtls_ssl_get_base_mode(alg);
2449 }
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002450#else
2451 const mbedtls_cipher_info_t *cipher =
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01002452 mbedtls_cipher_info_from_type((mbedtls_cipher_type_t) suite->cipher);
Gilles Peskine449bd832023-01-11 14:50:10 +01002453 if (cipher != NULL) {
Gilles Peskinee108d982022-04-26 16:50:40 +02002454 base_mode =
2455 mbedtls_ssl_get_base_mode(
Gilles Peskine449bd832023-01-11 14:50:10 +01002456 mbedtls_cipher_info_get_mode(cipher));
Gilles Peskinee108d982022-04-26 16:50:40 +02002457 }
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002458#endif /* MBEDTLS_USE_PSA_CRYPTO */
2459
Gilles Peskinee108d982022-04-26 16:50:40 +02002460#if !defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
2461 int encrypt_then_mac = 0;
2462#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002463 return mbedtls_ssl_get_actual_mode(base_mode, encrypt_then_mac);
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002464}
2465
Neil Armstrong8395d7a2022-05-18 11:44:56 +02002466#if defined(MBEDTLS_USE_PSA_CRYPTO) || defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yu251a12e2022-07-13 15:15:48 +08002467
Gilles Peskine449bd832023-01-11 14:50:10 +01002468psa_status_t mbedtls_ssl_cipher_to_psa(mbedtls_cipher_type_t mbedtls_cipher_type,
2469 size_t taglen,
2470 psa_algorithm_t *alg,
2471 psa_key_type_t *key_type,
2472 size_t *key_size)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002473{
Yanray Wang19e4dc82023-11-16 18:02:05 +08002474#if !defined(MBEDTLS_SSL_HAVE_CCM)
2475 (void) taglen;
2476#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002477 switch (mbedtls_cipher_type) {
Yanray Wang1a369d62023-11-16 15:17:31 +08002478#if defined(MBEDTLS_SSL_HAVE_AES) && defined(MBEDTLS_SSL_HAVE_CBC)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002479 case MBEDTLS_CIPHER_AES_128_CBC:
2480 *alg = PSA_ALG_CBC_NO_PADDING;
2481 *key_type = PSA_KEY_TYPE_AES;
2482 *key_size = 128;
2483 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002484#endif
2485#if defined(MBEDTLS_SSL_HAVE_AES) && defined(MBEDTLS_SSL_HAVE_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002486 case MBEDTLS_CIPHER_AES_128_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002487 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002488 *key_type = PSA_KEY_TYPE_AES;
2489 *key_size = 128;
2490 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002491#endif
2492#if defined(MBEDTLS_SSL_HAVE_AES) && defined(MBEDTLS_SSL_HAVE_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002493 case MBEDTLS_CIPHER_AES_128_GCM:
2494 *alg = PSA_ALG_GCM;
2495 *key_type = PSA_KEY_TYPE_AES;
2496 *key_size = 128;
2497 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002498#endif
2499#if defined(MBEDTLS_SSL_HAVE_AES) && defined(MBEDTLS_SSL_HAVE_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002500 case MBEDTLS_CIPHER_AES_192_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002501 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002502 *key_type = PSA_KEY_TYPE_AES;
2503 *key_size = 192;
2504 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002505#endif
2506#if defined(MBEDTLS_SSL_HAVE_AES) && defined(MBEDTLS_SSL_HAVE_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002507 case MBEDTLS_CIPHER_AES_192_GCM:
2508 *alg = PSA_ALG_GCM;
2509 *key_type = PSA_KEY_TYPE_AES;
2510 *key_size = 192;
2511 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002512#endif
2513#if defined(MBEDTLS_SSL_HAVE_AES) && defined(MBEDTLS_SSL_HAVE_CBC)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002514 case MBEDTLS_CIPHER_AES_256_CBC:
2515 *alg = PSA_ALG_CBC_NO_PADDING;
2516 *key_type = PSA_KEY_TYPE_AES;
2517 *key_size = 256;
2518 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002519#endif
2520#if defined(MBEDTLS_SSL_HAVE_AES) && defined(MBEDTLS_SSL_HAVE_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002521 case MBEDTLS_CIPHER_AES_256_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002522 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002523 *key_type = PSA_KEY_TYPE_AES;
2524 *key_size = 256;
2525 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002526#endif
2527#if defined(MBEDTLS_SSL_HAVE_AES) && defined(MBEDTLS_SSL_HAVE_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002528 case MBEDTLS_CIPHER_AES_256_GCM:
2529 *alg = PSA_ALG_GCM;
2530 *key_type = PSA_KEY_TYPE_AES;
2531 *key_size = 256;
2532 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002533#endif
2534#if defined(MBEDTLS_SSL_HAVE_ARIA) && defined(MBEDTLS_SSL_HAVE_CBC)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002535 case MBEDTLS_CIPHER_ARIA_128_CBC:
2536 *alg = PSA_ALG_CBC_NO_PADDING;
2537 *key_type = PSA_KEY_TYPE_ARIA;
2538 *key_size = 128;
2539 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002540#endif
2541#if defined(MBEDTLS_SSL_HAVE_ARIA) && defined(MBEDTLS_SSL_HAVE_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002542 case MBEDTLS_CIPHER_ARIA_128_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002543 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002544 *key_type = PSA_KEY_TYPE_ARIA;
2545 *key_size = 128;
2546 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002547#endif
2548#if defined(MBEDTLS_SSL_HAVE_ARIA) && defined(MBEDTLS_SSL_HAVE_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002549 case MBEDTLS_CIPHER_ARIA_128_GCM:
2550 *alg = PSA_ALG_GCM;
2551 *key_type = PSA_KEY_TYPE_ARIA;
2552 *key_size = 128;
2553 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002554#endif
2555#if defined(MBEDTLS_SSL_HAVE_ARIA) && defined(MBEDTLS_SSL_HAVE_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002556 case MBEDTLS_CIPHER_ARIA_192_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002557 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002558 *key_type = PSA_KEY_TYPE_ARIA;
2559 *key_size = 192;
2560 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002561#endif
2562#if defined(MBEDTLS_SSL_HAVE_ARIA) && defined(MBEDTLS_SSL_HAVE_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002563 case MBEDTLS_CIPHER_ARIA_192_GCM:
2564 *alg = PSA_ALG_GCM;
2565 *key_type = PSA_KEY_TYPE_ARIA;
2566 *key_size = 192;
2567 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002568#endif
2569#if defined(MBEDTLS_SSL_HAVE_ARIA) && defined(MBEDTLS_SSL_HAVE_CBC)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002570 case MBEDTLS_CIPHER_ARIA_256_CBC:
2571 *alg = PSA_ALG_CBC_NO_PADDING;
2572 *key_type = PSA_KEY_TYPE_ARIA;
2573 *key_size = 256;
2574 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002575#endif
2576#if defined(MBEDTLS_SSL_HAVE_ARIA) && defined(MBEDTLS_SSL_HAVE_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002577 case MBEDTLS_CIPHER_ARIA_256_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002578 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002579 *key_type = PSA_KEY_TYPE_ARIA;
2580 *key_size = 256;
2581 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002582#endif
2583#if defined(MBEDTLS_SSL_HAVE_ARIA) && defined(MBEDTLS_SSL_HAVE_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002584 case MBEDTLS_CIPHER_ARIA_256_GCM:
2585 *alg = PSA_ALG_GCM;
2586 *key_type = PSA_KEY_TYPE_ARIA;
2587 *key_size = 256;
2588 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002589#endif
2590#if defined(MBEDTLS_SSL_HAVE_CAMELLIA) && defined(MBEDTLS_SSL_HAVE_CBC)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002591 case MBEDTLS_CIPHER_CAMELLIA_128_CBC:
2592 *alg = PSA_ALG_CBC_NO_PADDING;
2593 *key_type = PSA_KEY_TYPE_CAMELLIA;
2594 *key_size = 128;
2595 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002596#endif
2597#if defined(MBEDTLS_SSL_HAVE_CAMELLIA) && defined(MBEDTLS_SSL_HAVE_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002598 case MBEDTLS_CIPHER_CAMELLIA_128_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002599 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002600 *key_type = PSA_KEY_TYPE_CAMELLIA;
2601 *key_size = 128;
2602 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002603#endif
2604#if defined(MBEDTLS_SSL_HAVE_CAMELLIA) && defined(MBEDTLS_SSL_HAVE_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002605 case MBEDTLS_CIPHER_CAMELLIA_128_GCM:
2606 *alg = PSA_ALG_GCM;
2607 *key_type = PSA_KEY_TYPE_CAMELLIA;
2608 *key_size = 128;
2609 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002610#endif
2611#if defined(MBEDTLS_SSL_HAVE_CAMELLIA) && defined(MBEDTLS_SSL_HAVE_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002612 case MBEDTLS_CIPHER_CAMELLIA_192_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002613 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002614 *key_type = PSA_KEY_TYPE_CAMELLIA;
2615 *key_size = 192;
2616 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002617#endif
2618#if defined(MBEDTLS_SSL_HAVE_CAMELLIA) && defined(MBEDTLS_SSL_HAVE_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002619 case MBEDTLS_CIPHER_CAMELLIA_192_GCM:
2620 *alg = PSA_ALG_GCM;
2621 *key_type = PSA_KEY_TYPE_CAMELLIA;
2622 *key_size = 192;
2623 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002624#endif
2625#if defined(MBEDTLS_SSL_HAVE_CAMELLIA) && defined(MBEDTLS_SSL_HAVE_CBC)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002626 case MBEDTLS_CIPHER_CAMELLIA_256_CBC:
2627 *alg = PSA_ALG_CBC_NO_PADDING;
2628 *key_type = PSA_KEY_TYPE_CAMELLIA;
2629 *key_size = 256;
2630 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002631#endif
2632#if defined(MBEDTLS_SSL_HAVE_CAMELLIA) && defined(MBEDTLS_SSL_HAVE_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002633 case MBEDTLS_CIPHER_CAMELLIA_256_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002634 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002635 *key_type = PSA_KEY_TYPE_CAMELLIA;
2636 *key_size = 256;
2637 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002638#endif
2639#if defined(MBEDTLS_SSL_HAVE_CAMELLIA) && defined(MBEDTLS_SSL_HAVE_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002640 case MBEDTLS_CIPHER_CAMELLIA_256_GCM:
2641 *alg = PSA_ALG_GCM;
2642 *key_type = PSA_KEY_TYPE_CAMELLIA;
2643 *key_size = 256;
2644 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002645#endif
2646#if defined(MBEDTLS_SSL_HAVE_CHACHAPOLY)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002647 case MBEDTLS_CIPHER_CHACHA20_POLY1305:
2648 *alg = PSA_ALG_CHACHA20_POLY1305;
2649 *key_type = PSA_KEY_TYPE_CHACHA20;
2650 *key_size = 256;
2651 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002652#endif
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002653 case MBEDTLS_CIPHER_NULL:
2654 *alg = MBEDTLS_SSL_NULL_CIPHER;
2655 *key_type = 0;
2656 *key_size = 0;
2657 break;
2658 default:
2659 return PSA_ERROR_NOT_SUPPORTED;
2660 }
2661
2662 return PSA_SUCCESS;
2663}
Neil Armstrong8395d7a2022-05-18 11:44:56 +02002664#endif /* MBEDTLS_USE_PSA_CRYPTO || MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002665
Manuel Pégourié-Gonnardcf141ca2015-05-20 10:35:51 +02002666#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002667int mbedtls_ssl_conf_dh_param_bin(mbedtls_ssl_config *conf,
2668 const unsigned char *dhm_P, size_t P_len,
2669 const unsigned char *dhm_G, size_t G_len)
Hanno Beckera90658f2017-10-04 15:29:08 +01002670{
Janos Follath865b3eb2019-12-16 11:46:15 +00002671 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Beckera90658f2017-10-04 15:29:08 +01002672
Gilles Peskine449bd832023-01-11 14:50:10 +01002673 mbedtls_mpi_free(&conf->dhm_P);
2674 mbedtls_mpi_free(&conf->dhm_G);
Glenn Strausscee11292021-12-20 01:43:17 -05002675
Gilles Peskine449bd832023-01-11 14:50:10 +01002676 if ((ret = mbedtls_mpi_read_binary(&conf->dhm_P, dhm_P, P_len)) != 0 ||
2677 (ret = mbedtls_mpi_read_binary(&conf->dhm_G, dhm_G, G_len)) != 0) {
2678 mbedtls_mpi_free(&conf->dhm_P);
2679 mbedtls_mpi_free(&conf->dhm_G);
2680 return ret;
Hanno Beckera90658f2017-10-04 15:29:08 +01002681 }
2682
Gilles Peskine449bd832023-01-11 14:50:10 +01002683 return 0;
Hanno Beckera90658f2017-10-04 15:29:08 +01002684}
Paul Bakker5121ce52009-01-03 21:22:43 +00002685
Gilles Peskine449bd832023-01-11 14:50:10 +01002686int mbedtls_ssl_conf_dh_param_ctx(mbedtls_ssl_config *conf, mbedtls_dhm_context *dhm_ctx)
Paul Bakker1b57b062011-01-06 15:48:19 +00002687{
Janos Follath865b3eb2019-12-16 11:46:15 +00002688 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker1b57b062011-01-06 15:48:19 +00002689
Gilles Peskine449bd832023-01-11 14:50:10 +01002690 mbedtls_mpi_free(&conf->dhm_P);
2691 mbedtls_mpi_free(&conf->dhm_G);
Glenn Strausscee11292021-12-20 01:43:17 -05002692
Gilles Peskine449bd832023-01-11 14:50:10 +01002693 if ((ret = mbedtls_dhm_get_value(dhm_ctx, MBEDTLS_DHM_PARAM_P,
2694 &conf->dhm_P)) != 0 ||
2695 (ret = mbedtls_dhm_get_value(dhm_ctx, MBEDTLS_DHM_PARAM_G,
2696 &conf->dhm_G)) != 0) {
2697 mbedtls_mpi_free(&conf->dhm_P);
2698 mbedtls_mpi_free(&conf->dhm_G);
2699 return ret;
Manuel Pégourié-Gonnard1028b742015-05-06 17:33:07 +01002700 }
Paul Bakker1b57b062011-01-06 15:48:19 +00002701
Gilles Peskine449bd832023-01-11 14:50:10 +01002702 return 0;
Paul Bakker1b57b062011-01-06 15:48:19 +00002703}
Manuel Pégourié-Gonnardcf141ca2015-05-20 10:35:51 +02002704#endif /* MBEDTLS_DHM_C && MBEDTLS_SSL_SRV_C */
Paul Bakker1b57b062011-01-06 15:48:19 +00002705
Manuel Pégourié-Gonnardbd990d62015-06-11 14:49:42 +02002706#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_CLI_C)
2707/*
2708 * Set the minimum length for Diffie-Hellman parameters
2709 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002710void mbedtls_ssl_conf_dhm_min_bitlen(mbedtls_ssl_config *conf,
2711 unsigned int bitlen)
Manuel Pégourié-Gonnardbd990d62015-06-11 14:49:42 +02002712{
2713 conf->dhm_min_bitlen = bitlen;
2714}
2715#endif /* MBEDTLS_DHM_C && MBEDTLS_SSL_CLI_C */
2716
Ronald Crone68ab4f2022-10-05 12:46:29 +02002717#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu7ddc38c2022-01-19 11:08:05 +08002718#if !defined(MBEDTLS_DEPRECATED_REMOVED) && defined(MBEDTLS_SSL_PROTO_TLS1_2)
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02002719/*
2720 * Set allowed/preferred hashes for handshake signatures
2721 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002722void mbedtls_ssl_conf_sig_hashes(mbedtls_ssl_config *conf,
2723 const int *hashes)
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02002724{
2725 conf->sig_hashes = hashes;
2726}
Jerry Yu7ddc38c2022-01-19 11:08:05 +08002727#endif /* !MBEDTLS_DEPRECATED_REMOVED && MBEDTLS_SSL_PROTO_TLS1_2 */
Hanno Becker1cd6e002021-08-10 13:27:10 +01002728
Jerry Yuf017ee42022-01-12 15:49:48 +08002729/* Configure allowed signature algorithms for handshake */
Gilles Peskine449bd832023-01-11 14:50:10 +01002730void mbedtls_ssl_conf_sig_algs(mbedtls_ssl_config *conf,
2731 const uint16_t *sig_algs)
Hanno Becker1cd6e002021-08-10 13:27:10 +01002732{
Jerry Yuf017ee42022-01-12 15:49:48 +08002733#if !defined(MBEDTLS_DEPRECATED_REMOVED)
2734 conf->sig_hashes = NULL;
2735#endif /* !MBEDTLS_DEPRECATED_REMOVED */
2736 conf->sig_algs = sig_algs;
Hanno Becker1cd6e002021-08-10 13:27:10 +01002737}
Ronald Crone68ab4f2022-10-05 12:46:29 +02002738#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02002739
Manuel Pégourié-Gonnardf07ce3b2023-09-22 11:53:41 +02002740#if defined(MBEDTLS_ECP_C)
Brett Warrene0edc842021-08-17 09:53:13 +01002741#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002742/*
2743 * Set the allowed elliptic curves
Brett Warrene0edc842021-08-17 09:53:13 +01002744 *
2745 * mbedtls_ssl_setup() takes the provided list
2746 * and translates it to a list of IANA TLS group identifiers,
2747 * stored in ssl->handshake->group_list.
2748 *
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002749 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002750void mbedtls_ssl_conf_curves(mbedtls_ssl_config *conf,
2751 const mbedtls_ecp_group_id *curve_list)
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002752{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002753 conf->curve_list = curve_list;
Brett Warrene0edc842021-08-17 09:53:13 +01002754 conf->group_list = NULL;
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002755}
Brett Warrene0edc842021-08-17 09:53:13 +01002756#endif /* MBEDTLS_DEPRECATED_REMOVED */
Manuel Pégourié-Gonnardf07ce3b2023-09-22 11:53:41 +02002757#endif /* MBEDTLS_ECP_C */
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002758
Brett Warrene0edc842021-08-17 09:53:13 +01002759/*
2760 * Set the allowed groups
2761 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002762void mbedtls_ssl_conf_groups(mbedtls_ssl_config *conf,
2763 const uint16_t *group_list)
Brett Warrene0edc842021-08-17 09:53:13 +01002764{
Manuel Pégourié-Gonnardf07ce3b2023-09-22 11:53:41 +02002765#if defined(MBEDTLS_ECP_C) && !defined(MBEDTLS_DEPRECATED_REMOVED)
Brett Warrene0edc842021-08-17 09:53:13 +01002766 conf->curve_list = NULL;
2767#endif
2768 conf->group_list = group_list;
2769}
2770
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01002771#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002772int mbedtls_ssl_set_hostname(mbedtls_ssl_context *ssl, const char *hostname)
Paul Bakker5121ce52009-01-03 21:22:43 +00002773{
Hanno Becker947194e2017-04-07 13:25:49 +01002774 /* Initialize to suppress unnecessary compiler warning */
2775 size_t hostname_len = 0;
2776
2777 /* Check if new hostname is valid before
2778 * making any change to current one */
Gilles Peskine449bd832023-01-11 14:50:10 +01002779 if (hostname != NULL) {
2780 hostname_len = strlen(hostname);
Hanno Becker947194e2017-04-07 13:25:49 +01002781
Gilles Peskine449bd832023-01-11 14:50:10 +01002782 if (hostname_len > MBEDTLS_SSL_MAX_HOST_NAME_LEN) {
2783 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2784 }
Hanno Becker947194e2017-04-07 13:25:49 +01002785 }
2786
2787 /* Now it's clear that we will overwrite the old hostname,
2788 * so we can free it safely */
2789
Gilles Peskine449bd832023-01-11 14:50:10 +01002790 if (ssl->hostname != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01002791 mbedtls_zeroize_and_free(ssl->hostname, strlen(ssl->hostname));
Hanno Becker947194e2017-04-07 13:25:49 +01002792 }
2793
2794 /* Passing NULL as hostname shall clear the old one */
Manuel Pégourié-Gonnardba26c242015-05-06 10:47:06 +01002795
Gilles Peskine449bd832023-01-11 14:50:10 +01002796 if (hostname == NULL) {
Hanno Becker947194e2017-04-07 13:25:49 +01002797 ssl->hostname = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01002798 } else {
2799 ssl->hostname = mbedtls_calloc(1, hostname_len + 1);
2800 if (ssl->hostname == NULL) {
2801 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
2802 }
Paul Bakker75c1a6f2013-08-19 14:25:29 +02002803
Gilles Peskine449bd832023-01-11 14:50:10 +01002804 memcpy(ssl->hostname, hostname, hostname_len);
Paul Bakker75c1a6f2013-08-19 14:25:29 +02002805
Hanno Becker947194e2017-04-07 13:25:49 +01002806 ssl->hostname[hostname_len] = '\0';
2807 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002808
Gilles Peskine449bd832023-01-11 14:50:10 +01002809 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00002810}
Hanno Becker1a9a51c2017-04-07 13:02:16 +01002811#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00002812
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01002813#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01002814void mbedtls_ssl_conf_sni(mbedtls_ssl_config *conf,
2815 int (*f_sni)(void *, mbedtls_ssl_context *,
2816 const unsigned char *, size_t),
2817 void *p_sni)
Paul Bakker5701cdc2012-09-27 21:49:42 +00002818{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002819 conf->f_sni = f_sni;
2820 conf->p_sni = p_sni;
Paul Bakker5701cdc2012-09-27 21:49:42 +00002821}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002822#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
Paul Bakker5701cdc2012-09-27 21:49:42 +00002823
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002824#if defined(MBEDTLS_SSL_ALPN)
Gilles Peskine449bd832023-01-11 14:50:10 +01002825int mbedtls_ssl_conf_alpn_protocols(mbedtls_ssl_config *conf, const char **protos)
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002826{
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002827 size_t cur_len, tot_len;
2828 const char **p;
2829
2830 /*
Brian J Murray1903fb32016-11-06 04:45:15 -08002831 * RFC 7301 3.1: "Empty strings MUST NOT be included and byte strings
2832 * MUST NOT be truncated."
2833 * We check lengths now rather than later.
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002834 */
2835 tot_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01002836 for (p = protos; *p != NULL; p++) {
2837 cur_len = strlen(*p);
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002838 tot_len += cur_len;
2839
Gilles Peskine449bd832023-01-11 14:50:10 +01002840 if ((cur_len == 0) ||
2841 (cur_len > MBEDTLS_SSL_MAX_ALPN_NAME_LEN) ||
2842 (tot_len > MBEDTLS_SSL_MAX_ALPN_LIST_LEN)) {
2843 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2844 }
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002845 }
2846
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002847 conf->alpn_list = protos;
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002848
Gilles Peskine449bd832023-01-11 14:50:10 +01002849 return 0;
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002850}
2851
Gilles Peskine449bd832023-01-11 14:50:10 +01002852const char *mbedtls_ssl_get_alpn_protocol(const mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002853{
Gilles Peskine449bd832023-01-11 14:50:10 +01002854 return ssl->alpn_chosen;
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002855}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002856#endif /* MBEDTLS_SSL_ALPN */
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002857
Johan Pascalb62bb512015-12-03 21:56:45 +01002858#if defined(MBEDTLS_SSL_DTLS_SRTP)
Gilles Peskine449bd832023-01-11 14:50:10 +01002859void mbedtls_ssl_conf_srtp_mki_value_supported(mbedtls_ssl_config *conf,
2860 int support_mki_value)
Ron Eldor591f1622018-01-22 12:30:04 +02002861{
2862 conf->dtls_srtp_mki_support = support_mki_value;
2863}
2864
Gilles Peskine449bd832023-01-11 14:50:10 +01002865int mbedtls_ssl_dtls_srtp_set_mki_value(mbedtls_ssl_context *ssl,
2866 unsigned char *mki_value,
2867 uint16_t mki_len)
Ron Eldor591f1622018-01-22 12:30:04 +02002868{
Gilles Peskine449bd832023-01-11 14:50:10 +01002869 if (mki_len > MBEDTLS_TLS_SRTP_MAX_MKI_LENGTH) {
2870 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Ron Eldora9788042018-12-05 11:04:31 +02002871 }
Ron Eldor591f1622018-01-22 12:30:04 +02002872
Gilles Peskine449bd832023-01-11 14:50:10 +01002873 if (ssl->conf->dtls_srtp_mki_support == MBEDTLS_SSL_DTLS_SRTP_MKI_UNSUPPORTED) {
2874 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Ron Eldora9788042018-12-05 11:04:31 +02002875 }
Ron Eldor591f1622018-01-22 12:30:04 +02002876
Gilles Peskine449bd832023-01-11 14:50:10 +01002877 memcpy(ssl->dtls_srtp_info.mki_value, mki_value, mki_len);
Ron Eldor591f1622018-01-22 12:30:04 +02002878 ssl->dtls_srtp_info.mki_len = mki_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01002879 return 0;
Ron Eldor591f1622018-01-22 12:30:04 +02002880}
2881
Gilles Peskine449bd832023-01-11 14:50:10 +01002882int mbedtls_ssl_conf_dtls_srtp_protection_profiles(mbedtls_ssl_config *conf,
2883 const mbedtls_ssl_srtp_profile *profiles)
Johan Pascalb62bb512015-12-03 21:56:45 +01002884{
Johan Pascal253d0262020-09-22 13:04:45 +02002885 const mbedtls_ssl_srtp_profile *p;
2886 size_t list_size = 0;
Johan Pascalb62bb512015-12-03 21:56:45 +01002887
Johan Pascal253d0262020-09-22 13:04:45 +02002888 /* check the profiles list: all entry must be valid,
2889 * its size cannot be more than the total number of supported profiles, currently 4 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002890 for (p = profiles; *p != MBEDTLS_TLS_SRTP_UNSET &&
2891 list_size <= MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH;
2892 p++) {
2893 if (mbedtls_ssl_check_srtp_profile_value(*p) != MBEDTLS_TLS_SRTP_UNSET) {
Johan Pascal76fdf1d2020-10-22 23:31:00 +02002894 list_size++;
Gilles Peskine449bd832023-01-11 14:50:10 +01002895 } else {
Johan Pascal76fdf1d2020-10-22 23:31:00 +02002896 /* unsupported value, stop parsing and set the size to an error value */
2897 list_size = MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH + 1;
Johan Pascalb62bb512015-12-03 21:56:45 +01002898 }
2899 }
2900
Gilles Peskine449bd832023-01-11 14:50:10 +01002901 if (list_size > MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH) {
2902 conf->dtls_srtp_profile_list = NULL;
2903 conf->dtls_srtp_profile_list_len = 0;
2904 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Johan Pascal253d0262020-09-22 13:04:45 +02002905 }
2906
Johan Pascal9bc97ca2020-09-21 23:44:45 +02002907 conf->dtls_srtp_profile_list = profiles;
Johan Pascal253d0262020-09-22 13:04:45 +02002908 conf->dtls_srtp_profile_list_len = list_size;
Johan Pascalb62bb512015-12-03 21:56:45 +01002909
Gilles Peskine449bd832023-01-11 14:50:10 +01002910 return 0;
Johan Pascalb62bb512015-12-03 21:56:45 +01002911}
2912
Gilles Peskine449bd832023-01-11 14:50:10 +01002913void mbedtls_ssl_get_dtls_srtp_negotiation_result(const mbedtls_ssl_context *ssl,
2914 mbedtls_dtls_srtp_info *dtls_srtp_info)
Johan Pascalb62bb512015-12-03 21:56:45 +01002915{
Johan Pascal2258a4f2020-10-28 13:53:09 +01002916 dtls_srtp_info->chosen_dtls_srtp_profile = ssl->dtls_srtp_info.chosen_dtls_srtp_profile;
2917 /* do not copy the mki value if there is no chosen profile */
Gilles Peskine449bd832023-01-11 14:50:10 +01002918 if (dtls_srtp_info->chosen_dtls_srtp_profile == MBEDTLS_TLS_SRTP_UNSET) {
Johan Pascal2258a4f2020-10-28 13:53:09 +01002919 dtls_srtp_info->mki_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01002920 } else {
Johan Pascal2258a4f2020-10-28 13:53:09 +01002921 dtls_srtp_info->mki_len = ssl->dtls_srtp_info.mki_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01002922 memcpy(dtls_srtp_info->mki_value, ssl->dtls_srtp_info.mki_value,
2923 ssl->dtls_srtp_info.mki_len);
Johan Pascal2258a4f2020-10-28 13:53:09 +01002924 }
Johan Pascalb62bb512015-12-03 21:56:45 +01002925}
Johan Pascalb62bb512015-12-03 21:56:45 +01002926#endif /* MBEDTLS_SSL_DTLS_SRTP */
2927
Aditya Patwardhan3096f332022-07-26 14:31:46 +05302928#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Gilles Peskine449bd832023-01-11 14:50:10 +01002929void mbedtls_ssl_conf_max_version(mbedtls_ssl_config *conf, int major, int minor)
Paul Bakker490ecc82011-10-06 13:04:09 +00002930{
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01002931 conf->max_tls_version = (mbedtls_ssl_protocol_version) ((major << 8) | minor);
Paul Bakker490ecc82011-10-06 13:04:09 +00002932}
2933
Gilles Peskine449bd832023-01-11 14:50:10 +01002934void mbedtls_ssl_conf_min_version(mbedtls_ssl_config *conf, int major, int minor)
Paul Bakker1d29fb52012-09-28 13:28:45 +00002935{
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01002936 conf->min_tls_version = (mbedtls_ssl_protocol_version) ((major << 8) | minor);
Paul Bakker1d29fb52012-09-28 13:28:45 +00002937}
Aditya Patwardhan3096f332022-07-26 14:31:46 +05302938#endif /* MBEDTLS_DEPRECATED_REMOVED */
Paul Bakker1d29fb52012-09-28 13:28:45 +00002939
Janos Follath088ce432017-04-10 12:42:31 +01002940#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002941void mbedtls_ssl_conf_cert_req_ca_list(mbedtls_ssl_config *conf,
2942 char cert_req_ca_list)
Janos Follath088ce432017-04-10 12:42:31 +01002943{
2944 conf->cert_req_ca_list = cert_req_ca_list;
2945}
2946#endif
2947
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002948#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01002949void mbedtls_ssl_conf_encrypt_then_mac(mbedtls_ssl_config *conf, char etm)
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01002950{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002951 conf->encrypt_then_mac = etm;
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01002952}
2953#endif
2954
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002955#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
Gilles Peskine449bd832023-01-11 14:50:10 +01002956void mbedtls_ssl_conf_extended_master_secret(mbedtls_ssl_config *conf, char ems)
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02002957{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002958 conf->extended_ms = ems;
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02002959}
2960#endif
2961
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002962#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01002963int mbedtls_ssl_conf_max_frag_len(mbedtls_ssl_config *conf, unsigned char mfl_code)
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002964{
Gilles Peskine449bd832023-01-11 14:50:10 +01002965 if (mfl_code >= MBEDTLS_SSL_MAX_FRAG_LEN_INVALID ||
2966 ssl_mfl_code_to_length(mfl_code) > MBEDTLS_TLS_EXT_ADV_CONTENT_LEN) {
2967 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002968 }
2969
Manuel Pégourié-Gonnard6bf89d62015-05-05 17:01:57 +01002970 conf->mfl_code = mfl_code;
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002971
Gilles Peskine449bd832023-01-11 14:50:10 +01002972 return 0;
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002973}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002974#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002975
Gilles Peskine449bd832023-01-11 14:50:10 +01002976void mbedtls_ssl_conf_legacy_renegotiation(mbedtls_ssl_config *conf, int allow_legacy)
Paul Bakker48916f92012-09-16 19:57:18 +00002977{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002978 conf->allow_legacy_renegotiation = allow_legacy;
Paul Bakker48916f92012-09-16 19:57:18 +00002979}
2980
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002981#if defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01002982void mbedtls_ssl_conf_renegotiation(mbedtls_ssl_config *conf, int renegotiation)
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01002983{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002984 conf->disable_renegotiation = renegotiation;
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01002985}
2986
Gilles Peskine449bd832023-01-11 14:50:10 +01002987void mbedtls_ssl_conf_renegotiation_enforced(mbedtls_ssl_config *conf, int max_records)
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02002988{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002989 conf->renego_max_records = max_records;
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02002990}
2991
Gilles Peskine449bd832023-01-11 14:50:10 +01002992void mbedtls_ssl_conf_renegotiation_period(mbedtls_ssl_config *conf,
2993 const unsigned char period[8])
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01002994{
Gilles Peskine449bd832023-01-11 14:50:10 +01002995 memcpy(conf->renego_period, period, 8);
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01002996}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002997#endif /* MBEDTLS_SSL_RENEGOTIATION */
Paul Bakker5121ce52009-01-03 21:22:43 +00002998
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002999#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02003000#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01003001void mbedtls_ssl_conf_session_tickets(mbedtls_ssl_config *conf, int use_tickets)
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02003002{
Manuel Pégourié-Gonnard2b494452015-05-06 10:05:11 +01003003 conf->session_tickets = use_tickets;
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02003004}
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02003005#endif
Paul Bakker606b4ba2013-08-14 16:52:14 +02003006
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02003007#if defined(MBEDTLS_SSL_SRV_C)
Jerry Yu1ad7ace2022-08-09 13:28:39 +08003008
Jerry Yud0766ec2022-09-22 10:46:57 +08003009#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003010void mbedtls_ssl_conf_new_session_tickets(mbedtls_ssl_config *conf,
3011 uint16_t num_tickets)
Jerry Yu1ad7ace2022-08-09 13:28:39 +08003012{
Jerry Yud0766ec2022-09-22 10:46:57 +08003013 conf->new_session_tickets_count = num_tickets;
Jerry Yu1ad7ace2022-08-09 13:28:39 +08003014}
3015#endif
3016
Gilles Peskine449bd832023-01-11 14:50:10 +01003017void mbedtls_ssl_conf_session_tickets_cb(mbedtls_ssl_config *conf,
3018 mbedtls_ssl_ticket_write_t *f_ticket_write,
3019 mbedtls_ssl_ticket_parse_t *f_ticket_parse,
3020 void *p_ticket)
Paul Bakker606b4ba2013-08-14 16:52:14 +02003021{
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02003022 conf->f_ticket_write = f_ticket_write;
3023 conf->f_ticket_parse = f_ticket_parse;
3024 conf->p_ticket = p_ticket;
Paul Bakker606b4ba2013-08-14 16:52:14 +02003025}
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02003026#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003027#endif /* MBEDTLS_SSL_SESSION_TICKETS */
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02003028
Gilles Peskine449bd832023-01-11 14:50:10 +01003029void mbedtls_ssl_set_export_keys_cb(mbedtls_ssl_context *ssl,
3030 mbedtls_ssl_export_keys_t *f_export_keys,
3031 void *p_export_keys)
Robert Cragie4feb7ae2015-10-02 13:33:37 +01003032{
Hanno Becker7e6c1782021-06-08 09:24:55 +01003033 ssl->f_export_keys = f_export_keys;
3034 ssl->p_export_keys = p_export_keys;
Ron Eldorf5cc10d2019-05-07 18:33:40 +03003035}
Robert Cragie4feb7ae2015-10-02 13:33:37 +01003036
Gilles Peskineb74a1c72018-04-24 13:09:22 +02003037#if defined(MBEDTLS_SSL_ASYNC_PRIVATE)
Gilles Peskine8bf79f62018-01-05 21:11:53 +01003038void mbedtls_ssl_conf_async_private_cb(
3039 mbedtls_ssl_config *conf,
3040 mbedtls_ssl_async_sign_t *f_async_sign,
3041 mbedtls_ssl_async_decrypt_t *f_async_decrypt,
3042 mbedtls_ssl_async_resume_t *f_async_resume,
3043 mbedtls_ssl_async_cancel_t *f_async_cancel,
Gilles Peskine449bd832023-01-11 14:50:10 +01003044 void *async_config_data)
Gilles Peskine8bf79f62018-01-05 21:11:53 +01003045{
3046 conf->f_async_sign_start = f_async_sign;
3047 conf->f_async_decrypt_start = f_async_decrypt;
3048 conf->f_async_resume = f_async_resume;
3049 conf->f_async_cancel = f_async_cancel;
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003050 conf->p_async_config_data = async_config_data;
3051}
3052
Gilles Peskine449bd832023-01-11 14:50:10 +01003053void *mbedtls_ssl_conf_get_async_config_data(const mbedtls_ssl_config *conf)
Gilles Peskine8f97af72018-04-26 11:46:10 +02003054{
Gilles Peskine449bd832023-01-11 14:50:10 +01003055 return conf->p_async_config_data;
Gilles Peskine8f97af72018-04-26 11:46:10 +02003056}
3057
Gilles Peskine449bd832023-01-11 14:50:10 +01003058void *mbedtls_ssl_get_async_operation_data(const mbedtls_ssl_context *ssl)
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003059{
Gilles Peskine449bd832023-01-11 14:50:10 +01003060 if (ssl->handshake == NULL) {
3061 return NULL;
3062 } else {
3063 return ssl->handshake->user_async_ctx;
3064 }
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003065}
3066
Gilles Peskine449bd832023-01-11 14:50:10 +01003067void mbedtls_ssl_set_async_operation_data(mbedtls_ssl_context *ssl,
3068 void *ctx)
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003069{
Gilles Peskine449bd832023-01-11 14:50:10 +01003070 if (ssl->handshake != NULL) {
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003071 ssl->handshake->user_async_ctx = ctx;
Gilles Peskine449bd832023-01-11 14:50:10 +01003072 }
Gilles Peskine8bf79f62018-01-05 21:11:53 +01003073}
Gilles Peskineb74a1c72018-04-24 13:09:22 +02003074#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
Gilles Peskine8bf79f62018-01-05 21:11:53 +01003075
Paul Bakker5121ce52009-01-03 21:22:43 +00003076/*
3077 * SSL get accessors
3078 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003079uint32_t mbedtls_ssl_get_verify_result(const mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00003080{
Gilles Peskine449bd832023-01-11 14:50:10 +01003081 if (ssl->session != NULL) {
3082 return ssl->session->verify_result;
3083 }
Manuel Pégourié-Gonnarde89163c2015-01-23 14:30:57 +00003084
Gilles Peskine449bd832023-01-11 14:50:10 +01003085 if (ssl->session_negotiate != NULL) {
3086 return ssl->session_negotiate->verify_result;
3087 }
Manuel Pégourié-Gonnarde89163c2015-01-23 14:30:57 +00003088
Gilles Peskine449bd832023-01-11 14:50:10 +01003089 return 0xFFFFFFFF;
Paul Bakker5121ce52009-01-03 21:22:43 +00003090}
3091
Gilles Peskine449bd832023-01-11 14:50:10 +01003092int mbedtls_ssl_get_ciphersuite_id_from_ssl(const mbedtls_ssl_context *ssl)
Glenn Strauss8f526902022-01-13 00:04:49 -05003093{
Gilles Peskine449bd832023-01-11 14:50:10 +01003094 if (ssl == NULL || ssl->session == NULL) {
3095 return 0;
3096 }
Glenn Strauss8f526902022-01-13 00:04:49 -05003097
Gilles Peskine449bd832023-01-11 14:50:10 +01003098 return ssl->session->ciphersuite;
Glenn Strauss8f526902022-01-13 00:04:49 -05003099}
3100
Gilles Peskine449bd832023-01-11 14:50:10 +01003101const char *mbedtls_ssl_get_ciphersuite(const mbedtls_ssl_context *ssl)
Paul Bakker72f62662011-01-16 21:27:44 +00003102{
Gilles Peskine449bd832023-01-11 14:50:10 +01003103 if (ssl == NULL || ssl->session == NULL) {
3104 return NULL;
3105 }
Paul Bakker926c8e42013-03-06 10:23:34 +01003106
Gilles Peskine449bd832023-01-11 14:50:10 +01003107 return mbedtls_ssl_get_ciphersuite_name(ssl->session->ciphersuite);
Paul Bakker72f62662011-01-16 21:27:44 +00003108}
3109
Gilles Peskine449bd832023-01-11 14:50:10 +01003110const char *mbedtls_ssl_get_version(const mbedtls_ssl_context *ssl)
Paul Bakker43ca69c2011-01-15 17:35:19 +00003111{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003112#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003113 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
3114 switch (ssl->tls_version) {
Glenn Strauss60bfe602022-03-14 19:04:24 -04003115 case MBEDTLS_SSL_VERSION_TLS1_2:
Gilles Peskine449bd832023-01-11 14:50:10 +01003116 return "DTLSv1.2";
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01003117 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01003118 return "unknown (DTLS)";
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01003119 }
3120 }
3121#endif
3122
Gilles Peskine449bd832023-01-11 14:50:10 +01003123 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 "TLSv1.2";
Glenn Strauss60bfe602022-03-14 19:04:24 -04003126 case MBEDTLS_SSL_VERSION_TLS1_3:
Gilles Peskine449bd832023-01-11 14:50:10 +01003127 return "TLSv1.3";
Paul Bakker43ca69c2011-01-15 17:35:19 +00003128 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01003129 return "unknown";
Paul Bakker43ca69c2011-01-15 17:35:19 +00003130 }
Paul Bakker43ca69c2011-01-15 17:35:19 +00003131}
3132
Waleed Elmelegy6a971fd2023-12-28 17:48:16 +00003133#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
3134
3135size_t mbedtls_ssl_get_output_record_size_limit(const mbedtls_ssl_context *ssl)
3136{
3137 const size_t max_len = MBEDTLS_SSL_OUT_CONTENT_LEN;
3138 size_t record_size_limit = max_len;
3139
3140 if (ssl->session != NULL &&
3141 ssl->session->record_size_limit >= MBEDTLS_SSL_RECORD_SIZE_LIMIT_MIN &&
3142 ssl->session->record_size_limit < max_len) {
3143 record_size_limit = ssl->session->record_size_limit;
3144 }
3145
3146 // TODO: this is currently untested
3147 /* During a handshake, use the value being negotiated */
3148 if (ssl->session_negotiate != NULL &&
3149 ssl->session_negotiate->record_size_limit >= MBEDTLS_SSL_RECORD_SIZE_LIMIT_MIN &&
3150 ssl->session_negotiate->record_size_limit < max_len) {
3151 record_size_limit = ssl->session_negotiate->record_size_limit;
3152 }
3153
3154 return record_size_limit;
3155}
3156#endif /* MBEDTLS_SSL_RECORD_SIZE_LIMIT */
3157
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02003158#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01003159size_t mbedtls_ssl_get_input_max_frag_len(const mbedtls_ssl_context *ssl)
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003160{
David Horstmann95d516f2021-05-04 18:36:56 +01003161 size_t max_len = MBEDTLS_SSL_IN_CONTENT_LEN;
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003162 size_t read_mfl;
3163
Jerry Yuddda0502022-12-01 19:43:12 +08003164#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003165 /* Use the configured MFL for the client if we're past SERVER_HELLO_DONE */
Gilles Peskine449bd832023-01-11 14:50:10 +01003166 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
3167 ssl->state >= MBEDTLS_SSL_SERVER_HELLO_DONE) {
3168 return ssl_mfl_code_to_length(ssl->conf->mfl_code);
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003169 }
Jerry Yuddda0502022-12-01 19:43:12 +08003170#endif
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003171
3172 /* Check if a smaller max length was negotiated */
Gilles Peskine449bd832023-01-11 14:50:10 +01003173 if (ssl->session_out != NULL) {
3174 read_mfl = ssl_mfl_code_to_length(ssl->session_out->mfl_code);
3175 if (read_mfl < max_len) {
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003176 max_len = read_mfl;
3177 }
3178 }
3179
Jerry Yuddda0502022-12-01 19:43:12 +08003180 /* During a handshake, use the value being negotiated */
Gilles Peskine449bd832023-01-11 14:50:10 +01003181 if (ssl->session_negotiate != NULL) {
3182 read_mfl = ssl_mfl_code_to_length(ssl->session_negotiate->mfl_code);
3183 if (read_mfl < max_len) {
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003184 max_len = read_mfl;
3185 }
3186 }
3187
Gilles Peskine449bd832023-01-11 14:50:10 +01003188 return max_len;
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003189}
3190
Gilles Peskine449bd832023-01-11 14:50:10 +01003191size_t mbedtls_ssl_get_output_max_frag_len(const mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02003192{
3193 size_t max_len;
3194
3195 /*
3196 * Assume mfl_code is correct since it was checked when set
3197 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003198 max_len = ssl_mfl_code_to_length(ssl->conf->mfl_code);
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02003199
Manuel Pégourié-Gonnard2cb17e22017-09-19 13:00:47 +02003200 /* Check if a smaller max length was negotiated */
Gilles Peskine449bd832023-01-11 14:50:10 +01003201 if (ssl->session_out != NULL &&
3202 ssl_mfl_code_to_length(ssl->session_out->mfl_code) < max_len) {
3203 max_len = ssl_mfl_code_to_length(ssl->session_out->mfl_code);
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02003204 }
3205
Manuel Pégourié-Gonnard2cb17e22017-09-19 13:00:47 +02003206 /* During a handshake, use the value being negotiated */
Gilles Peskine449bd832023-01-11 14:50:10 +01003207 if (ssl->session_negotiate != NULL &&
3208 ssl_mfl_code_to_length(ssl->session_negotiate->mfl_code) < max_len) {
3209 max_len = ssl_mfl_code_to_length(ssl->session_negotiate->mfl_code);
Manuel Pégourié-Gonnard2cb17e22017-09-19 13:00:47 +02003210 }
3211
Gilles Peskine449bd832023-01-11 14:50:10 +01003212 return max_len;
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02003213}
3214#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
3215
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003216#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003217size_t mbedtls_ssl_get_current_mtu(const mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003218{
Andrzej Kurekef43ce62018-10-09 08:24:12 -04003219 /* Return unlimited mtu for client hello messages to avoid fragmentation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01003220 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
3221 (ssl->state == MBEDTLS_SSL_CLIENT_HELLO ||
3222 ssl->state == MBEDTLS_SSL_SERVER_HELLO)) {
3223 return 0;
3224 }
Andrzej Kurekef43ce62018-10-09 08:24:12 -04003225
Gilles Peskine449bd832023-01-11 14:50:10 +01003226 if (ssl->handshake == NULL || ssl->handshake->mtu == 0) {
3227 return ssl->mtu;
3228 }
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003229
Gilles Peskine449bd832023-01-11 14:50:10 +01003230 if (ssl->mtu == 0) {
3231 return ssl->handshake->mtu;
3232 }
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003233
Gilles Peskine449bd832023-01-11 14:50:10 +01003234 return ssl->mtu < ssl->handshake->mtu ?
3235 ssl->mtu : ssl->handshake->mtu;
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003236}
3237#endif /* MBEDTLS_SSL_PROTO_DTLS */
3238
Gilles Peskine449bd832023-01-11 14:50:10 +01003239int mbedtls_ssl_get_max_out_record_payload(const mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003240{
3241 size_t max_len = MBEDTLS_SSL_OUT_CONTENT_LEN;
3242
Manuel Pégourié-Gonnard000281e2018-08-21 11:20:58 +02003243#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH) && \
Jan Brucknerf482dcc2023-03-15 09:09:06 +01003244 !defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT) && \
Manuel Pégourié-Gonnard000281e2018-08-21 11:20:58 +02003245 !defined(MBEDTLS_SSL_PROTO_DTLS)
3246 (void) ssl;
3247#endif
3248
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003249#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01003250 const size_t mfl = mbedtls_ssl_get_output_max_frag_len(ssl);
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003251
Gilles Peskine449bd832023-01-11 14:50:10 +01003252 if (max_len > mfl) {
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003253 max_len = mfl;
Gilles Peskine449bd832023-01-11 14:50:10 +01003254 }
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003255#endif
3256
Jan Brucknerf482dcc2023-03-15 09:09:06 +01003257#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
3258 const size_t record_size_limit = mbedtls_ssl_get_output_record_size_limit(ssl);
3259
3260 if (max_len > record_size_limit) {
3261 max_len = record_size_limit;
3262 }
3263#endif
3264
Waleed Elmelegy6a971fd2023-12-28 17:48:16 +00003265 if (ssl->transform_out != NULL &&
3266 ssl->transform_out->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Waleed Elmelegyf5017902024-01-09 14:18:34 +00003267 /*
3268 * In TLS 1.3 case, when records are protected, `max_len` as computed
3269 * above is the maximum length of the TLSInnerPlaintext structure that
3270 * along the plaintext payload contains the inner content type (one byte)
3271 * and some zero padding. Given the algorithm used for padding
3272 * in mbedtls_ssl_encrypt_buf(), compute the maximum length for
3273 * the plaintext payload. Round down to a multiple of
3274 * MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY and
3275 * subtract 1.
Waleed Elmelegy6a971fd2023-12-28 17:48:16 +00003276 */
3277 max_len = ((max_len / MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY) *
3278 MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY) - 1;
3279 }
3280
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003281#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003282 if (mbedtls_ssl_get_current_mtu(ssl) != 0) {
3283 const size_t mtu = mbedtls_ssl_get_current_mtu(ssl);
3284 const int ret = mbedtls_ssl_get_record_expansion(ssl);
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003285 const size_t overhead = (size_t) ret;
3286
Gilles Peskine449bd832023-01-11 14:50:10 +01003287 if (ret < 0) {
3288 return ret;
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003289 }
3290
Gilles Peskine449bd832023-01-11 14:50:10 +01003291 if (mtu <= overhead) {
3292 MBEDTLS_SSL_DEBUG_MSG(1, ("MTU too low for record expansion"));
3293 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
3294 }
3295
3296 if (max_len > mtu - overhead) {
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003297 max_len = mtu - overhead;
Gilles Peskine449bd832023-01-11 14:50:10 +01003298 }
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003299 }
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003300#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003301
Hanno Becker0defedb2018-08-10 12:35:02 +01003302#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH) && \
Waleed Elmelegy049cd302023-12-20 17:28:31 +00003303 !defined(MBEDTLS_SSL_PROTO_DTLS) && \
3304 !defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
Hanno Becker0defedb2018-08-10 12:35:02 +01003305 ((void) ssl);
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003306#endif
3307
Gilles Peskine449bd832023-01-11 14:50:10 +01003308 return (int) max_len;
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003309}
3310
Gilles Peskine449bd832023-01-11 14:50:10 +01003311int mbedtls_ssl_get_max_in_record_payload(const mbedtls_ssl_context *ssl)
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003312{
3313 size_t max_len = MBEDTLS_SSL_IN_CONTENT_LEN;
3314
3315#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
3316 (void) ssl;
3317#endif
3318
3319#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01003320 const size_t mfl = mbedtls_ssl_get_input_max_frag_len(ssl);
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003321
Gilles Peskine449bd832023-01-11 14:50:10 +01003322 if (max_len > mfl) {
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003323 max_len = mfl;
Gilles Peskine449bd832023-01-11 14:50:10 +01003324 }
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003325#endif
3326
Gilles Peskine449bd832023-01-11 14:50:10 +01003327 return (int) max_len;
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003328}
3329
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003330#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01003331const mbedtls_x509_crt *mbedtls_ssl_get_peer_cert(const mbedtls_ssl_context *ssl)
Paul Bakkerb0550d92012-10-30 07:51:03 +00003332{
Gilles Peskine449bd832023-01-11 14:50:10 +01003333 if (ssl == NULL || ssl->session == NULL) {
3334 return NULL;
3335 }
Paul Bakkerb0550d92012-10-30 07:51:03 +00003336
Hanno Beckere6824572019-02-07 13:18:46 +00003337#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01003338 return ssl->session->peer_cert;
Hanno Beckere6824572019-02-07 13:18:46 +00003339#else
Gilles Peskine449bd832023-01-11 14:50:10 +01003340 return NULL;
Hanno Beckere6824572019-02-07 13:18:46 +00003341#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Paul Bakkerb0550d92012-10-30 07:51:03 +00003342}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003343#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkerb0550d92012-10-30 07:51:03 +00003344
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003345#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01003346int mbedtls_ssl_get_session(const mbedtls_ssl_context *ssl,
3347 mbedtls_ssl_session *dst)
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003348{
Hanno Beckere810bbc2021-05-14 16:01:05 +01003349 int ret;
3350
Gilles Peskine449bd832023-01-11 14:50:10 +01003351 if (ssl == NULL ||
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003352 dst == NULL ||
3353 ssl->session == NULL ||
Gilles Peskine449bd832023-01-11 14:50:10 +01003354 ssl->conf->endpoint != MBEDTLS_SSL_IS_CLIENT) {
3355 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003356 }
3357
Hanno Beckere810bbc2021-05-14 16:01:05 +01003358 /* Since Mbed TLS 3.0, mbedtls_ssl_get_session() is no longer
3359 * idempotent: Each session can only be exported once.
3360 *
3361 * (This is in preparation for TLS 1.3 support where we will
3362 * need the ability to export multiple sessions (aka tickets),
3363 * which will be achieved by calling mbedtls_ssl_get_session()
3364 * multiple times until it fails.)
3365 *
3366 * Check whether we have already exported the current session,
3367 * and fail if so.
3368 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003369 if (ssl->session->exported == 1) {
3370 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
3371 }
Hanno Beckere810bbc2021-05-14 16:01:05 +01003372
Gilles Peskine449bd832023-01-11 14:50:10 +01003373 ret = mbedtls_ssl_session_copy(dst, ssl->session);
3374 if (ret != 0) {
3375 return ret;
3376 }
Hanno Beckere810bbc2021-05-14 16:01:05 +01003377
3378 /* Remember that we've exported the session. */
3379 ssl->session->exported = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01003380 return 0;
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003381}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003382#endif /* MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003383
David Horstmanncb01b362024-02-29 17:31:46 +00003384#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
3385
3386/* Serialization of TLS 1.2 sessions
David Horstmanne59f9702024-02-29 16:08:57 +00003387 *
David Horstmanncb01b362024-02-29 17:31:46 +00003388 * For more detail, see the description of ssl_session_save().
David Horstmanne59f9702024-02-29 16:08:57 +00003389 */
3390static size_t ssl_tls12_session_save(const mbedtls_ssl_session *session,
3391 unsigned char *buf,
3392 size_t buf_len)
3393{
3394 unsigned char *p = buf;
3395 size_t used = 0;
3396
3397#if defined(MBEDTLS_HAVE_TIME)
3398 uint64_t start;
3399#endif
3400#if defined(MBEDTLS_X509_CRT_PARSE_C)
3401#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
3402 size_t cert_len;
3403#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3404#endif /* MBEDTLS_X509_CRT_PARSE_C */
3405
3406 /*
3407 * Time
3408 */
3409#if defined(MBEDTLS_HAVE_TIME)
3410 used += 8;
3411
3412 if (used <= buf_len) {
3413 start = (uint64_t) session->start;
3414
3415 MBEDTLS_PUT_UINT64_BE(start, p, 0);
3416 p += 8;
3417 }
3418#endif /* MBEDTLS_HAVE_TIME */
3419
3420 /*
3421 * Basic mandatory fields
3422 */
3423 used += 1 /* id_len */
3424 + sizeof(session->id)
3425 + sizeof(session->master)
3426 + 4; /* verify_result */
3427
3428 if (used <= buf_len) {
3429 *p++ = MBEDTLS_BYTE_0(session->id_len);
3430 memcpy(p, session->id, 32);
3431 p += 32;
3432
3433 memcpy(p, session->master, 48);
3434 p += 48;
3435
3436 MBEDTLS_PUT_UINT32_BE(session->verify_result, p, 0);
3437 p += 4;
3438 }
3439
3440 /*
3441 * Peer's end-entity certificate
3442 */
3443#if defined(MBEDTLS_X509_CRT_PARSE_C)
3444#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
3445 if (session->peer_cert == NULL) {
3446 cert_len = 0;
3447 } else {
3448 cert_len = session->peer_cert->raw.len;
3449 }
3450
3451 used += 3 + cert_len;
3452
3453 if (used <= buf_len) {
3454 *p++ = MBEDTLS_BYTE_2(cert_len);
3455 *p++ = MBEDTLS_BYTE_1(cert_len);
3456 *p++ = MBEDTLS_BYTE_0(cert_len);
3457
3458 if (session->peer_cert != NULL) {
3459 memcpy(p, session->peer_cert->raw.p, cert_len);
3460 p += cert_len;
3461 }
3462 }
3463#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3464 if (session->peer_cert_digest != NULL) {
3465 used += 1 /* type */ + 1 /* length */ + session->peer_cert_digest_len;
3466 if (used <= buf_len) {
3467 *p++ = (unsigned char) session->peer_cert_digest_type;
3468 *p++ = (unsigned char) session->peer_cert_digest_len;
3469 memcpy(p, session->peer_cert_digest,
3470 session->peer_cert_digest_len);
3471 p += session->peer_cert_digest_len;
3472 }
3473 } else {
3474 used += 2;
3475 if (used <= buf_len) {
3476 *p++ = (unsigned char) MBEDTLS_MD_NONE;
3477 *p++ = 0;
3478 }
3479 }
3480#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3481#endif /* MBEDTLS_X509_CRT_PARSE_C */
3482
3483 /*
3484 * Session ticket if any, plus associated data
3485 */
3486#if defined(MBEDTLS_SSL_SESSION_TICKETS)
3487#if defined(MBEDTLS_SSL_CLI_C)
3488 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
3489 used += 3 + session->ticket_len + 4; /* len + ticket + lifetime */
3490
3491 if (used <= buf_len) {
3492 *p++ = MBEDTLS_BYTE_2(session->ticket_len);
3493 *p++ = MBEDTLS_BYTE_1(session->ticket_len);
3494 *p++ = MBEDTLS_BYTE_0(session->ticket_len);
3495
3496 if (session->ticket != NULL) {
3497 memcpy(p, session->ticket, session->ticket_len);
3498 p += session->ticket_len;
3499 }
3500
3501 MBEDTLS_PUT_UINT32_BE(session->ticket_lifetime, p, 0);
3502 p += 4;
3503 }
3504 }
3505#endif /* MBEDTLS_SSL_CLI_C */
3506#if defined(MBEDTLS_HAVE_TIME) && defined(MBEDTLS_SSL_SRV_C)
3507 if (session->endpoint == MBEDTLS_SSL_IS_SERVER) {
3508 used += 8;
3509
3510 if (used <= buf_len) {
3511 MBEDTLS_PUT_UINT64_BE((uint64_t) session->ticket_creation_time, p, 0);
3512 p += 8;
3513 }
3514 }
3515#endif /* MBEDTLS_HAVE_TIME && MBEDTLS_SSL_SRV_C */
3516#endif /* MBEDTLS_SSL_SESSION_TICKETS */
3517
3518 /*
3519 * Misc extension-related info
3520 */
3521#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
3522 used += 1;
3523
3524 if (used <= buf_len) {
3525 *p++ = session->mfl_code;
3526 }
3527#endif
3528
3529#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
3530 used += 1;
3531
3532 if (used <= buf_len) {
3533 *p++ = MBEDTLS_BYTE_0(session->encrypt_then_mac);
3534 }
3535#endif
3536
3537 return used;
3538}
3539
3540MBEDTLS_CHECK_RETURN_CRITICAL
3541static int ssl_tls12_session_load(mbedtls_ssl_session *session,
3542 const unsigned char *buf,
3543 size_t len)
3544{
3545#if defined(MBEDTLS_HAVE_TIME)
3546 uint64_t start;
3547#endif
3548#if defined(MBEDTLS_X509_CRT_PARSE_C)
3549#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
3550 size_t cert_len;
3551#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3552#endif /* MBEDTLS_X509_CRT_PARSE_C */
3553
3554 const unsigned char *p = buf;
3555 const unsigned char * const end = buf + len;
3556
3557 /*
3558 * Time
3559 */
3560#if defined(MBEDTLS_HAVE_TIME)
3561 if (8 > (size_t) (end - p)) {
3562 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3563 }
3564
3565 start = MBEDTLS_GET_UINT64_BE(p, 0);
3566 p += 8;
3567
3568 session->start = (time_t) start;
3569#endif /* MBEDTLS_HAVE_TIME */
3570
3571 /*
3572 * Basic mandatory fields
3573 */
3574 if (1 + 32 + 48 + 4 > (size_t) (end - p)) {
3575 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3576 }
3577
3578 session->id_len = *p++;
3579 memcpy(session->id, p, 32);
3580 p += 32;
3581
3582 memcpy(session->master, p, 48);
3583 p += 48;
3584
3585 session->verify_result = MBEDTLS_GET_UINT32_BE(p, 0);
3586 p += 4;
3587
3588 /* Immediately clear invalid pointer values that have been read, in case
3589 * we exit early before we replaced them with valid ones. */
3590#if defined(MBEDTLS_X509_CRT_PARSE_C)
3591#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
3592 session->peer_cert = NULL;
3593#else
3594 session->peer_cert_digest = NULL;
3595#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3596#endif /* MBEDTLS_X509_CRT_PARSE_C */
3597#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
3598 session->ticket = NULL;
3599#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
3600
3601 /*
3602 * Peer certificate
3603 */
3604#if defined(MBEDTLS_X509_CRT_PARSE_C)
3605#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
3606 /* Deserialize CRT from the end of the ticket. */
3607 if (3 > (size_t) (end - p)) {
3608 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3609 }
3610
3611 cert_len = MBEDTLS_GET_UINT24_BE(p, 0);
3612 p += 3;
3613
3614 if (cert_len != 0) {
3615 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
3616
3617 if (cert_len > (size_t) (end - p)) {
3618 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3619 }
3620
3621 session->peer_cert = mbedtls_calloc(1, sizeof(mbedtls_x509_crt));
3622
3623 if (session->peer_cert == NULL) {
3624 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
3625 }
3626
3627 mbedtls_x509_crt_init(session->peer_cert);
3628
3629 if ((ret = mbedtls_x509_crt_parse_der(session->peer_cert,
3630 p, cert_len)) != 0) {
3631 mbedtls_x509_crt_free(session->peer_cert);
3632 mbedtls_free(session->peer_cert);
3633 session->peer_cert = NULL;
3634 return ret;
3635 }
3636
3637 p += cert_len;
3638 }
3639#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3640 /* Deserialize CRT digest from the end of the ticket. */
3641 if (2 > (size_t) (end - p)) {
3642 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3643 }
3644
3645 session->peer_cert_digest_type = (mbedtls_md_type_t) *p++;
3646 session->peer_cert_digest_len = (size_t) *p++;
3647
3648 if (session->peer_cert_digest_len != 0) {
3649 const mbedtls_md_info_t *md_info =
3650 mbedtls_md_info_from_type(session->peer_cert_digest_type);
3651 if (md_info == NULL) {
3652 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3653 }
3654 if (session->peer_cert_digest_len != mbedtls_md_get_size(md_info)) {
3655 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3656 }
3657
3658 if (session->peer_cert_digest_len > (size_t) (end - p)) {
3659 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3660 }
3661
3662 session->peer_cert_digest =
3663 mbedtls_calloc(1, session->peer_cert_digest_len);
3664 if (session->peer_cert_digest == NULL) {
3665 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
3666 }
3667
3668 memcpy(session->peer_cert_digest, p,
3669 session->peer_cert_digest_len);
3670 p += session->peer_cert_digest_len;
3671 }
3672#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3673#endif /* MBEDTLS_X509_CRT_PARSE_C */
3674
3675 /*
3676 * Session ticket and associated data
3677 */
3678#if defined(MBEDTLS_SSL_SESSION_TICKETS)
3679#if defined(MBEDTLS_SSL_CLI_C)
3680 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
3681 if (3 > (size_t) (end - p)) {
3682 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3683 }
3684
3685 session->ticket_len = MBEDTLS_GET_UINT24_BE(p, 0);
3686 p += 3;
3687
3688 if (session->ticket_len != 0) {
3689 if (session->ticket_len > (size_t) (end - p)) {
3690 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3691 }
3692
3693 session->ticket = mbedtls_calloc(1, session->ticket_len);
3694 if (session->ticket == NULL) {
3695 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
3696 }
3697
3698 memcpy(session->ticket, p, session->ticket_len);
3699 p += session->ticket_len;
3700 }
3701
3702 if (4 > (size_t) (end - p)) {
3703 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3704 }
3705
3706 session->ticket_lifetime = MBEDTLS_GET_UINT32_BE(p, 0);
3707 p += 4;
3708 }
3709#endif /* MBEDTLS_SSL_CLI_C */
3710#if defined(MBEDTLS_HAVE_TIME) && defined(MBEDTLS_SSL_SRV_C)
3711 if (session->endpoint == MBEDTLS_SSL_IS_SERVER) {
3712 if (8 > (size_t) (end - p)) {
3713 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3714 }
3715 session->ticket_creation_time = MBEDTLS_GET_UINT64_BE(p, 0);
3716 p += 8;
3717 }
3718#endif /* MBEDTLS_HAVE_TIME && MBEDTLS_SSL_SRV_C */
3719#endif /* MBEDTLS_SSL_SESSION_TICKETS */
3720
3721 /*
3722 * Misc extension-related info
3723 */
3724#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
3725 if (1 > (size_t) (end - p)) {
3726 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3727 }
3728
3729 session->mfl_code = *p++;
3730#endif
3731
3732#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
3733 if (1 > (size_t) (end - p)) {
3734 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3735 }
3736
3737 session->encrypt_then_mac = *p++;
3738#endif
3739
3740 /* Done, should have consumed entire buffer */
3741 if (p != end) {
3742 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3743 }
3744
3745 return 0;
3746}
3747
3748#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
3749
3750#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
3751/* Serialization of TLS 1.3 sessions:
3752 *
Waleed Elmelegy11025632024-03-07 15:25:52 +00003753 * For more detail, see the description of ssl_session_save().
David Horstmanne59f9702024-02-29 16:08:57 +00003754 */
3755#if defined(MBEDTLS_SSL_SESSION_TICKETS)
3756MBEDTLS_CHECK_RETURN_CRITICAL
3757static int ssl_tls13_session_save(const mbedtls_ssl_session *session,
3758 unsigned char *buf,
3759 size_t buf_len,
3760 size_t *olen)
3761{
3762 unsigned char *p = buf;
3763#if defined(MBEDTLS_SSL_CLI_C) && \
3764 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
3765 size_t hostname_len = (session->hostname == NULL) ?
3766 0 : strlen(session->hostname) + 1;
3767#endif
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003768
3769#if defined(MBEDTLS_SSL_SRV_C) && \
3770 defined(MBEDTLS_SSL_EARLY_DATA) && defined(MBEDTLS_SSL_ALPN)
Waleed Elmelegydaa4da72024-03-13 16:25:34 +00003771 const size_t alpn_len = (session->ticket_alpn == NULL) ?
Waleed Elmelegyb28ab0a2024-03-13 16:48:28 +00003772 0 : strlen(session->ticket_alpn) + 1;
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003773#endif
David Horstmanne59f9702024-02-29 16:08:57 +00003774 size_t needed = 4 /* ticket_age_add */
3775 + 1 /* ticket_flags */
3776 + 1; /* resumption_key length */
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003777
David Horstmanne59f9702024-02-29 16:08:57 +00003778 *olen = 0;
3779
3780 if (session->resumption_key_len > MBEDTLS_SSL_TLS1_3_TICKET_RESUMPTION_KEY_LEN) {
3781 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3782 }
3783 needed += session->resumption_key_len; /* resumption_key */
3784
3785#if defined(MBEDTLS_SSL_EARLY_DATA)
3786 needed += 4; /* max_early_data_size */
3787#endif
3788#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
3789 needed += 2; /* record_size_limit */
3790#endif /* MBEDTLS_SSL_RECORD_SIZE_LIMIT */
3791
3792#if defined(MBEDTLS_HAVE_TIME)
3793 needed += 8; /* ticket_creation_time or ticket_reception_time */
3794#endif
3795
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003796#if defined(MBEDTLS_SSL_SRV_C)
3797 if (session->endpoint == MBEDTLS_SSL_IS_SERVER) {
3798#if defined(MBEDTLS_SSL_EARLY_DATA) && defined(MBEDTLS_SSL_ALPN)
Waleed Elmelegydaa4da72024-03-13 16:25:34 +00003799 needed += 2 /* alpn_len */
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003800 + alpn_len; /* alpn */
3801#endif
3802 }
3803#endif /* MBEDTLS_SSL_SRV_C */
3804
David Horstmanne59f9702024-02-29 16:08:57 +00003805#if defined(MBEDTLS_SSL_CLI_C)
3806 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
3807#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
3808 needed += 2 /* hostname_len */
3809 + hostname_len; /* hostname */
3810#endif
3811
3812 needed += 4 /* ticket_lifetime */
3813 + 2; /* ticket_len */
3814
3815 /* Check size_t overflow */
3816 if (session->ticket_len > SIZE_MAX - needed) {
3817 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3818 }
3819
3820 needed += session->ticket_len; /* ticket */
3821 }
3822#endif /* MBEDTLS_SSL_CLI_C */
3823
3824 *olen = needed;
3825 if (needed > buf_len) {
3826 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
3827 }
3828
3829 MBEDTLS_PUT_UINT32_BE(session->ticket_age_add, p, 0);
3830 p[4] = session->ticket_flags;
3831
3832 /* save resumption_key */
3833 p[5] = session->resumption_key_len;
3834 p += 6;
3835 memcpy(p, session->resumption_key, session->resumption_key_len);
3836 p += session->resumption_key_len;
3837
3838#if defined(MBEDTLS_SSL_EARLY_DATA)
3839 MBEDTLS_PUT_UINT32_BE(session->max_early_data_size, p, 0);
3840 p += 4;
3841#endif
3842#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
3843 MBEDTLS_PUT_UINT16_BE(session->record_size_limit, p, 0);
3844 p += 2;
3845#endif /* MBEDTLS_SSL_RECORD_SIZE_LIMIT */
3846
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003847#if defined(MBEDTLS_SSL_SRV_C)
David Horstmanne59f9702024-02-29 16:08:57 +00003848 if (session->endpoint == MBEDTLS_SSL_IS_SERVER) {
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003849#if defined(MBEDTLS_HAVE_TIME)
David Horstmanne59f9702024-02-29 16:08:57 +00003850 MBEDTLS_PUT_UINT64_BE((uint64_t) session->ticket_creation_time, p, 0);
3851 p += 8;
David Horstmanne59f9702024-02-29 16:08:57 +00003852#endif /* MBEDTLS_HAVE_TIME */
3853
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003854#if defined(MBEDTLS_SSL_EARLY_DATA) && defined(MBEDTLS_SSL_ALPN)
Waleed Elmelegydaa4da72024-03-13 16:25:34 +00003855 MBEDTLS_PUT_UINT16_BE(alpn_len, p, 0);
3856 p += 2;
3857
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003858 if (alpn_len > 0) {
3859 /* save chosen alpn */
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00003860 memcpy(p, session->ticket_alpn, alpn_len);
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003861 p += alpn_len;
3862 }
3863#endif /* MBEDTLS_SSL_EARLY_DATA && MBEDTLS_SSL_ALPN */
3864 }
3865#endif /* MBEDTLS_SSL_SRV_C */
3866
David Horstmanne59f9702024-02-29 16:08:57 +00003867#if defined(MBEDTLS_SSL_CLI_C)
3868 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
3869#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
3870 MBEDTLS_PUT_UINT16_BE(hostname_len, p, 0);
3871 p += 2;
3872 if (hostname_len > 0) {
3873 /* save host name */
3874 memcpy(p, session->hostname, hostname_len);
3875 p += hostname_len;
3876 }
3877#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
3878
3879#if defined(MBEDTLS_HAVE_TIME)
3880 MBEDTLS_PUT_UINT64_BE((uint64_t) session->ticket_reception_time, p, 0);
3881 p += 8;
3882#endif
3883 MBEDTLS_PUT_UINT32_BE(session->ticket_lifetime, p, 0);
3884 p += 4;
3885
3886 MBEDTLS_PUT_UINT16_BE(session->ticket_len, p, 0);
3887 p += 2;
3888
3889 if (session->ticket != NULL && session->ticket_len > 0) {
3890 memcpy(p, session->ticket, session->ticket_len);
3891 p += session->ticket_len;
3892 }
3893 }
3894#endif /* MBEDTLS_SSL_CLI_C */
3895 return 0;
3896}
3897
3898MBEDTLS_CHECK_RETURN_CRITICAL
3899static int ssl_tls13_session_load(mbedtls_ssl_session *session,
3900 const unsigned char *buf,
3901 size_t len)
3902{
3903 const unsigned char *p = buf;
3904 const unsigned char *end = buf + len;
3905
3906 if (end - p < 6) {
3907 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3908 }
3909 session->ticket_age_add = MBEDTLS_GET_UINT32_BE(p, 0);
3910 session->ticket_flags = p[4];
3911
3912 /* load resumption_key */
3913 session->resumption_key_len = p[5];
3914 p += 6;
3915
3916 if (end - p < session->resumption_key_len) {
3917 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3918 }
3919
3920 if (sizeof(session->resumption_key) < session->resumption_key_len) {
3921 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3922 }
3923 memcpy(session->resumption_key, p, session->resumption_key_len);
3924 p += session->resumption_key_len;
3925
3926#if defined(MBEDTLS_SSL_EARLY_DATA)
3927 if (end - p < 4) {
3928 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3929 }
3930 session->max_early_data_size = MBEDTLS_GET_UINT32_BE(p, 0);
3931 p += 4;
3932#endif
3933#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
3934 if (end - p < 2) {
3935 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3936 }
3937 session->record_size_limit = MBEDTLS_GET_UINT16_BE(p, 0);
3938 p += 2;
3939#endif /* MBEDTLS_SSL_RECORD_SIZE_LIMIT */
3940
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003941#if defined(MBEDTLS_SSL_SRV_C)
David Horstmanne59f9702024-02-29 16:08:57 +00003942 if (session->endpoint == MBEDTLS_SSL_IS_SERVER) {
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003943#if defined(MBEDTLS_HAVE_TIME)
David Horstmanne59f9702024-02-29 16:08:57 +00003944 if (end - p < 8) {
3945 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3946 }
3947 session->ticket_creation_time = MBEDTLS_GET_UINT64_BE(p, 0);
3948 p += 8;
David Horstmanne59f9702024-02-29 16:08:57 +00003949#endif /* MBEDTLS_HAVE_TIME */
3950
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003951#if defined(MBEDTLS_SSL_EARLY_DATA) && defined(MBEDTLS_SSL_ALPN)
Waleed Elmelegydaa4da72024-03-13 16:25:34 +00003952 size_t alpn_len;
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003953
Waleed Elmelegydaa4da72024-03-13 16:25:34 +00003954 if (end - p < 2) {
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003955 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3956 }
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00003957
Waleed Elmelegydaa4da72024-03-13 16:25:34 +00003958 alpn_len = MBEDTLS_GET_UINT16_BE(p, 0);
3959 p += 2;
3960
3961 if (end - p < (long int) alpn_len) {
Waleed Elmelegy7dfba342024-03-12 16:22:39 +00003962 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3963 }
3964
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003965 if (alpn_len > 0) {
Waleed Elmelegydaa4da72024-03-13 16:25:34 +00003966 int ret = mbedtls_ssl_session_set_ticket_alpn(session, (char *) p);
3967 if (ret != 0) {
3968 return ret;
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003969 }
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003970 p += alpn_len;
3971 }
3972#endif /* MBEDTLS_SSL_EARLY_DATA && MBEDTLS_SSL_ALPN */
3973 }
3974#endif /* MBEDTLS_SSL_SRV_C */
3975
David Horstmanne59f9702024-02-29 16:08:57 +00003976#if defined(MBEDTLS_SSL_CLI_C)
3977 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
3978#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
3979 size_t hostname_len;
3980 /* load host name */
3981 if (end - p < 2) {
3982 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3983 }
3984 hostname_len = MBEDTLS_GET_UINT16_BE(p, 0);
3985 p += 2;
3986
3987 if (end - p < (long int) hostname_len) {
3988 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3989 }
3990 if (hostname_len > 0) {
3991 session->hostname = mbedtls_calloc(1, hostname_len);
3992 if (session->hostname == NULL) {
3993 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
3994 }
3995 memcpy(session->hostname, p, hostname_len);
3996 p += hostname_len;
3997 }
3998#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
3999
4000#if defined(MBEDTLS_HAVE_TIME)
4001 if (end - p < 8) {
4002 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4003 }
4004 session->ticket_reception_time = MBEDTLS_GET_UINT64_BE(p, 0);
4005 p += 8;
4006#endif
4007 if (end - p < 4) {
4008 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4009 }
4010 session->ticket_lifetime = MBEDTLS_GET_UINT32_BE(p, 0);
4011 p += 4;
4012
4013 if (end - p < 2) {
4014 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4015 }
4016 session->ticket_len = MBEDTLS_GET_UINT16_BE(p, 0);
4017 p += 2;
4018
4019 if (end - p < (long int) session->ticket_len) {
4020 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4021 }
4022 if (session->ticket_len > 0) {
4023 session->ticket = mbedtls_calloc(1, session->ticket_len);
4024 if (session->ticket == NULL) {
4025 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
4026 }
4027 memcpy(session->ticket, p, session->ticket_len);
4028 p += session->ticket_len;
4029 }
4030 }
4031#endif /* MBEDTLS_SSL_CLI_C */
4032
4033 return 0;
4034
4035}
4036#else /* MBEDTLS_SSL_SESSION_TICKETS */
4037MBEDTLS_CHECK_RETURN_CRITICAL
4038static int ssl_tls13_session_save(const mbedtls_ssl_session *session,
4039 unsigned char *buf,
4040 size_t buf_len,
4041 size_t *olen)
4042{
4043 ((void) session);
4044 ((void) buf);
4045 ((void) buf_len);
4046 *olen = 0;
4047 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
4048}
4049
4050static int ssl_tls13_session_load(const mbedtls_ssl_session *session,
4051 unsigned char *buf,
4052 size_t buf_len)
4053{
4054 ((void) session);
4055 ((void) buf);
4056 ((void) buf_len);
4057 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
4058}
4059#endif /* !MBEDTLS_SSL_SESSION_TICKETS */
4060#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
4061
Paul Bakker5121ce52009-01-03 21:22:43 +00004062/*
Hanno Beckera835da52019-05-16 12:39:07 +01004063 * Define ticket header determining Mbed TLS version
4064 * and structure of the ticket.
4065 */
4066
Hanno Becker94ef3b32019-05-16 12:50:45 +01004067/*
Hanno Becker50b59662019-05-28 14:30:45 +01004068 * Define bitflag determining compile-time settings influencing
4069 * structure of serialized SSL sessions.
Hanno Becker94ef3b32019-05-16 12:50:45 +01004070 */
4071
Hanno Becker50b59662019-05-28 14:30:45 +01004072#if defined(MBEDTLS_HAVE_TIME)
Hanno Becker3e088662019-05-29 11:10:18 +01004073#define SSL_SERIALIZED_SESSION_CONFIG_TIME 1
Hanno Becker50b59662019-05-28 14:30:45 +01004074#else
Hanno Becker3e088662019-05-29 11:10:18 +01004075#define SSL_SERIALIZED_SESSION_CONFIG_TIME 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01004076#endif /* MBEDTLS_HAVE_TIME */
4077
4078#if defined(MBEDTLS_X509_CRT_PARSE_C)
Hanno Becker3e088662019-05-29 11:10:18 +01004079#define SSL_SERIALIZED_SESSION_CONFIG_CRT 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01004080#else
Hanno Becker3e088662019-05-29 11:10:18 +01004081#define SSL_SERIALIZED_SESSION_CONFIG_CRT 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01004082#endif /* MBEDTLS_X509_CRT_PARSE_C */
4083
David Horstmann5c5a32f2024-02-13 17:53:35 +00004084#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
David Horstmannf686f1d2024-03-01 11:20:32 +00004085#define SSL_SERIALIZED_SESSION_CONFIG_KEEP_PEER_CRT 1
David Horstmann5c5a32f2024-02-13 17:53:35 +00004086#else
David Horstmannf686f1d2024-03-01 11:20:32 +00004087#define SSL_SERIALIZED_SESSION_CONFIG_KEEP_PEER_CRT 0
David Horstmann5c5a32f2024-02-13 17:53:35 +00004088#endif /* MBEDTLS_SSL_SESSION_TICKETS */
4089
Hanno Becker94ef3b32019-05-16 12:50:45 +01004090#if defined(MBEDTLS_SSL_CLI_C) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Hanno Becker3e088662019-05-29 11:10:18 +01004091#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01004092#else
Hanno Becker3e088662019-05-29 11:10:18 +01004093#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01004094#endif /* MBEDTLS_SSL_CLI_C && MBEDTLS_SSL_SESSION_TICKETS */
4095
4096#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Hanno Becker3e088662019-05-29 11:10:18 +01004097#define SSL_SERIALIZED_SESSION_CONFIG_MFL 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01004098#else
Hanno Becker3e088662019-05-29 11:10:18 +01004099#define SSL_SERIALIZED_SESSION_CONFIG_MFL 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01004100#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
4101
Hanno Becker94ef3b32019-05-16 12:50:45 +01004102#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Hanno Becker3e088662019-05-29 11:10:18 +01004103#define SSL_SERIALIZED_SESSION_CONFIG_ETM 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01004104#else
Hanno Becker3e088662019-05-29 11:10:18 +01004105#define SSL_SERIALIZED_SESSION_CONFIG_ETM 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01004106#endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC */
4107
Hanno Becker94ef3b32019-05-16 12:50:45 +01004108#if defined(MBEDTLS_SSL_SESSION_TICKETS)
4109#define SSL_SERIALIZED_SESSION_CONFIG_TICKET 1
4110#else
4111#define SSL_SERIALIZED_SESSION_CONFIG_TICKET 0
4112#endif /* MBEDTLS_SSL_SESSION_TICKETS */
4113
David Horstmann92b258b2024-02-13 17:23:34 +00004114#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
4115#define SSL_SERIALIZED_SESSION_CONFIG_SNI 1
4116#else
4117#define SSL_SERIALIZED_SESSION_CONFIG_SNI 0
4118#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
4119
4120#if defined(MBEDTLS_SSL_EARLY_DATA)
4121#define SSL_SERIALIZED_SESSION_CONFIG_EARLY_DATA 1
4122#else
4123#define SSL_SERIALIZED_SESSION_CONFIG_EARLY_DATA 0
4124#endif /* MBEDTLS_SSL_EARLY_DATA */
4125
4126#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
4127#define SSL_SERIALIZED_SESSION_CONFIG_RECORD_SIZE 1
4128#else
4129#define SSL_SERIALIZED_SESSION_CONFIG_RECORD_SIZE 0
4130#endif /* MBEDTLS_SSL_RECORD_SIZE_LIMIT */
4131
Waleed Elmelegy7dfba342024-03-12 16:22:39 +00004132#if defined(MBEDTLS_SSL_ALPN) && defined(MBEDTLS_SSL_SRV_C) && \
4133 defined(MBEDTLS_SSL_EARLY_DATA)
Waleed Elmelegy11025632024-03-07 15:25:52 +00004134#define SSL_SERIALIZED_SESSION_CONFIG_ALPN 1
4135#else
4136#define SSL_SERIALIZED_SESSION_CONFIG_ALPN 0
4137#endif /* MBEDTLS_SSL_ALPN */
4138
Hanno Becker3e088662019-05-29 11:10:18 +01004139#define SSL_SERIALIZED_SESSION_CONFIG_TIME_BIT 0
4140#define SSL_SERIALIZED_SESSION_CONFIG_CRT_BIT 1
4141#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET_BIT 2
4142#define SSL_SERIALIZED_SESSION_CONFIG_MFL_BIT 3
Hanno Becker37bdbe62021-08-01 05:38:58 +01004143#define SSL_SERIALIZED_SESSION_CONFIG_ETM_BIT 4
4144#define SSL_SERIALIZED_SESSION_CONFIG_TICKET_BIT 5
David Horstmannf686f1d2024-03-01 11:20:32 +00004145#define SSL_SERIALIZED_SESSION_CONFIG_KEEP_PEER_CRT_BIT 6
David Horstmann92b258b2024-02-13 17:23:34 +00004146#define SSL_SERIALIZED_SESSION_CONFIG_SNI_BIT 7
4147#define SSL_SERIALIZED_SESSION_CONFIG_EARLY_DATA_BIT 8
4148#define SSL_SERIALIZED_SESSION_CONFIG_RECORD_SIZE_BIT 9
Waleed Elmelegy11025632024-03-07 15:25:52 +00004149#define SSL_SERIALIZED_SESSION_CONFIG_ALPN_BIT 10
Hanno Becker3e088662019-05-29 11:10:18 +01004150
Hanno Becker50b59662019-05-28 14:30:45 +01004151#define SSL_SERIALIZED_SESSION_CONFIG_BITFLAG \
Gilles Peskine449bd832023-01-11 14:50:10 +01004152 ((uint16_t) ( \
4153 (SSL_SERIALIZED_SESSION_CONFIG_TIME << SSL_SERIALIZED_SESSION_CONFIG_TIME_BIT) | \
4154 (SSL_SERIALIZED_SESSION_CONFIG_CRT << SSL_SERIALIZED_SESSION_CONFIG_CRT_BIT) | \
4155 (SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET << \
4156 SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET_BIT) | \
4157 (SSL_SERIALIZED_SESSION_CONFIG_MFL << SSL_SERIALIZED_SESSION_CONFIG_MFL_BIT) | \
4158 (SSL_SERIALIZED_SESSION_CONFIG_ETM << SSL_SERIALIZED_SESSION_CONFIG_ETM_BIT) | \
David Horstmann5c5a32f2024-02-13 17:53:35 +00004159 (SSL_SERIALIZED_SESSION_CONFIG_TICKET << SSL_SERIALIZED_SESSION_CONFIG_TICKET_BIT) | \
David Horstmann71fa1a92024-03-01 12:32:18 +00004160 (SSL_SERIALIZED_SESSION_CONFIG_KEEP_PEER_CRT << \
4161 SSL_SERIALIZED_SESSION_CONFIG_KEEP_PEER_CRT_BIT) | \
David Horstmann92b258b2024-02-13 17:23:34 +00004162 (SSL_SERIALIZED_SESSION_CONFIG_SNI << SSL_SERIALIZED_SESSION_CONFIG_SNI_BIT) | \
4163 (SSL_SERIALIZED_SESSION_CONFIG_EARLY_DATA << \
4164 SSL_SERIALIZED_SESSION_CONFIG_EARLY_DATA_BIT) | \
4165 (SSL_SERIALIZED_SESSION_CONFIG_RECORD_SIZE << \
Waleed Elmelegy11025632024-03-07 15:25:52 +00004166 SSL_SERIALIZED_SESSION_CONFIG_RECORD_SIZE_BIT) | \
Waleed Elmelegy75e33fa2024-03-07 16:57:58 +00004167 (SSL_SERIALIZED_SESSION_CONFIG_ALPN << \
Waleed Elmelegy11025632024-03-07 15:25:52 +00004168 SSL_SERIALIZED_SESSION_CONFIG_ALPN_BIT)))
Hanno Becker94ef3b32019-05-16 12:50:45 +01004169
Chien Wong4e9683e2023-12-28 17:07:43 +08004170static const unsigned char ssl_serialized_session_header[] = {
Hanno Becker94ef3b32019-05-16 12:50:45 +01004171 MBEDTLS_VERSION_MAJOR,
4172 MBEDTLS_VERSION_MINOR,
4173 MBEDTLS_VERSION_PATCH,
Gilles Peskine449bd832023-01-11 14:50:10 +01004174 MBEDTLS_BYTE_1(SSL_SERIALIZED_SESSION_CONFIG_BITFLAG),
4175 MBEDTLS_BYTE_0(SSL_SERIALIZED_SESSION_CONFIG_BITFLAG),
Hanno Beckerf8787072019-05-16 12:41:07 +01004176};
Hanno Beckera835da52019-05-16 12:39:07 +01004177
4178/*
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004179 * Serialize a session in the following format:
Manuel Pégourié-Gonnard35eb8022019-05-16 11:11:08 +02004180 * (in the presentation language of TLS, RFC 8446 section 3)
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004181 *
David Horstmanncb01b362024-02-29 17:31:46 +00004182 * TLS 1.2 session:
4183 *
4184 * struct {
4185 * #if defined(MBEDTLS_SSL_SESSION_TICKETS)
4186 * opaque ticket<0..2^24-1>; // length 0 means no ticket
4187 * uint32 ticket_lifetime;
4188 * #endif
4189 * } ClientOnlyData;
4190 *
4191 * struct {
4192 * #if defined(MBEDTLS_HAVE_TIME)
4193 * uint64 start_time;
4194 * #endif
4195 * uint8 session_id_len; // at most 32
4196 * opaque session_id[32];
4197 * opaque master[48]; // fixed length in the standard
4198 * uint32 verify_result;
4199 * #if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
4200 * opaque peer_cert<0..2^24-1>; // length 0 means no peer cert
4201 * #else
David Horstmann76ba26a2024-03-01 12:03:35 +00004202 * uint8 peer_cert_digest_type;
David Horstmanncb01b362024-02-29 17:31:46 +00004203 * opaque peer_cert_digest<0..2^8-1>
4204 * #endif
4205 * select (endpoint) {
4206 * case client: ClientOnlyData;
4207 * case server: uint64 ticket_creation_time;
4208 * };
4209 * #if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
4210 * uint8 mfl_code; // up to 255 according to standard
4211 * #endif
4212 * #if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
4213 * uint8 encrypt_then_mac; // 0 or 1
4214 * #endif
4215 * } serialized_session_tls12;
4216 *
4217 *
4218 * TLS 1.3 Session:
4219 *
4220 * struct {
4221 * #if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
4222 * opaque hostname<0..2^16-1>;
4223 * #endif
4224 * #if defined(MBEDTLS_HAVE_TIME)
4225 * uint64 ticket_reception_time;
4226 * #endif
4227 * uint32 ticket_lifetime;
4228 * opaque ticket<1..2^16-1>;
4229 * } ClientOnlyData;
4230 *
4231 * struct {
4232 * uint32 ticket_age_add;
4233 * uint8 ticket_flags;
4234 * opaque resumption_key<0..255>;
4235 * #if defined(MBEDTLS_SSL_EARLY_DATA)
4236 * uint32 max_early_data_size;
4237 * #endif
4238 * #if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
4239 * uint16 record_size_limit;
4240 * #endif
4241 * select ( endpoint ) {
4242 * case client: ClientOnlyData;
Waleed Elmelegy7dfba342024-03-12 16:22:39 +00004243 * case server:
David Horstmanncb01b362024-02-29 17:31:46 +00004244 * #if defined(MBEDTLS_HAVE_TIME)
Waleed Elmelegy7dfba342024-03-12 16:22:39 +00004245 * uint64 ticket_creation_time;
David Horstmanncb01b362024-02-29 17:31:46 +00004246 * #endif
Waleed Elmelegyfe9ae082024-03-07 15:47:31 +00004247 * #if defined(MBEDTLS_SSL_EARLY_DATA) && defined(MBEDTLS_SSL_ALPN)
Waleed Elmelegydaa4da72024-03-13 16:25:34 +00004248 * opaque ticket_alpn<0..256>;
Waleed Elmelegyfe9ae082024-03-07 15:47:31 +00004249 * #endif
David Horstmanncb01b362024-02-29 17:31:46 +00004250 * };
4251 * } serialized_session_tls13;
4252 *
4253 *
4254 * SSL session:
4255 *
4256 * struct {
Hanno Beckerdc28b6c2019-05-29 11:08:00 +01004257 *
Hanno Beckerdce50972021-08-01 05:39:23 +01004258 * opaque mbedtls_version[3]; // library version: major, minor, patch
4259 * opaque session_format[2]; // library-version specific 16-bit field
4260 * // determining the format of the remaining
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004261 * // serialized data.
Hanno Beckerdc28b6c2019-05-29 11:08:00 +01004262 *
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004263 * Note: When updating the format, remember to keep
4264 * these version+format bytes.
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004265 *
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004266 * // In this version, `session_format` determines
4267 * // the setting of those compile-time
4268 * // configuration options which influence
4269 * // the structure of mbedtls_ssl_session.
4270 *
Glenn Straussda7851c2022-03-14 13:29:48 -04004271 * uint8_t minor_ver; // Protocol minor version. Possible values:
Jerry Yu0c2a7382022-12-06 13:27:25 +08004272 * // - TLS 1.2 (0x0303)
4273 * // - TLS 1.3 (0x0304)
David Horstmann531aca22024-02-29 18:14:28 +00004274 * uint8_t endpoint;
4275 * uint16_t ciphersuite;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004276 *
Glenn Straussda7851c2022-03-14 13:29:48 -04004277 * select (serialized_session.tls_version) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004278 *
Glenn Straussda7851c2022-03-14 13:29:48 -04004279 * case MBEDTLS_SSL_VERSION_TLS1_2:
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004280 * serialized_session_tls12 data;
Jerry Yu0c2a7382022-12-06 13:27:25 +08004281 * case MBEDTLS_SSL_VERSION_TLS1_3:
Jerry Yuddda0502022-12-01 19:43:12 +08004282 * serialized_session_tls13 data;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004283 *
4284 * };
4285 *
4286 * } serialized_session;
4287 *
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004288 */
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004289
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004290MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004291static int ssl_session_save(const mbedtls_ssl_session *session,
4292 unsigned char omit_header,
4293 unsigned char *buf,
4294 size_t buf_len,
4295 size_t *olen)
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004296{
4297 unsigned char *p = buf;
4298 size_t used = 0;
Jerry Yu251a12e2022-07-13 15:15:48 +08004299 size_t remaining_len;
Jerry Yue36fdd62022-08-17 21:31:36 +08004300#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
4301 size_t out_len;
4302 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
4303#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01004304 if (session == NULL) {
4305 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
4306 }
Jerry Yu438ddd82022-07-07 06:55:50 +00004307
Gilles Peskine449bd832023-01-11 14:50:10 +01004308 if (!omit_header) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004309 /*
4310 * Add Mbed TLS version identifier
4311 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004312 used += sizeof(ssl_serialized_session_header);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004313
Gilles Peskine449bd832023-01-11 14:50:10 +01004314 if (used <= buf_len) {
4315 memcpy(p, ssl_serialized_session_header,
4316 sizeof(ssl_serialized_session_header));
4317 p += sizeof(ssl_serialized_session_header);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004318 }
4319 }
4320
4321 /*
Ronald Cron40a4ab02024-01-15 10:21:30 +01004322 * TLS version identifier, endpoint, ciphersuite
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004323 */
Ronald Cron40a4ab02024-01-15 10:21:30 +01004324 used += 1 /* TLS version */
4325 + 1 /* endpoint */
4326 + 2; /* ciphersuite */
Gilles Peskine449bd832023-01-11 14:50:10 +01004327 if (used <= buf_len) {
4328 *p++ = MBEDTLS_BYTE_0(session->tls_version);
Ronald Cron40a4ab02024-01-15 10:21:30 +01004329 *p++ = session->endpoint;
4330 MBEDTLS_PUT_UINT16_BE(session->ciphersuite, p, 0);
4331 p += 2;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004332 }
4333
4334 /* Forward to version-specific serialization routine. */
Jerry Yufca4d572022-07-21 10:37:48 +08004335 remaining_len = (buf_len >= used) ? buf_len - used : 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01004336 switch (session->tls_version) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004337#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01004338 case MBEDTLS_SSL_VERSION_TLS1_2:
4339 used += ssl_tls12_session_save(session, p, remaining_len);
4340 break;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004341#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
4342
Jerry Yu251a12e2022-07-13 15:15:48 +08004343#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004344 case MBEDTLS_SSL_VERSION_TLS1_3:
4345 ret = ssl_tls13_session_save(session, p, remaining_len, &out_len);
4346 if (ret != 0 && ret != MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL) {
4347 return ret;
4348 }
4349 used += out_len;
4350 break;
Jerry Yu251a12e2022-07-13 15:15:48 +08004351#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
4352
Gilles Peskine449bd832023-01-11 14:50:10 +01004353 default:
4354 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004355 }
4356
4357 *olen = used;
Gilles Peskine449bd832023-01-11 14:50:10 +01004358 if (used > buf_len) {
4359 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
4360 }
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004361
Gilles Peskine449bd832023-01-11 14:50:10 +01004362 return 0;
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004363}
4364
4365/*
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02004366 * Public wrapper for ssl_session_save()
4367 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004368int mbedtls_ssl_session_save(const mbedtls_ssl_session *session,
4369 unsigned char *buf,
4370 size_t buf_len,
4371 size_t *olen)
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02004372{
Gilles Peskine449bd832023-01-11 14:50:10 +01004373 return ssl_session_save(session, 0, buf, buf_len, olen);
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02004374}
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004375
Jerry Yuf1b23ca2022-02-18 11:48:47 +08004376/*
4377 * Deserialize session, see mbedtls_ssl_session_save() for format.
4378 *
4379 * This internal version is wrapped by a public function that cleans up in
4380 * case of error, and has an extra option omit_header.
4381 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004382MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004383static int ssl_session_load(mbedtls_ssl_session *session,
4384 unsigned char omit_header,
4385 const unsigned char *buf,
4386 size_t len)
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004387{
4388 const unsigned char *p = buf;
4389 const unsigned char * const end = buf + len;
Jerry Yu438ddd82022-07-07 06:55:50 +00004390 size_t remaining_len;
4391
4392
Gilles Peskine449bd832023-01-11 14:50:10 +01004393 if (session == NULL) {
4394 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
4395 }
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004396
Gilles Peskine449bd832023-01-11 14:50:10 +01004397 if (!omit_header) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004398 /*
4399 * Check Mbed TLS version identifier
4400 */
4401
Gilles Peskine449bd832023-01-11 14:50:10 +01004402 if ((size_t) (end - p) < sizeof(ssl_serialized_session_header)) {
4403 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004404 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004405
4406 if (memcmp(p, ssl_serialized_session_header,
4407 sizeof(ssl_serialized_session_header)) != 0) {
4408 return MBEDTLS_ERR_SSL_VERSION_MISMATCH;
4409 }
4410 p += sizeof(ssl_serialized_session_header);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004411 }
4412
4413 /*
Ronald Cron40a4ab02024-01-15 10:21:30 +01004414 * TLS version identifier, endpoint, ciphersuite
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004415 */
Ronald Cron40a4ab02024-01-15 10:21:30 +01004416 if (4 > (size_t) (end - p)) {
Gilles Peskine449bd832023-01-11 14:50:10 +01004417 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4418 }
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01004419 session->tls_version = (mbedtls_ssl_protocol_version) (0x0300 | *p++);
Ronald Cron40a4ab02024-01-15 10:21:30 +01004420 session->endpoint = *p++;
4421 session->ciphersuite = MBEDTLS_GET_UINT16_BE(p, 0);
4422 p += 2;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004423
4424 /* Dispatch according to TLS version. */
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00004425 remaining_len = (size_t) (end - p);
Gilles Peskine449bd832023-01-11 14:50:10 +01004426 switch (session->tls_version) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004427#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01004428 case MBEDTLS_SSL_VERSION_TLS1_2:
4429 return ssl_tls12_session_load(session, p, remaining_len);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004430#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
4431
Jerry Yu438ddd82022-07-07 06:55:50 +00004432#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004433 case MBEDTLS_SSL_VERSION_TLS1_3:
4434 return ssl_tls13_session_load(session, p, remaining_len);
Jerry Yu438ddd82022-07-07 06:55:50 +00004435#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
4436
Gilles Peskine449bd832023-01-11 14:50:10 +01004437 default:
4438 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004439 }
4440}
4441
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004442/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02004443 * Deserialize session: public wrapper for error cleaning
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02004444 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004445int mbedtls_ssl_session_load(mbedtls_ssl_session *session,
4446 const unsigned char *buf,
4447 size_t len)
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02004448{
Gilles Peskine449bd832023-01-11 14:50:10 +01004449 int ret = ssl_session_load(session, 0, buf, len);
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02004450
Gilles Peskine449bd832023-01-11 14:50:10 +01004451 if (ret != 0) {
4452 mbedtls_ssl_session_free(session);
4453 }
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02004454
Gilles Peskine449bd832023-01-11 14:50:10 +01004455 return ret;
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02004456}
4457
4458/*
Paul Bakker1961b702013-01-25 14:49:24 +01004459 * Perform a single step of the SSL handshake
Paul Bakker5121ce52009-01-03 21:22:43 +00004460 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004461MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004462static int ssl_prepare_handshake_step(mbedtls_ssl_context *ssl)
Hanno Becker41934dd2021-08-07 19:13:43 +01004463{
4464 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
4465
Ronald Cron66dbf912022-02-02 15:33:46 +01004466 /*
4467 * We may have not been able to send to the peer all the handshake data
Ronald Cron3f20b772022-03-08 16:00:02 +01004468 * that were written into the output buffer by the previous handshake step,
4469 * if the write to the network callback returned with the
Ronald Cron66dbf912022-02-02 15:33:46 +01004470 * #MBEDTLS_ERR_SSL_WANT_WRITE error code.
4471 * We proceed to the next handshake step only when all data from the
4472 * previous one have been sent to the peer, thus we make sure that this is
4473 * the case here by calling `mbedtls_ssl_flush_output()`. The function may
4474 * return with the #MBEDTLS_ERR_SSL_WANT_WRITE error code in which case
4475 * we have to wait before to go ahead.
4476 * In the case of TLS 1.3, handshake step handlers do not send data to the
4477 * peer. Data are only sent here and through
4478 * `mbedtls_ssl_handle_pending_alert` in case an error that triggered an
Andrzej Kurek5c65c572022-04-13 14:28:52 -04004479 * alert occurred.
Ronald Cron66dbf912022-02-02 15:33:46 +01004480 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004481 if ((ret = mbedtls_ssl_flush_output(ssl)) != 0) {
4482 return ret;
4483 }
Hanno Becker41934dd2021-08-07 19:13:43 +01004484
4485#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004486 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
4487 ssl->handshake->retransmit_state == MBEDTLS_SSL_RETRANS_SENDING) {
4488 if ((ret = mbedtls_ssl_flight_transmit(ssl)) != 0) {
4489 return ret;
4490 }
Hanno Becker41934dd2021-08-07 19:13:43 +01004491 }
4492#endif /* MBEDTLS_SSL_PROTO_DTLS */
4493
Gilles Peskine449bd832023-01-11 14:50:10 +01004494 return ret;
Hanno Becker41934dd2021-08-07 19:13:43 +01004495}
4496
Gilles Peskine449bd832023-01-11 14:50:10 +01004497int mbedtls_ssl_handshake_step(mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00004498{
Hanno Becker41934dd2021-08-07 19:13:43 +01004499 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00004500
Gilles Peskine449bd832023-01-11 14:50:10 +01004501 if (ssl == NULL ||
Hanno Becker41934dd2021-08-07 19:13:43 +01004502 ssl->conf == NULL ||
4503 ssl->handshake == NULL ||
Gilles Peskine449bd832023-01-11 14:50:10 +01004504 ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER) {
4505 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Becker41934dd2021-08-07 19:13:43 +01004506 }
4507
Gilles Peskine449bd832023-01-11 14:50:10 +01004508 ret = ssl_prepare_handshake_step(ssl);
4509 if (ret != 0) {
4510 return ret;
4511 }
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02004512
Gilles Peskine449bd832023-01-11 14:50:10 +01004513 ret = mbedtls_ssl_handle_pending_alert(ssl);
4514 if (ret != 0) {
Jerry Yue7047812021-09-13 19:26:39 +08004515 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01004516 }
Jerry Yue7047812021-09-13 19:26:39 +08004517
Tom Cosgrove2fdc7b32022-09-21 12:33:17 +01004518 /* If ssl->conf->endpoint is not one of MBEDTLS_SSL_IS_CLIENT or
4519 * MBEDTLS_SSL_IS_SERVER, this is the return code we give */
4520 ret = MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4521
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004522#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004523 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
4524 MBEDTLS_SSL_DEBUG_MSG(2, ("client state: %s",
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01004525 mbedtls_ssl_states_str((mbedtls_ssl_states) ssl->state)));
Jerry Yub9930e72021-08-06 17:11:51 +08004526
Gilles Peskine449bd832023-01-11 14:50:10 +01004527 switch (ssl->state) {
Ronald Cron9f0fba32022-02-10 16:45:15 +01004528 case MBEDTLS_SSL_HELLO_REQUEST:
4529 ssl->state = MBEDTLS_SSL_CLIENT_HELLO;
Tom Cosgrove87d9c6c2022-09-22 09:27:56 +01004530 ret = 0;
Ronald Cron9f0fba32022-02-10 16:45:15 +01004531 break;
Jerry Yub9930e72021-08-06 17:11:51 +08004532
Ronald Cron9f0fba32022-02-10 16:45:15 +01004533 case MBEDTLS_SSL_CLIENT_HELLO:
Gilles Peskine449bd832023-01-11 14:50:10 +01004534 ret = mbedtls_ssl_write_client_hello(ssl);
Ronald Cron9f0fba32022-02-10 16:45:15 +01004535 break;
4536
4537 default:
4538#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004539 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
4540 ret = mbedtls_ssl_tls13_handshake_client_step(ssl);
4541 } else {
4542 ret = mbedtls_ssl_handshake_client_step(ssl);
4543 }
Ronald Cron9f0fba32022-02-10 16:45:15 +01004544#elif defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01004545 ret = mbedtls_ssl_handshake_client_step(ssl);
Ronald Cron9f0fba32022-02-10 16:45:15 +01004546#else
Gilles Peskine449bd832023-01-11 14:50:10 +01004547 ret = mbedtls_ssl_tls13_handshake_client_step(ssl);
Ronald Cron9f0fba32022-02-10 16:45:15 +01004548#endif
4549 }
Jerry Yub9930e72021-08-06 17:11:51 +08004550 }
Ronald Cron6291b232023-03-08 15:51:25 +01004551#endif /* MBEDTLS_SSL_CLI_C */
4552
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004553#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004554 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Ronald Cron6291b232023-03-08 15:51:25 +01004555#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
4556 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Gilles Peskine449bd832023-01-11 14:50:10 +01004557 ret = mbedtls_ssl_tls13_handshake_server_step(ssl);
Ronald Cron6291b232023-03-08 15:51:25 +01004558 } else {
Gilles Peskine449bd832023-01-11 14:50:10 +01004559 ret = mbedtls_ssl_handshake_server_step(ssl);
4560 }
Ronald Cron6291b232023-03-08 15:51:25 +01004561#elif defined(MBEDTLS_SSL_PROTO_TLS1_2)
4562 ret = mbedtls_ssl_handshake_server_step(ssl);
4563#else
4564 ret = mbedtls_ssl_tls13_handshake_server_step(ssl);
Paul Bakker5121ce52009-01-03 21:22:43 +00004565#endif
Ronald Cron6291b232023-03-08 15:51:25 +01004566 }
4567#endif /* MBEDTLS_SSL_SRV_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00004568
Gilles Peskine449bd832023-01-11 14:50:10 +01004569 if (ret != 0) {
Jerry Yubbd5a3f2021-09-18 20:50:22 +08004570 /* handshake_step return error. And it is same
4571 * with alert_reason.
4572 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004573 if (ssl->send_alert) {
4574 ret = mbedtls_ssl_handle_pending_alert(ssl);
Jerry Yue7047812021-09-13 19:26:39 +08004575 goto cleanup;
4576 }
4577 }
4578
4579cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +01004580 return ret;
Paul Bakker1961b702013-01-25 14:49:24 +01004581}
4582
4583/*
4584 * Perform the SSL handshake
4585 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004586int mbedtls_ssl_handshake(mbedtls_ssl_context *ssl)
Paul Bakker1961b702013-01-25 14:49:24 +01004587{
4588 int ret = 0;
4589
Hanno Beckera817ea42020-10-20 15:20:23 +01004590 /* Sanity checks */
4591
Gilles Peskine449bd832023-01-11 14:50:10 +01004592 if (ssl == NULL || ssl->conf == NULL) {
4593 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4594 }
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02004595
Hanno Beckera817ea42020-10-20 15:20:23 +01004596#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004597 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
4598 (ssl->f_set_timer == NULL || ssl->f_get_timer == NULL)) {
4599 MBEDTLS_SSL_DEBUG_MSG(1, ("You must use "
4600 "mbedtls_ssl_set_timer_cb() for DTLS"));
4601 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Beckera817ea42020-10-20 15:20:23 +01004602 }
4603#endif /* MBEDTLS_SSL_PROTO_DTLS */
4604
Gilles Peskine449bd832023-01-11 14:50:10 +01004605 MBEDTLS_SSL_DEBUG_MSG(2, ("=> handshake"));
Paul Bakker1961b702013-01-25 14:49:24 +01004606
Hanno Beckera817ea42020-10-20 15:20:23 +01004607 /* Main handshake loop */
Gilles Peskine449bd832023-01-11 14:50:10 +01004608 while (ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER) {
4609 ret = mbedtls_ssl_handshake_step(ssl);
Paul Bakker1961b702013-01-25 14:49:24 +01004610
Gilles Peskine449bd832023-01-11 14:50:10 +01004611 if (ret != 0) {
Paul Bakker1961b702013-01-25 14:49:24 +01004612 break;
Gilles Peskine449bd832023-01-11 14:50:10 +01004613 }
Paul Bakker1961b702013-01-25 14:49:24 +01004614 }
4615
Gilles Peskine449bd832023-01-11 14:50:10 +01004616 MBEDTLS_SSL_DEBUG_MSG(2, ("<= handshake"));
Paul Bakker5121ce52009-01-03 21:22:43 +00004617
Gilles Peskine449bd832023-01-11 14:50:10 +01004618 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00004619}
4620
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004621#if defined(MBEDTLS_SSL_RENEGOTIATION)
4622#if defined(MBEDTLS_SSL_SRV_C)
Paul Bakker5121ce52009-01-03 21:22:43 +00004623/*
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004624 * Write HelloRequest to request renegotiation on server
Paul Bakker48916f92012-09-16 19:57:18 +00004625 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004626MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004627static int ssl_write_hello_request(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004628{
Janos Follath865b3eb2019-12-16 11:46:15 +00004629 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004630
Gilles Peskine449bd832023-01-11 14:50:10 +01004631 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write hello request"));
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004632
4633 ssl->out_msglen = 4;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004634 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
4635 ssl->out_msg[0] = MBEDTLS_SSL_HS_HELLO_REQUEST;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004636
Gilles Peskine449bd832023-01-11 14:50:10 +01004637 if ((ret = mbedtls_ssl_write_handshake_msg(ssl)) != 0) {
4638 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_handshake_msg", ret);
4639 return ret;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004640 }
4641
Gilles Peskine449bd832023-01-11 14:50:10 +01004642 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write hello request"));
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004643
Gilles Peskine449bd832023-01-11 14:50:10 +01004644 return 0;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004645}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004646#endif /* MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004647
4648/*
4649 * Actually renegotiate current connection, triggered by either:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004650 * - any side: calling mbedtls_ssl_renegotiate(),
4651 * - client: receiving a HelloRequest during mbedtls_ssl_read(),
4652 * - server: receiving any handshake message on server during mbedtls_ssl_read() after
Manuel Pégourié-Gonnard55e4ff22014-08-19 11:16:35 +02004653 * the initial handshake is completed.
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004654 * If the handshake doesn't complete due to waiting for I/O, it will continue
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004655 * during the next calls to mbedtls_ssl_renegotiate() or mbedtls_ssl_read() respectively.
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004656 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004657int mbedtls_ssl_start_renegotiation(mbedtls_ssl_context *ssl)
Paul Bakker48916f92012-09-16 19:57:18 +00004658{
Janos Follath865b3eb2019-12-16 11:46:15 +00004659 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker48916f92012-09-16 19:57:18 +00004660
Gilles Peskine449bd832023-01-11 14:50:10 +01004661 MBEDTLS_SSL_DEBUG_MSG(2, ("=> renegotiate"));
Paul Bakker48916f92012-09-16 19:57:18 +00004662
Gilles Peskine449bd832023-01-11 14:50:10 +01004663 if ((ret = ssl_handshake_init(ssl)) != 0) {
4664 return ret;
4665 }
Paul Bakker48916f92012-09-16 19:57:18 +00004666
Manuel Pégourié-Gonnard0557bd52014-08-19 19:18:39 +02004667 /* RFC 6347 4.2.2: "[...] the HelloRequest will have message_seq = 0 and
4668 * the ServerHello will have message_seq = 1" */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004669#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004670 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
4671 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING) {
4672 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02004673 ssl->handshake->out_msg_seq = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004674 } else {
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02004675 ssl->handshake->in_msg_seq = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004676 }
Manuel Pégourié-Gonnard0557bd52014-08-19 19:18:39 +02004677 }
4678#endif
4679
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004680 ssl->state = MBEDTLS_SSL_HELLO_REQUEST;
4681 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS;
Paul Bakker48916f92012-09-16 19:57:18 +00004682
Gilles Peskine449bd832023-01-11 14:50:10 +01004683 if ((ret = mbedtls_ssl_handshake(ssl)) != 0) {
4684 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_handshake", ret);
4685 return ret;
Paul Bakker48916f92012-09-16 19:57:18 +00004686 }
4687
Gilles Peskine449bd832023-01-11 14:50:10 +01004688 MBEDTLS_SSL_DEBUG_MSG(2, ("<= renegotiate"));
Paul Bakker48916f92012-09-16 19:57:18 +00004689
Gilles Peskine449bd832023-01-11 14:50:10 +01004690 return 0;
Paul Bakker48916f92012-09-16 19:57:18 +00004691}
4692
4693/*
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004694 * Renegotiate current connection on client,
4695 * or request renegotiation on server
4696 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004697int mbedtls_ssl_renegotiate(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004698{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004699 int ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004700
Gilles Peskine449bd832023-01-11 14:50:10 +01004701 if (ssl == NULL || ssl->conf == NULL) {
4702 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4703 }
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02004704
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004705#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004706 /* On server, just send the request */
Gilles Peskine449bd832023-01-11 14:50:10 +01004707 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
4708 if (mbedtls_ssl_is_handshake_over(ssl) == 0) {
4709 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4710 }
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004711
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004712 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_PENDING;
Manuel Pégourié-Gonnardf07f4212014-08-15 19:04:47 +02004713
4714 /* Did we already try/start sending HelloRequest? */
Gilles Peskine449bd832023-01-11 14:50:10 +01004715 if (ssl->out_left != 0) {
4716 return mbedtls_ssl_flush_output(ssl);
4717 }
Manuel Pégourié-Gonnardf07f4212014-08-15 19:04:47 +02004718
Gilles Peskine449bd832023-01-11 14:50:10 +01004719 return ssl_write_hello_request(ssl);
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004720 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004721#endif /* MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004722
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004723#if defined(MBEDTLS_SSL_CLI_C)
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004724 /*
4725 * On client, either start the renegotiation process or,
4726 * if already in progress, continue the handshake
4727 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004728 if (ssl->renego_status != MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS) {
4729 if (mbedtls_ssl_is_handshake_over(ssl) == 0) {
4730 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004731 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004732
4733 if ((ret = mbedtls_ssl_start_renegotiation(ssl)) != 0) {
4734 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_start_renegotiation", ret);
4735 return ret;
4736 }
4737 } else {
4738 if ((ret = mbedtls_ssl_handshake(ssl)) != 0) {
4739 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_handshake", ret);
4740 return ret;
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004741 }
4742 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004743#endif /* MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004744
Gilles Peskine449bd832023-01-11 14:50:10 +01004745 return ret;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004746}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004747#endif /* MBEDTLS_SSL_RENEGOTIATION */
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004748
Gilles Peskine449bd832023-01-11 14:50:10 +01004749void mbedtls_ssl_handshake_free(mbedtls_ssl_context *ssl)
Paul Bakker48916f92012-09-16 19:57:18 +00004750{
Gilles Peskine9b562d52018-04-25 20:32:43 +02004751 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
4752
Gilles Peskine449bd832023-01-11 14:50:10 +01004753 if (handshake == NULL) {
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004754 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01004755 }
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004756
Valerio Setti6f0441d2023-07-03 12:11:36 +02004757#if defined(MBEDTLS_PK_HAVE_ECC_KEYS)
Brett Warrene0edc842021-08-17 09:53:13 +01004758#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004759 if (ssl->handshake->group_list_heap_allocated) {
4760 mbedtls_free((void *) handshake->group_list);
4761 }
Brett Warrene0edc842021-08-17 09:53:13 +01004762 handshake->group_list = NULL;
4763#endif /* MBEDTLS_DEPRECATED_REMOVED */
Valerio Setti6f0441d2023-07-03 12:11:36 +02004764#endif /* MBEDTLS_PK_HAVE_ECC_KEYS */
Brett Warrene0edc842021-08-17 09:53:13 +01004765
Ronald Crone68ab4f2022-10-05 12:46:29 +02004766#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yuf017ee42022-01-12 15:49:48 +08004767#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004768 if (ssl->handshake->sig_algs_heap_allocated) {
4769 mbedtls_free((void *) handshake->sig_algs);
4770 }
Jerry Yuf017ee42022-01-12 15:49:48 +08004771 handshake->sig_algs = NULL;
4772#endif /* MBEDTLS_DEPRECATED_REMOVED */
Xiaofei Baic234ecf2022-02-08 09:59:23 +00004773#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004774 if (ssl->handshake->certificate_request_context) {
4775 mbedtls_free((void *) handshake->certificate_request_context);
Xiaofei Baic234ecf2022-02-08 09:59:23 +00004776 }
4777#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Ronald Crone68ab4f2022-10-05 12:46:29 +02004778#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Jerry Yuf017ee42022-01-12 15:49:48 +08004779
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02004780#if defined(MBEDTLS_SSL_ASYNC_PRIVATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01004781 if (ssl->conf->f_async_cancel != NULL && handshake->async_in_progress != 0) {
4782 ssl->conf->f_async_cancel(ssl);
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02004783 handshake->async_in_progress = 0;
4784 }
4785#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
4786
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01004787#if defined(MBEDTLS_MD_CAN_SHA256)
Andrzej Kurekeb342242019-01-29 09:14:33 -05004788#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01004789 psa_hash_abort(&handshake->fin_sha256_psa);
Andrzej Kurekeb342242019-01-29 09:14:33 -05004790#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01004791 mbedtls_md_free(&handshake->fin_sha256);
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02004792#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -05004793#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01004794#if defined(MBEDTLS_MD_CAN_SHA384)
Andrzej Kurekeb342242019-01-29 09:14:33 -05004795#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01004796 psa_hash_abort(&handshake->fin_sha384_psa);
Andrzej Kurekeb342242019-01-29 09:14:33 -05004797#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01004798 mbedtls_md_free(&handshake->fin_sha384);
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02004799#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -05004800#endif
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02004801
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004802#if defined(MBEDTLS_DHM_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004803 mbedtls_dhm_free(&handshake->dhm_ctx);
Paul Bakker48916f92012-09-16 19:57:18 +00004804#endif
Valerio Setti7aeec542023-07-05 18:57:21 +02004805#if !defined(MBEDTLS_USE_PSA_CRYPTO) && \
Valerio Setti6eb00542023-07-07 17:04:24 +02004806 defined(MBEDTLS_KEY_EXCHANGE_SOME_ECDH_OR_ECDHE_1_2_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004807 mbedtls_ecdh_free(&handshake->ecdh_ctx);
Paul Bakker61d113b2013-07-04 11:51:43 +02004808#endif
Valerio Setti02c25b52022-11-15 14:08:42 +01004809
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02004810#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Neil Armstrongca7d5062022-05-31 14:43:23 +02004811#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01004812 psa_pake_abort(&handshake->psa_pake_ctx);
Valerio Settieb3f7882022-12-08 18:42:58 +01004813 /*
4814 * Opaque keys are not stored in the handshake's data and it's the user
4815 * responsibility to destroy them. Clear ones, instead, are created by
4816 * the TLS library and should be destroyed at the same level
4817 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004818 if (!mbedtls_svc_key_id_is_null(handshake->psa_pake_password)) {
4819 psa_destroy_key(handshake->psa_pake_password);
Valerio Settieb3f7882022-12-08 18:42:58 +01004820 }
Neil Armstrongca7d5062022-05-31 14:43:23 +02004821 handshake->psa_pake_password = MBEDTLS_SVC_KEY_ID_INIT;
4822#else
Gilles Peskine449bd832023-01-11 14:50:10 +01004823 mbedtls_ecjpake_free(&handshake->ecjpake_ctx);
Neil Armstrongca7d5062022-05-31 14:43:23 +02004824#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard77c06462015-09-17 13:59:49 +02004825#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004826 mbedtls_free(handshake->ecjpake_cache);
Manuel Pégourié-Gonnard77c06462015-09-17 13:59:49 +02004827 handshake->ecjpake_cache = NULL;
4828 handshake->ecjpake_cache_len = 0;
4829#endif
Manuel Pégourié-Gonnard76cfd3f2015-09-15 12:10:54 +02004830#endif
Paul Bakker61d113b2013-07-04 11:51:43 +02004831
Valerio Setti7aeec542023-07-05 18:57:21 +02004832#if defined(MBEDTLS_KEY_EXCHANGE_SOME_ECDH_OR_ECDHE_ANY_ENABLED) || \
Valerio Setti45d56f32023-07-13 17:23:20 +02004833 defined(MBEDTLS_KEY_EXCHANGE_WITH_ECDSA_ANY_ENABLED) || \
Janos Follath4ae5c292016-02-10 11:27:43 +00004834 defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Paul Bakker9af723c2014-05-01 13:03:14 +02004835 /* explicit void pointer cast for buggy MS compiler */
Gilles Peskine449bd832023-01-11 14:50:10 +01004836 mbedtls_free((void *) handshake->curves_tls_id);
Manuel Pégourié-Gonnardd09453c2013-09-23 19:11:32 +02004837#endif
4838
Ronald Cron73fe8df2022-10-05 14:31:43 +02004839#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED)
Neil Armstrong501c9322022-05-03 09:35:09 +02004840#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01004841 if (!mbedtls_svc_key_id_is_null(ssl->handshake->psk_opaque)) {
Neil Armstrong501c9322022-05-03 09:35:09 +02004842 /* The maintenance of the external PSK key slot is the
4843 * user's responsibility. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004844 if (ssl->handshake->psk_opaque_is_internal) {
4845 psa_destroy_key(ssl->handshake->psk_opaque);
Neil Armstrong501c9322022-05-03 09:35:09 +02004846 ssl->handshake->psk_opaque_is_internal = 0;
4847 }
4848 ssl->handshake->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
4849 }
Neil Armstronge952a302022-05-03 10:22:14 +02004850#else
Gilles Peskine449bd832023-01-11 14:50:10 +01004851 if (handshake->psk != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01004852 mbedtls_zeroize_and_free(handshake->psk, handshake->psk_len);
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01004853 }
Neil Armstronge952a302022-05-03 10:22:14 +02004854#endif /* MBEDTLS_USE_PSA_CRYPTO */
Ronald Cron73fe8df2022-10-05 14:31:43 +02004855#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED */
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01004856
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004857#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
4858 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Manuel Pégourié-Gonnard83724542013-09-24 22:30:56 +02004859 /*
4860 * Free only the linked list wrapper, not the keys themselves
4861 * since the belong to the SNI callback
4862 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004863 ssl_key_cert_free(handshake->sni_key_cert);
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004864#endif /* MBEDTLS_X509_CRT_PARSE_C && MBEDTLS_SSL_SERVER_NAME_INDICATION */
Manuel Pégourié-Gonnard705fcca2013-09-23 20:04:20 +02004865
Gilles Peskineeccd8882020-03-10 12:19:08 +01004866#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004867 mbedtls_x509_crt_restart_free(&handshake->ecrs_ctx);
4868 if (handshake->ecrs_peer_cert != NULL) {
4869 mbedtls_x509_crt_free(handshake->ecrs_peer_cert);
4870 mbedtls_free(handshake->ecrs_peer_cert);
Hanno Becker3dad3112019-02-05 17:19:52 +00004871 }
Manuel Pégourié-Gonnard862cde52017-05-17 11:56:15 +02004872#endif
4873
Hanno Becker75173122019-02-06 16:18:31 +00004874#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
4875 !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01004876 mbedtls_pk_free(&handshake->peer_pubkey);
Hanno Becker75173122019-02-06 16:18:31 +00004877#endif /* MBEDTLS_X509_CRT_PARSE_C && !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
4878
XiaokangQian9b93c0d2022-02-09 06:02:25 +00004879#if defined(MBEDTLS_SSL_CLI_C) && \
Gilles Peskine449bd832023-01-11 14:50:10 +01004880 (defined(MBEDTLS_SSL_PROTO_DTLS) || defined(MBEDTLS_SSL_PROTO_TLS1_3))
4881 mbedtls_free(handshake->cookie);
XiaokangQian9b93c0d2022-02-09 06:02:25 +00004882#endif /* MBEDTLS_SSL_CLI_C &&
4883 ( MBEDTLS_SSL_PROTO_DTLS || MBEDTLS_SSL_PROTO_TLS1_3 ) */
XiaokangQian8499b6c2022-01-27 09:00:11 +00004884
4885#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004886 mbedtls_ssl_flight_free(handshake->flight);
4887 mbedtls_ssl_buffering_free(ssl);
XiaokangQian8499b6c2022-01-27 09:00:11 +00004888#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard74848812014-07-11 02:43:49 +02004889
Valerio Settiea59c432023-07-25 11:14:03 +02004890#if defined(MBEDTLS_KEY_EXCHANGE_SOME_XXDH_PSA_ANY_ENABLED)
Przemek Stekiel7ac93be2023-07-04 10:02:38 +02004891 if (handshake->xxdh_psa_privkey_is_external == 0) {
4892 psa_destroy_key(handshake->xxdh_psa_privkey);
Gilles Peskine449bd832023-01-11 14:50:10 +01004893 }
Valerio Settiea59c432023-07-25 11:14:03 +02004894#endif /* MBEDTLS_KEY_EXCHANGE_SOME_XXDH_PSA_ANY_ENABLED */
Hanno Becker4a63ed42019-01-08 11:39:35 +00004895
Ronald Cron6f135e12021-12-08 16:57:54 +01004896#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004897 mbedtls_ssl_transform_free(handshake->transform_handshake);
4898 mbedtls_free(handshake->transform_handshake);
Jerry Yu3d9b5902022-11-04 14:07:25 +08004899#if defined(MBEDTLS_SSL_EARLY_DATA)
Gilles Peskine449bd832023-01-11 14:50:10 +01004900 mbedtls_ssl_transform_free(handshake->transform_earlydata);
4901 mbedtls_free(handshake->transform_earlydata);
Jerry Yu3d9b5902022-11-04 14:07:25 +08004902#endif
Ronald Cron6f135e12021-12-08 16:57:54 +01004903#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yuba9c7272021-10-30 11:54:10 +08004904
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05004905
4906#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
4907 /* If the buffers are too big - reallocate. Because of the way Mbed TLS
4908 * processes datagrams and the fact that a datagram is allowed to have
4909 * several records in it, it is possible that the I/O buffers are not
4910 * empty at this stage */
Gilles Peskine449bd832023-01-11 14:50:10 +01004911 handle_buffer_resizing(ssl, 1, mbedtls_ssl_get_input_buflen(ssl),
4912 mbedtls_ssl_get_output_buflen(ssl));
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05004913#endif
Hanno Becker3aa186f2021-08-10 09:24:19 +01004914
Jerry Yuba9c7272021-10-30 11:54:10 +08004915 /* mbedtls_platform_zeroize MUST be last one in this function */
Gilles Peskine449bd832023-01-11 14:50:10 +01004916 mbedtls_platform_zeroize(handshake,
4917 sizeof(mbedtls_ssl_handshake_params));
Paul Bakker48916f92012-09-16 19:57:18 +00004918}
4919
Gilles Peskine449bd832023-01-11 14:50:10 +01004920void mbedtls_ssl_session_free(mbedtls_ssl_session *session)
Paul Bakker48916f92012-09-16 19:57:18 +00004921{
Gilles Peskine449bd832023-01-11 14:50:10 +01004922 if (session == NULL) {
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004923 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01004924 }
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004925
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004926#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004927 ssl_clear_peer_cert(session);
Paul Bakkered27a042013-04-18 22:46:23 +02004928#endif
Paul Bakker0a597072012-09-25 21:55:46 +00004929
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02004930#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
Xiaokang Qianbc663a02022-10-09 11:14:39 +00004931#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && \
4932 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01004933 mbedtls_free(session->hostname);
Xiaokang Qian281fd1b2022-09-20 11:35:41 +00004934#endif
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00004935 mbedtls_free(session->ticket);
4936#endif
4937
Waleed Elmelegy2824a202024-02-23 17:51:47 +00004938#if defined(MBEDTLS_SSL_EARLY_DATA) && defined(MBEDTLS_SSL_ALPN) && \
4939 defined(MBEDTLS_SSL_SRV_C)
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00004940 mbedtls_free(session->ticket_alpn);
Paul Bakkera503a632013-08-14 13:48:06 +02004941#endif
Manuel Pégourié-Gonnard75d44012013-08-02 14:44:04 +02004942
Gilles Peskine449bd832023-01-11 14:50:10 +01004943 mbedtls_platform_zeroize(session, sizeof(mbedtls_ssl_session));
Paul Bakker48916f92012-09-16 19:57:18 +00004944}
4945
Manuel Pégourié-Gonnard5c0e3772019-07-23 16:13:17 +02004946#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004947
4948#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
4949#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID 1u
4950#else
4951#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID 0u
4952#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
4953
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004954#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT 1u
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004955
4956#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
4957#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY 1u
4958#else
4959#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY 0u
4960#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
4961
4962#if defined(MBEDTLS_SSL_ALPN)
4963#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN 1u
4964#else
4965#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN 0u
4966#endif /* MBEDTLS_SSL_ALPN */
4967
4968#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID_BIT 0
4969#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT_BIT 1
4970#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY_BIT 2
4971#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN_BIT 3
4972
4973#define SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG \
Gilles Peskine449bd832023-01-11 14:50:10 +01004974 ((uint32_t) ( \
4975 (SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID << \
4976 SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID_BIT) | \
4977 (SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT << \
4978 SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT_BIT) | \
4979 (SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY << \
4980 SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY_BIT) | \
4981 (SSL_SERIALIZED_CONTEXT_CONFIG_ALPN << SSL_SERIALIZED_CONTEXT_CONFIG_ALPN_BIT) | \
4982 0u))
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004983
Chien Wong4e9683e2023-12-28 17:07:43 +08004984static const unsigned char ssl_serialized_context_header[] = {
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004985 MBEDTLS_VERSION_MAJOR,
4986 MBEDTLS_VERSION_MINOR,
4987 MBEDTLS_VERSION_PATCH,
Gilles Peskine449bd832023-01-11 14:50:10 +01004988 MBEDTLS_BYTE_1(SSL_SERIALIZED_SESSION_CONFIG_BITFLAG),
4989 MBEDTLS_BYTE_0(SSL_SERIALIZED_SESSION_CONFIG_BITFLAG),
4990 MBEDTLS_BYTE_2(SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG),
4991 MBEDTLS_BYTE_1(SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG),
4992 MBEDTLS_BYTE_0(SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG),
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004993};
4994
Paul Bakker5121ce52009-01-03 21:22:43 +00004995/*
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004996 * Serialize a full SSL context
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02004997 *
4998 * The format of the serialized data is:
4999 * (in the presentation language of TLS, RFC 8446 section 3)
5000 *
5001 * // header
5002 * opaque mbedtls_version[3]; // major, minor, patch
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005003 * opaque context_format[5]; // version-specific field determining
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02005004 * // the format of the remaining
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005005 * // serialized data.
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02005006 * Note: When updating the format, remember to keep these
5007 * version+format bytes. (We may make their size part of the API.)
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02005008 *
5009 * // session sub-structure
5010 * opaque session<1..2^32-1>; // see mbedtls_ssl_session_save()
5011 * // transform sub-structure
5012 * uint8 random[64]; // ServerHello.random+ClientHello.random
5013 * uint8 in_cid<0..2^8-1> // Connection ID: expected incoming value
5014 * uint8 out_cid<0..2^8-1> // Connection ID: outgoing value to use
5015 * // fields from ssl_context
5016 * uint32 badmac_seen; // DTLS: number of records with failing MAC
5017 * uint64 in_window_top; // DTLS: last validated record seq_num
5018 * uint64 in_window; // DTLS: bitmask for replay protection
5019 * uint8 disable_datagram_packing; // DTLS: only one record per datagram
5020 * uint64 cur_out_ctr; // Record layer: outgoing sequence number
5021 * uint16 mtu; // DTLS: path mtu (max outgoing fragment size)
5022 * uint8 alpn_chosen<0..2^8-1> // ALPN: negotiated application protocol
5023 *
5024 * Note that many fields of the ssl_context or sub-structures are not
5025 * serialized, as they fall in one of the following categories:
5026 *
5027 * 1. forced value (eg in_left must be 0)
5028 * 2. pointer to dynamically-allocated memory (eg session, transform)
5029 * 3. value can be re-derived from other data (eg session keys from MS)
5030 * 4. value was temporary (eg content of input buffer)
5031 * 5. value will be provided by the user again (eg I/O callbacks and context)
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005032 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005033int mbedtls_ssl_context_save(mbedtls_ssl_context *ssl,
5034 unsigned char *buf,
5035 size_t buf_len,
5036 size_t *olen)
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005037{
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005038 unsigned char *p = buf;
5039 size_t used = 0;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005040 size_t session_len;
5041 int ret = 0;
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005042
Manuel Pégourié-Gonnard1aaf6692019-07-10 14:14:05 +02005043 /*
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02005044 * Enforce usage restrictions, see "return BAD_INPUT_DATA" in
5045 * this function's documentation.
5046 *
5047 * These are due to assumptions/limitations in the implementation. Some of
5048 * them are likely to stay (no handshake in progress) some might go away
5049 * (only DTLS) but are currently used to simplify the implementation.
Manuel Pégourié-Gonnard1aaf6692019-07-10 14:14:05 +02005050 */
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02005051 /* The initial handshake must be over */
Gilles Peskine449bd832023-01-11 14:50:10 +01005052 if (mbedtls_ssl_is_handshake_over(ssl) == 0) {
5053 MBEDTLS_SSL_DEBUG_MSG(1, ("Initial handshake isn't over"));
5054 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03005055 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005056 if (ssl->handshake != NULL) {
5057 MBEDTLS_SSL_DEBUG_MSG(1, ("Handshake isn't completed"));
5058 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03005059 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02005060 /* Double-check that sub-structures are indeed ready */
Gilles Peskine449bd832023-01-11 14:50:10 +01005061 if (ssl->transform == NULL || ssl->session == NULL) {
5062 MBEDTLS_SSL_DEBUG_MSG(1, ("Serialised structures aren't ready"));
5063 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03005064 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02005065 /* There must be no pending incoming or outgoing data */
Gilles Peskine449bd832023-01-11 14:50:10 +01005066 if (mbedtls_ssl_check_pending(ssl) != 0) {
5067 MBEDTLS_SSL_DEBUG_MSG(1, ("There is pending incoming data"));
5068 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03005069 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005070 if (ssl->out_left != 0) {
5071 MBEDTLS_SSL_DEBUG_MSG(1, ("There is pending outgoing data"));
5072 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03005073 }
Dave Rodgman556e8a32022-12-06 16:31:25 +00005074 /* Protocol must be DTLS, not TLS */
Gilles Peskine449bd832023-01-11 14:50:10 +01005075 if (ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
5076 MBEDTLS_SSL_DEBUG_MSG(1, ("Only DTLS is supported"));
5077 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03005078 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02005079 /* Version must be 1.2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005080 if (ssl->tls_version != MBEDTLS_SSL_VERSION_TLS1_2) {
5081 MBEDTLS_SSL_DEBUG_MSG(1, ("Only version 1.2 supported"));
5082 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03005083 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02005084 /* We must be using an AEAD ciphersuite */
Gilles Peskine449bd832023-01-11 14:50:10 +01005085 if (mbedtls_ssl_transform_uses_aead(ssl->transform) != 1) {
5086 MBEDTLS_SSL_DEBUG_MSG(1, ("Only AEAD ciphersuites supported"));
5087 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03005088 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02005089 /* Renegotiation must not be enabled */
5090#if defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01005091 if (ssl->conf->disable_renegotiation != MBEDTLS_SSL_RENEGOTIATION_DISABLED) {
5092 MBEDTLS_SSL_DEBUG_MSG(1, ("Renegotiation must not be enabled"));
5093 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03005094 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02005095#endif
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005096
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005097 /*
5098 * Version and format identifier
5099 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005100 used += sizeof(ssl_serialized_context_header);
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005101
Gilles Peskine449bd832023-01-11 14:50:10 +01005102 if (used <= buf_len) {
5103 memcpy(p, ssl_serialized_context_header,
5104 sizeof(ssl_serialized_context_header));
5105 p += sizeof(ssl_serialized_context_header);
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005106 }
5107
5108 /*
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005109 * Session (length + data)
5110 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005111 ret = ssl_session_save(ssl->session, 1, NULL, 0, &session_len);
5112 if (ret != MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL) {
5113 return ret;
5114 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005115
5116 used += 4 + session_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01005117 if (used <= buf_len) {
5118 MBEDTLS_PUT_UINT32_BE(session_len, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01005119 p += 4;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005120
Gilles Peskine449bd832023-01-11 14:50:10 +01005121 ret = ssl_session_save(ssl->session, 1,
5122 p, session_len, &session_len);
5123 if (ret != 0) {
5124 return ret;
5125 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005126
5127 p += session_len;
5128 }
5129
5130 /*
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005131 * Transform
5132 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005133 used += sizeof(ssl->transform->randbytes);
5134 if (used <= buf_len) {
5135 memcpy(p, ssl->transform->randbytes,
5136 sizeof(ssl->transform->randbytes));
5137 p += sizeof(ssl->transform->randbytes);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005138 }
5139
5140#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Dave Rodgmanc37ad442023-11-03 23:36:06 +00005141 used += 2U + ssl->transform->in_cid_len + ssl->transform->out_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01005142 if (used <= buf_len) {
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005143 *p++ = ssl->transform->in_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01005144 memcpy(p, ssl->transform->in_cid, ssl->transform->in_cid_len);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005145 p += ssl->transform->in_cid_len;
5146
5147 *p++ = ssl->transform->out_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01005148 memcpy(p, ssl->transform->out_cid, ssl->transform->out_cid_len);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005149 p += ssl->transform->out_cid_len;
5150 }
5151#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
5152
5153 /*
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005154 * Saved fields from top-level ssl_context structure
5155 */
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005156 used += 4;
Gilles Peskine449bd832023-01-11 14:50:10 +01005157 if (used <= buf_len) {
5158 MBEDTLS_PUT_UINT32_BE(ssl->badmac_seen, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01005159 p += 4;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005160 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005161
5162#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
5163 used += 16;
Gilles Peskine449bd832023-01-11 14:50:10 +01005164 if (used <= buf_len) {
5165 MBEDTLS_PUT_UINT64_BE(ssl->in_window_top, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01005166 p += 8;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005167
Gilles Peskine449bd832023-01-11 14:50:10 +01005168 MBEDTLS_PUT_UINT64_BE(ssl->in_window, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01005169 p += 8;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005170 }
5171#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
5172
5173#if defined(MBEDTLS_SSL_PROTO_DTLS)
5174 used += 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01005175 if (used <= buf_len) {
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005176 *p++ = ssl->disable_datagram_packing;
5177 }
5178#endif /* MBEDTLS_SSL_PROTO_DTLS */
5179
Jerry Yuae0b2e22021-10-08 15:21:19 +08005180 used += MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Gilles Peskine449bd832023-01-11 14:50:10 +01005181 if (used <= buf_len) {
5182 memcpy(p, ssl->cur_out_ctr, MBEDTLS_SSL_SEQUENCE_NUMBER_LEN);
Jerry Yuae0b2e22021-10-08 15:21:19 +08005183 p += MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005184 }
5185
5186#if defined(MBEDTLS_SSL_PROTO_DTLS)
5187 used += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01005188 if (used <= buf_len) {
5189 MBEDTLS_PUT_UINT16_BE(ssl->mtu, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01005190 p += 2;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005191 }
5192#endif /* MBEDTLS_SSL_PROTO_DTLS */
5193
5194#if defined(MBEDTLS_SSL_ALPN)
5195 {
5196 const uint8_t alpn_len = ssl->alpn_chosen
Gilles Peskine449bd832023-01-11 14:50:10 +01005197 ? (uint8_t) strlen(ssl->alpn_chosen)
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005198 : 0;
5199
5200 used += 1 + alpn_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01005201 if (used <= buf_len) {
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005202 *p++ = alpn_len;
5203
Gilles Peskine449bd832023-01-11 14:50:10 +01005204 if (ssl->alpn_chosen != NULL) {
5205 memcpy(p, ssl->alpn_chosen, alpn_len);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005206 p += alpn_len;
5207 }
5208 }
5209 }
5210#endif /* MBEDTLS_SSL_ALPN */
5211
5212 /*
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005213 * Done
5214 */
5215 *olen = used;
5216
Gilles Peskine449bd832023-01-11 14:50:10 +01005217 if (used > buf_len) {
5218 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
5219 }
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005220
Gilles Peskine449bd832023-01-11 14:50:10 +01005221 MBEDTLS_SSL_DEBUG_BUF(4, "saved context", buf, used);
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005222
Gilles Peskine449bd832023-01-11 14:50:10 +01005223 return mbedtls_ssl_session_reset_int(ssl, 0);
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005224}
5225
5226/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02005227 * Deserialize context, see mbedtls_ssl_context_save() for format.
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005228 *
5229 * This internal version is wrapped by a public function that cleans up in
5230 * case of error.
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005231 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005232MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01005233static int ssl_context_load(mbedtls_ssl_context *ssl,
5234 const unsigned char *buf,
5235 size_t len)
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005236{
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005237 const unsigned char *p = buf;
5238 const unsigned char * const end = buf + len;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005239 size_t session_len;
Janos Follath865b3eb2019-12-16 11:46:15 +00005240 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04005241#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Andrzej Kurek894edde2022-09-29 06:31:14 -04005242 tls_prf_fn prf_func = NULL;
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04005243#endif
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005244
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02005245 /*
5246 * The context should have been freshly setup or reset.
5247 * Give the user an error in case of obvious misuse.
Manuel Pégourié-Gonnard4ca930f2019-07-26 16:31:53 +02005248 * (Checking session is useful because it won't be NULL if we're
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02005249 * renegotiating, or if the user mistakenly loaded a session first.)
5250 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005251 if (ssl->state != MBEDTLS_SSL_HELLO_REQUEST ||
5252 ssl->session != NULL) {
5253 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02005254 }
5255
5256 /*
5257 * We can't check that the config matches the initial one, but we can at
5258 * least check it matches the requirements for serializing.
5259 */
Dave Rodgmane99b24d2023-09-14 15:45:03 +01005260 if (
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02005261#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard9a96fd72019-07-23 17:11:24 +02005262 ssl->conf->disable_renegotiation != MBEDTLS_SSL_RENEGOTIATION_DISABLED ||
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02005263#endif
Dave Rodgmane99b24d2023-09-14 15:45:03 +01005264 ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM ||
5265 ssl->conf->max_tls_version < MBEDTLS_SSL_VERSION_TLS1_2 ||
5266 ssl->conf->min_tls_version > MBEDTLS_SSL_VERSION_TLS1_2
5267 ) {
Gilles Peskine449bd832023-01-11 14:50:10 +01005268 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02005269 }
5270
Gilles Peskine449bd832023-01-11 14:50:10 +01005271 MBEDTLS_SSL_DEBUG_BUF(4, "context to load", buf, len);
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005272
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005273 /*
5274 * Check version identifier
5275 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005276 if ((size_t) (end - p) < sizeof(ssl_serialized_context_header)) {
5277 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005278 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005279
5280 if (memcmp(p, ssl_serialized_context_header,
5281 sizeof(ssl_serialized_context_header)) != 0) {
5282 return MBEDTLS_ERR_SSL_VERSION_MISMATCH;
5283 }
5284 p += sizeof(ssl_serialized_context_header);
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005285
5286 /*
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005287 * Session
5288 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005289 if ((size_t) (end - p) < 4) {
5290 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5291 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005292
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01005293 session_len = MBEDTLS_GET_UINT32_BE(p, 0);
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005294 p += 4;
5295
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02005296 /* This has been allocated by ssl_handshake_init(), called by
Hanno Becker43aefe22020-02-05 10:44:56 +00005297 * by either mbedtls_ssl_session_reset_int() or mbedtls_ssl_setup(). */
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02005298 ssl->session = ssl->session_negotiate;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005299 ssl->session_in = ssl->session;
5300 ssl->session_out = ssl->session;
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02005301 ssl->session_negotiate = NULL;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005302
Gilles Peskine449bd832023-01-11 14:50:10 +01005303 if ((size_t) (end - p) < session_len) {
5304 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5305 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005306
Gilles Peskine449bd832023-01-11 14:50:10 +01005307 ret = ssl_session_load(ssl->session, 1, p, session_len);
5308 if (ret != 0) {
5309 mbedtls_ssl_session_free(ssl->session);
5310 return ret;
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02005311 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005312
5313 p += session_len;
5314
5315 /*
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005316 * Transform
5317 */
5318
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02005319 /* This has been allocated by ssl_handshake_init(), called by
Hanno Becker43aefe22020-02-05 10:44:56 +00005320 * by either mbedtls_ssl_session_reset_int() or mbedtls_ssl_setup(). */
Jerry Yu2e199812022-12-01 18:57:19 +08005321#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02005322 ssl->transform = ssl->transform_negotiate;
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005323 ssl->transform_in = ssl->transform;
5324 ssl->transform_out = ssl->transform;
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02005325 ssl->transform_negotiate = NULL;
Jerry Yu2e199812022-12-01 18:57:19 +08005326#endif
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005327
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04005328#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005329 prf_func = ssl_tls12prf_from_cs(ssl->session->ciphersuite);
5330 if (prf_func == NULL) {
5331 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5332 }
Andrzej Kurek894edde2022-09-29 06:31:14 -04005333
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005334 /* Read random bytes and populate structure */
Gilles Peskine449bd832023-01-11 14:50:10 +01005335 if ((size_t) (end - p) < sizeof(ssl->transform->randbytes)) {
5336 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5337 }
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04005338
Gilles Peskine449bd832023-01-11 14:50:10 +01005339 ret = ssl_tls12_populate_transform(ssl->transform,
5340 ssl->session->ciphersuite,
5341 ssl->session->master,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02005342#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01005343 ssl->session->encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02005344#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01005345 prf_func,
5346 p, /* currently pointing to randbytes */
5347 MBEDTLS_SSL_VERSION_TLS1_2, /* (D)TLS 1.2 is forced */
5348 ssl->conf->endpoint,
5349 ssl);
5350 if (ret != 0) {
5351 return ret;
5352 }
Jerry Yu840fbb22022-02-17 14:59:29 +08005353#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005354 p += sizeof(ssl->transform->randbytes);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005355
5356#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
5357 /* Read connection IDs and store them */
Gilles Peskine449bd832023-01-11 14:50:10 +01005358 if ((size_t) (end - p) < 1) {
5359 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5360 }
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005361
5362 ssl->transform->in_cid_len = *p++;
5363
Gilles Peskine449bd832023-01-11 14:50:10 +01005364 if ((size_t) (end - p) < ssl->transform->in_cid_len + 1u) {
5365 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5366 }
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005367
Gilles Peskine449bd832023-01-11 14:50:10 +01005368 memcpy(ssl->transform->in_cid, p, ssl->transform->in_cid_len);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005369 p += ssl->transform->in_cid_len;
5370
5371 ssl->transform->out_cid_len = *p++;
5372
Gilles Peskine449bd832023-01-11 14:50:10 +01005373 if ((size_t) (end - p) < ssl->transform->out_cid_len) {
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->out_cid, p, ssl->transform->out_cid_len);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005378 p += ssl->transform->out_cid_len;
5379#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
5380
5381 /*
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005382 * Saved fields from top-level ssl_context structure
5383 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005384 if ((size_t) (end - p) < 4) {
5385 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5386 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005387
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01005388 ssl->badmac_seen = MBEDTLS_GET_UINT32_BE(p, 0);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005389 p += 4;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005390
5391#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Gilles Peskine449bd832023-01-11 14:50:10 +01005392 if ((size_t) (end - p) < 16) {
5393 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5394 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005395
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01005396 ssl->in_window_top = MBEDTLS_GET_UINT64_BE(p, 0);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005397 p += 8;
5398
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01005399 ssl->in_window = MBEDTLS_GET_UINT64_BE(p, 0);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005400 p += 8;
5401#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
5402
5403#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005404 if ((size_t) (end - p) < 1) {
5405 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5406 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005407
5408 ssl->disable_datagram_packing = *p++;
5409#endif /* MBEDTLS_SSL_PROTO_DTLS */
5410
Gilles Peskine449bd832023-01-11 14:50:10 +01005411 if ((size_t) (end - p) < sizeof(ssl->cur_out_ctr)) {
5412 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5413 }
5414 memcpy(ssl->cur_out_ctr, p, sizeof(ssl->cur_out_ctr));
5415 p += sizeof(ssl->cur_out_ctr);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005416
5417#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005418 if ((size_t) (end - p) < 2) {
5419 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5420 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005421
Dave Rodgmana3d0f612023-11-03 23:34:02 +00005422 ssl->mtu = MBEDTLS_GET_UINT16_BE(p, 0);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005423 p += 2;
5424#endif /* MBEDTLS_SSL_PROTO_DTLS */
5425
5426#if defined(MBEDTLS_SSL_ALPN)
5427 {
5428 uint8_t alpn_len;
5429 const char **cur;
5430
Gilles Peskine449bd832023-01-11 14:50:10 +01005431 if ((size_t) (end - p) < 1) {
5432 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5433 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005434
5435 alpn_len = *p++;
5436
Gilles Peskine449bd832023-01-11 14:50:10 +01005437 if (alpn_len != 0 && ssl->conf->alpn_list != NULL) {
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005438 /* alpn_chosen should point to an item in the configured list */
Gilles Peskine449bd832023-01-11 14:50:10 +01005439 for (cur = ssl->conf->alpn_list; *cur != NULL; cur++) {
5440 if (strlen(*cur) == alpn_len &&
Waleed Elmelegy131b2ff2024-03-14 01:39:39 +00005441 memcmp(p, *cur, alpn_len) == 0) {
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005442 ssl->alpn_chosen = *cur;
5443 break;
5444 }
5445 }
5446 }
5447
5448 /* can only happen on conf mismatch */
Gilles Peskine449bd832023-01-11 14:50:10 +01005449 if (alpn_len != 0 && ssl->alpn_chosen == NULL) {
5450 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5451 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005452
5453 p += alpn_len;
5454 }
5455#endif /* MBEDTLS_SSL_ALPN */
5456
5457 /*
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02005458 * Forced fields from top-level ssl_context structure
5459 *
5460 * Most of them already set to the correct value by mbedtls_ssl_init() and
5461 * mbedtls_ssl_reset(), so we only need to set the remaining ones.
5462 */
5463 ssl->state = MBEDTLS_SSL_HANDSHAKE_OVER;
Glenn Strauss60bfe602022-03-14 19:04:24 -04005464 ssl->tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02005465
Hanno Becker361b10d2019-08-30 10:42:49 +01005466 /* Adjust pointers for header fields of outgoing records to
5467 * the given transform, accounting for explicit IV and CID. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005468 mbedtls_ssl_update_out_pointers(ssl, ssl->transform);
Hanno Becker361b10d2019-08-30 10:42:49 +01005469
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02005470#if defined(MBEDTLS_SSL_PROTO_DTLS)
5471 ssl->in_epoch = 1;
5472#endif
5473
5474 /* mbedtls_ssl_reset() leaves the handshake sub-structure allocated,
5475 * which we don't want - otherwise we'd end up freeing the wrong transform
Hanno Beckerce5f5fd2020-02-05 10:47:44 +00005476 * by calling mbedtls_ssl_handshake_wrapup_free_hs_transform()
5477 * inappropriately. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005478 if (ssl->handshake != NULL) {
5479 mbedtls_ssl_handshake_free(ssl);
5480 mbedtls_free(ssl->handshake);
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02005481 ssl->handshake = NULL;
5482 }
5483
5484 /*
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005485 * Done - should have consumed entire buffer
5486 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005487 if (p != end) {
5488 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5489 }
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005490
Gilles Peskine449bd832023-01-11 14:50:10 +01005491 return 0;
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005492}
5493
5494/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02005495 * Deserialize context: public wrapper for error cleaning
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005496 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005497int mbedtls_ssl_context_load(mbedtls_ssl_context *context,
5498 const unsigned char *buf,
5499 size_t len)
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005500{
Gilles Peskine449bd832023-01-11 14:50:10 +01005501 int ret = ssl_context_load(context, buf, len);
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005502
Gilles Peskine449bd832023-01-11 14:50:10 +01005503 if (ret != 0) {
5504 mbedtls_ssl_free(context);
5505 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005506
Gilles Peskine449bd832023-01-11 14:50:10 +01005507 return ret;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005508}
Manuel Pégourié-Gonnard5c0e3772019-07-23 16:13:17 +02005509#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005510
5511/*
Paul Bakker5121ce52009-01-03 21:22:43 +00005512 * Free an SSL context
5513 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005514void mbedtls_ssl_free(mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00005515{
Gilles Peskine449bd832023-01-11 14:50:10 +01005516 if (ssl == NULL) {
Paul Bakkeraccaffe2014-06-26 13:37:14 +02005517 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01005518 }
Paul Bakkeraccaffe2014-06-26 13:37:14 +02005519
Gilles Peskine449bd832023-01-11 14:50:10 +01005520 MBEDTLS_SSL_DEBUG_MSG(2, ("=> free"));
Paul Bakker5121ce52009-01-03 21:22:43 +00005521
Gilles Peskine449bd832023-01-11 14:50:10 +01005522 if (ssl->out_buf != NULL) {
sander-visserb8aa2072020-05-06 22:05:13 +02005523#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
5524 size_t out_buf_len = ssl->out_buf_len;
5525#else
5526 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
5527#endif
5528
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005529 mbedtls_zeroize_and_free(ssl->out_buf, out_buf_len);
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05005530 ssl->out_buf = NULL;
Paul Bakker5121ce52009-01-03 21:22:43 +00005531 }
5532
Gilles Peskine449bd832023-01-11 14:50:10 +01005533 if (ssl->in_buf != NULL) {
sander-visserb8aa2072020-05-06 22:05:13 +02005534#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
5535 size_t in_buf_len = ssl->in_buf_len;
5536#else
5537 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
5538#endif
5539
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005540 mbedtls_zeroize_and_free(ssl->in_buf, in_buf_len);
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05005541 ssl->in_buf = NULL;
Paul Bakker5121ce52009-01-03 21:22:43 +00005542 }
5543
Gilles Peskine449bd832023-01-11 14:50:10 +01005544 if (ssl->transform) {
5545 mbedtls_ssl_transform_free(ssl->transform);
5546 mbedtls_free(ssl->transform);
Paul Bakker48916f92012-09-16 19:57:18 +00005547 }
5548
Gilles Peskine449bd832023-01-11 14:50:10 +01005549 if (ssl->handshake) {
5550 mbedtls_ssl_handshake_free(ssl);
5551 mbedtls_free(ssl->handshake);
Jerry Yu2e199812022-12-01 18:57:19 +08005552
5553#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005554 mbedtls_ssl_transform_free(ssl->transform_negotiate);
5555 mbedtls_free(ssl->transform_negotiate);
Jerry Yu2e199812022-12-01 18:57:19 +08005556#endif
5557
Gilles Peskine449bd832023-01-11 14:50:10 +01005558 mbedtls_ssl_session_free(ssl->session_negotiate);
5559 mbedtls_free(ssl->session_negotiate);
Paul Bakker48916f92012-09-16 19:57:18 +00005560 }
5561
Ronald Cron6f135e12021-12-08 16:57:54 +01005562#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01005563 mbedtls_ssl_transform_free(ssl->transform_application);
5564 mbedtls_free(ssl->transform_application);
Ronald Cron6f135e12021-12-08 16:57:54 +01005565#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker3aa186f2021-08-10 09:24:19 +01005566
Gilles Peskine449bd832023-01-11 14:50:10 +01005567 if (ssl->session) {
5568 mbedtls_ssl_session_free(ssl->session);
5569 mbedtls_free(ssl->session);
Paul Bakkerc0463502013-02-14 11:19:38 +01005570 }
5571
Manuel Pégourié-Gonnard55fab2d2015-05-11 16:15:19 +02005572#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005573 if (ssl->hostname != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005574 mbedtls_zeroize_and_free(ssl->hostname, strlen(ssl->hostname));
Paul Bakker5121ce52009-01-03 21:22:43 +00005575 }
Paul Bakker0be444a2013-08-27 21:55:01 +02005576#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00005577
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02005578#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005579 mbedtls_free(ssl->cli_id);
Manuel Pégourié-Gonnard43c02182014-07-22 17:32:01 +02005580#endif
5581
Gilles Peskine449bd832023-01-11 14:50:10 +01005582 MBEDTLS_SSL_DEBUG_MSG(2, ("<= free"));
Paul Bakker2da561c2009-02-05 18:00:28 +00005583
Paul Bakker86f04f42013-02-14 11:20:09 +01005584 /* Actually clear after last debug message */
Gilles Peskine449bd832023-01-11 14:50:10 +01005585 mbedtls_platform_zeroize(ssl, sizeof(mbedtls_ssl_context));
Paul Bakker5121ce52009-01-03 21:22:43 +00005586}
5587
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005588/*
Shaun Case8b0ecbc2021-12-20 21:14:10 -08005589 * Initialize mbedtls_ssl_config
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005590 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005591void mbedtls_ssl_config_init(mbedtls_ssl_config *conf)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005592{
Gilles Peskine449bd832023-01-11 14:50:10 +01005593 memset(conf, 0, sizeof(mbedtls_ssl_config));
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005594}
5595
Gilles Peskineae270bf2021-06-02 00:05:29 +02005596/* The selection should be the same as mbedtls_x509_crt_profile_default in
5597 * x509_crt.c, plus Montgomery curves for ECDHE. Here, the order matters:
Gilles Peskineb1940a72021-06-02 15:18:12 +02005598 * curves with a lower resource usage come first.
Gilles Peskineae270bf2021-06-02 00:05:29 +02005599 * See the documentation of mbedtls_ssl_conf_curves() for what we promise
Gilles Peskineb1940a72021-06-02 15:18:12 +02005600 * about this list.
5601 */
Chien Wong4e9683e2023-12-28 17:07:43 +08005602static const uint16_t ssl_preset_default_groups[] = {
Valerio Settidb6b4db2023-09-01 09:20:51 +02005603#if defined(MBEDTLS_ECP_HAVE_CURVE25519)
Brett Warrene0edc842021-08-17 09:53:13 +01005604 MBEDTLS_SSL_IANA_TLS_GROUP_X25519,
Gilles Peskineae270bf2021-06-02 00:05:29 +02005605#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005606#if defined(MBEDTLS_ECP_HAVE_SECP256R1)
Brett Warrene0edc842021-08-17 09:53:13 +01005607 MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1,
Gilles Peskineae270bf2021-06-02 00:05:29 +02005608#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005609#if defined(MBEDTLS_ECP_HAVE_SECP384R1)
Brett Warrene0edc842021-08-17 09:53:13 +01005610 MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02005611#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005612#if defined(MBEDTLS_ECP_HAVE_CURVE448)
Brett Warrene0edc842021-08-17 09:53:13 +01005613 MBEDTLS_SSL_IANA_TLS_GROUP_X448,
Gilles Peskineb1940a72021-06-02 15:18:12 +02005614#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005615#if defined(MBEDTLS_ECP_HAVE_SECP521R1)
Brett Warrene0edc842021-08-17 09:53:13 +01005616 MBEDTLS_SSL_IANA_TLS_GROUP_SECP521R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02005617#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005618#if defined(MBEDTLS_ECP_HAVE_BP256R1)
Brett Warrene0edc842021-08-17 09:53:13 +01005619 MBEDTLS_SSL_IANA_TLS_GROUP_BP256R1,
Gilles Peskineae270bf2021-06-02 00:05:29 +02005620#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005621#if defined(MBEDTLS_ECP_HAVE_BP384R1)
Brett Warrene0edc842021-08-17 09:53:13 +01005622 MBEDTLS_SSL_IANA_TLS_GROUP_BP384R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02005623#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005624#if defined(MBEDTLS_ECP_HAVE_BP512R1)
Brett Warrene0edc842021-08-17 09:53:13 +01005625 MBEDTLS_SSL_IANA_TLS_GROUP_BP512R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02005626#endif
Przemek Stekiel316c19e2023-05-31 15:25:11 +02005627#if defined(PSA_WANT_ALG_FFDH)
Przemek Stekiel383f4712022-12-12 14:48:57 +01005628 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE2048,
5629 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE3072,
5630 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE4096,
5631 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE6144,
5632 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE8192,
5633#endif
Brett Warrene0edc842021-08-17 09:53:13 +01005634 MBEDTLS_SSL_IANA_TLS_GROUP_NONE
Gilles Peskineae270bf2021-06-02 00:05:29 +02005635};
Gilles Peskineae270bf2021-06-02 00:05:29 +02005636
Alexey Tsvetkov2ca34372022-06-07 10:21:05 +03005637static const int ssl_preset_suiteb_ciphersuites[] = {
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005638 MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256,
5639 MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384,
5640 0
5641};
5642
Ronald Crone68ab4f2022-10-05 12:46:29 +02005643#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Hanno Becker9c6aa7b2021-08-10 13:50:43 +01005644
Jerry Yu909df7b2022-01-22 11:56:27 +08005645/* NOTICE:
Jerry Yu0b994b82022-01-25 17:22:12 +08005646 * For ssl_preset_*_sig_algs and ssl_tls12_preset_*_sig_algs, the following
Jerry Yu370e1462022-01-25 10:36:53 +08005647 * rules SHOULD be upheld.
5648 * - No duplicate entries.
5649 * - But if there is a good reason, do not change the order of the algorithms.
Jerry Yu09a99fc2022-07-28 14:22:17 +08005650 * - ssl_tls12_preset* is for TLS 1.2 use only.
Jerry Yu370e1462022-01-25 10:36:53 +08005651 * - ssl_preset_* is for TLS 1.3 only or hybrid TLS 1.3/1.2 handshakes.
Jerry Yu1a8b4812022-01-20 17:56:50 +08005652 */
Chien Wong4e9683e2023-12-28 17:07:43 +08005653static const uint16_t ssl_preset_default_sig_algs[] = {
Jerry Yu1a8b4812022-01-20 17:56:50 +08005654
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005655#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005656 defined(MBEDTLS_MD_CAN_SHA256) && \
Valerio Setticf29c5d2023-09-01 09:03:41 +02005657 defined(PSA_WANT_ECC_SECP_R1_256)
Jerry Yued5e9f42022-01-26 11:21:34 +08005658 MBEDTLS_TLS1_3_SIG_ECDSA_SECP256R1_SHA256,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005659 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256)
5660#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08005661
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005662#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005663 defined(MBEDTLS_MD_CAN_SHA384) && \
Valerio Setticf29c5d2023-09-01 09:03:41 +02005664 defined(PSA_WANT_ECC_SECP_R1_384)
Jerry Yu909df7b2022-01-22 11:56:27 +08005665 MBEDTLS_TLS1_3_SIG_ECDSA_SECP384R1_SHA384,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005666 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384)
5667#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08005668
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005669#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005670 defined(MBEDTLS_MD_CAN_SHA512) && \
Valerio Setticf29c5d2023-09-01 09:03:41 +02005671 defined(PSA_WANT_ECC_SECP_R1_521)
Jerry Yued5e9f42022-01-26 11:21:34 +08005672 MBEDTLS_TLS1_3_SIG_ECDSA_SECP521R1_SHA512,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005673 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA512)
5674#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08005675
Yanray Wang1136fad2023-11-22 16:54:31 +08005676#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && defined(MBEDTLS_MD_CAN_SHA512)
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005677 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA512,
Yanray Wang1136fad2023-11-22 16:54:31 +08005678#endif
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005679
Yanray Wang1136fad2023-11-22 16:54:31 +08005680#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && defined(MBEDTLS_MD_CAN_SHA384)
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005681 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA384,
Yanray Wang1136fad2023-11-22 16:54:31 +08005682#endif
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005683
Yanray Wang1136fad2023-11-22 16:54:31 +08005684#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && defined(MBEDTLS_MD_CAN_SHA256)
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005685 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256,
Yanray Wang1136fad2023-11-22 16:54:31 +08005686#endif
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005687
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005688#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_MD_CAN_SHA512)
Jerry Yu693a47a2022-06-23 14:02:28 +08005689 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA512,
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005690#endif /* MBEDTLS_RSA_C && MBEDTLS_MD_CAN_SHA512 */
Jerry Yu693a47a2022-06-23 14:02:28 +08005691
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005692#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_MD_CAN_SHA384)
Jerry Yu693a47a2022-06-23 14:02:28 +08005693 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA384,
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005694#endif /* MBEDTLS_RSA_C && MBEDTLS_MD_CAN_SHA384 */
Jerry Yu693a47a2022-06-23 14:02:28 +08005695
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005696#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_MD_CAN_SHA256)
Jerry Yu693a47a2022-06-23 14:02:28 +08005697 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA256,
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005698#endif /* MBEDTLS_RSA_C && MBEDTLS_MD_CAN_SHA256 */
Jerry Yu693a47a2022-06-23 14:02:28 +08005699
Gabor Mezei15b95a62022-05-09 16:37:58 +02005700 MBEDTLS_TLS_SIG_NONE
Jerry Yu909df7b2022-01-22 11:56:27 +08005701};
5702
5703/* NOTICE: see above */
5704#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
5705static uint16_t ssl_tls12_preset_default_sig_algs[] = {
Yanray Wang1136fad2023-11-22 16:54:31 +08005706
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005707#if defined(MBEDTLS_MD_CAN_SHA512)
Valerio Settie9646ec2023-08-02 20:02:28 +02005708#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005709 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA512),
Jerry Yu713013f2022-01-17 18:16:35 +08005710#endif
Jerry Yu09a99fc2022-07-28 14:22:17 +08005711#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT)
5712 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA512,
Yanray Wang1136fad2023-11-22 16:54:31 +08005713#endif
Gabor Mezeic1051b62022-05-10 13:13:58 +02005714#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005715 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA512),
Gabor Mezeic1051b62022-05-10 13:13:58 +02005716#endif
Yanray Wang1136fad2023-11-22 16:54:31 +08005717#endif /* MBEDTLS_MD_CAN_SHA512 */
5718
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005719#if defined(MBEDTLS_MD_CAN_SHA384)
Valerio Settie9646ec2023-08-02 20:02:28 +02005720#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005721 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384),
Jerry Yu11f0a9c2022-01-12 18:43:08 +08005722#endif
Jerry Yu09a99fc2022-07-28 14:22:17 +08005723#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT)
5724 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA384,
Yanray Wang1136fad2023-11-22 16:54:31 +08005725#endif
Gabor Mezeic1051b62022-05-10 13:13:58 +02005726#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005727 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA384),
Gabor Mezeic1051b62022-05-10 13:13:58 +02005728#endif
Yanray Wang1136fad2023-11-22 16:54:31 +08005729#endif /* MBEDTLS_MD_CAN_SHA384 */
5730
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005731#if defined(MBEDTLS_MD_CAN_SHA256)
Valerio Settie9646ec2023-08-02 20:02:28 +02005732#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005733 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256),
Jerry Yu11f0a9c2022-01-12 18:43:08 +08005734#endif
Jerry Yu09a99fc2022-07-28 14:22:17 +08005735#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT)
5736 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256,
Yanray Wang1136fad2023-11-22 16:54:31 +08005737#endif
Gabor Mezeic1051b62022-05-10 13:13:58 +02005738#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005739 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA256),
Gabor Mezeic1051b62022-05-10 13:13:58 +02005740#endif
Yanray Wang1136fad2023-11-22 16:54:31 +08005741#endif /* MBEDTLS_MD_CAN_SHA256 */
5742
Gabor Mezei15b95a62022-05-09 16:37:58 +02005743 MBEDTLS_TLS_SIG_NONE
Jerry Yu909df7b2022-01-22 11:56:27 +08005744};
5745#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Yanray Wang1136fad2023-11-22 16:54:31 +08005746
Jerry Yu909df7b2022-01-22 11:56:27 +08005747/* NOTICE: see above */
Chien Wong4e9683e2023-12-28 17:07:43 +08005748static const uint16_t ssl_preset_suiteb_sig_algs[] = {
Jerry Yu909df7b2022-01-22 11:56:27 +08005749
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005750#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Valerio Setti45d56f32023-07-13 17:23:20 +02005751 defined(MBEDTLS_MD_CAN_SHA256) && \
Valerio Settidb6b4db2023-09-01 09:20:51 +02005752 defined(MBEDTLS_ECP_HAVE_SECP256R1)
Jerry Yu909df7b2022-01-22 11:56:27 +08005753 MBEDTLS_TLS1_3_SIG_ECDSA_SECP256R1_SHA256,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005754 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256)
5755#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08005756
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005757#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Valerio Setti45d56f32023-07-13 17:23:20 +02005758 defined(MBEDTLS_MD_CAN_SHA384) && \
Valerio Settidb6b4db2023-09-01 09:20:51 +02005759 defined(MBEDTLS_ECP_HAVE_SECP384R1)
Jerry Yu53037892022-01-25 11:02:06 +08005760 MBEDTLS_TLS1_3_SIG_ECDSA_SECP384R1_SHA384,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005761 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384)
5762#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08005763
Gabor Mezei15b95a62022-05-09 16:37:58 +02005764 MBEDTLS_TLS_SIG_NONE
Jerry Yu713013f2022-01-17 18:16:35 +08005765};
Jerry Yu6106fdc2022-01-12 16:36:14 +08005766
Jerry Yu909df7b2022-01-22 11:56:27 +08005767/* NOTICE: see above */
5768#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
5769static uint16_t ssl_tls12_preset_suiteb_sig_algs[] = {
Yanray Wang1136fad2023-11-22 16:54:31 +08005770
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005771#if defined(MBEDTLS_MD_CAN_SHA256)
Valerio Settie9646ec2023-08-02 20:02:28 +02005772#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005773 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256),
Jerry Yu713013f2022-01-17 18:16:35 +08005774#endif
Yanray Wang1136fad2023-11-22 16:54:31 +08005775#endif /* MBEDTLS_MD_CAN_SHA256 */
Yanray Wang69ceb392023-11-22 16:32:39 +08005776
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005777#if defined(MBEDTLS_MD_CAN_SHA384)
Valerio Settie9646ec2023-08-02 20:02:28 +02005778#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005779 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384),
Jerry Yu18c833e2022-01-25 10:55:47 +08005780#endif
Yanray Wang1136fad2023-11-22 16:54:31 +08005781#endif /* MBEDTLS_MD_CAN_SHA384 */
5782
Gabor Mezei15b95a62022-05-09 16:37:58 +02005783 MBEDTLS_TLS_SIG_NONE
Hanno Becker9c6aa7b2021-08-10 13:50:43 +01005784};
Jerry Yu909df7b2022-01-22 11:56:27 +08005785#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
5786
Ronald Crone68ab4f2022-10-05 12:46:29 +02005787#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005788
Chien Wong4e9683e2023-12-28 17:07:43 +08005789static const uint16_t ssl_preset_suiteb_groups[] = {
Valerio Settidb6b4db2023-09-01 09:20:51 +02005790#if defined(MBEDTLS_ECP_HAVE_SECP256R1)
Brett Warrene0edc842021-08-17 09:53:13 +01005791 MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1,
Jaeden Amerod4311042019-06-03 08:27:16 +01005792#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005793#if defined(MBEDTLS_ECP_HAVE_SECP384R1)
Brett Warrene0edc842021-08-17 09:53:13 +01005794 MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1,
Jaeden Amerod4311042019-06-03 08:27:16 +01005795#endif
Brett Warrene0edc842021-08-17 09:53:13 +01005796 MBEDTLS_SSL_IANA_TLS_GROUP_NONE
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005797};
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005798
Ronald Crone68ab4f2022-10-05 12:46:29 +02005799#if defined(MBEDTLS_DEBUG_C) && defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu909df7b2022-01-22 11:56:27 +08005800/* Function for checking `ssl_preset_*_sig_algs` and `ssl_tls12_preset_*_sig_algs`
Jerry Yu370e1462022-01-25 10:36:53 +08005801 * to make sure there are no duplicated signature algorithm entries. */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005802MBEDTLS_CHECK_RETURN_CRITICAL
Chien Wong4e9683e2023-12-28 17:07:43 +08005803static int ssl_check_no_sig_alg_duplication(const uint16_t *sig_algs)
Jerry Yu1a8b4812022-01-20 17:56:50 +08005804{
5805 size_t i, j;
5806 int ret = 0;
Jerry Yu909df7b2022-01-22 11:56:27 +08005807
Gilles Peskine449bd832023-01-11 14:50:10 +01005808 for (i = 0; sig_algs[i] != MBEDTLS_TLS_SIG_NONE; i++) {
5809 for (j = 0; j < i; j++) {
5810 if (sig_algs[i] != sig_algs[j]) {
Jerry Yuf377d642022-01-25 10:43:59 +08005811 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01005812 }
5813 mbedtls_printf(" entry(%04x,%" MBEDTLS_PRINTF_SIZET
5814 ") is duplicated at %" MBEDTLS_PRINTF_SIZET "\n",
5815 sig_algs[i], j, i);
Jerry Yuf377d642022-01-25 10:43:59 +08005816 ret = -1;
Jerry Yu1a8b4812022-01-20 17:56:50 +08005817 }
5818 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005819 return ret;
Jerry Yu1a8b4812022-01-20 17:56:50 +08005820}
5821
Ronald Crone68ab4f2022-10-05 12:46:29 +02005822#endif /* MBEDTLS_DEBUG_C && MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Jerry Yu1a8b4812022-01-20 17:56:50 +08005823
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005824/*
Tillmann Karras588ad502015-09-25 04:27:22 +02005825 * Load default in mbedtls_ssl_config
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005826 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005827int mbedtls_ssl_config_defaults(mbedtls_ssl_config *conf,
5828 int endpoint, int transport, int preset)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005829{
Manuel Pégourié-Gonnard8b431fb2015-05-11 12:54:52 +02005830#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Janos Follath865b3eb2019-12-16 11:46:15 +00005831 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard8b431fb2015-05-11 12:54:52 +02005832#endif
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005833
Ronald Crone68ab4f2022-10-05 12:46:29 +02005834#if defined(MBEDTLS_DEBUG_C) && defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005835 if (ssl_check_no_sig_alg_duplication(ssl_preset_suiteb_sig_algs)) {
5836 mbedtls_printf("ssl_preset_suiteb_sig_algs has duplicated entries\n");
5837 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu1a8b4812022-01-20 17:56:50 +08005838 }
5839
Gilles Peskine449bd832023-01-11 14:50:10 +01005840 if (ssl_check_no_sig_alg_duplication(ssl_preset_default_sig_algs)) {
5841 mbedtls_printf("ssl_preset_default_sig_algs has duplicated entries\n");
5842 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu1a8b4812022-01-20 17:56:50 +08005843 }
Jerry Yu909df7b2022-01-22 11:56:27 +08005844
5845#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005846 if (ssl_check_no_sig_alg_duplication(ssl_tls12_preset_suiteb_sig_algs)) {
5847 mbedtls_printf("ssl_tls12_preset_suiteb_sig_algs has duplicated entries\n");
5848 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu909df7b2022-01-22 11:56:27 +08005849 }
5850
Gilles Peskine449bd832023-01-11 14:50:10 +01005851 if (ssl_check_no_sig_alg_duplication(ssl_tls12_preset_default_sig_algs)) {
5852 mbedtls_printf("ssl_tls12_preset_default_sig_algs has duplicated entries\n");
5853 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu909df7b2022-01-22 11:56:27 +08005854 }
5855#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Ronald Crone68ab4f2022-10-05 12:46:29 +02005856#endif /* MBEDTLS_DEBUG_C && MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Jerry Yu1a8b4812022-01-20 17:56:50 +08005857
Manuel Pégourié-Gonnard0de074f2015-05-14 12:58:01 +02005858 /* Use the functions here so that they are covered in tests,
5859 * but otherwise access member directly for efficiency */
Gilles Peskine449bd832023-01-11 14:50:10 +01005860 mbedtls_ssl_conf_endpoint(conf, endpoint);
5861 mbedtls_ssl_conf_transport(conf, transport);
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005862
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005863 /*
5864 * Things that are common to all presets
5865 */
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02005866#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005867 if (endpoint == MBEDTLS_SSL_IS_CLIENT) {
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02005868 conf->authmode = MBEDTLS_SSL_VERIFY_REQUIRED;
5869#if defined(MBEDTLS_SSL_SESSION_TICKETS)
5870 conf->session_tickets = MBEDTLS_SSL_SESSION_TICKETS_ENABLED;
5871#endif
5872 }
5873#endif
5874
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005875#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
5876 conf->encrypt_then_mac = MBEDTLS_SSL_ETM_ENABLED;
5877#endif
5878
5879#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
5880 conf->extended_ms = MBEDTLS_SSL_EXTENDED_MS_ENABLED;
5881#endif
5882
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02005883#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005884 conf->f_cookie_write = ssl_cookie_write_dummy;
5885 conf->f_cookie_check = ssl_cookie_check_dummy;
5886#endif
5887
5888#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
5889 conf->anti_replay = MBEDTLS_SSL_ANTI_REPLAY_ENABLED;
5890#endif
5891
Janos Follath088ce432017-04-10 12:42:31 +01005892#if defined(MBEDTLS_SSL_SRV_C)
5893 conf->cert_req_ca_list = MBEDTLS_SSL_CERT_REQ_CA_LIST_ENABLED;
TRodziewicz3946f792021-06-14 12:11:18 +02005894 conf->respect_cli_pref = MBEDTLS_SSL_SRV_CIPHERSUITE_ORDER_SERVER;
Janos Follath088ce432017-04-10 12:42:31 +01005895#endif
5896
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005897#if defined(MBEDTLS_SSL_PROTO_DTLS)
5898 conf->hs_timeout_min = MBEDTLS_SSL_DTLS_TIMEOUT_DFL_MIN;
5899 conf->hs_timeout_max = MBEDTLS_SSL_DTLS_TIMEOUT_DFL_MAX;
5900#endif
5901
5902#if defined(MBEDTLS_SSL_RENEGOTIATION)
5903 conf->renego_max_records = MBEDTLS_SSL_RENEGO_MAX_RECORDS_DEFAULT;
Gilles Peskine449bd832023-01-11 14:50:10 +01005904 memset(conf->renego_period, 0x00, 2);
5905 memset(conf->renego_period + 2, 0xFF, 6);
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005906#endif
5907
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005908#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005909 if (endpoint == MBEDTLS_SSL_IS_SERVER) {
Hanno Beckere2defad2021-07-24 05:59:17 +01005910 const unsigned char dhm_p[] =
5911 MBEDTLS_DHM_RFC3526_MODP_2048_P_BIN;
5912 const unsigned char dhm_g[] =
5913 MBEDTLS_DHM_RFC3526_MODP_2048_G_BIN;
Hanno Becker00d0a682017-10-04 13:14:29 +01005914
Gilles Peskine449bd832023-01-11 14:50:10 +01005915 if ((ret = mbedtls_ssl_conf_dh_param_bin(conf,
5916 dhm_p, sizeof(dhm_p),
5917 dhm_g, sizeof(dhm_g))) != 0) {
5918 return ret;
Hanno Beckere2defad2021-07-24 05:59:17 +01005919 }
5920 }
Manuel Pégourié-Gonnardbd990d62015-06-11 14:49:42 +02005921#endif
5922
Ronald Cron6f135e12021-12-08 16:57:54 +01005923#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yu6ee56aa2022-12-06 17:47:22 +08005924
5925#if defined(MBEDTLS_SSL_EARLY_DATA)
Yanray Wangd5ed36f2023-11-07 11:40:43 +08005926 mbedtls_ssl_conf_early_data(conf, MBEDTLS_SSL_EARLY_DATA_DISABLED);
Jerry Yu6ee56aa2022-12-06 17:47:22 +08005927#if defined(MBEDTLS_SSL_SRV_C)
Yanray Wang07517612023-11-07 11:47:36 +08005928 mbedtls_ssl_conf_max_early_data_size(conf, MBEDTLS_SSL_MAX_EARLY_DATA_SIZE);
Jerry Yu6ee56aa2022-12-06 17:47:22 +08005929#endif
5930#endif /* MBEDTLS_SSL_EARLY_DATA */
5931
Jerry Yud0766ec2022-09-22 10:46:57 +08005932#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Jerry Yu1ad7ace2022-08-09 13:28:39 +08005933 mbedtls_ssl_conf_new_session_tickets(
Gilles Peskine449bd832023-01-11 14:50:10 +01005934 conf, MBEDTLS_SSL_TLS1_3_DEFAULT_NEW_SESSION_TICKETS);
Jerry Yu1ad7ace2022-08-09 13:28:39 +08005935#endif
Hanno Becker71f1ed62021-07-24 06:01:47 +01005936 /*
5937 * Allow all TLS 1.3 key exchange modes by default.
5938 */
Xiaofei Bai746f9482021-11-12 08:53:56 +00005939 conf->tls13_kex_modes = MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_ALL;
Ronald Cron6f135e12021-12-08 16:57:54 +01005940#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker71f1ed62021-07-24 06:01:47 +01005941
Gilles Peskine449bd832023-01-11 14:50:10 +01005942 if (transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Glenn Strauss2dfcea22022-03-14 17:26:42 -04005943#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
XiaokangQian4d3a6042022-04-21 13:46:17 +00005944 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
XiaokangQian060d8672022-04-21 09:24:56 +00005945 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
XiaokangQian4d3a6042022-04-21 13:46:17 +00005946#else
Gilles Peskine449bd832023-01-11 14:50:10 +01005947 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
XiaokangQian060d8672022-04-21 09:24:56 +00005948#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01005949 } else {
XiaokangQian4d3a6042022-04-21 13:46:17 +00005950#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
Ronald Cron097ba142023-03-08 16:18:00 +01005951 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
5952 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
XiaokangQian4d3a6042022-04-21 13:46:17 +00005953#elif defined(MBEDTLS_SSL_PROTO_TLS1_3)
5954 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
5955 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
5956#elif defined(MBEDTLS_SSL_PROTO_TLS1_2)
5957 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
5958 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
5959#else
Gilles Peskine449bd832023-01-11 14:50:10 +01005960 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
XiaokangQian4d3a6042022-04-21 13:46:17 +00005961#endif
5962 }
Glenn Strauss2dfcea22022-03-14 17:26:42 -04005963
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005964 /*
5965 * Preset-specific defaults
5966 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005967 switch (preset) {
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005968 /*
5969 * NSA Suite B
5970 */
5971 case MBEDTLS_SSL_PRESET_SUITEB:
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005972
Hanno Beckerd60b6c62021-04-29 12:04:11 +01005973 conf->ciphersuite_list = ssl_preset_suiteb_ciphersuites;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005974
5975#if defined(MBEDTLS_X509_CRT_PARSE_C)
5976 conf->cert_profile = &mbedtls_x509_crt_profile_suiteb;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005977#endif
5978
Ronald Crone68ab4f2022-10-05 12:46:29 +02005979#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu909df7b2022-01-22 11:56:27 +08005980#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005981 if (mbedtls_ssl_conf_is_tls12_only(conf)) {
Jerry Yu909df7b2022-01-22 11:56:27 +08005982 conf->sig_algs = ssl_tls12_preset_suiteb_sig_algs;
Gilles Peskine449bd832023-01-11 14:50:10 +01005983 } else
Jerry Yu909df7b2022-01-22 11:56:27 +08005984#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005985 conf->sig_algs = ssl_preset_suiteb_sig_algs;
Ronald Crone68ab4f2022-10-05 12:46:29 +02005986#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005987
Manuel Pégourié-Gonnardf07ce3b2023-09-22 11:53:41 +02005988#if defined(MBEDTLS_ECP_C) && !defined(MBEDTLS_DEPRECATED_REMOVED)
Brett Warrene0edc842021-08-17 09:53:13 +01005989 conf->curve_list = NULL;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005990#endif
Brett Warrene0edc842021-08-17 09:53:13 +01005991 conf->group_list = ssl_preset_suiteb_groups;
Manuel Pégourié-Gonnardc98204e2015-08-11 04:21:01 +02005992 break;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005993
5994 /*
5995 * Default
5996 */
5997 default:
Ronald Cronf6606552022-03-15 11:23:25 +01005998
Hanno Beckerd60b6c62021-04-29 12:04:11 +01005999 conf->ciphersuite_list = mbedtls_ssl_list_ciphersuites();
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02006000
6001#if defined(MBEDTLS_X509_CRT_PARSE_C)
6002 conf->cert_profile = &mbedtls_x509_crt_profile_default;
6003#endif
6004
Ronald Crone68ab4f2022-10-05 12:46:29 +02006005#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu909df7b2022-01-22 11:56:27 +08006006#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01006007 if (mbedtls_ssl_conf_is_tls12_only(conf)) {
Jerry Yu909df7b2022-01-22 11:56:27 +08006008 conf->sig_algs = ssl_tls12_preset_default_sig_algs;
Gilles Peskine449bd832023-01-11 14:50:10 +01006009 } else
Jerry Yu909df7b2022-01-22 11:56:27 +08006010#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006011 conf->sig_algs = ssl_preset_default_sig_algs;
Ronald Crone68ab4f2022-10-05 12:46:29 +02006012#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02006013
Manuel Pégourié-Gonnardf07ce3b2023-09-22 11:53:41 +02006014#if defined(MBEDTLS_ECP_C) && !defined(MBEDTLS_DEPRECATED_REMOVED)
Brett Warrene0edc842021-08-17 09:53:13 +01006015 conf->curve_list = NULL;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02006016#endif
Brett Warrene0edc842021-08-17 09:53:13 +01006017 conf->group_list = ssl_preset_default_groups;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02006018
6019#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_CLI_C)
6020 conf->dhm_min_bitlen = 1024;
6021#endif
6022 }
6023
Gilles Peskine449bd832023-01-11 14:50:10 +01006024 return 0;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02006025}
6026
6027/*
6028 * Free mbedtls_ssl_config
6029 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006030void mbedtls_ssl_config_free(mbedtls_ssl_config *conf)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02006031{
6032#if defined(MBEDTLS_DHM_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01006033 mbedtls_mpi_free(&conf->dhm_P);
6034 mbedtls_mpi_free(&conf->dhm_G);
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02006035#endif
6036
Ronald Cron73fe8df2022-10-05 14:31:43 +02006037#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED)
Neil Armstrong501c9322022-05-03 09:35:09 +02006038#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01006039 if (!mbedtls_svc_key_id_is_null(conf->psk_opaque)) {
Neil Armstrong501c9322022-05-03 09:35:09 +02006040 conf->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
6041 }
Neil Armstrong8ecd6682022-05-05 11:40:35 +02006042#endif /* MBEDTLS_USE_PSA_CRYPTO */
Gilles Peskine449bd832023-01-11 14:50:10 +01006043 if (conf->psk != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01006044 mbedtls_zeroize_and_free(conf->psk, conf->psk_len);
Azim Khan27e8a122018-03-21 14:24:11 +00006045 conf->psk = NULL;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02006046 conf->psk_len = 0;
junyeonLEE316b1622017-12-20 16:29:30 +09006047 }
6048
Gilles Peskine449bd832023-01-11 14:50:10 +01006049 if (conf->psk_identity != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01006050 mbedtls_zeroize_and_free(conf->psk_identity, conf->psk_identity_len);
Azim Khan27e8a122018-03-21 14:24:11 +00006051 conf->psk_identity = NULL;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02006052 conf->psk_identity_len = 0;
6053 }
Ronald Cron73fe8df2022-10-05 14:31:43 +02006054#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED */
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02006055
6056#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01006057 ssl_key_cert_free(conf->key_cert);
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02006058#endif
6059
Gilles Peskine449bd832023-01-11 14:50:10 +01006060 mbedtls_platform_zeroize(conf, sizeof(mbedtls_ssl_config));
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02006061}
6062
Manuel Pégourié-Gonnard5674a972015-10-19 15:14:03 +02006063#if defined(MBEDTLS_PK_C) && \
Valerio Settie9646ec2023-08-02 20:02:28 +02006064 (defined(MBEDTLS_RSA_C) || defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED))
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02006065/*
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006066 * Convert between MBEDTLS_PK_XXX and SSL_SIG_XXX
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02006067 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006068unsigned char mbedtls_ssl_sig_from_pk(mbedtls_pk_context *pk)
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02006069{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006070#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01006071 if (mbedtls_pk_can_do(pk, MBEDTLS_PK_RSA)) {
6072 return MBEDTLS_SSL_SIG_RSA;
6073 }
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02006074#endif
Valerio Settie9646ec2023-08-02 20:02:28 +02006075#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01006076 if (mbedtls_pk_can_do(pk, MBEDTLS_PK_ECDSA)) {
6077 return MBEDTLS_SSL_SIG_ECDSA;
6078 }
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02006079#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01006080 return MBEDTLS_SSL_SIG_ANON;
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02006081}
6082
Gilles Peskine449bd832023-01-11 14:50:10 +01006083unsigned char mbedtls_ssl_sig_from_pk_alg(mbedtls_pk_type_t type)
Hanno Becker7e5437a2017-04-28 17:15:26 +01006084{
Gilles Peskine449bd832023-01-11 14:50:10 +01006085 switch (type) {
Hanno Becker7e5437a2017-04-28 17:15:26 +01006086 case MBEDTLS_PK_RSA:
Gilles Peskine449bd832023-01-11 14:50:10 +01006087 return MBEDTLS_SSL_SIG_RSA;
Hanno Becker7e5437a2017-04-28 17:15:26 +01006088 case MBEDTLS_PK_ECDSA:
6089 case MBEDTLS_PK_ECKEY:
Gilles Peskine449bd832023-01-11 14:50:10 +01006090 return MBEDTLS_SSL_SIG_ECDSA;
Hanno Becker7e5437a2017-04-28 17:15:26 +01006091 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006092 return MBEDTLS_SSL_SIG_ANON;
Hanno Becker7e5437a2017-04-28 17:15:26 +01006093 }
6094}
6095
Gilles Peskine449bd832023-01-11 14:50:10 +01006096mbedtls_pk_type_t mbedtls_ssl_pk_alg_from_sig(unsigned char sig)
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02006097{
Gilles Peskine449bd832023-01-11 14:50:10 +01006098 switch (sig) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006099#if defined(MBEDTLS_RSA_C)
6100 case MBEDTLS_SSL_SIG_RSA:
Gilles Peskine449bd832023-01-11 14:50:10 +01006101 return MBEDTLS_PK_RSA;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02006102#endif
Valerio Settie9646ec2023-08-02 20:02:28 +02006103#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006104 case MBEDTLS_SSL_SIG_ECDSA:
Gilles Peskine449bd832023-01-11 14:50:10 +01006105 return MBEDTLS_PK_ECDSA;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02006106#endif
6107 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006108 return MBEDTLS_PK_NONE;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02006109 }
6110}
Valerio Settie9646ec2023-08-02 20:02:28 +02006111#endif /* MBEDTLS_PK_C &&
6112 ( MBEDTLS_RSA_C || MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED ) */
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02006113
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02006114/*
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006115 * Convert from MBEDTLS_SSL_HASH_XXX to MBEDTLS_MD_XXX
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02006116 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006117mbedtls_md_type_t mbedtls_ssl_md_alg_from_hash(unsigned char hash)
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02006118{
Gilles Peskine449bd832023-01-11 14:50:10 +01006119 switch (hash) {
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006120#if defined(MBEDTLS_MD_CAN_MD5)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006121 case MBEDTLS_SSL_HASH_MD5:
Gilles Peskine449bd832023-01-11 14:50:10 +01006122 return MBEDTLS_MD_MD5;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02006123#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006124#if defined(MBEDTLS_MD_CAN_SHA1)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006125 case MBEDTLS_SSL_HASH_SHA1:
Gilles Peskine449bd832023-01-11 14:50:10 +01006126 return MBEDTLS_MD_SHA1;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02006127#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006128#if defined(MBEDTLS_MD_CAN_SHA224)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006129 case MBEDTLS_SSL_HASH_SHA224:
Gilles Peskine449bd832023-01-11 14:50:10 +01006130 return MBEDTLS_MD_SHA224;
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02006131#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006132#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006133 case MBEDTLS_SSL_HASH_SHA256:
Gilles Peskine449bd832023-01-11 14:50:10 +01006134 return MBEDTLS_MD_SHA256;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02006135#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006136#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006137 case MBEDTLS_SSL_HASH_SHA384:
Gilles Peskine449bd832023-01-11 14:50:10 +01006138 return MBEDTLS_MD_SHA384;
Mateusz Starzyk3352a532021-04-06 14:28:22 +02006139#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006140#if defined(MBEDTLS_MD_CAN_SHA512)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006141 case MBEDTLS_SSL_HASH_SHA512:
Gilles Peskine449bd832023-01-11 14:50:10 +01006142 return MBEDTLS_MD_SHA512;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02006143#endif
6144 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006145 return MBEDTLS_MD_NONE;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02006146 }
6147}
6148
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006149/*
6150 * Convert from MBEDTLS_MD_XXX to MBEDTLS_SSL_HASH_XXX
6151 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006152unsigned char mbedtls_ssl_hash_from_md_alg(int md)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006153{
Gilles Peskine449bd832023-01-11 14:50:10 +01006154 switch (md) {
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006155#if defined(MBEDTLS_MD_CAN_MD5)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006156 case MBEDTLS_MD_MD5:
Gilles Peskine449bd832023-01-11 14:50:10 +01006157 return MBEDTLS_SSL_HASH_MD5;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006158#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006159#if defined(MBEDTLS_MD_CAN_SHA1)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006160 case MBEDTLS_MD_SHA1:
Gilles Peskine449bd832023-01-11 14:50:10 +01006161 return MBEDTLS_SSL_HASH_SHA1;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006162#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006163#if defined(MBEDTLS_MD_CAN_SHA224)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006164 case MBEDTLS_MD_SHA224:
Gilles Peskine449bd832023-01-11 14:50:10 +01006165 return MBEDTLS_SSL_HASH_SHA224;
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02006166#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006167#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006168 case MBEDTLS_MD_SHA256:
Gilles Peskine449bd832023-01-11 14:50:10 +01006169 return MBEDTLS_SSL_HASH_SHA256;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006170#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006171#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006172 case MBEDTLS_MD_SHA384:
Gilles Peskine449bd832023-01-11 14:50:10 +01006173 return MBEDTLS_SSL_HASH_SHA384;
Mateusz Starzyk3352a532021-04-06 14:28:22 +02006174#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006175#if defined(MBEDTLS_MD_CAN_SHA512)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006176 case MBEDTLS_MD_SHA512:
Gilles Peskine449bd832023-01-11 14:50:10 +01006177 return MBEDTLS_SSL_HASH_SHA512;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006178#endif
6179 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006180 return MBEDTLS_SSL_HASH_NONE;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006181 }
6182}
6183
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01006184/*
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006185 * Check if a curve proposed by the peer is in our list.
Manuel Pégourié-Gonnard9d412d82015-06-17 12:10:46 +02006186 * Return 0 if we're willing to use it, -1 otherwise.
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01006187 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006188int mbedtls_ssl_check_curve_tls_id(const mbedtls_ssl_context *ssl, uint16_t tls_id)
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01006189{
Gilles Peskine449bd832023-01-11 14:50:10 +01006190 const uint16_t *group_list = mbedtls_ssl_get_groups(ssl);
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01006191
Gilles Peskine449bd832023-01-11 14:50:10 +01006192 if (group_list == NULL) {
6193 return -1;
Brett Warrene0edc842021-08-17 09:53:13 +01006194 }
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01006195
Gilles Peskine449bd832023-01-11 14:50:10 +01006196 for (; *group_list != 0; group_list++) {
6197 if (*group_list == tls_id) {
6198 return 0;
6199 }
6200 }
6201
6202 return -1;
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01006203}
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01006204
Valerio Setti49e69072023-06-27 17:27:51 +02006205#if defined(MBEDTLS_PK_HAVE_ECC_KEYS)
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01006206/*
6207 * Same as mbedtls_ssl_check_curve_tls_id() but with a mbedtls_ecp_group_id.
6208 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006209int mbedtls_ssl_check_curve(const mbedtls_ssl_context *ssl, mbedtls_ecp_group_id grp_id)
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01006210{
Gilles Peskine449bd832023-01-11 14:50:10 +01006211 uint16_t tls_id = mbedtls_ssl_get_tls_id_from_ecp_group_id(grp_id);
Leonid Rozenboim19e59732022-08-08 16:52:38 -07006212
Gilles Peskine449bd832023-01-11 14:50:10 +01006213 if (tls_id == 0) {
Leonid Rozenboim19e59732022-08-08 16:52:38 -07006214 return -1;
Gilles Peskine449bd832023-01-11 14:50:10 +01006215 }
Leonid Rozenboim19e59732022-08-08 16:52:38 -07006216
Gilles Peskine449bd832023-01-11 14:50:10 +01006217 return mbedtls_ssl_check_curve_tls_id(ssl, tls_id);
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01006218}
Valerio Setti49e69072023-06-27 17:27:51 +02006219#endif /* MBEDTLS_PK_HAVE_ECC_KEYS */
Valerio Setti67419f02023-01-04 16:12:42 +01006220
Valerio Setti18c9fed2022-12-30 17:44:24 +01006221static const struct {
6222 uint16_t tls_id;
6223 mbedtls_ecp_group_id ecp_group_id;
6224 psa_ecc_family_t psa_family;
6225 uint16_t bits;
Valerio Setti18c9fed2022-12-30 17:44:24 +01006226} tls_id_match_table[] =
6227{
Valerio Settidb6b4db2023-09-01 09:20:51 +02006228#if defined(MBEDTLS_ECP_HAVE_SECP521R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02006229 { 25, MBEDTLS_ECP_DP_SECP521R1, PSA_ECC_FAMILY_SECP_R1, 521 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006230#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02006231#if defined(MBEDTLS_ECP_HAVE_BP512R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02006232 { 28, MBEDTLS_ECP_DP_BP512R1, PSA_ECC_FAMILY_BRAINPOOL_P_R1, 512 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006233#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02006234#if defined(MBEDTLS_ECP_HAVE_SECP384R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02006235 { 24, MBEDTLS_ECP_DP_SECP384R1, PSA_ECC_FAMILY_SECP_R1, 384 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006236#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02006237#if defined(MBEDTLS_ECP_HAVE_BP384R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02006238 { 27, MBEDTLS_ECP_DP_BP384R1, PSA_ECC_FAMILY_BRAINPOOL_P_R1, 384 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006239#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02006240#if defined(MBEDTLS_ECP_HAVE_SECP256R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02006241 { 23, MBEDTLS_ECP_DP_SECP256R1, PSA_ECC_FAMILY_SECP_R1, 256 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006242#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02006243#if defined(MBEDTLS_ECP_HAVE_SECP256K1)
Valerio Settiacd32c02023-06-29 18:06:29 +02006244 { 22, MBEDTLS_ECP_DP_SECP256K1, PSA_ECC_FAMILY_SECP_K1, 256 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006245#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02006246#if defined(MBEDTLS_ECP_HAVE_BP256R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02006247 { 26, MBEDTLS_ECP_DP_BP256R1, PSA_ECC_FAMILY_BRAINPOOL_P_R1, 256 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006248#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02006249#if defined(MBEDTLS_ECP_HAVE_SECP224R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02006250 { 21, MBEDTLS_ECP_DP_SECP224R1, PSA_ECC_FAMILY_SECP_R1, 224 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006251#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02006252#if defined(MBEDTLS_ECP_HAVE_SECP224K1)
Valerio Settiacd32c02023-06-29 18:06:29 +02006253 { 20, MBEDTLS_ECP_DP_SECP224K1, PSA_ECC_FAMILY_SECP_K1, 224 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006254#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02006255#if defined(MBEDTLS_ECP_HAVE_SECP192R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02006256 { 19, MBEDTLS_ECP_DP_SECP192R1, PSA_ECC_FAMILY_SECP_R1, 192 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006257#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02006258#if defined(MBEDTLS_ECP_HAVE_SECP192K1)
Valerio Settiacd32c02023-06-29 18:06:29 +02006259 { 18, MBEDTLS_ECP_DP_SECP192K1, PSA_ECC_FAMILY_SECP_K1, 192 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006260#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02006261#if defined(MBEDTLS_ECP_HAVE_CURVE25519)
Valerio Settiacd32c02023-06-29 18:06:29 +02006262 { 29, MBEDTLS_ECP_DP_CURVE25519, PSA_ECC_FAMILY_MONTGOMERY, 255 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006263#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02006264#if defined(MBEDTLS_ECP_HAVE_CURVE448)
Valerio Settiacd32c02023-06-29 18:06:29 +02006265 { 30, MBEDTLS_ECP_DP_CURVE448, PSA_ECC_FAMILY_MONTGOMERY, 448 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006266#endif
Valerio Settiacd32c02023-06-29 18:06:29 +02006267 { 0, MBEDTLS_ECP_DP_NONE, 0, 0 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006268};
6269
Gilles Peskine449bd832023-01-11 14:50:10 +01006270int mbedtls_ssl_get_psa_curve_info_from_tls_id(uint16_t tls_id,
Przemek Stekielda4fba62023-06-02 14:52:28 +02006271 psa_key_type_t *type,
Gilles Peskine449bd832023-01-11 14:50:10 +01006272 size_t *bits)
Valerio Setti18c9fed2022-12-30 17:44:24 +01006273{
Gilles Peskine449bd832023-01-11 14:50:10 +01006274 for (int i = 0; tls_id_match_table[i].tls_id != 0; i++) {
6275 if (tls_id_match_table[i].tls_id == tls_id) {
Przemek Stekielda4fba62023-06-02 14:52:28 +02006276 if (type != NULL) {
6277 *type = PSA_KEY_TYPE_ECC_KEY_PAIR(tls_id_match_table[i].psa_family);
Gilles Peskine449bd832023-01-11 14:50:10 +01006278 }
6279 if (bits != NULL) {
Valerio Setti18c9fed2022-12-30 17:44:24 +01006280 *bits = tls_id_match_table[i].bits;
Gilles Peskine449bd832023-01-11 14:50:10 +01006281 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01006282 return PSA_SUCCESS;
6283 }
6284 }
6285
6286 return PSA_ERROR_NOT_SUPPORTED;
6287}
6288
Gilles Peskine449bd832023-01-11 14:50:10 +01006289mbedtls_ecp_group_id mbedtls_ssl_get_ecp_group_id_from_tls_id(uint16_t tls_id)
Valerio Setti18c9fed2022-12-30 17:44:24 +01006290{
Gilles Peskine449bd832023-01-11 14:50:10 +01006291 for (int i = 0; tls_id_match_table[i].tls_id != 0; i++) {
6292 if (tls_id_match_table[i].tls_id == tls_id) {
Valerio Setti18c9fed2022-12-30 17:44:24 +01006293 return tls_id_match_table[i].ecp_group_id;
Gilles Peskine449bd832023-01-11 14:50:10 +01006294 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01006295 }
6296
6297 return MBEDTLS_ECP_DP_NONE;
6298}
6299
Gilles Peskine449bd832023-01-11 14:50:10 +01006300uint16_t mbedtls_ssl_get_tls_id_from_ecp_group_id(mbedtls_ecp_group_id grp_id)
Valerio Setti18c9fed2022-12-30 17:44:24 +01006301{
Gilles Peskine449bd832023-01-11 14:50:10 +01006302 for (int i = 0; tls_id_match_table[i].ecp_group_id != MBEDTLS_ECP_DP_NONE;
6303 i++) {
6304 if (tls_id_match_table[i].ecp_group_id == grp_id) {
Valerio Setti18c9fed2022-12-30 17:44:24 +01006305 return tls_id_match_table[i].tls_id;
Gilles Peskine449bd832023-01-11 14:50:10 +01006306 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01006307 }
6308
6309 return 0;
6310}
6311
Valerio Setti67419f02023-01-04 16:12:42 +01006312#if defined(MBEDTLS_DEBUG_C)
Valerio Settiacd32c02023-06-29 18:06:29 +02006313static const struct {
6314 uint16_t tls_id;
6315 const char *name;
6316} tls_id_curve_name_table[] =
6317{
Valerio Setti54e23792023-07-07 10:49:27 +02006318 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP521R1, "secp521r1" },
6319 { MBEDTLS_SSL_IANA_TLS_GROUP_BP512R1, "brainpoolP512r1" },
6320 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1, "secp384r1" },
6321 { MBEDTLS_SSL_IANA_TLS_GROUP_BP384R1, "brainpoolP384r1" },
6322 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1, "secp256r1" },
6323 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP256K1, "secp256k1" },
6324 { MBEDTLS_SSL_IANA_TLS_GROUP_BP256R1, "brainpoolP256r1" },
6325 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP224R1, "secp224r1" },
6326 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP224K1, "secp224k1" },
6327 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP192R1, "secp192r1" },
6328 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP192K1, "secp192k1" },
6329 { MBEDTLS_SSL_IANA_TLS_GROUP_X25519, "x25519" },
6330 { MBEDTLS_SSL_IANA_TLS_GROUP_X448, "x448" },
Valerio Settiacd32c02023-06-29 18:06:29 +02006331 { 0, NULL },
6332};
6333
Gilles Peskine449bd832023-01-11 14:50:10 +01006334const char *mbedtls_ssl_get_curve_name_from_tls_id(uint16_t tls_id)
Valerio Setti18c9fed2022-12-30 17:44:24 +01006335{
Valerio Settiacd32c02023-06-29 18:06:29 +02006336 for (int i = 0; tls_id_curve_name_table[i].tls_id != 0; i++) {
6337 if (tls_id_curve_name_table[i].tls_id == tls_id) {
6338 return tls_id_curve_name_table[i].name;
Gilles Peskine449bd832023-01-11 14:50:10 +01006339 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01006340 }
6341
6342 return NULL;
6343}
Valerio Setti67419f02023-01-04 16:12:42 +01006344#endif
Valerio Setti18c9fed2022-12-30 17:44:24 +01006345
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006346#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01006347int mbedtls_ssl_check_cert_usage(const mbedtls_x509_crt *cert,
6348 const mbedtls_ssl_ciphersuite_t *ciphersuite,
6349 int cert_endpoint,
6350 uint32_t *flags)
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02006351{
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01006352 int ret = 0;
Dave Rodgmanc37ad442023-11-03 23:36:06 +00006353 unsigned int usage = 0;
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02006354 const char *ext_oid;
6355 size_t ext_len;
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02006356
Gilles Peskine449bd832023-01-11 14:50:10 +01006357 if (cert_endpoint == MBEDTLS_SSL_IS_SERVER) {
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02006358 /* Server part of the key exchange */
Gilles Peskine449bd832023-01-11 14:50:10 +01006359 switch (ciphersuite->key_exchange) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006360 case MBEDTLS_KEY_EXCHANGE_RSA:
6361 case MBEDTLS_KEY_EXCHANGE_RSA_PSK:
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01006362 usage = MBEDTLS_X509_KU_KEY_ENCIPHERMENT;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02006363 break;
6364
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006365 case MBEDTLS_KEY_EXCHANGE_DHE_RSA:
6366 case MBEDTLS_KEY_EXCHANGE_ECDHE_RSA:
6367 case MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA:
6368 usage = MBEDTLS_X509_KU_DIGITAL_SIGNATURE;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02006369 break;
6370
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006371 case MBEDTLS_KEY_EXCHANGE_ECDH_RSA:
6372 case MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA:
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01006373 usage = MBEDTLS_X509_KU_KEY_AGREEMENT;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02006374 break;
6375
6376 /* Don't use default: we want warnings when adding new values */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006377 case MBEDTLS_KEY_EXCHANGE_NONE:
6378 case MBEDTLS_KEY_EXCHANGE_PSK:
6379 case MBEDTLS_KEY_EXCHANGE_DHE_PSK:
6380 case MBEDTLS_KEY_EXCHANGE_ECDHE_PSK:
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +02006381 case MBEDTLS_KEY_EXCHANGE_ECJPAKE:
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02006382 usage = 0;
6383 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006384 } else {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006385 /* Client auth: we only implement rsa_sign and mbedtls_ecdsa_sign for now */
6386 usage = MBEDTLS_X509_KU_DIGITAL_SIGNATURE;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02006387 }
6388
Gilles Peskine449bd832023-01-11 14:50:10 +01006389 if (mbedtls_x509_crt_check_key_usage(cert, usage) != 0) {
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01006390 *flags |= MBEDTLS_X509_BADCERT_KEY_USAGE;
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01006391 ret = -1;
6392 }
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02006393
Gilles Peskine449bd832023-01-11 14:50:10 +01006394 if (cert_endpoint == MBEDTLS_SSL_IS_SERVER) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006395 ext_oid = MBEDTLS_OID_SERVER_AUTH;
Gilles Peskine449bd832023-01-11 14:50:10 +01006396 ext_len = MBEDTLS_OID_SIZE(MBEDTLS_OID_SERVER_AUTH);
6397 } else {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006398 ext_oid = MBEDTLS_OID_CLIENT_AUTH;
Gilles Peskine449bd832023-01-11 14:50:10 +01006399 ext_len = MBEDTLS_OID_SIZE(MBEDTLS_OID_CLIENT_AUTH);
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02006400 }
6401
Gilles Peskine449bd832023-01-11 14:50:10 +01006402 if (mbedtls_x509_crt_check_extended_key_usage(cert, ext_oid, ext_len) != 0) {
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01006403 *flags |= MBEDTLS_X509_BADCERT_EXT_KEY_USAGE;
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01006404 ret = -1;
6405 }
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02006406
Gilles Peskine449bd832023-01-11 14:50:10 +01006407 return ret;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02006408}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006409#endif /* MBEDTLS_X509_CRT_PARSE_C */
Manuel Pégourié-Gonnard3a306b92014-04-29 15:11:17 +02006410
Jerry Yu148165c2021-09-24 23:20:59 +08006411#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01006412int mbedtls_ssl_get_handshake_transcript(mbedtls_ssl_context *ssl,
6413 const mbedtls_md_type_t md,
6414 unsigned char *dst,
6415 size_t dst_len,
6416 size_t *olen)
Jerry Yu148165c2021-09-24 23:20:59 +08006417{
Ronald Cronf6893e12022-01-07 22:09:01 +01006418 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
6419 psa_hash_operation_t *hash_operation_to_clone;
6420 psa_hash_operation_t hash_operation = psa_hash_operation_init();
6421
Jerry Yu148165c2021-09-24 23:20:59 +08006422 *olen = 0;
Ronald Cronf6893e12022-01-07 22:09:01 +01006423
Gilles Peskine449bd832023-01-11 14:50:10 +01006424 switch (md) {
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006425#if defined(MBEDTLS_MD_CAN_SHA384)
Gilles Peskine449bd832023-01-11 14:50:10 +01006426 case MBEDTLS_MD_SHA384:
6427 hash_operation_to_clone = &ssl->handshake->fin_sha384_psa;
6428 break;
Ronald Cronf6893e12022-01-07 22:09:01 +01006429#endif
6430
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006431#if defined(MBEDTLS_MD_CAN_SHA256)
Gilles Peskine449bd832023-01-11 14:50:10 +01006432 case MBEDTLS_MD_SHA256:
6433 hash_operation_to_clone = &ssl->handshake->fin_sha256_psa;
6434 break;
Ronald Cronf6893e12022-01-07 22:09:01 +01006435#endif
6436
Gilles Peskine449bd832023-01-11 14:50:10 +01006437 default:
6438 goto exit;
6439 }
6440
6441 status = psa_hash_clone(hash_operation_to_clone, &hash_operation);
6442 if (status != PSA_SUCCESS) {
Ronald Cronf6893e12022-01-07 22:09:01 +01006443 goto exit;
6444 }
6445
Gilles Peskine449bd832023-01-11 14:50:10 +01006446 status = psa_hash_finish(&hash_operation, dst, dst_len, olen);
6447 if (status != PSA_SUCCESS) {
Ronald Cronf6893e12022-01-07 22:09:01 +01006448 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006449 }
Ronald Cronf6893e12022-01-07 22:09:01 +01006450
6451exit:
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006452#if !defined(MBEDTLS_MD_CAN_SHA384) && \
6453 !defined(MBEDTLS_MD_CAN_SHA256)
Andrzej Kurekeabeb302022-10-17 07:52:51 -04006454 (void) ssl;
6455#endif
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05006456 return PSA_TO_MBEDTLS_ERR(status);
Jerry Yu148165c2021-09-24 23:20:59 +08006457}
6458#else /* MBEDTLS_USE_PSA_CRYPTO */
6459
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006460#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006461MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006462static int ssl_get_handshake_transcript_sha384(mbedtls_ssl_context *ssl,
6463 unsigned char *dst,
6464 size_t dst_len,
6465 size_t *olen)
Jerry Yu24c0ec32021-09-09 14:21:07 +08006466{
Jerry Yu24c0ec32021-09-09 14:21:07 +08006467 int ret;
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01006468 mbedtls_md_context_t sha384;
Jerry Yu24c0ec32021-09-09 14:21:07 +08006469
Gilles Peskine449bd832023-01-11 14:50:10 +01006470 if (dst_len < 48) {
6471 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
6472 }
Jerry Yu24c0ec32021-09-09 14:21:07 +08006473
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01006474 mbedtls_md_init(&sha384);
6475 ret = mbedtls_md_setup(&sha384, mbedtls_md_info_from_type(MBEDTLS_MD_SHA384), 0);
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01006476 if (ret != 0) {
6477 goto exit;
6478 }
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01006479 ret = mbedtls_md_clone(&sha384, &ssl->handshake->fin_sha384);
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01006480 if (ret != 0) {
6481 goto exit;
6482 }
Jerry Yu24c0ec32021-09-09 14:21:07 +08006483
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01006484 if ((ret = mbedtls_md_finish(&sha384, dst)) != 0) {
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01006485 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_finish", ret);
Jerry Yu24c0ec32021-09-09 14:21:07 +08006486 goto exit;
6487 }
6488
6489 *olen = 48;
6490
6491exit:
6492
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01006493 mbedtls_md_free(&sha384);
Gilles Peskine449bd832023-01-11 14:50:10 +01006494 return ret;
Jerry Yu24c0ec32021-09-09 14:21:07 +08006495}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006496#endif /* MBEDTLS_MD_CAN_SHA384 */
Jerry Yu24c0ec32021-09-09 14:21:07 +08006497
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006498#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006499MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006500static int ssl_get_handshake_transcript_sha256(mbedtls_ssl_context *ssl,
6501 unsigned char *dst,
6502 size_t dst_len,
6503 size_t *olen)
Jerry Yu24c0ec32021-09-09 14:21:07 +08006504{
Jerry Yu24c0ec32021-09-09 14:21:07 +08006505 int ret;
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01006506 mbedtls_md_context_t sha256;
Jerry Yu24c0ec32021-09-09 14:21:07 +08006507
Gilles Peskine449bd832023-01-11 14:50:10 +01006508 if (dst_len < 32) {
6509 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
6510 }
Jerry Yu24c0ec32021-09-09 14:21:07 +08006511
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01006512 mbedtls_md_init(&sha256);
6513 ret = mbedtls_md_setup(&sha256, mbedtls_md_info_from_type(MBEDTLS_MD_SHA256), 0);
6514 if (ret != 0) {
6515 goto exit;
6516 }
6517 ret = mbedtls_md_clone(&sha256, &ssl->handshake->fin_sha256);
6518 if (ret != 0) {
6519 goto exit;
6520 }
Jerry Yuc5aef882021-12-23 20:15:02 +08006521
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01006522 if ((ret = mbedtls_md_finish(&sha256, dst)) != 0) {
6523 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_finish", ret);
Jerry Yu24c0ec32021-09-09 14:21:07 +08006524 goto exit;
6525 }
6526
6527 *olen = 32;
6528
6529exit:
6530
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01006531 mbedtls_md_free(&sha256);
Gilles Peskine449bd832023-01-11 14:50:10 +01006532 return ret;
Jerry Yu24c0ec32021-09-09 14:21:07 +08006533}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006534#endif /* MBEDTLS_MD_CAN_SHA256 */
Jerry Yu24c0ec32021-09-09 14:21:07 +08006535
Gilles Peskine449bd832023-01-11 14:50:10 +01006536int mbedtls_ssl_get_handshake_transcript(mbedtls_ssl_context *ssl,
6537 const mbedtls_md_type_t md,
6538 unsigned char *dst,
6539 size_t dst_len,
6540 size_t *olen)
Jerry Yu24c0ec32021-09-09 14:21:07 +08006541{
Gilles Peskine449bd832023-01-11 14:50:10 +01006542 switch (md) {
Jerry Yuc1ddeef2021-10-08 15:14:45 +08006543
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006544#if defined(MBEDTLS_MD_CAN_SHA384)
Gilles Peskine449bd832023-01-11 14:50:10 +01006545 case MBEDTLS_MD_SHA384:
6546 return ssl_get_handshake_transcript_sha384(ssl, dst, dst_len, olen);
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006547#endif /* MBEDTLS_MD_CAN_SHA384*/
Jerry Yuc1ddeef2021-10-08 15:14:45 +08006548
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006549#if defined(MBEDTLS_MD_CAN_SHA256)
Gilles Peskine449bd832023-01-11 14:50:10 +01006550 case MBEDTLS_MD_SHA256:
6551 return ssl_get_handshake_transcript_sha256(ssl, dst, dst_len, olen);
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006552#endif /* MBEDTLS_MD_CAN_SHA256*/
Jerry Yuc1ddeef2021-10-08 15:14:45 +08006553
Gilles Peskine449bd832023-01-11 14:50:10 +01006554 default:
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006555#if !defined(MBEDTLS_MD_CAN_SHA384) && \
6556 !defined(MBEDTLS_MD_CAN_SHA256)
Gilles Peskine449bd832023-01-11 14:50:10 +01006557 (void) ssl;
6558 (void) dst;
6559 (void) dst_len;
6560 (void) olen;
Andrzej Kurek409248a2022-10-24 10:33:21 -04006561#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01006562 break;
Jerry Yuc1ddeef2021-10-08 15:14:45 +08006563 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006564 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yu24c0ec32021-09-09 14:21:07 +08006565}
XiaokangQian647719a2021-12-07 09:16:29 +00006566
Jerry Yu148165c2021-09-24 23:20:59 +08006567#endif /* !MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu24c0ec32021-09-09 14:21:07 +08006568
Ronald Crone68ab4f2022-10-05 12:46:29 +02006569#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Gabor Mezei078e8032022-04-27 21:17:56 +02006570/* mbedtls_ssl_parse_sig_alg_ext()
6571 *
6572 * The `extension_data` field of signature algorithm contains a `SignatureSchemeList`
6573 * value (TLS 1.3 RFC8446):
6574 * enum {
6575 * ....
6576 * ecdsa_secp256r1_sha256( 0x0403 ),
6577 * ecdsa_secp384r1_sha384( 0x0503 ),
6578 * ecdsa_secp521r1_sha512( 0x0603 ),
6579 * ....
6580 * } SignatureScheme;
6581 *
6582 * struct {
6583 * SignatureScheme supported_signature_algorithms<2..2^16-2>;
6584 * } SignatureSchemeList;
6585 *
6586 * The `extension_data` field of signature algorithm contains a `SignatureAndHashAlgorithm`
6587 * value (TLS 1.2 RFC5246):
6588 * enum {
6589 * none(0), md5(1), sha1(2), sha224(3), sha256(4), sha384(5),
6590 * sha512(6), (255)
6591 * } HashAlgorithm;
6592 *
6593 * enum { anonymous(0), rsa(1), dsa(2), ecdsa(3), (255) }
6594 * SignatureAlgorithm;
6595 *
6596 * struct {
6597 * HashAlgorithm hash;
6598 * SignatureAlgorithm signature;
6599 * } SignatureAndHashAlgorithm;
6600 *
6601 * SignatureAndHashAlgorithm
6602 * supported_signature_algorithms<2..2^16-2>;
6603 *
6604 * The TLS 1.3 signature algorithm extension was defined to be a compatible
6605 * generalization of the TLS 1.2 signature algorithm extension.
6606 * `SignatureAndHashAlgorithm` field of TLS 1.2 can be represented by
6607 * `SignatureScheme` field of TLS 1.3
6608 *
6609 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006610int mbedtls_ssl_parse_sig_alg_ext(mbedtls_ssl_context *ssl,
6611 const unsigned char *buf,
6612 const unsigned char *end)
Gabor Mezei078e8032022-04-27 21:17:56 +02006613{
6614 const unsigned char *p = buf;
6615 size_t supported_sig_algs_len = 0;
6616 const unsigned char *supported_sig_algs_end;
6617 uint16_t sig_alg;
6618 uint32_t common_idx = 0;
6619
Gilles Peskine449bd832023-01-11 14:50:10 +01006620 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
6621 supported_sig_algs_len = MBEDTLS_GET_UINT16_BE(p, 0);
Gabor Mezei078e8032022-04-27 21:17:56 +02006622 p += 2;
6623
Gilles Peskine449bd832023-01-11 14:50:10 +01006624 memset(ssl->handshake->received_sig_algs, 0,
6625 sizeof(ssl->handshake->received_sig_algs));
Gabor Mezei078e8032022-04-27 21:17:56 +02006626
Gilles Peskine449bd832023-01-11 14:50:10 +01006627 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, supported_sig_algs_len);
Gabor Mezei078e8032022-04-27 21:17:56 +02006628 supported_sig_algs_end = p + supported_sig_algs_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01006629 while (p < supported_sig_algs_end) {
6630 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, supported_sig_algs_end, 2);
6631 sig_alg = MBEDTLS_GET_UINT16_BE(p, 0);
Gabor Mezei078e8032022-04-27 21:17:56 +02006632 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01006633 MBEDTLS_SSL_DEBUG_MSG(4, ("received signature algorithm: 0x%x %s",
6634 sig_alg,
6635 mbedtls_ssl_sig_alg_to_str(sig_alg)));
Jerry Yu2fe6c632022-06-29 10:02:38 +08006636#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01006637 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_2 &&
6638 (!(mbedtls_ssl_sig_alg_is_supported(ssl, sig_alg) &&
6639 mbedtls_ssl_sig_alg_is_offered(ssl, sig_alg)))) {
Gabor Mezei078e8032022-04-27 21:17:56 +02006640 continue;
Jerry Yu2fe6c632022-06-29 10:02:38 +08006641 }
6642#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gabor Mezei078e8032022-04-27 21:17:56 +02006643
Gilles Peskine449bd832023-01-11 14:50:10 +01006644 MBEDTLS_SSL_DEBUG_MSG(4, ("valid signature algorithm: %s",
6645 mbedtls_ssl_sig_alg_to_str(sig_alg)));
Gabor Mezei078e8032022-04-27 21:17:56 +02006646
Gilles Peskine449bd832023-01-11 14:50:10 +01006647 if (common_idx + 1 < MBEDTLS_RECEIVED_SIG_ALGS_SIZE) {
Gabor Mezei078e8032022-04-27 21:17:56 +02006648 ssl->handshake->received_sig_algs[common_idx] = sig_alg;
6649 common_idx += 1;
6650 }
6651 }
6652 /* Check that we consumed all the message. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006653 if (p != end) {
6654 MBEDTLS_SSL_DEBUG_MSG(1,
6655 ("Signature algorithms extension length misaligned"));
6656 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR,
6657 MBEDTLS_ERR_SSL_DECODE_ERROR);
6658 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Gabor Mezei078e8032022-04-27 21:17:56 +02006659 }
6660
Gilles Peskine449bd832023-01-11 14:50:10 +01006661 if (common_idx == 0) {
6662 MBEDTLS_SSL_DEBUG_MSG(3, ("no signature algorithm in common"));
6663 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE,
6664 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE);
6665 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Gabor Mezei078e8032022-04-27 21:17:56 +02006666 }
6667
Gabor Mezei15b95a62022-05-09 16:37:58 +02006668 ssl->handshake->received_sig_algs[common_idx] = MBEDTLS_TLS_SIG_NONE;
Gilles Peskine449bd832023-01-11 14:50:10 +01006669 return 0;
Gabor Mezei078e8032022-04-27 21:17:56 +02006670}
6671
Ronald Crone68ab4f2022-10-05 12:46:29 +02006672#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Gabor Mezei078e8032022-04-27 21:17:56 +02006673
Jerry Yudc7bd172022-02-17 13:44:15 +08006674#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
6675
6676#if defined(MBEDTLS_USE_PSA_CRYPTO)
6677
Gilles Peskine449bd832023-01-11 14:50:10 +01006678static psa_status_t setup_psa_key_derivation(psa_key_derivation_operation_t *derivation,
6679 mbedtls_svc_key_id_t key,
6680 psa_algorithm_t alg,
6681 const unsigned char *raw_psk, size_t raw_psk_length,
6682 const unsigned char *seed, size_t seed_length,
6683 const unsigned char *label, size_t label_length,
6684 const unsigned char *other_secret,
6685 size_t other_secret_length,
6686 size_t capacity)
Jerry Yudc7bd172022-02-17 13:44:15 +08006687{
6688 psa_status_t status;
6689
Gilles Peskine449bd832023-01-11 14:50:10 +01006690 status = psa_key_derivation_setup(derivation, alg);
6691 if (status != PSA_SUCCESS) {
6692 return status;
6693 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006694
Gilles Peskine449bd832023-01-11 14:50:10 +01006695 if (PSA_ALG_IS_TLS12_PRF(alg) || PSA_ALG_IS_TLS12_PSK_TO_MS(alg)) {
6696 status = psa_key_derivation_input_bytes(derivation,
6697 PSA_KEY_DERIVATION_INPUT_SEED,
6698 seed, seed_length);
6699 if (status != PSA_SUCCESS) {
6700 return status;
Przemek Stekiel1f027032022-04-05 17:12:11 +02006701 }
6702
Gilles Peskine449bd832023-01-11 14:50:10 +01006703 if (other_secret != NULL) {
6704 status = psa_key_derivation_input_bytes(derivation,
6705 PSA_KEY_DERIVATION_INPUT_OTHER_SECRET,
6706 other_secret, other_secret_length);
6707 if (status != PSA_SUCCESS) {
6708 return status;
6709 }
6710 }
6711
6712 if (mbedtls_svc_key_id_is_null(key)) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006713 status = psa_key_derivation_input_bytes(
6714 derivation, PSA_KEY_DERIVATION_INPUT_SECRET,
Gilles Peskine449bd832023-01-11 14:50:10 +01006715 raw_psk, raw_psk_length);
6716 } else {
Jerry Yudc7bd172022-02-17 13:44:15 +08006717 status = psa_key_derivation_input_key(
Gilles Peskine449bd832023-01-11 14:50:10 +01006718 derivation, PSA_KEY_DERIVATION_INPUT_SECRET, key);
Jerry Yudc7bd172022-02-17 13:44:15 +08006719 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006720 if (status != PSA_SUCCESS) {
6721 return status;
6722 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006723
Gilles Peskine449bd832023-01-11 14:50:10 +01006724 status = psa_key_derivation_input_bytes(derivation,
6725 PSA_KEY_DERIVATION_INPUT_LABEL,
6726 label, label_length);
6727 if (status != PSA_SUCCESS) {
6728 return status;
6729 }
6730 } else {
6731 return PSA_ERROR_NOT_SUPPORTED;
Jerry Yudc7bd172022-02-17 13:44:15 +08006732 }
6733
Gilles Peskine449bd832023-01-11 14:50:10 +01006734 status = psa_key_derivation_set_capacity(derivation, capacity);
6735 if (status != PSA_SUCCESS) {
6736 return status;
6737 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006738
Gilles Peskine449bd832023-01-11 14:50:10 +01006739 return PSA_SUCCESS;
Jerry Yudc7bd172022-02-17 13:44:15 +08006740}
6741
Andrzej Kurek57d10632022-10-24 10:32:01 -04006742#if defined(PSA_WANT_ALG_SHA_384) || \
6743 defined(PSA_WANT_ALG_SHA_256)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006744MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006745static int tls_prf_generic(mbedtls_md_type_t md_type,
6746 const unsigned char *secret, size_t slen,
6747 const char *label,
6748 const unsigned char *random, size_t rlen,
6749 unsigned char *dstbuf, size_t dlen)
Jerry Yudc7bd172022-02-17 13:44:15 +08006750{
6751 psa_status_t status;
6752 psa_algorithm_t alg;
6753 mbedtls_svc_key_id_t master_key = MBEDTLS_SVC_KEY_ID_INIT;
6754 psa_key_derivation_operation_t derivation =
6755 PSA_KEY_DERIVATION_OPERATION_INIT;
6756
Gilles Peskine449bd832023-01-11 14:50:10 +01006757 if (md_type == MBEDTLS_MD_SHA384) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006758 alg = PSA_ALG_TLS12_PRF(PSA_ALG_SHA_384);
Gilles Peskine449bd832023-01-11 14:50:10 +01006759 } else {
Jerry Yudc7bd172022-02-17 13:44:15 +08006760 alg = PSA_ALG_TLS12_PRF(PSA_ALG_SHA_256);
Gilles Peskine449bd832023-01-11 14:50:10 +01006761 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006762
6763 /* Normally a "secret" should be long enough to be impossible to
6764 * find by brute force, and in particular should not be empty. But
6765 * this PRF is also used to derive an IV, in particular in EAP-TLS,
6766 * and for this use case it makes sense to have a 0-length "secret".
6767 * Since the key API doesn't allow importing a key of length 0,
6768 * keep master_key=0, which setup_psa_key_derivation() understands
6769 * to mean a 0-length "secret" input. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006770 if (slen != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006771 psa_key_attributes_t key_attributes = psa_key_attributes_init();
Gilles Peskine449bd832023-01-11 14:50:10 +01006772 psa_set_key_usage_flags(&key_attributes, PSA_KEY_USAGE_DERIVE);
6773 psa_set_key_algorithm(&key_attributes, alg);
6774 psa_set_key_type(&key_attributes, PSA_KEY_TYPE_DERIVE);
Jerry Yudc7bd172022-02-17 13:44:15 +08006775
Gilles Peskine449bd832023-01-11 14:50:10 +01006776 status = psa_import_key(&key_attributes, secret, slen, &master_key);
6777 if (status != PSA_SUCCESS) {
6778 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
6779 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006780 }
6781
Gilles Peskine449bd832023-01-11 14:50:10 +01006782 status = setup_psa_key_derivation(&derivation,
6783 master_key, alg,
6784 NULL, 0,
6785 random, rlen,
6786 (unsigned char const *) label,
6787 (size_t) strlen(label),
6788 NULL, 0,
6789 dlen);
6790 if (status != PSA_SUCCESS) {
6791 psa_key_derivation_abort(&derivation);
6792 psa_destroy_key(master_key);
6793 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yudc7bd172022-02-17 13:44:15 +08006794 }
6795
Gilles Peskine449bd832023-01-11 14:50:10 +01006796 status = psa_key_derivation_output_bytes(&derivation, dstbuf, dlen);
6797 if (status != PSA_SUCCESS) {
6798 psa_key_derivation_abort(&derivation);
6799 psa_destroy_key(master_key);
6800 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yudc7bd172022-02-17 13:44:15 +08006801 }
6802
Gilles Peskine449bd832023-01-11 14:50:10 +01006803 status = psa_key_derivation_abort(&derivation);
6804 if (status != PSA_SUCCESS) {
6805 psa_destroy_key(master_key);
6806 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yudc7bd172022-02-17 13:44:15 +08006807 }
6808
Gilles Peskine449bd832023-01-11 14:50:10 +01006809 if (!mbedtls_svc_key_id_is_null(master_key)) {
6810 status = psa_destroy_key(master_key);
6811 }
6812 if (status != PSA_SUCCESS) {
6813 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
6814 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006815
Gilles Peskine449bd832023-01-11 14:50:10 +01006816 return 0;
Jerry Yudc7bd172022-02-17 13:44:15 +08006817}
Andrzej Kurek57d10632022-10-24 10:32:01 -04006818#endif /* PSA_WANT_ALG_SHA_256 || PSA_WANT_ALG_SHA_384 */
Jerry Yudc7bd172022-02-17 13:44:15 +08006819#else /* MBEDTLS_USE_PSA_CRYPTO */
6820
Andrzej Kurek57d10632022-10-24 10:32:01 -04006821#if defined(MBEDTLS_MD_C) && \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006822 (defined(MBEDTLS_MD_CAN_SHA256) || \
6823 defined(MBEDTLS_MD_CAN_SHA384))
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006824MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006825static int tls_prf_generic(mbedtls_md_type_t md_type,
6826 const unsigned char *secret, size_t slen,
6827 const char *label,
6828 const unsigned char *random, size_t rlen,
6829 unsigned char *dstbuf, size_t dlen)
Jerry Yudc7bd172022-02-17 13:44:15 +08006830{
6831 size_t nb;
6832 size_t i, j, k, md_len;
6833 unsigned char *tmp;
6834 size_t tmp_len = 0;
6835 unsigned char h_i[MBEDTLS_MD_MAX_SIZE];
6836 const mbedtls_md_info_t *md_info;
6837 mbedtls_md_context_t md_ctx;
6838 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6839
Gilles Peskine449bd832023-01-11 14:50:10 +01006840 mbedtls_md_init(&md_ctx);
Jerry Yudc7bd172022-02-17 13:44:15 +08006841
Gilles Peskine449bd832023-01-11 14:50:10 +01006842 if ((md_info = mbedtls_md_info_from_type(md_type)) == NULL) {
6843 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
6844 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006845
Gilles Peskine449bd832023-01-11 14:50:10 +01006846 md_len = mbedtls_md_get_size(md_info);
Jerry Yudc7bd172022-02-17 13:44:15 +08006847
Gilles Peskine449bd832023-01-11 14:50:10 +01006848 tmp_len = md_len + strlen(label) + rlen;
6849 tmp = mbedtls_calloc(1, tmp_len);
6850 if (tmp == NULL) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006851 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
6852 goto exit;
6853 }
6854
Gilles Peskine449bd832023-01-11 14:50:10 +01006855 nb = strlen(label);
6856 memcpy(tmp + md_len, label, nb);
6857 memcpy(tmp + md_len + nb, random, rlen);
Jerry Yudc7bd172022-02-17 13:44:15 +08006858 nb += rlen;
6859
6860 /*
6861 * Compute P_<hash>(secret, label + random)[0..dlen]
6862 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006863 if ((ret = mbedtls_md_setup(&md_ctx, md_info, 1)) != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006864 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006865 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006866
Gilles Peskine449bd832023-01-11 14:50:10 +01006867 ret = mbedtls_md_hmac_starts(&md_ctx, secret, slen);
6868 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006869 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006870 }
6871 ret = mbedtls_md_hmac_update(&md_ctx, tmp + md_len, nb);
6872 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006873 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006874 }
6875 ret = mbedtls_md_hmac_finish(&md_ctx, tmp);
6876 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006877 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006878 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006879
Gilles Peskine449bd832023-01-11 14:50:10 +01006880 for (i = 0; i < dlen; i += md_len) {
6881 ret = mbedtls_md_hmac_reset(&md_ctx);
6882 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006883 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006884 }
6885 ret = mbedtls_md_hmac_update(&md_ctx, tmp, md_len + nb);
6886 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006887 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006888 }
6889 ret = mbedtls_md_hmac_finish(&md_ctx, h_i);
6890 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006891 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006892 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006893
Gilles Peskine449bd832023-01-11 14:50:10 +01006894 ret = mbedtls_md_hmac_reset(&md_ctx);
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_update(&md_ctx, tmp, md_len);
6899 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006900 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006901 }
6902 ret = mbedtls_md_hmac_finish(&md_ctx, tmp);
6903 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006904 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006905 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006906
Gilles Peskine449bd832023-01-11 14:50:10 +01006907 k = (i + md_len > dlen) ? dlen % md_len : md_len;
Jerry Yudc7bd172022-02-17 13:44:15 +08006908
Gilles Peskine449bd832023-01-11 14:50:10 +01006909 for (j = 0; j < k; j++) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006910 dstbuf[i + j] = h_i[j];
Gilles Peskine449bd832023-01-11 14:50:10 +01006911 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006912 }
6913
6914exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01006915 mbedtls_md_free(&md_ctx);
Jerry Yudc7bd172022-02-17 13:44:15 +08006916
Gilles Peskine449bd832023-01-11 14:50:10 +01006917 if (tmp != NULL) {
6918 mbedtls_platform_zeroize(tmp, tmp_len);
6919 }
Dave Rodgman29b9b2b2022-11-01 16:08:14 +00006920
Gilles Peskine449bd832023-01-11 14:50:10 +01006921 mbedtls_platform_zeroize(h_i, sizeof(h_i));
Jerry Yudc7bd172022-02-17 13:44:15 +08006922
Gilles Peskine449bd832023-01-11 14:50:10 +01006923 mbedtls_free(tmp);
Jerry Yudc7bd172022-02-17 13:44:15 +08006924
Gilles Peskine449bd832023-01-11 14:50:10 +01006925 return ret;
Jerry Yudc7bd172022-02-17 13:44:15 +08006926}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006927#endif /* MBEDTLS_MD_C && ( MBEDTLS_MD_CAN_SHA256 || MBEDTLS_MD_CAN_SHA384 ) */
Jerry Yudc7bd172022-02-17 13:44:15 +08006928#endif /* MBEDTLS_USE_PSA_CRYPTO */
6929
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006930#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006931MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006932static int tls_prf_sha256(const unsigned char *secret, size_t slen,
6933 const char *label,
6934 const unsigned char *random, size_t rlen,
6935 unsigned char *dstbuf, size_t dlen)
Jerry Yudc7bd172022-02-17 13:44:15 +08006936{
Gilles Peskine449bd832023-01-11 14:50:10 +01006937 return tls_prf_generic(MBEDTLS_MD_SHA256, secret, slen,
6938 label, random, rlen, dstbuf, dlen);
Jerry Yudc7bd172022-02-17 13:44:15 +08006939}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006940#endif /* MBEDTLS_MD_CAN_SHA256*/
Jerry Yudc7bd172022-02-17 13:44:15 +08006941
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006942#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006943MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006944static int tls_prf_sha384(const unsigned char *secret, size_t slen,
6945 const char *label,
6946 const unsigned char *random, size_t rlen,
6947 unsigned char *dstbuf, size_t dlen)
Jerry Yudc7bd172022-02-17 13:44:15 +08006948{
Gilles Peskine449bd832023-01-11 14:50:10 +01006949 return tls_prf_generic(MBEDTLS_MD_SHA384, secret, slen,
6950 label, random, rlen, dstbuf, dlen);
Jerry Yudc7bd172022-02-17 13:44:15 +08006951}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006952#endif /* MBEDTLS_MD_CAN_SHA384*/
Jerry Yudc7bd172022-02-17 13:44:15 +08006953
Jerry Yuf009d862022-02-17 14:01:37 +08006954/*
6955 * Set appropriate PRF function and other SSL / TLS1.2 functions
6956 *
6957 * Inputs:
Jerry Yuf009d862022-02-17 14:01:37 +08006958 * - hash associated with the ciphersuite (only used by TLS 1.2)
6959 *
6960 * Outputs:
6961 * - the tls_prf, calc_verify and calc_finished members of handshake structure
6962 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006963MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006964static int ssl_set_handshake_prfs(mbedtls_ssl_handshake_params *handshake,
6965 mbedtls_md_type_t hash)
Jerry Yuf009d862022-02-17 14:01:37 +08006966{
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006967#if defined(MBEDTLS_MD_CAN_SHA384)
Gilles Peskine449bd832023-01-11 14:50:10 +01006968 if (hash == MBEDTLS_MD_SHA384) {
Jerry Yuf009d862022-02-17 14:01:37 +08006969 handshake->tls_prf = tls_prf_sha384;
6970 handshake->calc_verify = ssl_calc_verify_tls_sha384;
6971 handshake->calc_finished = ssl_calc_finished_tls_sha384;
Gilles Peskine449bd832023-01-11 14:50:10 +01006972 } else
Jerry Yuf009d862022-02-17 14:01:37 +08006973#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006974#if defined(MBEDTLS_MD_CAN_SHA256)
Jerry Yuf009d862022-02-17 14:01:37 +08006975 {
Ronald Cron81591aa2022-03-07 09:05:51 +01006976 (void) hash;
Jerry Yuf009d862022-02-17 14:01:37 +08006977 handshake->tls_prf = tls_prf_sha256;
6978 handshake->calc_verify = ssl_calc_verify_tls_sha256;
6979 handshake->calc_finished = ssl_calc_finished_tls_sha256;
6980 }
Ronald Cron81591aa2022-03-07 09:05:51 +01006981#else
Jerry Yuf009d862022-02-17 14:01:37 +08006982 {
Jerry Yuf009d862022-02-17 14:01:37 +08006983 (void) handshake;
Ronald Cron81591aa2022-03-07 09:05:51 +01006984 (void) hash;
Gilles Peskine449bd832023-01-11 14:50:10 +01006985 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yuf009d862022-02-17 14:01:37 +08006986 }
Ronald Cron81591aa2022-03-07 09:05:51 +01006987#endif
Jerry Yuf009d862022-02-17 14:01:37 +08006988
Gilles Peskine449bd832023-01-11 14:50:10 +01006989 return 0;
Jerry Yuf009d862022-02-17 14:01:37 +08006990}
Jerry Yud6ab2352022-02-17 14:03:43 +08006991
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006992/*
6993 * Compute master secret if needed
6994 *
6995 * Parameters:
6996 * [in/out] handshake
6997 * [in] resume, premaster, extended_ms, calc_verify, tls_prf
6998 * (PSA-PSK) ciphersuite_info, psk_opaque
6999 * [out] premaster (cleared)
7000 * [out] master
7001 * [in] ssl: optionally used for debugging, EMS and PSA-PSK
7002 * debug: conf->f_dbg, conf->p_dbg
7003 * EMS: passed to calc_verify (debug + session_negotiate)
Ronald Crona25cf582022-03-07 11:10:36 +01007004 * PSA-PSA: conf
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007005 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007006MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007007static int ssl_compute_master(mbedtls_ssl_handshake_params *handshake,
7008 unsigned char *master,
7009 const mbedtls_ssl_context *ssl)
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007010{
7011 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7012
7013 /* cf. RFC 5246, Section 8.1:
7014 * "The master secret is always exactly 48 bytes in length." */
7015 size_t const master_secret_len = 48;
7016
7017#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
7018 unsigned char session_hash[48];
7019#endif /* MBEDTLS_SSL_EXTENDED_MASTER_SECRET */
7020
7021 /* The label for the KDF used for key expansion.
7022 * This is either "master secret" or "extended master secret"
7023 * depending on whether the Extended Master Secret extension
7024 * is used. */
7025 char const *lbl = "master secret";
7026
Przemek Stekielae4ed302022-04-05 17:15:55 +02007027 /* The seed for the KDF used for key expansion.
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007028 * - If the Extended Master Secret extension is not used,
7029 * this is ClientHello.Random + ServerHello.Random
7030 * (see Sect. 8.1 in RFC 5246).
7031 * - If the Extended Master Secret extension is used,
7032 * this is the transcript of the handshake so far.
7033 * (see Sect. 4 in RFC 7627). */
Przemek Stekielae4ed302022-04-05 17:15:55 +02007034 unsigned char const *seed = handshake->randbytes;
7035 size_t seed_len = 64;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007036
7037#if !defined(MBEDTLS_DEBUG_C) && \
7038 !defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET) && \
7039 !(defined(MBEDTLS_USE_PSA_CRYPTO) && \
Gilles Peskine449bd832023-01-11 14:50:10 +01007040 defined(MBEDTLS_KEY_EXCHANGE_PSK_ENABLED))
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007041 ssl = NULL; /* make sure we don't use it except for those cases */
7042 (void) ssl;
7043#endif
7044
Gilles Peskine449bd832023-01-11 14:50:10 +01007045 if (handshake->resume != 0) {
7046 MBEDTLS_SSL_DEBUG_MSG(3, ("no premaster (session resumed)"));
7047 return 0;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007048 }
7049
7050#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
Gilles Peskine449bd832023-01-11 14:50:10 +01007051 if (handshake->extended_ms == MBEDTLS_SSL_EXTENDED_MS_ENABLED) {
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007052 lbl = "extended master secret";
Przemek Stekielae4ed302022-04-05 17:15:55 +02007053 seed = session_hash;
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01007054 ret = handshake->calc_verify(ssl, session_hash, &seed_len);
7055 if (ret != 0) {
7056 MBEDTLS_SSL_DEBUG_RET(1, "calc_verify", ret);
7057 }
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007058
Gilles Peskine449bd832023-01-11 14:50:10 +01007059 MBEDTLS_SSL_DEBUG_BUF(3, "session hash for extended master secret",
7060 session_hash, seed_len);
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007061 }
Przemek Stekiel169bf0b2022-04-29 07:53:29 +02007062#endif /* MBEDTLS_SSL_EXTENDED_MASTER_SECRET */
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007063
Przemek Stekiel99114f32022-04-22 11:20:09 +02007064#if defined(MBEDTLS_USE_PSA_CRYPTO) && \
Przemek Stekiel8a4b7fd2022-04-28 09:22:22 +02007065 defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007066 if (mbedtls_ssl_ciphersuite_uses_psk(handshake->ciphersuite_info) == 1) {
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007067 /* Perform PSK-to-MS expansion in a single step. */
7068 psa_status_t status;
7069 psa_algorithm_t alg;
7070 mbedtls_svc_key_id_t psk;
7071 psa_key_derivation_operation_t derivation =
7072 PSA_KEY_DERIVATION_OPERATION_INIT;
Dave Rodgman2eab4622023-10-05 13:30:37 +01007073 mbedtls_md_type_t hash_alg = (mbedtls_md_type_t) handshake->ciphersuite_info->mac;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007074
Gilles Peskine449bd832023-01-11 14:50:10 +01007075 MBEDTLS_SSL_DEBUG_MSG(2, ("perform PSA-based PSK-to-MS expansion"));
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007076
Gilles Peskine449bd832023-01-11 14:50:10 +01007077 psk = mbedtls_ssl_get_opaque_psk(ssl);
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007078
Gilles Peskine449bd832023-01-11 14:50:10 +01007079 if (hash_alg == MBEDTLS_MD_SHA384) {
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007080 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_384);
Gilles Peskine449bd832023-01-11 14:50:10 +01007081 } else {
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007082 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_256);
Gilles Peskine449bd832023-01-11 14:50:10 +01007083 }
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007084
Przemek Stekiel51a1f362022-04-13 08:57:06 +02007085 size_t other_secret_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01007086 unsigned char *other_secret = NULL;
Przemek Stekielc2033402022-04-05 17:19:41 +02007087
Gilles Peskine449bd832023-01-11 14:50:10 +01007088 switch (handshake->ciphersuite_info->key_exchange) {
Przemek Stekiel19b80f82022-04-14 08:29:31 +02007089 /* Provide other secret.
Przemek Stekiel51a1f362022-04-13 08:57:06 +02007090 * Other secret is stored in premaster, where first 2 bytes hold the
Przemek Stekiel19b80f82022-04-14 08:29:31 +02007091 * length of the other key.
Przemek Stekielc2033402022-04-05 17:19:41 +02007092 */
Przemek Stekiel19b80f82022-04-14 08:29:31 +02007093 case MBEDTLS_KEY_EXCHANGE_RSA_PSK:
Przemek Stekiel8abcee92022-04-28 09:16:28 +02007094 /* For RSA-PSK other key length is always 48 bytes. */
Przemek Stekiel19b80f82022-04-14 08:29:31 +02007095 other_secret_len = 48;
7096 other_secret = handshake->premaster + 2;
7097 break;
7098 case MBEDTLS_KEY_EXCHANGE_ECDHE_PSK:
Przemek Stekielb293aaa2022-04-19 12:22:38 +02007099 case MBEDTLS_KEY_EXCHANGE_DHE_PSK:
Przemek Stekiel19b80f82022-04-14 08:29:31 +02007100 other_secret_len = MBEDTLS_GET_UINT16_BE(handshake->premaster, 0);
7101 other_secret = handshake->premaster + 2;
7102 break;
7103 default:
7104 break;
Przemek Stekielc2033402022-04-05 17:19:41 +02007105 }
7106
Gilles Peskine449bd832023-01-11 14:50:10 +01007107 status = setup_psa_key_derivation(&derivation, psk, alg,
7108 ssl->conf->psk, ssl->conf->psk_len,
7109 seed, seed_len,
7110 (unsigned char const *) lbl,
7111 (size_t) strlen(lbl),
7112 other_secret, other_secret_len,
7113 master_secret_len);
7114 if (status != PSA_SUCCESS) {
7115 psa_key_derivation_abort(&derivation);
7116 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007117 }
7118
Gilles Peskine449bd832023-01-11 14:50:10 +01007119 status = psa_key_derivation_output_bytes(&derivation,
7120 master,
7121 master_secret_len);
7122 if (status != PSA_SUCCESS) {
7123 psa_key_derivation_abort(&derivation);
7124 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007125 }
7126
Gilles Peskine449bd832023-01-11 14:50:10 +01007127 status = psa_key_derivation_abort(&derivation);
7128 if (status != PSA_SUCCESS) {
7129 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
7130 }
7131 } else
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007132#endif
7133 {
Neil Armstrongca7d5062022-05-31 14:43:23 +02007134#if defined(MBEDTLS_USE_PSA_CRYPTO) && \
Gilles Peskine449bd832023-01-11 14:50:10 +01007135 defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
7136 if (handshake->ciphersuite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_ECJPAKE) {
Neil Armstrongca7d5062022-05-31 14:43:23 +02007137 psa_status_t status;
7138 psa_algorithm_t alg = PSA_ALG_TLS12_ECJPAKE_TO_PMS;
7139 psa_key_derivation_operation_t derivation =
7140 PSA_KEY_DERIVATION_OPERATION_INIT;
7141
Gilles Peskine449bd832023-01-11 14:50:10 +01007142 MBEDTLS_SSL_DEBUG_MSG(2, ("perform PSA-based PMS KDF for ECJPAKE"));
Neil Armstrongca7d5062022-05-31 14:43:23 +02007143
7144 handshake->pmslen = PSA_TLS12_ECJPAKE_TO_PMS_DATA_SIZE;
7145
Gilles Peskine449bd832023-01-11 14:50:10 +01007146 status = psa_key_derivation_setup(&derivation, alg);
7147 if (status != PSA_SUCCESS) {
7148 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Neil Armstrongca7d5062022-05-31 14:43:23 +02007149 }
7150
Gilles Peskine449bd832023-01-11 14:50:10 +01007151 status = psa_key_derivation_set_capacity(&derivation,
7152 PSA_TLS12_ECJPAKE_TO_PMS_DATA_SIZE);
7153 if (status != PSA_SUCCESS) {
7154 psa_key_derivation_abort(&derivation);
7155 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Neil Armstrongca7d5062022-05-31 14:43:23 +02007156 }
7157
Gilles Peskine449bd832023-01-11 14:50:10 +01007158 status = psa_pake_get_implicit_key(&handshake->psa_pake_ctx,
7159 &derivation);
7160 if (status != PSA_SUCCESS) {
7161 psa_key_derivation_abort(&derivation);
7162 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Neil Armstrongca7d5062022-05-31 14:43:23 +02007163 }
7164
Gilles Peskine449bd832023-01-11 14:50:10 +01007165 status = psa_key_derivation_output_bytes(&derivation,
7166 handshake->premaster,
7167 handshake->pmslen);
7168 if (status != PSA_SUCCESS) {
7169 psa_key_derivation_abort(&derivation);
7170 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
7171 }
7172
7173 status = psa_key_derivation_abort(&derivation);
7174 if (status != PSA_SUCCESS) {
7175 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Neil Armstrongca7d5062022-05-31 14:43:23 +02007176 }
7177 }
7178#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01007179 ret = handshake->tls_prf(handshake->premaster, handshake->pmslen,
7180 lbl, seed, seed_len,
7181 master,
7182 master_secret_len);
7183 if (ret != 0) {
7184 MBEDTLS_SSL_DEBUG_RET(1, "prf", ret);
7185 return ret;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007186 }
7187
Gilles Peskine449bd832023-01-11 14:50:10 +01007188 MBEDTLS_SSL_DEBUG_BUF(3, "premaster secret",
7189 handshake->premaster,
7190 handshake->pmslen);
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007191
Gilles Peskine449bd832023-01-11 14:50:10 +01007192 mbedtls_platform_zeroize(handshake->premaster,
7193 sizeof(handshake->premaster));
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007194 }
7195
Gilles Peskine449bd832023-01-11 14:50:10 +01007196 return 0;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007197}
7198
Gilles Peskine449bd832023-01-11 14:50:10 +01007199int mbedtls_ssl_derive_keys(mbedtls_ssl_context *ssl)
Jerry Yud62f87e2022-02-17 14:09:02 +08007200{
7201 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7202 const mbedtls_ssl_ciphersuite_t * const ciphersuite_info =
7203 ssl->handshake->ciphersuite_info;
7204
Gilles Peskine449bd832023-01-11 14:50:10 +01007205 MBEDTLS_SSL_DEBUG_MSG(2, ("=> derive keys"));
Jerry Yud62f87e2022-02-17 14:09:02 +08007206
7207 /* Set PRF, calc_verify and calc_finished function pointers */
Gilles Peskine449bd832023-01-11 14:50:10 +01007208 ret = ssl_set_handshake_prfs(ssl->handshake,
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01007209 (mbedtls_md_type_t) ciphersuite_info->mac);
Gilles Peskine449bd832023-01-11 14:50:10 +01007210 if (ret != 0) {
7211 MBEDTLS_SSL_DEBUG_RET(1, "ssl_set_handshake_prfs", ret);
7212 return ret;
Jerry Yud62f87e2022-02-17 14:09:02 +08007213 }
7214
7215 /* Compute master secret if needed */
Gilles Peskine449bd832023-01-11 14:50:10 +01007216 ret = ssl_compute_master(ssl->handshake,
7217 ssl->session_negotiate->master,
7218 ssl);
7219 if (ret != 0) {
7220 MBEDTLS_SSL_DEBUG_RET(1, "ssl_compute_master", ret);
7221 return ret;
Jerry Yud62f87e2022-02-17 14:09:02 +08007222 }
7223
7224 /* Swap the client and server random values:
7225 * - MS derivation wanted client+server (RFC 5246 8.1)
7226 * - key derivation wants server+client (RFC 5246 6.3) */
7227 {
7228 unsigned char tmp[64];
Gilles Peskine449bd832023-01-11 14:50:10 +01007229 memcpy(tmp, ssl->handshake->randbytes, 64);
7230 memcpy(ssl->handshake->randbytes, tmp + 32, 32);
7231 memcpy(ssl->handshake->randbytes + 32, tmp, 32);
7232 mbedtls_platform_zeroize(tmp, sizeof(tmp));
Jerry Yud62f87e2022-02-17 14:09:02 +08007233 }
7234
7235 /* Populate transform structure */
Gilles Peskine449bd832023-01-11 14:50:10 +01007236 ret = ssl_tls12_populate_transform(ssl->transform_negotiate,
7237 ssl->session_negotiate->ciphersuite,
7238 ssl->session_negotiate->master,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02007239#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01007240 ssl->session_negotiate->encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02007241#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01007242 ssl->handshake->tls_prf,
7243 ssl->handshake->randbytes,
7244 ssl->tls_version,
7245 ssl->conf->endpoint,
7246 ssl);
7247 if (ret != 0) {
7248 MBEDTLS_SSL_DEBUG_RET(1, "ssl_tls12_populate_transform", ret);
7249 return ret;
Jerry Yud62f87e2022-02-17 14:09:02 +08007250 }
7251
7252 /* We no longer need Server/ClientHello.random values */
Gilles Peskine449bd832023-01-11 14:50:10 +01007253 mbedtls_platform_zeroize(ssl->handshake->randbytes,
7254 sizeof(ssl->handshake->randbytes));
Jerry Yud62f87e2022-02-17 14:09:02 +08007255
Gilles Peskine449bd832023-01-11 14:50:10 +01007256 MBEDTLS_SSL_DEBUG_MSG(2, ("<= derive keys"));
Jerry Yud62f87e2022-02-17 14:09:02 +08007257
Gilles Peskine449bd832023-01-11 14:50:10 +01007258 return 0;
Jerry Yud62f87e2022-02-17 14:09:02 +08007259}
Jerry Yu8392e0d2022-02-17 14:10:24 +08007260
Gilles Peskine449bd832023-01-11 14:50:10 +01007261int mbedtls_ssl_set_calc_verify_md(mbedtls_ssl_context *ssl, int md)
Ronald Cron4dcbca92022-03-07 10:21:40 +01007262{
Gilles Peskine449bd832023-01-11 14:50:10 +01007263 switch (md) {
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01007264#if defined(MBEDTLS_MD_CAN_SHA384)
Ronald Cron4dcbca92022-03-07 10:21:40 +01007265 case MBEDTLS_SSL_HASH_SHA384:
7266 ssl->handshake->calc_verify = ssl_calc_verify_tls_sha384;
7267 break;
7268#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01007269#if defined(MBEDTLS_MD_CAN_SHA256)
Ronald Cron4dcbca92022-03-07 10:21:40 +01007270 case MBEDTLS_SSL_HASH_SHA256:
7271 ssl->handshake->calc_verify = ssl_calc_verify_tls_sha256;
7272 break;
7273#endif
7274 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01007275 return -1;
Ronald Cron4dcbca92022-03-07 10:21:40 +01007276 }
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01007277#if !defined(MBEDTLS_MD_CAN_SHA384) && \
7278 !defined(MBEDTLS_MD_CAN_SHA256)
Andrzej Kurekeabeb302022-10-17 07:52:51 -04007279 (void) ssl;
7280#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01007281 return 0;
Ronald Cron4dcbca92022-03-07 10:21:40 +01007282}
7283
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007284#if defined(MBEDTLS_USE_PSA_CRYPTO)
7285static int ssl_calc_verify_tls_psa(const mbedtls_ssl_context *ssl,
7286 const psa_hash_operation_t *hs_op,
7287 size_t buffer_size,
7288 unsigned char *hash,
7289 size_t *hlen)
7290{
7291 psa_status_t status;
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007292 psa_hash_operation_t cloned_op = psa_hash_operation_init();
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007293
7294#if !defined(MBEDTLS_DEBUG_C)
7295 (void) ssl;
7296#endif
7297 MBEDTLS_SSL_DEBUG_MSG(2, ("=> PSA calc verify"));
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007298 status = psa_hash_clone(hs_op, &cloned_op);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007299 if (status != PSA_SUCCESS) {
7300 goto exit;
7301 }
7302
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007303 status = psa_hash_finish(&cloned_op, hash, buffer_size, hlen);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007304 if (status != PSA_SUCCESS) {
7305 goto exit;
7306 }
7307
7308 MBEDTLS_SSL_DEBUG_BUF(3, "PSA calculated verify result", hash, *hlen);
7309 MBEDTLS_SSL_DEBUG_MSG(2, ("<= PSA calc verify"));
7310
7311exit:
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007312 psa_hash_abort(&cloned_op);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007313 return mbedtls_md_error_from_psa(status);
7314}
7315#else
7316static int ssl_calc_verify_tls_legacy(const mbedtls_ssl_context *ssl,
7317 const mbedtls_md_context_t *hs_ctx,
7318 unsigned char *hash,
7319 size_t *hlen)
7320{
7321 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007322 mbedtls_md_context_t cloned_ctx;
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007323
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007324 mbedtls_md_init(&cloned_ctx);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007325
7326#if !defined(MBEDTLS_DEBUG_C)
7327 (void) ssl;
7328#endif
7329 MBEDTLS_SSL_DEBUG_MSG(2, ("=> calc verify"));
7330
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007331 ret = mbedtls_md_setup(&cloned_ctx, mbedtls_md_info_from_ctx(hs_ctx), 0);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007332 if (ret != 0) {
7333 goto exit;
7334 }
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007335 ret = mbedtls_md_clone(&cloned_ctx, hs_ctx);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007336 if (ret != 0) {
7337 goto exit;
7338 }
7339
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007340 ret = mbedtls_md_finish(&cloned_ctx, hash);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007341 if (ret != 0) {
7342 goto exit;
7343 }
7344
7345 *hlen = mbedtls_md_get_size(mbedtls_md_info_from_ctx(hs_ctx));
7346
7347 MBEDTLS_SSL_DEBUG_BUF(3, "calculated verify result", hash, *hlen);
7348 MBEDTLS_SSL_DEBUG_MSG(2, ("<= calc verify"));
7349
7350exit:
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007351 mbedtls_md_free(&cloned_ctx);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007352 return ret;
7353}
7354#endif /* MBEDTLS_USE_PSA_CRYPTO */
7355
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01007356#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +01007357int ssl_calc_verify_tls_sha256(const mbedtls_ssl_context *ssl,
7358 unsigned char *hash,
7359 size_t *hlen)
Jerry Yu8392e0d2022-02-17 14:10:24 +08007360{
7361#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007362 return ssl_calc_verify_tls_psa(ssl, &ssl->handshake->fin_sha256_psa, 32,
7363 hash, hlen);
Jerry Yu8392e0d2022-02-17 14:10:24 +08007364#else
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007365 return ssl_calc_verify_tls_legacy(ssl, &ssl->handshake->fin_sha256,
7366 hash, hlen);
Jerry Yu8392e0d2022-02-17 14:10:24 +08007367#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu8392e0d2022-02-17 14:10:24 +08007368}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01007369#endif /* MBEDTLS_MD_CAN_SHA256 */
Jerry Yu8392e0d2022-02-17 14:10:24 +08007370
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01007371#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +01007372int ssl_calc_verify_tls_sha384(const mbedtls_ssl_context *ssl,
7373 unsigned char *hash,
7374 size_t *hlen)
Jerry Yuc1cb3842022-02-17 14:13:48 +08007375{
7376#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007377 return ssl_calc_verify_tls_psa(ssl, &ssl->handshake->fin_sha384_psa, 48,
7378 hash, hlen);
Jerry Yuc1cb3842022-02-17 14:13:48 +08007379#else
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007380 return ssl_calc_verify_tls_legacy(ssl, &ssl->handshake->fin_sha384,
7381 hash, hlen);
Jerry Yuc1cb3842022-02-17 14:13:48 +08007382#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yuc1cb3842022-02-17 14:13:48 +08007383}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01007384#endif /* MBEDTLS_MD_CAN_SHA384 */
Jerry Yuc1cb3842022-02-17 14:13:48 +08007385
Neil Armstrong80f6f322022-05-03 17:56:38 +02007386#if !defined(MBEDTLS_USE_PSA_CRYPTO) && \
7387 defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007388int mbedtls_ssl_psk_derive_premaster(mbedtls_ssl_context *ssl, mbedtls_key_exchange_type_t key_ex)
Jerry Yuce3dca42022-02-17 14:16:37 +08007389{
7390 unsigned char *p = ssl->handshake->premaster;
Gilles Peskine449bd832023-01-11 14:50:10 +01007391 unsigned char *end = p + sizeof(ssl->handshake->premaster);
Jerry Yuce3dca42022-02-17 14:16:37 +08007392 const unsigned char *psk = NULL;
7393 size_t psk_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01007394 int psk_ret = mbedtls_ssl_get_psk(ssl, &psk, &psk_len);
Jerry Yuce3dca42022-02-17 14:16:37 +08007395
Gilles Peskine449bd832023-01-11 14:50:10 +01007396 if (psk_ret == MBEDTLS_ERR_SSL_PRIVATE_KEY_REQUIRED) {
Jerry Yuce3dca42022-02-17 14:16:37 +08007397 /*
7398 * This should never happen because the existence of a PSK is always
Przemek Stekielb293aaa2022-04-19 12:22:38 +02007399 * checked before calling this function.
7400 *
7401 * The exception is opaque DHE-PSK. For DHE-PSK fill premaster with
Przemek Stekiel8abcee92022-04-28 09:16:28 +02007402 * the shared secret without PSK.
Jerry Yuce3dca42022-02-17 14:16:37 +08007403 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007404 if (key_ex != MBEDTLS_KEY_EXCHANGE_DHE_PSK) {
7405 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
7406 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Przemek Stekielb293aaa2022-04-19 12:22:38 +02007407 }
Jerry Yuce3dca42022-02-17 14:16:37 +08007408 }
7409
7410 /*
7411 * PMS = struct {
7412 * opaque other_secret<0..2^16-1>;
7413 * opaque psk<0..2^16-1>;
7414 * };
7415 * with "other_secret" depending on the particular key exchange
7416 */
7417#if defined(MBEDTLS_KEY_EXCHANGE_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007418 if (key_ex == MBEDTLS_KEY_EXCHANGE_PSK) {
7419 if (end - p < 2) {
7420 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
7421 }
Jerry Yuce3dca42022-02-17 14:16:37 +08007422
Gilles Peskine449bd832023-01-11 14:50:10 +01007423 MBEDTLS_PUT_UINT16_BE(psk_len, p, 0);
Jerry Yuce3dca42022-02-17 14:16:37 +08007424 p += 2;
7425
Gilles Peskine449bd832023-01-11 14:50:10 +01007426 if (end < p || (size_t) (end - p) < psk_len) {
7427 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
7428 }
Jerry Yuce3dca42022-02-17 14:16:37 +08007429
Gilles Peskine449bd832023-01-11 14:50:10 +01007430 memset(p, 0, psk_len);
Jerry Yuce3dca42022-02-17 14:16:37 +08007431 p += psk_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01007432 } else
Jerry Yuce3dca42022-02-17 14:16:37 +08007433#endif /* MBEDTLS_KEY_EXCHANGE_PSK_ENABLED */
7434#if defined(MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007435 if (key_ex == MBEDTLS_KEY_EXCHANGE_RSA_PSK) {
Jerry Yuce3dca42022-02-17 14:16:37 +08007436 /*
7437 * other_secret already set by the ClientKeyExchange message,
7438 * and is 48 bytes long
7439 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007440 if (end - p < 2) {
7441 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
7442 }
Jerry Yuce3dca42022-02-17 14:16:37 +08007443
7444 *p++ = 0;
7445 *p++ = 48;
7446 p += 48;
Gilles Peskine449bd832023-01-11 14:50:10 +01007447 } else
Jerry Yuce3dca42022-02-17 14:16:37 +08007448#endif /* MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED */
7449#if defined(MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007450 if (key_ex == MBEDTLS_KEY_EXCHANGE_DHE_PSK) {
Jerry Yuce3dca42022-02-17 14:16:37 +08007451 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7452 size_t len;
7453
7454 /* Write length only when we know the actual value */
Gilles Peskine449bd832023-01-11 14:50:10 +01007455 if ((ret = mbedtls_dhm_calc_secret(&ssl->handshake->dhm_ctx,
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00007456 p + 2, (size_t) (end - (p + 2)), &len,
Gilles Peskine449bd832023-01-11 14:50:10 +01007457 ssl->conf->f_rng, ssl->conf->p_rng)) != 0) {
7458 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_dhm_calc_secret", ret);
7459 return ret;
Jerry Yuce3dca42022-02-17 14:16:37 +08007460 }
Gilles Peskine449bd832023-01-11 14:50:10 +01007461 MBEDTLS_PUT_UINT16_BE(len, p, 0);
Jerry Yuce3dca42022-02-17 14:16:37 +08007462 p += 2 + len;
7463
Gilles Peskine449bd832023-01-11 14:50:10 +01007464 MBEDTLS_SSL_DEBUG_MPI(3, "DHM: K ", &ssl->handshake->dhm_ctx.K);
7465 } else
Jerry Yuce3dca42022-02-17 14:16:37 +08007466#endif /* MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED */
Neil Armstrong80f6f322022-05-03 17:56:38 +02007467#if defined(MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007468 if (key_ex == MBEDTLS_KEY_EXCHANGE_ECDHE_PSK) {
Jerry Yuce3dca42022-02-17 14:16:37 +08007469 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7470 size_t zlen;
7471
Gilles Peskine449bd832023-01-11 14:50:10 +01007472 if ((ret = mbedtls_ecdh_calc_secret(&ssl->handshake->ecdh_ctx, &zlen,
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00007473 p + 2, (size_t) (end - (p + 2)),
Gilles Peskine449bd832023-01-11 14:50:10 +01007474 ssl->conf->f_rng, ssl->conf->p_rng)) != 0) {
7475 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ecdh_calc_secret", ret);
7476 return ret;
Jerry Yuce3dca42022-02-17 14:16:37 +08007477 }
7478
Gilles Peskine449bd832023-01-11 14:50:10 +01007479 MBEDTLS_PUT_UINT16_BE(zlen, p, 0);
Jerry Yuce3dca42022-02-17 14:16:37 +08007480 p += 2 + zlen;
7481
Gilles Peskine449bd832023-01-11 14:50:10 +01007482 MBEDTLS_SSL_DEBUG_ECDH(3, &ssl->handshake->ecdh_ctx,
7483 MBEDTLS_DEBUG_ECDH_Z);
7484 } else
Neil Armstrong80f6f322022-05-03 17:56:38 +02007485#endif /* MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED */
Jerry Yuce3dca42022-02-17 14:16:37 +08007486 {
Gilles Peskine449bd832023-01-11 14:50:10 +01007487 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
7488 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yuce3dca42022-02-17 14:16:37 +08007489 }
7490
7491 /* opaque psk<0..2^16-1>; */
Gilles Peskine449bd832023-01-11 14:50:10 +01007492 if (end - p < 2) {
7493 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
7494 }
Jerry Yuce3dca42022-02-17 14:16:37 +08007495
Gilles Peskine449bd832023-01-11 14:50:10 +01007496 MBEDTLS_PUT_UINT16_BE(psk_len, p, 0);
Jerry Yuce3dca42022-02-17 14:16:37 +08007497 p += 2;
7498
Gilles Peskine449bd832023-01-11 14:50:10 +01007499 if (end < p || (size_t) (end - p) < psk_len) {
7500 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
7501 }
Jerry Yuce3dca42022-02-17 14:16:37 +08007502
Gilles Peskine449bd832023-01-11 14:50:10 +01007503 memcpy(p, psk, psk_len);
Jerry Yuce3dca42022-02-17 14:16:37 +08007504 p += psk_len;
7505
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00007506 ssl->handshake->pmslen = (size_t) (p - ssl->handshake->premaster);
Jerry Yuce3dca42022-02-17 14:16:37 +08007507
Gilles Peskine449bd832023-01-11 14:50:10 +01007508 return 0;
Jerry Yuce3dca42022-02-17 14:16:37 +08007509}
Neil Armstrong80f6f322022-05-03 17:56:38 +02007510#endif /* !MBEDTLS_USE_PSA_CRYPTO && MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
Jerry Yuc2c673d2022-02-17 14:20:39 +08007511
7512#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007513MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007514static int ssl_write_hello_request(mbedtls_ssl_context *ssl);
Jerry Yuc2c673d2022-02-17 14:20:39 +08007515
7516#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01007517int mbedtls_ssl_resend_hello_request(mbedtls_ssl_context *ssl)
Jerry Yuc2c673d2022-02-17 14:20:39 +08007518{
7519 /* If renegotiation is not enforced, retransmit until we would reach max
7520 * timeout if we were using the usual handshake doubling scheme */
Gilles Peskine449bd832023-01-11 14:50:10 +01007521 if (ssl->conf->renego_max_records < 0) {
Jerry Yuc2c673d2022-02-17 14:20:39 +08007522 uint32_t ratio = ssl->conf->hs_timeout_max / ssl->conf->hs_timeout_min + 1;
7523 unsigned char doublings = 1;
7524
Gilles Peskine449bd832023-01-11 14:50:10 +01007525 while (ratio != 0) {
Jerry Yuc2c673d2022-02-17 14:20:39 +08007526 ++doublings;
7527 ratio >>= 1;
7528 }
7529
Gilles Peskine449bd832023-01-11 14:50:10 +01007530 if (++ssl->renego_records_seen > doublings) {
7531 MBEDTLS_SSL_DEBUG_MSG(2, ("no longer retransmitting hello request"));
7532 return 0;
Jerry Yuc2c673d2022-02-17 14:20:39 +08007533 }
7534 }
7535
Gilles Peskine449bd832023-01-11 14:50:10 +01007536 return ssl_write_hello_request(ssl);
Jerry Yuc2c673d2022-02-17 14:20:39 +08007537}
7538#endif
7539#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_RENEGOTIATION */
Jerry Yud9526692022-02-17 14:23:47 +08007540
Jerry Yud9526692022-02-17 14:23:47 +08007541/*
7542 * Handshake functions
7543 */
7544#if !defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
7545/* No certificate support -> dummy functions */
Gilles Peskine449bd832023-01-11 14:50:10 +01007546int mbedtls_ssl_write_certificate(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08007547{
7548 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
7549 ssl->handshake->ciphersuite_info;
7550
Gilles Peskine449bd832023-01-11 14:50:10 +01007551 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007552
Gilles Peskine449bd832023-01-11 14:50:10 +01007553 if (!mbedtls_ssl_ciphersuite_uses_srv_cert(ciphersuite_info)) {
7554 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007555 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01007556 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007557 }
7558
Gilles Peskine449bd832023-01-11 14:50:10 +01007559 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
7560 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007561}
7562
Gilles Peskine449bd832023-01-11 14:50:10 +01007563int mbedtls_ssl_parse_certificate(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08007564{
7565 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
7566 ssl->handshake->ciphersuite_info;
7567
Gilles Peskine449bd832023-01-11 14:50:10 +01007568 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007569
Gilles Peskine449bd832023-01-11 14:50:10 +01007570 if (!mbedtls_ssl_ciphersuite_uses_srv_cert(ciphersuite_info)) {
7571 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007572 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01007573 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007574 }
7575
Gilles Peskine449bd832023-01-11 14:50:10 +01007576 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
7577 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007578}
7579
7580#else /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
7581/* Some certificate support -> implement write and parse */
7582
Gilles Peskine449bd832023-01-11 14:50:10 +01007583int mbedtls_ssl_write_certificate(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08007584{
7585 int ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
7586 size_t i, n;
7587 const mbedtls_x509_crt *crt;
7588 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
7589 ssl->handshake->ciphersuite_info;
7590
Gilles Peskine449bd832023-01-11 14:50:10 +01007591 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007592
Gilles Peskine449bd832023-01-11 14:50:10 +01007593 if (!mbedtls_ssl_ciphersuite_uses_srv_cert(ciphersuite_info)) {
7594 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007595 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01007596 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007597 }
7598
7599#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007600 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
7601 if (ssl->handshake->client_auth == 0) {
7602 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007603 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01007604 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007605 }
7606 }
7607#endif /* MBEDTLS_SSL_CLI_C */
7608#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007609 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
7610 if (mbedtls_ssl_own_cert(ssl) == NULL) {
Jerry Yud9526692022-02-17 14:23:47 +08007611 /* Should never happen because we shouldn't have picked the
7612 * ciphersuite if we don't have a certificate. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007613 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007614 }
7615 }
7616#endif
7617
Gilles Peskine449bd832023-01-11 14:50:10 +01007618 MBEDTLS_SSL_DEBUG_CRT(3, "own certificate", mbedtls_ssl_own_cert(ssl));
Jerry Yud9526692022-02-17 14:23:47 +08007619
7620 /*
7621 * 0 . 0 handshake type
7622 * 1 . 3 handshake length
7623 * 4 . 6 length of all certs
7624 * 7 . 9 length of cert. 1
7625 * 10 . n-1 peer certificate
7626 * n . n+2 length of cert. 2
7627 * n+3 . ... upper level cert, etc.
7628 */
7629 i = 7;
Gilles Peskine449bd832023-01-11 14:50:10 +01007630 crt = mbedtls_ssl_own_cert(ssl);
Jerry Yud9526692022-02-17 14:23:47 +08007631
Gilles Peskine449bd832023-01-11 14:50:10 +01007632 while (crt != NULL) {
Jerry Yud9526692022-02-17 14:23:47 +08007633 n = crt->raw.len;
Gilles Peskine449bd832023-01-11 14:50:10 +01007634 if (n > MBEDTLS_SSL_OUT_CONTENT_LEN - 3 - i) {
7635 MBEDTLS_SSL_DEBUG_MSG(1, ("certificate too large, %" MBEDTLS_PRINTF_SIZET
7636 " > %" MBEDTLS_PRINTF_SIZET,
7637 i + 3 + n, (size_t) MBEDTLS_SSL_OUT_CONTENT_LEN));
7638 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
Jerry Yud9526692022-02-17 14:23:47 +08007639 }
7640
Gilles Peskine449bd832023-01-11 14:50:10 +01007641 ssl->out_msg[i] = MBEDTLS_BYTE_2(n);
7642 ssl->out_msg[i + 1] = MBEDTLS_BYTE_1(n);
7643 ssl->out_msg[i + 2] = MBEDTLS_BYTE_0(n);
Jerry Yud9526692022-02-17 14:23:47 +08007644
Gilles Peskine449bd832023-01-11 14:50:10 +01007645 i += 3; memcpy(ssl->out_msg + i, crt->raw.p, n);
Jerry Yud9526692022-02-17 14:23:47 +08007646 i += n; crt = crt->next;
7647 }
7648
Gilles Peskine449bd832023-01-11 14:50:10 +01007649 ssl->out_msg[4] = MBEDTLS_BYTE_2(i - 7);
7650 ssl->out_msg[5] = MBEDTLS_BYTE_1(i - 7);
7651 ssl->out_msg[6] = MBEDTLS_BYTE_0(i - 7);
Jerry Yud9526692022-02-17 14:23:47 +08007652
7653 ssl->out_msglen = i;
7654 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
7655 ssl->out_msg[0] = MBEDTLS_SSL_HS_CERTIFICATE;
7656
7657 ssl->state++;
7658
Gilles Peskine449bd832023-01-11 14:50:10 +01007659 if ((ret = mbedtls_ssl_write_handshake_msg(ssl)) != 0) {
7660 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_handshake_msg", ret);
7661 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007662 }
7663
Gilles Peskine449bd832023-01-11 14:50:10 +01007664 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007665
Gilles Peskine449bd832023-01-11 14:50:10 +01007666 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007667}
7668
7669#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
7670
7671#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007672MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007673static int ssl_check_peer_crt_unchanged(mbedtls_ssl_context *ssl,
7674 unsigned char *crt_buf,
7675 size_t crt_buf_len)
Jerry Yud9526692022-02-17 14:23:47 +08007676{
7677 mbedtls_x509_crt const * const peer_crt = ssl->session->peer_cert;
7678
Gilles Peskine449bd832023-01-11 14:50:10 +01007679 if (peer_crt == NULL) {
7680 return -1;
7681 }
Jerry Yud9526692022-02-17 14:23:47 +08007682
Gilles Peskine449bd832023-01-11 14:50:10 +01007683 if (peer_crt->raw.len != crt_buf_len) {
7684 return -1;
7685 }
Jerry Yud9526692022-02-17 14:23:47 +08007686
Gilles Peskine449bd832023-01-11 14:50:10 +01007687 return memcmp(peer_crt->raw.p, crt_buf, peer_crt->raw.len);
Jerry Yud9526692022-02-17 14:23:47 +08007688}
7689#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007690MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007691static int ssl_check_peer_crt_unchanged(mbedtls_ssl_context *ssl,
7692 unsigned char *crt_buf,
7693 size_t crt_buf_len)
Jerry Yud9526692022-02-17 14:23:47 +08007694{
7695 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7696 unsigned char const * const peer_cert_digest =
7697 ssl->session->peer_cert_digest;
7698 mbedtls_md_type_t const peer_cert_digest_type =
7699 ssl->session->peer_cert_digest_type;
7700 mbedtls_md_info_t const * const digest_info =
Gilles Peskine449bd832023-01-11 14:50:10 +01007701 mbedtls_md_info_from_type(peer_cert_digest_type);
Jerry Yud9526692022-02-17 14:23:47 +08007702 unsigned char tmp_digest[MBEDTLS_SSL_PEER_CERT_DIGEST_MAX_LEN];
7703 size_t digest_len;
7704
Gilles Peskine449bd832023-01-11 14:50:10 +01007705 if (peer_cert_digest == NULL || digest_info == NULL) {
7706 return -1;
7707 }
Jerry Yud9526692022-02-17 14:23:47 +08007708
Gilles Peskine449bd832023-01-11 14:50:10 +01007709 digest_len = mbedtls_md_get_size(digest_info);
7710 if (digest_len > MBEDTLS_SSL_PEER_CERT_DIGEST_MAX_LEN) {
7711 return -1;
7712 }
Jerry Yud9526692022-02-17 14:23:47 +08007713
Gilles Peskine449bd832023-01-11 14:50:10 +01007714 ret = mbedtls_md(digest_info, crt_buf, crt_buf_len, tmp_digest);
7715 if (ret != 0) {
7716 return -1;
7717 }
Jerry Yud9526692022-02-17 14:23:47 +08007718
Gilles Peskine449bd832023-01-11 14:50:10 +01007719 return memcmp(tmp_digest, peer_cert_digest, digest_len);
Jerry Yud9526692022-02-17 14:23:47 +08007720}
7721#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7722#endif /* MBEDTLS_SSL_RENEGOTIATION && MBEDTLS_SSL_CLI_C */
7723
7724/*
7725 * Once the certificate message is read, parse it into a cert chain and
7726 * perform basic checks, but leave actual verification to the caller
7727 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007728MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007729static int ssl_parse_certificate_chain(mbedtls_ssl_context *ssl,
7730 mbedtls_x509_crt *chain)
Jerry Yud9526692022-02-17 14:23:47 +08007731{
7732 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7733#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007734 int crt_cnt = 0;
Jerry Yud9526692022-02-17 14:23:47 +08007735#endif
7736 size_t i, n;
7737 uint8_t alert;
7738
Gilles Peskine449bd832023-01-11 14:50:10 +01007739 if (ssl->in_msgtype != MBEDTLS_SSL_MSG_HANDSHAKE) {
7740 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7741 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7742 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
7743 return MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
Jerry Yud9526692022-02-17 14:23:47 +08007744 }
7745
Gilles Peskine449bd832023-01-11 14:50:10 +01007746 if (ssl->in_msg[0] != MBEDTLS_SSL_HS_CERTIFICATE) {
7747 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7748 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
7749 return MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
Jerry Yud9526692022-02-17 14:23:47 +08007750 }
7751
Gilles Peskine449bd832023-01-11 14:50:10 +01007752 if (ssl->in_hslen < mbedtls_ssl_hs_hdr_len(ssl) + 3 + 3) {
7753 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7754 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7755 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
7756 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007757 }
7758
Gilles Peskine449bd832023-01-11 14:50:10 +01007759 i = mbedtls_ssl_hs_hdr_len(ssl);
Jerry Yud9526692022-02-17 14:23:47 +08007760
7761 /*
7762 * Same message structure as in mbedtls_ssl_write_certificate()
7763 */
Dave Rodgmana3d0f612023-11-03 23:34:02 +00007764 n = MBEDTLS_GET_UINT16_BE(ssl->in_msg, i + 1);
Jerry Yud9526692022-02-17 14:23:47 +08007765
Gilles Peskine449bd832023-01-11 14:50:10 +01007766 if (ssl->in_msg[i] != 0 ||
7767 ssl->in_hslen != n + 3 + mbedtls_ssl_hs_hdr_len(ssl)) {
7768 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7769 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7770 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
7771 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007772 }
7773
7774 /* Make &ssl->in_msg[i] point to the beginning of the CRT chain. */
7775 i += 3;
7776
7777 /* Iterate through and parse the CRTs in the provided chain. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007778 while (i < ssl->in_hslen) {
Jerry Yud9526692022-02-17 14:23:47 +08007779 /* Check that there's room for the next CRT's length fields. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007780 if (i + 3 > ssl->in_hslen) {
7781 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7782 mbedtls_ssl_send_alert_message(ssl,
7783 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7784 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
7785 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007786 }
7787 /* In theory, the CRT can be up to 2**24 Bytes, but we don't support
7788 * anything beyond 2**16 ~ 64K. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007789 if (ssl->in_msg[i] != 0) {
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_UNSUPPORTED_CERT);
7794 return MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
Jerry Yud9526692022-02-17 14:23:47 +08007795 }
7796
7797 /* Read length of the next CRT in the chain. */
Dave Rodgmana3d0f612023-11-03 23:34:02 +00007798 n = MBEDTLS_GET_UINT16_BE(ssl->in_msg, i + 1);
Jerry Yud9526692022-02-17 14:23:47 +08007799 i += 3;
7800
Gilles Peskine449bd832023-01-11 14:50:10 +01007801 if (n < 128 || i + n > ssl->in_hslen) {
7802 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7803 mbedtls_ssl_send_alert_message(ssl,
7804 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7805 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
7806 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007807 }
7808
7809 /* Check if we're handling the first CRT in the chain. */
7810#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007811 if (crt_cnt++ == 0 &&
Jerry Yud9526692022-02-17 14:23:47 +08007812 ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
Gilles Peskine449bd832023-01-11 14:50:10 +01007813 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS) {
Jerry Yud9526692022-02-17 14:23:47 +08007814 /* During client-side renegotiation, check that the server's
7815 * end-CRTs hasn't changed compared to the initial handshake,
7816 * mitigating the triple handshake attack. On success, reuse
7817 * the original end-CRT instead of parsing it again. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007818 MBEDTLS_SSL_DEBUG_MSG(3, ("Check that peer CRT hasn't changed during renegotiation"));
7819 if (ssl_check_peer_crt_unchanged(ssl,
7820 &ssl->in_msg[i],
7821 n) != 0) {
7822 MBEDTLS_SSL_DEBUG_MSG(1, ("new server cert during renegotiation"));
7823 mbedtls_ssl_send_alert_message(ssl,
7824 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7825 MBEDTLS_SSL_ALERT_MSG_ACCESS_DENIED);
7826 return MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
Jerry Yud9526692022-02-17 14:23:47 +08007827 }
7828
7829 /* Now we can safely free the original chain. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007830 ssl_clear_peer_cert(ssl->session);
Jerry Yud9526692022-02-17 14:23:47 +08007831 }
7832#endif /* MBEDTLS_SSL_RENEGOTIATION && MBEDTLS_SSL_CLI_C */
7833
7834 /* Parse the next certificate in the chain. */
7835#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01007836 ret = mbedtls_x509_crt_parse_der(chain, ssl->in_msg + i, n);
Jerry Yud9526692022-02-17 14:23:47 +08007837#else
7838 /* If we don't need to store the CRT chain permanently, parse
7839 * it in-place from the input buffer instead of making a copy. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007840 ret = mbedtls_x509_crt_parse_der_nocopy(chain, ssl->in_msg + i, n);
Jerry Yud9526692022-02-17 14:23:47 +08007841#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Gilles Peskine449bd832023-01-11 14:50:10 +01007842 switch (ret) {
Jerry Yud9526692022-02-17 14:23:47 +08007843 case 0: /*ok*/
7844 case MBEDTLS_ERR_X509_UNKNOWN_SIG_ALG + MBEDTLS_ERR_OID_NOT_FOUND:
7845 /* Ignore certificate with an unknown algorithm: maybe a
7846 prior certificate was already trusted. */
7847 break;
7848
7849 case MBEDTLS_ERR_X509_ALLOC_FAILED:
7850 alert = MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR;
7851 goto crt_parse_der_failed;
7852
7853 case MBEDTLS_ERR_X509_UNKNOWN_VERSION:
7854 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
7855 goto crt_parse_der_failed;
7856
7857 default:
7858 alert = MBEDTLS_SSL_ALERT_MSG_BAD_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01007859crt_parse_der_failed:
7860 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL, alert);
7861 MBEDTLS_SSL_DEBUG_RET(1, " mbedtls_x509_crt_parse_der", ret);
7862 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007863 }
7864
7865 i += n;
7866 }
7867
Gilles Peskine449bd832023-01-11 14:50:10 +01007868 MBEDTLS_SSL_DEBUG_CRT(3, "peer certificate", chain);
7869 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007870}
7871
7872#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007873MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007874static int ssl_srv_check_client_no_crt_notification(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08007875{
Gilles Peskine449bd832023-01-11 14:50:10 +01007876 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
7877 return -1;
7878 }
Jerry Yud9526692022-02-17 14:23:47 +08007879
Gilles Peskine449bd832023-01-11 14:50:10 +01007880 if (ssl->in_hslen == 3 + mbedtls_ssl_hs_hdr_len(ssl) &&
Jerry Yud9526692022-02-17 14:23:47 +08007881 ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
7882 ssl->in_msg[0] == MBEDTLS_SSL_HS_CERTIFICATE &&
Gilles Peskine449bd832023-01-11 14:50:10 +01007883 memcmp(ssl->in_msg + mbedtls_ssl_hs_hdr_len(ssl), "\0\0\0", 3) == 0) {
7884 MBEDTLS_SSL_DEBUG_MSG(1, ("peer has no certificate"));
7885 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007886 }
Gilles Peskine449bd832023-01-11 14:50:10 +01007887 return -1;
Jerry Yud9526692022-02-17 14:23:47 +08007888}
7889#endif /* MBEDTLS_SSL_SRV_C */
7890
7891/* Check if a certificate message is expected.
7892 * Return either
7893 * - SSL_CERTIFICATE_EXPECTED, or
7894 * - SSL_CERTIFICATE_SKIP
7895 * indicating whether a Certificate message is expected or not.
7896 */
7897#define SSL_CERTIFICATE_EXPECTED 0
7898#define SSL_CERTIFICATE_SKIP 1
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007899MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007900static int ssl_parse_certificate_coordinate(mbedtls_ssl_context *ssl,
7901 int authmode)
Jerry Yud9526692022-02-17 14:23:47 +08007902{
7903 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
7904 ssl->handshake->ciphersuite_info;
7905
Gilles Peskine449bd832023-01-11 14:50:10 +01007906 if (!mbedtls_ssl_ciphersuite_uses_srv_cert(ciphersuite_info)) {
7907 return SSL_CERTIFICATE_SKIP;
7908 }
Jerry Yud9526692022-02-17 14:23:47 +08007909
7910#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007911 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
7912 if (ciphersuite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_RSA_PSK) {
7913 return SSL_CERTIFICATE_SKIP;
7914 }
Jerry Yud9526692022-02-17 14:23:47 +08007915
Gilles Peskine449bd832023-01-11 14:50:10 +01007916 if (authmode == MBEDTLS_SSL_VERIFY_NONE) {
Jerry Yud9526692022-02-17 14:23:47 +08007917 ssl->session_negotiate->verify_result =
7918 MBEDTLS_X509_BADCERT_SKIP_VERIFY;
Gilles Peskine449bd832023-01-11 14:50:10 +01007919 return SSL_CERTIFICATE_SKIP;
Jerry Yud9526692022-02-17 14:23:47 +08007920 }
7921 }
7922#else
7923 ((void) authmode);
7924#endif /* MBEDTLS_SSL_SRV_C */
7925
Gilles Peskine449bd832023-01-11 14:50:10 +01007926 return SSL_CERTIFICATE_EXPECTED;
Jerry Yud9526692022-02-17 14:23:47 +08007927}
7928
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007929MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007930static int ssl_parse_certificate_verify(mbedtls_ssl_context *ssl,
7931 int authmode,
7932 mbedtls_x509_crt *chain,
7933 void *rs_ctx)
Jerry Yud9526692022-02-17 14:23:47 +08007934{
7935 int ret = 0;
7936 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
7937 ssl->handshake->ciphersuite_info;
7938 int have_ca_chain = 0;
7939
7940 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *);
7941 void *p_vrfy;
7942
Gilles Peskine449bd832023-01-11 14:50:10 +01007943 if (authmode == MBEDTLS_SSL_VERIFY_NONE) {
7944 return 0;
7945 }
Jerry Yud9526692022-02-17 14:23:47 +08007946
Gilles Peskine449bd832023-01-11 14:50:10 +01007947 if (ssl->f_vrfy != NULL) {
7948 MBEDTLS_SSL_DEBUG_MSG(3, ("Use context-specific verification callback"));
Jerry Yud9526692022-02-17 14:23:47 +08007949 f_vrfy = ssl->f_vrfy;
7950 p_vrfy = ssl->p_vrfy;
Gilles Peskine449bd832023-01-11 14:50:10 +01007951 } else {
7952 MBEDTLS_SSL_DEBUG_MSG(3, ("Use configuration-specific verification callback"));
Jerry Yud9526692022-02-17 14:23:47 +08007953 f_vrfy = ssl->conf->f_vrfy;
7954 p_vrfy = ssl->conf->p_vrfy;
7955 }
7956
7957 /*
7958 * Main check: verify certificate
7959 */
7960#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
Gilles Peskine449bd832023-01-11 14:50:10 +01007961 if (ssl->conf->f_ca_cb != NULL) {
Jerry Yud9526692022-02-17 14:23:47 +08007962 ((void) rs_ctx);
7963 have_ca_chain = 1;
7964
Gilles Peskine449bd832023-01-11 14:50:10 +01007965 MBEDTLS_SSL_DEBUG_MSG(3, ("use CA callback for X.509 CRT verification"));
Jerry Yud9526692022-02-17 14:23:47 +08007966 ret = mbedtls_x509_crt_verify_with_ca_cb(
7967 chain,
7968 ssl->conf->f_ca_cb,
7969 ssl->conf->p_ca_cb,
7970 ssl->conf->cert_profile,
7971 ssl->hostname,
7972 &ssl->session_negotiate->verify_result,
Gilles Peskine449bd832023-01-11 14:50:10 +01007973 f_vrfy, p_vrfy);
7974 } else
Jerry Yud9526692022-02-17 14:23:47 +08007975#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
7976 {
7977 mbedtls_x509_crt *ca_chain;
7978 mbedtls_x509_crl *ca_crl;
7979
7980#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01007981 if (ssl->handshake->sni_ca_chain != NULL) {
Jerry Yud9526692022-02-17 14:23:47 +08007982 ca_chain = ssl->handshake->sni_ca_chain;
7983 ca_crl = ssl->handshake->sni_ca_crl;
Gilles Peskine449bd832023-01-11 14:50:10 +01007984 } else
Jerry Yud9526692022-02-17 14:23:47 +08007985#endif
7986 {
7987 ca_chain = ssl->conf->ca_chain;
7988 ca_crl = ssl->conf->ca_crl;
7989 }
7990
Gilles Peskine449bd832023-01-11 14:50:10 +01007991 if (ca_chain != NULL) {
Jerry Yud9526692022-02-17 14:23:47 +08007992 have_ca_chain = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01007993 }
Jerry Yud9526692022-02-17 14:23:47 +08007994
7995 ret = mbedtls_x509_crt_verify_restartable(
7996 chain,
7997 ca_chain, ca_crl,
7998 ssl->conf->cert_profile,
7999 ssl->hostname,
8000 &ssl->session_negotiate->verify_result,
Gilles Peskine449bd832023-01-11 14:50:10 +01008001 f_vrfy, p_vrfy, rs_ctx);
Jerry Yud9526692022-02-17 14:23:47 +08008002 }
8003
Gilles Peskine449bd832023-01-11 14:50:10 +01008004 if (ret != 0) {
8005 MBEDTLS_SSL_DEBUG_RET(1, "x509_verify_cert", ret);
Jerry Yud9526692022-02-17 14:23:47 +08008006 }
8007
8008#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01008009 if (ret == MBEDTLS_ERR_ECP_IN_PROGRESS) {
8010 return MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS;
8011 }
Jerry Yud9526692022-02-17 14:23:47 +08008012#endif
8013
8014 /*
8015 * Secondary checks: always done, but change 'ret' only if it was 0
8016 */
8017
Valerio Settiacd32c02023-06-29 18:06:29 +02008018#if defined(MBEDTLS_PK_HAVE_ECC_KEYS)
Jerry Yud9526692022-02-17 14:23:47 +08008019 {
8020 const mbedtls_pk_context *pk = &chain->pk;
8021
Manuel Pégourié-Gonnard66b0d612022-06-17 10:49:29 +02008022 /* If certificate uses an EC key, make sure the curve is OK.
8023 * This is a public key, so it can't be opaque, so can_do() is a good
8024 * enough check to ensure pk_ec() is safe to use here. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008025 if (mbedtls_pk_can_do(pk, MBEDTLS_PK_ECKEY)) {
Leonid Rozenboim19e59732022-08-08 16:52:38 -07008026 /* and in the unlikely case the above assumption no longer holds
8027 * we are making sure that pk_ec() here does not return a NULL
8028 */
Valerio Settif9362b72023-11-29 08:42:27 +01008029 mbedtls_ecp_group_id grp_id = mbedtls_pk_get_ec_group_id(pk);
Valerio Settid0405092023-05-24 13:16:40 +02008030 if (grp_id == MBEDTLS_ECP_DP_NONE) {
8031 MBEDTLS_SSL_DEBUG_MSG(1, ("invalid group ID"));
Gilles Peskine449bd832023-01-11 14:50:10 +01008032 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Leonid Rozenboim19e59732022-08-08 16:52:38 -07008033 }
Valerio Setti97207782023-05-18 18:59:06 +02008034 if (mbedtls_ssl_check_curve(ssl, grp_id) != 0) {
Leonid Rozenboim19e59732022-08-08 16:52:38 -07008035 ssl->session_negotiate->verify_result |=
8036 MBEDTLS_X509_BADCERT_BAD_KEY;
8037
Gilles Peskine449bd832023-01-11 14:50:10 +01008038 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate (EC key curve)"));
8039 if (ret == 0) {
Leonid Rozenboim19e59732022-08-08 16:52:38 -07008040 ret = MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
Gilles Peskine449bd832023-01-11 14:50:10 +01008041 }
Leonid Rozenboim19e59732022-08-08 16:52:38 -07008042 }
Jerry Yud9526692022-02-17 14:23:47 +08008043 }
8044 }
Valerio Settiacd32c02023-06-29 18:06:29 +02008045#endif /* MBEDTLS_PK_HAVE_ECC_KEYS */
Jerry Yud9526692022-02-17 14:23:47 +08008046
Gilles Peskine449bd832023-01-11 14:50:10 +01008047 if (mbedtls_ssl_check_cert_usage(chain,
8048 ciphersuite_info,
8049 !ssl->conf->endpoint,
8050 &ssl->session_negotiate->verify_result) != 0) {
8051 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate (usage extensions)"));
8052 if (ret == 0) {
Jerry Yud9526692022-02-17 14:23:47 +08008053 ret = MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
Gilles Peskine449bd832023-01-11 14:50:10 +01008054 }
Jerry Yud9526692022-02-17 14:23:47 +08008055 }
8056
8057 /* mbedtls_x509_crt_verify_with_profile is supposed to report a
8058 * verification failure through MBEDTLS_ERR_X509_CERT_VERIFY_FAILED,
8059 * with details encoded in the verification flags. All other kinds
8060 * of error codes, including those from the user provided f_vrfy
8061 * functions, are treated as fatal and lead to a failure of
8062 * ssl_parse_certificate even if verification was optional. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008063 if (authmode == MBEDTLS_SSL_VERIFY_OPTIONAL &&
8064 (ret == MBEDTLS_ERR_X509_CERT_VERIFY_FAILED ||
8065 ret == MBEDTLS_ERR_SSL_BAD_CERTIFICATE)) {
Jerry Yud9526692022-02-17 14:23:47 +08008066 ret = 0;
8067 }
8068
Gilles Peskine449bd832023-01-11 14:50:10 +01008069 if (have_ca_chain == 0 && authmode == MBEDTLS_SSL_VERIFY_REQUIRED) {
8070 MBEDTLS_SSL_DEBUG_MSG(1, ("got no CA chain"));
Jerry Yud9526692022-02-17 14:23:47 +08008071 ret = MBEDTLS_ERR_SSL_CA_CHAIN_REQUIRED;
8072 }
8073
Gilles Peskine449bd832023-01-11 14:50:10 +01008074 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08008075 uint8_t alert;
8076
8077 /* The certificate may have been rejected for several reasons.
8078 Pick one and send the corresponding alert. Which alert to send
8079 may be a subject of debate in some cases. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008080 if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_OTHER) {
Jerry Yud9526692022-02-17 14:23:47 +08008081 alert = MBEDTLS_SSL_ALERT_MSG_ACCESS_DENIED;
Gilles Peskine449bd832023-01-11 14:50:10 +01008082 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_CN_MISMATCH) {
Jerry Yud9526692022-02-17 14:23:47 +08008083 alert = MBEDTLS_SSL_ALERT_MSG_BAD_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01008084 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_KEY_USAGE) {
Jerry Yud9526692022-02-17 14:23:47 +08008085 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01008086 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_EXT_KEY_USAGE) {
Jerry Yud9526692022-02-17 14:23:47 +08008087 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01008088 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_NS_CERT_TYPE) {
Jerry Yud9526692022-02-17 14:23:47 +08008089 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01008090 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_BAD_PK) {
Jerry Yud9526692022-02-17 14:23:47 +08008091 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01008092 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_BAD_KEY) {
Jerry Yud9526692022-02-17 14:23:47 +08008093 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01008094 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_EXPIRED) {
Jerry Yud9526692022-02-17 14:23:47 +08008095 alert = MBEDTLS_SSL_ALERT_MSG_CERT_EXPIRED;
Gilles Peskine449bd832023-01-11 14:50:10 +01008096 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_REVOKED) {
Jerry Yud9526692022-02-17 14:23:47 +08008097 alert = MBEDTLS_SSL_ALERT_MSG_CERT_REVOKED;
Gilles Peskine449bd832023-01-11 14:50:10 +01008098 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_NOT_TRUSTED) {
Jerry Yud9526692022-02-17 14:23:47 +08008099 alert = MBEDTLS_SSL_ALERT_MSG_UNKNOWN_CA;
Gilles Peskine449bd832023-01-11 14:50:10 +01008100 } else {
Jerry Yud9526692022-02-17 14:23:47 +08008101 alert = MBEDTLS_SSL_ALERT_MSG_CERT_UNKNOWN;
Gilles Peskine449bd832023-01-11 14:50:10 +01008102 }
8103 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8104 alert);
Jerry Yud9526692022-02-17 14:23:47 +08008105 }
8106
8107#if defined(MBEDTLS_DEBUG_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008108 if (ssl->session_negotiate->verify_result != 0) {
8109 MBEDTLS_SSL_DEBUG_MSG(3, ("! Certificate verification flags %08x",
8110 (unsigned int) ssl->session_negotiate->verify_result));
8111 } else {
8112 MBEDTLS_SSL_DEBUG_MSG(3, ("Certificate verification flags clear"));
Jerry Yud9526692022-02-17 14:23:47 +08008113 }
8114#endif /* MBEDTLS_DEBUG_C */
8115
Gilles Peskine449bd832023-01-11 14:50:10 +01008116 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08008117}
8118
8119#if !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02008120MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01008121static int ssl_remember_peer_crt_digest(mbedtls_ssl_context *ssl,
8122 unsigned char *start, size_t len)
Jerry Yud9526692022-02-17 14:23:47 +08008123{
8124 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
8125 /* Remember digest of the peer's end-CRT. */
8126 ssl->session_negotiate->peer_cert_digest =
Gilles Peskine449bd832023-01-11 14:50:10 +01008127 mbedtls_calloc(1, MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN);
8128 if (ssl->session_negotiate->peer_cert_digest == NULL) {
8129 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc(%d bytes) failed",
8130 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN));
8131 mbedtls_ssl_send_alert_message(ssl,
8132 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8133 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR);
Jerry Yud9526692022-02-17 14:23:47 +08008134
Gilles Peskine449bd832023-01-11 14:50:10 +01008135 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
Jerry Yud9526692022-02-17 14:23:47 +08008136 }
8137
Gilles Peskine449bd832023-01-11 14:50:10 +01008138 ret = mbedtls_md(mbedtls_md_info_from_type(
8139 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE),
8140 start, len,
8141 ssl->session_negotiate->peer_cert_digest);
Jerry Yud9526692022-02-17 14:23:47 +08008142
8143 ssl->session_negotiate->peer_cert_digest_type =
8144 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE;
8145 ssl->session_negotiate->peer_cert_digest_len =
8146 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN;
8147
Gilles Peskine449bd832023-01-11 14:50:10 +01008148 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08008149}
8150
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02008151MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01008152static int ssl_remember_peer_pubkey(mbedtls_ssl_context *ssl,
8153 unsigned char *start, size_t len)
Jerry Yud9526692022-02-17 14:23:47 +08008154{
8155 unsigned char *end = start + len;
8156 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
8157
8158 /* Make a copy of the peer's raw public key. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008159 mbedtls_pk_init(&ssl->handshake->peer_pubkey);
8160 ret = mbedtls_pk_parse_subpubkey(&start, end,
8161 &ssl->handshake->peer_pubkey);
8162 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08008163 /* We should have parsed the public key before. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008164 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08008165 }
8166
Gilles Peskine449bd832023-01-11 14:50:10 +01008167 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08008168}
8169#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
8170
Gilles Peskine449bd832023-01-11 14:50:10 +01008171int mbedtls_ssl_parse_certificate(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08008172{
8173 int ret = 0;
8174 int crt_expected;
8175#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
8176 const int authmode = ssl->handshake->sni_authmode != MBEDTLS_SSL_VERIFY_UNSET
8177 ? ssl->handshake->sni_authmode
8178 : ssl->conf->authmode;
8179#else
8180 const int authmode = ssl->conf->authmode;
8181#endif
8182 void *rs_ctx = NULL;
8183 mbedtls_x509_crt *chain = NULL;
8184
Gilles Peskine449bd832023-01-11 14:50:10 +01008185 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08008186
Gilles Peskine449bd832023-01-11 14:50:10 +01008187 crt_expected = ssl_parse_certificate_coordinate(ssl, authmode);
8188 if (crt_expected == SSL_CERTIFICATE_SKIP) {
8189 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08008190 goto exit;
8191 }
8192
8193#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01008194 if (ssl->handshake->ecrs_enabled &&
8195 ssl->handshake->ecrs_state == ssl_ecrs_crt_verify) {
Jerry Yud9526692022-02-17 14:23:47 +08008196 chain = ssl->handshake->ecrs_peer_cert;
8197 ssl->handshake->ecrs_peer_cert = NULL;
8198 goto crt_verify;
8199 }
8200#endif
8201
Gilles Peskine449bd832023-01-11 14:50:10 +01008202 if ((ret = mbedtls_ssl_read_record(ssl, 1)) != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08008203 /* mbedtls_ssl_read_record may have sent an alert already. We
8204 let it decide whether to alert. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008205 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_read_record", ret);
Jerry Yud9526692022-02-17 14:23:47 +08008206 goto exit;
8207 }
8208
8209#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008210 if (ssl_srv_check_client_no_crt_notification(ssl) == 0) {
Jerry Yud9526692022-02-17 14:23:47 +08008211 ssl->session_negotiate->verify_result = MBEDTLS_X509_BADCERT_MISSING;
8212
Gilles Peskine449bd832023-01-11 14:50:10 +01008213 if (authmode != MBEDTLS_SSL_VERIFY_OPTIONAL) {
Jerry Yud9526692022-02-17 14:23:47 +08008214 ret = MBEDTLS_ERR_SSL_NO_CLIENT_CERTIFICATE;
Gilles Peskine449bd832023-01-11 14:50:10 +01008215 }
Jerry Yud9526692022-02-17 14:23:47 +08008216
8217 goto exit;
8218 }
8219#endif /* MBEDTLS_SSL_SRV_C */
8220
8221 /* Clear existing peer CRT structure in case we tried to
8222 * reuse a session but it failed, and allocate a new one. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008223 ssl_clear_peer_cert(ssl->session_negotiate);
Jerry Yud9526692022-02-17 14:23:47 +08008224
Gilles Peskine449bd832023-01-11 14:50:10 +01008225 chain = mbedtls_calloc(1, sizeof(mbedtls_x509_crt));
8226 if (chain == NULL) {
8227 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc(%" MBEDTLS_PRINTF_SIZET " bytes) failed",
8228 sizeof(mbedtls_x509_crt)));
8229 mbedtls_ssl_send_alert_message(ssl,
8230 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8231 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR);
Jerry Yud9526692022-02-17 14:23:47 +08008232
8233 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
8234 goto exit;
8235 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008236 mbedtls_x509_crt_init(chain);
Jerry Yud9526692022-02-17 14:23:47 +08008237
Gilles Peskine449bd832023-01-11 14:50:10 +01008238 ret = ssl_parse_certificate_chain(ssl, chain);
8239 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08008240 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01008241 }
Jerry Yud9526692022-02-17 14:23:47 +08008242
8243#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01008244 if (ssl->handshake->ecrs_enabled) {
Jerry Yud9526692022-02-17 14:23:47 +08008245 ssl->handshake->ecrs_state = ssl_ecrs_crt_verify;
Gilles Peskine449bd832023-01-11 14:50:10 +01008246 }
Jerry Yud9526692022-02-17 14:23:47 +08008247
8248crt_verify:
Gilles Peskine449bd832023-01-11 14:50:10 +01008249 if (ssl->handshake->ecrs_enabled) {
Jerry Yud9526692022-02-17 14:23:47 +08008250 rs_ctx = &ssl->handshake->ecrs_ctx;
Gilles Peskine449bd832023-01-11 14:50:10 +01008251 }
Jerry Yud9526692022-02-17 14:23:47 +08008252#endif
8253
Gilles Peskine449bd832023-01-11 14:50:10 +01008254 ret = ssl_parse_certificate_verify(ssl, authmode,
8255 chain, rs_ctx);
8256 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08008257 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01008258 }
Jerry Yud9526692022-02-17 14:23:47 +08008259
8260#if !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
8261 {
8262 unsigned char *crt_start, *pk_start;
8263 size_t crt_len, pk_len;
8264
8265 /* We parse the CRT chain without copying, so
8266 * these pointers point into the input buffer,
8267 * and are hence still valid after freeing the
8268 * CRT chain. */
8269
8270 crt_start = chain->raw.p;
8271 crt_len = chain->raw.len;
8272
8273 pk_start = chain->pk_raw.p;
8274 pk_len = chain->pk_raw.len;
8275
8276 /* Free the CRT structures before computing
8277 * digest and copying the peer's public key. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008278 mbedtls_x509_crt_free(chain);
8279 mbedtls_free(chain);
Jerry Yud9526692022-02-17 14:23:47 +08008280 chain = NULL;
8281
Gilles Peskine449bd832023-01-11 14:50:10 +01008282 ret = ssl_remember_peer_crt_digest(ssl, crt_start, crt_len);
8283 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08008284 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01008285 }
Jerry Yud9526692022-02-17 14:23:47 +08008286
Gilles Peskine449bd832023-01-11 14:50:10 +01008287 ret = ssl_remember_peer_pubkey(ssl, pk_start, pk_len);
8288 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08008289 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01008290 }
Jerry Yud9526692022-02-17 14:23:47 +08008291 }
8292#else /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
8293 /* Pass ownership to session structure. */
8294 ssl->session_negotiate->peer_cert = chain;
8295 chain = NULL;
8296#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
8297
Gilles Peskine449bd832023-01-11 14:50:10 +01008298 MBEDTLS_SSL_DEBUG_MSG(2, ("<= parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08008299
8300exit:
8301
Gilles Peskine449bd832023-01-11 14:50:10 +01008302 if (ret == 0) {
Jerry Yud9526692022-02-17 14:23:47 +08008303 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01008304 }
Jerry Yud9526692022-02-17 14:23:47 +08008305
8306#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01008307 if (ret == MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS) {
Jerry Yud9526692022-02-17 14:23:47 +08008308 ssl->handshake->ecrs_peer_cert = chain;
8309 chain = NULL;
8310 }
8311#endif
8312
Gilles Peskine449bd832023-01-11 14:50:10 +01008313 if (chain != NULL) {
8314 mbedtls_x509_crt_free(chain);
8315 mbedtls_free(chain);
Jerry Yud9526692022-02-17 14:23:47 +08008316 }
8317
Gilles Peskine449bd832023-01-11 14:50:10 +01008318 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08008319}
8320#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
8321
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008322static int ssl_calc_finished_tls_generic(mbedtls_ssl_context *ssl, void *ctx,
8323 unsigned char *padbuf, size_t hlen,
8324 unsigned char *buf, int from)
Jerry Yu615bd6f2022-02-17 14:25:15 +08008325{
Dave Rodgmanc37ad442023-11-03 23:36:06 +00008326 unsigned int len = 12;
Jerry Yu615bd6f2022-02-17 14:25:15 +08008327 const char *sender;
Jerry Yu615bd6f2022-02-17 14:25:15 +08008328#if defined(MBEDTLS_USE_PSA_CRYPTO)
Jerry Yu615bd6f2022-02-17 14:25:15 +08008329 psa_status_t status;
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008330 psa_hash_operation_t *hs_op = ctx;
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02008331 psa_hash_operation_t cloned_op = PSA_HASH_OPERATION_INIT;
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008332 size_t hash_size;
Jerry Yu615bd6f2022-02-17 14:25:15 +08008333#else
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01008334 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008335 mbedtls_md_context_t *hs_ctx = ctx;
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02008336 mbedtls_md_context_t cloned_ctx;
8337 mbedtls_md_init(&cloned_ctx);
Jerry Yu615bd6f2022-02-17 14:25:15 +08008338#endif
8339
8340 mbedtls_ssl_session *session = ssl->session_negotiate;
Gilles Peskine449bd832023-01-11 14:50:10 +01008341 if (!session) {
Jerry Yu615bd6f2022-02-17 14:25:15 +08008342 session = ssl->session;
Gilles Peskine449bd832023-01-11 14:50:10 +01008343 }
Jerry Yu615bd6f2022-02-17 14:25:15 +08008344
Gilles Peskine449bd832023-01-11 14:50:10 +01008345 sender = (from == MBEDTLS_SSL_IS_CLIENT)
Jerry Yu615bd6f2022-02-17 14:25:15 +08008346 ? "client finished"
8347 : "server finished";
8348
8349#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008350 MBEDTLS_SSL_DEBUG_MSG(2, ("=> calc PSA finished tls"));
Jerry Yu615bd6f2022-02-17 14:25:15 +08008351
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02008352 status = psa_hash_clone(hs_op, &cloned_op);
Gilles Peskine449bd832023-01-11 14:50:10 +01008353 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01008354 goto exit;
Jerry Yu615bd6f2022-02-17 14:25:15 +08008355 }
8356
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02008357 status = psa_hash_finish(&cloned_op, padbuf, hlen, &hash_size);
Gilles Peskine449bd832023-01-11 14:50:10 +01008358 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01008359 goto exit;
Jerry Yu615bd6f2022-02-17 14:25:15 +08008360 }
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008361 MBEDTLS_SSL_DEBUG_BUF(3, "PSA calculated padbuf", padbuf, hlen);
Jerry Yu615bd6f2022-02-17 14:25:15 +08008362#else
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008363 MBEDTLS_SSL_DEBUG_MSG(2, ("=> calc finished tls"));
Jerry Yu615bd6f2022-02-17 14:25:15 +08008364
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02008365 ret = mbedtls_md_setup(&cloned_ctx, mbedtls_md_info_from_ctx(hs_ctx), 0);
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01008366 if (ret != 0) {
8367 goto exit;
8368 }
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02008369 ret = mbedtls_md_clone(&cloned_ctx, hs_ctx);
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01008370 if (ret != 0) {
8371 goto exit;
8372 }
Jerry Yu615bd6f2022-02-17 14:25:15 +08008373
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02008374 ret = mbedtls_md_finish(&cloned_ctx, padbuf);
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008375 if (ret != 0) {
8376 goto exit;
8377 }
8378#endif /* MBEDTLS_USE_PSA_CRYPTO */
8379
8380 MBEDTLS_SSL_DEBUG_BUF(4, "finished output", padbuf, hlen);
8381
Jerry Yu615bd6f2022-02-17 14:25:15 +08008382 /*
8383 * TLSv1.2:
8384 * hash = PRF( master, finished_label,
8385 * Hash( handshake ) )[0.11]
8386 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008387 ssl->handshake->tls_prf(session->master, 48, sender,
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008388 padbuf, hlen, buf, len);
Jerry Yu615bd6f2022-02-17 14:25:15 +08008389
Gilles Peskine449bd832023-01-11 14:50:10 +01008390 MBEDTLS_SSL_DEBUG_BUF(3, "calc finished result", buf, len);
Jerry Yu615bd6f2022-02-17 14:25:15 +08008391
Paul Elliottecb95be2023-08-11 16:41:04 +01008392 mbedtls_platform_zeroize(padbuf, hlen);
Jerry Yu615bd6f2022-02-17 14:25:15 +08008393
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008394 MBEDTLS_SSL_DEBUG_MSG(2, ("<= calc finished"));
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01008395
8396exit:
8397#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02008398 psa_hash_abort(&cloned_op);
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +02008399 return mbedtls_md_error_from_psa(status);
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01008400#else
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02008401 mbedtls_md_free(&cloned_ctx);
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01008402 return ret;
8403#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu615bd6f2022-02-17 14:25:15 +08008404}
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008405
8406#if defined(MBEDTLS_MD_CAN_SHA256)
8407static int ssl_calc_finished_tls_sha256(
8408 mbedtls_ssl_context *ssl, unsigned char *buf, int from)
8409{
8410 unsigned char padbuf[32];
8411 return ssl_calc_finished_tls_generic(ssl,
8412#if defined(MBEDTLS_USE_PSA_CRYPTO)
8413 &ssl->handshake->fin_sha256_psa,
8414#else
8415 &ssl->handshake->fin_sha256,
8416#endif
8417 padbuf, sizeof(padbuf),
8418 buf, from);
8419}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01008420#endif /* MBEDTLS_MD_CAN_SHA256*/
Jerry Yu615bd6f2022-02-17 14:25:15 +08008421
Jerry Yub7ba49e2022-02-17 14:25:53 +08008422
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01008423#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +01008424static int ssl_calc_finished_tls_sha384(
Gilles Peskine449bd832023-01-11 14:50:10 +01008425 mbedtls_ssl_context *ssl, unsigned char *buf, int from)
Jerry Yub7ba49e2022-02-17 14:25:53 +08008426{
Jerry Yub7ba49e2022-02-17 14:25:53 +08008427 unsigned char padbuf[48];
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008428 return ssl_calc_finished_tls_generic(ssl,
Jerry Yub7ba49e2022-02-17 14:25:53 +08008429#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008430 &ssl->handshake->fin_sha384_psa,
Jerry Yub7ba49e2022-02-17 14:25:53 +08008431#else
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008432 &ssl->handshake->fin_sha384,
Jerry Yub7ba49e2022-02-17 14:25:53 +08008433#endif
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008434 padbuf, sizeof(padbuf),
8435 buf, from);
Jerry Yub7ba49e2022-02-17 14:25:53 +08008436}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01008437#endif /* MBEDTLS_MD_CAN_SHA384*/
Jerry Yub7ba49e2022-02-17 14:25:53 +08008438
Gilles Peskine449bd832023-01-11 14:50:10 +01008439void mbedtls_ssl_handshake_wrapup_free_hs_transform(mbedtls_ssl_context *ssl)
Jerry Yuaef00152022-02-17 14:27:31 +08008440{
Gilles Peskine449bd832023-01-11 14:50:10 +01008441 MBEDTLS_SSL_DEBUG_MSG(3, ("=> handshake wrapup: final free"));
Jerry Yuaef00152022-02-17 14:27:31 +08008442
8443 /*
8444 * Free our handshake params
8445 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008446 mbedtls_ssl_handshake_free(ssl);
8447 mbedtls_free(ssl->handshake);
Jerry Yuaef00152022-02-17 14:27:31 +08008448 ssl->handshake = NULL;
8449
8450 /*
Shaun Case8b0ecbc2021-12-20 21:14:10 -08008451 * Free the previous transform and switch in the current one
Jerry Yuaef00152022-02-17 14:27:31 +08008452 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008453 if (ssl->transform) {
8454 mbedtls_ssl_transform_free(ssl->transform);
8455 mbedtls_free(ssl->transform);
Jerry Yuaef00152022-02-17 14:27:31 +08008456 }
8457 ssl->transform = ssl->transform_negotiate;
8458 ssl->transform_negotiate = NULL;
8459
Gilles Peskine449bd832023-01-11 14:50:10 +01008460 MBEDTLS_SSL_DEBUG_MSG(3, ("<= handshake wrapup: final free"));
Jerry Yuaef00152022-02-17 14:27:31 +08008461}
8462
Gilles Peskine449bd832023-01-11 14:50:10 +01008463void mbedtls_ssl_handshake_wrapup(mbedtls_ssl_context *ssl)
Jerry Yu2a9fff52022-02-17 14:28:51 +08008464{
8465 int resume = ssl->handshake->resume;
8466
Gilles Peskine449bd832023-01-11 14:50:10 +01008467 MBEDTLS_SSL_DEBUG_MSG(3, ("=> handshake wrapup"));
Jerry Yu2a9fff52022-02-17 14:28:51 +08008468
8469#if defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01008470 if (ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS) {
Jerry Yu2a9fff52022-02-17 14:28:51 +08008471 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_DONE;
8472 ssl->renego_records_seen = 0;
8473 }
8474#endif
8475
8476 /*
8477 * Free the previous session and switch in the current one
8478 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008479 if (ssl->session) {
Jerry Yu2a9fff52022-02-17 14:28:51 +08008480#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
8481 /* RFC 7366 3.1: keep the EtM state */
8482 ssl->session_negotiate->encrypt_then_mac =
Gilles Peskine449bd832023-01-11 14:50:10 +01008483 ssl->session->encrypt_then_mac;
Jerry Yu2a9fff52022-02-17 14:28:51 +08008484#endif
8485
Gilles Peskine449bd832023-01-11 14:50:10 +01008486 mbedtls_ssl_session_free(ssl->session);
8487 mbedtls_free(ssl->session);
Jerry Yu2a9fff52022-02-17 14:28:51 +08008488 }
8489 ssl->session = ssl->session_negotiate;
8490 ssl->session_negotiate = NULL;
8491
8492 /*
8493 * Add cache entry
8494 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008495 if (ssl->conf->f_set_cache != NULL &&
Jerry Yu2a9fff52022-02-17 14:28:51 +08008496 ssl->session->id_len != 0 &&
Gilles Peskine449bd832023-01-11 14:50:10 +01008497 resume == 0) {
8498 if (ssl->conf->f_set_cache(ssl->conf->p_cache,
8499 ssl->session->id,
8500 ssl->session->id_len,
8501 ssl->session) != 0) {
8502 MBEDTLS_SSL_DEBUG_MSG(1, ("cache did not store session"));
8503 }
Jerry Yu2a9fff52022-02-17 14:28:51 +08008504 }
8505
8506#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01008507 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
8508 ssl->handshake->flight != NULL) {
Jerry Yu2a9fff52022-02-17 14:28:51 +08008509 /* Cancel handshake timer */
Gilles Peskine449bd832023-01-11 14:50:10 +01008510 mbedtls_ssl_set_timer(ssl, 0);
Jerry Yu2a9fff52022-02-17 14:28:51 +08008511
8512 /* Keep last flight around in case we need to resend it:
8513 * we need the handshake and transform structures for that */
Gilles Peskine449bd832023-01-11 14:50:10 +01008514 MBEDTLS_SSL_DEBUG_MSG(3, ("skip freeing handshake and transform"));
8515 } else
Jerry Yu2a9fff52022-02-17 14:28:51 +08008516#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01008517 mbedtls_ssl_handshake_wrapup_free_hs_transform(ssl);
Jerry Yu2a9fff52022-02-17 14:28:51 +08008518
Jerry Yu5ed73ff2022-10-27 13:08:42 +08008519 ssl->state = MBEDTLS_SSL_HANDSHAKE_OVER;
Jerry Yu2a9fff52022-02-17 14:28:51 +08008520
Gilles Peskine449bd832023-01-11 14:50:10 +01008521 MBEDTLS_SSL_DEBUG_MSG(3, ("<= handshake wrapup"));
Jerry Yu2a9fff52022-02-17 14:28:51 +08008522}
8523
Gilles Peskine449bd832023-01-11 14:50:10 +01008524int mbedtls_ssl_write_finished(mbedtls_ssl_context *ssl)
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008525{
Dave Rodgmanc37ad442023-11-03 23:36:06 +00008526 int ret;
8527 unsigned int hash_len;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008528
Gilles Peskine449bd832023-01-11 14:50:10 +01008529 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write finished"));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008530
Gilles Peskine449bd832023-01-11 14:50:10 +01008531 mbedtls_ssl_update_out_pointers(ssl, ssl->transform_negotiate);
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008532
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01008533 ret = ssl->handshake->calc_finished(ssl, ssl->out_msg + 4, ssl->conf->endpoint);
8534 if (ret != 0) {
8535 MBEDTLS_SSL_DEBUG_RET(1, "calc_finished", ret);
8536 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008537
8538 /*
8539 * RFC 5246 7.4.9 (Page 63) says 12 is the default length and ciphersuites
8540 * may define some other value. Currently (early 2016), no defined
8541 * ciphersuite does this (and this is unlikely to change as activity has
8542 * moved to TLS 1.3 now) so we can keep the hardcoded 12 here.
8543 */
8544 hash_len = 12;
8545
8546#if defined(MBEDTLS_SSL_RENEGOTIATION)
8547 ssl->verify_data_len = hash_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01008548 memcpy(ssl->own_verify_data, ssl->out_msg + 4, hash_len);
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008549#endif
8550
8551 ssl->out_msglen = 4 + hash_len;
8552 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
8553 ssl->out_msg[0] = MBEDTLS_SSL_HS_FINISHED;
8554
8555 /*
8556 * In case of session resuming, invert the client and server
8557 * ChangeCipherSpec messages order.
8558 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008559 if (ssl->handshake->resume != 0) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008560#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008561 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008562 ssl->state = MBEDTLS_SSL_HANDSHAKE_WRAPUP;
Gilles Peskine449bd832023-01-11 14:50:10 +01008563 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008564#endif
8565#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008566 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008567 ssl->state = MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC;
Gilles Peskine449bd832023-01-11 14:50:10 +01008568 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008569#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01008570 } else {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008571 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01008572 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008573
8574 /*
8575 * Switch to our negotiated transform and session parameters for outbound
8576 * data.
8577 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008578 MBEDTLS_SSL_DEBUG_MSG(3, ("switching to new transform spec for outbound data"));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008579
8580#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01008581 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008582 unsigned char i;
8583
8584 /* Remember current epoch settings for resending */
8585 ssl->handshake->alt_transform_out = ssl->transform_out;
Gilles Peskine449bd832023-01-11 14:50:10 +01008586 memcpy(ssl->handshake->alt_out_ctr, ssl->cur_out_ctr,
8587 sizeof(ssl->handshake->alt_out_ctr));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008588
8589 /* Set sequence_number to zero */
Gilles Peskine449bd832023-01-11 14:50:10 +01008590 memset(&ssl->cur_out_ctr[2], 0, sizeof(ssl->cur_out_ctr) - 2);
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008591
8592
8593 /* Increment epoch */
Gilles Peskine449bd832023-01-11 14:50:10 +01008594 for (i = 2; i > 0; i--) {
8595 if (++ssl->cur_out_ctr[i - 1] != 0) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008596 break;
Gilles Peskine449bd832023-01-11 14:50:10 +01008597 }
8598 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008599
8600 /* The loop goes to its end iff the counter is wrapping */
Gilles Peskine449bd832023-01-11 14:50:10 +01008601 if (i == 0) {
8602 MBEDTLS_SSL_DEBUG_MSG(1, ("DTLS epoch would wrap"));
8603 return MBEDTLS_ERR_SSL_COUNTER_WRAPPING;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008604 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008605 } else
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008606#endif /* MBEDTLS_SSL_PROTO_DTLS */
Gilles Peskine449bd832023-01-11 14:50:10 +01008607 memset(ssl->cur_out_ctr, 0, sizeof(ssl->cur_out_ctr));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008608
8609 ssl->transform_out = ssl->transform_negotiate;
8610 ssl->session_out = ssl->session_negotiate;
8611
8612#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01008613 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
8614 mbedtls_ssl_send_flight_completed(ssl);
8615 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008616#endif
8617
Gilles Peskine449bd832023-01-11 14:50:10 +01008618 if ((ret = mbedtls_ssl_write_handshake_msg(ssl)) != 0) {
8619 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_handshake_msg", ret);
8620 return ret;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008621 }
8622
8623#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01008624 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
8625 (ret = mbedtls_ssl_flight_transmit(ssl)) != 0) {
8626 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_flight_transmit", ret);
8627 return ret;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008628 }
8629#endif
8630
Gilles Peskine449bd832023-01-11 14:50:10 +01008631 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write finished"));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008632
Gilles Peskine449bd832023-01-11 14:50:10 +01008633 return 0;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008634}
8635
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008636#define SSL_MAX_HASH_LEN 12
8637
Gilles Peskine449bd832023-01-11 14:50:10 +01008638int mbedtls_ssl_parse_finished(mbedtls_ssl_context *ssl)
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008639{
8640 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
8641 unsigned int hash_len = 12;
8642 unsigned char buf[SSL_MAX_HASH_LEN];
8643
Gilles Peskine449bd832023-01-11 14:50:10 +01008644 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse finished"));
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008645
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01008646 ret = ssl->handshake->calc_finished(ssl, buf, ssl->conf->endpoint ^ 1);
8647 if (ret != 0) {
8648 MBEDTLS_SSL_DEBUG_RET(1, "calc_finished", ret);
8649 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008650
Gilles Peskine449bd832023-01-11 14:50:10 +01008651 if ((ret = mbedtls_ssl_read_record(ssl, 1)) != 0) {
8652 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_read_record", ret);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008653 goto exit;
8654 }
8655
Gilles Peskine449bd832023-01-11 14:50:10 +01008656 if (ssl->in_msgtype != MBEDTLS_SSL_MSG_HANDSHAKE) {
8657 MBEDTLS_SSL_DEBUG_MSG(1, ("bad finished message"));
8658 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8659 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008660 ret = MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
8661 goto exit;
8662 }
8663
Gilles Peskine449bd832023-01-11 14:50:10 +01008664 if (ssl->in_msg[0] != MBEDTLS_SSL_HS_FINISHED) {
8665 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8666 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008667 ret = MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
8668 goto exit;
8669 }
8670
Gilles Peskine449bd832023-01-11 14:50:10 +01008671 if (ssl->in_hslen != mbedtls_ssl_hs_hdr_len(ssl) + hash_len) {
8672 MBEDTLS_SSL_DEBUG_MSG(1, ("bad finished message"));
8673 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8674 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008675 ret = MBEDTLS_ERR_SSL_DECODE_ERROR;
8676 goto exit;
8677 }
8678
Gilles Peskine449bd832023-01-11 14:50:10 +01008679 if (mbedtls_ct_memcmp(ssl->in_msg + mbedtls_ssl_hs_hdr_len(ssl),
8680 buf, hash_len) != 0) {
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_DECRYPT_ERROR);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008684 ret = MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
8685 goto exit;
8686 }
8687
8688#if defined(MBEDTLS_SSL_RENEGOTIATION)
8689 ssl->verify_data_len = hash_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01008690 memcpy(ssl->peer_verify_data, buf, hash_len);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008691#endif
8692
Gilles Peskine449bd832023-01-11 14:50:10 +01008693 if (ssl->handshake->resume != 0) {
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008694#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008695 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008696 ssl->state = MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC;
Gilles Peskine449bd832023-01-11 14:50:10 +01008697 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008698#endif
8699#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008700 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008701 ssl->state = MBEDTLS_SSL_HANDSHAKE_WRAPUP;
Gilles Peskine449bd832023-01-11 14:50:10 +01008702 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008703#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01008704 } else {
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008705 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01008706 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008707
8708#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01008709 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
8710 mbedtls_ssl_recv_flight_completed(ssl);
8711 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008712#endif
8713
Gilles Peskine449bd832023-01-11 14:50:10 +01008714 MBEDTLS_SSL_DEBUG_MSG(2, ("<= parse finished"));
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008715
8716exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01008717 mbedtls_platform_zeroize(buf, hash_len);
8718 return ret;
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008719}
8720
Jerry Yu392112c2022-02-17 14:34:10 +08008721#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
8722/*
8723 * Helper to get TLS 1.2 PRF from ciphersuite
8724 * (Duplicates bits of logic from ssl_set_handshake_prfs().)
8725 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008726static tls_prf_fn ssl_tls12prf_from_cs(int ciphersuite_id)
Jerry Yu392112c2022-02-17 14:34:10 +08008727{
Jerry Yu392112c2022-02-17 14:34:10 +08008728 const mbedtls_ssl_ciphersuite_t * const ciphersuite_info =
Gilles Peskine449bd832023-01-11 14:50:10 +01008729 mbedtls_ssl_ciphersuite_from_id(ciphersuite_id);
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01008730#if defined(MBEDTLS_MD_CAN_SHA384)
Gilles Peskine449bd832023-01-11 14:50:10 +01008731 if (ciphersuite_info != NULL && ciphersuite_info->mac == MBEDTLS_MD_SHA384) {
8732 return tls_prf_sha384;
8733 } else
Jerry Yu392112c2022-02-17 14:34:10 +08008734#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01008735#if defined(MBEDTLS_MD_CAN_SHA256)
Andrzej Kurek894edde2022-09-29 06:31:14 -04008736 {
Gilles Peskine449bd832023-01-11 14:50:10 +01008737 if (ciphersuite_info != NULL && ciphersuite_info->mac == MBEDTLS_MD_SHA256) {
8738 return tls_prf_sha256;
8739 }
Andrzej Kurek894edde2022-09-29 06:31:14 -04008740 }
8741#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01008742#if !defined(MBEDTLS_MD_CAN_SHA384) && \
8743 !defined(MBEDTLS_MD_CAN_SHA256)
Andrzej Kurek894edde2022-09-29 06:31:14 -04008744 (void) ciphersuite_info;
8745#endif
Andrzej Kurekeabeb302022-10-17 07:52:51 -04008746
Gilles Peskine449bd832023-01-11 14:50:10 +01008747 return NULL;
Jerry Yu392112c2022-02-17 14:34:10 +08008748}
8749#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
Jerry Yue93ffcd2022-02-17 14:37:06 +08008750
Gilles Peskine449bd832023-01-11 14:50:10 +01008751static mbedtls_tls_prf_types tls_prf_get_type(mbedtls_ssl_tls_prf_cb *tls_prf)
Jerry Yue93ffcd2022-02-17 14:37:06 +08008752{
8753 ((void) tls_prf);
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01008754#if defined(MBEDTLS_MD_CAN_SHA384)
Gilles Peskine449bd832023-01-11 14:50:10 +01008755 if (tls_prf == tls_prf_sha384) {
8756 return MBEDTLS_SSL_TLS_PRF_SHA384;
8757 } else
Jerry Yue93ffcd2022-02-17 14:37:06 +08008758#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01008759#if defined(MBEDTLS_MD_CAN_SHA256)
Gilles Peskine449bd832023-01-11 14:50:10 +01008760 if (tls_prf == tls_prf_sha256) {
8761 return MBEDTLS_SSL_TLS_PRF_SHA256;
8762 } else
Jerry Yue93ffcd2022-02-17 14:37:06 +08008763#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01008764 return MBEDTLS_SSL_TLS_PRF_NONE;
Jerry Yue93ffcd2022-02-17 14:37:06 +08008765}
8766
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008767/*
8768 * Populate a transform structure with session keys and all the other
8769 * necessary information.
8770 *
8771 * Parameters:
8772 * - [in/out]: transform: structure to populate
8773 * [in] must be just initialised with mbedtls_ssl_transform_init()
8774 * [out] fully populated, ready for use by mbedtls_ssl_{en,de}crypt_buf()
8775 * - [in] ciphersuite
8776 * - [in] master
8777 * - [in] encrypt_then_mac
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008778 * - [in] tls_prf: pointer to PRF to use for key derivation
8779 * - [in] randbytes: buffer holding ServerHello.random + ClientHello.random
Glenn Strauss07c64162022-03-14 12:34:51 -04008780 * - [in] tls_version: TLS version
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008781 * - [in] endpoint: client or server
8782 * - [in] ssl: used for:
8783 * - ssl->conf->{f,p}_export_keys
8784 * [in] optionally used for:
8785 * - MBEDTLS_DEBUG_C: ssl->conf->{f,p}_dbg
8786 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02008787MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01008788static int ssl_tls12_populate_transform(mbedtls_ssl_transform *transform,
8789 int ciphersuite,
8790 const unsigned char master[48],
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008791#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01008792 int encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008793#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01008794 ssl_tls_prf_t tls_prf,
8795 const unsigned char randbytes[64],
8796 mbedtls_ssl_protocol_version tls_version,
8797 unsigned endpoint,
8798 const mbedtls_ssl_context *ssl)
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008799{
8800 int ret = 0;
8801 unsigned char keyblk[256];
8802 unsigned char *key1;
8803 unsigned char *key2;
8804 unsigned char *mac_enc;
8805 unsigned char *mac_dec;
8806 size_t mac_key_len = 0;
8807 size_t iv_copy_len;
8808 size_t keylen;
8809 const mbedtls_ssl_ciphersuite_t *ciphersuite_info;
Neil Armstrong7fea33e2022-04-01 15:40:25 +02008810 mbedtls_ssl_mode_t ssl_mode;
Neil Armstronge4512952022-03-08 09:08:22 +01008811#if !defined(MBEDTLS_USE_PSA_CRYPTO)
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008812 const mbedtls_cipher_info_t *cipher_info;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008813 const mbedtls_md_info_t *md_info;
Neil Armstronge4512952022-03-08 09:08:22 +01008814#endif /* !MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008815
8816#if defined(MBEDTLS_USE_PSA_CRYPTO)
8817 psa_key_type_t key_type;
8818 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
8819 psa_algorithm_t alg;
Neil Armstronge4512952022-03-08 09:08:22 +01008820 psa_algorithm_t mac_alg = 0;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008821 size_t key_bits;
8822 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
8823#endif
8824
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008825 /*
8826 * Some data just needs copying into the structure
8827 */
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008828#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008829 transform->encrypt_then_mac = encrypt_then_mac;
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008830#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Glenn Strauss07c64162022-03-14 12:34:51 -04008831 transform->tls_version = tls_version;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008832
8833#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01008834 memcpy(transform->randbytes, randbytes, sizeof(transform->randbytes));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008835#endif
8836
8837#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01008838 if (tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008839 /* At the moment, we keep TLS <= 1.2 and TLS 1.3 transform
8840 * generation separate. This should never happen. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008841 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008842 }
8843#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
8844
8845 /*
8846 * Get various info structures
8847 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008848 ciphersuite_info = mbedtls_ssl_ciphersuite_from_id(ciphersuite);
8849 if (ciphersuite_info == NULL) {
8850 MBEDTLS_SSL_DEBUG_MSG(1, ("ciphersuite info for %d not found",
8851 ciphersuite));
8852 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008853 }
8854
Neil Armstrongab555e02022-04-04 11:07:59 +02008855 ssl_mode = mbedtls_ssl_get_mode_from_ciphersuite(
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008856#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01008857 encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008858#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01008859 ciphersuite_info);
Neil Armstrong7fea33e2022-04-01 15:40:25 +02008860
Gilles Peskine449bd832023-01-11 14:50:10 +01008861 if (ssl_mode == MBEDTLS_SSL_MODE_AEAD) {
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008862 transform->taglen =
8863 ciphersuite_info->flags & MBEDTLS_CIPHERSUITE_SHORT_TAG ? 8 : 16;
Gilles Peskine449bd832023-01-11 14:50:10 +01008864 }
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008865
8866#if defined(MBEDTLS_USE_PSA_CRYPTO)
Dave Rodgman2eab4622023-10-05 13:30:37 +01008867 if ((status = mbedtls_ssl_cipher_to_psa((mbedtls_cipher_type_t) ciphersuite_info->cipher,
Gilles Peskine449bd832023-01-11 14:50:10 +01008868 transform->taglen,
8869 &alg,
8870 &key_type,
8871 &key_bits)) != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008872 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01008873 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_cipher_to_psa", ret);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008874 goto end;
8875 }
8876#else
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01008877 cipher_info = mbedtls_cipher_info_from_type((mbedtls_cipher_type_t) ciphersuite_info->cipher);
Gilles Peskine449bd832023-01-11 14:50:10 +01008878 if (cipher_info == NULL) {
8879 MBEDTLS_SSL_DEBUG_MSG(1, ("cipher info for %u not found",
8880 ciphersuite_info->cipher));
8881 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008882 }
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008883#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008884
Neil Armstronge4512952022-03-08 09:08:22 +01008885#if defined(MBEDTLS_USE_PSA_CRYPTO)
Dave Rodgman2eab4622023-10-05 13:30:37 +01008886 mac_alg = mbedtls_md_psa_alg_from_type((mbedtls_md_type_t) ciphersuite_info->mac);
Gilles Peskine449bd832023-01-11 14:50:10 +01008887 if (mac_alg == 0) {
Manuel Pégourié-Gonnard2d6d9932023-03-28 11:38:08 +02008888 MBEDTLS_SSL_DEBUG_MSG(1, ("mbedtls_md_psa_alg_from_type for %u not found",
Gilles Peskine449bd832023-01-11 14:50:10 +01008889 (unsigned) ciphersuite_info->mac));
8890 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Neil Armstronge4512952022-03-08 09:08:22 +01008891 }
8892#else
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01008893 md_info = mbedtls_md_info_from_type((mbedtls_md_type_t) ciphersuite_info->mac);
Gilles Peskine449bd832023-01-11 14:50:10 +01008894 if (md_info == NULL) {
8895 MBEDTLS_SSL_DEBUG_MSG(1, ("mbedtls_md info for %u not found",
8896 (unsigned) ciphersuite_info->mac));
8897 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008898 }
Neil Armstronge4512952022-03-08 09:08:22 +01008899#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008900
8901#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
8902 /* Copy own and peer's CID if the use of the CID
8903 * extension has been negotiated. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008904 if (ssl->handshake->cid_in_use == MBEDTLS_SSL_CID_ENABLED) {
8905 MBEDTLS_SSL_DEBUG_MSG(3, ("Copy CIDs into SSL transform"));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008906
8907 transform->in_cid_len = ssl->own_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01008908 memcpy(transform->in_cid, ssl->own_cid, ssl->own_cid_len);
8909 MBEDTLS_SSL_DEBUG_BUF(3, "Incoming CID", transform->in_cid,
8910 transform->in_cid_len);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008911
8912 transform->out_cid_len = ssl->handshake->peer_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01008913 memcpy(transform->out_cid, ssl->handshake->peer_cid,
8914 ssl->handshake->peer_cid_len);
8915 MBEDTLS_SSL_DEBUG_BUF(3, "Outgoing CID", transform->out_cid,
8916 transform->out_cid_len);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008917 }
8918#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
8919
8920 /*
8921 * Compute key block using the PRF
8922 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008923 ret = tls_prf(master, 48, "key expansion", randbytes, 64, keyblk, 256);
8924 if (ret != 0) {
8925 MBEDTLS_SSL_DEBUG_RET(1, "prf", ret);
8926 return ret;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008927 }
8928
Gilles Peskine449bd832023-01-11 14:50:10 +01008929 MBEDTLS_SSL_DEBUG_MSG(3, ("ciphersuite = %s",
8930 mbedtls_ssl_get_ciphersuite_name(ciphersuite)));
8931 MBEDTLS_SSL_DEBUG_BUF(3, "master secret", master, 48);
8932 MBEDTLS_SSL_DEBUG_BUF(4, "random bytes", randbytes, 64);
8933 MBEDTLS_SSL_DEBUG_BUF(4, "key block", keyblk, 256);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008934
8935 /*
8936 * Determine the appropriate key, IV and MAC length.
8937 */
8938
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008939#if defined(MBEDTLS_USE_PSA_CRYPTO)
8940 keylen = PSA_BITS_TO_BYTES(key_bits);
8941#else
Gilles Peskine449bd832023-01-11 14:50:10 +01008942 keylen = mbedtls_cipher_info_get_key_bitlen(cipher_info) / 8;
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008943#endif
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008944
Valerio Settie5707042023-10-11 11:54:42 +02008945#if defined(MBEDTLS_SSL_HAVE_AEAD)
Gilles Peskine449bd832023-01-11 14:50:10 +01008946 if (ssl_mode == MBEDTLS_SSL_MODE_AEAD) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008947 size_t explicit_ivlen;
8948
8949 transform->maclen = 0;
8950 mac_key_len = 0;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008951
8952 /* All modes haves 96-bit IVs, but the length of the static parts vary
8953 * with mode and version:
8954 * - For GCM and CCM in TLS 1.2, there's a static IV of 4 Bytes
8955 * (to be concatenated with a dynamically chosen IV of 8 Bytes)
8956 * - For ChaChaPoly in TLS 1.2, and all modes in TLS 1.3, there's
8957 * a static IV of 12 Bytes (to be XOR'ed with the 8 Byte record
8958 * sequence number).
8959 */
8960 transform->ivlen = 12;
David Horstmann3b2276a2022-10-06 14:49:08 +01008961
8962 int is_chachapoly = 0;
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008963#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01008964 is_chachapoly = (key_type == PSA_KEY_TYPE_CHACHA20);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008965#else
Gilles Peskine449bd832023-01-11 14:50:10 +01008966 is_chachapoly = (mbedtls_cipher_info_get_mode(cipher_info)
8967 == MBEDTLS_MODE_CHACHAPOLY);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008968#endif /* MBEDTLS_USE_PSA_CRYPTO */
David Horstmann3b2276a2022-10-06 14:49:08 +01008969
Gilles Peskine449bd832023-01-11 14:50:10 +01008970 if (is_chachapoly) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008971 transform->fixed_ivlen = 12;
Gilles Peskine449bd832023-01-11 14:50:10 +01008972 } else {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008973 transform->fixed_ivlen = 4;
Gilles Peskine449bd832023-01-11 14:50:10 +01008974 }
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008975
8976 /* Minimum length of encrypted record */
8977 explicit_ivlen = transform->ivlen - transform->fixed_ivlen;
8978 transform->minlen = explicit_ivlen + transform->taglen;
Gilles Peskine449bd832023-01-11 14:50:10 +01008979 } else
Valerio Settie5707042023-10-11 11:54:42 +02008980#endif /* MBEDTLS_SSL_HAVE_AEAD */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008981#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01008982 if (ssl_mode == MBEDTLS_SSL_MODE_STREAM ||
Neil Armstrong7fea33e2022-04-01 15:40:25 +02008983 ssl_mode == MBEDTLS_SSL_MODE_CBC ||
Gilles Peskine449bd832023-01-11 14:50:10 +01008984 ssl_mode == MBEDTLS_SSL_MODE_CBC_ETM) {
Neil Armstronge4512952022-03-08 09:08:22 +01008985#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01008986 size_t block_size = PSA_BLOCK_CIPHER_BLOCK_LENGTH(key_type);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008987#else
Dave Rodgman85a88132023-06-24 11:41:50 +01008988 size_t block_size = mbedtls_cipher_info_get_block_size(cipher_info);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008989#endif /* MBEDTLS_USE_PSA_CRYPTO */
8990
8991#if defined(MBEDTLS_USE_PSA_CRYPTO)
Neil Armstronge4512952022-03-08 09:08:22 +01008992 /* Get MAC length */
8993 mac_key_len = PSA_HASH_LENGTH(mac_alg);
8994#else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008995 /* Initialize HMAC contexts */
Gilles Peskine449bd832023-01-11 14:50:10 +01008996 if ((ret = mbedtls_md_setup(&transform->md_ctx_enc, md_info, 1)) != 0 ||
8997 (ret = mbedtls_md_setup(&transform->md_ctx_dec, md_info, 1)) != 0) {
8998 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_setup", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008999 goto end;
9000 }
9001
9002 /* Get MAC length */
Gilles Peskine449bd832023-01-11 14:50:10 +01009003 mac_key_len = mbedtls_md_get_size(md_info);
Neil Armstronge4512952022-03-08 09:08:22 +01009004#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009005 transform->maclen = mac_key_len;
9006
9007 /* IV length */
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02009008#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01009009 transform->ivlen = PSA_CIPHER_IV_LENGTH(key_type, alg);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02009010#else
Dave Rodgmanbb521fd2023-06-24 11:21:25 +01009011 transform->ivlen = mbedtls_cipher_info_get_iv_size(cipher_info);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02009012#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009013
9014 /* Minimum length */
Gilles Peskine449bd832023-01-11 14:50:10 +01009015 if (ssl_mode == MBEDTLS_SSL_MODE_STREAM) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009016 transform->minlen = transform->maclen;
Gilles Peskine449bd832023-01-11 14:50:10 +01009017 } else {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009018 /*
9019 * GenericBlockCipher:
9020 * 1. if EtM is in use: one block plus MAC
9021 * otherwise: * first multiple of blocklen greater than maclen
9022 * 2. IV
9023 */
9024#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01009025 if (ssl_mode == MBEDTLS_SSL_MODE_CBC_ETM) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009026 transform->minlen = transform->maclen
Gilles Peskine449bd832023-01-11 14:50:10 +01009027 + block_size;
9028 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009029#endif
9030 {
9031 transform->minlen = transform->maclen
Gilles Peskine449bd832023-01-11 14:50:10 +01009032 + block_size
9033 - transform->maclen % block_size;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009034 }
9035
Gilles Peskine449bd832023-01-11 14:50:10 +01009036 if (tls_version == MBEDTLS_SSL_VERSION_TLS1_2) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009037 transform->minlen += transform->ivlen;
Gilles Peskine449bd832023-01-11 14:50:10 +01009038 } else {
9039 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009040 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
9041 goto end;
9042 }
9043 }
Gilles Peskine449bd832023-01-11 14:50:10 +01009044 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009045#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
9046 {
Gilles Peskine449bd832023-01-11 14:50:10 +01009047 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
9048 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009049 }
9050
Gilles Peskine449bd832023-01-11 14:50:10 +01009051 MBEDTLS_SSL_DEBUG_MSG(3, ("keylen: %u, minlen: %u, ivlen: %u, maclen: %u",
9052 (unsigned) keylen,
9053 (unsigned) transform->minlen,
9054 (unsigned) transform->ivlen,
9055 (unsigned) transform->maclen));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009056
9057 /*
9058 * Finally setup the cipher contexts, IVs and MAC secrets.
9059 */
9060#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01009061 if (endpoint == MBEDTLS_SSL_IS_CLIENT) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009062 key1 = keyblk + mac_key_len * 2;
9063 key2 = keyblk + mac_key_len * 2 + keylen;
9064
9065 mac_enc = keyblk;
9066 mac_dec = keyblk + mac_key_len;
9067
Gilles Peskine449bd832023-01-11 14:50:10 +01009068 iv_copy_len = (transform->fixed_ivlen) ?
9069 transform->fixed_ivlen : transform->ivlen;
9070 memcpy(transform->iv_enc, key2 + keylen, iv_copy_len);
9071 memcpy(transform->iv_dec, key2 + keylen + iv_copy_len,
9072 iv_copy_len);
9073 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009074#endif /* MBEDTLS_SSL_CLI_C */
9075#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01009076 if (endpoint == MBEDTLS_SSL_IS_SERVER) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009077 key1 = keyblk + mac_key_len * 2 + keylen;
9078 key2 = keyblk + mac_key_len * 2;
9079
9080 mac_enc = keyblk + mac_key_len;
9081 mac_dec = keyblk;
9082
Gilles Peskine449bd832023-01-11 14:50:10 +01009083 iv_copy_len = (transform->fixed_ivlen) ?
9084 transform->fixed_ivlen : transform->ivlen;
9085 memcpy(transform->iv_dec, key1 + keylen, iv_copy_len);
9086 memcpy(transform->iv_enc, key1 + keylen + iv_copy_len,
9087 iv_copy_len);
9088 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009089#endif /* MBEDTLS_SSL_SRV_C */
9090 {
Gilles Peskine449bd832023-01-11 14:50:10 +01009091 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009092 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
9093 goto end;
9094 }
9095
Paul Elliott4fb19552023-10-18 12:15:30 +01009096 if (ssl->f_export_keys != NULL) {
Gilles Peskine449bd832023-01-11 14:50:10 +01009097 ssl->f_export_keys(ssl->p_export_keys,
9098 MBEDTLS_SSL_KEY_EXPORT_TLS12_MASTER_SECRET,
9099 master, 48,
9100 randbytes + 32,
9101 randbytes,
9102 tls_prf_get_type(tls_prf));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009103 }
9104
9105#if defined(MBEDTLS_USE_PSA_CRYPTO)
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009106 transform->psa_alg = alg;
9107
Gilles Peskine449bd832023-01-11 14:50:10 +01009108 if (alg != MBEDTLS_SSL_NULL_CIPHER) {
9109 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_ENCRYPT);
9110 psa_set_key_algorithm(&attributes, alg);
9111 psa_set_key_type(&attributes, key_type);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009112
Gilles Peskine449bd832023-01-11 14:50:10 +01009113 if ((status = psa_import_key(&attributes,
9114 key1,
9115 PSA_BITS_TO_BYTES(key_bits),
9116 &transform->psa_key_enc)) != PSA_SUCCESS) {
9117 MBEDTLS_SSL_DEBUG_RET(3, "psa_import_key", (int) status);
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05009118 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01009119 MBEDTLS_SSL_DEBUG_RET(1, "psa_import_key", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009120 goto end;
9121 }
9122
Gilles Peskine449bd832023-01-11 14:50:10 +01009123 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_DECRYPT);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009124
Gilles Peskine449bd832023-01-11 14:50:10 +01009125 if ((status = psa_import_key(&attributes,
9126 key2,
9127 PSA_BITS_TO_BYTES(key_bits),
9128 &transform->psa_key_dec)) != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05009129 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01009130 MBEDTLS_SSL_DEBUG_RET(1, "psa_import_key", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009131 goto end;
9132 }
9133 }
9134#else
Gilles Peskine449bd832023-01-11 14:50:10 +01009135 if ((ret = mbedtls_cipher_setup(&transform->cipher_ctx_enc,
9136 cipher_info)) != 0) {
9137 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_setup", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009138 goto end;
9139 }
9140
Gilles Peskine449bd832023-01-11 14:50:10 +01009141 if ((ret = mbedtls_cipher_setup(&transform->cipher_ctx_dec,
9142 cipher_info)) != 0) {
9143 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_setup", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009144 goto end;
9145 }
9146
Gilles Peskine449bd832023-01-11 14:50:10 +01009147 if ((ret = mbedtls_cipher_setkey(&transform->cipher_ctx_enc, key1,
9148 (int) mbedtls_cipher_info_get_key_bitlen(cipher_info),
9149 MBEDTLS_ENCRYPT)) != 0) {
9150 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_setkey", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009151 goto end;
9152 }
9153
Gilles Peskine449bd832023-01-11 14:50:10 +01009154 if ((ret = mbedtls_cipher_setkey(&transform->cipher_ctx_dec, key2,
9155 (int) mbedtls_cipher_info_get_key_bitlen(cipher_info),
9156 MBEDTLS_DECRYPT)) != 0) {
9157 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_setkey", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009158 goto end;
9159 }
9160
9161#if defined(MBEDTLS_CIPHER_MODE_CBC)
Gilles Peskine449bd832023-01-11 14:50:10 +01009162 if (mbedtls_cipher_info_get_mode(cipher_info) == MBEDTLS_MODE_CBC) {
9163 if ((ret = mbedtls_cipher_set_padding_mode(&transform->cipher_ctx_enc,
9164 MBEDTLS_PADDING_NONE)) != 0) {
9165 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_set_padding_mode", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009166 goto end;
9167 }
9168
Gilles Peskine449bd832023-01-11 14:50:10 +01009169 if ((ret = mbedtls_cipher_set_padding_mode(&transform->cipher_ctx_dec,
9170 MBEDTLS_PADDING_NONE)) != 0) {
9171 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_set_padding_mode", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009172 goto end;
9173 }
9174 }
9175#endif /* MBEDTLS_CIPHER_MODE_CBC */
9176#endif /* MBEDTLS_USE_PSA_CRYPTO */
9177
Neil Armstrong29c0c042022-03-17 17:47:28 +01009178#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
9179 /* For HMAC-based ciphersuites, initialize the HMAC transforms.
9180 For AEAD-based ciphersuites, there is nothing to do here. */
Gilles Peskine449bd832023-01-11 14:50:10 +01009181 if (mac_key_len != 0) {
Neil Armstrong29c0c042022-03-17 17:47:28 +01009182#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01009183 transform->psa_mac_alg = PSA_ALG_HMAC(mac_alg);
Neil Armstrong29c0c042022-03-17 17:47:28 +01009184
Gilles Peskine449bd832023-01-11 14:50:10 +01009185 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_SIGN_MESSAGE);
9186 psa_set_key_algorithm(&attributes, PSA_ALG_HMAC(mac_alg));
9187 psa_set_key_type(&attributes, PSA_KEY_TYPE_HMAC);
Neil Armstrong29c0c042022-03-17 17:47:28 +01009188
Gilles Peskine449bd832023-01-11 14:50:10 +01009189 if ((status = psa_import_key(&attributes,
9190 mac_enc, mac_key_len,
9191 &transform->psa_mac_enc)) != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05009192 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01009193 MBEDTLS_SSL_DEBUG_RET(1, "psa_import_mac_key", ret);
Neil Armstrong29c0c042022-03-17 17:47:28 +01009194 goto end;
9195 }
9196
Gilles Peskine449bd832023-01-11 14:50:10 +01009197 if ((transform->psa_alg == MBEDTLS_SSL_NULL_CIPHER) ||
9198 ((transform->psa_alg == PSA_ALG_CBC_NO_PADDING)
Andrzej Kurek8c95ac42022-08-17 16:17:00 -04009199#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01009200 && (transform->encrypt_then_mac == MBEDTLS_SSL_ETM_DISABLED)
Andrzej Kurek8c95ac42022-08-17 16:17:00 -04009201#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01009202 )) {
Neil Armstrong29c0c042022-03-17 17:47:28 +01009203 /* mbedtls_ct_hmac() requires the key to be exportable */
Gilles Peskine449bd832023-01-11 14:50:10 +01009204 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_EXPORT |
9205 PSA_KEY_USAGE_VERIFY_HASH);
9206 } else {
9207 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_VERIFY_HASH);
9208 }
Neil Armstrong29c0c042022-03-17 17:47:28 +01009209
Gilles Peskine449bd832023-01-11 14:50:10 +01009210 if ((status = psa_import_key(&attributes,
9211 mac_dec, mac_key_len,
9212 &transform->psa_mac_dec)) != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05009213 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01009214 MBEDTLS_SSL_DEBUG_RET(1, "psa_import_mac_key", ret);
Neil Armstrong29c0c042022-03-17 17:47:28 +01009215 goto end;
9216 }
9217#else
Gilles Peskine449bd832023-01-11 14:50:10 +01009218 ret = mbedtls_md_hmac_starts(&transform->md_ctx_enc, mac_enc, mac_key_len);
9219 if (ret != 0) {
Neil Armstrong29c0c042022-03-17 17:47:28 +01009220 goto end;
Gilles Peskine449bd832023-01-11 14:50:10 +01009221 }
9222 ret = mbedtls_md_hmac_starts(&transform->md_ctx_dec, mac_dec, mac_key_len);
9223 if (ret != 0) {
Neil Armstrong29c0c042022-03-17 17:47:28 +01009224 goto end;
Gilles Peskine449bd832023-01-11 14:50:10 +01009225 }
Neil Armstrong29c0c042022-03-17 17:47:28 +01009226#endif /* MBEDTLS_USE_PSA_CRYPTO */
9227 }
9228#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
9229
9230 ((void) mac_dec);
9231 ((void) mac_enc);
9232
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009233end:
Gilles Peskine449bd832023-01-11 14:50:10 +01009234 mbedtls_platform_zeroize(keyblk, sizeof(keyblk));
9235 return ret;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009236}
9237
Valerio Settia08b1a42022-11-17 15:10:02 +01009238#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED) && \
9239 defined(MBEDTLS_USE_PSA_CRYPTO)
Valerio Setti6b3dab02022-11-17 17:14:54 +01009240int mbedtls_psa_ecjpake_read_round(
Gilles Peskine449bd832023-01-11 14:50:10 +01009241 psa_pake_operation_t *pake_ctx,
9242 const unsigned char *buf,
9243 size_t len, mbedtls_ecjpake_rounds_t round)
Valerio Settia08b1a42022-11-17 15:10:02 +01009244{
9245 psa_status_t status;
9246 size_t input_offset = 0;
Valerio Setti819de862022-11-17 18:05:19 +01009247 /*
Valerio Setti6b3dab02022-11-17 17:14:54 +01009248 * At round one repeat the KEY_SHARE, ZK_PUBLIC & ZF_PROOF twice
9249 * At round two perform a single cycle
9250 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009251 unsigned int remaining_steps = (round == MBEDTLS_ECJPAKE_ROUND_ONE) ? 2 : 1;
Valerio Settia08b1a42022-11-17 15:10:02 +01009252
Gilles Peskine449bd832023-01-11 14:50:10 +01009253 for (; remaining_steps > 0; remaining_steps--) {
9254 for (psa_pake_step_t step = PSA_PAKE_STEP_KEY_SHARE;
Valerio Settia08b1a42022-11-17 15:10:02 +01009255 step <= PSA_PAKE_STEP_ZK_PROOF;
Gilles Peskine449bd832023-01-11 14:50:10 +01009256 ++step) {
Valerio Settia08b1a42022-11-17 15:10:02 +01009257 /* Length is stored at the first byte */
9258 size_t length = buf[input_offset];
9259 input_offset += 1;
9260
Gilles Peskine449bd832023-01-11 14:50:10 +01009261 if (input_offset + length > len) {
Valerio Settia08b1a42022-11-17 15:10:02 +01009262 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
9263 }
9264
Gilles Peskine449bd832023-01-11 14:50:10 +01009265 status = psa_pake_input(pake_ctx, step,
9266 buf + input_offset, length);
9267 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05009268 return PSA_TO_MBEDTLS_ERR(status);
Valerio Settia08b1a42022-11-17 15:10:02 +01009269 }
9270
9271 input_offset += length;
9272 }
9273 }
9274
Gilles Peskine449bd832023-01-11 14:50:10 +01009275 if (input_offset != len) {
Valerio Setti61ea17d2022-11-18 12:11:00 +01009276 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Gilles Peskine449bd832023-01-11 14:50:10 +01009277 }
Valerio Setti30ebe112022-11-17 16:23:34 +01009278
Gilles Peskine449bd832023-01-11 14:50:10 +01009279 return 0;
Valerio Settia08b1a42022-11-17 15:10:02 +01009280}
9281
Valerio Setti6b3dab02022-11-17 17:14:54 +01009282int mbedtls_psa_ecjpake_write_round(
Gilles Peskine449bd832023-01-11 14:50:10 +01009283 psa_pake_operation_t *pake_ctx,
9284 unsigned char *buf,
9285 size_t len, size_t *olen,
9286 mbedtls_ecjpake_rounds_t round)
Valerio Settia08b1a42022-11-17 15:10:02 +01009287{
9288 psa_status_t status;
9289 size_t output_offset = 0;
9290 size_t output_len;
Valerio Setti819de862022-11-17 18:05:19 +01009291 /*
Valerio Setti6b3dab02022-11-17 17:14:54 +01009292 * At round one repeat the KEY_SHARE, ZK_PUBLIC & ZF_PROOF twice
9293 * At round two perform a single cycle
9294 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009295 unsigned int remaining_steps = (round == MBEDTLS_ECJPAKE_ROUND_ONE) ? 2 : 1;
Valerio Settia08b1a42022-11-17 15:10:02 +01009296
Gilles Peskine449bd832023-01-11 14:50:10 +01009297 for (; remaining_steps > 0; remaining_steps--) {
9298 for (psa_pake_step_t step = PSA_PAKE_STEP_KEY_SHARE;
9299 step <= PSA_PAKE_STEP_ZK_PROOF;
9300 ++step) {
Valerio Setti79f6b6b2022-11-21 14:17:03 +01009301 /*
Valerio Settid4a9b1a2022-11-22 11:11:10 +01009302 * For each step, prepend 1 byte with the length of the data as
9303 * given by psa_pake_output().
Valerio Setti79f6b6b2022-11-21 14:17:03 +01009304 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009305 status = psa_pake_output(pake_ctx, step,
9306 buf + output_offset + 1,
9307 len - output_offset - 1,
9308 &output_len);
9309 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05009310 return PSA_TO_MBEDTLS_ERR(status);
Valerio Settia08b1a42022-11-17 15:10:02 +01009311 }
9312
Valerio Setti99d88c12022-11-22 16:03:43 +01009313 *(buf + output_offset) = (uint8_t) output_len;
Valerio Setti79f6b6b2022-11-21 14:17:03 +01009314
9315 output_offset += output_len + 1;
Valerio Settia08b1a42022-11-17 15:10:02 +01009316 }
9317 }
9318
9319 *olen = output_offset;
9320
Gilles Peskine449bd832023-01-11 14:50:10 +01009321 return 0;
Valerio Settia08b1a42022-11-17 15:10:02 +01009322}
Valerio Settia08b1a42022-11-17 15:10:02 +01009323#endif //MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED && MBEDTLS_USE_PSA_CRYPTO
9324
Jerry Yuee40f9d2022-02-17 14:55:16 +08009325#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01009326int mbedtls_ssl_get_key_exchange_md_tls1_2(mbedtls_ssl_context *ssl,
9327 unsigned char *hash, size_t *hashlen,
9328 unsigned char *data, size_t data_len,
9329 mbedtls_md_type_t md_alg)
Jerry Yuee40f9d2022-02-17 14:55:16 +08009330{
9331 psa_status_t status;
9332 psa_hash_operation_t hash_operation = PSA_HASH_OPERATION_INIT;
Manuel Pégourié-Gonnard2d6d9932023-03-28 11:38:08 +02009333 psa_algorithm_t hash_alg = mbedtls_md_psa_alg_from_type(md_alg);
Jerry Yuee40f9d2022-02-17 14:55:16 +08009334
Gilles Peskine449bd832023-01-11 14:50:10 +01009335 MBEDTLS_SSL_DEBUG_MSG(3, ("Perform PSA-based computation of digest of ServerKeyExchange"));
Jerry Yuee40f9d2022-02-17 14:55:16 +08009336
Gilles Peskine449bd832023-01-11 14:50:10 +01009337 if ((status = psa_hash_setup(&hash_operation,
9338 hash_alg)) != PSA_SUCCESS) {
9339 MBEDTLS_SSL_DEBUG_RET(1, "psa_hash_setup", status);
Jerry Yuee40f9d2022-02-17 14:55:16 +08009340 goto exit;
9341 }
9342
Gilles Peskine449bd832023-01-11 14:50:10 +01009343 if ((status = psa_hash_update(&hash_operation, ssl->handshake->randbytes,
9344 64)) != PSA_SUCCESS) {
9345 MBEDTLS_SSL_DEBUG_RET(1, "psa_hash_update", status);
Jerry Yuee40f9d2022-02-17 14:55:16 +08009346 goto exit;
9347 }
9348
Gilles Peskine449bd832023-01-11 14:50:10 +01009349 if ((status = psa_hash_update(&hash_operation,
9350 data, data_len)) != PSA_SUCCESS) {
9351 MBEDTLS_SSL_DEBUG_RET(1, "psa_hash_update", status);
Jerry Yuee40f9d2022-02-17 14:55:16 +08009352 goto exit;
9353 }
9354
Gilles Peskine449bd832023-01-11 14:50:10 +01009355 if ((status = psa_hash_finish(&hash_operation, hash, PSA_HASH_MAX_SIZE,
9356 hashlen)) != PSA_SUCCESS) {
9357 MBEDTLS_SSL_DEBUG_RET(1, "psa_hash_finish", status);
9358 goto exit;
Jerry Yuee40f9d2022-02-17 14:55:16 +08009359 }
9360
9361exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01009362 if (status != PSA_SUCCESS) {
9363 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
9364 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR);
9365 switch (status) {
Jerry Yuee40f9d2022-02-17 14:55:16 +08009366 case PSA_ERROR_NOT_SUPPORTED:
Gilles Peskine449bd832023-01-11 14:50:10 +01009367 return MBEDTLS_ERR_MD_FEATURE_UNAVAILABLE;
Jerry Yuee40f9d2022-02-17 14:55:16 +08009368 case PSA_ERROR_BAD_STATE: /* Intentional fallthrough */
9369 case PSA_ERROR_BUFFER_TOO_SMALL:
Gilles Peskine449bd832023-01-11 14:50:10 +01009370 return MBEDTLS_ERR_MD_BAD_INPUT_DATA;
Jerry Yuee40f9d2022-02-17 14:55:16 +08009371 case PSA_ERROR_INSUFFICIENT_MEMORY:
Gilles Peskine449bd832023-01-11 14:50:10 +01009372 return MBEDTLS_ERR_MD_ALLOC_FAILED;
Jerry Yuee40f9d2022-02-17 14:55:16 +08009373 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01009374 return MBEDTLS_ERR_PLATFORM_HW_ACCEL_FAILED;
Jerry Yuee40f9d2022-02-17 14:55:16 +08009375 }
9376 }
Gilles Peskine449bd832023-01-11 14:50:10 +01009377 return 0;
Jerry Yuee40f9d2022-02-17 14:55:16 +08009378}
9379
9380#else
9381
Gilles Peskine449bd832023-01-11 14:50:10 +01009382int mbedtls_ssl_get_key_exchange_md_tls1_2(mbedtls_ssl_context *ssl,
9383 unsigned char *hash, size_t *hashlen,
9384 unsigned char *data, size_t data_len,
9385 mbedtls_md_type_t md_alg)
Jerry Yuee40f9d2022-02-17 14:55:16 +08009386{
9387 int ret = 0;
9388 mbedtls_md_context_t ctx;
Gilles Peskine449bd832023-01-11 14:50:10 +01009389 const mbedtls_md_info_t *md_info = mbedtls_md_info_from_type(md_alg);
9390 *hashlen = mbedtls_md_get_size(md_info);
Jerry Yuee40f9d2022-02-17 14:55:16 +08009391
Gilles Peskine449bd832023-01-11 14:50:10 +01009392 MBEDTLS_SSL_DEBUG_MSG(3, ("Perform mbedtls-based computation of digest of ServerKeyExchange"));
Jerry Yuee40f9d2022-02-17 14:55:16 +08009393
Gilles Peskine449bd832023-01-11 14:50:10 +01009394 mbedtls_md_init(&ctx);
Jerry Yuee40f9d2022-02-17 14:55:16 +08009395
9396 /*
9397 * digitally-signed struct {
9398 * opaque client_random[32];
9399 * opaque server_random[32];
9400 * ServerDHParams params;
9401 * };
9402 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009403 if ((ret = mbedtls_md_setup(&ctx, md_info, 0)) != 0) {
9404 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_setup", ret);
Jerry Yuee40f9d2022-02-17 14:55:16 +08009405 goto exit;
9406 }
Gilles Peskine449bd832023-01-11 14:50:10 +01009407 if ((ret = mbedtls_md_starts(&ctx)) != 0) {
9408 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_starts", ret);
Jerry Yuee40f9d2022-02-17 14:55:16 +08009409 goto exit;
9410 }
Gilles Peskine449bd832023-01-11 14:50:10 +01009411 if ((ret = mbedtls_md_update(&ctx, ssl->handshake->randbytes, 64)) != 0) {
9412 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_update", ret);
Jerry Yuee40f9d2022-02-17 14:55:16 +08009413 goto exit;
9414 }
Gilles Peskine449bd832023-01-11 14:50:10 +01009415 if ((ret = mbedtls_md_update(&ctx, data, data_len)) != 0) {
9416 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_update", ret);
Jerry Yuee40f9d2022-02-17 14:55:16 +08009417 goto exit;
9418 }
Gilles Peskine449bd832023-01-11 14:50:10 +01009419 if ((ret = mbedtls_md_finish(&ctx, hash)) != 0) {
9420 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_finish", ret);
Jerry Yuee40f9d2022-02-17 14:55:16 +08009421 goto exit;
9422 }
9423
9424exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01009425 mbedtls_md_free(&ctx);
Jerry Yuee40f9d2022-02-17 14:55:16 +08009426
Gilles Peskine449bd832023-01-11 14:50:10 +01009427 if (ret != 0) {
9428 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
9429 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR);
9430 }
Jerry Yuee40f9d2022-02-17 14:55:16 +08009431
Gilles Peskine449bd832023-01-11 14:50:10 +01009432 return ret;
Jerry Yuee40f9d2022-02-17 14:55:16 +08009433}
9434#endif /* MBEDTLS_USE_PSA_CRYPTO */
9435
Jerry Yud9d91da2022-02-17 14:57:06 +08009436#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
9437
Gabor Mezeia3d016c2022-05-10 12:44:09 +02009438/* Find the preferred hash for a given signature algorithm. */
9439unsigned int mbedtls_ssl_tls12_get_preferred_hash_for_sig_alg(
Gilles Peskine449bd832023-01-11 14:50:10 +01009440 mbedtls_ssl_context *ssl,
9441 unsigned int sig_alg)
Jerry Yud9d91da2022-02-17 14:57:06 +08009442{
Gabor Mezei078e8032022-04-27 21:17:56 +02009443 unsigned int i;
Gabor Mezeia3d016c2022-05-10 12:44:09 +02009444 uint16_t *received_sig_algs = ssl->handshake->received_sig_algs;
Gabor Mezei078e8032022-04-27 21:17:56 +02009445
Gilles Peskine449bd832023-01-11 14:50:10 +01009446 if (sig_alg == MBEDTLS_SSL_SIG_ANON) {
9447 return MBEDTLS_SSL_HASH_NONE;
9448 }
Gabor Mezei078e8032022-04-27 21:17:56 +02009449
Gilles Peskine449bd832023-01-11 14:50:10 +01009450 for (i = 0; received_sig_algs[i] != MBEDTLS_TLS_SIG_NONE; i++) {
Neil Armstrong9f1176a2022-06-24 18:19:19 +02009451 unsigned int hash_alg_received =
Gilles Peskine449bd832023-01-11 14:50:10 +01009452 MBEDTLS_SSL_TLS12_HASH_ALG_FROM_SIG_AND_HASH_ALG(
9453 received_sig_algs[i]);
Neil Armstrong9f1176a2022-06-24 18:19:19 +02009454 unsigned int sig_alg_received =
Gilles Peskine449bd832023-01-11 14:50:10 +01009455 MBEDTLS_SSL_TLS12_SIG_ALG_FROM_SIG_AND_HASH_ALG(
9456 received_sig_algs[i]);
Neil Armstrong9f1176a2022-06-24 18:19:19 +02009457
Manuel Pégourié-Gonnard47bb3802023-06-05 12:40:32 +02009458 mbedtls_md_type_t md_alg =
9459 mbedtls_ssl_md_alg_from_hash((unsigned char) hash_alg_received);
9460 if (md_alg == MBEDTLS_MD_NONE) {
9461 continue;
9462 }
9463
Gilles Peskine449bd832023-01-11 14:50:10 +01009464 if (sig_alg == sig_alg_received) {
Neil Armstrong9f1176a2022-06-24 18:19:19 +02009465#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01009466 if (ssl->handshake->key_cert && ssl->handshake->key_cert->key) {
Neil Armstrong96eceb82022-06-30 18:05:05 +02009467 psa_algorithm_t psa_hash_alg =
Manuel Pégourié-Gonnard47bb3802023-06-05 12:40:32 +02009468 mbedtls_md_psa_alg_from_type(md_alg);
Neil Armstrong9f1176a2022-06-24 18:19:19 +02009469
Gilles Peskine449bd832023-01-11 14:50:10 +01009470 if (sig_alg_received == MBEDTLS_SSL_SIG_ECDSA &&
9471 !mbedtls_pk_can_do_ext(ssl->handshake->key_cert->key,
9472 PSA_ALG_ECDSA(psa_hash_alg),
9473 PSA_KEY_USAGE_SIGN_HASH)) {
Neil Armstrong9f1176a2022-06-24 18:19:19 +02009474 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01009475 }
Neil Armstrong9f1176a2022-06-24 18:19:19 +02009476
Gilles Peskine449bd832023-01-11 14:50:10 +01009477 if (sig_alg_received == MBEDTLS_SSL_SIG_RSA &&
9478 !mbedtls_pk_can_do_ext(ssl->handshake->key_cert->key,
9479 PSA_ALG_RSA_PKCS1V15_SIGN(
9480 psa_hash_alg),
9481 PSA_KEY_USAGE_SIGN_HASH)) {
Neil Armstrong9f1176a2022-06-24 18:19:19 +02009482 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01009483 }
Neil Armstrong9f1176a2022-06-24 18:19:19 +02009484 }
Neil Armstrong9f1176a2022-06-24 18:19:19 +02009485#endif /* MBEDTLS_USE_PSA_CRYPTO */
Neil Armstrong96eceb82022-06-30 18:05:05 +02009486
Gilles Peskine449bd832023-01-11 14:50:10 +01009487 return hash_alg_received;
Neil Armstrong9f1176a2022-06-24 18:19:19 +02009488 }
Jerry Yud9d91da2022-02-17 14:57:06 +08009489 }
Jerry Yud9d91da2022-02-17 14:57:06 +08009490
Gilles Peskine449bd832023-01-11 14:50:10 +01009491 return MBEDTLS_SSL_HASH_NONE;
Jerry Yud9d91da2022-02-17 14:57:06 +08009492}
9493
9494#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
9495
Jerry Yudc7bd172022-02-17 13:44:15 +08009496#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
9497
XiaokangQian75d40ef2022-04-20 11:05:24 +00009498int mbedtls_ssl_validate_ciphersuite(
9499 const mbedtls_ssl_context *ssl,
9500 const mbedtls_ssl_ciphersuite_t *suite_info,
9501 mbedtls_ssl_protocol_version min_tls_version,
Gilles Peskine449bd832023-01-11 14:50:10 +01009502 mbedtls_ssl_protocol_version max_tls_version)
XiaokangQian75d40ef2022-04-20 11:05:24 +00009503{
9504 (void) ssl;
9505
Gilles Peskine449bd832023-01-11 14:50:10 +01009506 if (suite_info == NULL) {
9507 return -1;
9508 }
XiaokangQian75d40ef2022-04-20 11:05:24 +00009509
Gilles Peskine449bd832023-01-11 14:50:10 +01009510 if ((suite_info->min_tls_version > max_tls_version) ||
9511 (suite_info->max_tls_version < min_tls_version)) {
9512 return -1;
XiaokangQian75d40ef2022-04-20 11:05:24 +00009513 }
9514
XiaokangQian060d8672022-04-21 09:24:56 +00009515#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_CLI_C)
XiaokangQian75d40ef2022-04-20 11:05:24 +00009516#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Neil Armstrongca7d5062022-05-31 14:43:23 +02009517#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01009518 if (suite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_ECJPAKE &&
9519 ssl->handshake->psa_pake_ctx_is_ok != 1)
Neil Armstrongca7d5062022-05-31 14:43:23 +02009520#else
Gilles Peskine449bd832023-01-11 14:50:10 +01009521 if (suite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_ECJPAKE &&
9522 mbedtls_ecjpake_check(&ssl->handshake->ecjpake_ctx) != 0)
Neil Armstrongca7d5062022-05-31 14:43:23 +02009523#endif /* MBEDTLS_USE_PSA_CRYPTO */
XiaokangQian75d40ef2022-04-20 11:05:24 +00009524 {
Gilles Peskine449bd832023-01-11 14:50:10 +01009525 return -1;
XiaokangQian75d40ef2022-04-20 11:05:24 +00009526 }
9527#endif
9528
9529 /* Don't suggest PSK-based ciphersuite if no PSK is available. */
9530#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01009531 if (mbedtls_ssl_ciphersuite_uses_psk(suite_info) &&
9532 mbedtls_ssl_conf_has_static_psk(ssl->conf) == 0) {
9533 return -1;
XiaokangQian75d40ef2022-04-20 11:05:24 +00009534 }
9535#endif /* MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
9536#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
9537
Gilles Peskine449bd832023-01-11 14:50:10 +01009538 return 0;
XiaokangQian75d40ef2022-04-20 11:05:24 +00009539}
9540
Ronald Crone68ab4f2022-10-05 12:46:29 +02009541#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
XiaokangQianeaf36512022-04-24 09:07:44 +00009542/*
9543 * Function for writing a signature algorithm extension.
9544 *
9545 * The `extension_data` field of signature algorithm contains a `SignatureSchemeList`
9546 * value (TLS 1.3 RFC8446):
9547 * enum {
9548 * ....
9549 * ecdsa_secp256r1_sha256( 0x0403 ),
9550 * ecdsa_secp384r1_sha384( 0x0503 ),
9551 * ecdsa_secp521r1_sha512( 0x0603 ),
9552 * ....
9553 * } SignatureScheme;
9554 *
9555 * struct {
9556 * SignatureScheme supported_signature_algorithms<2..2^16-2>;
9557 * } SignatureSchemeList;
9558 *
9559 * The `extension_data` field of signature algorithm contains a `SignatureAndHashAlgorithm`
9560 * value (TLS 1.2 RFC5246):
9561 * enum {
9562 * none(0), md5(1), sha1(2), sha224(3), sha256(4), sha384(5),
9563 * sha512(6), (255)
9564 * } HashAlgorithm;
9565 *
9566 * enum { anonymous(0), rsa(1), dsa(2), ecdsa(3), (255) }
9567 * SignatureAlgorithm;
9568 *
9569 * struct {
9570 * HashAlgorithm hash;
9571 * SignatureAlgorithm signature;
9572 * } SignatureAndHashAlgorithm;
9573 *
9574 * SignatureAndHashAlgorithm
9575 * supported_signature_algorithms<2..2^16-2>;
9576 *
9577 * The TLS 1.3 signature algorithm extension was defined to be a compatible
9578 * generalization of the TLS 1.2 signature algorithm extension.
9579 * `SignatureAndHashAlgorithm` field of TLS 1.2 can be represented by
9580 * `SignatureScheme` field of TLS 1.3
9581 *
9582 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009583int mbedtls_ssl_write_sig_alg_ext(mbedtls_ssl_context *ssl, unsigned char *buf,
9584 const unsigned char *end, size_t *out_len)
XiaokangQianeaf36512022-04-24 09:07:44 +00009585{
9586 unsigned char *p = buf;
9587 unsigned char *supported_sig_alg; /* Start of supported_signature_algorithms */
9588 size_t supported_sig_alg_len = 0; /* Length of supported_signature_algorithms */
9589
9590 *out_len = 0;
9591
Gilles Peskine449bd832023-01-11 14:50:10 +01009592 MBEDTLS_SSL_DEBUG_MSG(3, ("adding signature_algorithms extension"));
XiaokangQianeaf36512022-04-24 09:07:44 +00009593
9594 /* Check if we have space for header and length field:
9595 * - extension_type (2 bytes)
9596 * - extension_data_length (2 bytes)
9597 * - supported_signature_algorithms_length (2 bytes)
9598 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009599 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 6);
XiaokangQianeaf36512022-04-24 09:07:44 +00009600 p += 6;
9601
9602 /*
9603 * Write supported_signature_algorithms
9604 */
9605 supported_sig_alg = p;
Gilles Peskine449bd832023-01-11 14:50:10 +01009606 const uint16_t *sig_alg = mbedtls_ssl_get_sig_algs(ssl);
9607 if (sig_alg == NULL) {
9608 return MBEDTLS_ERR_SSL_BAD_CONFIG;
9609 }
XiaokangQianeaf36512022-04-24 09:07:44 +00009610
Gilles Peskine449bd832023-01-11 14:50:10 +01009611 for (; *sig_alg != MBEDTLS_TLS1_3_SIG_NONE; sig_alg++) {
9612 MBEDTLS_SSL_DEBUG_MSG(3, ("got signature scheme [%x] %s",
9613 *sig_alg,
9614 mbedtls_ssl_sig_alg_to_str(*sig_alg)));
9615 if (!mbedtls_ssl_sig_alg_is_supported(ssl, *sig_alg)) {
XiaokangQianeaf36512022-04-24 09:07:44 +00009616 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01009617 }
9618 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 2);
9619 MBEDTLS_PUT_UINT16_BE(*sig_alg, p, 0);
XiaokangQianeaf36512022-04-24 09:07:44 +00009620 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01009621 MBEDTLS_SSL_DEBUG_MSG(3, ("sent signature scheme [%x] %s",
9622 *sig_alg,
9623 mbedtls_ssl_sig_alg_to_str(*sig_alg)));
XiaokangQianeaf36512022-04-24 09:07:44 +00009624 }
9625
9626 /* Length of supported_signature_algorithms */
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00009627 supported_sig_alg_len = (size_t) (p - supported_sig_alg);
Gilles Peskine449bd832023-01-11 14:50:10 +01009628 if (supported_sig_alg_len == 0) {
9629 MBEDTLS_SSL_DEBUG_MSG(1, ("No signature algorithms defined."));
9630 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
XiaokangQianeaf36512022-04-24 09:07:44 +00009631 }
9632
Gilles Peskine449bd832023-01-11 14:50:10 +01009633 MBEDTLS_PUT_UINT16_BE(MBEDTLS_TLS_EXT_SIG_ALG, buf, 0);
9634 MBEDTLS_PUT_UINT16_BE(supported_sig_alg_len + 2, buf, 2);
9635 MBEDTLS_PUT_UINT16_BE(supported_sig_alg_len, buf, 4);
XiaokangQianeaf36512022-04-24 09:07:44 +00009636
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00009637 *out_len = (size_t) (p - buf);
XiaokangQianeaf36512022-04-24 09:07:44 +00009638
9639#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01009640 mbedtls_ssl_tls13_set_hs_sent_ext_mask(ssl, MBEDTLS_TLS_EXT_SIG_ALG);
XiaokangQianeaf36512022-04-24 09:07:44 +00009641#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yu0c354a22022-08-29 15:25:36 +08009642
Gilles Peskine449bd832023-01-11 14:50:10 +01009643 return 0;
XiaokangQianeaf36512022-04-24 09:07:44 +00009644}
Ronald Crone68ab4f2022-10-05 12:46:29 +02009645#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
XiaokangQianeaf36512022-04-24 09:07:44 +00009646
XiaokangQian40a35232022-05-07 09:02:40 +00009647#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
XiaokangQian9b2b7712022-05-17 02:57:00 +00009648/*
9649 * mbedtls_ssl_parse_server_name_ext
9650 *
9651 * Structure of server_name extension:
9652 *
9653 * enum {
9654 * host_name(0), (255)
9655 * } NameType;
9656 * opaque HostName<1..2^16-1>;
9657 *
9658 * struct {
9659 * NameType name_type;
9660 * select (name_type) {
9661 * case host_name: HostName;
9662 * } name;
9663 * } ServerName;
9664 * struct {
9665 * ServerName server_name_list<1..2^16-1>
9666 * } ServerNameList;
9667 */
Ronald Cronce7d76e2022-07-08 18:56:49 +02009668MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01009669int mbedtls_ssl_parse_server_name_ext(mbedtls_ssl_context *ssl,
9670 const unsigned char *buf,
9671 const unsigned char *end)
XiaokangQian40a35232022-05-07 09:02:40 +00009672{
9673 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
9674 const unsigned char *p = buf;
XiaokangQian9b2b7712022-05-17 02:57:00 +00009675 size_t server_name_list_len, hostname_len;
9676 const unsigned char *server_name_list_end;
XiaokangQian40a35232022-05-07 09:02:40 +00009677
Gilles Peskine449bd832023-01-11 14:50:10 +01009678 MBEDTLS_SSL_DEBUG_MSG(3, ("parse ServerName extension"));
XiaokangQian40a35232022-05-07 09:02:40 +00009679
Gilles Peskine449bd832023-01-11 14:50:10 +01009680 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
9681 server_name_list_len = MBEDTLS_GET_UINT16_BE(p, 0);
XiaokangQian40a35232022-05-07 09:02:40 +00009682 p += 2;
9683
Gilles Peskine449bd832023-01-11 14:50:10 +01009684 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, server_name_list_len);
XiaokangQian9b2b7712022-05-17 02:57:00 +00009685 server_name_list_end = p + server_name_list_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01009686 while (p < server_name_list_end) {
9687 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, server_name_list_end, 3);
9688 hostname_len = MBEDTLS_GET_UINT16_BE(p, 1);
9689 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, server_name_list_end,
9690 hostname_len + 3);
XiaokangQian40a35232022-05-07 09:02:40 +00009691
Gilles Peskine449bd832023-01-11 14:50:10 +01009692 if (p[0] == MBEDTLS_TLS_EXT_SERVERNAME_HOSTNAME) {
XiaokangQian75fe8c72022-06-15 09:42:45 +00009693 /* sni_name is intended to be used only during the parsing of the
9694 * ClientHello message (it is reset to NULL before the end of
9695 * the message parsing). Thus it is ok to just point to the
9696 * reception buffer and not make a copy of it.
9697 */
XiaokangQianf2a94202022-05-20 06:44:24 +00009698 ssl->handshake->sni_name = p + 3;
9699 ssl->handshake->sni_name_len = hostname_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01009700 if (ssl->conf->f_sni == NULL) {
9701 return 0;
XiaokangQian40a35232022-05-07 09:02:40 +00009702 }
Gilles Peskine449bd832023-01-11 14:50:10 +01009703 ret = ssl->conf->f_sni(ssl->conf->p_sni,
9704 ssl, p + 3, hostname_len);
9705 if (ret != 0) {
9706 MBEDTLS_SSL_DEBUG_RET(1, "ssl_sni_wrapper", ret);
9707 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_UNRECOGNIZED_NAME,
9708 MBEDTLS_ERR_SSL_UNRECOGNIZED_NAME);
9709 return MBEDTLS_ERR_SSL_UNRECOGNIZED_NAME;
9710 }
9711 return 0;
XiaokangQian40a35232022-05-07 09:02:40 +00009712 }
9713
9714 p += hostname_len + 3;
9715 }
9716
Gilles Peskine449bd832023-01-11 14:50:10 +01009717 return 0;
XiaokangQian40a35232022-05-07 09:02:40 +00009718}
9719#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
9720
XiaokangQianacb39922022-06-17 10:18:48 +00009721#if defined(MBEDTLS_SSL_ALPN)
Ronald Cronce7d76e2022-07-08 18:56:49 +02009722MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01009723int mbedtls_ssl_parse_alpn_ext(mbedtls_ssl_context *ssl,
9724 const unsigned char *buf,
9725 const unsigned char *end)
XiaokangQianacb39922022-06-17 10:18:48 +00009726{
9727 const unsigned char *p = buf;
XiaokangQianc7403452022-06-23 03:24:12 +00009728 size_t protocol_name_list_len;
XiaokangQian95d5f542022-06-24 02:29:26 +00009729 const unsigned char *protocol_name_list;
9730 const unsigned char *protocol_name_list_end;
XiaokangQianc7403452022-06-23 03:24:12 +00009731 size_t protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00009732
9733 /* If ALPN not configured, just ignore the extension */
Gilles Peskine449bd832023-01-11 14:50:10 +01009734 if (ssl->conf->alpn_list == NULL) {
9735 return 0;
9736 }
XiaokangQianacb39922022-06-17 10:18:48 +00009737
9738 /*
XiaokangQianc7403452022-06-23 03:24:12 +00009739 * RFC7301, section 3.1
9740 * opaque ProtocolName<1..2^8-1>;
XiaokangQianacb39922022-06-17 10:18:48 +00009741 *
XiaokangQianc7403452022-06-23 03:24:12 +00009742 * struct {
9743 * ProtocolName protocol_name_list<2..2^16-1>
9744 * } ProtocolNameList;
XiaokangQianacb39922022-06-17 10:18:48 +00009745 */
9746
XiaokangQianc7403452022-06-23 03:24:12 +00009747 /*
XiaokangQian0b776e22022-06-24 09:04:59 +00009748 * protocol_name_list_len 2 bytes
9749 * protocol_name_len 1 bytes
9750 * protocol_name >=1 byte
XiaokangQianc7403452022-06-23 03:24:12 +00009751 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009752 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 4);
XiaokangQianacb39922022-06-17 10:18:48 +00009753
Gilles Peskine449bd832023-01-11 14:50:10 +01009754 protocol_name_list_len = MBEDTLS_GET_UINT16_BE(p, 0);
XiaokangQianacb39922022-06-17 10:18:48 +00009755 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01009756 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, protocol_name_list_len);
XiaokangQian95d5f542022-06-24 02:29:26 +00009757 protocol_name_list = p;
9758 protocol_name_list_end = p + protocol_name_list_len;
XiaokangQianacb39922022-06-17 10:18:48 +00009759
9760 /* Validate peer's list (lengths) */
Gilles Peskine449bd832023-01-11 14:50:10 +01009761 while (p < protocol_name_list_end) {
XiaokangQian95d5f542022-06-24 02:29:26 +00009762 protocol_name_len = *p++;
Gilles Peskine449bd832023-01-11 14:50:10 +01009763 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, protocol_name_list_end,
9764 protocol_name_len);
9765 if (protocol_name_len == 0) {
XiaokangQian95d5f542022-06-24 02:29:26 +00009766 MBEDTLS_SSL_PEND_FATAL_ALERT(
9767 MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
Gilles Peskine449bd832023-01-11 14:50:10 +01009768 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
9769 return MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
XiaokangQian95d5f542022-06-24 02:29:26 +00009770 }
9771
9772 p += protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00009773 }
9774
9775 /* Use our order of preference */
Gilles Peskine449bd832023-01-11 14:50:10 +01009776 for (const char **alpn = ssl->conf->alpn_list; *alpn != NULL; alpn++) {
9777 size_t const alpn_len = strlen(*alpn);
XiaokangQian95d5f542022-06-24 02:29:26 +00009778 p = protocol_name_list;
Gilles Peskine449bd832023-01-11 14:50:10 +01009779 while (p < protocol_name_list_end) {
XiaokangQian95d5f542022-06-24 02:29:26 +00009780 protocol_name_len = *p++;
Gilles Peskine449bd832023-01-11 14:50:10 +01009781 if (protocol_name_len == alpn_len &&
9782 memcmp(p, *alpn, alpn_len) == 0) {
XiaokangQianacb39922022-06-17 10:18:48 +00009783 ssl->alpn_chosen = *alpn;
Gilles Peskine449bd832023-01-11 14:50:10 +01009784 return 0;
XiaokangQianacb39922022-06-17 10:18:48 +00009785 }
XiaokangQian95d5f542022-06-24 02:29:26 +00009786
9787 p += protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00009788 }
9789 }
9790
XiaokangQian95d5f542022-06-24 02:29:26 +00009791 /* If we get here, no match was found */
XiaokangQianacb39922022-06-17 10:18:48 +00009792 MBEDTLS_SSL_PEND_FATAL_ALERT(
Gilles Peskine449bd832023-01-11 14:50:10 +01009793 MBEDTLS_SSL_ALERT_MSG_NO_APPLICATION_PROTOCOL,
9794 MBEDTLS_ERR_SSL_NO_APPLICATION_PROTOCOL);
9795 return MBEDTLS_ERR_SSL_NO_APPLICATION_PROTOCOL;
XiaokangQianacb39922022-06-17 10:18:48 +00009796}
9797
Gilles Peskine449bd832023-01-11 14:50:10 +01009798int mbedtls_ssl_write_alpn_ext(mbedtls_ssl_context *ssl,
9799 unsigned char *buf,
9800 unsigned char *end,
9801 size_t *out_len)
XiaokangQianacb39922022-06-17 10:18:48 +00009802{
9803 unsigned char *p = buf;
XiaokangQian95d5f542022-06-24 02:29:26 +00009804 size_t protocol_name_len;
XiaokangQianc7403452022-06-23 03:24:12 +00009805 *out_len = 0;
XiaokangQianacb39922022-06-17 10:18:48 +00009806
Gilles Peskine449bd832023-01-11 14:50:10 +01009807 if (ssl->alpn_chosen == NULL) {
9808 return 0;
XiaokangQianacb39922022-06-17 10:18:48 +00009809 }
9810
Gilles Peskine449bd832023-01-11 14:50:10 +01009811 protocol_name_len = strlen(ssl->alpn_chosen);
9812 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 7 + protocol_name_len);
XiaokangQianacb39922022-06-17 10:18:48 +00009813
Gilles Peskine449bd832023-01-11 14:50:10 +01009814 MBEDTLS_SSL_DEBUG_MSG(3, ("server side, adding alpn extension"));
XiaokangQianacb39922022-06-17 10:18:48 +00009815 /*
9816 * 0 . 1 ext identifier
9817 * 2 . 3 ext length
9818 * 4 . 5 protocol list length
9819 * 6 . 6 protocol name length
9820 * 7 . 7+n protocol name
9821 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009822 MBEDTLS_PUT_UINT16_BE(MBEDTLS_TLS_EXT_ALPN, p, 0);
XiaokangQianacb39922022-06-17 10:18:48 +00009823
XiaokangQian95d5f542022-06-24 02:29:26 +00009824 *out_len = 7 + protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00009825
Gilles Peskine449bd832023-01-11 14:50:10 +01009826 MBEDTLS_PUT_UINT16_BE(protocol_name_len + 3, p, 2);
9827 MBEDTLS_PUT_UINT16_BE(protocol_name_len + 1, p, 4);
XiaokangQian0b776e22022-06-24 09:04:59 +00009828 /* Note: the length of the chosen protocol has been checked to be less
9829 * than 255 bytes in `mbedtls_ssl_conf_alpn_protocols`.
9830 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009831 p[6] = MBEDTLS_BYTE_0(protocol_name_len);
XiaokangQianacb39922022-06-17 10:18:48 +00009832
Gilles Peskine449bd832023-01-11 14:50:10 +01009833 memcpy(p + 7, ssl->alpn_chosen, protocol_name_len);
Jerry Yub95dd362022-11-08 21:19:34 +08009834
9835#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01009836 mbedtls_ssl_tls13_set_hs_sent_ext_mask(ssl, MBEDTLS_TLS_EXT_ALPN);
Jerry Yub95dd362022-11-08 21:19:34 +08009837#endif
9838
Gilles Peskine449bd832023-01-11 14:50:10 +01009839 return 0;
XiaokangQianacb39922022-06-17 10:18:48 +00009840}
9841#endif /* MBEDTLS_SSL_ALPN */
9842
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009843#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && \
Xiaokang Qian03409292022-10-12 02:49:52 +00009844 defined(MBEDTLS_SSL_SESSION_TICKETS) && \
Xiaokang Qianed0620c2022-10-12 06:58:13 +00009845 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION) && \
Xiaokang Qianed3afcd2022-10-12 08:31:11 +00009846 defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01009847int mbedtls_ssl_session_set_hostname(mbedtls_ssl_session *session,
9848 const char *hostname)
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009849{
9850 /* Initialize to suppress unnecessary compiler warning */
9851 size_t hostname_len = 0;
9852
9853 /* Check if new hostname is valid before
9854 * making any change to current one */
Gilles Peskine449bd832023-01-11 14:50:10 +01009855 if (hostname != NULL) {
9856 hostname_len = strlen(hostname);
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009857
Gilles Peskine449bd832023-01-11 14:50:10 +01009858 if (hostname_len > MBEDTLS_SSL_MAX_HOST_NAME_LEN) {
9859 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9860 }
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009861 }
9862
9863 /* Now it's clear that we will overwrite the old hostname,
9864 * so we can free it safely */
Gilles Peskine449bd832023-01-11 14:50:10 +01009865 if (session->hostname != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01009866 mbedtls_zeroize_and_free(session->hostname,
Gilles Peskine449bd832023-01-11 14:50:10 +01009867 strlen(session->hostname));
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009868 }
9869
9870 /* Passing NULL as hostname shall clear the old one */
Gilles Peskine449bd832023-01-11 14:50:10 +01009871 if (hostname == NULL) {
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009872 session->hostname = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01009873 } else {
9874 session->hostname = mbedtls_calloc(1, hostname_len + 1);
9875 if (session->hostname == NULL) {
9876 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
9877 }
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009878
Gilles Peskine449bd832023-01-11 14:50:10 +01009879 memcpy(session->hostname, hostname, hostname_len);
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009880 }
9881
Gilles Peskine449bd832023-01-11 14:50:10 +01009882 return 0;
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009883}
Xiaokang Qian03409292022-10-12 02:49:52 +00009884#endif /* MBEDTLS_SSL_PROTO_TLS1_3 &&
9885 MBEDTLS_SSL_SESSION_TICKETS &&
Xiaokang Qianed0620c2022-10-12 06:58:13 +00009886 MBEDTLS_SSL_SERVER_NAME_INDICATION &&
Xiaokang Qianed3afcd2022-10-12 08:31:11 +00009887 MBEDTLS_SSL_CLI_C */
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009888
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00009889#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_EARLY_DATA) && \
9890 defined(MBEDTLS_SSL_ALPN)
Waleed Elmelegy7dfba342024-03-12 16:22:39 +00009891int mbedtls_ssl_session_set_ticket_alpn(mbedtls_ssl_session *session,
9892 const char *alpn)
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00009893{
9894 size_t alpn_len = 0;
9895
9896 if (alpn != NULL) {
9897 alpn_len = strlen(alpn);
9898
9899 if (alpn_len > MBEDTLS_SSL_MAX_ALPN_NAME_LEN) {
9900 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9901 }
9902 }
9903
9904 if (session->ticket_alpn != NULL) {
9905 mbedtls_zeroize_and_free(session->ticket_alpn,
9906 strlen(session->ticket_alpn));
Waleed Elmelegy7dfba342024-03-12 16:22:39 +00009907 session->ticket_alpn = NULL;
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00009908 }
9909
Waleed Elmelegy7dfba342024-03-12 16:22:39 +00009910 if (alpn != NULL) {
9911 session->ticket_alpn = mbedtls_calloc(alpn_len + 1, 1);
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00009912 if (session->ticket_alpn == NULL) {
9913 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
9914 }
Waleed Elmelegy7dfba342024-03-12 16:22:39 +00009915 memcpy(session->ticket_alpn, alpn, alpn_len);
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00009916 }
9917
9918 return 0;
9919}
9920#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_EARLY_DATA && MBEDTLS_SSL_ALPN */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02009921#endif /* MBEDTLS_SSL_TLS_C */