blob: 3ee2538b65e6392213ccfa29842196ffdc5c08bf [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
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200241#if defined(MBEDTLS_X509_CRT_PARSE_C)
Hanno Becker6d1986e2019-02-07 12:27:42 +0000242
243#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +0100244 if (src->peer_cert != NULL) {
Janos Follath865b3eb2019-12-16 11:46:15 +0000245 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker2292d1f2013-09-15 17:06:49 +0200246
Gilles Peskine449bd832023-01-11 14:50:10 +0100247 dst->peer_cert = mbedtls_calloc(1, sizeof(mbedtls_x509_crt));
248 if (dst->peer_cert == NULL) {
249 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
250 }
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200251
Gilles Peskine449bd832023-01-11 14:50:10 +0100252 mbedtls_x509_crt_init(dst->peer_cert);
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200253
Gilles Peskine449bd832023-01-11 14:50:10 +0100254 if ((ret = mbedtls_x509_crt_parse_der(dst->peer_cert, src->peer_cert->raw.p,
255 src->peer_cert->raw.len)) != 0) {
256 mbedtls_free(dst->peer_cert);
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200257 dst->peer_cert = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +0100258 return ret;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200259 }
260 }
Hanno Becker6d1986e2019-02-07 12:27:42 +0000261#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Gilles Peskine449bd832023-01-11 14:50:10 +0100262 if (src->peer_cert_digest != NULL) {
Hanno Becker9198ad12019-02-05 17:00:50 +0000263 dst->peer_cert_digest =
Gilles Peskine449bd832023-01-11 14:50:10 +0100264 mbedtls_calloc(1, src->peer_cert_digest_len);
265 if (dst->peer_cert_digest == NULL) {
266 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
267 }
Hanno Becker9198ad12019-02-05 17:00:50 +0000268
Gilles Peskine449bd832023-01-11 14:50:10 +0100269 memcpy(dst->peer_cert_digest, src->peer_cert_digest,
270 src->peer_cert_digest_len);
Hanno Becker9198ad12019-02-05 17:00:50 +0000271 dst->peer_cert_digest_type = src->peer_cert_digest_type;
Hanno Beckeraccc5992019-02-25 10:06:59 +0000272 dst->peer_cert_digest_len = src->peer_cert_digest_len;
Hanno Becker9198ad12019-02-05 17:00:50 +0000273 }
274#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
275
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200276#endif /* MBEDTLS_X509_CRT_PARSE_C */
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200277
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +0200278#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +0100279 if (src->ticket != NULL) {
280 dst->ticket = mbedtls_calloc(1, src->ticket_len);
281 if (dst->ticket == NULL) {
282 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
283 }
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200284
Gilles Peskine449bd832023-01-11 14:50:10 +0100285 memcpy(dst->ticket, src->ticket, src->ticket_len);
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200286 }
Xiaokang Qian126bf8e2022-10-13 02:22:40 +0000287
288#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && \
289 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +0100290 if (src->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Xiaokang Qian126bf8e2022-10-13 02:22:40 +0000291 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine449bd832023-01-11 14:50:10 +0100292 ret = mbedtls_ssl_session_set_hostname(dst, src->hostname);
293 if (ret != 0) {
294 return ret;
295 }
Xiaokang Qian126bf8e2022-10-13 02:22:40 +0000296 }
297#endif /* MBEDTLS_SSL_PROTO_TLS1_3 &&
298 MBEDTLS_SSL_SERVER_NAME_INDICATION */
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +0200299#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200300
Gilles Peskine449bd832023-01-11 14:50:10 +0100301 return 0;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200302}
303
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500304#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200305MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100306static int resize_buffer(unsigned char **buffer, size_t len_new, size_t *len_old)
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500307{
Gilles Peskine449bd832023-01-11 14:50:10 +0100308 unsigned char *resized_buffer = mbedtls_calloc(1, len_new);
309 if (resized_buffer == NULL) {
Yanray Wang365ee3e2023-11-22 10:28:28 +0800310 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
Gilles Peskine449bd832023-01-11 14:50:10 +0100311 }
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500312
313 /* We want to copy len_new bytes when downsizing the buffer, and
314 * len_old bytes when upsizing, so we choose the smaller of two sizes,
315 * to fit one buffer into another. Size checks, ensuring that no data is
316 * lost, are done outside of this function. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100317 memcpy(resized_buffer, *buffer,
318 (len_new < *len_old) ? len_new : *len_old);
Tom Cosgroveca8c61b2023-07-17 15:17:40 +0100319 mbedtls_zeroize_and_free(*buffer, *len_old);
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500320
321 *buffer = resized_buffer;
322 *len_old = len_new;
323
324 return 0;
325}
Andrzej Kurek4a063792020-10-21 15:08:44 +0200326
Gilles Peskine449bd832023-01-11 14:50:10 +0100327static void handle_buffer_resizing(mbedtls_ssl_context *ssl, int downsizing,
328 size_t in_buf_new_len,
329 size_t out_buf_new_len)
Andrzej Kurek4a063792020-10-21 15:08:44 +0200330{
331 int modified = 0;
332 size_t written_in = 0, iv_offset_in = 0, len_offset_in = 0;
333 size_t written_out = 0, iv_offset_out = 0, len_offset_out = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +0100334 if (ssl->in_buf != NULL) {
Andrzej Kurek4a063792020-10-21 15:08:44 +0200335 written_in = ssl->in_msg - ssl->in_buf;
336 iv_offset_in = ssl->in_iv - ssl->in_buf;
337 len_offset_in = ssl->in_len - ssl->in_buf;
Gilles Peskine449bd832023-01-11 14:50:10 +0100338 if (downsizing ?
Andrzej Kurek4a063792020-10-21 15:08:44 +0200339 ssl->in_buf_len > in_buf_new_len && ssl->in_left < in_buf_new_len :
Gilles Peskine449bd832023-01-11 14:50:10 +0100340 ssl->in_buf_len < in_buf_new_len) {
341 if (resize_buffer(&ssl->in_buf, in_buf_new_len, &ssl->in_buf_len) != 0) {
342 MBEDTLS_SSL_DEBUG_MSG(1, ("input buffer resizing failed - out of memory"));
343 } else {
344 MBEDTLS_SSL_DEBUG_MSG(2, ("Reallocating in_buf to %" MBEDTLS_PRINTF_SIZET,
345 in_buf_new_len));
Andrzej Kurek4a063792020-10-21 15:08:44 +0200346 modified = 1;
347 }
348 }
349 }
350
Gilles Peskine449bd832023-01-11 14:50:10 +0100351 if (ssl->out_buf != NULL) {
Andrzej Kurek4a063792020-10-21 15:08:44 +0200352 written_out = ssl->out_msg - ssl->out_buf;
353 iv_offset_out = ssl->out_iv - ssl->out_buf;
354 len_offset_out = ssl->out_len - ssl->out_buf;
Gilles Peskine449bd832023-01-11 14:50:10 +0100355 if (downsizing ?
Andrzej Kurek4a063792020-10-21 15:08:44 +0200356 ssl->out_buf_len > out_buf_new_len && ssl->out_left < out_buf_new_len :
Gilles Peskine449bd832023-01-11 14:50:10 +0100357 ssl->out_buf_len < out_buf_new_len) {
358 if (resize_buffer(&ssl->out_buf, out_buf_new_len, &ssl->out_buf_len) != 0) {
359 MBEDTLS_SSL_DEBUG_MSG(1, ("output buffer resizing failed - out of memory"));
360 } else {
361 MBEDTLS_SSL_DEBUG_MSG(2, ("Reallocating out_buf to %" MBEDTLS_PRINTF_SIZET,
362 out_buf_new_len));
Andrzej Kurek4a063792020-10-21 15:08:44 +0200363 modified = 1;
364 }
365 }
366 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100367 if (modified) {
Andrzej Kurek4a063792020-10-21 15:08:44 +0200368 /* Update pointers here to avoid doing it twice. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100369 mbedtls_ssl_reset_in_out_pointers(ssl);
Andrzej Kurek4a063792020-10-21 15:08:44 +0200370 /* Fields below might not be properly updated with record
371 * splitting or with CID, so they are manually updated here. */
372 ssl->out_msg = ssl->out_buf + written_out;
373 ssl->out_len = ssl->out_buf + len_offset_out;
374 ssl->out_iv = ssl->out_buf + iv_offset_out;
375
376 ssl->in_msg = ssl->in_buf + written_in;
377 ssl->in_len = ssl->in_buf + len_offset_in;
378 ssl->in_iv = ssl->in_buf + iv_offset_in;
379 }
380}
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500381#endif /* MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH */
382
Jerry Yudb8c48a2022-01-27 14:54:54 +0800383#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Jerry Yued14c932022-02-17 13:40:45 +0800384
385#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
Gilles Peskine449bd832023-01-11 14:50:10 +0100386typedef int (*tls_prf_fn)(const unsigned char *secret, size_t slen,
387 const char *label,
388 const unsigned char *random, size_t rlen,
389 unsigned char *dstbuf, size_t dlen);
Jerry Yued14c932022-02-17 13:40:45 +0800390
Gilles Peskine449bd832023-01-11 14:50:10 +0100391static tls_prf_fn ssl_tls12prf_from_cs(int ciphersuite_id);
Jerry Yued14c932022-02-17 13:40:45 +0800392
393#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
394
395/* Type for the TLS PRF */
396typedef int ssl_tls_prf_t(const unsigned char *, size_t, const char *,
397 const unsigned char *, size_t,
398 unsigned char *, size_t);
399
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200400MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100401static int ssl_tls12_populate_transform(mbedtls_ssl_transform *transform,
402 int ciphersuite,
403 const unsigned char master[48],
Neil Armstrongf2c82f02022-04-05 11:16:53 +0200404#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +0100405 int encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +0200406#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +0100407 ssl_tls_prf_t tls_prf,
408 const unsigned char randbytes[64],
409 mbedtls_ssl_protocol_version tls_version,
410 unsigned endpoint,
411 const mbedtls_ssl_context *ssl);
Jerry Yued14c932022-02-17 13:40:45 +0800412
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100413#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200414MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100415static int tls_prf_sha256(const unsigned char *secret, size_t slen,
Ron Eldor51d3ab52019-05-12 14:54:30 +0300416 const char *label,
417 const unsigned char *random, size_t rlen,
Gilles Peskine449bd832023-01-11 14:50:10 +0100418 unsigned char *dstbuf, size_t dlen);
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100419static int ssl_calc_verify_tls_sha256(const mbedtls_ssl_context *, unsigned char *, size_t *);
420static int ssl_calc_finished_tls_sha256(mbedtls_ssl_context *, unsigned char *, int);
Gilles Peskine449bd832023-01-11 14:50:10 +0100421
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100422#endif /* MBEDTLS_MD_CAN_SHA256*/
Gilles Peskine449bd832023-01-11 14:50:10 +0100423
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100424#if defined(MBEDTLS_MD_CAN_SHA384)
Gilles Peskine449bd832023-01-11 14:50:10 +0100425MBEDTLS_CHECK_RETURN_CRITICAL
426static int tls_prf_sha384(const unsigned char *secret, size_t slen,
427 const char *label,
428 const unsigned char *random, size_t rlen,
429 unsigned char *dstbuf, size_t dlen);
430
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100431static int ssl_calc_verify_tls_sha384(const mbedtls_ssl_context *, unsigned char *, size_t *);
432static int ssl_calc_finished_tls_sha384(mbedtls_ssl_context *, unsigned char *, int);
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100433#endif /* MBEDTLS_MD_CAN_SHA384*/
Gilles Peskine449bd832023-01-11 14:50:10 +0100434
Gilles Peskine449bd832023-01-11 14:50:10 +0100435MBEDTLS_CHECK_RETURN_CRITICAL
436static int ssl_tls12_session_load(mbedtls_ssl_session *session,
437 const unsigned char *buf,
438 size_t len);
439#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
440
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100441static int ssl_update_checksum_start(mbedtls_ssl_context *, const unsigned char *, size_t);
Gilles Peskine449bd832023-01-11 14:50:10 +0100442
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100443#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100444static int ssl_update_checksum_sha256(mbedtls_ssl_context *, const unsigned char *, size_t);
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100445#endif /* MBEDTLS_MD_CAN_SHA256*/
Gilles Peskine449bd832023-01-11 14:50:10 +0100446
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100447#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100448static int ssl_update_checksum_sha384(mbedtls_ssl_context *, const unsigned char *, size_t);
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100449#endif /* MBEDTLS_MD_CAN_SHA384*/
Gilles Peskine449bd832023-01-11 14:50:10 +0100450
451int mbedtls_ssl_tls_prf(const mbedtls_tls_prf_types prf,
452 const unsigned char *secret, size_t slen,
453 const char *label,
454 const unsigned char *random, size_t rlen,
455 unsigned char *dstbuf, size_t dlen)
Ron Eldor51d3ab52019-05-12 14:54:30 +0300456{
457 mbedtls_ssl_tls_prf_cb *tls_prf = NULL;
458
Gilles Peskine449bd832023-01-11 14:50:10 +0100459 switch (prf) {
Ron Eldord2f25f72019-05-15 14:54:22 +0300460#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100461#if defined(MBEDTLS_MD_CAN_SHA384)
Ron Eldor51d3ab52019-05-12 14:54:30 +0300462 case MBEDTLS_SSL_TLS_PRF_SHA384:
463 tls_prf = tls_prf_sha384;
Gilles Peskine449bd832023-01-11 14:50:10 +0100464 break;
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100465#endif /* MBEDTLS_MD_CAN_SHA384*/
466#if defined(MBEDTLS_MD_CAN_SHA256)
Ron Eldor51d3ab52019-05-12 14:54:30 +0300467 case MBEDTLS_SSL_TLS_PRF_SHA256:
468 tls_prf = tls_prf_sha256;
Gilles Peskine449bd832023-01-11 14:50:10 +0100469 break;
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100470#endif /* MBEDTLS_MD_CAN_SHA256*/
Ron Eldord2f25f72019-05-15 14:54:22 +0300471#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100472 default:
473 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Ron Eldor51d3ab52019-05-12 14:54:30 +0300474 }
475
Gilles Peskine449bd832023-01-11 14:50:10 +0100476 return tls_prf(secret, slen, label, random, rlen, dstbuf, dlen);
Ron Eldor51d3ab52019-05-12 14:54:30 +0300477}
478
Jerry Yuc73c6182022-02-08 20:29:25 +0800479#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +0100480static void ssl_clear_peer_cert(mbedtls_ssl_session *session)
Jerry Yuc73c6182022-02-08 20:29:25 +0800481{
482#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +0100483 if (session->peer_cert != NULL) {
484 mbedtls_x509_crt_free(session->peer_cert);
485 mbedtls_free(session->peer_cert);
Jerry Yuc73c6182022-02-08 20:29:25 +0800486 session->peer_cert = NULL;
487 }
488#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Gilles Peskine449bd832023-01-11 14:50:10 +0100489 if (session->peer_cert_digest != NULL) {
Jerry Yuc73c6182022-02-08 20:29:25 +0800490 /* Zeroization is not necessary. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100491 mbedtls_free(session->peer_cert_digest);
Jerry Yuc73c6182022-02-08 20:29:25 +0800492 session->peer_cert_digest = NULL;
493 session->peer_cert_digest_type = MBEDTLS_MD_NONE;
494 session->peer_cert_digest_len = 0;
495 }
496#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
497}
498#endif /* MBEDTLS_X509_CRT_PARSE_C */
499
Gilles Peskine449bd832023-01-11 14:50:10 +0100500uint32_t mbedtls_ssl_get_extension_id(unsigned int extension_type)
Jerry Yu7a485c12022-10-31 13:08:18 +0800501{
Gilles Peskine449bd832023-01-11 14:50:10 +0100502 switch (extension_type) {
Jerry Yu7a485c12022-10-31 13:08:18 +0800503 case MBEDTLS_TLS_EXT_SERVERNAME:
Gilles Peskine449bd832023-01-11 14:50:10 +0100504 return MBEDTLS_SSL_EXT_ID_SERVERNAME;
Jerry Yu7a485c12022-10-31 13:08:18 +0800505
506 case MBEDTLS_TLS_EXT_MAX_FRAGMENT_LENGTH:
Gilles Peskine449bd832023-01-11 14:50:10 +0100507 return MBEDTLS_SSL_EXT_ID_MAX_FRAGMENT_LENGTH;
Jerry Yu7a485c12022-10-31 13:08:18 +0800508
509 case MBEDTLS_TLS_EXT_STATUS_REQUEST:
Gilles Peskine449bd832023-01-11 14:50:10 +0100510 return MBEDTLS_SSL_EXT_ID_STATUS_REQUEST;
Jerry Yu7a485c12022-10-31 13:08:18 +0800511
512 case MBEDTLS_TLS_EXT_SUPPORTED_GROUPS:
Gilles Peskine449bd832023-01-11 14:50:10 +0100513 return MBEDTLS_SSL_EXT_ID_SUPPORTED_GROUPS;
Jerry Yu7a485c12022-10-31 13:08:18 +0800514
515 case MBEDTLS_TLS_EXT_SIG_ALG:
Gilles Peskine449bd832023-01-11 14:50:10 +0100516 return MBEDTLS_SSL_EXT_ID_SIG_ALG;
Jerry Yu7a485c12022-10-31 13:08:18 +0800517
518 case MBEDTLS_TLS_EXT_USE_SRTP:
Gilles Peskine449bd832023-01-11 14:50:10 +0100519 return MBEDTLS_SSL_EXT_ID_USE_SRTP;
Jerry Yu7a485c12022-10-31 13:08:18 +0800520
521 case MBEDTLS_TLS_EXT_HEARTBEAT:
Gilles Peskine449bd832023-01-11 14:50:10 +0100522 return MBEDTLS_SSL_EXT_ID_HEARTBEAT;
Jerry Yu7a485c12022-10-31 13:08:18 +0800523
524 case MBEDTLS_TLS_EXT_ALPN:
Gilles Peskine449bd832023-01-11 14:50:10 +0100525 return MBEDTLS_SSL_EXT_ID_ALPN;
Jerry Yu7a485c12022-10-31 13:08:18 +0800526
527 case MBEDTLS_TLS_EXT_SCT:
Gilles Peskine449bd832023-01-11 14:50:10 +0100528 return MBEDTLS_SSL_EXT_ID_SCT;
Jerry Yu7a485c12022-10-31 13:08:18 +0800529
530 case MBEDTLS_TLS_EXT_CLI_CERT_TYPE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100531 return MBEDTLS_SSL_EXT_ID_CLI_CERT_TYPE;
Jerry Yu7a485c12022-10-31 13:08:18 +0800532
533 case MBEDTLS_TLS_EXT_SERV_CERT_TYPE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100534 return MBEDTLS_SSL_EXT_ID_SERV_CERT_TYPE;
Jerry Yu7a485c12022-10-31 13:08:18 +0800535
536 case MBEDTLS_TLS_EXT_PADDING:
Gilles Peskine449bd832023-01-11 14:50:10 +0100537 return MBEDTLS_SSL_EXT_ID_PADDING;
Jerry Yu7a485c12022-10-31 13:08:18 +0800538
539 case MBEDTLS_TLS_EXT_PRE_SHARED_KEY:
Gilles Peskine449bd832023-01-11 14:50:10 +0100540 return MBEDTLS_SSL_EXT_ID_PRE_SHARED_KEY;
Jerry Yu7a485c12022-10-31 13:08:18 +0800541
542 case MBEDTLS_TLS_EXT_EARLY_DATA:
Gilles Peskine449bd832023-01-11 14:50:10 +0100543 return MBEDTLS_SSL_EXT_ID_EARLY_DATA;
Jerry Yu7a485c12022-10-31 13:08:18 +0800544
545 case MBEDTLS_TLS_EXT_SUPPORTED_VERSIONS:
Gilles Peskine449bd832023-01-11 14:50:10 +0100546 return MBEDTLS_SSL_EXT_ID_SUPPORTED_VERSIONS;
Jerry Yu7a485c12022-10-31 13:08:18 +0800547
548 case MBEDTLS_TLS_EXT_COOKIE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100549 return MBEDTLS_SSL_EXT_ID_COOKIE;
Jerry Yu7a485c12022-10-31 13:08:18 +0800550
551 case MBEDTLS_TLS_EXT_PSK_KEY_EXCHANGE_MODES:
Gilles Peskine449bd832023-01-11 14:50:10 +0100552 return MBEDTLS_SSL_EXT_ID_PSK_KEY_EXCHANGE_MODES;
Jerry Yu7a485c12022-10-31 13:08:18 +0800553
554 case MBEDTLS_TLS_EXT_CERT_AUTH:
Gilles Peskine449bd832023-01-11 14:50:10 +0100555 return MBEDTLS_SSL_EXT_ID_CERT_AUTH;
Jerry Yu7a485c12022-10-31 13:08:18 +0800556
557 case MBEDTLS_TLS_EXT_OID_FILTERS:
Gilles Peskine449bd832023-01-11 14:50:10 +0100558 return MBEDTLS_SSL_EXT_ID_OID_FILTERS;
Jerry Yu7a485c12022-10-31 13:08:18 +0800559
560 case MBEDTLS_TLS_EXT_POST_HANDSHAKE_AUTH:
Gilles Peskine449bd832023-01-11 14:50:10 +0100561 return MBEDTLS_SSL_EXT_ID_POST_HANDSHAKE_AUTH;
Jerry Yu7a485c12022-10-31 13:08:18 +0800562
563 case MBEDTLS_TLS_EXT_SIG_ALG_CERT:
Gilles Peskine449bd832023-01-11 14:50:10 +0100564 return MBEDTLS_SSL_EXT_ID_SIG_ALG_CERT;
Jerry Yu7a485c12022-10-31 13:08:18 +0800565
566 case MBEDTLS_TLS_EXT_KEY_SHARE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100567 return MBEDTLS_SSL_EXT_ID_KEY_SHARE;
Jerry Yu7a485c12022-10-31 13:08:18 +0800568
569 case MBEDTLS_TLS_EXT_TRUNCATED_HMAC:
Gilles Peskine449bd832023-01-11 14:50:10 +0100570 return MBEDTLS_SSL_EXT_ID_TRUNCATED_HMAC;
Jerry Yu7a485c12022-10-31 13:08:18 +0800571
572 case MBEDTLS_TLS_EXT_SUPPORTED_POINT_FORMATS:
Gilles Peskine449bd832023-01-11 14:50:10 +0100573 return MBEDTLS_SSL_EXT_ID_SUPPORTED_POINT_FORMATS;
Jerry Yu7a485c12022-10-31 13:08:18 +0800574
575 case MBEDTLS_TLS_EXT_ENCRYPT_THEN_MAC:
Gilles Peskine449bd832023-01-11 14:50:10 +0100576 return MBEDTLS_SSL_EXT_ID_ENCRYPT_THEN_MAC;
Jerry Yu7a485c12022-10-31 13:08:18 +0800577
578 case MBEDTLS_TLS_EXT_EXTENDED_MASTER_SECRET:
Gilles Peskine449bd832023-01-11 14:50:10 +0100579 return MBEDTLS_SSL_EXT_ID_EXTENDED_MASTER_SECRET;
Jerry Yu7a485c12022-10-31 13:08:18 +0800580
Jan Bruckner151f6422023-02-10 12:45:19 +0100581 case MBEDTLS_TLS_EXT_RECORD_SIZE_LIMIT:
582 return MBEDTLS_SSL_EXT_ID_RECORD_SIZE_LIMIT;
583
Jerry Yu7a485c12022-10-31 13:08:18 +0800584 case MBEDTLS_TLS_EXT_SESSION_TICKET:
Gilles Peskine449bd832023-01-11 14:50:10 +0100585 return MBEDTLS_SSL_EXT_ID_SESSION_TICKET;
Jerry Yu7a485c12022-10-31 13:08:18 +0800586
587 }
588
Gilles Peskine449bd832023-01-11 14:50:10 +0100589 return MBEDTLS_SSL_EXT_ID_UNRECOGNIZED;
Jerry Yu7a485c12022-10-31 13:08:18 +0800590}
591
Gilles Peskine449bd832023-01-11 14:50:10 +0100592uint32_t mbedtls_ssl_get_extension_mask(unsigned int extension_type)
Jerry Yu7a485c12022-10-31 13:08:18 +0800593{
Gilles Peskine449bd832023-01-11 14:50:10 +0100594 return 1 << mbedtls_ssl_get_extension_id(extension_type);
Jerry Yu7a485c12022-10-31 13:08:18 +0800595}
596
Jerry Yud25cab02022-10-31 12:48:30 +0800597#if defined(MBEDTLS_DEBUG_C)
598static const char *extension_name_table[] = {
Jerry Yuea52ed92022-11-08 21:01:17 +0800599 [MBEDTLS_SSL_EXT_ID_UNRECOGNIZED] = "unrecognized",
Jerry Yud25cab02022-10-31 12:48:30 +0800600 [MBEDTLS_SSL_EXT_ID_SERVERNAME] = "server_name",
601 [MBEDTLS_SSL_EXT_ID_MAX_FRAGMENT_LENGTH] = "max_fragment_length",
602 [MBEDTLS_SSL_EXT_ID_STATUS_REQUEST] = "status_request",
603 [MBEDTLS_SSL_EXT_ID_SUPPORTED_GROUPS] = "supported_groups",
604 [MBEDTLS_SSL_EXT_ID_SIG_ALG] = "signature_algorithms",
605 [MBEDTLS_SSL_EXT_ID_USE_SRTP] = "use_srtp",
606 [MBEDTLS_SSL_EXT_ID_HEARTBEAT] = "heartbeat",
607 [MBEDTLS_SSL_EXT_ID_ALPN] = "application_layer_protocol_negotiation",
608 [MBEDTLS_SSL_EXT_ID_SCT] = "signed_certificate_timestamp",
609 [MBEDTLS_SSL_EXT_ID_CLI_CERT_TYPE] = "client_certificate_type",
610 [MBEDTLS_SSL_EXT_ID_SERV_CERT_TYPE] = "server_certificate_type",
611 [MBEDTLS_SSL_EXT_ID_PADDING] = "padding",
612 [MBEDTLS_SSL_EXT_ID_PRE_SHARED_KEY] = "pre_shared_key",
613 [MBEDTLS_SSL_EXT_ID_EARLY_DATA] = "early_data",
614 [MBEDTLS_SSL_EXT_ID_SUPPORTED_VERSIONS] = "supported_versions",
615 [MBEDTLS_SSL_EXT_ID_COOKIE] = "cookie",
616 [MBEDTLS_SSL_EXT_ID_PSK_KEY_EXCHANGE_MODES] = "psk_key_exchange_modes",
617 [MBEDTLS_SSL_EXT_ID_CERT_AUTH] = "certificate_authorities",
618 [MBEDTLS_SSL_EXT_ID_OID_FILTERS] = "oid_filters",
619 [MBEDTLS_SSL_EXT_ID_POST_HANDSHAKE_AUTH] = "post_handshake_auth",
620 [MBEDTLS_SSL_EXT_ID_SIG_ALG_CERT] = "signature_algorithms_cert",
621 [MBEDTLS_SSL_EXT_ID_KEY_SHARE] = "key_share",
622 [MBEDTLS_SSL_EXT_ID_TRUNCATED_HMAC] = "truncated_hmac",
623 [MBEDTLS_SSL_EXT_ID_SUPPORTED_POINT_FORMATS] = "supported_point_formats",
624 [MBEDTLS_SSL_EXT_ID_ENCRYPT_THEN_MAC] = "encrypt_then_mac",
625 [MBEDTLS_SSL_EXT_ID_EXTENDED_MASTER_SECRET] = "extended_master_secret",
Jan Bruckner151f6422023-02-10 12:45:19 +0100626 [MBEDTLS_SSL_EXT_ID_SESSION_TICKET] = "session_ticket",
627 [MBEDTLS_SSL_EXT_ID_RECORD_SIZE_LIMIT] = "record_size_limit"
Jerry Yud25cab02022-10-31 12:48:30 +0800628};
629
Chien Wong4e9683e2023-12-28 17:07:43 +0800630static const unsigned int extension_type_table[] = {
Jerry Yud25cab02022-10-31 12:48:30 +0800631 [MBEDTLS_SSL_EXT_ID_UNRECOGNIZED] = 0xff,
632 [MBEDTLS_SSL_EXT_ID_SERVERNAME] = MBEDTLS_TLS_EXT_SERVERNAME,
633 [MBEDTLS_SSL_EXT_ID_MAX_FRAGMENT_LENGTH] = MBEDTLS_TLS_EXT_MAX_FRAGMENT_LENGTH,
634 [MBEDTLS_SSL_EXT_ID_STATUS_REQUEST] = MBEDTLS_TLS_EXT_STATUS_REQUEST,
635 [MBEDTLS_SSL_EXT_ID_SUPPORTED_GROUPS] = MBEDTLS_TLS_EXT_SUPPORTED_GROUPS,
636 [MBEDTLS_SSL_EXT_ID_SIG_ALG] = MBEDTLS_TLS_EXT_SIG_ALG,
637 [MBEDTLS_SSL_EXT_ID_USE_SRTP] = MBEDTLS_TLS_EXT_USE_SRTP,
638 [MBEDTLS_SSL_EXT_ID_HEARTBEAT] = MBEDTLS_TLS_EXT_HEARTBEAT,
639 [MBEDTLS_SSL_EXT_ID_ALPN] = MBEDTLS_TLS_EXT_ALPN,
640 [MBEDTLS_SSL_EXT_ID_SCT] = MBEDTLS_TLS_EXT_SCT,
641 [MBEDTLS_SSL_EXT_ID_CLI_CERT_TYPE] = MBEDTLS_TLS_EXT_CLI_CERT_TYPE,
642 [MBEDTLS_SSL_EXT_ID_SERV_CERT_TYPE] = MBEDTLS_TLS_EXT_SERV_CERT_TYPE,
643 [MBEDTLS_SSL_EXT_ID_PADDING] = MBEDTLS_TLS_EXT_PADDING,
644 [MBEDTLS_SSL_EXT_ID_PRE_SHARED_KEY] = MBEDTLS_TLS_EXT_PRE_SHARED_KEY,
645 [MBEDTLS_SSL_EXT_ID_EARLY_DATA] = MBEDTLS_TLS_EXT_EARLY_DATA,
646 [MBEDTLS_SSL_EXT_ID_SUPPORTED_VERSIONS] = MBEDTLS_TLS_EXT_SUPPORTED_VERSIONS,
647 [MBEDTLS_SSL_EXT_ID_COOKIE] = MBEDTLS_TLS_EXT_COOKIE,
648 [MBEDTLS_SSL_EXT_ID_PSK_KEY_EXCHANGE_MODES] = MBEDTLS_TLS_EXT_PSK_KEY_EXCHANGE_MODES,
649 [MBEDTLS_SSL_EXT_ID_CERT_AUTH] = MBEDTLS_TLS_EXT_CERT_AUTH,
650 [MBEDTLS_SSL_EXT_ID_OID_FILTERS] = MBEDTLS_TLS_EXT_OID_FILTERS,
651 [MBEDTLS_SSL_EXT_ID_POST_HANDSHAKE_AUTH] = MBEDTLS_TLS_EXT_POST_HANDSHAKE_AUTH,
652 [MBEDTLS_SSL_EXT_ID_SIG_ALG_CERT] = MBEDTLS_TLS_EXT_SIG_ALG_CERT,
653 [MBEDTLS_SSL_EXT_ID_KEY_SHARE] = MBEDTLS_TLS_EXT_KEY_SHARE,
654 [MBEDTLS_SSL_EXT_ID_TRUNCATED_HMAC] = MBEDTLS_TLS_EXT_TRUNCATED_HMAC,
655 [MBEDTLS_SSL_EXT_ID_SUPPORTED_POINT_FORMATS] = MBEDTLS_TLS_EXT_SUPPORTED_POINT_FORMATS,
656 [MBEDTLS_SSL_EXT_ID_ENCRYPT_THEN_MAC] = MBEDTLS_TLS_EXT_ENCRYPT_THEN_MAC,
657 [MBEDTLS_SSL_EXT_ID_EXTENDED_MASTER_SECRET] = MBEDTLS_TLS_EXT_EXTENDED_MASTER_SECRET,
Jan Bruckner151f6422023-02-10 12:45:19 +0100658 [MBEDTLS_SSL_EXT_ID_SESSION_TICKET] = MBEDTLS_TLS_EXT_SESSION_TICKET,
659 [MBEDTLS_SSL_EXT_ID_RECORD_SIZE_LIMIT] = MBEDTLS_TLS_EXT_RECORD_SIZE_LIMIT
Jerry Yud25cab02022-10-31 12:48:30 +0800660};
661
Gilles Peskine449bd832023-01-11 14:50:10 +0100662const char *mbedtls_ssl_get_extension_name(unsigned int extension_type)
Jerry Yud25cab02022-10-31 12:48:30 +0800663{
Gilles Peskine449bd832023-01-11 14:50:10 +0100664 return extension_name_table[
665 mbedtls_ssl_get_extension_id(extension_type)];
Jerry Yud25cab02022-10-31 12:48:30 +0800666}
667
Gilles Peskine449bd832023-01-11 14:50:10 +0100668static const char *ssl_tls13_get_hs_msg_name(int hs_msg_type)
Jerry Yud25cab02022-10-31 12:48:30 +0800669{
Gilles Peskine449bd832023-01-11 14:50:10 +0100670 switch (hs_msg_type) {
Jerry Yud25cab02022-10-31 12:48:30 +0800671 case MBEDTLS_SSL_HS_CLIENT_HELLO:
Gilles Peskine449bd832023-01-11 14:50:10 +0100672 return "ClientHello";
Jerry Yud25cab02022-10-31 12:48:30 +0800673 case MBEDTLS_SSL_HS_SERVER_HELLO:
Gilles Peskine449bd832023-01-11 14:50:10 +0100674 return "ServerHello";
Jerry Yud25cab02022-10-31 12:48:30 +0800675 case MBEDTLS_SSL_TLS1_3_HS_HELLO_RETRY_REQUEST:
Gilles Peskine449bd832023-01-11 14:50:10 +0100676 return "HelloRetryRequest";
Jerry Yud25cab02022-10-31 12:48:30 +0800677 case MBEDTLS_SSL_HS_NEW_SESSION_TICKET:
Gilles Peskine449bd832023-01-11 14:50:10 +0100678 return "NewSessionTicket";
Jerry Yud25cab02022-10-31 12:48:30 +0800679 case MBEDTLS_SSL_HS_ENCRYPTED_EXTENSIONS:
Gilles Peskine449bd832023-01-11 14:50:10 +0100680 return "EncryptedExtensions";
Jerry Yud25cab02022-10-31 12:48:30 +0800681 case MBEDTLS_SSL_HS_CERTIFICATE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100682 return "Certificate";
Jerry Yud25cab02022-10-31 12:48:30 +0800683 case MBEDTLS_SSL_HS_CERTIFICATE_REQUEST:
Gilles Peskine449bd832023-01-11 14:50:10 +0100684 return "CertificateRequest";
Jerry Yud25cab02022-10-31 12:48:30 +0800685 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100686 return "Unknown";
Jerry Yud25cab02022-10-31 12:48:30 +0800687}
688
Gilles Peskine449bd832023-01-11 14:50:10 +0100689void mbedtls_ssl_print_extension(const mbedtls_ssl_context *ssl,
690 int level, const char *file, int line,
691 int hs_msg_type, unsigned int extension_type,
692 const char *extra_msg0, const char *extra_msg1)
Jerry Yud25cab02022-10-31 12:48:30 +0800693{
694 const char *extra_msg;
Gilles Peskine449bd832023-01-11 14:50:10 +0100695 if (extra_msg0 && extra_msg1) {
Jerry Yud25cab02022-10-31 12:48:30 +0800696 mbedtls_debug_print_msg(
697 ssl, level, file, line,
698 "%s: %s(%u) extension %s %s.",
Gilles Peskine449bd832023-01-11 14:50:10 +0100699 ssl_tls13_get_hs_msg_name(hs_msg_type),
700 mbedtls_ssl_get_extension_name(extension_type),
Jerry Yud25cab02022-10-31 12:48:30 +0800701 extension_type,
Gilles Peskine449bd832023-01-11 14:50:10 +0100702 extra_msg0, extra_msg1);
Jerry Yud25cab02022-10-31 12:48:30 +0800703 return;
704 }
705
706 extra_msg = extra_msg0 ? extra_msg0 : extra_msg1;
Gilles Peskine449bd832023-01-11 14:50:10 +0100707 if (extra_msg) {
Jerry Yud25cab02022-10-31 12:48:30 +0800708 mbedtls_debug_print_msg(
709 ssl, level, file, line,
Gilles Peskine449bd832023-01-11 14:50:10 +0100710 "%s: %s(%u) extension %s.", ssl_tls13_get_hs_msg_name(hs_msg_type),
711 mbedtls_ssl_get_extension_name(extension_type), extension_type,
712 extra_msg);
Jerry Yud25cab02022-10-31 12:48:30 +0800713 return;
714 }
715
716 mbedtls_debug_print_msg(
717 ssl, level, file, line,
Gilles Peskine449bd832023-01-11 14:50:10 +0100718 "%s: %s(%u) extension.", ssl_tls13_get_hs_msg_name(hs_msg_type),
719 mbedtls_ssl_get_extension_name(extension_type), extension_type);
Jerry Yud25cab02022-10-31 12:48:30 +0800720}
721
Gilles Peskine449bd832023-01-11 14:50:10 +0100722void mbedtls_ssl_print_extensions(const mbedtls_ssl_context *ssl,
723 int level, const char *file, int line,
724 int hs_msg_type, uint32_t extensions_mask,
725 const char *extra)
Jerry Yud25cab02022-10-31 12:48:30 +0800726{
727
Gilles Peskine449bd832023-01-11 14:50:10 +0100728 for (unsigned i = 0;
729 i < sizeof(extension_name_table) / sizeof(extension_name_table[0]);
730 i++) {
Jerry Yu79aa7212022-11-08 21:30:21 +0800731 mbedtls_ssl_print_extension(
Jerry Yuea52ed92022-11-08 21:01:17 +0800732 ssl, level, file, line, hs_msg_type, extension_type_table[i],
Gilles Peskine449bd832023-01-11 14:50:10 +0100733 extensions_mask & (1 << i) ? "exists" : "does not exist", extra);
Jerry Yud25cab02022-10-31 12:48:30 +0800734 }
735}
736
Pengyu Lvee455c02023-01-12 14:37:24 +0800737#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Pengyu Lvee455c02023-01-12 14:37:24 +0800738static const char *ticket_flag_name_table[] =
739{
740 [0] = "ALLOW_PSK_RESUMPTION",
741 [2] = "ALLOW_PSK_EPHEMERAL_RESUMPTION",
742 [3] = "ALLOW_EARLY_DATA",
743};
744
Pengyu Lv4938a562023-01-16 11:28:49 +0800745void mbedtls_ssl_print_ticket_flags(const mbedtls_ssl_context *ssl,
746 int level, const char *file, int line,
747 unsigned int flags)
Pengyu Lvee455c02023-01-12 14:37:24 +0800748{
749 size_t i;
750
751 mbedtls_debug_print_msg(ssl, level, file, line,
Pengyu Lv4938a562023-01-16 11:28:49 +0800752 "print ticket_flags (0x%02x)", flags);
753
754 flags = flags & MBEDTLS_SSL_TLS1_3_TICKET_FLAGS_MASK;
Pengyu Lvee455c02023-01-12 14:37:24 +0800755
756 for (i = 0; i < ARRAY_LENGTH(ticket_flag_name_table); i++) {
Pengyu Lv4938a562023-01-16 11:28:49 +0800757 if ((flags & (1 << i))) {
Pengyu Lvee455c02023-01-12 14:37:24 +0800758 mbedtls_debug_print_msg(ssl, level, file, line, "- %s is set.",
759 ticket_flag_name_table[i]);
760 }
761 }
762}
763#endif /* MBEDTLS_SSL_PROTO_TLS1_3 && MBEDTLS_SSL_SESSION_TICKETS */
764
Jerry Yud25cab02022-10-31 12:48:30 +0800765#endif /* MBEDTLS_DEBUG_C */
766
Gilles Peskine449bd832023-01-11 14:50:10 +0100767void mbedtls_ssl_optimize_checksum(mbedtls_ssl_context *ssl,
768 const mbedtls_ssl_ciphersuite_t *ciphersuite_info)
Jerry Yuc73c6182022-02-08 20:29:25 +0800769{
770 ((void) ciphersuite_info);
771
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100772#if defined(MBEDTLS_MD_CAN_SHA384)
Gilles Peskine449bd832023-01-11 14:50:10 +0100773 if (ciphersuite_info->mac == MBEDTLS_MD_SHA384) {
Jerry Yuc73c6182022-02-08 20:29:25 +0800774 ssl->handshake->update_checksum = ssl_update_checksum_sha384;
Gilles Peskine449bd832023-01-11 14:50:10 +0100775 } else
Jerry Yuc73c6182022-02-08 20:29:25 +0800776#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100777#if defined(MBEDTLS_MD_CAN_SHA256)
Gilles Peskine449bd832023-01-11 14:50:10 +0100778 if (ciphersuite_info->mac != MBEDTLS_MD_SHA384) {
Jerry Yuc73c6182022-02-08 20:29:25 +0800779 ssl->handshake->update_checksum = ssl_update_checksum_sha256;
Gilles Peskine449bd832023-01-11 14:50:10 +0100780 } else
Jerry Yuc73c6182022-02-08 20:29:25 +0800781#endif
782 {
Gilles Peskine449bd832023-01-11 14:50:10 +0100783 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
Jerry Yuc73c6182022-02-08 20:29:25 +0800784 return;
785 }
786}
787
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100788int mbedtls_ssl_add_hs_hdr_to_checksum(mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100789 unsigned hs_type,
790 size_t total_hs_len)
Ronald Cron8f6d39a2022-03-10 18:56:50 +0100791{
792 unsigned char hs_hdr[4];
793
794 /* Build HS header for checksum update. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100795 hs_hdr[0] = MBEDTLS_BYTE_0(hs_type);
796 hs_hdr[1] = MBEDTLS_BYTE_2(total_hs_len);
797 hs_hdr[2] = MBEDTLS_BYTE_1(total_hs_len);
798 hs_hdr[3] = MBEDTLS_BYTE_0(total_hs_len);
Ronald Cron8f6d39a2022-03-10 18:56:50 +0100799
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100800 return ssl->handshake->update_checksum(ssl, hs_hdr, sizeof(hs_hdr));
Ronald Cron8f6d39a2022-03-10 18:56:50 +0100801}
802
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100803int mbedtls_ssl_add_hs_msg_to_checksum(mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100804 unsigned hs_type,
805 unsigned char const *msg,
806 size_t msg_len)
Ronald Cron8f6d39a2022-03-10 18:56:50 +0100807{
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100808 int ret;
809 ret = mbedtls_ssl_add_hs_hdr_to_checksum(ssl, hs_type, msg_len);
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100810 if (ret != 0) {
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100811 return ret;
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100812 }
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100813 return ssl->handshake->update_checksum(ssl, msg, msg_len);
Ronald Cron8f6d39a2022-03-10 18:56:50 +0100814}
815
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100816int mbedtls_ssl_reset_checksum(mbedtls_ssl_context *ssl)
Jerry Yuc73c6182022-02-08 20:29:25 +0800817{
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100818#if defined(MBEDTLS_MD_CAN_SHA256) || \
819 defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100820#if defined(MBEDTLS_USE_PSA_CRYPTO)
821 psa_status_t status;
822#else
823 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
824#endif
Manuel Pégourié-Gonnard626aaed2023-02-06 22:03:06 +0100825#else /* SHA-256 or SHA-384 */
Jerry Yuc73c6182022-02-08 20:29:25 +0800826 ((void) ssl);
Manuel Pégourié-Gonnard626aaed2023-02-06 22:03:06 +0100827#endif /* SHA-256 or SHA-384 */
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100828#if defined(MBEDTLS_MD_CAN_SHA256)
Jerry Yuc73c6182022-02-08 20:29:25 +0800829#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100830 status = psa_hash_abort(&ssl->handshake->fin_sha256_psa);
831 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200832 return mbedtls_md_error_from_psa(status);
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100833 }
834 status = psa_hash_setup(&ssl->handshake->fin_sha256_psa, PSA_ALG_SHA_256);
835 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200836 return mbedtls_md_error_from_psa(status);
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100837 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800838#else
Manuel Pégourié-Gonnard947cee12023-03-06 11:59:59 +0100839 mbedtls_md_free(&ssl->handshake->fin_sha256);
840 mbedtls_md_init(&ssl->handshake->fin_sha256);
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +0100841 ret = mbedtls_md_setup(&ssl->handshake->fin_sha256,
842 mbedtls_md_info_from_type(MBEDTLS_MD_SHA256),
843 0);
844 if (ret != 0) {
845 return ret;
846 }
847 ret = mbedtls_md_starts(&ssl->handshake->fin_sha256);
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100848 if (ret != 0) {
849 return ret;
850 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800851#endif
852#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100853#if defined(MBEDTLS_MD_CAN_SHA384)
Jerry Yuc73c6182022-02-08 20:29:25 +0800854#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100855 status = psa_hash_abort(&ssl->handshake->fin_sha384_psa);
856 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200857 return mbedtls_md_error_from_psa(status);
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100858 }
859 status = psa_hash_setup(&ssl->handshake->fin_sha384_psa, PSA_ALG_SHA_384);
860 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200861 return mbedtls_md_error_from_psa(status);
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100862 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800863#else
Manuel Pégourié-Gonnard947cee12023-03-06 11:59:59 +0100864 mbedtls_md_free(&ssl->handshake->fin_sha384);
865 mbedtls_md_init(&ssl->handshake->fin_sha384);
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +0100866 ret = mbedtls_md_setup(&ssl->handshake->fin_sha384,
867 mbedtls_md_info_from_type(MBEDTLS_MD_SHA384), 0);
868 if (ret != 0) {
869 return ret;
870 }
871 ret = mbedtls_md_starts(&ssl->handshake->fin_sha384);
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100872 if (ret != 0) {
873 return ret;
874 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800875#endif
876#endif
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100877 return 0;
Jerry Yuc73c6182022-02-08 20:29:25 +0800878}
879
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100880static int ssl_update_checksum_start(mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100881 const unsigned char *buf, size_t len)
Jerry Yuc73c6182022-02-08 20:29:25 +0800882{
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100883#if defined(MBEDTLS_MD_CAN_SHA256) || \
884 defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnarddf949012023-02-06 10:00:52 +0100885#if defined(MBEDTLS_USE_PSA_CRYPTO)
886 psa_status_t status;
887#else
888 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
889#endif
Manuel Pégourié-Gonnard626aaed2023-02-06 22:03:06 +0100890#else /* SHA-256 or SHA-384 */
891 ((void) ssl);
892 (void) buf;
893 (void) len;
894#endif /* SHA-256 or SHA-384 */
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100895#if defined(MBEDTLS_MD_CAN_SHA256)
Jerry Yuc73c6182022-02-08 20:29:25 +0800896#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnarddf949012023-02-06 10:00:52 +0100897 status = psa_hash_update(&ssl->handshake->fin_sha256_psa, buf, len);
898 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200899 return mbedtls_md_error_from_psa(status);
Manuel Pégourié-Gonnarddf949012023-02-06 10:00:52 +0100900 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800901#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +0100902 ret = mbedtls_md_update(&ssl->handshake->fin_sha256, buf, len);
Manuel Pégourié-Gonnarddf949012023-02-06 10:00:52 +0100903 if (ret != 0) {
904 return ret;
905 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800906#endif
907#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100908#if defined(MBEDTLS_MD_CAN_SHA384)
Jerry Yuc73c6182022-02-08 20:29:25 +0800909#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnarddf949012023-02-06 10:00:52 +0100910 status = psa_hash_update(&ssl->handshake->fin_sha384_psa, buf, len);
911 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200912 return mbedtls_md_error_from_psa(status);
Manuel Pégourié-Gonnarddf949012023-02-06 10:00:52 +0100913 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800914#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +0100915 ret = mbedtls_md_update(&ssl->handshake->fin_sha384, buf, len);
Manuel Pégourié-Gonnarddf949012023-02-06 10:00:52 +0100916 if (ret != 0) {
917 return ret;
918 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800919#endif
920#endif
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100921 return 0;
Jerry Yuc73c6182022-02-08 20:29:25 +0800922}
923
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100924#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100925static int ssl_update_checksum_sha256(mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100926 const unsigned char *buf, size_t len)
Jerry Yuc73c6182022-02-08 20:29:25 +0800927{
928#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200929 return mbedtls_md_error_from_psa(psa_hash_update(
930 &ssl->handshake->fin_sha256_psa, buf, len));
Jerry Yuc73c6182022-02-08 20:29:25 +0800931#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +0100932 return mbedtls_md_update(&ssl->handshake->fin_sha256, buf, len);
Jerry Yuc73c6182022-02-08 20:29:25 +0800933#endif
934}
935#endif
936
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100937#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100938static int ssl_update_checksum_sha384(mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100939 const unsigned char *buf, size_t len)
Jerry Yuc73c6182022-02-08 20:29:25 +0800940{
941#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200942 return mbedtls_md_error_from_psa(psa_hash_update(
943 &ssl->handshake->fin_sha384_psa, buf, len));
Jerry Yuc73c6182022-02-08 20:29:25 +0800944#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +0100945 return mbedtls_md_update(&ssl->handshake->fin_sha384, buf, len);
Jerry Yuc73c6182022-02-08 20:29:25 +0800946#endif
947}
948#endif
949
Gilles Peskine449bd832023-01-11 14:50:10 +0100950static void ssl_handshake_params_init(mbedtls_ssl_handshake_params *handshake)
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200951{
Gilles Peskine449bd832023-01-11 14:50:10 +0100952 memset(handshake, 0, sizeof(mbedtls_ssl_handshake_params));
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200953
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100954#if defined(MBEDTLS_MD_CAN_SHA256)
Andrzej Kurekeb342242019-01-29 09:14:33 -0500955#if defined(MBEDTLS_USE_PSA_CRYPTO)
956 handshake->fin_sha256_psa = psa_hash_operation_init();
Andrzej Kurekeb342242019-01-29 09:14:33 -0500957#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +0100958 mbedtls_md_init(&handshake->fin_sha256);
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200959#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -0500960#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100961#if defined(MBEDTLS_MD_CAN_SHA384)
Andrzej Kurekeb342242019-01-29 09:14:33 -0500962#if defined(MBEDTLS_USE_PSA_CRYPTO)
Andrzej Kurek972fba52019-01-30 03:29:12 -0500963 handshake->fin_sha384_psa = psa_hash_operation_init();
Andrzej Kurekeb342242019-01-29 09:14:33 -0500964#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +0100965 mbedtls_md_init(&handshake->fin_sha384);
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200966#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -0500967#endif
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200968
969 handshake->update_checksum = ssl_update_checksum_start;
Hanno Becker7e5437a2017-04-28 17:15:26 +0100970
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200971#if defined(MBEDTLS_DHM_C)
Gilles Peskine449bd832023-01-11 14:50:10 +0100972 mbedtls_dhm_init(&handshake->dhm_ctx);
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200973#endif
Valerio Setti7aeec542023-07-05 18:57:21 +0200974#if !defined(MBEDTLS_USE_PSA_CRYPTO) && \
Valerio Setti6eb00542023-07-07 17:04:24 +0200975 defined(MBEDTLS_KEY_EXCHANGE_SOME_ECDH_OR_ECDHE_1_2_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +0100976 mbedtls_ecdh_init(&handshake->ecdh_ctx);
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200977#endif
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +0200978#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Neil Armstrongca7d5062022-05-31 14:43:23 +0200979#if defined(MBEDTLS_USE_PSA_CRYPTO)
980 handshake->psa_pake_ctx = psa_pake_operation_init();
981 handshake->psa_pake_password = MBEDTLS_SVC_KEY_ID_INIT;
982#else
Gilles Peskine449bd832023-01-11 14:50:10 +0100983 mbedtls_ecjpake_init(&handshake->ecjpake_ctx);
Neil Armstrongca7d5062022-05-31 14:43:23 +0200984#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard77c06462015-09-17 13:59:49 +0200985#if defined(MBEDTLS_SSL_CLI_C)
986 handshake->ecjpake_cache = NULL;
987 handshake->ecjpake_cache_len = 0;
988#endif
Manuel Pégourié-Gonnard76cfd3f2015-09-15 12:10:54 +0200989#endif
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +0200990
Gilles Peskineeccd8882020-03-10 12:19:08 +0100991#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +0100992 mbedtls_x509_crt_restart_init(&handshake->ecrs_ctx);
Manuel Pégourié-Gonnard862cde52017-05-17 11:56:15 +0200993#endif
994
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +0200995#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
996 handshake->sni_authmode = MBEDTLS_SSL_VERIFY_UNSET;
997#endif
Hanno Becker75173122019-02-06 16:18:31 +0000998
999#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
1000 !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01001001 mbedtls_pk_init(&handshake->peer_pubkey);
Hanno Becker75173122019-02-06 16:18:31 +00001002#endif
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001003}
1004
Gilles Peskine449bd832023-01-11 14:50:10 +01001005void mbedtls_ssl_transform_init(mbedtls_ssl_transform *transform)
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001006{
Gilles Peskine449bd832023-01-11 14:50:10 +01001007 memset(transform, 0, sizeof(mbedtls_ssl_transform));
Paul Bakker84bbeb52014-07-01 14:53:22 +02001008
Przemyslaw Stekiel8f80fb92022-01-11 08:28:13 +01001009#if defined(MBEDTLS_USE_PSA_CRYPTO)
1010 transform->psa_key_enc = MBEDTLS_SVC_KEY_ID_INIT;
1011 transform->psa_key_dec = MBEDTLS_SVC_KEY_ID_INIT;
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01001012#else
Gilles Peskine449bd832023-01-11 14:50:10 +01001013 mbedtls_cipher_init(&transform->cipher_ctx_enc);
1014 mbedtls_cipher_init(&transform->cipher_ctx_dec);
Przemyslaw Stekiel8f80fb92022-01-11 08:28:13 +01001015#endif
1016
Hanno Beckerfd86ca82020-11-30 08:54:23 +00001017#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Neil Armstrong39b8e7d2022-02-23 09:24:45 +01001018#if defined(MBEDTLS_USE_PSA_CRYPTO)
1019 transform->psa_mac_enc = MBEDTLS_SVC_KEY_ID_INIT;
1020 transform->psa_mac_dec = MBEDTLS_SVC_KEY_ID_INIT;
Neil Armstrongcf8841a2022-02-24 11:17:45 +01001021#else
Gilles Peskine449bd832023-01-11 14:50:10 +01001022 mbedtls_md_init(&transform->md_ctx_enc);
1023 mbedtls_md_init(&transform->md_ctx_dec);
Hanno Beckerd56ed242018-01-03 15:32:51 +00001024#endif
Neil Armstrongcf8841a2022-02-24 11:17:45 +01001025#endif
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001026}
1027
Gilles Peskine449bd832023-01-11 14:50:10 +01001028void mbedtls_ssl_session_init(mbedtls_ssl_session *session)
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001029{
Gilles Peskine449bd832023-01-11 14:50:10 +01001030 memset(session, 0, sizeof(mbedtls_ssl_session));
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001031}
1032
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001033MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001034static int ssl_handshake_init(mbedtls_ssl_context *ssl)
Paul Bakker48916f92012-09-16 19:57:18 +00001035{
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01001036 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1037
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001038 /* Clear old handshake information if present */
Jerry Yu2e199812022-12-01 18:57:19 +08001039#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01001040 if (ssl->transform_negotiate) {
1041 mbedtls_ssl_transform_free(ssl->transform_negotiate);
1042 }
Jerry Yu2e199812022-12-01 18:57:19 +08001043#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001044 if (ssl->session_negotiate) {
1045 mbedtls_ssl_session_free(ssl->session_negotiate);
1046 }
1047 if (ssl->handshake) {
1048 mbedtls_ssl_handshake_free(ssl);
1049 }
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001050
Jerry Yu2e199812022-12-01 18:57:19 +08001051#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001052 /*
1053 * Either the pointers are now NULL or cleared properly and can be freed.
1054 * Now allocate missing structures.
1055 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001056 if (ssl->transform_negotiate == NULL) {
1057 ssl->transform_negotiate = mbedtls_calloc(1, sizeof(mbedtls_ssl_transform));
Paul Bakkerb9cfaa02013-10-11 18:58:55 +02001058 }
Jerry Yu2e199812022-12-01 18:57:19 +08001059#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Paul Bakker48916f92012-09-16 19:57:18 +00001060
Gilles Peskine449bd832023-01-11 14:50:10 +01001061 if (ssl->session_negotiate == NULL) {
1062 ssl->session_negotiate = mbedtls_calloc(1, sizeof(mbedtls_ssl_session));
Paul Bakkerb9cfaa02013-10-11 18:58:55 +02001063 }
Paul Bakker48916f92012-09-16 19:57:18 +00001064
Gilles Peskine449bd832023-01-11 14:50:10 +01001065 if (ssl->handshake == NULL) {
1066 ssl->handshake = mbedtls_calloc(1, sizeof(mbedtls_ssl_handshake_params));
Paul Bakkerb9cfaa02013-10-11 18:58:55 +02001067 }
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05001068#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1069 /* If the buffers are too small - reallocate */
Andrzej Kurek8ea68722020-04-03 06:40:47 -04001070
Gilles Peskine449bd832023-01-11 14:50:10 +01001071 handle_buffer_resizing(ssl, 0, MBEDTLS_SSL_IN_BUFFER_LEN,
1072 MBEDTLS_SSL_OUT_BUFFER_LEN);
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05001073#endif
Paul Bakker48916f92012-09-16 19:57:18 +00001074
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001075 /* All pointers should exist and can be directly freed without issue */
Gilles Peskine449bd832023-01-11 14:50:10 +01001076 if (ssl->handshake == NULL ||
Jerry Yu2e199812022-12-01 18:57:19 +08001077#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Paul Bakker48916f92012-09-16 19:57:18 +00001078 ssl->transform_negotiate == NULL ||
Jerry Yu2e199812022-12-01 18:57:19 +08001079#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001080 ssl->session_negotiate == NULL) {
1081 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc() of ssl sub-contexts failed"));
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001082
Gilles Peskine449bd832023-01-11 14:50:10 +01001083 mbedtls_free(ssl->handshake);
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001084 ssl->handshake = NULL;
Jerry Yu2e199812022-12-01 18:57:19 +08001085
1086#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01001087 mbedtls_free(ssl->transform_negotiate);
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001088 ssl->transform_negotiate = NULL;
Jerry Yu2e199812022-12-01 18:57:19 +08001089#endif
1090
Gilles Peskine449bd832023-01-11 14:50:10 +01001091 mbedtls_free(ssl->session_negotiate);
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001092 ssl->session_negotiate = NULL;
1093
Gilles Peskine449bd832023-01-11 14:50:10 +01001094 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
Paul Bakker48916f92012-09-16 19:57:18 +00001095 }
1096
Jerry Yu4caf3ca2023-11-15 16:13:47 +08001097#if defined(MBEDTLS_SSL_EARLY_DATA)
1098#if defined(MBEDTLS_SSL_CLI_C)
Ronald Cron05d7cfb2024-03-03 15:39:30 +01001099 ssl->early_data_state = MBEDTLS_SSL_EARLY_DATA_STATE_IDLE;
Ronald Cron5d0ae902024-01-05 14:20:35 +01001100#endif
Jerry Yu4caf3ca2023-11-15 16:13:47 +08001101#if defined(MBEDTLS_SSL_SRV_C)
1102 ssl->discard_early_data_record = MBEDTLS_SSL_EARLY_DATA_NO_DISCARD;
1103#endif
Ronald Cron19bfe0a2024-02-26 16:43:01 +01001104 ssl->total_early_data_size = 0;
Jerry Yu4caf3ca2023-11-15 16:13:47 +08001105#endif /* MBEDTLS_SSL_EARLY_DATA */
Ronald Cron5d0ae902024-01-05 14:20:35 +01001106
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001107 /* Initialize structures */
Gilles Peskine449bd832023-01-11 14:50:10 +01001108 mbedtls_ssl_session_init(ssl->session_negotiate);
1109 ssl_handshake_params_init(ssl->handshake);
Paul Bakker968afaa2014-07-09 11:09:24 +02001110
Jerry Yu2e199812022-12-01 18:57:19 +08001111#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01001112 mbedtls_ssl_transform_init(ssl->transform_negotiate);
Jerry Yu2e199812022-12-01 18:57:19 +08001113#endif
1114
Manuel Pégourié-Gonnard537f2312023-02-05 10:17:45 +01001115 /* Setup handshake checksums */
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01001116 ret = mbedtls_ssl_reset_checksum(ssl);
1117 if (ret != 0) {
1118 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_reset_checksum", ret);
1119 return ret;
1120 }
Manuel Pégourié-Gonnard537f2312023-02-05 10:17:45 +01001121
Jerry Yud0766ec2022-09-22 10:46:57 +08001122#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && \
1123 defined(MBEDTLS_SSL_SRV_C) && \
1124 defined(MBEDTLS_SSL_SESSION_TICKETS)
1125 ssl->handshake->new_session_tickets_count =
Gilles Peskine449bd832023-01-11 14:50:10 +01001126 ssl->conf->new_session_tickets_count;
Jerry Yud0766ec2022-09-22 10:46:57 +08001127#endif
1128
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001129#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01001130 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +02001131 ssl->handshake->alt_transform_out = ssl->transform_out;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02001132
Gilles Peskine449bd832023-01-11 14:50:10 +01001133 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +02001134 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_PREPARING;
Gilles Peskine449bd832023-01-11 14:50:10 +01001135 } else {
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +02001136 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_WAITING;
Gilles Peskine449bd832023-01-11 14:50:10 +01001137 }
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001138
Gilles Peskine449bd832023-01-11 14:50:10 +01001139 mbedtls_ssl_set_timer(ssl, 0);
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +02001140 }
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02001141#endif
1142
Brett Warrene0edc842021-08-17 09:53:13 +01001143/*
1144 * curve_list is translated to IANA TLS group identifiers here because
1145 * mbedtls_ssl_conf_curves returns void and so can't return
1146 * any error codes.
1147 */
Manuel Pégourié-Gonnardf07ce3b2023-09-22 11:53:41 +02001148#if defined(MBEDTLS_ECP_C)
Brett Warrene0edc842021-08-17 09:53:13 +01001149#if !defined(MBEDTLS_DEPRECATED_REMOVED)
1150 /* Heap allocate and translate curve_list from internal to IANA group ids */
Gilles Peskine449bd832023-01-11 14:50:10 +01001151 if (ssl->conf->curve_list != NULL) {
Brett Warrene0edc842021-08-17 09:53:13 +01001152 size_t length;
1153 const mbedtls_ecp_group_id *curve_list = ssl->conf->curve_list;
1154
Thomas Daubney850a0792023-05-22 12:05:03 +01001155 for (length = 0; (curve_list[length] != MBEDTLS_ECP_DP_NONE); length++) {
Gilles Peskine449bd832023-01-11 14:50:10 +01001156 }
Brett Warrene0edc842021-08-17 09:53:13 +01001157
1158 /* Leave room for zero termination */
Gilles Peskine449bd832023-01-11 14:50:10 +01001159 uint16_t *group_list = mbedtls_calloc(length + 1, sizeof(uint16_t));
1160 if (group_list == NULL) {
1161 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
1162 }
Brett Warrene0edc842021-08-17 09:53:13 +01001163
Gilles Peskine449bd832023-01-11 14:50:10 +01001164 for (size_t i = 0; i < length; i++) {
Valerio Setti18c9fed2022-12-30 17:44:24 +01001165 uint16_t tls_id = mbedtls_ssl_get_tls_id_from_ecp_group_id(
Gilles Peskine449bd832023-01-11 14:50:10 +01001166 curve_list[i]);
1167 if (tls_id == 0) {
1168 mbedtls_free(group_list);
1169 return MBEDTLS_ERR_SSL_BAD_CONFIG;
Brett Warrene0edc842021-08-17 09:53:13 +01001170 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01001171 group_list[i] = tls_id;
Brett Warrene0edc842021-08-17 09:53:13 +01001172 }
1173
1174 group_list[length] = 0;
1175
1176 ssl->handshake->group_list = group_list;
1177 ssl->handshake->group_list_heap_allocated = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01001178 } else {
Brett Warrene0edc842021-08-17 09:53:13 +01001179 ssl->handshake->group_list = ssl->conf->group_list;
1180 ssl->handshake->group_list_heap_allocated = 0;
1181 }
1182#endif /* MBEDTLS_DEPRECATED_REMOVED */
Manuel Pégourié-Gonnardf07ce3b2023-09-22 11:53:41 +02001183#endif /* MBEDTLS_ECP_C */
Brett Warrene0edc842021-08-17 09:53:13 +01001184
Ronald Crone68ab4f2022-10-05 12:46:29 +02001185#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yuf017ee42022-01-12 15:49:48 +08001186#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Jerry Yua69269a2022-01-17 21:06:01 +08001187#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Jerry Yu713013f2022-01-17 18:16:35 +08001188 /* Heap allocate and translate sig_hashes from internal hash identifiers to
1189 signature algorithms IANA identifiers. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001190 if (mbedtls_ssl_conf_is_tls12_only(ssl->conf) &&
1191 ssl->conf->sig_hashes != NULL) {
Jerry Yuf017ee42022-01-12 15:49:48 +08001192 const int *md;
1193 const int *sig_hashes = ssl->conf->sig_hashes;
Jerry Yub476a442022-01-21 18:14:45 +08001194 size_t sig_algs_len = 0;
Jerry Yuf017ee42022-01-12 15:49:48 +08001195 uint16_t *p;
1196
Tom Cosgrove6ef9bb32023-03-08 14:19:51 +00001197 MBEDTLS_STATIC_ASSERT(MBEDTLS_SSL_MAX_SIG_ALG_LIST_LEN
1198 <= (SIZE_MAX - (2 * sizeof(uint16_t))),
1199 "MBEDTLS_SSL_MAX_SIG_ALG_LIST_LEN too big");
Jerry Yua68dca22022-01-20 16:28:27 +08001200
Gilles Peskine449bd832023-01-11 14:50:10 +01001201 for (md = sig_hashes; *md != MBEDTLS_MD_NONE; md++) {
1202 if (mbedtls_ssl_hash_from_md_alg(*md) == MBEDTLS_SSL_HASH_NONE) {
Jerry Yuf017ee42022-01-12 15:49:48 +08001203 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01001204 }
Valerio Settie9646ec2023-08-02 20:02:28 +02001205#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01001206 sig_algs_len += sizeof(uint16_t);
Jerry Yub476a442022-01-21 18:14:45 +08001207#endif
Jerry Yua68dca22022-01-20 16:28:27 +08001208
Jerry Yub476a442022-01-21 18:14:45 +08001209#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001210 sig_algs_len += sizeof(uint16_t);
Jerry Yub476a442022-01-21 18:14:45 +08001211#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001212 if (sig_algs_len > MBEDTLS_SSL_MAX_SIG_ALG_LIST_LEN) {
1213 return MBEDTLS_ERR_SSL_BAD_CONFIG;
1214 }
Jerry Yuf017ee42022-01-12 15:49:48 +08001215 }
1216
Gilles Peskine449bd832023-01-11 14:50:10 +01001217 if (sig_algs_len < MBEDTLS_SSL_MIN_SIG_ALG_LIST_LEN) {
1218 return MBEDTLS_ERR_SSL_BAD_CONFIG;
1219 }
Jerry Yuf017ee42022-01-12 15:49:48 +08001220
Gilles Peskine449bd832023-01-11 14:50:10 +01001221 ssl->handshake->sig_algs = mbedtls_calloc(1, sig_algs_len +
1222 sizeof(uint16_t));
1223 if (ssl->handshake->sig_algs == NULL) {
1224 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
1225 }
Jerry Yuf017ee42022-01-12 15:49:48 +08001226
Gilles Peskine449bd832023-01-11 14:50:10 +01001227 p = (uint16_t *) ssl->handshake->sig_algs;
1228 for (md = sig_hashes; *md != MBEDTLS_MD_NONE; md++) {
1229 unsigned char hash = mbedtls_ssl_hash_from_md_alg(*md);
1230 if (hash == MBEDTLS_SSL_HASH_NONE) {
Jerry Yuf017ee42022-01-12 15:49:48 +08001231 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01001232 }
Valerio Settie9646ec2023-08-02 20:02:28 +02001233#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01001234 *p = ((hash << 8) | MBEDTLS_SSL_SIG_ECDSA);
Jerry Yuf017ee42022-01-12 15:49:48 +08001235 p++;
Jerry Yu6106fdc2022-01-12 16:36:14 +08001236#endif
1237#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001238 *p = ((hash << 8) | MBEDTLS_SSL_SIG_RSA);
Jerry Yuf017ee42022-01-12 15:49:48 +08001239 p++;
Jerry Yu6106fdc2022-01-12 16:36:14 +08001240#endif
Jerry Yuf017ee42022-01-12 15:49:48 +08001241 }
Gabor Mezei15b95a62022-05-09 16:37:58 +02001242 *p = MBEDTLS_TLS_SIG_NONE;
Jerry Yuf017ee42022-01-12 15:49:48 +08001243 ssl->handshake->sig_algs_heap_allocated = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01001244 } else
Jerry Yua69269a2022-01-17 21:06:01 +08001245#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Jerry Yuf017ee42022-01-12 15:49:48 +08001246 {
Jerry Yuf017ee42022-01-12 15:49:48 +08001247 ssl->handshake->sig_algs_heap_allocated = 0;
1248 }
Jerry Yucc539102022-06-27 16:27:35 +08001249#endif /* !MBEDTLS_DEPRECATED_REMOVED */
Ronald Crone68ab4f2022-10-05 12:46:29 +02001250#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Gilles Peskine449bd832023-01-11 14:50:10 +01001251 return 0;
Paul Bakker48916f92012-09-16 19:57:18 +00001252}
1253
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001254#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001255/* Dummy cookie callbacks for defaults */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001256MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001257static int ssl_cookie_write_dummy(void *ctx,
1258 unsigned char **p, unsigned char *end,
1259 const unsigned char *cli_id, size_t cli_id_len)
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001260{
1261 ((void) ctx);
1262 ((void) p);
1263 ((void) end);
1264 ((void) cli_id);
1265 ((void) cli_id_len);
1266
Gilles Peskine449bd832023-01-11 14:50:10 +01001267 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001268}
1269
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001270MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001271static int ssl_cookie_check_dummy(void *ctx,
1272 const unsigned char *cookie, size_t cookie_len,
1273 const unsigned char *cli_id, size_t cli_id_len)
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001274{
1275 ((void) ctx);
1276 ((void) cookie);
1277 ((void) cookie_len);
1278 ((void) cli_id);
1279 ((void) cli_id_len);
1280
Gilles Peskine449bd832023-01-11 14:50:10 +01001281 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001282}
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001283#endif /* MBEDTLS_SSL_DTLS_HELLO_VERIFY && MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001284
Paul Bakker5121ce52009-01-03 21:22:43 +00001285/*
1286 * Initialize an SSL context
1287 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001288void mbedtls_ssl_init(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +02001289{
Gilles Peskine449bd832023-01-11 14:50:10 +01001290 memset(ssl, 0, sizeof(mbedtls_ssl_context));
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +02001291}
1292
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001293MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001294static int ssl_conf_version_check(const mbedtls_ssl_context *ssl)
Jerry Yu60835a82021-08-04 10:13:52 +08001295{
Ronald Cron086ee0b2022-03-15 15:18:51 +01001296 const mbedtls_ssl_config *conf = ssl->conf;
1297
Ronald Cron6f135e12021-12-08 16:57:54 +01001298#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01001299 if (mbedtls_ssl_conf_is_tls13_only(conf)) {
1300 if (conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
1301 MBEDTLS_SSL_DEBUG_MSG(1, ("DTLS 1.3 is not yet supported."));
1302 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
XiaokangQianed582dd2022-04-13 08:21:05 +00001303 }
1304
Gilles Peskine449bd832023-01-11 14:50:10 +01001305 MBEDTLS_SSL_DEBUG_MSG(4, ("The SSL configuration is tls13 only."));
1306 return 0;
Jerry Yu60835a82021-08-04 10:13:52 +08001307 }
1308#endif
1309
1310#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01001311 if (mbedtls_ssl_conf_is_tls12_only(conf)) {
1312 MBEDTLS_SSL_DEBUG_MSG(4, ("The SSL configuration is tls12 only."));
1313 return 0;
Jerry Yu60835a82021-08-04 10:13:52 +08001314 }
1315#endif
1316
Ronald Cron6f135e12021-12-08 16:57:54 +01001317#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01001318 if (mbedtls_ssl_conf_is_hybrid_tls12_tls13(conf)) {
1319 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
1320 MBEDTLS_SSL_DEBUG_MSG(1, ("DTLS not yet supported in Hybrid TLS 1.3 + TLS 1.2"));
1321 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
XiaokangQianed582dd2022-04-13 08:21:05 +00001322 }
1323
Gilles Peskine449bd832023-01-11 14:50:10 +01001324 MBEDTLS_SSL_DEBUG_MSG(4, ("The SSL configuration is TLS 1.3 or TLS 1.2."));
1325 return 0;
Jerry Yu60835a82021-08-04 10:13:52 +08001326 }
1327#endif
1328
Gilles Peskine449bd832023-01-11 14:50:10 +01001329 MBEDTLS_SSL_DEBUG_MSG(1, ("The SSL configuration is invalid."));
1330 return MBEDTLS_ERR_SSL_BAD_CONFIG;
Jerry Yu60835a82021-08-04 10:13:52 +08001331}
1332
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001333MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu60835a82021-08-04 10:13:52 +08001334static int ssl_conf_check(const mbedtls_ssl_context *ssl)
1335{
1336 int ret;
Gilles Peskine449bd832023-01-11 14:50:10 +01001337 ret = ssl_conf_version_check(ssl);
1338 if (ret != 0) {
1339 return ret;
1340 }
Jerry Yu60835a82021-08-04 10:13:52 +08001341
Jerry Yudef7ae42022-10-30 14:13:19 +08001342#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
1343 /* RFC 8446 section 4.4.3
1344 *
1345 * If the verification fails, the receiver MUST terminate the handshake with
1346 * a "decrypt_error" alert.
1347 *
1348 * If the client is configured as TLS 1.3 only with optional verify, return
1349 * bad config.
1350 *
1351 */
Pengyu Lv0a1ff2b2023-11-14 11:03:32 +08001352 if (mbedtls_ssl_conf_tls13_is_ephemeral_enabled(
Gilles Peskine449bd832023-01-11 14:50:10 +01001353 (mbedtls_ssl_context *) ssl) &&
Jerry Yudef7ae42022-10-30 14:13:19 +08001354 ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
1355 ssl->conf->max_tls_version == MBEDTLS_SSL_VERSION_TLS1_3 &&
1356 ssl->conf->min_tls_version == MBEDTLS_SSL_VERSION_TLS1_3 &&
Gilles Peskine449bd832023-01-11 14:50:10 +01001357 ssl->conf->authmode == MBEDTLS_SSL_VERIFY_OPTIONAL) {
Jerry Yudef7ae42022-10-30 14:13:19 +08001358 MBEDTLS_SSL_DEBUG_MSG(
Gilles Peskine449bd832023-01-11 14:50:10 +01001359 1, ("Optional verify auth mode "
1360 "is not available for TLS 1.3 client"));
1361 return MBEDTLS_ERR_SSL_BAD_CONFIG;
Jerry Yudef7ae42022-10-30 14:13:19 +08001362 }
1363#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
1364
Yanray Wangb422cab2023-12-01 16:18:10 +08001365 if (ssl->conf->f_rng == NULL) {
1366 MBEDTLS_SSL_DEBUG_MSG(1, ("no RNG provided"));
1367 return MBEDTLS_ERR_SSL_NO_RNG;
1368 }
1369
Jerry Yu60835a82021-08-04 10:13:52 +08001370 /* Space for further checks */
1371
Gilles Peskine449bd832023-01-11 14:50:10 +01001372 return 0;
Jerry Yu60835a82021-08-04 10:13:52 +08001373}
1374
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +02001375/*
1376 * Setup an SSL context
1377 */
Hanno Becker2a43f6f2018-08-10 11:12:52 +01001378
Gilles Peskine449bd832023-01-11 14:50:10 +01001379int mbedtls_ssl_setup(mbedtls_ssl_context *ssl,
1380 const mbedtls_ssl_config *conf)
Paul Bakker5121ce52009-01-03 21:22:43 +00001381{
Janos Follath865b3eb2019-12-16 11:46:15 +00001382 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Darryl Greenb33cc762019-11-28 14:29:44 +00001383 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
1384 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
Paul Bakker5121ce52009-01-03 21:22:43 +00001385
Manuel Pégourié-Gonnarddef0bbe2015-05-04 14:56:36 +02001386 ssl->conf = conf;
Paul Bakker62f2dee2012-09-28 07:31:51 +00001387
Gilles Peskine449bd832023-01-11 14:50:10 +01001388 if ((ret = ssl_conf_check(ssl)) != 0) {
1389 return ret;
1390 }
Ronald Cron8a12aee2023-03-08 15:30:43 +01001391 ssl->tls_version = ssl->conf->max_tls_version;
Jerry Yu60835a82021-08-04 10:13:52 +08001392
Paul Bakker62f2dee2012-09-28 07:31:51 +00001393 /*
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01001394 * Prepare base structures
Paul Bakker62f2dee2012-09-28 07:31:51 +00001395 */
k-stachowiakc9a5f022018-07-24 13:53:31 +02001396
1397 /* Set to NULL in case of an error condition */
1398 ssl->out_buf = NULL;
k-stachowiaka47911c2018-07-04 17:41:58 +02001399
Darryl Greenb33cc762019-11-28 14:29:44 +00001400#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1401 ssl->in_buf_len = in_buf_len;
1402#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001403 ssl->in_buf = mbedtls_calloc(1, in_buf_len);
1404 if (ssl->in_buf == NULL) {
1405 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc(%" MBEDTLS_PRINTF_SIZET " bytes) failed", in_buf_len));
k-stachowiak9f7798e2018-07-31 16:52:32 +02001406 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
k-stachowiaka47911c2018-07-04 17:41:58 +02001407 goto error;
Angus Grattond8213d02016-05-25 20:56:48 +10001408 }
1409
Darryl Greenb33cc762019-11-28 14:29:44 +00001410#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1411 ssl->out_buf_len = out_buf_len;
1412#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001413 ssl->out_buf = mbedtls_calloc(1, out_buf_len);
1414 if (ssl->out_buf == NULL) {
1415 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc(%" MBEDTLS_PRINTF_SIZET " bytes) failed", out_buf_len));
k-stachowiak9f7798e2018-07-31 16:52:32 +02001416 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
k-stachowiaka47911c2018-07-04 17:41:58 +02001417 goto error;
Paul Bakker5121ce52009-01-03 21:22:43 +00001418 }
1419
Gilles Peskine449bd832023-01-11 14:50:10 +01001420 mbedtls_ssl_reset_in_out_pointers(ssl);
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02001421
Johan Pascalb62bb512015-12-03 21:56:45 +01001422#if defined(MBEDTLS_SSL_DTLS_SRTP)
Gilles Peskine449bd832023-01-11 14:50:10 +01001423 memset(&ssl->dtls_srtp_info, 0, sizeof(ssl->dtls_srtp_info));
Johan Pascalb62bb512015-12-03 21:56:45 +01001424#endif
1425
Gilles Peskine449bd832023-01-11 14:50:10 +01001426 if ((ret = ssl_handshake_init(ssl)) != 0) {
k-stachowiaka47911c2018-07-04 17:41:58 +02001427 goto error;
Gilles Peskine449bd832023-01-11 14:50:10 +01001428 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001429
Gilles Peskine449bd832023-01-11 14:50:10 +01001430 return 0;
k-stachowiaka47911c2018-07-04 17:41:58 +02001431
1432error:
Gilles Peskine449bd832023-01-11 14:50:10 +01001433 mbedtls_free(ssl->in_buf);
1434 mbedtls_free(ssl->out_buf);
k-stachowiaka47911c2018-07-04 17:41:58 +02001435
1436 ssl->conf = NULL;
1437
Darryl Greenb33cc762019-11-28 14:29:44 +00001438#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1439 ssl->in_buf_len = 0;
1440 ssl->out_buf_len = 0;
1441#endif
k-stachowiaka47911c2018-07-04 17:41:58 +02001442 ssl->in_buf = NULL;
1443 ssl->out_buf = NULL;
1444
1445 ssl->in_hdr = NULL;
1446 ssl->in_ctr = NULL;
1447 ssl->in_len = NULL;
1448 ssl->in_iv = NULL;
1449 ssl->in_msg = NULL;
1450
1451 ssl->out_hdr = NULL;
1452 ssl->out_ctr = NULL;
1453 ssl->out_len = NULL;
1454 ssl->out_iv = NULL;
1455 ssl->out_msg = NULL;
1456
Gilles Peskine449bd832023-01-11 14:50:10 +01001457 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00001458}
1459
1460/*
Paul Bakker7eb013f2011-10-06 12:37:39 +00001461 * Reset an initialized and used SSL context for re-use while retaining
1462 * all application-set variables, function pointers and data.
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001463 *
1464 * If partial is non-zero, keep data in the input buffer and client ID.
1465 * (Use when a DTLS client reconnects from the same port.)
Paul Bakker7eb013f2011-10-06 12:37:39 +00001466 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001467void mbedtls_ssl_session_reset_msg_layer(mbedtls_ssl_context *ssl,
1468 int partial)
Paul Bakker7eb013f2011-10-06 12:37:39 +00001469{
Darryl Greenb33cc762019-11-28 14:29:44 +00001470#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1471 size_t in_buf_len = ssl->in_buf_len;
1472 size_t out_buf_len = ssl->out_buf_len;
1473#else
1474 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
1475 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
1476#endif
Paul Bakker48916f92012-09-16 19:57:18 +00001477
Hanno Beckerb0302c42021-08-03 09:39:42 +01001478#if !defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE) || !defined(MBEDTLS_SSL_SRV_C)
1479 partial = 0;
Hanno Becker7e772132018-08-10 12:38:21 +01001480#endif
1481
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001482 /* Cancel any possibly running timer */
Gilles Peskine449bd832023-01-11 14:50:10 +01001483 mbedtls_ssl_set_timer(ssl, 0);
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001484
Gilles Peskine449bd832023-01-11 14:50:10 +01001485 mbedtls_ssl_reset_in_out_pointers(ssl);
Hanno Beckerb0302c42021-08-03 09:39:42 +01001486
1487 /* Reset incoming message parsing */
1488 ssl->in_offt = NULL;
1489 ssl->nb_zero = 0;
1490 ssl->in_msgtype = 0;
1491 ssl->in_msglen = 0;
1492 ssl->in_hslen = 0;
1493 ssl->keep_current_message = 0;
1494 ssl->transform_in = NULL;
1495
1496#if defined(MBEDTLS_SSL_PROTO_DTLS)
1497 ssl->next_record_offset = 0;
1498 ssl->in_epoch = 0;
1499#endif
1500
1501 /* Keep current datagram if partial == 1 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001502 if (partial == 0) {
Hanno Beckerb0302c42021-08-03 09:39:42 +01001503 ssl->in_left = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01001504 memset(ssl->in_buf, 0, in_buf_len);
Hanno Beckerb0302c42021-08-03 09:39:42 +01001505 }
1506
Ronald Cronad8c17b2022-06-10 17:18:09 +02001507 ssl->send_alert = 0;
1508
Hanno Beckerb0302c42021-08-03 09:39:42 +01001509 /* Reset outgoing message writing */
1510 ssl->out_msgtype = 0;
1511 ssl->out_msglen = 0;
1512 ssl->out_left = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01001513 memset(ssl->out_buf, 0, out_buf_len);
1514 memset(ssl->cur_out_ctr, 0, sizeof(ssl->cur_out_ctr));
Hanno Beckerb0302c42021-08-03 09:39:42 +01001515 ssl->transform_out = NULL;
1516
1517#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Gilles Peskine449bd832023-01-11 14:50:10 +01001518 mbedtls_ssl_dtls_replay_reset(ssl);
Hanno Beckerb0302c42021-08-03 09:39:42 +01001519#endif
1520
XiaokangQian2b01dc32022-01-21 02:53:13 +00001521#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01001522 if (ssl->transform) {
1523 mbedtls_ssl_transform_free(ssl->transform);
1524 mbedtls_free(ssl->transform);
Hanno Beckerb0302c42021-08-03 09:39:42 +01001525 ssl->transform = NULL;
1526 }
XiaokangQian2b01dc32022-01-21 02:53:13 +00001527#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
1528
XiaokangQian2b01dc32022-01-21 02:53:13 +00001529#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01001530 mbedtls_ssl_transform_free(ssl->transform_application);
1531 mbedtls_free(ssl->transform_application);
XiaokangQian2b01dc32022-01-21 02:53:13 +00001532 ssl->transform_application = NULL;
1533
Gilles Peskine449bd832023-01-11 14:50:10 +01001534 if (ssl->handshake != NULL) {
Jerry Yu3d9b5902022-11-04 14:07:25 +08001535#if defined(MBEDTLS_SSL_EARLY_DATA)
Gilles Peskine449bd832023-01-11 14:50:10 +01001536 mbedtls_ssl_transform_free(ssl->handshake->transform_earlydata);
1537 mbedtls_free(ssl->handshake->transform_earlydata);
XiaokangQian2b01dc32022-01-21 02:53:13 +00001538 ssl->handshake->transform_earlydata = NULL;
Jerry Yu3d9b5902022-11-04 14:07:25 +08001539#endif
XiaokangQian2b01dc32022-01-21 02:53:13 +00001540
Gilles Peskine449bd832023-01-11 14:50:10 +01001541 mbedtls_ssl_transform_free(ssl->handshake->transform_handshake);
1542 mbedtls_free(ssl->handshake->transform_handshake);
XiaokangQian2b01dc32022-01-21 02:53:13 +00001543 ssl->handshake->transform_handshake = NULL;
1544 }
1545
XiaokangQian2b01dc32022-01-21 02:53:13 +00001546#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Beckerb0302c42021-08-03 09:39:42 +01001547}
1548
Gilles Peskine449bd832023-01-11 14:50:10 +01001549int mbedtls_ssl_session_reset_int(mbedtls_ssl_context *ssl, int partial)
Hanno Beckerb0302c42021-08-03 09:39:42 +01001550{
1551 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1552
1553 ssl->state = MBEDTLS_SSL_HELLO_REQUEST;
1554
Gilles Peskine449bd832023-01-11 14:50:10 +01001555 mbedtls_ssl_session_reset_msg_layer(ssl, partial);
Hanno Beckerb0302c42021-08-03 09:39:42 +01001556
1557 /* Reset renegotiation state */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001558#if defined(MBEDTLS_SSL_RENEGOTIATION)
1559 ssl->renego_status = MBEDTLS_SSL_INITIAL_HANDSHAKE;
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001560 ssl->renego_records_seen = 0;
Paul Bakker48916f92012-09-16 19:57:18 +00001561
1562 ssl->verify_data_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01001563 memset(ssl->own_verify_data, 0, MBEDTLS_SSL_VERIFY_DATA_MAX_LEN);
1564 memset(ssl->peer_verify_data, 0, MBEDTLS_SSL_VERIFY_DATA_MAX_LEN);
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001565#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001566 ssl->secure_renegotiation = MBEDTLS_SSL_LEGACY_RENEGOTIATION;
Paul Bakker48916f92012-09-16 19:57:18 +00001567
Hanno Beckerb0302c42021-08-03 09:39:42 +01001568 ssl->session_in = NULL;
Hanno Becker78640902018-08-13 16:35:15 +01001569 ssl->session_out = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01001570 if (ssl->session) {
1571 mbedtls_ssl_session_free(ssl->session);
1572 mbedtls_free(ssl->session);
Paul Bakkerc0463502013-02-14 11:19:38 +01001573 ssl->session = NULL;
1574 }
1575
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001576#if defined(MBEDTLS_SSL_ALPN)
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001577 ssl->alpn_chosen = NULL;
1578#endif
1579
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001580#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
David Horstmann3b2276a2022-10-06 14:49:08 +01001581 int free_cli_id = 1;
Hanno Becker4ccbf062018-08-10 11:20:38 +01001582#if defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE)
Gilles Peskine449bd832023-01-11 14:50:10 +01001583 free_cli_id = (partial == 0);
Hanno Becker4ccbf062018-08-10 11:20:38 +01001584#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001585 if (free_cli_id) {
1586 mbedtls_free(ssl->cli_id);
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001587 ssl->cli_id = NULL;
1588 ssl->cli_id_len = 0;
1589 }
Manuel Pégourié-Gonnard43c02182014-07-22 17:32:01 +02001590#endif
1591
Gilles Peskine449bd832023-01-11 14:50:10 +01001592 if ((ret = ssl_handshake_init(ssl)) != 0) {
1593 return ret;
1594 }
Paul Bakker2770fbd2012-07-03 13:30:23 +00001595
Gilles Peskine449bd832023-01-11 14:50:10 +01001596 return 0;
Paul Bakker7eb013f2011-10-06 12:37:39 +00001597}
1598
Manuel Pégourié-Gonnard779e4292013-08-03 13:50:48 +02001599/*
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001600 * Reset an initialized and used SSL context for re-use while retaining
1601 * all application-set variables, function pointers and data.
1602 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001603int mbedtls_ssl_session_reset(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001604{
Gilles Peskine449bd832023-01-11 14:50:10 +01001605 return mbedtls_ssl_session_reset_int(ssl, 0);
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001606}
1607
1608/*
Paul Bakker5121ce52009-01-03 21:22:43 +00001609 * SSL set accessors
1610 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001611void mbedtls_ssl_conf_endpoint(mbedtls_ssl_config *conf, int endpoint)
Paul Bakker5121ce52009-01-03 21:22:43 +00001612{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001613 conf->endpoint = endpoint;
Paul Bakker5121ce52009-01-03 21:22:43 +00001614}
1615
Gilles Peskine449bd832023-01-11 14:50:10 +01001616void mbedtls_ssl_conf_transport(mbedtls_ssl_config *conf, int transport)
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001617{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001618 conf->transport = transport;
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001619}
1620
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001621#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Gilles Peskine449bd832023-01-11 14:50:10 +01001622void mbedtls_ssl_conf_dtls_anti_replay(mbedtls_ssl_config *conf, char mode)
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02001623{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001624 conf->anti_replay = mode;
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02001625}
1626#endif
1627
Gilles Peskine449bd832023-01-11 14:50:10 +01001628void mbedtls_ssl_conf_dtls_badmac_limit(mbedtls_ssl_config *conf, unsigned limit)
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001629{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001630 conf->badmac_limit = limit;
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001631}
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001632
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001633#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker04da1892018-08-14 13:22:10 +01001634
Gilles Peskine449bd832023-01-11 14:50:10 +01001635void mbedtls_ssl_set_datagram_packing(mbedtls_ssl_context *ssl,
1636 unsigned allow_packing)
Hanno Becker04da1892018-08-14 13:22:10 +01001637{
1638 ssl->disable_datagram_packing = !allow_packing;
1639}
1640
Gilles Peskine449bd832023-01-11 14:50:10 +01001641void mbedtls_ssl_conf_handshake_timeout(mbedtls_ssl_config *conf,
1642 uint32_t min, uint32_t max)
Manuel Pégourié-Gonnard905dd242014-10-01 12:03:55 +02001643{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001644 conf->hs_timeout_min = min;
1645 conf->hs_timeout_max = max;
Manuel Pégourié-Gonnard905dd242014-10-01 12:03:55 +02001646}
1647#endif
1648
Gilles Peskine449bd832023-01-11 14:50:10 +01001649void mbedtls_ssl_conf_authmode(mbedtls_ssl_config *conf, int authmode)
Paul Bakker5121ce52009-01-03 21:22:43 +00001650{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001651 conf->authmode = authmode;
Paul Bakker5121ce52009-01-03 21:22:43 +00001652}
1653
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001654#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001655void mbedtls_ssl_conf_verify(mbedtls_ssl_config *conf,
1656 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *),
1657 void *p_vrfy)
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001658{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001659 conf->f_vrfy = f_vrfy;
1660 conf->p_vrfy = p_vrfy;
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001661}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001662#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001663
Gilles Peskine449bd832023-01-11 14:50:10 +01001664void mbedtls_ssl_conf_rng(mbedtls_ssl_config *conf,
1665 int (*f_rng)(void *, unsigned char *, size_t),
1666 void *p_rng)
Paul Bakker5121ce52009-01-03 21:22:43 +00001667{
Manuel Pégourié-Gonnard750e4d72015-05-07 12:35:38 +01001668 conf->f_rng = f_rng;
1669 conf->p_rng = p_rng;
Paul Bakker5121ce52009-01-03 21:22:43 +00001670}
1671
Gilles Peskine449bd832023-01-11 14:50:10 +01001672void mbedtls_ssl_conf_dbg(mbedtls_ssl_config *conf,
1673 void (*f_dbg)(void *, int, const char *, int, const char *),
1674 void *p_dbg)
Paul Bakker5121ce52009-01-03 21:22:43 +00001675{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001676 conf->f_dbg = f_dbg;
1677 conf->p_dbg = p_dbg;
Paul Bakker5121ce52009-01-03 21:22:43 +00001678}
1679
Gilles Peskine449bd832023-01-11 14:50:10 +01001680void mbedtls_ssl_set_bio(mbedtls_ssl_context *ssl,
1681 void *p_bio,
1682 mbedtls_ssl_send_t *f_send,
1683 mbedtls_ssl_recv_t *f_recv,
1684 mbedtls_ssl_recv_timeout_t *f_recv_timeout)
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02001685{
1686 ssl->p_bio = p_bio;
1687 ssl->f_send = f_send;
1688 ssl->f_recv = f_recv;
1689 ssl->f_recv_timeout = f_recv_timeout;
Manuel Pégourié-Gonnard97fd52c2015-05-06 15:38:52 +01001690}
1691
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02001692#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01001693void mbedtls_ssl_set_mtu(mbedtls_ssl_context *ssl, uint16_t mtu)
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02001694{
1695 ssl->mtu = mtu;
1696}
1697#endif
1698
Gilles Peskine449bd832023-01-11 14:50:10 +01001699void mbedtls_ssl_conf_read_timeout(mbedtls_ssl_config *conf, uint32_t timeout)
Manuel Pégourié-Gonnard97fd52c2015-05-06 15:38:52 +01001700{
1701 conf->read_timeout = timeout;
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02001702}
1703
Gilles Peskine449bd832023-01-11 14:50:10 +01001704void mbedtls_ssl_set_timer_cb(mbedtls_ssl_context *ssl,
1705 void *p_timer,
1706 mbedtls_ssl_set_timer_t *f_set_timer,
1707 mbedtls_ssl_get_timer_t *f_get_timer)
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02001708{
1709 ssl->p_timer = p_timer;
1710 ssl->f_set_timer = f_set_timer;
1711 ssl->f_get_timer = f_get_timer;
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001712
1713 /* Make sure we start with no timer running */
Gilles Peskine449bd832023-01-11 14:50:10 +01001714 mbedtls_ssl_set_timer(ssl, 0);
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02001715}
1716
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001717#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001718void mbedtls_ssl_conf_session_cache(mbedtls_ssl_config *conf,
1719 void *p_cache,
1720 mbedtls_ssl_cache_get_t *f_get_cache,
1721 mbedtls_ssl_cache_set_t *f_set_cache)
Paul Bakker5121ce52009-01-03 21:22:43 +00001722{
Manuel Pégourié-Gonnard5cb33082015-05-06 18:06:26 +01001723 conf->p_cache = p_cache;
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001724 conf->f_get_cache = f_get_cache;
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001725 conf->f_set_cache = f_set_cache;
Paul Bakker5121ce52009-01-03 21:22:43 +00001726}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001727#endif /* MBEDTLS_SSL_SRV_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00001728
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001729#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001730int mbedtls_ssl_set_session(mbedtls_ssl_context *ssl, const mbedtls_ssl_session *session)
Paul Bakker5121ce52009-01-03 21:22:43 +00001731{
Janos Follath865b3eb2019-12-16 11:46:15 +00001732 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001733
Gilles Peskine449bd832023-01-11 14:50:10 +01001734 if (ssl == NULL ||
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001735 session == NULL ||
1736 ssl->session_negotiate == NULL ||
Gilles Peskine449bd832023-01-11 14:50:10 +01001737 ssl->conf->endpoint != MBEDTLS_SSL_IS_CLIENT) {
1738 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001739 }
1740
Gilles Peskine449bd832023-01-11 14:50:10 +01001741 if (ssl->handshake->resume == 1) {
1742 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
1743 }
Hanno Beckere810bbc2021-05-14 16:01:05 +01001744
Jerry Yu21092062022-10-10 21:21:31 +08001745#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01001746 if (session->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Jerry Yu21092062022-10-10 21:21:31 +08001747 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
Gilles Peskine449bd832023-01-11 14:50:10 +01001748 mbedtls_ssl_ciphersuite_from_id(session->ciphersuite);
Jerry Yu21092062022-10-10 21:21:31 +08001749
Gilles Peskine449bd832023-01-11 14:50:10 +01001750 if (mbedtls_ssl_validate_ciphersuite(
Jerry Yu21092062022-10-10 21:21:31 +08001751 ssl, ciphersuite_info, MBEDTLS_SSL_VERSION_TLS1_3,
Gilles Peskine449bd832023-01-11 14:50:10 +01001752 MBEDTLS_SSL_VERSION_TLS1_3) != 0) {
1753 MBEDTLS_SSL_DEBUG_MSG(4, ("%d is not a valid TLS 1.3 ciphersuite.",
1754 session->ciphersuite));
1755 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jerry Yu21092062022-10-10 21:21:31 +08001756 }
Jerry Yu40afab62022-10-08 10:42:13 +08001757 }
Jerry Yu21092062022-10-10 21:21:31 +08001758#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yu40afab62022-10-08 10:42:13 +08001759
Gilles Peskine449bd832023-01-11 14:50:10 +01001760 if ((ret = mbedtls_ssl_session_copy(ssl->session_negotiate,
1761 session)) != 0) {
1762 return ret;
1763 }
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001764
Paul Bakker0a597072012-09-25 21:55:46 +00001765 ssl->handshake->resume = 1;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001766
Gilles Peskine449bd832023-01-11 14:50:10 +01001767 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00001768}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001769#endif /* MBEDTLS_SSL_CLI_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00001770
Gilles Peskine449bd832023-01-11 14:50:10 +01001771void mbedtls_ssl_conf_ciphersuites(mbedtls_ssl_config *conf,
1772 const int *ciphersuites)
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001773{
Hanno Beckerd60b6c62021-04-29 12:04:11 +01001774 conf->ciphersuite_list = ciphersuites;
Paul Bakker5121ce52009-01-03 21:22:43 +00001775}
1776
Ronald Cron6f135e12021-12-08 16:57:54 +01001777#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01001778void mbedtls_ssl_conf_tls13_key_exchange_modes(mbedtls_ssl_config *conf,
1779 const int kex_modes)
Hanno Becker71f1ed62021-07-24 06:01:47 +01001780{
Xiaofei Bai746f9482021-11-12 08:53:56 +00001781 conf->tls13_kex_modes = kex_modes & MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_ALL;
Hanno Becker71f1ed62021-07-24 06:01:47 +01001782}
Xiaokang Qian72de95d2022-10-25 02:54:33 +00001783
1784#if defined(MBEDTLS_SSL_EARLY_DATA)
Yanray Wangd5ed36f2023-11-07 11:40:43 +08001785void mbedtls_ssl_conf_early_data(mbedtls_ssl_config *conf,
1786 int early_data_enabled)
Xiaokang Qian72de95d2022-10-25 02:54:33 +00001787{
1788 conf->early_data_enabled = early_data_enabled;
1789}
Jerry Yucc4e0072022-11-22 17:22:22 +08001790
1791#if defined(MBEDTLS_SSL_SRV_C)
Yanray Wang07517612023-11-07 11:47:36 +08001792void mbedtls_ssl_conf_max_early_data_size(
Gilles Peskine449bd832023-01-11 14:50:10 +01001793 mbedtls_ssl_config *conf, uint32_t max_early_data_size)
Jerry Yucc4e0072022-11-22 17:22:22 +08001794{
Jerry Yu39da9852022-12-06 16:58:36 +08001795 conf->max_early_data_size = max_early_data_size;
Jerry Yucc4e0072022-11-22 17:22:22 +08001796}
1797#endif /* MBEDTLS_SSL_SRV_C */
1798
Xiaokang Qian72de95d2022-10-25 02:54:33 +00001799#endif /* MBEDTLS_SSL_EARLY_DATA */
Ronald Cron6f135e12021-12-08 16:57:54 +01001800#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker71f1ed62021-07-24 06:01:47 +01001801
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001802#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001803void mbedtls_ssl_conf_cert_profile(mbedtls_ssl_config *conf,
1804 const mbedtls_x509_crt_profile *profile)
Manuel Pégourié-Gonnard6e3ee3a2015-06-17 10:58:20 +02001805{
1806 conf->cert_profile = profile;
1807}
1808
Gilles Peskine449bd832023-01-11 14:50:10 +01001809static void ssl_key_cert_free(mbedtls_ssl_key_cert *key_cert)
Glenn Strauss36872db2022-01-22 05:06:31 -05001810{
1811 mbedtls_ssl_key_cert *cur = key_cert, *next;
1812
Gilles Peskine449bd832023-01-11 14:50:10 +01001813 while (cur != NULL) {
Glenn Strauss36872db2022-01-22 05:06:31 -05001814 next = cur->next;
Gilles Peskine449bd832023-01-11 14:50:10 +01001815 mbedtls_free(cur);
Glenn Strauss36872db2022-01-22 05:06:31 -05001816 cur = next;
1817 }
1818}
1819
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001820/* Append a new keycert entry to a (possibly empty) list */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001821MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001822static int ssl_append_key_cert(mbedtls_ssl_key_cert **head,
1823 mbedtls_x509_crt *cert,
1824 mbedtls_pk_context *key)
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001825{
niisato8ee24222018-06-25 19:05:48 +09001826 mbedtls_ssl_key_cert *new_cert;
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001827
Gilles Peskine449bd832023-01-11 14:50:10 +01001828 if (cert == NULL) {
Glenn Strauss36872db2022-01-22 05:06:31 -05001829 /* Free list if cert is null */
Gilles Peskine449bd832023-01-11 14:50:10 +01001830 ssl_key_cert_free(*head);
Glenn Strauss36872db2022-01-22 05:06:31 -05001831 *head = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01001832 return 0;
Glenn Strauss36872db2022-01-22 05:06:31 -05001833 }
1834
Gilles Peskine449bd832023-01-11 14:50:10 +01001835 new_cert = mbedtls_calloc(1, sizeof(mbedtls_ssl_key_cert));
1836 if (new_cert == NULL) {
1837 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
1838 }
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001839
niisato8ee24222018-06-25 19:05:48 +09001840 new_cert->cert = cert;
1841 new_cert->key = key;
1842 new_cert->next = NULL;
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001843
Glenn Strauss36872db2022-01-22 05:06:31 -05001844 /* Update head if the list was null, else add to the end */
Gilles Peskine449bd832023-01-11 14:50:10 +01001845 if (*head == NULL) {
niisato8ee24222018-06-25 19:05:48 +09001846 *head = new_cert;
Gilles Peskine449bd832023-01-11 14:50:10 +01001847 } else {
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001848 mbedtls_ssl_key_cert *cur = *head;
Gilles Peskine449bd832023-01-11 14:50:10 +01001849 while (cur->next != NULL) {
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001850 cur = cur->next;
Gilles Peskine449bd832023-01-11 14:50:10 +01001851 }
niisato8ee24222018-06-25 19:05:48 +09001852 cur->next = new_cert;
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001853 }
1854
Gilles Peskine449bd832023-01-11 14:50:10 +01001855 return 0;
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001856}
1857
Gilles Peskine449bd832023-01-11 14:50:10 +01001858int mbedtls_ssl_conf_own_cert(mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001859 mbedtls_x509_crt *own_cert,
Gilles Peskine449bd832023-01-11 14:50:10 +01001860 mbedtls_pk_context *pk_key)
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001861{
Gilles Peskine449bd832023-01-11 14:50:10 +01001862 return ssl_append_key_cert(&conf->key_cert, own_cert, pk_key);
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001863}
1864
Gilles Peskine449bd832023-01-11 14:50:10 +01001865void mbedtls_ssl_conf_ca_chain(mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01001866 mbedtls_x509_crt *ca_chain,
Gilles Peskine449bd832023-01-11 14:50:10 +01001867 mbedtls_x509_crl *ca_crl)
Paul Bakker5121ce52009-01-03 21:22:43 +00001868{
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01001869 conf->ca_chain = ca_chain;
1870 conf->ca_crl = ca_crl;
Hanno Becker5adaad92019-03-27 16:54:37 +00001871
1872#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
1873 /* mbedtls_ssl_conf_ca_chain() and mbedtls_ssl_conf_ca_cb()
1874 * cannot be used together. */
1875 conf->f_ca_cb = NULL;
1876 conf->p_ca_cb = NULL;
1877#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
Paul Bakker5121ce52009-01-03 21:22:43 +00001878}
Hanno Becker5adaad92019-03-27 16:54:37 +00001879
1880#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
Gilles Peskine449bd832023-01-11 14:50:10 +01001881void mbedtls_ssl_conf_ca_cb(mbedtls_ssl_config *conf,
1882 mbedtls_x509_crt_ca_cb_t f_ca_cb,
1883 void *p_ca_cb)
Hanno Becker5adaad92019-03-27 16:54:37 +00001884{
1885 conf->f_ca_cb = f_ca_cb;
1886 conf->p_ca_cb = p_ca_cb;
1887
1888 /* mbedtls_ssl_conf_ca_chain() and mbedtls_ssl_conf_ca_cb()
1889 * cannot be used together. */
1890 conf->ca_chain = NULL;
1891 conf->ca_crl = NULL;
1892}
1893#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001894#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkereb2c6582012-09-27 19:15:01 +00001895
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001896#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01001897const unsigned char *mbedtls_ssl_get_hs_sni(mbedtls_ssl_context *ssl,
1898 size_t *name_len)
Glenn Strauss69894072022-01-24 12:58:00 -05001899{
1900 *name_len = ssl->handshake->sni_name_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01001901 return ssl->handshake->sni_name;
Glenn Strauss69894072022-01-24 12:58:00 -05001902}
1903
Gilles Peskine449bd832023-01-11 14:50:10 +01001904int mbedtls_ssl_set_hs_own_cert(mbedtls_ssl_context *ssl,
1905 mbedtls_x509_crt *own_cert,
1906 mbedtls_pk_context *pk_key)
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001907{
Gilles Peskine449bd832023-01-11 14:50:10 +01001908 return ssl_append_key_cert(&ssl->handshake->sni_key_cert,
1909 own_cert, pk_key);
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001910}
Manuel Pégourié-Gonnard22bfa4b2015-05-11 08:46:37 +02001911
Gilles Peskine449bd832023-01-11 14:50:10 +01001912void mbedtls_ssl_set_hs_ca_chain(mbedtls_ssl_context *ssl,
1913 mbedtls_x509_crt *ca_chain,
1914 mbedtls_x509_crl *ca_crl)
Manuel Pégourié-Gonnard22bfa4b2015-05-11 08:46:37 +02001915{
1916 ssl->handshake->sni_ca_chain = ca_chain;
1917 ssl->handshake->sni_ca_crl = ca_crl;
1918}
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +02001919
Glenn Strauss999ef702022-03-11 01:37:23 -05001920#if defined(MBEDTLS_KEY_EXCHANGE_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01001921void mbedtls_ssl_set_hs_dn_hints(mbedtls_ssl_context *ssl,
1922 const mbedtls_x509_crt *crt)
Glenn Strauss999ef702022-03-11 01:37:23 -05001923{
1924 ssl->handshake->dn_hints = crt;
1925}
1926#endif /* MBEDTLS_KEY_EXCHANGE_CERT_REQ_ALLOWED_ENABLED */
1927
Gilles Peskine449bd832023-01-11 14:50:10 +01001928void mbedtls_ssl_set_hs_authmode(mbedtls_ssl_context *ssl,
1929 int authmode)
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +02001930{
1931 ssl->handshake->sni_authmode = authmode;
1932}
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001933#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
1934
Hanno Becker8927c832019-04-03 12:52:50 +01001935#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001936void mbedtls_ssl_set_verify(mbedtls_ssl_context *ssl,
1937 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *),
1938 void *p_vrfy)
Hanno Becker8927c832019-04-03 12:52:50 +01001939{
1940 ssl->f_vrfy = f_vrfy;
1941 ssl->p_vrfy = p_vrfy;
1942}
1943#endif
1944
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02001945#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02001946
Valerio Setti016f6822022-12-09 14:17:50 +01001947#if defined(MBEDTLS_USE_PSA_CRYPTO)
Przemek Stekielfde11282023-03-13 16:06:09 +01001948static const uint8_t jpake_server_id[] = { 's', 'e', 'r', 'v', 'e', 'r' };
1949static const uint8_t jpake_client_id[] = { 'c', 'l', 'i', 'e', 'n', 't' };
1950
Valerio Setti016f6822022-12-09 14:17:50 +01001951static psa_status_t mbedtls_ssl_set_hs_ecjpake_password_common(
Gilles Peskine449bd832023-01-11 14:50:10 +01001952 mbedtls_ssl_context *ssl,
1953 mbedtls_svc_key_id_t pwd)
Valerio Setti016f6822022-12-09 14:17:50 +01001954{
1955 psa_status_t status;
Valerio Setti016f6822022-12-09 14:17:50 +01001956 psa_pake_cipher_suite_t cipher_suite = psa_pake_cipher_suite_init();
Przemek Stekielfde11282023-03-13 16:06:09 +01001957 const uint8_t *user = NULL;
Przemek Stekiel4cd20312023-03-01 11:11:28 +01001958 size_t user_len = 0;
Przemek Stekielfde11282023-03-13 16:06:09 +01001959 const uint8_t *peer = NULL;
Przemek Stekiel4cd20312023-03-01 11:11:28 +01001960 size_t peer_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01001961 psa_pake_cs_set_algorithm(&cipher_suite, PSA_ALG_JPAKE);
1962 psa_pake_cs_set_primitive(&cipher_suite,
1963 PSA_PAKE_PRIMITIVE(PSA_PAKE_PRIMITIVE_TYPE_ECC,
1964 PSA_ECC_FAMILY_SECP_R1,
1965 256));
1966 psa_pake_cs_set_hash(&cipher_suite, PSA_ALG_SHA_256);
Valerio Setti016f6822022-12-09 14:17:50 +01001967
Gilles Peskine449bd832023-01-11 14:50:10 +01001968 status = psa_pake_setup(&ssl->handshake->psa_pake_ctx, &cipher_suite);
1969 if (status != PSA_SUCCESS) {
Valerio Setti016f6822022-12-09 14:17:50 +01001970 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001971 }
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02001972
Gilles Peskine449bd832023-01-11 14:50:10 +01001973 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Przemek Stekielfde11282023-03-13 16:06:09 +01001974 user = jpake_server_id;
1975 user_len = sizeof(jpake_server_id);
1976 peer = jpake_client_id;
1977 peer_len = sizeof(jpake_client_id);
Gilles Peskine449bd832023-01-11 14:50:10 +01001978 } else {
Przemek Stekielfde11282023-03-13 16:06:09 +01001979 user = jpake_client_id;
1980 user_len = sizeof(jpake_client_id);
1981 peer = jpake_server_id;
1982 peer_len = sizeof(jpake_server_id);
Gilles Peskine449bd832023-01-11 14:50:10 +01001983 }
Neil Armstrongca7d5062022-05-31 14:43:23 +02001984
Przemek Stekiel4cd20312023-03-01 11:11:28 +01001985 status = psa_pake_set_user(&ssl->handshake->psa_pake_ctx, user, user_len);
1986 if (status != PSA_SUCCESS) {
1987 return status;
1988 }
1989
1990 status = psa_pake_set_peer(&ssl->handshake->psa_pake_ctx, peer, peer_len);
Gilles Peskine449bd832023-01-11 14:50:10 +01001991 if (status != PSA_SUCCESS) {
Valerio Setti016f6822022-12-09 14:17:50 +01001992 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001993 }
Valerio Setti016f6822022-12-09 14:17:50 +01001994
Gilles Peskine449bd832023-01-11 14:50:10 +01001995 status = psa_pake_set_password_key(&ssl->handshake->psa_pake_ctx, pwd);
1996 if (status != PSA_SUCCESS) {
Valerio Setti016f6822022-12-09 14:17:50 +01001997 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001998 }
Valerio Setti016f6822022-12-09 14:17:50 +01001999
2000 ssl->handshake->psa_pake_ctx_is_ok = 1;
2001
Gilles Peskine449bd832023-01-11 14:50:10 +01002002 return PSA_SUCCESS;
Valerio Setti016f6822022-12-09 14:17:50 +01002003}
2004
Gilles Peskine449bd832023-01-11 14:50:10 +01002005int mbedtls_ssl_set_hs_ecjpake_password(mbedtls_ssl_context *ssl,
2006 const unsigned char *pw,
2007 size_t pw_len)
Valerio Setti016f6822022-12-09 14:17:50 +01002008{
2009 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
2010 psa_status_t status;
2011
Gilles Peskine449bd832023-01-11 14:50:10 +01002012 if (ssl->handshake == NULL || ssl->conf == NULL) {
2013 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Neil Armstrongca7d5062022-05-31 14:43:23 +02002014 }
2015
Gilles Peskine449bd832023-01-11 14:50:10 +01002016 /* Empty password is not valid */
2017 if ((pw == NULL) || (pw_len == 0)) {
2018 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2019 }
2020
2021 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_DERIVE);
2022 psa_set_key_algorithm(&attributes, PSA_ALG_JPAKE);
2023 psa_set_key_type(&attributes, PSA_KEY_TYPE_PASSWORD);
2024
2025 status = psa_import_key(&attributes, pw, pw_len,
2026 &ssl->handshake->psa_pake_password);
2027 if (status != PSA_SUCCESS) {
2028 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
2029 }
2030
2031 status = mbedtls_ssl_set_hs_ecjpake_password_common(ssl,
2032 ssl->handshake->psa_pake_password);
2033 if (status != PSA_SUCCESS) {
2034 psa_destroy_key(ssl->handshake->psa_pake_password);
2035 psa_pake_abort(&ssl->handshake->psa_pake_ctx);
2036 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
2037 }
2038
2039 return 0;
Valerio Setti02c25b52022-11-15 14:08:42 +01002040}
Valerio Settia9a97dc2022-11-28 18:26:16 +01002041
Gilles Peskine449bd832023-01-11 14:50:10 +01002042int mbedtls_ssl_set_hs_ecjpake_password_opaque(mbedtls_ssl_context *ssl,
2043 mbedtls_svc_key_id_t pwd)
Valerio Settia9a97dc2022-11-28 18:26:16 +01002044{
Valerio Settia9a97dc2022-11-28 18:26:16 +01002045 psa_status_t status;
2046
Gilles Peskine449bd832023-01-11 14:50:10 +01002047 if (ssl->handshake == NULL || ssl->conf == NULL) {
2048 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Neil Armstrongca7d5062022-05-31 14:43:23 +02002049 }
2050
Gilles Peskine449bd832023-01-11 14:50:10 +01002051 if (mbedtls_svc_key_id_is_null(pwd)) {
2052 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2053 }
2054
2055 status = mbedtls_ssl_set_hs_ecjpake_password_common(ssl, pwd);
2056 if (status != PSA_SUCCESS) {
2057 psa_pake_abort(&ssl->handshake->psa_pake_ctx);
2058 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
2059 }
2060
2061 return 0;
Valerio Setti02c25b52022-11-15 14:08:42 +01002062}
2063#else /* MBEDTLS_USE_PSA_CRYPTO */
Gilles Peskine449bd832023-01-11 14:50:10 +01002064int mbedtls_ssl_set_hs_ecjpake_password(mbedtls_ssl_context *ssl,
2065 const unsigned char *pw,
2066 size_t pw_len)
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002067{
2068 mbedtls_ecjpake_role role;
2069
Gilles Peskine449bd832023-01-11 14:50:10 +01002070 if (ssl->handshake == NULL || ssl->conf == NULL) {
2071 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2072 }
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002073
Valerio Settic689ed82022-12-07 14:40:38 +01002074 /* Empty password is not valid */
Gilles Peskine449bd832023-01-11 14:50:10 +01002075 if ((pw == NULL) || (pw_len == 0)) {
2076 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2077 }
Valerio Settic689ed82022-12-07 14:40:38 +01002078
Gilles Peskine449bd832023-01-11 14:50:10 +01002079 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002080 role = MBEDTLS_ECJPAKE_SERVER;
Gilles Peskine449bd832023-01-11 14:50:10 +01002081 } else {
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002082 role = MBEDTLS_ECJPAKE_CLIENT;
Gilles Peskine449bd832023-01-11 14:50:10 +01002083 }
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002084
Gilles Peskine449bd832023-01-11 14:50:10 +01002085 return mbedtls_ecjpake_setup(&ssl->handshake->ecjpake_ctx,
2086 role,
2087 MBEDTLS_MD_SHA256,
2088 MBEDTLS_ECP_DP_SECP256R1,
2089 pw, pw_len);
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002090}
Valerio Setti02c25b52022-11-15 14:08:42 +01002091#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02002092#endif /* MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED */
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002093
Ronald Cron73fe8df2022-10-05 14:31:43 +02002094#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01002095int mbedtls_ssl_conf_has_static_psk(mbedtls_ssl_config const *conf)
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002096{
Gilles Peskine449bd832023-01-11 14:50:10 +01002097 if (conf->psk_identity == NULL ||
2098 conf->psk_identity_len == 0) {
2099 return 0;
Ronald Crond29e13e2022-10-19 10:33:48 +02002100 }
2101
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002102#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01002103 if (!mbedtls_svc_key_id_is_null(conf->psk_opaque)) {
2104 return 1;
2105 }
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002106#endif /* MBEDTLS_USE_PSA_CRYPTO */
Ronald Crond29e13e2022-10-19 10:33:48 +02002107
Gilles Peskine449bd832023-01-11 14:50:10 +01002108 if (conf->psk != NULL && conf->psk_len != 0) {
2109 return 1;
2110 }
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002111
Gilles Peskine449bd832023-01-11 14:50:10 +01002112 return 0;
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002113}
2114
Gilles Peskine449bd832023-01-11 14:50:10 +01002115static void ssl_conf_remove_psk(mbedtls_ssl_config *conf)
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002116{
2117 /* Remove reference to existing PSK, if any. */
2118#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01002119 if (!mbedtls_svc_key_id_is_null(conf->psk_opaque)) {
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002120 /* The maintenance of the PSK key slot is the
2121 * user's responsibility. */
Ronald Croncf56a0a2020-08-04 09:51:30 +02002122 conf->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002123 }
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002124#endif /* MBEDTLS_USE_PSA_CRYPTO */
Gilles Peskine449bd832023-01-11 14:50:10 +01002125 if (conf->psk != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01002126 mbedtls_zeroize_and_free(conf->psk, conf->psk_len);
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002127 conf->psk = NULL;
2128 conf->psk_len = 0;
2129 }
2130
2131 /* Remove reference to PSK identity, if any. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002132 if (conf->psk_identity != NULL) {
2133 mbedtls_free(conf->psk_identity);
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002134 conf->psk_identity = NULL;
2135 conf->psk_identity_len = 0;
2136 }
2137}
2138
Hanno Becker7390c712018-11-15 13:33:04 +00002139/* This function assumes that PSK identity in the SSL config is unset.
2140 * It checks that the provided identity is well-formed and attempts
2141 * to make a copy of it in the SSL config.
2142 * On failure, the PSK identity in the config remains unset. */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002143MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002144static int ssl_conf_set_psk_identity(mbedtls_ssl_config *conf,
2145 unsigned char const *psk_identity,
2146 size_t psk_identity_len)
Paul Bakkerd4a56ec2013-04-16 18:05:29 +02002147{
Manuel Pégourié-Gonnardc6b5d832015-08-27 16:37:35 +02002148 /* Identity len will be encoded on two bytes */
Gilles Peskine449bd832023-01-11 14:50:10 +01002149 if (psk_identity == NULL ||
Ronald Cron2a87e9b2022-10-19 10:55:26 +02002150 psk_identity_len == 0 ||
Gilles Peskine449bd832023-01-11 14:50:10 +01002151 (psk_identity_len >> 16) != 0 ||
2152 psk_identity_len > MBEDTLS_SSL_OUT_CONTENT_LEN) {
2153 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnardc6b5d832015-08-27 16:37:35 +02002154 }
2155
Gilles Peskine449bd832023-01-11 14:50:10 +01002156 conf->psk_identity = mbedtls_calloc(1, psk_identity_len);
2157 if (conf->psk_identity == NULL) {
2158 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
2159 }
Paul Bakker6db455e2013-09-18 17:29:31 +02002160
Manuel Pégourié-Gonnard120fdbd2015-05-07 17:07:50 +01002161 conf->psk_identity_len = psk_identity_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01002162 memcpy(conf->psk_identity, psk_identity, conf->psk_identity_len);
Paul Bakker5ad403f2013-09-18 21:21:30 +02002163
Gilles Peskine449bd832023-01-11 14:50:10 +01002164 return 0;
Paul Bakker6db455e2013-09-18 17:29:31 +02002165}
2166
Gilles Peskine449bd832023-01-11 14:50:10 +01002167int mbedtls_ssl_conf_psk(mbedtls_ssl_config *conf,
2168 const unsigned char *psk, size_t psk_len,
2169 const unsigned char *psk_identity, size_t psk_identity_len)
Hanno Becker7390c712018-11-15 13:33:04 +00002170{
Janos Follath865b3eb2019-12-16 11:46:15 +00002171 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002172
2173 /* We currently only support one PSK, raw or opaque. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002174 if (mbedtls_ssl_conf_has_static_psk(conf)) {
2175 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
2176 }
Hanno Becker7390c712018-11-15 13:33:04 +00002177
2178 /* Check and set raw PSK */
Gilles Peskine449bd832023-01-11 14:50:10 +01002179 if (psk == NULL) {
2180 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2181 }
2182 if (psk_len == 0) {
2183 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2184 }
2185 if (psk_len > MBEDTLS_PSK_MAX_LEN) {
2186 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2187 }
Piotr Nowicki9926eaf2019-11-20 14:54:36 +01002188
Gilles Peskine449bd832023-01-11 14:50:10 +01002189 if ((conf->psk = mbedtls_calloc(1, psk_len)) == NULL) {
2190 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
2191 }
Hanno Becker7390c712018-11-15 13:33:04 +00002192 conf->psk_len = psk_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01002193 memcpy(conf->psk, psk, conf->psk_len);
Hanno Becker7390c712018-11-15 13:33:04 +00002194
2195 /* Check and set PSK Identity */
Gilles Peskine449bd832023-01-11 14:50:10 +01002196 ret = ssl_conf_set_psk_identity(conf, psk_identity, psk_identity_len);
2197 if (ret != 0) {
2198 ssl_conf_remove_psk(conf);
2199 }
Hanno Becker7390c712018-11-15 13:33:04 +00002200
Gilles Peskine449bd832023-01-11 14:50:10 +01002201 return ret;
Hanno Becker7390c712018-11-15 13:33:04 +00002202}
2203
Gilles Peskine449bd832023-01-11 14:50:10 +01002204static void ssl_remove_psk(mbedtls_ssl_context *ssl)
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002205{
2206#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01002207 if (!mbedtls_svc_key_id_is_null(ssl->handshake->psk_opaque)) {
Neil Armstrong501c9322022-05-03 09:35:09 +02002208 /* The maintenance of the external PSK key slot is the
2209 * user's responsibility. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002210 if (ssl->handshake->psk_opaque_is_internal) {
2211 psa_destroy_key(ssl->handshake->psk_opaque);
Neil Armstrong501c9322022-05-03 09:35:09 +02002212 ssl->handshake->psk_opaque_is_internal = 0;
2213 }
Ronald Croncf56a0a2020-08-04 09:51:30 +02002214 ssl->handshake->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002215 }
Neil Armstronge952a302022-05-03 10:22:14 +02002216#else
Gilles Peskine449bd832023-01-11 14:50:10 +01002217 if (ssl->handshake->psk != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01002218 mbedtls_zeroize_and_free(ssl->handshake->psk,
Gilles Peskine449bd832023-01-11 14:50:10 +01002219 ssl->handshake->psk_len);
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002220 ssl->handshake->psk_len = 0;
2221 }
Neil Armstronge952a302022-05-03 10:22:14 +02002222#endif /* MBEDTLS_USE_PSA_CRYPTO */
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002223}
2224
Gilles Peskine449bd832023-01-11 14:50:10 +01002225int mbedtls_ssl_set_hs_psk(mbedtls_ssl_context *ssl,
2226 const unsigned char *psk, size_t psk_len)
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002227{
Neil Armstrong501c9322022-05-03 09:35:09 +02002228#if defined(MBEDTLS_USE_PSA_CRYPTO)
2229 psa_key_attributes_t key_attributes = psa_key_attributes_init();
Jerry Yu5d01c052022-08-17 10:18:10 +08002230 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Jerry Yu24b8c812022-08-20 19:06:56 +08002231 psa_algorithm_t alg = PSA_ALG_NONE;
Jerry Yu5d01c052022-08-17 10:18:10 +08002232 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Neil Armstrong501c9322022-05-03 09:35:09 +02002233#endif /* MBEDTLS_USE_PSA_CRYPTO */
2234
Gilles Peskine449bd832023-01-11 14:50:10 +01002235 if (psk == NULL || ssl->handshake == NULL) {
2236 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2237 }
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002238
Gilles Peskine449bd832023-01-11 14:50:10 +01002239 if (psk_len > MBEDTLS_PSK_MAX_LEN) {
2240 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2241 }
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002242
Gilles Peskine449bd832023-01-11 14:50:10 +01002243 ssl_remove_psk(ssl);
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002244
Neil Armstrong501c9322022-05-03 09:35:09 +02002245#if defined(MBEDTLS_USE_PSA_CRYPTO)
Jerry Yuccc68a42022-07-26 16:39:20 +08002246#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01002247 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_2) {
2248 if (ssl->handshake->ciphersuite_info->mac == MBEDTLS_MD_SHA384) {
2249 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_384);
2250 } else {
2251 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_256);
2252 }
2253 psa_set_key_usage_flags(&key_attributes, PSA_KEY_USAGE_DERIVE);
Jerry Yuccc68a42022-07-26 16:39:20 +08002254 }
2255#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Neil Armstrong501c9322022-05-03 09:35:09 +02002256
Jerry Yu568ec252022-07-22 21:27:34 +08002257#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01002258 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
2259 alg = PSA_ALG_HKDF_EXTRACT(PSA_ALG_ANY_HASH);
2260 psa_set_key_usage_flags(&key_attributes,
2261 PSA_KEY_USAGE_DERIVE | PSA_KEY_USAGE_EXPORT);
Jerry Yuccc68a42022-07-26 16:39:20 +08002262 }
2263#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
2264
Gilles Peskine449bd832023-01-11 14:50:10 +01002265 psa_set_key_algorithm(&key_attributes, alg);
2266 psa_set_key_type(&key_attributes, PSA_KEY_TYPE_DERIVE);
Neil Armstrong501c9322022-05-03 09:35:09 +02002267
Gilles Peskine449bd832023-01-11 14:50:10 +01002268 status = psa_import_key(&key_attributes, psk, psk_len, &key);
2269 if (status != PSA_SUCCESS) {
2270 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
2271 }
Neil Armstrong501c9322022-05-03 09:35:09 +02002272
2273 /* Allow calling psa_destroy_key() on psk remove */
2274 ssl->handshake->psk_opaque_is_internal = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01002275 return mbedtls_ssl_set_hs_psk_opaque(ssl, key);
Neil Armstrong501c9322022-05-03 09:35:09 +02002276#else
Gilles Peskine449bd832023-01-11 14:50:10 +01002277 if ((ssl->handshake->psk = mbedtls_calloc(1, psk_len)) == NULL) {
2278 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
2279 }
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002280
2281 ssl->handshake->psk_len = psk_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01002282 memcpy(ssl->handshake->psk, psk, ssl->handshake->psk_len);
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002283
Gilles Peskine449bd832023-01-11 14:50:10 +01002284 return 0;
Neil Armstrong501c9322022-05-03 09:35:09 +02002285#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002286}
2287
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002288#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01002289int mbedtls_ssl_conf_psk_opaque(mbedtls_ssl_config *conf,
2290 mbedtls_svc_key_id_t psk,
2291 const unsigned char *psk_identity,
2292 size_t psk_identity_len)
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002293{
Janos Follath865b3eb2019-12-16 11:46:15 +00002294 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002295
2296 /* We currently only support one PSK, raw or opaque. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002297 if (mbedtls_ssl_conf_has_static_psk(conf)) {
2298 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
2299 }
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002300
Hanno Becker7390c712018-11-15 13:33:04 +00002301 /* Check and set opaque PSK */
Gilles Peskine449bd832023-01-11 14:50:10 +01002302 if (mbedtls_svc_key_id_is_null(psk)) {
2303 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2304 }
Ronald Croncf56a0a2020-08-04 09:51:30 +02002305 conf->psk_opaque = psk;
Hanno Becker7390c712018-11-15 13:33:04 +00002306
2307 /* Check and set PSK Identity */
Gilles Peskine449bd832023-01-11 14:50:10 +01002308 ret = ssl_conf_set_psk_identity(conf, psk_identity,
2309 psk_identity_len);
2310 if (ret != 0) {
2311 ssl_conf_remove_psk(conf);
2312 }
Hanno Becker7390c712018-11-15 13:33:04 +00002313
Gilles Peskine449bd832023-01-11 14:50:10 +01002314 return ret;
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002315}
2316
Gilles Peskine449bd832023-01-11 14:50:10 +01002317int mbedtls_ssl_set_hs_psk_opaque(mbedtls_ssl_context *ssl,
2318 mbedtls_svc_key_id_t psk)
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002319{
Gilles Peskine449bd832023-01-11 14:50:10 +01002320 if ((mbedtls_svc_key_id_is_null(psk)) ||
2321 (ssl->handshake == NULL)) {
2322 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2323 }
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002324
Gilles Peskine449bd832023-01-11 14:50:10 +01002325 ssl_remove_psk(ssl);
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002326 ssl->handshake->psk_opaque = psk;
Gilles Peskine449bd832023-01-11 14:50:10 +01002327 return 0;
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002328}
2329#endif /* MBEDTLS_USE_PSA_CRYPTO */
2330
Jerry Yu8897c072022-08-12 13:56:53 +08002331#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002332void mbedtls_ssl_conf_psk_cb(mbedtls_ssl_config *conf,
2333 int (*f_psk)(void *, mbedtls_ssl_context *, const unsigned char *,
2334 size_t),
2335 void *p_psk)
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002336{
2337 conf->f_psk = f_psk;
2338 conf->p_psk = p_psk;
2339}
Jerry Yu8897c072022-08-12 13:56:53 +08002340#endif /* MBEDTLS_SSL_SRV_C */
2341
Ronald Cron73fe8df2022-10-05 14:31:43 +02002342#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED */
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002343
2344#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine301711e2022-04-26 16:57:05 +02002345static mbedtls_ssl_mode_t mbedtls_ssl_get_base_mode(
Gilles Peskine449bd832023-01-11 14:50:10 +01002346 psa_algorithm_t alg)
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002347{
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002348#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01002349 if (alg == PSA_ALG_CBC_NO_PADDING) {
2350 return MBEDTLS_SSL_MODE_CBC;
2351 }
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002352#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
Gilles Peskine449bd832023-01-11 14:50:10 +01002353 if (PSA_ALG_IS_AEAD(alg)) {
2354 return MBEDTLS_SSL_MODE_AEAD;
2355 }
2356 return MBEDTLS_SSL_MODE_STREAM;
Gilles Peskine301711e2022-04-26 16:57:05 +02002357}
2358
2359#else /* MBEDTLS_USE_PSA_CRYPTO */
2360
2361static mbedtls_ssl_mode_t mbedtls_ssl_get_base_mode(
Gilles Peskine449bd832023-01-11 14:50:10 +01002362 mbedtls_cipher_mode_t mode)
Gilles Peskine301711e2022-04-26 16:57:05 +02002363{
2364#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01002365 if (mode == MBEDTLS_MODE_CBC) {
2366 return MBEDTLS_SSL_MODE_CBC;
2367 }
Gilles Peskine301711e2022-04-26 16:57:05 +02002368#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
2369
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002370#if defined(MBEDTLS_GCM_C) || \
2371 defined(MBEDTLS_CCM_C) || \
2372 defined(MBEDTLS_CHACHAPOLY_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002373 if (mode == MBEDTLS_MODE_GCM ||
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002374 mode == MBEDTLS_MODE_CCM ||
Gilles Peskine449bd832023-01-11 14:50:10 +01002375 mode == MBEDTLS_MODE_CHACHAPOLY) {
2376 return MBEDTLS_SSL_MODE_AEAD;
2377 }
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002378#endif /* MBEDTLS_GCM_C || MBEDTLS_CCM_C || MBEDTLS_CHACHAPOLY_C */
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002379
Gilles Peskine449bd832023-01-11 14:50:10 +01002380 return MBEDTLS_SSL_MODE_STREAM;
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002381}
Gilles Peskine301711e2022-04-26 16:57:05 +02002382#endif /* MBEDTLS_USE_PSA_CRYPTO */
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002383
Gilles Peskinee108d982022-04-26 16:50:40 +02002384static mbedtls_ssl_mode_t mbedtls_ssl_get_actual_mode(
2385 mbedtls_ssl_mode_t base_mode,
Gilles Peskine449bd832023-01-11 14:50:10 +01002386 int encrypt_then_mac)
Gilles Peskinee108d982022-04-26 16:50:40 +02002387{
2388#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01002389 if (encrypt_then_mac == MBEDTLS_SSL_ETM_ENABLED &&
2390 base_mode == MBEDTLS_SSL_MODE_CBC) {
2391 return MBEDTLS_SSL_MODE_CBC_ETM;
Gilles Peskinee108d982022-04-26 16:50:40 +02002392 }
2393#else
2394 (void) encrypt_then_mac;
2395#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002396 return base_mode;
Gilles Peskinee108d982022-04-26 16:50:40 +02002397}
2398
Neil Armstrongab555e02022-04-04 11:07:59 +02002399mbedtls_ssl_mode_t mbedtls_ssl_get_mode_from_transform(
Gilles Peskine449bd832023-01-11 14:50:10 +01002400 const mbedtls_ssl_transform *transform)
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002401{
Gilles Peskinee108d982022-04-26 16:50:40 +02002402 mbedtls_ssl_mode_t base_mode = mbedtls_ssl_get_base_mode(
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002403#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01002404 transform->psa_alg
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002405#else
Gilles Peskine449bd832023-01-11 14:50:10 +01002406 mbedtls_cipher_get_cipher_mode(&transform->cipher_ctx_enc)
Gilles Peskinee108d982022-04-26 16:50:40 +02002407#endif
2408 );
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002409
Gilles Peskinee108d982022-04-26 16:50:40 +02002410 int encrypt_then_mac = 0;
Neil Armstrongf2c82f02022-04-05 11:16:53 +02002411#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskinee108d982022-04-26 16:50:40 +02002412 encrypt_then_mac = transform->encrypt_then_mac;
2413#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002414 return mbedtls_ssl_get_actual_mode(base_mode, encrypt_then_mac);
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002415}
2416
Neil Armstrongab555e02022-04-04 11:07:59 +02002417mbedtls_ssl_mode_t mbedtls_ssl_get_mode_from_ciphersuite(
Neil Armstrongf2c82f02022-04-05 11:16:53 +02002418#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01002419 int encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02002420#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01002421 const mbedtls_ssl_ciphersuite_t *suite)
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002422{
Gilles Peskinee108d982022-04-26 16:50:40 +02002423 mbedtls_ssl_mode_t base_mode = MBEDTLS_SSL_MODE_STREAM;
2424
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002425#if defined(MBEDTLS_USE_PSA_CRYPTO)
2426 psa_status_t status;
2427 psa_algorithm_t alg;
2428 psa_key_type_t type;
2429 size_t size;
Dave Rodgman2eab4622023-10-05 13:30:37 +01002430 status = mbedtls_ssl_cipher_to_psa((mbedtls_cipher_type_t) suite->cipher,
2431 0, &alg, &type, &size);
Gilles Peskine449bd832023-01-11 14:50:10 +01002432 if (status == PSA_SUCCESS) {
2433 base_mode = mbedtls_ssl_get_base_mode(alg);
2434 }
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002435#else
2436 const mbedtls_cipher_info_t *cipher =
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01002437 mbedtls_cipher_info_from_type((mbedtls_cipher_type_t) suite->cipher);
Gilles Peskine449bd832023-01-11 14:50:10 +01002438 if (cipher != NULL) {
Gilles Peskinee108d982022-04-26 16:50:40 +02002439 base_mode =
2440 mbedtls_ssl_get_base_mode(
Gilles Peskine449bd832023-01-11 14:50:10 +01002441 mbedtls_cipher_info_get_mode(cipher));
Gilles Peskinee108d982022-04-26 16:50:40 +02002442 }
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002443#endif /* MBEDTLS_USE_PSA_CRYPTO */
2444
Gilles Peskinee108d982022-04-26 16:50:40 +02002445#if !defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
2446 int encrypt_then_mac = 0;
2447#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002448 return mbedtls_ssl_get_actual_mode(base_mode, encrypt_then_mac);
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002449}
2450
Neil Armstrong8395d7a2022-05-18 11:44:56 +02002451#if defined(MBEDTLS_USE_PSA_CRYPTO) || defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yu251a12e2022-07-13 15:15:48 +08002452
Gilles Peskine449bd832023-01-11 14:50:10 +01002453psa_status_t mbedtls_ssl_cipher_to_psa(mbedtls_cipher_type_t mbedtls_cipher_type,
2454 size_t taglen,
2455 psa_algorithm_t *alg,
2456 psa_key_type_t *key_type,
2457 size_t *key_size)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002458{
Yanray Wang19e4dc82023-11-16 18:02:05 +08002459#if !defined(MBEDTLS_SSL_HAVE_CCM)
2460 (void) taglen;
2461#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002462 switch (mbedtls_cipher_type) {
Yanray Wang1a369d62023-11-16 15:17:31 +08002463#if defined(MBEDTLS_SSL_HAVE_AES) && defined(MBEDTLS_SSL_HAVE_CBC)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002464 case MBEDTLS_CIPHER_AES_128_CBC:
2465 *alg = PSA_ALG_CBC_NO_PADDING;
2466 *key_type = PSA_KEY_TYPE_AES;
2467 *key_size = 128;
2468 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002469#endif
2470#if defined(MBEDTLS_SSL_HAVE_AES) && defined(MBEDTLS_SSL_HAVE_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002471 case MBEDTLS_CIPHER_AES_128_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002472 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002473 *key_type = PSA_KEY_TYPE_AES;
2474 *key_size = 128;
2475 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002476#endif
2477#if defined(MBEDTLS_SSL_HAVE_AES) && defined(MBEDTLS_SSL_HAVE_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002478 case MBEDTLS_CIPHER_AES_128_GCM:
2479 *alg = PSA_ALG_GCM;
2480 *key_type = PSA_KEY_TYPE_AES;
2481 *key_size = 128;
2482 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002483#endif
2484#if defined(MBEDTLS_SSL_HAVE_AES) && defined(MBEDTLS_SSL_HAVE_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002485 case MBEDTLS_CIPHER_AES_192_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002486 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002487 *key_type = PSA_KEY_TYPE_AES;
2488 *key_size = 192;
2489 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002490#endif
2491#if defined(MBEDTLS_SSL_HAVE_AES) && defined(MBEDTLS_SSL_HAVE_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002492 case MBEDTLS_CIPHER_AES_192_GCM:
2493 *alg = PSA_ALG_GCM;
2494 *key_type = PSA_KEY_TYPE_AES;
2495 *key_size = 192;
2496 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002497#endif
2498#if defined(MBEDTLS_SSL_HAVE_AES) && defined(MBEDTLS_SSL_HAVE_CBC)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002499 case MBEDTLS_CIPHER_AES_256_CBC:
2500 *alg = PSA_ALG_CBC_NO_PADDING;
2501 *key_type = PSA_KEY_TYPE_AES;
2502 *key_size = 256;
2503 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002504#endif
2505#if defined(MBEDTLS_SSL_HAVE_AES) && defined(MBEDTLS_SSL_HAVE_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002506 case MBEDTLS_CIPHER_AES_256_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002507 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002508 *key_type = PSA_KEY_TYPE_AES;
2509 *key_size = 256;
2510 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002511#endif
2512#if defined(MBEDTLS_SSL_HAVE_AES) && defined(MBEDTLS_SSL_HAVE_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002513 case MBEDTLS_CIPHER_AES_256_GCM:
2514 *alg = PSA_ALG_GCM;
2515 *key_type = PSA_KEY_TYPE_AES;
2516 *key_size = 256;
2517 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002518#endif
2519#if defined(MBEDTLS_SSL_HAVE_ARIA) && defined(MBEDTLS_SSL_HAVE_CBC)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002520 case MBEDTLS_CIPHER_ARIA_128_CBC:
2521 *alg = PSA_ALG_CBC_NO_PADDING;
2522 *key_type = PSA_KEY_TYPE_ARIA;
2523 *key_size = 128;
2524 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002525#endif
2526#if defined(MBEDTLS_SSL_HAVE_ARIA) && defined(MBEDTLS_SSL_HAVE_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002527 case MBEDTLS_CIPHER_ARIA_128_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002528 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002529 *key_type = PSA_KEY_TYPE_ARIA;
2530 *key_size = 128;
2531 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002532#endif
2533#if defined(MBEDTLS_SSL_HAVE_ARIA) && defined(MBEDTLS_SSL_HAVE_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002534 case MBEDTLS_CIPHER_ARIA_128_GCM:
2535 *alg = PSA_ALG_GCM;
2536 *key_type = PSA_KEY_TYPE_ARIA;
2537 *key_size = 128;
2538 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002539#endif
2540#if defined(MBEDTLS_SSL_HAVE_ARIA) && defined(MBEDTLS_SSL_HAVE_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002541 case MBEDTLS_CIPHER_ARIA_192_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002542 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002543 *key_type = PSA_KEY_TYPE_ARIA;
2544 *key_size = 192;
2545 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002546#endif
2547#if defined(MBEDTLS_SSL_HAVE_ARIA) && defined(MBEDTLS_SSL_HAVE_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002548 case MBEDTLS_CIPHER_ARIA_192_GCM:
2549 *alg = PSA_ALG_GCM;
2550 *key_type = PSA_KEY_TYPE_ARIA;
2551 *key_size = 192;
2552 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002553#endif
2554#if defined(MBEDTLS_SSL_HAVE_ARIA) && defined(MBEDTLS_SSL_HAVE_CBC)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002555 case MBEDTLS_CIPHER_ARIA_256_CBC:
2556 *alg = PSA_ALG_CBC_NO_PADDING;
2557 *key_type = PSA_KEY_TYPE_ARIA;
2558 *key_size = 256;
2559 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002560#endif
2561#if defined(MBEDTLS_SSL_HAVE_ARIA) && defined(MBEDTLS_SSL_HAVE_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002562 case MBEDTLS_CIPHER_ARIA_256_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002563 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002564 *key_type = PSA_KEY_TYPE_ARIA;
2565 *key_size = 256;
2566 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002567#endif
2568#if defined(MBEDTLS_SSL_HAVE_ARIA) && defined(MBEDTLS_SSL_HAVE_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002569 case MBEDTLS_CIPHER_ARIA_256_GCM:
2570 *alg = PSA_ALG_GCM;
2571 *key_type = PSA_KEY_TYPE_ARIA;
2572 *key_size = 256;
2573 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002574#endif
2575#if defined(MBEDTLS_SSL_HAVE_CAMELLIA) && defined(MBEDTLS_SSL_HAVE_CBC)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002576 case MBEDTLS_CIPHER_CAMELLIA_128_CBC:
2577 *alg = PSA_ALG_CBC_NO_PADDING;
2578 *key_type = PSA_KEY_TYPE_CAMELLIA;
2579 *key_size = 128;
2580 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002581#endif
2582#if defined(MBEDTLS_SSL_HAVE_CAMELLIA) && defined(MBEDTLS_SSL_HAVE_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002583 case MBEDTLS_CIPHER_CAMELLIA_128_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002584 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002585 *key_type = PSA_KEY_TYPE_CAMELLIA;
2586 *key_size = 128;
2587 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002588#endif
2589#if defined(MBEDTLS_SSL_HAVE_CAMELLIA) && defined(MBEDTLS_SSL_HAVE_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002590 case MBEDTLS_CIPHER_CAMELLIA_128_GCM:
2591 *alg = PSA_ALG_GCM;
2592 *key_type = PSA_KEY_TYPE_CAMELLIA;
2593 *key_size = 128;
2594 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002595#endif
2596#if defined(MBEDTLS_SSL_HAVE_CAMELLIA) && defined(MBEDTLS_SSL_HAVE_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002597 case MBEDTLS_CIPHER_CAMELLIA_192_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002598 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002599 *key_type = PSA_KEY_TYPE_CAMELLIA;
2600 *key_size = 192;
2601 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002602#endif
2603#if defined(MBEDTLS_SSL_HAVE_CAMELLIA) && defined(MBEDTLS_SSL_HAVE_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002604 case MBEDTLS_CIPHER_CAMELLIA_192_GCM:
2605 *alg = PSA_ALG_GCM;
2606 *key_type = PSA_KEY_TYPE_CAMELLIA;
2607 *key_size = 192;
2608 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002609#endif
2610#if defined(MBEDTLS_SSL_HAVE_CAMELLIA) && defined(MBEDTLS_SSL_HAVE_CBC)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002611 case MBEDTLS_CIPHER_CAMELLIA_256_CBC:
2612 *alg = PSA_ALG_CBC_NO_PADDING;
2613 *key_type = PSA_KEY_TYPE_CAMELLIA;
2614 *key_size = 256;
2615 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002616#endif
2617#if defined(MBEDTLS_SSL_HAVE_CAMELLIA) && defined(MBEDTLS_SSL_HAVE_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002618 case MBEDTLS_CIPHER_CAMELLIA_256_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002619 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002620 *key_type = PSA_KEY_TYPE_CAMELLIA;
2621 *key_size = 256;
2622 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002623#endif
2624#if defined(MBEDTLS_SSL_HAVE_CAMELLIA) && defined(MBEDTLS_SSL_HAVE_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002625 case MBEDTLS_CIPHER_CAMELLIA_256_GCM:
2626 *alg = PSA_ALG_GCM;
2627 *key_type = PSA_KEY_TYPE_CAMELLIA;
2628 *key_size = 256;
2629 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002630#endif
2631#if defined(MBEDTLS_SSL_HAVE_CHACHAPOLY)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002632 case MBEDTLS_CIPHER_CHACHA20_POLY1305:
2633 *alg = PSA_ALG_CHACHA20_POLY1305;
2634 *key_type = PSA_KEY_TYPE_CHACHA20;
2635 *key_size = 256;
2636 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002637#endif
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002638 case MBEDTLS_CIPHER_NULL:
2639 *alg = MBEDTLS_SSL_NULL_CIPHER;
2640 *key_type = 0;
2641 *key_size = 0;
2642 break;
2643 default:
2644 return PSA_ERROR_NOT_SUPPORTED;
2645 }
2646
2647 return PSA_SUCCESS;
2648}
Neil Armstrong8395d7a2022-05-18 11:44:56 +02002649#endif /* MBEDTLS_USE_PSA_CRYPTO || MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002650
Manuel Pégourié-Gonnardcf141ca2015-05-20 10:35:51 +02002651#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002652int mbedtls_ssl_conf_dh_param_bin(mbedtls_ssl_config *conf,
2653 const unsigned char *dhm_P, size_t P_len,
2654 const unsigned char *dhm_G, size_t G_len)
Hanno Beckera90658f2017-10-04 15:29:08 +01002655{
Janos Follath865b3eb2019-12-16 11:46:15 +00002656 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Beckera90658f2017-10-04 15:29:08 +01002657
Gilles Peskine449bd832023-01-11 14:50:10 +01002658 mbedtls_mpi_free(&conf->dhm_P);
2659 mbedtls_mpi_free(&conf->dhm_G);
Glenn Strausscee11292021-12-20 01:43:17 -05002660
Gilles Peskine449bd832023-01-11 14:50:10 +01002661 if ((ret = mbedtls_mpi_read_binary(&conf->dhm_P, dhm_P, P_len)) != 0 ||
2662 (ret = mbedtls_mpi_read_binary(&conf->dhm_G, dhm_G, G_len)) != 0) {
2663 mbedtls_mpi_free(&conf->dhm_P);
2664 mbedtls_mpi_free(&conf->dhm_G);
2665 return ret;
Hanno Beckera90658f2017-10-04 15:29:08 +01002666 }
2667
Gilles Peskine449bd832023-01-11 14:50:10 +01002668 return 0;
Hanno Beckera90658f2017-10-04 15:29:08 +01002669}
Paul Bakker5121ce52009-01-03 21:22:43 +00002670
Gilles Peskine449bd832023-01-11 14:50:10 +01002671int mbedtls_ssl_conf_dh_param_ctx(mbedtls_ssl_config *conf, mbedtls_dhm_context *dhm_ctx)
Paul Bakker1b57b062011-01-06 15:48:19 +00002672{
Janos Follath865b3eb2019-12-16 11:46:15 +00002673 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker1b57b062011-01-06 15:48:19 +00002674
Gilles Peskine449bd832023-01-11 14:50:10 +01002675 mbedtls_mpi_free(&conf->dhm_P);
2676 mbedtls_mpi_free(&conf->dhm_G);
Glenn Strausscee11292021-12-20 01:43:17 -05002677
Gilles Peskine449bd832023-01-11 14:50:10 +01002678 if ((ret = mbedtls_dhm_get_value(dhm_ctx, MBEDTLS_DHM_PARAM_P,
2679 &conf->dhm_P)) != 0 ||
2680 (ret = mbedtls_dhm_get_value(dhm_ctx, MBEDTLS_DHM_PARAM_G,
2681 &conf->dhm_G)) != 0) {
2682 mbedtls_mpi_free(&conf->dhm_P);
2683 mbedtls_mpi_free(&conf->dhm_G);
2684 return ret;
Manuel Pégourié-Gonnard1028b742015-05-06 17:33:07 +01002685 }
Paul Bakker1b57b062011-01-06 15:48:19 +00002686
Gilles Peskine449bd832023-01-11 14:50:10 +01002687 return 0;
Paul Bakker1b57b062011-01-06 15:48:19 +00002688}
Manuel Pégourié-Gonnardcf141ca2015-05-20 10:35:51 +02002689#endif /* MBEDTLS_DHM_C && MBEDTLS_SSL_SRV_C */
Paul Bakker1b57b062011-01-06 15:48:19 +00002690
Manuel Pégourié-Gonnardbd990d62015-06-11 14:49:42 +02002691#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_CLI_C)
2692/*
2693 * Set the minimum length for Diffie-Hellman parameters
2694 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002695void mbedtls_ssl_conf_dhm_min_bitlen(mbedtls_ssl_config *conf,
2696 unsigned int bitlen)
Manuel Pégourié-Gonnardbd990d62015-06-11 14:49:42 +02002697{
2698 conf->dhm_min_bitlen = bitlen;
2699}
2700#endif /* MBEDTLS_DHM_C && MBEDTLS_SSL_CLI_C */
2701
Ronald Crone68ab4f2022-10-05 12:46:29 +02002702#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu7ddc38c2022-01-19 11:08:05 +08002703#if !defined(MBEDTLS_DEPRECATED_REMOVED) && defined(MBEDTLS_SSL_PROTO_TLS1_2)
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02002704/*
2705 * Set allowed/preferred hashes for handshake signatures
2706 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002707void mbedtls_ssl_conf_sig_hashes(mbedtls_ssl_config *conf,
2708 const int *hashes)
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02002709{
2710 conf->sig_hashes = hashes;
2711}
Jerry Yu7ddc38c2022-01-19 11:08:05 +08002712#endif /* !MBEDTLS_DEPRECATED_REMOVED && MBEDTLS_SSL_PROTO_TLS1_2 */
Hanno Becker1cd6e002021-08-10 13:27:10 +01002713
Jerry Yuf017ee42022-01-12 15:49:48 +08002714/* Configure allowed signature algorithms for handshake */
Gilles Peskine449bd832023-01-11 14:50:10 +01002715void mbedtls_ssl_conf_sig_algs(mbedtls_ssl_config *conf,
2716 const uint16_t *sig_algs)
Hanno Becker1cd6e002021-08-10 13:27:10 +01002717{
Jerry Yuf017ee42022-01-12 15:49:48 +08002718#if !defined(MBEDTLS_DEPRECATED_REMOVED)
2719 conf->sig_hashes = NULL;
2720#endif /* !MBEDTLS_DEPRECATED_REMOVED */
2721 conf->sig_algs = sig_algs;
Hanno Becker1cd6e002021-08-10 13:27:10 +01002722}
Ronald Crone68ab4f2022-10-05 12:46:29 +02002723#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02002724
Manuel Pégourié-Gonnardf07ce3b2023-09-22 11:53:41 +02002725#if defined(MBEDTLS_ECP_C)
Brett Warrene0edc842021-08-17 09:53:13 +01002726#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002727/*
2728 * Set the allowed elliptic curves
Brett Warrene0edc842021-08-17 09:53:13 +01002729 *
2730 * mbedtls_ssl_setup() takes the provided list
2731 * and translates it to a list of IANA TLS group identifiers,
2732 * stored in ssl->handshake->group_list.
2733 *
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002734 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002735void mbedtls_ssl_conf_curves(mbedtls_ssl_config *conf,
2736 const mbedtls_ecp_group_id *curve_list)
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002737{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002738 conf->curve_list = curve_list;
Brett Warrene0edc842021-08-17 09:53:13 +01002739 conf->group_list = NULL;
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002740}
Brett Warrene0edc842021-08-17 09:53:13 +01002741#endif /* MBEDTLS_DEPRECATED_REMOVED */
Manuel Pégourié-Gonnardf07ce3b2023-09-22 11:53:41 +02002742#endif /* MBEDTLS_ECP_C */
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002743
Brett Warrene0edc842021-08-17 09:53:13 +01002744/*
2745 * Set the allowed groups
2746 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002747void mbedtls_ssl_conf_groups(mbedtls_ssl_config *conf,
2748 const uint16_t *group_list)
Brett Warrene0edc842021-08-17 09:53:13 +01002749{
Manuel Pégourié-Gonnardf07ce3b2023-09-22 11:53:41 +02002750#if defined(MBEDTLS_ECP_C) && !defined(MBEDTLS_DEPRECATED_REMOVED)
Brett Warrene0edc842021-08-17 09:53:13 +01002751 conf->curve_list = NULL;
2752#endif
2753 conf->group_list = group_list;
2754}
2755
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01002756#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002757int mbedtls_ssl_set_hostname(mbedtls_ssl_context *ssl, const char *hostname)
Paul Bakker5121ce52009-01-03 21:22:43 +00002758{
Hanno Becker947194e2017-04-07 13:25:49 +01002759 /* Initialize to suppress unnecessary compiler warning */
2760 size_t hostname_len = 0;
2761
2762 /* Check if new hostname is valid before
2763 * making any change to current one */
Gilles Peskine449bd832023-01-11 14:50:10 +01002764 if (hostname != NULL) {
2765 hostname_len = strlen(hostname);
Hanno Becker947194e2017-04-07 13:25:49 +01002766
Gilles Peskine449bd832023-01-11 14:50:10 +01002767 if (hostname_len > MBEDTLS_SSL_MAX_HOST_NAME_LEN) {
2768 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2769 }
Hanno Becker947194e2017-04-07 13:25:49 +01002770 }
2771
2772 /* Now it's clear that we will overwrite the old hostname,
2773 * so we can free it safely */
2774
Gilles Peskine449bd832023-01-11 14:50:10 +01002775 if (ssl->hostname != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01002776 mbedtls_zeroize_and_free(ssl->hostname, strlen(ssl->hostname));
Hanno Becker947194e2017-04-07 13:25:49 +01002777 }
2778
2779 /* Passing NULL as hostname shall clear the old one */
Manuel Pégourié-Gonnardba26c242015-05-06 10:47:06 +01002780
Gilles Peskine449bd832023-01-11 14:50:10 +01002781 if (hostname == NULL) {
Hanno Becker947194e2017-04-07 13:25:49 +01002782 ssl->hostname = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01002783 } else {
2784 ssl->hostname = mbedtls_calloc(1, hostname_len + 1);
2785 if (ssl->hostname == NULL) {
2786 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
2787 }
Paul Bakker75c1a6f2013-08-19 14:25:29 +02002788
Gilles Peskine449bd832023-01-11 14:50:10 +01002789 memcpy(ssl->hostname, hostname, hostname_len);
Paul Bakker75c1a6f2013-08-19 14:25:29 +02002790
Hanno Becker947194e2017-04-07 13:25:49 +01002791 ssl->hostname[hostname_len] = '\0';
2792 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002793
Gilles Peskine449bd832023-01-11 14:50:10 +01002794 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00002795}
Hanno Becker1a9a51c2017-04-07 13:02:16 +01002796#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00002797
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01002798#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01002799void mbedtls_ssl_conf_sni(mbedtls_ssl_config *conf,
2800 int (*f_sni)(void *, mbedtls_ssl_context *,
2801 const unsigned char *, size_t),
2802 void *p_sni)
Paul Bakker5701cdc2012-09-27 21:49:42 +00002803{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002804 conf->f_sni = f_sni;
2805 conf->p_sni = p_sni;
Paul Bakker5701cdc2012-09-27 21:49:42 +00002806}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002807#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
Paul Bakker5701cdc2012-09-27 21:49:42 +00002808
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002809#if defined(MBEDTLS_SSL_ALPN)
Gilles Peskine449bd832023-01-11 14:50:10 +01002810int mbedtls_ssl_conf_alpn_protocols(mbedtls_ssl_config *conf, const char **protos)
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002811{
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002812 size_t cur_len, tot_len;
2813 const char **p;
2814
2815 /*
Brian J Murray1903fb32016-11-06 04:45:15 -08002816 * RFC 7301 3.1: "Empty strings MUST NOT be included and byte strings
2817 * MUST NOT be truncated."
2818 * We check lengths now rather than later.
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002819 */
2820 tot_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01002821 for (p = protos; *p != NULL; p++) {
2822 cur_len = strlen(*p);
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002823 tot_len += cur_len;
2824
Gilles Peskine449bd832023-01-11 14:50:10 +01002825 if ((cur_len == 0) ||
2826 (cur_len > MBEDTLS_SSL_MAX_ALPN_NAME_LEN) ||
2827 (tot_len > MBEDTLS_SSL_MAX_ALPN_LIST_LEN)) {
2828 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2829 }
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002830 }
2831
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002832 conf->alpn_list = protos;
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002833
Gilles Peskine449bd832023-01-11 14:50:10 +01002834 return 0;
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002835}
2836
Gilles Peskine449bd832023-01-11 14:50:10 +01002837const char *mbedtls_ssl_get_alpn_protocol(const mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002838{
Gilles Peskine449bd832023-01-11 14:50:10 +01002839 return ssl->alpn_chosen;
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002840}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002841#endif /* MBEDTLS_SSL_ALPN */
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002842
Johan Pascalb62bb512015-12-03 21:56:45 +01002843#if defined(MBEDTLS_SSL_DTLS_SRTP)
Gilles Peskine449bd832023-01-11 14:50:10 +01002844void mbedtls_ssl_conf_srtp_mki_value_supported(mbedtls_ssl_config *conf,
2845 int support_mki_value)
Ron Eldor591f1622018-01-22 12:30:04 +02002846{
2847 conf->dtls_srtp_mki_support = support_mki_value;
2848}
2849
Gilles Peskine449bd832023-01-11 14:50:10 +01002850int mbedtls_ssl_dtls_srtp_set_mki_value(mbedtls_ssl_context *ssl,
2851 unsigned char *mki_value,
2852 uint16_t mki_len)
Ron Eldor591f1622018-01-22 12:30:04 +02002853{
Gilles Peskine449bd832023-01-11 14:50:10 +01002854 if (mki_len > MBEDTLS_TLS_SRTP_MAX_MKI_LENGTH) {
2855 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Ron Eldora9788042018-12-05 11:04:31 +02002856 }
Ron Eldor591f1622018-01-22 12:30:04 +02002857
Gilles Peskine449bd832023-01-11 14:50:10 +01002858 if (ssl->conf->dtls_srtp_mki_support == MBEDTLS_SSL_DTLS_SRTP_MKI_UNSUPPORTED) {
2859 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Ron Eldora9788042018-12-05 11:04:31 +02002860 }
Ron Eldor591f1622018-01-22 12:30:04 +02002861
Gilles Peskine449bd832023-01-11 14:50:10 +01002862 memcpy(ssl->dtls_srtp_info.mki_value, mki_value, mki_len);
Ron Eldor591f1622018-01-22 12:30:04 +02002863 ssl->dtls_srtp_info.mki_len = mki_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01002864 return 0;
Ron Eldor591f1622018-01-22 12:30:04 +02002865}
2866
Gilles Peskine449bd832023-01-11 14:50:10 +01002867int mbedtls_ssl_conf_dtls_srtp_protection_profiles(mbedtls_ssl_config *conf,
2868 const mbedtls_ssl_srtp_profile *profiles)
Johan Pascalb62bb512015-12-03 21:56:45 +01002869{
Johan Pascal253d0262020-09-22 13:04:45 +02002870 const mbedtls_ssl_srtp_profile *p;
2871 size_t list_size = 0;
Johan Pascalb62bb512015-12-03 21:56:45 +01002872
Johan Pascal253d0262020-09-22 13:04:45 +02002873 /* check the profiles list: all entry must be valid,
2874 * its size cannot be more than the total number of supported profiles, currently 4 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002875 for (p = profiles; *p != MBEDTLS_TLS_SRTP_UNSET &&
2876 list_size <= MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH;
2877 p++) {
2878 if (mbedtls_ssl_check_srtp_profile_value(*p) != MBEDTLS_TLS_SRTP_UNSET) {
Johan Pascal76fdf1d2020-10-22 23:31:00 +02002879 list_size++;
Gilles Peskine449bd832023-01-11 14:50:10 +01002880 } else {
Johan Pascal76fdf1d2020-10-22 23:31:00 +02002881 /* unsupported value, stop parsing and set the size to an error value */
2882 list_size = MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH + 1;
Johan Pascalb62bb512015-12-03 21:56:45 +01002883 }
2884 }
2885
Gilles Peskine449bd832023-01-11 14:50:10 +01002886 if (list_size > MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH) {
2887 conf->dtls_srtp_profile_list = NULL;
2888 conf->dtls_srtp_profile_list_len = 0;
2889 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Johan Pascal253d0262020-09-22 13:04:45 +02002890 }
2891
Johan Pascal9bc97ca2020-09-21 23:44:45 +02002892 conf->dtls_srtp_profile_list = profiles;
Johan Pascal253d0262020-09-22 13:04:45 +02002893 conf->dtls_srtp_profile_list_len = list_size;
Johan Pascalb62bb512015-12-03 21:56:45 +01002894
Gilles Peskine449bd832023-01-11 14:50:10 +01002895 return 0;
Johan Pascalb62bb512015-12-03 21:56:45 +01002896}
2897
Gilles Peskine449bd832023-01-11 14:50:10 +01002898void mbedtls_ssl_get_dtls_srtp_negotiation_result(const mbedtls_ssl_context *ssl,
2899 mbedtls_dtls_srtp_info *dtls_srtp_info)
Johan Pascalb62bb512015-12-03 21:56:45 +01002900{
Johan Pascal2258a4f2020-10-28 13:53:09 +01002901 dtls_srtp_info->chosen_dtls_srtp_profile = ssl->dtls_srtp_info.chosen_dtls_srtp_profile;
2902 /* do not copy the mki value if there is no chosen profile */
Gilles Peskine449bd832023-01-11 14:50:10 +01002903 if (dtls_srtp_info->chosen_dtls_srtp_profile == MBEDTLS_TLS_SRTP_UNSET) {
Johan Pascal2258a4f2020-10-28 13:53:09 +01002904 dtls_srtp_info->mki_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01002905 } else {
Johan Pascal2258a4f2020-10-28 13:53:09 +01002906 dtls_srtp_info->mki_len = ssl->dtls_srtp_info.mki_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01002907 memcpy(dtls_srtp_info->mki_value, ssl->dtls_srtp_info.mki_value,
2908 ssl->dtls_srtp_info.mki_len);
Johan Pascal2258a4f2020-10-28 13:53:09 +01002909 }
Johan Pascalb62bb512015-12-03 21:56:45 +01002910}
Johan Pascalb62bb512015-12-03 21:56:45 +01002911#endif /* MBEDTLS_SSL_DTLS_SRTP */
2912
Aditya Patwardhan3096f332022-07-26 14:31:46 +05302913#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Gilles Peskine449bd832023-01-11 14:50:10 +01002914void mbedtls_ssl_conf_max_version(mbedtls_ssl_config *conf, int major, int minor)
Paul Bakker490ecc82011-10-06 13:04:09 +00002915{
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01002916 conf->max_tls_version = (mbedtls_ssl_protocol_version) ((major << 8) | minor);
Paul Bakker490ecc82011-10-06 13:04:09 +00002917}
2918
Gilles Peskine449bd832023-01-11 14:50:10 +01002919void mbedtls_ssl_conf_min_version(mbedtls_ssl_config *conf, int major, int minor)
Paul Bakker1d29fb52012-09-28 13:28:45 +00002920{
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01002921 conf->min_tls_version = (mbedtls_ssl_protocol_version) ((major << 8) | minor);
Paul Bakker1d29fb52012-09-28 13:28:45 +00002922}
Aditya Patwardhan3096f332022-07-26 14:31:46 +05302923#endif /* MBEDTLS_DEPRECATED_REMOVED */
Paul Bakker1d29fb52012-09-28 13:28:45 +00002924
Janos Follath088ce432017-04-10 12:42:31 +01002925#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002926void mbedtls_ssl_conf_cert_req_ca_list(mbedtls_ssl_config *conf,
2927 char cert_req_ca_list)
Janos Follath088ce432017-04-10 12:42:31 +01002928{
2929 conf->cert_req_ca_list = cert_req_ca_list;
2930}
2931#endif
2932
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002933#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01002934void mbedtls_ssl_conf_encrypt_then_mac(mbedtls_ssl_config *conf, char etm)
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01002935{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002936 conf->encrypt_then_mac = etm;
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01002937}
2938#endif
2939
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002940#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
Gilles Peskine449bd832023-01-11 14:50:10 +01002941void mbedtls_ssl_conf_extended_master_secret(mbedtls_ssl_config *conf, char ems)
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02002942{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002943 conf->extended_ms = ems;
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02002944}
2945#endif
2946
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002947#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01002948int mbedtls_ssl_conf_max_frag_len(mbedtls_ssl_config *conf, unsigned char mfl_code)
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002949{
Gilles Peskine449bd832023-01-11 14:50:10 +01002950 if (mfl_code >= MBEDTLS_SSL_MAX_FRAG_LEN_INVALID ||
2951 ssl_mfl_code_to_length(mfl_code) > MBEDTLS_TLS_EXT_ADV_CONTENT_LEN) {
2952 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002953 }
2954
Manuel Pégourié-Gonnard6bf89d62015-05-05 17:01:57 +01002955 conf->mfl_code = mfl_code;
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002956
Gilles Peskine449bd832023-01-11 14:50:10 +01002957 return 0;
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002958}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002959#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002960
Gilles Peskine449bd832023-01-11 14:50:10 +01002961void mbedtls_ssl_conf_legacy_renegotiation(mbedtls_ssl_config *conf, int allow_legacy)
Paul Bakker48916f92012-09-16 19:57:18 +00002962{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002963 conf->allow_legacy_renegotiation = allow_legacy;
Paul Bakker48916f92012-09-16 19:57:18 +00002964}
2965
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002966#if defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01002967void mbedtls_ssl_conf_renegotiation(mbedtls_ssl_config *conf, int renegotiation)
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01002968{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002969 conf->disable_renegotiation = renegotiation;
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01002970}
2971
Gilles Peskine449bd832023-01-11 14:50:10 +01002972void mbedtls_ssl_conf_renegotiation_enforced(mbedtls_ssl_config *conf, int max_records)
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02002973{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002974 conf->renego_max_records = max_records;
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02002975}
2976
Gilles Peskine449bd832023-01-11 14:50:10 +01002977void mbedtls_ssl_conf_renegotiation_period(mbedtls_ssl_config *conf,
2978 const unsigned char period[8])
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01002979{
Gilles Peskine449bd832023-01-11 14:50:10 +01002980 memcpy(conf->renego_period, period, 8);
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01002981}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002982#endif /* MBEDTLS_SSL_RENEGOTIATION */
Paul Bakker5121ce52009-01-03 21:22:43 +00002983
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002984#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02002985#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002986void mbedtls_ssl_conf_session_tickets(mbedtls_ssl_config *conf, int use_tickets)
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02002987{
Manuel Pégourié-Gonnard2b494452015-05-06 10:05:11 +01002988 conf->session_tickets = use_tickets;
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02002989}
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02002990#endif
Paul Bakker606b4ba2013-08-14 16:52:14 +02002991
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02002992#if defined(MBEDTLS_SSL_SRV_C)
Jerry Yu1ad7ace2022-08-09 13:28:39 +08002993
Jerry Yud0766ec2022-09-22 10:46:57 +08002994#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Gilles Peskine449bd832023-01-11 14:50:10 +01002995void mbedtls_ssl_conf_new_session_tickets(mbedtls_ssl_config *conf,
2996 uint16_t num_tickets)
Jerry Yu1ad7ace2022-08-09 13:28:39 +08002997{
Jerry Yud0766ec2022-09-22 10:46:57 +08002998 conf->new_session_tickets_count = num_tickets;
Jerry Yu1ad7ace2022-08-09 13:28:39 +08002999}
3000#endif
3001
Gilles Peskine449bd832023-01-11 14:50:10 +01003002void mbedtls_ssl_conf_session_tickets_cb(mbedtls_ssl_config *conf,
3003 mbedtls_ssl_ticket_write_t *f_ticket_write,
3004 mbedtls_ssl_ticket_parse_t *f_ticket_parse,
3005 void *p_ticket)
Paul Bakker606b4ba2013-08-14 16:52:14 +02003006{
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02003007 conf->f_ticket_write = f_ticket_write;
3008 conf->f_ticket_parse = f_ticket_parse;
3009 conf->p_ticket = p_ticket;
Paul Bakker606b4ba2013-08-14 16:52:14 +02003010}
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02003011#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003012#endif /* MBEDTLS_SSL_SESSION_TICKETS */
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02003013
Gilles Peskine449bd832023-01-11 14:50:10 +01003014void mbedtls_ssl_set_export_keys_cb(mbedtls_ssl_context *ssl,
3015 mbedtls_ssl_export_keys_t *f_export_keys,
3016 void *p_export_keys)
Robert Cragie4feb7ae2015-10-02 13:33:37 +01003017{
Hanno Becker7e6c1782021-06-08 09:24:55 +01003018 ssl->f_export_keys = f_export_keys;
3019 ssl->p_export_keys = p_export_keys;
Ron Eldorf5cc10d2019-05-07 18:33:40 +03003020}
Robert Cragie4feb7ae2015-10-02 13:33:37 +01003021
Gilles Peskineb74a1c72018-04-24 13:09:22 +02003022#if defined(MBEDTLS_SSL_ASYNC_PRIVATE)
Gilles Peskine8bf79f62018-01-05 21:11:53 +01003023void mbedtls_ssl_conf_async_private_cb(
3024 mbedtls_ssl_config *conf,
3025 mbedtls_ssl_async_sign_t *f_async_sign,
3026 mbedtls_ssl_async_decrypt_t *f_async_decrypt,
3027 mbedtls_ssl_async_resume_t *f_async_resume,
3028 mbedtls_ssl_async_cancel_t *f_async_cancel,
Gilles Peskine449bd832023-01-11 14:50:10 +01003029 void *async_config_data)
Gilles Peskine8bf79f62018-01-05 21:11:53 +01003030{
3031 conf->f_async_sign_start = f_async_sign;
3032 conf->f_async_decrypt_start = f_async_decrypt;
3033 conf->f_async_resume = f_async_resume;
3034 conf->f_async_cancel = f_async_cancel;
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003035 conf->p_async_config_data = async_config_data;
3036}
3037
Gilles Peskine449bd832023-01-11 14:50:10 +01003038void *mbedtls_ssl_conf_get_async_config_data(const mbedtls_ssl_config *conf)
Gilles Peskine8f97af72018-04-26 11:46:10 +02003039{
Gilles Peskine449bd832023-01-11 14:50:10 +01003040 return conf->p_async_config_data;
Gilles Peskine8f97af72018-04-26 11:46:10 +02003041}
3042
Gilles Peskine449bd832023-01-11 14:50:10 +01003043void *mbedtls_ssl_get_async_operation_data(const mbedtls_ssl_context *ssl)
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003044{
Gilles Peskine449bd832023-01-11 14:50:10 +01003045 if (ssl->handshake == NULL) {
3046 return NULL;
3047 } else {
3048 return ssl->handshake->user_async_ctx;
3049 }
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003050}
3051
Gilles Peskine449bd832023-01-11 14:50:10 +01003052void mbedtls_ssl_set_async_operation_data(mbedtls_ssl_context *ssl,
3053 void *ctx)
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003054{
Gilles Peskine449bd832023-01-11 14:50:10 +01003055 if (ssl->handshake != NULL) {
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003056 ssl->handshake->user_async_ctx = ctx;
Gilles Peskine449bd832023-01-11 14:50:10 +01003057 }
Gilles Peskine8bf79f62018-01-05 21:11:53 +01003058}
Gilles Peskineb74a1c72018-04-24 13:09:22 +02003059#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
Gilles Peskine8bf79f62018-01-05 21:11:53 +01003060
Paul Bakker5121ce52009-01-03 21:22:43 +00003061/*
3062 * SSL get accessors
3063 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003064uint32_t mbedtls_ssl_get_verify_result(const mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00003065{
Gilles Peskine449bd832023-01-11 14:50:10 +01003066 if (ssl->session != NULL) {
3067 return ssl->session->verify_result;
3068 }
Manuel Pégourié-Gonnarde89163c2015-01-23 14:30:57 +00003069
Gilles Peskine449bd832023-01-11 14:50:10 +01003070 if (ssl->session_negotiate != NULL) {
3071 return ssl->session_negotiate->verify_result;
3072 }
Manuel Pégourié-Gonnarde89163c2015-01-23 14:30:57 +00003073
Gilles Peskine449bd832023-01-11 14:50:10 +01003074 return 0xFFFFFFFF;
Paul Bakker5121ce52009-01-03 21:22:43 +00003075}
3076
Gilles Peskine449bd832023-01-11 14:50:10 +01003077int mbedtls_ssl_get_ciphersuite_id_from_ssl(const mbedtls_ssl_context *ssl)
Glenn Strauss8f526902022-01-13 00:04:49 -05003078{
Gilles Peskine449bd832023-01-11 14:50:10 +01003079 if (ssl == NULL || ssl->session == NULL) {
3080 return 0;
3081 }
Glenn Strauss8f526902022-01-13 00:04:49 -05003082
Gilles Peskine449bd832023-01-11 14:50:10 +01003083 return ssl->session->ciphersuite;
Glenn Strauss8f526902022-01-13 00:04:49 -05003084}
3085
Gilles Peskine449bd832023-01-11 14:50:10 +01003086const char *mbedtls_ssl_get_ciphersuite(const mbedtls_ssl_context *ssl)
Paul Bakker72f62662011-01-16 21:27:44 +00003087{
Gilles Peskine449bd832023-01-11 14:50:10 +01003088 if (ssl == NULL || ssl->session == NULL) {
3089 return NULL;
3090 }
Paul Bakker926c8e42013-03-06 10:23:34 +01003091
Gilles Peskine449bd832023-01-11 14:50:10 +01003092 return mbedtls_ssl_get_ciphersuite_name(ssl->session->ciphersuite);
Paul Bakker72f62662011-01-16 21:27:44 +00003093}
3094
Gilles Peskine449bd832023-01-11 14:50:10 +01003095const char *mbedtls_ssl_get_version(const mbedtls_ssl_context *ssl)
Paul Bakker43ca69c2011-01-15 17:35:19 +00003096{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003097#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003098 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
3099 switch (ssl->tls_version) {
Glenn Strauss60bfe602022-03-14 19:04:24 -04003100 case MBEDTLS_SSL_VERSION_TLS1_2:
Gilles Peskine449bd832023-01-11 14:50:10 +01003101 return "DTLSv1.2";
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01003102 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01003103 return "unknown (DTLS)";
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01003104 }
3105 }
3106#endif
3107
Gilles Peskine449bd832023-01-11 14:50:10 +01003108 switch (ssl->tls_version) {
Glenn Strauss60bfe602022-03-14 19:04:24 -04003109 case MBEDTLS_SSL_VERSION_TLS1_2:
Gilles Peskine449bd832023-01-11 14:50:10 +01003110 return "TLSv1.2";
Glenn Strauss60bfe602022-03-14 19:04:24 -04003111 case MBEDTLS_SSL_VERSION_TLS1_3:
Gilles Peskine449bd832023-01-11 14:50:10 +01003112 return "TLSv1.3";
Paul Bakker43ca69c2011-01-15 17:35:19 +00003113 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01003114 return "unknown";
Paul Bakker43ca69c2011-01-15 17:35:19 +00003115 }
Paul Bakker43ca69c2011-01-15 17:35:19 +00003116}
3117
Waleed Elmelegy6a971fd2023-12-28 17:48:16 +00003118#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
3119
3120size_t mbedtls_ssl_get_output_record_size_limit(const mbedtls_ssl_context *ssl)
3121{
3122 const size_t max_len = MBEDTLS_SSL_OUT_CONTENT_LEN;
3123 size_t record_size_limit = max_len;
3124
3125 if (ssl->session != NULL &&
3126 ssl->session->record_size_limit >= MBEDTLS_SSL_RECORD_SIZE_LIMIT_MIN &&
3127 ssl->session->record_size_limit < max_len) {
3128 record_size_limit = ssl->session->record_size_limit;
3129 }
3130
3131 // TODO: this is currently untested
3132 /* During a handshake, use the value being negotiated */
3133 if (ssl->session_negotiate != NULL &&
3134 ssl->session_negotiate->record_size_limit >= MBEDTLS_SSL_RECORD_SIZE_LIMIT_MIN &&
3135 ssl->session_negotiate->record_size_limit < max_len) {
3136 record_size_limit = ssl->session_negotiate->record_size_limit;
3137 }
3138
3139 return record_size_limit;
3140}
3141#endif /* MBEDTLS_SSL_RECORD_SIZE_LIMIT */
3142
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02003143#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01003144size_t mbedtls_ssl_get_input_max_frag_len(const mbedtls_ssl_context *ssl)
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003145{
David Horstmann95d516f2021-05-04 18:36:56 +01003146 size_t max_len = MBEDTLS_SSL_IN_CONTENT_LEN;
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003147 size_t read_mfl;
3148
Jerry Yuddda0502022-12-01 19:43:12 +08003149#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003150 /* Use the configured MFL for the client if we're past SERVER_HELLO_DONE */
Gilles Peskine449bd832023-01-11 14:50:10 +01003151 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
3152 ssl->state >= MBEDTLS_SSL_SERVER_HELLO_DONE) {
3153 return ssl_mfl_code_to_length(ssl->conf->mfl_code);
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003154 }
Jerry Yuddda0502022-12-01 19:43:12 +08003155#endif
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003156
3157 /* Check if a smaller max length was negotiated */
Gilles Peskine449bd832023-01-11 14:50:10 +01003158 if (ssl->session_out != NULL) {
3159 read_mfl = ssl_mfl_code_to_length(ssl->session_out->mfl_code);
3160 if (read_mfl < max_len) {
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003161 max_len = read_mfl;
3162 }
3163 }
3164
Jerry Yuddda0502022-12-01 19:43:12 +08003165 /* During a handshake, use the value being negotiated */
Gilles Peskine449bd832023-01-11 14:50:10 +01003166 if (ssl->session_negotiate != NULL) {
3167 read_mfl = ssl_mfl_code_to_length(ssl->session_negotiate->mfl_code);
3168 if (read_mfl < max_len) {
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003169 max_len = read_mfl;
3170 }
3171 }
3172
Gilles Peskine449bd832023-01-11 14:50:10 +01003173 return max_len;
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003174}
3175
Gilles Peskine449bd832023-01-11 14:50:10 +01003176size_t mbedtls_ssl_get_output_max_frag_len(const mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02003177{
3178 size_t max_len;
3179
3180 /*
3181 * Assume mfl_code is correct since it was checked when set
3182 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003183 max_len = ssl_mfl_code_to_length(ssl->conf->mfl_code);
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02003184
Manuel Pégourié-Gonnard2cb17e22017-09-19 13:00:47 +02003185 /* Check if a smaller max length was negotiated */
Gilles Peskine449bd832023-01-11 14:50:10 +01003186 if (ssl->session_out != NULL &&
3187 ssl_mfl_code_to_length(ssl->session_out->mfl_code) < max_len) {
3188 max_len = ssl_mfl_code_to_length(ssl->session_out->mfl_code);
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02003189 }
3190
Manuel Pégourié-Gonnard2cb17e22017-09-19 13:00:47 +02003191 /* During a handshake, use the value being negotiated */
Gilles Peskine449bd832023-01-11 14:50:10 +01003192 if (ssl->session_negotiate != NULL &&
3193 ssl_mfl_code_to_length(ssl->session_negotiate->mfl_code) < max_len) {
3194 max_len = ssl_mfl_code_to_length(ssl->session_negotiate->mfl_code);
Manuel Pégourié-Gonnard2cb17e22017-09-19 13:00:47 +02003195 }
3196
Gilles Peskine449bd832023-01-11 14:50:10 +01003197 return max_len;
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02003198}
3199#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
3200
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003201#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003202size_t mbedtls_ssl_get_current_mtu(const mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003203{
Andrzej Kurekef43ce62018-10-09 08:24:12 -04003204 /* Return unlimited mtu for client hello messages to avoid fragmentation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01003205 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
3206 (ssl->state == MBEDTLS_SSL_CLIENT_HELLO ||
3207 ssl->state == MBEDTLS_SSL_SERVER_HELLO)) {
3208 return 0;
3209 }
Andrzej Kurekef43ce62018-10-09 08:24:12 -04003210
Gilles Peskine449bd832023-01-11 14:50:10 +01003211 if (ssl->handshake == NULL || ssl->handshake->mtu == 0) {
3212 return ssl->mtu;
3213 }
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003214
Gilles Peskine449bd832023-01-11 14:50:10 +01003215 if (ssl->mtu == 0) {
3216 return ssl->handshake->mtu;
3217 }
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003218
Gilles Peskine449bd832023-01-11 14:50:10 +01003219 return ssl->mtu < ssl->handshake->mtu ?
3220 ssl->mtu : ssl->handshake->mtu;
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003221}
3222#endif /* MBEDTLS_SSL_PROTO_DTLS */
3223
Gilles Peskine449bd832023-01-11 14:50:10 +01003224int mbedtls_ssl_get_max_out_record_payload(const mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003225{
3226 size_t max_len = MBEDTLS_SSL_OUT_CONTENT_LEN;
3227
Manuel Pégourié-Gonnard000281e2018-08-21 11:20:58 +02003228#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH) && \
Jan Brucknerf482dcc2023-03-15 09:09:06 +01003229 !defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT) && \
Manuel Pégourié-Gonnard000281e2018-08-21 11:20:58 +02003230 !defined(MBEDTLS_SSL_PROTO_DTLS)
3231 (void) ssl;
3232#endif
3233
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003234#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01003235 const size_t mfl = mbedtls_ssl_get_output_max_frag_len(ssl);
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003236
Gilles Peskine449bd832023-01-11 14:50:10 +01003237 if (max_len > mfl) {
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003238 max_len = mfl;
Gilles Peskine449bd832023-01-11 14:50:10 +01003239 }
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003240#endif
3241
Jan Brucknerf482dcc2023-03-15 09:09:06 +01003242#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
3243 const size_t record_size_limit = mbedtls_ssl_get_output_record_size_limit(ssl);
3244
3245 if (max_len > record_size_limit) {
3246 max_len = record_size_limit;
3247 }
3248#endif
3249
Waleed Elmelegy6a971fd2023-12-28 17:48:16 +00003250 if (ssl->transform_out != NULL &&
3251 ssl->transform_out->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Waleed Elmelegyf5017902024-01-09 14:18:34 +00003252 /*
3253 * In TLS 1.3 case, when records are protected, `max_len` as computed
3254 * above is the maximum length of the TLSInnerPlaintext structure that
3255 * along the plaintext payload contains the inner content type (one byte)
3256 * and some zero padding. Given the algorithm used for padding
3257 * in mbedtls_ssl_encrypt_buf(), compute the maximum length for
3258 * the plaintext payload. Round down to a multiple of
3259 * MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY and
3260 * subtract 1.
Waleed Elmelegy6a971fd2023-12-28 17:48:16 +00003261 */
3262 max_len = ((max_len / MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY) *
3263 MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY) - 1;
3264 }
3265
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003266#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003267 if (mbedtls_ssl_get_current_mtu(ssl) != 0) {
3268 const size_t mtu = mbedtls_ssl_get_current_mtu(ssl);
3269 const int ret = mbedtls_ssl_get_record_expansion(ssl);
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003270 const size_t overhead = (size_t) ret;
3271
Gilles Peskine449bd832023-01-11 14:50:10 +01003272 if (ret < 0) {
3273 return ret;
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003274 }
3275
Gilles Peskine449bd832023-01-11 14:50:10 +01003276 if (mtu <= overhead) {
3277 MBEDTLS_SSL_DEBUG_MSG(1, ("MTU too low for record expansion"));
3278 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
3279 }
3280
3281 if (max_len > mtu - overhead) {
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003282 max_len = mtu - overhead;
Gilles Peskine449bd832023-01-11 14:50:10 +01003283 }
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003284 }
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003285#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003286
Hanno Becker0defedb2018-08-10 12:35:02 +01003287#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH) && \
Waleed Elmelegy049cd302023-12-20 17:28:31 +00003288 !defined(MBEDTLS_SSL_PROTO_DTLS) && \
3289 !defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
Hanno Becker0defedb2018-08-10 12:35:02 +01003290 ((void) ssl);
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003291#endif
3292
Gilles Peskine449bd832023-01-11 14:50:10 +01003293 return (int) max_len;
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003294}
3295
Gilles Peskine449bd832023-01-11 14:50:10 +01003296int mbedtls_ssl_get_max_in_record_payload(const mbedtls_ssl_context *ssl)
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003297{
3298 size_t max_len = MBEDTLS_SSL_IN_CONTENT_LEN;
3299
3300#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
3301 (void) ssl;
3302#endif
3303
3304#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01003305 const size_t mfl = mbedtls_ssl_get_input_max_frag_len(ssl);
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003306
Gilles Peskine449bd832023-01-11 14:50:10 +01003307 if (max_len > mfl) {
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003308 max_len = mfl;
Gilles Peskine449bd832023-01-11 14:50:10 +01003309 }
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003310#endif
3311
Gilles Peskine449bd832023-01-11 14:50:10 +01003312 return (int) max_len;
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003313}
3314
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003315#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01003316const mbedtls_x509_crt *mbedtls_ssl_get_peer_cert(const mbedtls_ssl_context *ssl)
Paul Bakkerb0550d92012-10-30 07:51:03 +00003317{
Gilles Peskine449bd832023-01-11 14:50:10 +01003318 if (ssl == NULL || ssl->session == NULL) {
3319 return NULL;
3320 }
Paul Bakkerb0550d92012-10-30 07:51:03 +00003321
Hanno Beckere6824572019-02-07 13:18:46 +00003322#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01003323 return ssl->session->peer_cert;
Hanno Beckere6824572019-02-07 13:18:46 +00003324#else
Gilles Peskine449bd832023-01-11 14:50:10 +01003325 return NULL;
Hanno Beckere6824572019-02-07 13:18:46 +00003326#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Paul Bakkerb0550d92012-10-30 07:51:03 +00003327}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003328#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkerb0550d92012-10-30 07:51:03 +00003329
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003330#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01003331int mbedtls_ssl_get_session(const mbedtls_ssl_context *ssl,
3332 mbedtls_ssl_session *dst)
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003333{
Hanno Beckere810bbc2021-05-14 16:01:05 +01003334 int ret;
3335
Gilles Peskine449bd832023-01-11 14:50:10 +01003336 if (ssl == NULL ||
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003337 dst == NULL ||
3338 ssl->session == NULL ||
Gilles Peskine449bd832023-01-11 14:50:10 +01003339 ssl->conf->endpoint != MBEDTLS_SSL_IS_CLIENT) {
3340 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003341 }
3342
Hanno Beckere810bbc2021-05-14 16:01:05 +01003343 /* Since Mbed TLS 3.0, mbedtls_ssl_get_session() is no longer
3344 * idempotent: Each session can only be exported once.
3345 *
3346 * (This is in preparation for TLS 1.3 support where we will
3347 * need the ability to export multiple sessions (aka tickets),
3348 * which will be achieved by calling mbedtls_ssl_get_session()
3349 * multiple times until it fails.)
3350 *
3351 * Check whether we have already exported the current session,
3352 * and fail if so.
3353 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003354 if (ssl->session->exported == 1) {
3355 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
3356 }
Hanno Beckere810bbc2021-05-14 16:01:05 +01003357
Gilles Peskine449bd832023-01-11 14:50:10 +01003358 ret = mbedtls_ssl_session_copy(dst, ssl->session);
3359 if (ret != 0) {
3360 return ret;
3361 }
Hanno Beckere810bbc2021-05-14 16:01:05 +01003362
3363 /* Remember that we've exported the session. */
3364 ssl->session->exported = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01003365 return 0;
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003366}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003367#endif /* MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003368
David Horstmanncb01b362024-02-29 17:31:46 +00003369#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
3370
3371/* Serialization of TLS 1.2 sessions
David Horstmanne59f9702024-02-29 16:08:57 +00003372 *
David Horstmanncb01b362024-02-29 17:31:46 +00003373 * For more detail, see the description of ssl_session_save().
David Horstmanne59f9702024-02-29 16:08:57 +00003374 */
3375static size_t ssl_tls12_session_save(const mbedtls_ssl_session *session,
3376 unsigned char *buf,
3377 size_t buf_len)
3378{
3379 unsigned char *p = buf;
3380 size_t used = 0;
3381
3382#if defined(MBEDTLS_HAVE_TIME)
3383 uint64_t start;
3384#endif
3385#if defined(MBEDTLS_X509_CRT_PARSE_C)
3386#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
3387 size_t cert_len;
3388#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3389#endif /* MBEDTLS_X509_CRT_PARSE_C */
3390
3391 /*
3392 * Time
3393 */
3394#if defined(MBEDTLS_HAVE_TIME)
3395 used += 8;
3396
3397 if (used <= buf_len) {
3398 start = (uint64_t) session->start;
3399
3400 MBEDTLS_PUT_UINT64_BE(start, p, 0);
3401 p += 8;
3402 }
3403#endif /* MBEDTLS_HAVE_TIME */
3404
3405 /*
3406 * Basic mandatory fields
3407 */
3408 used += 1 /* id_len */
3409 + sizeof(session->id)
3410 + sizeof(session->master)
3411 + 4; /* verify_result */
3412
3413 if (used <= buf_len) {
3414 *p++ = MBEDTLS_BYTE_0(session->id_len);
3415 memcpy(p, session->id, 32);
3416 p += 32;
3417
3418 memcpy(p, session->master, 48);
3419 p += 48;
3420
3421 MBEDTLS_PUT_UINT32_BE(session->verify_result, p, 0);
3422 p += 4;
3423 }
3424
3425 /*
3426 * Peer's end-entity certificate
3427 */
3428#if defined(MBEDTLS_X509_CRT_PARSE_C)
3429#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
3430 if (session->peer_cert == NULL) {
3431 cert_len = 0;
3432 } else {
3433 cert_len = session->peer_cert->raw.len;
3434 }
3435
3436 used += 3 + cert_len;
3437
3438 if (used <= buf_len) {
3439 *p++ = MBEDTLS_BYTE_2(cert_len);
3440 *p++ = MBEDTLS_BYTE_1(cert_len);
3441 *p++ = MBEDTLS_BYTE_0(cert_len);
3442
3443 if (session->peer_cert != NULL) {
3444 memcpy(p, session->peer_cert->raw.p, cert_len);
3445 p += cert_len;
3446 }
3447 }
3448#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3449 if (session->peer_cert_digest != NULL) {
3450 used += 1 /* type */ + 1 /* length */ + session->peer_cert_digest_len;
3451 if (used <= buf_len) {
3452 *p++ = (unsigned char) session->peer_cert_digest_type;
3453 *p++ = (unsigned char) session->peer_cert_digest_len;
3454 memcpy(p, session->peer_cert_digest,
3455 session->peer_cert_digest_len);
3456 p += session->peer_cert_digest_len;
3457 }
3458 } else {
3459 used += 2;
3460 if (used <= buf_len) {
3461 *p++ = (unsigned char) MBEDTLS_MD_NONE;
3462 *p++ = 0;
3463 }
3464 }
3465#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3466#endif /* MBEDTLS_X509_CRT_PARSE_C */
3467
3468 /*
3469 * Session ticket if any, plus associated data
3470 */
3471#if defined(MBEDTLS_SSL_SESSION_TICKETS)
3472#if defined(MBEDTLS_SSL_CLI_C)
3473 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
3474 used += 3 + session->ticket_len + 4; /* len + ticket + lifetime */
3475
3476 if (used <= buf_len) {
3477 *p++ = MBEDTLS_BYTE_2(session->ticket_len);
3478 *p++ = MBEDTLS_BYTE_1(session->ticket_len);
3479 *p++ = MBEDTLS_BYTE_0(session->ticket_len);
3480
3481 if (session->ticket != NULL) {
3482 memcpy(p, session->ticket, session->ticket_len);
3483 p += session->ticket_len;
3484 }
3485
3486 MBEDTLS_PUT_UINT32_BE(session->ticket_lifetime, p, 0);
3487 p += 4;
3488 }
3489 }
3490#endif /* MBEDTLS_SSL_CLI_C */
3491#if defined(MBEDTLS_HAVE_TIME) && defined(MBEDTLS_SSL_SRV_C)
3492 if (session->endpoint == MBEDTLS_SSL_IS_SERVER) {
3493 used += 8;
3494
3495 if (used <= buf_len) {
3496 MBEDTLS_PUT_UINT64_BE((uint64_t) session->ticket_creation_time, p, 0);
3497 p += 8;
3498 }
3499 }
3500#endif /* MBEDTLS_HAVE_TIME && MBEDTLS_SSL_SRV_C */
3501#endif /* MBEDTLS_SSL_SESSION_TICKETS */
3502
3503 /*
3504 * Misc extension-related info
3505 */
3506#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
3507 used += 1;
3508
3509 if (used <= buf_len) {
3510 *p++ = session->mfl_code;
3511 }
3512#endif
3513
3514#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
3515 used += 1;
3516
3517 if (used <= buf_len) {
3518 *p++ = MBEDTLS_BYTE_0(session->encrypt_then_mac);
3519 }
3520#endif
3521
3522 return used;
3523}
3524
3525MBEDTLS_CHECK_RETURN_CRITICAL
3526static int ssl_tls12_session_load(mbedtls_ssl_session *session,
3527 const unsigned char *buf,
3528 size_t len)
3529{
3530#if defined(MBEDTLS_HAVE_TIME)
3531 uint64_t start;
3532#endif
3533#if defined(MBEDTLS_X509_CRT_PARSE_C)
3534#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
3535 size_t cert_len;
3536#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3537#endif /* MBEDTLS_X509_CRT_PARSE_C */
3538
3539 const unsigned char *p = buf;
3540 const unsigned char * const end = buf + len;
3541
3542 /*
3543 * Time
3544 */
3545#if defined(MBEDTLS_HAVE_TIME)
3546 if (8 > (size_t) (end - p)) {
3547 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3548 }
3549
3550 start = MBEDTLS_GET_UINT64_BE(p, 0);
3551 p += 8;
3552
3553 session->start = (time_t) start;
3554#endif /* MBEDTLS_HAVE_TIME */
3555
3556 /*
3557 * Basic mandatory fields
3558 */
3559 if (1 + 32 + 48 + 4 > (size_t) (end - p)) {
3560 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3561 }
3562
3563 session->id_len = *p++;
3564 memcpy(session->id, p, 32);
3565 p += 32;
3566
3567 memcpy(session->master, p, 48);
3568 p += 48;
3569
3570 session->verify_result = MBEDTLS_GET_UINT32_BE(p, 0);
3571 p += 4;
3572
3573 /* Immediately clear invalid pointer values that have been read, in case
3574 * we exit early before we replaced them with valid ones. */
3575#if defined(MBEDTLS_X509_CRT_PARSE_C)
3576#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
3577 session->peer_cert = NULL;
3578#else
3579 session->peer_cert_digest = NULL;
3580#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3581#endif /* MBEDTLS_X509_CRT_PARSE_C */
3582#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
3583 session->ticket = NULL;
3584#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
3585
3586 /*
3587 * Peer certificate
3588 */
3589#if defined(MBEDTLS_X509_CRT_PARSE_C)
3590#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
3591 /* Deserialize CRT from the end of the ticket. */
3592 if (3 > (size_t) (end - p)) {
3593 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3594 }
3595
3596 cert_len = MBEDTLS_GET_UINT24_BE(p, 0);
3597 p += 3;
3598
3599 if (cert_len != 0) {
3600 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
3601
3602 if (cert_len > (size_t) (end - p)) {
3603 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3604 }
3605
3606 session->peer_cert = mbedtls_calloc(1, sizeof(mbedtls_x509_crt));
3607
3608 if (session->peer_cert == NULL) {
3609 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
3610 }
3611
3612 mbedtls_x509_crt_init(session->peer_cert);
3613
3614 if ((ret = mbedtls_x509_crt_parse_der(session->peer_cert,
3615 p, cert_len)) != 0) {
3616 mbedtls_x509_crt_free(session->peer_cert);
3617 mbedtls_free(session->peer_cert);
3618 session->peer_cert = NULL;
3619 return ret;
3620 }
3621
3622 p += cert_len;
3623 }
3624#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3625 /* Deserialize CRT digest from the end of the ticket. */
3626 if (2 > (size_t) (end - p)) {
3627 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3628 }
3629
3630 session->peer_cert_digest_type = (mbedtls_md_type_t) *p++;
3631 session->peer_cert_digest_len = (size_t) *p++;
3632
3633 if (session->peer_cert_digest_len != 0) {
3634 const mbedtls_md_info_t *md_info =
3635 mbedtls_md_info_from_type(session->peer_cert_digest_type);
3636 if (md_info == NULL) {
3637 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3638 }
3639 if (session->peer_cert_digest_len != mbedtls_md_get_size(md_info)) {
3640 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3641 }
3642
3643 if (session->peer_cert_digest_len > (size_t) (end - p)) {
3644 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3645 }
3646
3647 session->peer_cert_digest =
3648 mbedtls_calloc(1, session->peer_cert_digest_len);
3649 if (session->peer_cert_digest == NULL) {
3650 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
3651 }
3652
3653 memcpy(session->peer_cert_digest, p,
3654 session->peer_cert_digest_len);
3655 p += session->peer_cert_digest_len;
3656 }
3657#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3658#endif /* MBEDTLS_X509_CRT_PARSE_C */
3659
3660 /*
3661 * Session ticket and associated data
3662 */
3663#if defined(MBEDTLS_SSL_SESSION_TICKETS)
3664#if defined(MBEDTLS_SSL_CLI_C)
3665 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
3666 if (3 > (size_t) (end - p)) {
3667 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3668 }
3669
3670 session->ticket_len = MBEDTLS_GET_UINT24_BE(p, 0);
3671 p += 3;
3672
3673 if (session->ticket_len != 0) {
3674 if (session->ticket_len > (size_t) (end - p)) {
3675 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3676 }
3677
3678 session->ticket = mbedtls_calloc(1, session->ticket_len);
3679 if (session->ticket == NULL) {
3680 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
3681 }
3682
3683 memcpy(session->ticket, p, session->ticket_len);
3684 p += session->ticket_len;
3685 }
3686
3687 if (4 > (size_t) (end - p)) {
3688 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3689 }
3690
3691 session->ticket_lifetime = MBEDTLS_GET_UINT32_BE(p, 0);
3692 p += 4;
3693 }
3694#endif /* MBEDTLS_SSL_CLI_C */
3695#if defined(MBEDTLS_HAVE_TIME) && defined(MBEDTLS_SSL_SRV_C)
3696 if (session->endpoint == MBEDTLS_SSL_IS_SERVER) {
3697 if (8 > (size_t) (end - p)) {
3698 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3699 }
3700 session->ticket_creation_time = MBEDTLS_GET_UINT64_BE(p, 0);
3701 p += 8;
3702 }
3703#endif /* MBEDTLS_HAVE_TIME && MBEDTLS_SSL_SRV_C */
3704#endif /* MBEDTLS_SSL_SESSION_TICKETS */
3705
3706 /*
3707 * Misc extension-related info
3708 */
3709#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
3710 if (1 > (size_t) (end - p)) {
3711 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3712 }
3713
3714 session->mfl_code = *p++;
3715#endif
3716
3717#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
3718 if (1 > (size_t) (end - p)) {
3719 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3720 }
3721
3722 session->encrypt_then_mac = *p++;
3723#endif
3724
3725 /* Done, should have consumed entire buffer */
3726 if (p != end) {
3727 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3728 }
3729
3730 return 0;
3731}
3732
3733#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
3734
3735#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
3736/* Serialization of TLS 1.3 sessions:
3737 *
Waleed Elmelegy11025632024-03-07 15:25:52 +00003738 * For more detail, see the description of ssl_session_save().
David Horstmanne59f9702024-02-29 16:08:57 +00003739 */
3740#if defined(MBEDTLS_SSL_SESSION_TICKETS)
3741MBEDTLS_CHECK_RETURN_CRITICAL
3742static int ssl_tls13_session_save(const mbedtls_ssl_session *session,
3743 unsigned char *buf,
3744 size_t buf_len,
3745 size_t *olen)
3746{
3747 unsigned char *p = buf;
3748#if defined(MBEDTLS_SSL_CLI_C) && \
3749 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
3750 size_t hostname_len = (session->hostname == NULL) ?
3751 0 : strlen(session->hostname) + 1;
3752#endif
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003753
3754#if defined(MBEDTLS_SSL_SRV_C) && \
3755 defined(MBEDTLS_SSL_EARLY_DATA) && defined(MBEDTLS_SSL_ALPN)
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00003756 const uint8_t alpn_len = (session->ticket_alpn == NULL) ?
Waleed Elmelegy7dfba342024-03-12 16:22:39 +00003757 0 : (uint8_t) strlen(session->ticket_alpn);
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003758#endif
David Horstmanne59f9702024-02-29 16:08:57 +00003759 size_t needed = 4 /* ticket_age_add */
3760 + 1 /* ticket_flags */
3761 + 1; /* resumption_key length */
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003762
David Horstmanne59f9702024-02-29 16:08:57 +00003763 *olen = 0;
3764
3765 if (session->resumption_key_len > MBEDTLS_SSL_TLS1_3_TICKET_RESUMPTION_KEY_LEN) {
3766 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3767 }
3768 needed += session->resumption_key_len; /* resumption_key */
3769
3770#if defined(MBEDTLS_SSL_EARLY_DATA)
3771 needed += 4; /* max_early_data_size */
3772#endif
3773#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
3774 needed += 2; /* record_size_limit */
3775#endif /* MBEDTLS_SSL_RECORD_SIZE_LIMIT */
3776
3777#if defined(MBEDTLS_HAVE_TIME)
3778 needed += 8; /* ticket_creation_time or ticket_reception_time */
3779#endif
3780
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003781#if defined(MBEDTLS_SSL_SRV_C)
3782 if (session->endpoint == MBEDTLS_SSL_IS_SERVER) {
3783#if defined(MBEDTLS_SSL_EARLY_DATA) && defined(MBEDTLS_SSL_ALPN)
3784 needed += 1 /* alpn_len */
3785 + alpn_len; /* alpn */
3786#endif
3787 }
3788#endif /* MBEDTLS_SSL_SRV_C */
3789
David Horstmanne59f9702024-02-29 16:08:57 +00003790#if defined(MBEDTLS_SSL_CLI_C)
3791 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
3792#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
3793 needed += 2 /* hostname_len */
3794 + hostname_len; /* hostname */
3795#endif
3796
3797 needed += 4 /* ticket_lifetime */
3798 + 2; /* ticket_len */
3799
3800 /* Check size_t overflow */
3801 if (session->ticket_len > SIZE_MAX - needed) {
3802 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3803 }
3804
3805 needed += session->ticket_len; /* ticket */
3806 }
3807#endif /* MBEDTLS_SSL_CLI_C */
3808
3809 *olen = needed;
3810 if (needed > buf_len) {
3811 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
3812 }
3813
3814 MBEDTLS_PUT_UINT32_BE(session->ticket_age_add, p, 0);
3815 p[4] = session->ticket_flags;
3816
3817 /* save resumption_key */
3818 p[5] = session->resumption_key_len;
3819 p += 6;
3820 memcpy(p, session->resumption_key, session->resumption_key_len);
3821 p += session->resumption_key_len;
3822
3823#if defined(MBEDTLS_SSL_EARLY_DATA)
3824 MBEDTLS_PUT_UINT32_BE(session->max_early_data_size, p, 0);
3825 p += 4;
3826#endif
3827#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
3828 MBEDTLS_PUT_UINT16_BE(session->record_size_limit, p, 0);
3829 p += 2;
3830#endif /* MBEDTLS_SSL_RECORD_SIZE_LIMIT */
3831
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003832#if defined(MBEDTLS_SSL_SRV_C)
David Horstmanne59f9702024-02-29 16:08:57 +00003833 if (session->endpoint == MBEDTLS_SSL_IS_SERVER) {
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003834#if defined(MBEDTLS_HAVE_TIME)
David Horstmanne59f9702024-02-29 16:08:57 +00003835 MBEDTLS_PUT_UINT64_BE((uint64_t) session->ticket_creation_time, p, 0);
3836 p += 8;
David Horstmanne59f9702024-02-29 16:08:57 +00003837#endif /* MBEDTLS_HAVE_TIME */
3838
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003839#if defined(MBEDTLS_SSL_EARLY_DATA) && defined(MBEDTLS_SSL_ALPN)
3840 *p++ = alpn_len;
3841 if (alpn_len > 0) {
3842 /* save chosen alpn */
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00003843 memcpy(p, session->ticket_alpn, alpn_len);
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003844 p += alpn_len;
3845 }
3846#endif /* MBEDTLS_SSL_EARLY_DATA && MBEDTLS_SSL_ALPN */
3847 }
3848#endif /* MBEDTLS_SSL_SRV_C */
3849
David Horstmanne59f9702024-02-29 16:08:57 +00003850#if defined(MBEDTLS_SSL_CLI_C)
3851 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
3852#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
3853 MBEDTLS_PUT_UINT16_BE(hostname_len, p, 0);
3854 p += 2;
3855 if (hostname_len > 0) {
3856 /* save host name */
3857 memcpy(p, session->hostname, hostname_len);
3858 p += hostname_len;
3859 }
3860#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
3861
3862#if defined(MBEDTLS_HAVE_TIME)
3863 MBEDTLS_PUT_UINT64_BE((uint64_t) session->ticket_reception_time, p, 0);
3864 p += 8;
3865#endif
3866 MBEDTLS_PUT_UINT32_BE(session->ticket_lifetime, p, 0);
3867 p += 4;
3868
3869 MBEDTLS_PUT_UINT16_BE(session->ticket_len, p, 0);
3870 p += 2;
3871
3872 if (session->ticket != NULL && session->ticket_len > 0) {
3873 memcpy(p, session->ticket, session->ticket_len);
3874 p += session->ticket_len;
3875 }
3876 }
3877#endif /* MBEDTLS_SSL_CLI_C */
3878 return 0;
3879}
3880
3881MBEDTLS_CHECK_RETURN_CRITICAL
3882static int ssl_tls13_session_load(mbedtls_ssl_session *session,
3883 const unsigned char *buf,
3884 size_t len)
3885{
3886 const unsigned char *p = buf;
3887 const unsigned char *end = buf + len;
3888
3889 if (end - p < 6) {
3890 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3891 }
3892 session->ticket_age_add = MBEDTLS_GET_UINT32_BE(p, 0);
3893 session->ticket_flags = p[4];
3894
3895 /* load resumption_key */
3896 session->resumption_key_len = p[5];
3897 p += 6;
3898
3899 if (end - p < session->resumption_key_len) {
3900 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3901 }
3902
3903 if (sizeof(session->resumption_key) < session->resumption_key_len) {
3904 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3905 }
3906 memcpy(session->resumption_key, p, session->resumption_key_len);
3907 p += session->resumption_key_len;
3908
3909#if defined(MBEDTLS_SSL_EARLY_DATA)
3910 if (end - p < 4) {
3911 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3912 }
3913 session->max_early_data_size = MBEDTLS_GET_UINT32_BE(p, 0);
3914 p += 4;
3915#endif
3916#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
3917 if (end - p < 2) {
3918 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3919 }
3920 session->record_size_limit = MBEDTLS_GET_UINT16_BE(p, 0);
3921 p += 2;
3922#endif /* MBEDTLS_SSL_RECORD_SIZE_LIMIT */
3923
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003924#if defined(MBEDTLS_SSL_SRV_C)
David Horstmanne59f9702024-02-29 16:08:57 +00003925 if (session->endpoint == MBEDTLS_SSL_IS_SERVER) {
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003926#if defined(MBEDTLS_HAVE_TIME)
David Horstmanne59f9702024-02-29 16:08:57 +00003927 if (end - p < 8) {
3928 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3929 }
3930 session->ticket_creation_time = MBEDTLS_GET_UINT64_BE(p, 0);
3931 p += 8;
David Horstmanne59f9702024-02-29 16:08:57 +00003932#endif /* MBEDTLS_HAVE_TIME */
3933
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003934#if defined(MBEDTLS_SSL_EARLY_DATA) && defined(MBEDTLS_SSL_ALPN)
3935 uint8_t alpn_len;
3936
3937 if (end - p < 1) {
3938 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3939 }
3940 alpn_len = *p++;
3941
3942 if (end - p < alpn_len) {
3943 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3944 }
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00003945
Waleed Elmelegy7dfba342024-03-12 16:22:39 +00003946 if (alpn_len > MBEDTLS_SSL_MAX_ALPN_NAME_LEN) {
3947 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3948 }
3949
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003950 if (alpn_len > 0) {
Waleed Elmelegy7dfba342024-03-12 16:22:39 +00003951 if (session->ticket_alpn != NULL) {
3952 mbedtls_zeroize_and_free(session->ticket_alpn,
3953 strlen(session->ticket_alpn));
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003954 }
Waleed Elmelegy7dfba342024-03-12 16:22:39 +00003955 session->ticket_alpn = mbedtls_calloc(alpn_len + 1, sizeof(char));
3956 if (session->ticket_alpn == NULL) {
3957 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
3958 }
3959 memcpy(session->ticket_alpn, p, alpn_len);
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003960 p += alpn_len;
3961 }
3962#endif /* MBEDTLS_SSL_EARLY_DATA && MBEDTLS_SSL_ALPN */
3963 }
3964#endif /* MBEDTLS_SSL_SRV_C */
3965
David Horstmanne59f9702024-02-29 16:08:57 +00003966#if defined(MBEDTLS_SSL_CLI_C)
3967 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
3968#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
3969 size_t hostname_len;
3970 /* load host name */
3971 if (end - p < 2) {
3972 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3973 }
3974 hostname_len = MBEDTLS_GET_UINT16_BE(p, 0);
3975 p += 2;
3976
3977 if (end - p < (long int) hostname_len) {
3978 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3979 }
3980 if (hostname_len > 0) {
3981 session->hostname = mbedtls_calloc(1, hostname_len);
3982 if (session->hostname == NULL) {
3983 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
3984 }
3985 memcpy(session->hostname, p, hostname_len);
3986 p += hostname_len;
3987 }
3988#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
3989
3990#if defined(MBEDTLS_HAVE_TIME)
3991 if (end - p < 8) {
3992 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3993 }
3994 session->ticket_reception_time = MBEDTLS_GET_UINT64_BE(p, 0);
3995 p += 8;
3996#endif
3997 if (end - p < 4) {
3998 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3999 }
4000 session->ticket_lifetime = MBEDTLS_GET_UINT32_BE(p, 0);
4001 p += 4;
4002
4003 if (end - p < 2) {
4004 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4005 }
4006 session->ticket_len = MBEDTLS_GET_UINT16_BE(p, 0);
4007 p += 2;
4008
4009 if (end - p < (long int) session->ticket_len) {
4010 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4011 }
4012 if (session->ticket_len > 0) {
4013 session->ticket = mbedtls_calloc(1, session->ticket_len);
4014 if (session->ticket == NULL) {
4015 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
4016 }
4017 memcpy(session->ticket, p, session->ticket_len);
4018 p += session->ticket_len;
4019 }
4020 }
4021#endif /* MBEDTLS_SSL_CLI_C */
4022
4023 return 0;
4024
4025}
4026#else /* MBEDTLS_SSL_SESSION_TICKETS */
4027MBEDTLS_CHECK_RETURN_CRITICAL
4028static int ssl_tls13_session_save(const mbedtls_ssl_session *session,
4029 unsigned char *buf,
4030 size_t buf_len,
4031 size_t *olen)
4032{
4033 ((void) session);
4034 ((void) buf);
4035 ((void) buf_len);
4036 *olen = 0;
4037 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
4038}
4039
4040static int ssl_tls13_session_load(const mbedtls_ssl_session *session,
4041 unsigned char *buf,
4042 size_t buf_len)
4043{
4044 ((void) session);
4045 ((void) buf);
4046 ((void) buf_len);
4047 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
4048}
4049#endif /* !MBEDTLS_SSL_SESSION_TICKETS */
4050#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
4051
Paul Bakker5121ce52009-01-03 21:22:43 +00004052/*
Hanno Beckera835da52019-05-16 12:39:07 +01004053 * Define ticket header determining Mbed TLS version
4054 * and structure of the ticket.
4055 */
4056
Hanno Becker94ef3b32019-05-16 12:50:45 +01004057/*
Hanno Becker50b59662019-05-28 14:30:45 +01004058 * Define bitflag determining compile-time settings influencing
4059 * structure of serialized SSL sessions.
Hanno Becker94ef3b32019-05-16 12:50:45 +01004060 */
4061
Hanno Becker50b59662019-05-28 14:30:45 +01004062#if defined(MBEDTLS_HAVE_TIME)
Hanno Becker3e088662019-05-29 11:10:18 +01004063#define SSL_SERIALIZED_SESSION_CONFIG_TIME 1
Hanno Becker50b59662019-05-28 14:30:45 +01004064#else
Hanno Becker3e088662019-05-29 11:10:18 +01004065#define SSL_SERIALIZED_SESSION_CONFIG_TIME 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01004066#endif /* MBEDTLS_HAVE_TIME */
4067
4068#if defined(MBEDTLS_X509_CRT_PARSE_C)
Hanno Becker3e088662019-05-29 11:10:18 +01004069#define SSL_SERIALIZED_SESSION_CONFIG_CRT 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01004070#else
Hanno Becker3e088662019-05-29 11:10:18 +01004071#define SSL_SERIALIZED_SESSION_CONFIG_CRT 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01004072#endif /* MBEDTLS_X509_CRT_PARSE_C */
4073
David Horstmann5c5a32f2024-02-13 17:53:35 +00004074#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
David Horstmannf686f1d2024-03-01 11:20:32 +00004075#define SSL_SERIALIZED_SESSION_CONFIG_KEEP_PEER_CRT 1
David Horstmann5c5a32f2024-02-13 17:53:35 +00004076#else
David Horstmannf686f1d2024-03-01 11:20:32 +00004077#define SSL_SERIALIZED_SESSION_CONFIG_KEEP_PEER_CRT 0
David Horstmann5c5a32f2024-02-13 17:53:35 +00004078#endif /* MBEDTLS_SSL_SESSION_TICKETS */
4079
Hanno Becker94ef3b32019-05-16 12:50:45 +01004080#if defined(MBEDTLS_SSL_CLI_C) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Hanno Becker3e088662019-05-29 11:10:18 +01004081#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01004082#else
Hanno Becker3e088662019-05-29 11:10:18 +01004083#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01004084#endif /* MBEDTLS_SSL_CLI_C && MBEDTLS_SSL_SESSION_TICKETS */
4085
4086#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Hanno Becker3e088662019-05-29 11:10:18 +01004087#define SSL_SERIALIZED_SESSION_CONFIG_MFL 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01004088#else
Hanno Becker3e088662019-05-29 11:10:18 +01004089#define SSL_SERIALIZED_SESSION_CONFIG_MFL 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01004090#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
4091
Hanno Becker94ef3b32019-05-16 12:50:45 +01004092#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Hanno Becker3e088662019-05-29 11:10:18 +01004093#define SSL_SERIALIZED_SESSION_CONFIG_ETM 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01004094#else
Hanno Becker3e088662019-05-29 11:10:18 +01004095#define SSL_SERIALIZED_SESSION_CONFIG_ETM 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01004096#endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC */
4097
Hanno Becker94ef3b32019-05-16 12:50:45 +01004098#if defined(MBEDTLS_SSL_SESSION_TICKETS)
4099#define SSL_SERIALIZED_SESSION_CONFIG_TICKET 1
4100#else
4101#define SSL_SERIALIZED_SESSION_CONFIG_TICKET 0
4102#endif /* MBEDTLS_SSL_SESSION_TICKETS */
4103
David Horstmann92b258b2024-02-13 17:23:34 +00004104#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
4105#define SSL_SERIALIZED_SESSION_CONFIG_SNI 1
4106#else
4107#define SSL_SERIALIZED_SESSION_CONFIG_SNI 0
4108#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
4109
4110#if defined(MBEDTLS_SSL_EARLY_DATA)
4111#define SSL_SERIALIZED_SESSION_CONFIG_EARLY_DATA 1
4112#else
4113#define SSL_SERIALIZED_SESSION_CONFIG_EARLY_DATA 0
4114#endif /* MBEDTLS_SSL_EARLY_DATA */
4115
4116#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
4117#define SSL_SERIALIZED_SESSION_CONFIG_RECORD_SIZE 1
4118#else
4119#define SSL_SERIALIZED_SESSION_CONFIG_RECORD_SIZE 0
4120#endif /* MBEDTLS_SSL_RECORD_SIZE_LIMIT */
4121
Waleed Elmelegy7dfba342024-03-12 16:22:39 +00004122#if defined(MBEDTLS_SSL_ALPN) && defined(MBEDTLS_SSL_SRV_C) && \
4123 defined(MBEDTLS_SSL_EARLY_DATA)
Waleed Elmelegy11025632024-03-07 15:25:52 +00004124#define SSL_SERIALIZED_SESSION_CONFIG_ALPN 1
4125#else
4126#define SSL_SERIALIZED_SESSION_CONFIG_ALPN 0
4127#endif /* MBEDTLS_SSL_ALPN */
4128
Hanno Becker3e088662019-05-29 11:10:18 +01004129#define SSL_SERIALIZED_SESSION_CONFIG_TIME_BIT 0
4130#define SSL_SERIALIZED_SESSION_CONFIG_CRT_BIT 1
4131#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET_BIT 2
4132#define SSL_SERIALIZED_SESSION_CONFIG_MFL_BIT 3
Hanno Becker37bdbe62021-08-01 05:38:58 +01004133#define SSL_SERIALIZED_SESSION_CONFIG_ETM_BIT 4
4134#define SSL_SERIALIZED_SESSION_CONFIG_TICKET_BIT 5
David Horstmannf686f1d2024-03-01 11:20:32 +00004135#define SSL_SERIALIZED_SESSION_CONFIG_KEEP_PEER_CRT_BIT 6
David Horstmann92b258b2024-02-13 17:23:34 +00004136#define SSL_SERIALIZED_SESSION_CONFIG_SNI_BIT 7
4137#define SSL_SERIALIZED_SESSION_CONFIG_EARLY_DATA_BIT 8
4138#define SSL_SERIALIZED_SESSION_CONFIG_RECORD_SIZE_BIT 9
Waleed Elmelegy11025632024-03-07 15:25:52 +00004139#define SSL_SERIALIZED_SESSION_CONFIG_ALPN_BIT 10
Hanno Becker3e088662019-05-29 11:10:18 +01004140
Hanno Becker50b59662019-05-28 14:30:45 +01004141#define SSL_SERIALIZED_SESSION_CONFIG_BITFLAG \
Gilles Peskine449bd832023-01-11 14:50:10 +01004142 ((uint16_t) ( \
4143 (SSL_SERIALIZED_SESSION_CONFIG_TIME << SSL_SERIALIZED_SESSION_CONFIG_TIME_BIT) | \
4144 (SSL_SERIALIZED_SESSION_CONFIG_CRT << SSL_SERIALIZED_SESSION_CONFIG_CRT_BIT) | \
4145 (SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET << \
4146 SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET_BIT) | \
4147 (SSL_SERIALIZED_SESSION_CONFIG_MFL << SSL_SERIALIZED_SESSION_CONFIG_MFL_BIT) | \
4148 (SSL_SERIALIZED_SESSION_CONFIG_ETM << SSL_SERIALIZED_SESSION_CONFIG_ETM_BIT) | \
David Horstmann5c5a32f2024-02-13 17:53:35 +00004149 (SSL_SERIALIZED_SESSION_CONFIG_TICKET << SSL_SERIALIZED_SESSION_CONFIG_TICKET_BIT) | \
David Horstmann71fa1a92024-03-01 12:32:18 +00004150 (SSL_SERIALIZED_SESSION_CONFIG_KEEP_PEER_CRT << \
4151 SSL_SERIALIZED_SESSION_CONFIG_KEEP_PEER_CRT_BIT) | \
David Horstmann92b258b2024-02-13 17:23:34 +00004152 (SSL_SERIALIZED_SESSION_CONFIG_SNI << SSL_SERIALIZED_SESSION_CONFIG_SNI_BIT) | \
4153 (SSL_SERIALIZED_SESSION_CONFIG_EARLY_DATA << \
4154 SSL_SERIALIZED_SESSION_CONFIG_EARLY_DATA_BIT) | \
4155 (SSL_SERIALIZED_SESSION_CONFIG_RECORD_SIZE << \
Waleed Elmelegy11025632024-03-07 15:25:52 +00004156 SSL_SERIALIZED_SESSION_CONFIG_RECORD_SIZE_BIT) | \
Waleed Elmelegy75e33fa2024-03-07 16:57:58 +00004157 (SSL_SERIALIZED_SESSION_CONFIG_ALPN << \
Waleed Elmelegy11025632024-03-07 15:25:52 +00004158 SSL_SERIALIZED_SESSION_CONFIG_ALPN_BIT)))
Hanno Becker94ef3b32019-05-16 12:50:45 +01004159
Chien Wong4e9683e2023-12-28 17:07:43 +08004160static const unsigned char ssl_serialized_session_header[] = {
Hanno Becker94ef3b32019-05-16 12:50:45 +01004161 MBEDTLS_VERSION_MAJOR,
4162 MBEDTLS_VERSION_MINOR,
4163 MBEDTLS_VERSION_PATCH,
Gilles Peskine449bd832023-01-11 14:50:10 +01004164 MBEDTLS_BYTE_1(SSL_SERIALIZED_SESSION_CONFIG_BITFLAG),
4165 MBEDTLS_BYTE_0(SSL_SERIALIZED_SESSION_CONFIG_BITFLAG),
Hanno Beckerf8787072019-05-16 12:41:07 +01004166};
Hanno Beckera835da52019-05-16 12:39:07 +01004167
4168/*
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004169 * Serialize a session in the following format:
Manuel Pégourié-Gonnard35eb8022019-05-16 11:11:08 +02004170 * (in the presentation language of TLS, RFC 8446 section 3)
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004171 *
David Horstmanncb01b362024-02-29 17:31:46 +00004172 * TLS 1.2 session:
4173 *
4174 * struct {
4175 * #if defined(MBEDTLS_SSL_SESSION_TICKETS)
4176 * opaque ticket<0..2^24-1>; // length 0 means no ticket
4177 * uint32 ticket_lifetime;
4178 * #endif
4179 * } ClientOnlyData;
4180 *
4181 * struct {
4182 * #if defined(MBEDTLS_HAVE_TIME)
4183 * uint64 start_time;
4184 * #endif
4185 * uint8 session_id_len; // at most 32
4186 * opaque session_id[32];
4187 * opaque master[48]; // fixed length in the standard
4188 * uint32 verify_result;
4189 * #if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
4190 * opaque peer_cert<0..2^24-1>; // length 0 means no peer cert
4191 * #else
David Horstmann76ba26a2024-03-01 12:03:35 +00004192 * uint8 peer_cert_digest_type;
David Horstmanncb01b362024-02-29 17:31:46 +00004193 * opaque peer_cert_digest<0..2^8-1>
4194 * #endif
4195 * select (endpoint) {
4196 * case client: ClientOnlyData;
4197 * case server: uint64 ticket_creation_time;
4198 * };
4199 * #if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
4200 * uint8 mfl_code; // up to 255 according to standard
4201 * #endif
4202 * #if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
4203 * uint8 encrypt_then_mac; // 0 or 1
4204 * #endif
4205 * } serialized_session_tls12;
4206 *
4207 *
4208 * TLS 1.3 Session:
4209 *
4210 * struct {
4211 * #if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
4212 * opaque hostname<0..2^16-1>;
4213 * #endif
4214 * #if defined(MBEDTLS_HAVE_TIME)
4215 * uint64 ticket_reception_time;
4216 * #endif
4217 * uint32 ticket_lifetime;
4218 * opaque ticket<1..2^16-1>;
4219 * } ClientOnlyData;
4220 *
4221 * struct {
4222 * uint32 ticket_age_add;
4223 * uint8 ticket_flags;
4224 * opaque resumption_key<0..255>;
4225 * #if defined(MBEDTLS_SSL_EARLY_DATA)
4226 * uint32 max_early_data_size;
4227 * #endif
4228 * #if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
4229 * uint16 record_size_limit;
4230 * #endif
4231 * select ( endpoint ) {
4232 * case client: ClientOnlyData;
Waleed Elmelegy7dfba342024-03-12 16:22:39 +00004233 * case server:
David Horstmanncb01b362024-02-29 17:31:46 +00004234 * #if defined(MBEDTLS_HAVE_TIME)
Waleed Elmelegy7dfba342024-03-12 16:22:39 +00004235 * uint64 ticket_creation_time;
David Horstmanncb01b362024-02-29 17:31:46 +00004236 * #endif
Waleed Elmelegyfe9ae082024-03-07 15:47:31 +00004237 * #if defined(MBEDTLS_SSL_EARLY_DATA) && defined(MBEDTLS_SSL_ALPN)
Waleed Elmelegyfe9ae082024-03-07 15:47:31 +00004238 * opaque ticket_alpn<0..255>;
4239 * #endif
David Horstmanncb01b362024-02-29 17:31:46 +00004240 * };
4241 * } serialized_session_tls13;
4242 *
4243 *
4244 * SSL session:
4245 *
4246 * struct {
Hanno Beckerdc28b6c2019-05-29 11:08:00 +01004247 *
Hanno Beckerdce50972021-08-01 05:39:23 +01004248 * opaque mbedtls_version[3]; // library version: major, minor, patch
4249 * opaque session_format[2]; // library-version specific 16-bit field
4250 * // determining the format of the remaining
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004251 * // serialized data.
Hanno Beckerdc28b6c2019-05-29 11:08:00 +01004252 *
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004253 * Note: When updating the format, remember to keep
4254 * these version+format bytes.
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004255 *
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004256 * // In this version, `session_format` determines
4257 * // the setting of those compile-time
4258 * // configuration options which influence
4259 * // the structure of mbedtls_ssl_session.
4260 *
Glenn Straussda7851c2022-03-14 13:29:48 -04004261 * uint8_t minor_ver; // Protocol minor version. Possible values:
Jerry Yu0c2a7382022-12-06 13:27:25 +08004262 * // - TLS 1.2 (0x0303)
4263 * // - TLS 1.3 (0x0304)
David Horstmann531aca22024-02-29 18:14:28 +00004264 * uint8_t endpoint;
4265 * uint16_t ciphersuite;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004266 *
Glenn Straussda7851c2022-03-14 13:29:48 -04004267 * select (serialized_session.tls_version) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004268 *
Glenn Straussda7851c2022-03-14 13:29:48 -04004269 * case MBEDTLS_SSL_VERSION_TLS1_2:
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004270 * serialized_session_tls12 data;
Jerry Yu0c2a7382022-12-06 13:27:25 +08004271 * case MBEDTLS_SSL_VERSION_TLS1_3:
Jerry Yuddda0502022-12-01 19:43:12 +08004272 * serialized_session_tls13 data;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004273 *
4274 * };
4275 *
4276 * } serialized_session;
4277 *
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004278 */
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004279
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004280MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004281static int ssl_session_save(const mbedtls_ssl_session *session,
4282 unsigned char omit_header,
4283 unsigned char *buf,
4284 size_t buf_len,
4285 size_t *olen)
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004286{
4287 unsigned char *p = buf;
4288 size_t used = 0;
Jerry Yu251a12e2022-07-13 15:15:48 +08004289 size_t remaining_len;
Jerry Yue36fdd62022-08-17 21:31:36 +08004290#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
4291 size_t out_len;
4292 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
4293#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01004294 if (session == NULL) {
4295 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
4296 }
Jerry Yu438ddd82022-07-07 06:55:50 +00004297
Gilles Peskine449bd832023-01-11 14:50:10 +01004298 if (!omit_header) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004299 /*
4300 * Add Mbed TLS version identifier
4301 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004302 used += sizeof(ssl_serialized_session_header);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004303
Gilles Peskine449bd832023-01-11 14:50:10 +01004304 if (used <= buf_len) {
4305 memcpy(p, ssl_serialized_session_header,
4306 sizeof(ssl_serialized_session_header));
4307 p += sizeof(ssl_serialized_session_header);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004308 }
4309 }
4310
4311 /*
Ronald Cron40a4ab02024-01-15 10:21:30 +01004312 * TLS version identifier, endpoint, ciphersuite
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004313 */
Ronald Cron40a4ab02024-01-15 10:21:30 +01004314 used += 1 /* TLS version */
4315 + 1 /* endpoint */
4316 + 2; /* ciphersuite */
Gilles Peskine449bd832023-01-11 14:50:10 +01004317 if (used <= buf_len) {
4318 *p++ = MBEDTLS_BYTE_0(session->tls_version);
Ronald Cron40a4ab02024-01-15 10:21:30 +01004319 *p++ = session->endpoint;
4320 MBEDTLS_PUT_UINT16_BE(session->ciphersuite, p, 0);
4321 p += 2;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004322 }
4323
4324 /* Forward to version-specific serialization routine. */
Jerry Yufca4d572022-07-21 10:37:48 +08004325 remaining_len = (buf_len >= used) ? buf_len - used : 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01004326 switch (session->tls_version) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004327#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01004328 case MBEDTLS_SSL_VERSION_TLS1_2:
4329 used += ssl_tls12_session_save(session, p, remaining_len);
4330 break;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004331#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
4332
Jerry Yu251a12e2022-07-13 15:15:48 +08004333#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004334 case MBEDTLS_SSL_VERSION_TLS1_3:
4335 ret = ssl_tls13_session_save(session, p, remaining_len, &out_len);
4336 if (ret != 0 && ret != MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL) {
4337 return ret;
4338 }
4339 used += out_len;
4340 break;
Jerry Yu251a12e2022-07-13 15:15:48 +08004341#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
4342
Gilles Peskine449bd832023-01-11 14:50:10 +01004343 default:
4344 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004345 }
4346
4347 *olen = used;
Gilles Peskine449bd832023-01-11 14:50:10 +01004348 if (used > buf_len) {
4349 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
4350 }
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004351
Gilles Peskine449bd832023-01-11 14:50:10 +01004352 return 0;
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004353}
4354
4355/*
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02004356 * Public wrapper for ssl_session_save()
4357 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004358int mbedtls_ssl_session_save(const mbedtls_ssl_session *session,
4359 unsigned char *buf,
4360 size_t buf_len,
4361 size_t *olen)
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02004362{
Gilles Peskine449bd832023-01-11 14:50:10 +01004363 return ssl_session_save(session, 0, buf, buf_len, olen);
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02004364}
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004365
Jerry Yuf1b23ca2022-02-18 11:48:47 +08004366/*
4367 * Deserialize session, see mbedtls_ssl_session_save() for format.
4368 *
4369 * This internal version is wrapped by a public function that cleans up in
4370 * case of error, and has an extra option omit_header.
4371 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004372MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004373static int ssl_session_load(mbedtls_ssl_session *session,
4374 unsigned char omit_header,
4375 const unsigned char *buf,
4376 size_t len)
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004377{
4378 const unsigned char *p = buf;
4379 const unsigned char * const end = buf + len;
Jerry Yu438ddd82022-07-07 06:55:50 +00004380 size_t remaining_len;
4381
4382
Gilles Peskine449bd832023-01-11 14:50:10 +01004383 if (session == NULL) {
4384 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
4385 }
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004386
Gilles Peskine449bd832023-01-11 14:50:10 +01004387 if (!omit_header) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004388 /*
4389 * Check Mbed TLS version identifier
4390 */
4391
Gilles Peskine449bd832023-01-11 14:50:10 +01004392 if ((size_t) (end - p) < sizeof(ssl_serialized_session_header)) {
4393 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004394 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004395
4396 if (memcmp(p, ssl_serialized_session_header,
4397 sizeof(ssl_serialized_session_header)) != 0) {
4398 return MBEDTLS_ERR_SSL_VERSION_MISMATCH;
4399 }
4400 p += sizeof(ssl_serialized_session_header);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004401 }
4402
4403 /*
Ronald Cron40a4ab02024-01-15 10:21:30 +01004404 * TLS version identifier, endpoint, ciphersuite
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004405 */
Ronald Cron40a4ab02024-01-15 10:21:30 +01004406 if (4 > (size_t) (end - p)) {
Gilles Peskine449bd832023-01-11 14:50:10 +01004407 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4408 }
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01004409 session->tls_version = (mbedtls_ssl_protocol_version) (0x0300 | *p++);
Ronald Cron40a4ab02024-01-15 10:21:30 +01004410 session->endpoint = *p++;
4411 session->ciphersuite = MBEDTLS_GET_UINT16_BE(p, 0);
4412 p += 2;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004413
4414 /* Dispatch according to TLS version. */
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00004415 remaining_len = (size_t) (end - p);
Gilles Peskine449bd832023-01-11 14:50:10 +01004416 switch (session->tls_version) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004417#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01004418 case MBEDTLS_SSL_VERSION_TLS1_2:
4419 return ssl_tls12_session_load(session, p, remaining_len);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004420#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
4421
Jerry Yu438ddd82022-07-07 06:55:50 +00004422#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004423 case MBEDTLS_SSL_VERSION_TLS1_3:
4424 return ssl_tls13_session_load(session, p, remaining_len);
Jerry Yu438ddd82022-07-07 06:55:50 +00004425#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
4426
Gilles Peskine449bd832023-01-11 14:50:10 +01004427 default:
4428 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004429 }
4430}
4431
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004432/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02004433 * Deserialize session: public wrapper for error cleaning
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02004434 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004435int mbedtls_ssl_session_load(mbedtls_ssl_session *session,
4436 const unsigned char *buf,
4437 size_t len)
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02004438{
Gilles Peskine449bd832023-01-11 14:50:10 +01004439 int ret = ssl_session_load(session, 0, buf, len);
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02004440
Gilles Peskine449bd832023-01-11 14:50:10 +01004441 if (ret != 0) {
4442 mbedtls_ssl_session_free(session);
4443 }
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02004444
Gilles Peskine449bd832023-01-11 14:50:10 +01004445 return ret;
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02004446}
4447
4448/*
Paul Bakker1961b702013-01-25 14:49:24 +01004449 * Perform a single step of the SSL handshake
Paul Bakker5121ce52009-01-03 21:22:43 +00004450 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004451MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004452static int ssl_prepare_handshake_step(mbedtls_ssl_context *ssl)
Hanno Becker41934dd2021-08-07 19:13:43 +01004453{
4454 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
4455
Ronald Cron66dbf912022-02-02 15:33:46 +01004456 /*
4457 * We may have not been able to send to the peer all the handshake data
Ronald Cron3f20b772022-03-08 16:00:02 +01004458 * that were written into the output buffer by the previous handshake step,
4459 * if the write to the network callback returned with the
Ronald Cron66dbf912022-02-02 15:33:46 +01004460 * #MBEDTLS_ERR_SSL_WANT_WRITE error code.
4461 * We proceed to the next handshake step only when all data from the
4462 * previous one have been sent to the peer, thus we make sure that this is
4463 * the case here by calling `mbedtls_ssl_flush_output()`. The function may
4464 * return with the #MBEDTLS_ERR_SSL_WANT_WRITE error code in which case
4465 * we have to wait before to go ahead.
4466 * In the case of TLS 1.3, handshake step handlers do not send data to the
4467 * peer. Data are only sent here and through
4468 * `mbedtls_ssl_handle_pending_alert` in case an error that triggered an
Andrzej Kurek5c65c572022-04-13 14:28:52 -04004469 * alert occurred.
Ronald Cron66dbf912022-02-02 15:33:46 +01004470 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004471 if ((ret = mbedtls_ssl_flush_output(ssl)) != 0) {
4472 return ret;
4473 }
Hanno Becker41934dd2021-08-07 19:13:43 +01004474
4475#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004476 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
4477 ssl->handshake->retransmit_state == MBEDTLS_SSL_RETRANS_SENDING) {
4478 if ((ret = mbedtls_ssl_flight_transmit(ssl)) != 0) {
4479 return ret;
4480 }
Hanno Becker41934dd2021-08-07 19:13:43 +01004481 }
4482#endif /* MBEDTLS_SSL_PROTO_DTLS */
4483
Gilles Peskine449bd832023-01-11 14:50:10 +01004484 return ret;
Hanno Becker41934dd2021-08-07 19:13:43 +01004485}
4486
Gilles Peskine449bd832023-01-11 14:50:10 +01004487int mbedtls_ssl_handshake_step(mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00004488{
Hanno Becker41934dd2021-08-07 19:13:43 +01004489 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00004490
Gilles Peskine449bd832023-01-11 14:50:10 +01004491 if (ssl == NULL ||
Hanno Becker41934dd2021-08-07 19:13:43 +01004492 ssl->conf == NULL ||
4493 ssl->handshake == NULL ||
Gilles Peskine449bd832023-01-11 14:50:10 +01004494 ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER) {
4495 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Becker41934dd2021-08-07 19:13:43 +01004496 }
4497
Gilles Peskine449bd832023-01-11 14:50:10 +01004498 ret = ssl_prepare_handshake_step(ssl);
4499 if (ret != 0) {
4500 return ret;
4501 }
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02004502
Gilles Peskine449bd832023-01-11 14:50:10 +01004503 ret = mbedtls_ssl_handle_pending_alert(ssl);
4504 if (ret != 0) {
Jerry Yue7047812021-09-13 19:26:39 +08004505 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01004506 }
Jerry Yue7047812021-09-13 19:26:39 +08004507
Tom Cosgrove2fdc7b32022-09-21 12:33:17 +01004508 /* If ssl->conf->endpoint is not one of MBEDTLS_SSL_IS_CLIENT or
4509 * MBEDTLS_SSL_IS_SERVER, this is the return code we give */
4510 ret = MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4511
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004512#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004513 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
4514 MBEDTLS_SSL_DEBUG_MSG(2, ("client state: %s",
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01004515 mbedtls_ssl_states_str((mbedtls_ssl_states) ssl->state)));
Jerry Yub9930e72021-08-06 17:11:51 +08004516
Gilles Peskine449bd832023-01-11 14:50:10 +01004517 switch (ssl->state) {
Ronald Cron9f0fba32022-02-10 16:45:15 +01004518 case MBEDTLS_SSL_HELLO_REQUEST:
4519 ssl->state = MBEDTLS_SSL_CLIENT_HELLO;
Tom Cosgrove87d9c6c2022-09-22 09:27:56 +01004520 ret = 0;
Ronald Cron9f0fba32022-02-10 16:45:15 +01004521 break;
Jerry Yub9930e72021-08-06 17:11:51 +08004522
Ronald Cron9f0fba32022-02-10 16:45:15 +01004523 case MBEDTLS_SSL_CLIENT_HELLO:
Gilles Peskine449bd832023-01-11 14:50:10 +01004524 ret = mbedtls_ssl_write_client_hello(ssl);
Ronald Cron9f0fba32022-02-10 16:45:15 +01004525 break;
4526
4527 default:
4528#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004529 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
4530 ret = mbedtls_ssl_tls13_handshake_client_step(ssl);
4531 } else {
4532 ret = mbedtls_ssl_handshake_client_step(ssl);
4533 }
Ronald Cron9f0fba32022-02-10 16:45:15 +01004534#elif defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01004535 ret = mbedtls_ssl_handshake_client_step(ssl);
Ronald Cron9f0fba32022-02-10 16:45:15 +01004536#else
Gilles Peskine449bd832023-01-11 14:50:10 +01004537 ret = mbedtls_ssl_tls13_handshake_client_step(ssl);
Ronald Cron9f0fba32022-02-10 16:45:15 +01004538#endif
4539 }
Jerry Yub9930e72021-08-06 17:11:51 +08004540 }
Ronald Cron6291b232023-03-08 15:51:25 +01004541#endif /* MBEDTLS_SSL_CLI_C */
4542
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004543#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004544 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Ronald Cron6291b232023-03-08 15:51:25 +01004545#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
4546 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Gilles Peskine449bd832023-01-11 14:50:10 +01004547 ret = mbedtls_ssl_tls13_handshake_server_step(ssl);
Ronald Cron6291b232023-03-08 15:51:25 +01004548 } else {
Gilles Peskine449bd832023-01-11 14:50:10 +01004549 ret = mbedtls_ssl_handshake_server_step(ssl);
4550 }
Ronald Cron6291b232023-03-08 15:51:25 +01004551#elif defined(MBEDTLS_SSL_PROTO_TLS1_2)
4552 ret = mbedtls_ssl_handshake_server_step(ssl);
4553#else
4554 ret = mbedtls_ssl_tls13_handshake_server_step(ssl);
Paul Bakker5121ce52009-01-03 21:22:43 +00004555#endif
Ronald Cron6291b232023-03-08 15:51:25 +01004556 }
4557#endif /* MBEDTLS_SSL_SRV_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00004558
Gilles Peskine449bd832023-01-11 14:50:10 +01004559 if (ret != 0) {
Jerry Yubbd5a3f2021-09-18 20:50:22 +08004560 /* handshake_step return error. And it is same
4561 * with alert_reason.
4562 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004563 if (ssl->send_alert) {
4564 ret = mbedtls_ssl_handle_pending_alert(ssl);
Jerry Yue7047812021-09-13 19:26:39 +08004565 goto cleanup;
4566 }
4567 }
4568
4569cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +01004570 return ret;
Paul Bakker1961b702013-01-25 14:49:24 +01004571}
4572
4573/*
4574 * Perform the SSL handshake
4575 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004576int mbedtls_ssl_handshake(mbedtls_ssl_context *ssl)
Paul Bakker1961b702013-01-25 14:49:24 +01004577{
4578 int ret = 0;
4579
Hanno Beckera817ea42020-10-20 15:20:23 +01004580 /* Sanity checks */
4581
Gilles Peskine449bd832023-01-11 14:50:10 +01004582 if (ssl == NULL || ssl->conf == NULL) {
4583 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4584 }
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02004585
Hanno Beckera817ea42020-10-20 15:20:23 +01004586#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004587 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
4588 (ssl->f_set_timer == NULL || ssl->f_get_timer == NULL)) {
4589 MBEDTLS_SSL_DEBUG_MSG(1, ("You must use "
4590 "mbedtls_ssl_set_timer_cb() for DTLS"));
4591 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Beckera817ea42020-10-20 15:20:23 +01004592 }
4593#endif /* MBEDTLS_SSL_PROTO_DTLS */
4594
Gilles Peskine449bd832023-01-11 14:50:10 +01004595 MBEDTLS_SSL_DEBUG_MSG(2, ("=> handshake"));
Paul Bakker1961b702013-01-25 14:49:24 +01004596
Hanno Beckera817ea42020-10-20 15:20:23 +01004597 /* Main handshake loop */
Gilles Peskine449bd832023-01-11 14:50:10 +01004598 while (ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER) {
4599 ret = mbedtls_ssl_handshake_step(ssl);
Paul Bakker1961b702013-01-25 14:49:24 +01004600
Gilles Peskine449bd832023-01-11 14:50:10 +01004601 if (ret != 0) {
Paul Bakker1961b702013-01-25 14:49:24 +01004602 break;
Gilles Peskine449bd832023-01-11 14:50:10 +01004603 }
Paul Bakker1961b702013-01-25 14:49:24 +01004604 }
4605
Gilles Peskine449bd832023-01-11 14:50:10 +01004606 MBEDTLS_SSL_DEBUG_MSG(2, ("<= handshake"));
Paul Bakker5121ce52009-01-03 21:22:43 +00004607
Gilles Peskine449bd832023-01-11 14:50:10 +01004608 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00004609}
4610
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004611#if defined(MBEDTLS_SSL_RENEGOTIATION)
4612#if defined(MBEDTLS_SSL_SRV_C)
Paul Bakker5121ce52009-01-03 21:22:43 +00004613/*
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004614 * Write HelloRequest to request renegotiation on server
Paul Bakker48916f92012-09-16 19:57:18 +00004615 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004616MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004617static int ssl_write_hello_request(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004618{
Janos Follath865b3eb2019-12-16 11:46:15 +00004619 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004620
Gilles Peskine449bd832023-01-11 14:50:10 +01004621 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write hello request"));
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004622
4623 ssl->out_msglen = 4;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004624 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
4625 ssl->out_msg[0] = MBEDTLS_SSL_HS_HELLO_REQUEST;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004626
Gilles Peskine449bd832023-01-11 14:50:10 +01004627 if ((ret = mbedtls_ssl_write_handshake_msg(ssl)) != 0) {
4628 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_handshake_msg", ret);
4629 return ret;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004630 }
4631
Gilles Peskine449bd832023-01-11 14:50:10 +01004632 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write hello request"));
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004633
Gilles Peskine449bd832023-01-11 14:50:10 +01004634 return 0;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004635}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004636#endif /* MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004637
4638/*
4639 * Actually renegotiate current connection, triggered by either:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004640 * - any side: calling mbedtls_ssl_renegotiate(),
4641 * - client: receiving a HelloRequest during mbedtls_ssl_read(),
4642 * - server: receiving any handshake message on server during mbedtls_ssl_read() after
Manuel Pégourié-Gonnard55e4ff22014-08-19 11:16:35 +02004643 * the initial handshake is completed.
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004644 * If the handshake doesn't complete due to waiting for I/O, it will continue
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004645 * during the next calls to mbedtls_ssl_renegotiate() or mbedtls_ssl_read() respectively.
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004646 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004647int mbedtls_ssl_start_renegotiation(mbedtls_ssl_context *ssl)
Paul Bakker48916f92012-09-16 19:57:18 +00004648{
Janos Follath865b3eb2019-12-16 11:46:15 +00004649 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker48916f92012-09-16 19:57:18 +00004650
Gilles Peskine449bd832023-01-11 14:50:10 +01004651 MBEDTLS_SSL_DEBUG_MSG(2, ("=> renegotiate"));
Paul Bakker48916f92012-09-16 19:57:18 +00004652
Gilles Peskine449bd832023-01-11 14:50:10 +01004653 if ((ret = ssl_handshake_init(ssl)) != 0) {
4654 return ret;
4655 }
Paul Bakker48916f92012-09-16 19:57:18 +00004656
Manuel Pégourié-Gonnard0557bd52014-08-19 19:18:39 +02004657 /* RFC 6347 4.2.2: "[...] the HelloRequest will have message_seq = 0 and
4658 * the ServerHello will have message_seq = 1" */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004659#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004660 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
4661 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING) {
4662 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02004663 ssl->handshake->out_msg_seq = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004664 } else {
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02004665 ssl->handshake->in_msg_seq = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004666 }
Manuel Pégourié-Gonnard0557bd52014-08-19 19:18:39 +02004667 }
4668#endif
4669
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004670 ssl->state = MBEDTLS_SSL_HELLO_REQUEST;
4671 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS;
Paul Bakker48916f92012-09-16 19:57:18 +00004672
Gilles Peskine449bd832023-01-11 14:50:10 +01004673 if ((ret = mbedtls_ssl_handshake(ssl)) != 0) {
4674 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_handshake", ret);
4675 return ret;
Paul Bakker48916f92012-09-16 19:57:18 +00004676 }
4677
Gilles Peskine449bd832023-01-11 14:50:10 +01004678 MBEDTLS_SSL_DEBUG_MSG(2, ("<= renegotiate"));
Paul Bakker48916f92012-09-16 19:57:18 +00004679
Gilles Peskine449bd832023-01-11 14:50:10 +01004680 return 0;
Paul Bakker48916f92012-09-16 19:57:18 +00004681}
4682
4683/*
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004684 * Renegotiate current connection on client,
4685 * or request renegotiation on server
4686 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004687int mbedtls_ssl_renegotiate(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004688{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004689 int ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004690
Gilles Peskine449bd832023-01-11 14:50:10 +01004691 if (ssl == NULL || ssl->conf == NULL) {
4692 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4693 }
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02004694
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004695#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004696 /* On server, just send the request */
Gilles Peskine449bd832023-01-11 14:50:10 +01004697 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
4698 if (mbedtls_ssl_is_handshake_over(ssl) == 0) {
4699 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4700 }
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004701
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004702 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_PENDING;
Manuel Pégourié-Gonnardf07f4212014-08-15 19:04:47 +02004703
4704 /* Did we already try/start sending HelloRequest? */
Gilles Peskine449bd832023-01-11 14:50:10 +01004705 if (ssl->out_left != 0) {
4706 return mbedtls_ssl_flush_output(ssl);
4707 }
Manuel Pégourié-Gonnardf07f4212014-08-15 19:04:47 +02004708
Gilles Peskine449bd832023-01-11 14:50:10 +01004709 return ssl_write_hello_request(ssl);
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004710 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004711#endif /* MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004712
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004713#if defined(MBEDTLS_SSL_CLI_C)
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004714 /*
4715 * On client, either start the renegotiation process or,
4716 * if already in progress, continue the handshake
4717 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004718 if (ssl->renego_status != MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS) {
4719 if (mbedtls_ssl_is_handshake_over(ssl) == 0) {
4720 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004721 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004722
4723 if ((ret = mbedtls_ssl_start_renegotiation(ssl)) != 0) {
4724 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_start_renegotiation", ret);
4725 return ret;
4726 }
4727 } else {
4728 if ((ret = mbedtls_ssl_handshake(ssl)) != 0) {
4729 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_handshake", ret);
4730 return ret;
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004731 }
4732 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004733#endif /* MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004734
Gilles Peskine449bd832023-01-11 14:50:10 +01004735 return ret;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004736}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004737#endif /* MBEDTLS_SSL_RENEGOTIATION */
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004738
Gilles Peskine449bd832023-01-11 14:50:10 +01004739void mbedtls_ssl_handshake_free(mbedtls_ssl_context *ssl)
Paul Bakker48916f92012-09-16 19:57:18 +00004740{
Gilles Peskine9b562d52018-04-25 20:32:43 +02004741 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
4742
Gilles Peskine449bd832023-01-11 14:50:10 +01004743 if (handshake == NULL) {
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004744 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01004745 }
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004746
Valerio Setti6f0441d2023-07-03 12:11:36 +02004747#if defined(MBEDTLS_PK_HAVE_ECC_KEYS)
Brett Warrene0edc842021-08-17 09:53:13 +01004748#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004749 if (ssl->handshake->group_list_heap_allocated) {
4750 mbedtls_free((void *) handshake->group_list);
4751 }
Brett Warrene0edc842021-08-17 09:53:13 +01004752 handshake->group_list = NULL;
4753#endif /* MBEDTLS_DEPRECATED_REMOVED */
Valerio Setti6f0441d2023-07-03 12:11:36 +02004754#endif /* MBEDTLS_PK_HAVE_ECC_KEYS */
Brett Warrene0edc842021-08-17 09:53:13 +01004755
Ronald Crone68ab4f2022-10-05 12:46:29 +02004756#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yuf017ee42022-01-12 15:49:48 +08004757#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004758 if (ssl->handshake->sig_algs_heap_allocated) {
4759 mbedtls_free((void *) handshake->sig_algs);
4760 }
Jerry Yuf017ee42022-01-12 15:49:48 +08004761 handshake->sig_algs = NULL;
4762#endif /* MBEDTLS_DEPRECATED_REMOVED */
Xiaofei Baic234ecf2022-02-08 09:59:23 +00004763#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004764 if (ssl->handshake->certificate_request_context) {
4765 mbedtls_free((void *) handshake->certificate_request_context);
Xiaofei Baic234ecf2022-02-08 09:59:23 +00004766 }
4767#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Ronald Crone68ab4f2022-10-05 12:46:29 +02004768#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Jerry Yuf017ee42022-01-12 15:49:48 +08004769
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02004770#if defined(MBEDTLS_SSL_ASYNC_PRIVATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01004771 if (ssl->conf->f_async_cancel != NULL && handshake->async_in_progress != 0) {
4772 ssl->conf->f_async_cancel(ssl);
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02004773 handshake->async_in_progress = 0;
4774 }
4775#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
4776
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01004777#if defined(MBEDTLS_MD_CAN_SHA256)
Andrzej Kurekeb342242019-01-29 09:14:33 -05004778#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01004779 psa_hash_abort(&handshake->fin_sha256_psa);
Andrzej Kurekeb342242019-01-29 09:14:33 -05004780#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01004781 mbedtls_md_free(&handshake->fin_sha256);
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02004782#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -05004783#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01004784#if defined(MBEDTLS_MD_CAN_SHA384)
Andrzej Kurekeb342242019-01-29 09:14:33 -05004785#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01004786 psa_hash_abort(&handshake->fin_sha384_psa);
Andrzej Kurekeb342242019-01-29 09:14:33 -05004787#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01004788 mbedtls_md_free(&handshake->fin_sha384);
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02004789#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -05004790#endif
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02004791
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004792#if defined(MBEDTLS_DHM_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004793 mbedtls_dhm_free(&handshake->dhm_ctx);
Paul Bakker48916f92012-09-16 19:57:18 +00004794#endif
Valerio Setti7aeec542023-07-05 18:57:21 +02004795#if !defined(MBEDTLS_USE_PSA_CRYPTO) && \
Valerio Setti6eb00542023-07-07 17:04:24 +02004796 defined(MBEDTLS_KEY_EXCHANGE_SOME_ECDH_OR_ECDHE_1_2_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004797 mbedtls_ecdh_free(&handshake->ecdh_ctx);
Paul Bakker61d113b2013-07-04 11:51:43 +02004798#endif
Valerio Setti02c25b52022-11-15 14:08:42 +01004799
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02004800#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Neil Armstrongca7d5062022-05-31 14:43:23 +02004801#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01004802 psa_pake_abort(&handshake->psa_pake_ctx);
Valerio Settieb3f7882022-12-08 18:42:58 +01004803 /*
4804 * Opaque keys are not stored in the handshake's data and it's the user
4805 * responsibility to destroy them. Clear ones, instead, are created by
4806 * the TLS library and should be destroyed at the same level
4807 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004808 if (!mbedtls_svc_key_id_is_null(handshake->psa_pake_password)) {
4809 psa_destroy_key(handshake->psa_pake_password);
Valerio Settieb3f7882022-12-08 18:42:58 +01004810 }
Neil Armstrongca7d5062022-05-31 14:43:23 +02004811 handshake->psa_pake_password = MBEDTLS_SVC_KEY_ID_INIT;
4812#else
Gilles Peskine449bd832023-01-11 14:50:10 +01004813 mbedtls_ecjpake_free(&handshake->ecjpake_ctx);
Neil Armstrongca7d5062022-05-31 14:43:23 +02004814#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard77c06462015-09-17 13:59:49 +02004815#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004816 mbedtls_free(handshake->ecjpake_cache);
Manuel Pégourié-Gonnard77c06462015-09-17 13:59:49 +02004817 handshake->ecjpake_cache = NULL;
4818 handshake->ecjpake_cache_len = 0;
4819#endif
Manuel Pégourié-Gonnard76cfd3f2015-09-15 12:10:54 +02004820#endif
Paul Bakker61d113b2013-07-04 11:51:43 +02004821
Valerio Setti7aeec542023-07-05 18:57:21 +02004822#if defined(MBEDTLS_KEY_EXCHANGE_SOME_ECDH_OR_ECDHE_ANY_ENABLED) || \
Valerio Setti45d56f32023-07-13 17:23:20 +02004823 defined(MBEDTLS_KEY_EXCHANGE_WITH_ECDSA_ANY_ENABLED) || \
Janos Follath4ae5c292016-02-10 11:27:43 +00004824 defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Paul Bakker9af723c2014-05-01 13:03:14 +02004825 /* explicit void pointer cast for buggy MS compiler */
Gilles Peskine449bd832023-01-11 14:50:10 +01004826 mbedtls_free((void *) handshake->curves_tls_id);
Manuel Pégourié-Gonnardd09453c2013-09-23 19:11:32 +02004827#endif
4828
Ronald Cron73fe8df2022-10-05 14:31:43 +02004829#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED)
Neil Armstrong501c9322022-05-03 09:35:09 +02004830#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01004831 if (!mbedtls_svc_key_id_is_null(ssl->handshake->psk_opaque)) {
Neil Armstrong501c9322022-05-03 09:35:09 +02004832 /* The maintenance of the external PSK key slot is the
4833 * user's responsibility. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004834 if (ssl->handshake->psk_opaque_is_internal) {
4835 psa_destroy_key(ssl->handshake->psk_opaque);
Neil Armstrong501c9322022-05-03 09:35:09 +02004836 ssl->handshake->psk_opaque_is_internal = 0;
4837 }
4838 ssl->handshake->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
4839 }
Neil Armstronge952a302022-05-03 10:22:14 +02004840#else
Gilles Peskine449bd832023-01-11 14:50:10 +01004841 if (handshake->psk != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01004842 mbedtls_zeroize_and_free(handshake->psk, handshake->psk_len);
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01004843 }
Neil Armstronge952a302022-05-03 10:22:14 +02004844#endif /* MBEDTLS_USE_PSA_CRYPTO */
Ronald Cron73fe8df2022-10-05 14:31:43 +02004845#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED */
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01004846
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004847#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
4848 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Manuel Pégourié-Gonnard83724542013-09-24 22:30:56 +02004849 /*
4850 * Free only the linked list wrapper, not the keys themselves
4851 * since the belong to the SNI callback
4852 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004853 ssl_key_cert_free(handshake->sni_key_cert);
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004854#endif /* MBEDTLS_X509_CRT_PARSE_C && MBEDTLS_SSL_SERVER_NAME_INDICATION */
Manuel Pégourié-Gonnard705fcca2013-09-23 20:04:20 +02004855
Gilles Peskineeccd8882020-03-10 12:19:08 +01004856#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004857 mbedtls_x509_crt_restart_free(&handshake->ecrs_ctx);
4858 if (handshake->ecrs_peer_cert != NULL) {
4859 mbedtls_x509_crt_free(handshake->ecrs_peer_cert);
4860 mbedtls_free(handshake->ecrs_peer_cert);
Hanno Becker3dad3112019-02-05 17:19:52 +00004861 }
Manuel Pégourié-Gonnard862cde52017-05-17 11:56:15 +02004862#endif
4863
Hanno Becker75173122019-02-06 16:18:31 +00004864#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
4865 !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01004866 mbedtls_pk_free(&handshake->peer_pubkey);
Hanno Becker75173122019-02-06 16:18:31 +00004867#endif /* MBEDTLS_X509_CRT_PARSE_C && !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
4868
XiaokangQian9b93c0d2022-02-09 06:02:25 +00004869#if defined(MBEDTLS_SSL_CLI_C) && \
Gilles Peskine449bd832023-01-11 14:50:10 +01004870 (defined(MBEDTLS_SSL_PROTO_DTLS) || defined(MBEDTLS_SSL_PROTO_TLS1_3))
4871 mbedtls_free(handshake->cookie);
XiaokangQian9b93c0d2022-02-09 06:02:25 +00004872#endif /* MBEDTLS_SSL_CLI_C &&
4873 ( MBEDTLS_SSL_PROTO_DTLS || MBEDTLS_SSL_PROTO_TLS1_3 ) */
XiaokangQian8499b6c2022-01-27 09:00:11 +00004874
4875#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004876 mbedtls_ssl_flight_free(handshake->flight);
4877 mbedtls_ssl_buffering_free(ssl);
XiaokangQian8499b6c2022-01-27 09:00:11 +00004878#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard74848812014-07-11 02:43:49 +02004879
Valerio Settiea59c432023-07-25 11:14:03 +02004880#if defined(MBEDTLS_KEY_EXCHANGE_SOME_XXDH_PSA_ANY_ENABLED)
Przemek Stekiel7ac93be2023-07-04 10:02:38 +02004881 if (handshake->xxdh_psa_privkey_is_external == 0) {
4882 psa_destroy_key(handshake->xxdh_psa_privkey);
Gilles Peskine449bd832023-01-11 14:50:10 +01004883 }
Valerio Settiea59c432023-07-25 11:14:03 +02004884#endif /* MBEDTLS_KEY_EXCHANGE_SOME_XXDH_PSA_ANY_ENABLED */
Hanno Becker4a63ed42019-01-08 11:39:35 +00004885
Ronald Cron6f135e12021-12-08 16:57:54 +01004886#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004887 mbedtls_ssl_transform_free(handshake->transform_handshake);
4888 mbedtls_free(handshake->transform_handshake);
Jerry Yu3d9b5902022-11-04 14:07:25 +08004889#if defined(MBEDTLS_SSL_EARLY_DATA)
Gilles Peskine449bd832023-01-11 14:50:10 +01004890 mbedtls_ssl_transform_free(handshake->transform_earlydata);
4891 mbedtls_free(handshake->transform_earlydata);
Jerry Yu3d9b5902022-11-04 14:07:25 +08004892#endif
Ronald Cron6f135e12021-12-08 16:57:54 +01004893#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yuba9c7272021-10-30 11:54:10 +08004894
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05004895
4896#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
4897 /* If the buffers are too big - reallocate. Because of the way Mbed TLS
4898 * processes datagrams and the fact that a datagram is allowed to have
4899 * several records in it, it is possible that the I/O buffers are not
4900 * empty at this stage */
Gilles Peskine449bd832023-01-11 14:50:10 +01004901 handle_buffer_resizing(ssl, 1, mbedtls_ssl_get_input_buflen(ssl),
4902 mbedtls_ssl_get_output_buflen(ssl));
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05004903#endif
Hanno Becker3aa186f2021-08-10 09:24:19 +01004904
Jerry Yuba9c7272021-10-30 11:54:10 +08004905 /* mbedtls_platform_zeroize MUST be last one in this function */
Gilles Peskine449bd832023-01-11 14:50:10 +01004906 mbedtls_platform_zeroize(handshake,
4907 sizeof(mbedtls_ssl_handshake_params));
Paul Bakker48916f92012-09-16 19:57:18 +00004908}
4909
Gilles Peskine449bd832023-01-11 14:50:10 +01004910void mbedtls_ssl_session_free(mbedtls_ssl_session *session)
Paul Bakker48916f92012-09-16 19:57:18 +00004911{
Gilles Peskine449bd832023-01-11 14:50:10 +01004912 if (session == NULL) {
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004913 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01004914 }
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004915
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004916#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004917 ssl_clear_peer_cert(session);
Paul Bakkered27a042013-04-18 22:46:23 +02004918#endif
Paul Bakker0a597072012-09-25 21:55:46 +00004919
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02004920#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
Xiaokang Qianbc663a02022-10-09 11:14:39 +00004921#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && \
4922 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01004923 mbedtls_free(session->hostname);
Xiaokang Qian281fd1b2022-09-20 11:35:41 +00004924#endif
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00004925 mbedtls_free(session->ticket);
4926#endif
4927
Waleed Elmelegy2824a202024-02-23 17:51:47 +00004928#if defined(MBEDTLS_SSL_EARLY_DATA) && defined(MBEDTLS_SSL_ALPN) && \
4929 defined(MBEDTLS_SSL_SRV_C)
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00004930 mbedtls_free(session->ticket_alpn);
Paul Bakkera503a632013-08-14 13:48:06 +02004931#endif
Manuel Pégourié-Gonnard75d44012013-08-02 14:44:04 +02004932
Gilles Peskine449bd832023-01-11 14:50:10 +01004933 mbedtls_platform_zeroize(session, sizeof(mbedtls_ssl_session));
Paul Bakker48916f92012-09-16 19:57:18 +00004934}
4935
Manuel Pégourié-Gonnard5c0e3772019-07-23 16:13:17 +02004936#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004937
4938#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
4939#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID 1u
4940#else
4941#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID 0u
4942#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
4943
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004944#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT 1u
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004945
4946#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
4947#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY 1u
4948#else
4949#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY 0u
4950#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
4951
4952#if defined(MBEDTLS_SSL_ALPN)
4953#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN 1u
4954#else
4955#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN 0u
4956#endif /* MBEDTLS_SSL_ALPN */
4957
4958#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID_BIT 0
4959#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT_BIT 1
4960#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY_BIT 2
4961#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN_BIT 3
4962
4963#define SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG \
Gilles Peskine449bd832023-01-11 14:50:10 +01004964 ((uint32_t) ( \
4965 (SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID << \
4966 SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID_BIT) | \
4967 (SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT << \
4968 SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT_BIT) | \
4969 (SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY << \
4970 SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY_BIT) | \
4971 (SSL_SERIALIZED_CONTEXT_CONFIG_ALPN << SSL_SERIALIZED_CONTEXT_CONFIG_ALPN_BIT) | \
4972 0u))
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004973
Chien Wong4e9683e2023-12-28 17:07:43 +08004974static const unsigned char ssl_serialized_context_header[] = {
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004975 MBEDTLS_VERSION_MAJOR,
4976 MBEDTLS_VERSION_MINOR,
4977 MBEDTLS_VERSION_PATCH,
Gilles Peskine449bd832023-01-11 14:50:10 +01004978 MBEDTLS_BYTE_1(SSL_SERIALIZED_SESSION_CONFIG_BITFLAG),
4979 MBEDTLS_BYTE_0(SSL_SERIALIZED_SESSION_CONFIG_BITFLAG),
4980 MBEDTLS_BYTE_2(SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG),
4981 MBEDTLS_BYTE_1(SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG),
4982 MBEDTLS_BYTE_0(SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG),
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004983};
4984
Paul Bakker5121ce52009-01-03 21:22:43 +00004985/*
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004986 * Serialize a full SSL context
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02004987 *
4988 * The format of the serialized data is:
4989 * (in the presentation language of TLS, RFC 8446 section 3)
4990 *
4991 * // header
4992 * opaque mbedtls_version[3]; // major, minor, patch
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004993 * opaque context_format[5]; // version-specific field determining
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02004994 * // the format of the remaining
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004995 * // serialized data.
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004996 * Note: When updating the format, remember to keep these
4997 * version+format bytes. (We may make their size part of the API.)
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02004998 *
4999 * // session sub-structure
5000 * opaque session<1..2^32-1>; // see mbedtls_ssl_session_save()
5001 * // transform sub-structure
5002 * uint8 random[64]; // ServerHello.random+ClientHello.random
5003 * uint8 in_cid<0..2^8-1> // Connection ID: expected incoming value
5004 * uint8 out_cid<0..2^8-1> // Connection ID: outgoing value to use
5005 * // fields from ssl_context
5006 * uint32 badmac_seen; // DTLS: number of records with failing MAC
5007 * uint64 in_window_top; // DTLS: last validated record seq_num
5008 * uint64 in_window; // DTLS: bitmask for replay protection
5009 * uint8 disable_datagram_packing; // DTLS: only one record per datagram
5010 * uint64 cur_out_ctr; // Record layer: outgoing sequence number
5011 * uint16 mtu; // DTLS: path mtu (max outgoing fragment size)
5012 * uint8 alpn_chosen<0..2^8-1> // ALPN: negotiated application protocol
5013 *
5014 * Note that many fields of the ssl_context or sub-structures are not
5015 * serialized, as they fall in one of the following categories:
5016 *
5017 * 1. forced value (eg in_left must be 0)
5018 * 2. pointer to dynamically-allocated memory (eg session, transform)
5019 * 3. value can be re-derived from other data (eg session keys from MS)
5020 * 4. value was temporary (eg content of input buffer)
5021 * 5. value will be provided by the user again (eg I/O callbacks and context)
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005022 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005023int mbedtls_ssl_context_save(mbedtls_ssl_context *ssl,
5024 unsigned char *buf,
5025 size_t buf_len,
5026 size_t *olen)
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005027{
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005028 unsigned char *p = buf;
5029 size_t used = 0;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005030 size_t session_len;
5031 int ret = 0;
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005032
Manuel Pégourié-Gonnard1aaf6692019-07-10 14:14:05 +02005033 /*
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02005034 * Enforce usage restrictions, see "return BAD_INPUT_DATA" in
5035 * this function's documentation.
5036 *
5037 * These are due to assumptions/limitations in the implementation. Some of
5038 * them are likely to stay (no handshake in progress) some might go away
5039 * (only DTLS) but are currently used to simplify the implementation.
Manuel Pégourié-Gonnard1aaf6692019-07-10 14:14:05 +02005040 */
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02005041 /* The initial handshake must be over */
Gilles Peskine449bd832023-01-11 14:50:10 +01005042 if (mbedtls_ssl_is_handshake_over(ssl) == 0) {
5043 MBEDTLS_SSL_DEBUG_MSG(1, ("Initial handshake isn't over"));
5044 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03005045 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005046 if (ssl->handshake != NULL) {
5047 MBEDTLS_SSL_DEBUG_MSG(1, ("Handshake isn't completed"));
5048 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03005049 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02005050 /* Double-check that sub-structures are indeed ready */
Gilles Peskine449bd832023-01-11 14:50:10 +01005051 if (ssl->transform == NULL || ssl->session == NULL) {
5052 MBEDTLS_SSL_DEBUG_MSG(1, ("Serialised structures aren't ready"));
5053 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03005054 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02005055 /* There must be no pending incoming or outgoing data */
Gilles Peskine449bd832023-01-11 14:50:10 +01005056 if (mbedtls_ssl_check_pending(ssl) != 0) {
5057 MBEDTLS_SSL_DEBUG_MSG(1, ("There is pending incoming data"));
5058 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03005059 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005060 if (ssl->out_left != 0) {
5061 MBEDTLS_SSL_DEBUG_MSG(1, ("There is pending outgoing data"));
5062 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03005063 }
Dave Rodgman556e8a32022-12-06 16:31:25 +00005064 /* Protocol must be DTLS, not TLS */
Gilles Peskine449bd832023-01-11 14:50:10 +01005065 if (ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
5066 MBEDTLS_SSL_DEBUG_MSG(1, ("Only DTLS is supported"));
5067 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03005068 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02005069 /* Version must be 1.2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005070 if (ssl->tls_version != MBEDTLS_SSL_VERSION_TLS1_2) {
5071 MBEDTLS_SSL_DEBUG_MSG(1, ("Only version 1.2 supported"));
5072 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03005073 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02005074 /* We must be using an AEAD ciphersuite */
Gilles Peskine449bd832023-01-11 14:50:10 +01005075 if (mbedtls_ssl_transform_uses_aead(ssl->transform) != 1) {
5076 MBEDTLS_SSL_DEBUG_MSG(1, ("Only AEAD ciphersuites 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 /* Renegotiation must not be enabled */
5080#if defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01005081 if (ssl->conf->disable_renegotiation != MBEDTLS_SSL_RENEGOTIATION_DISABLED) {
5082 MBEDTLS_SSL_DEBUG_MSG(1, ("Renegotiation must not be enabled"));
5083 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03005084 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02005085#endif
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005086
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005087 /*
5088 * Version and format identifier
5089 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005090 used += sizeof(ssl_serialized_context_header);
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005091
Gilles Peskine449bd832023-01-11 14:50:10 +01005092 if (used <= buf_len) {
5093 memcpy(p, ssl_serialized_context_header,
5094 sizeof(ssl_serialized_context_header));
5095 p += sizeof(ssl_serialized_context_header);
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005096 }
5097
5098 /*
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005099 * Session (length + data)
5100 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005101 ret = ssl_session_save(ssl->session, 1, NULL, 0, &session_len);
5102 if (ret != MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL) {
5103 return ret;
5104 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005105
5106 used += 4 + session_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01005107 if (used <= buf_len) {
5108 MBEDTLS_PUT_UINT32_BE(session_len, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01005109 p += 4;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005110
Gilles Peskine449bd832023-01-11 14:50:10 +01005111 ret = ssl_session_save(ssl->session, 1,
5112 p, session_len, &session_len);
5113 if (ret != 0) {
5114 return ret;
5115 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005116
5117 p += session_len;
5118 }
5119
5120 /*
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005121 * Transform
5122 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005123 used += sizeof(ssl->transform->randbytes);
5124 if (used <= buf_len) {
5125 memcpy(p, ssl->transform->randbytes,
5126 sizeof(ssl->transform->randbytes));
5127 p += sizeof(ssl->transform->randbytes);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005128 }
5129
5130#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Dave Rodgmanc37ad442023-11-03 23:36:06 +00005131 used += 2U + ssl->transform->in_cid_len + ssl->transform->out_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01005132 if (used <= buf_len) {
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005133 *p++ = ssl->transform->in_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01005134 memcpy(p, ssl->transform->in_cid, ssl->transform->in_cid_len);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005135 p += ssl->transform->in_cid_len;
5136
5137 *p++ = ssl->transform->out_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01005138 memcpy(p, ssl->transform->out_cid, ssl->transform->out_cid_len);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005139 p += ssl->transform->out_cid_len;
5140 }
5141#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
5142
5143 /*
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005144 * Saved fields from top-level ssl_context structure
5145 */
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005146 used += 4;
Gilles Peskine449bd832023-01-11 14:50:10 +01005147 if (used <= buf_len) {
5148 MBEDTLS_PUT_UINT32_BE(ssl->badmac_seen, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01005149 p += 4;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005150 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005151
5152#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
5153 used += 16;
Gilles Peskine449bd832023-01-11 14:50:10 +01005154 if (used <= buf_len) {
5155 MBEDTLS_PUT_UINT64_BE(ssl->in_window_top, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01005156 p += 8;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005157
Gilles Peskine449bd832023-01-11 14:50:10 +01005158 MBEDTLS_PUT_UINT64_BE(ssl->in_window, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01005159 p += 8;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005160 }
5161#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
5162
5163#if defined(MBEDTLS_SSL_PROTO_DTLS)
5164 used += 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01005165 if (used <= buf_len) {
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005166 *p++ = ssl->disable_datagram_packing;
5167 }
5168#endif /* MBEDTLS_SSL_PROTO_DTLS */
5169
Jerry Yuae0b2e22021-10-08 15:21:19 +08005170 used += MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Gilles Peskine449bd832023-01-11 14:50:10 +01005171 if (used <= buf_len) {
5172 memcpy(p, ssl->cur_out_ctr, MBEDTLS_SSL_SEQUENCE_NUMBER_LEN);
Jerry Yuae0b2e22021-10-08 15:21:19 +08005173 p += MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005174 }
5175
5176#if defined(MBEDTLS_SSL_PROTO_DTLS)
5177 used += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01005178 if (used <= buf_len) {
5179 MBEDTLS_PUT_UINT16_BE(ssl->mtu, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01005180 p += 2;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005181 }
5182#endif /* MBEDTLS_SSL_PROTO_DTLS */
5183
5184#if defined(MBEDTLS_SSL_ALPN)
5185 {
5186 const uint8_t alpn_len = ssl->alpn_chosen
Gilles Peskine449bd832023-01-11 14:50:10 +01005187 ? (uint8_t) strlen(ssl->alpn_chosen)
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005188 : 0;
5189
5190 used += 1 + alpn_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01005191 if (used <= buf_len) {
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005192 *p++ = alpn_len;
5193
Gilles Peskine449bd832023-01-11 14:50:10 +01005194 if (ssl->alpn_chosen != NULL) {
5195 memcpy(p, ssl->alpn_chosen, alpn_len);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005196 p += alpn_len;
5197 }
5198 }
5199 }
5200#endif /* MBEDTLS_SSL_ALPN */
5201
5202 /*
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005203 * Done
5204 */
5205 *olen = used;
5206
Gilles Peskine449bd832023-01-11 14:50:10 +01005207 if (used > buf_len) {
5208 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
5209 }
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005210
Gilles Peskine449bd832023-01-11 14:50:10 +01005211 MBEDTLS_SSL_DEBUG_BUF(4, "saved context", buf, used);
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005212
Gilles Peskine449bd832023-01-11 14:50:10 +01005213 return mbedtls_ssl_session_reset_int(ssl, 0);
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005214}
5215
5216/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02005217 * Deserialize context, see mbedtls_ssl_context_save() for format.
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005218 *
5219 * This internal version is wrapped by a public function that cleans up in
5220 * case of error.
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005221 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005222MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01005223static int ssl_context_load(mbedtls_ssl_context *ssl,
5224 const unsigned char *buf,
5225 size_t len)
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005226{
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005227 const unsigned char *p = buf;
5228 const unsigned char * const end = buf + len;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005229 size_t session_len;
Janos Follath865b3eb2019-12-16 11:46:15 +00005230 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04005231#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Andrzej Kurek894edde2022-09-29 06:31:14 -04005232 tls_prf_fn prf_func = NULL;
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04005233#endif
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005234
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02005235 /*
5236 * The context should have been freshly setup or reset.
5237 * Give the user an error in case of obvious misuse.
Manuel Pégourié-Gonnard4ca930f2019-07-26 16:31:53 +02005238 * (Checking session is useful because it won't be NULL if we're
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02005239 * renegotiating, or if the user mistakenly loaded a session first.)
5240 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005241 if (ssl->state != MBEDTLS_SSL_HELLO_REQUEST ||
5242 ssl->session != NULL) {
5243 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02005244 }
5245
5246 /*
5247 * We can't check that the config matches the initial one, but we can at
5248 * least check it matches the requirements for serializing.
5249 */
Dave Rodgmane99b24d2023-09-14 15:45:03 +01005250 if (
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02005251#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard9a96fd72019-07-23 17:11:24 +02005252 ssl->conf->disable_renegotiation != MBEDTLS_SSL_RENEGOTIATION_DISABLED ||
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02005253#endif
Dave Rodgmane99b24d2023-09-14 15:45:03 +01005254 ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM ||
5255 ssl->conf->max_tls_version < MBEDTLS_SSL_VERSION_TLS1_2 ||
5256 ssl->conf->min_tls_version > MBEDTLS_SSL_VERSION_TLS1_2
5257 ) {
Gilles Peskine449bd832023-01-11 14:50:10 +01005258 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02005259 }
5260
Gilles Peskine449bd832023-01-11 14:50:10 +01005261 MBEDTLS_SSL_DEBUG_BUF(4, "context to load", buf, len);
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005262
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005263 /*
5264 * Check version identifier
5265 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005266 if ((size_t) (end - p) < sizeof(ssl_serialized_context_header)) {
5267 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005268 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005269
5270 if (memcmp(p, ssl_serialized_context_header,
5271 sizeof(ssl_serialized_context_header)) != 0) {
5272 return MBEDTLS_ERR_SSL_VERSION_MISMATCH;
5273 }
5274 p += sizeof(ssl_serialized_context_header);
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005275
5276 /*
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005277 * Session
5278 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005279 if ((size_t) (end - p) < 4) {
5280 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5281 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005282
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01005283 session_len = MBEDTLS_GET_UINT32_BE(p, 0);
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005284 p += 4;
5285
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02005286 /* This has been allocated by ssl_handshake_init(), called by
Hanno Becker43aefe22020-02-05 10:44:56 +00005287 * by either mbedtls_ssl_session_reset_int() or mbedtls_ssl_setup(). */
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02005288 ssl->session = ssl->session_negotiate;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005289 ssl->session_in = ssl->session;
5290 ssl->session_out = ssl->session;
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02005291 ssl->session_negotiate = NULL;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005292
Gilles Peskine449bd832023-01-11 14:50:10 +01005293 if ((size_t) (end - p) < session_len) {
5294 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5295 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005296
Gilles Peskine449bd832023-01-11 14:50:10 +01005297 ret = ssl_session_load(ssl->session, 1, p, session_len);
5298 if (ret != 0) {
5299 mbedtls_ssl_session_free(ssl->session);
5300 return ret;
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02005301 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005302
5303 p += session_len;
5304
5305 /*
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005306 * Transform
5307 */
5308
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02005309 /* This has been allocated by ssl_handshake_init(), called by
Hanno Becker43aefe22020-02-05 10:44:56 +00005310 * by either mbedtls_ssl_session_reset_int() or mbedtls_ssl_setup(). */
Jerry Yu2e199812022-12-01 18:57:19 +08005311#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02005312 ssl->transform = ssl->transform_negotiate;
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005313 ssl->transform_in = ssl->transform;
5314 ssl->transform_out = ssl->transform;
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02005315 ssl->transform_negotiate = NULL;
Jerry Yu2e199812022-12-01 18:57:19 +08005316#endif
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005317
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04005318#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005319 prf_func = ssl_tls12prf_from_cs(ssl->session->ciphersuite);
5320 if (prf_func == NULL) {
5321 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5322 }
Andrzej Kurek894edde2022-09-29 06:31:14 -04005323
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005324 /* Read random bytes and populate structure */
Gilles Peskine449bd832023-01-11 14:50:10 +01005325 if ((size_t) (end - p) < sizeof(ssl->transform->randbytes)) {
5326 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5327 }
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04005328
Gilles Peskine449bd832023-01-11 14:50:10 +01005329 ret = ssl_tls12_populate_transform(ssl->transform,
5330 ssl->session->ciphersuite,
5331 ssl->session->master,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02005332#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01005333 ssl->session->encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02005334#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01005335 prf_func,
5336 p, /* currently pointing to randbytes */
5337 MBEDTLS_SSL_VERSION_TLS1_2, /* (D)TLS 1.2 is forced */
5338 ssl->conf->endpoint,
5339 ssl);
5340 if (ret != 0) {
5341 return ret;
5342 }
Jerry Yu840fbb22022-02-17 14:59:29 +08005343#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005344 p += sizeof(ssl->transform->randbytes);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005345
5346#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
5347 /* Read connection IDs and store them */
Gilles Peskine449bd832023-01-11 14:50:10 +01005348 if ((size_t) (end - p) < 1) {
5349 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5350 }
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005351
5352 ssl->transform->in_cid_len = *p++;
5353
Gilles Peskine449bd832023-01-11 14:50:10 +01005354 if ((size_t) (end - p) < ssl->transform->in_cid_len + 1u) {
5355 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5356 }
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005357
Gilles Peskine449bd832023-01-11 14:50:10 +01005358 memcpy(ssl->transform->in_cid, p, ssl->transform->in_cid_len);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005359 p += ssl->transform->in_cid_len;
5360
5361 ssl->transform->out_cid_len = *p++;
5362
Gilles Peskine449bd832023-01-11 14:50:10 +01005363 if ((size_t) (end - p) < ssl->transform->out_cid_len) {
5364 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5365 }
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005366
Gilles Peskine449bd832023-01-11 14:50:10 +01005367 memcpy(ssl->transform->out_cid, p, ssl->transform->out_cid_len);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005368 p += ssl->transform->out_cid_len;
5369#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
5370
5371 /*
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005372 * Saved fields from top-level ssl_context structure
5373 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005374 if ((size_t) (end - p) < 4) {
5375 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5376 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005377
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01005378 ssl->badmac_seen = MBEDTLS_GET_UINT32_BE(p, 0);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005379 p += 4;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005380
5381#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Gilles Peskine449bd832023-01-11 14:50:10 +01005382 if ((size_t) (end - p) < 16) {
5383 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5384 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005385
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01005386 ssl->in_window_top = MBEDTLS_GET_UINT64_BE(p, 0);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005387 p += 8;
5388
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01005389 ssl->in_window = MBEDTLS_GET_UINT64_BE(p, 0);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005390 p += 8;
5391#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
5392
5393#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005394 if ((size_t) (end - p) < 1) {
5395 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5396 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005397
5398 ssl->disable_datagram_packing = *p++;
5399#endif /* MBEDTLS_SSL_PROTO_DTLS */
5400
Gilles Peskine449bd832023-01-11 14:50:10 +01005401 if ((size_t) (end - p) < sizeof(ssl->cur_out_ctr)) {
5402 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5403 }
5404 memcpy(ssl->cur_out_ctr, p, sizeof(ssl->cur_out_ctr));
5405 p += sizeof(ssl->cur_out_ctr);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005406
5407#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005408 if ((size_t) (end - p) < 2) {
5409 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5410 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005411
Dave Rodgmana3d0f612023-11-03 23:34:02 +00005412 ssl->mtu = MBEDTLS_GET_UINT16_BE(p, 0);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005413 p += 2;
5414#endif /* MBEDTLS_SSL_PROTO_DTLS */
5415
5416#if defined(MBEDTLS_SSL_ALPN)
5417 {
5418 uint8_t alpn_len;
5419 const char **cur;
5420
Gilles Peskine449bd832023-01-11 14:50:10 +01005421 if ((size_t) (end - p) < 1) {
5422 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5423 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005424
5425 alpn_len = *p++;
5426
Gilles Peskine449bd832023-01-11 14:50:10 +01005427 if (alpn_len != 0 && ssl->conf->alpn_list != NULL) {
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005428 /* alpn_chosen should point to an item in the configured list */
Gilles Peskine449bd832023-01-11 14:50:10 +01005429 for (cur = ssl->conf->alpn_list; *cur != NULL; cur++) {
5430 if (strlen(*cur) == alpn_len &&
5431 memcmp(p, cur, alpn_len) == 0) {
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005432 ssl->alpn_chosen = *cur;
5433 break;
5434 }
5435 }
5436 }
5437
5438 /* can only happen on conf mismatch */
Gilles Peskine449bd832023-01-11 14:50:10 +01005439 if (alpn_len != 0 && ssl->alpn_chosen == NULL) {
5440 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5441 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005442
5443 p += alpn_len;
5444 }
5445#endif /* MBEDTLS_SSL_ALPN */
5446
5447 /*
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02005448 * Forced fields from top-level ssl_context structure
5449 *
5450 * Most of them already set to the correct value by mbedtls_ssl_init() and
5451 * mbedtls_ssl_reset(), so we only need to set the remaining ones.
5452 */
5453 ssl->state = MBEDTLS_SSL_HANDSHAKE_OVER;
Glenn Strauss60bfe602022-03-14 19:04:24 -04005454 ssl->tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02005455
Hanno Becker361b10d2019-08-30 10:42:49 +01005456 /* Adjust pointers for header fields of outgoing records to
5457 * the given transform, accounting for explicit IV and CID. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005458 mbedtls_ssl_update_out_pointers(ssl, ssl->transform);
Hanno Becker361b10d2019-08-30 10:42:49 +01005459
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02005460#if defined(MBEDTLS_SSL_PROTO_DTLS)
5461 ssl->in_epoch = 1;
5462#endif
5463
5464 /* mbedtls_ssl_reset() leaves the handshake sub-structure allocated,
5465 * which we don't want - otherwise we'd end up freeing the wrong transform
Hanno Beckerce5f5fd2020-02-05 10:47:44 +00005466 * by calling mbedtls_ssl_handshake_wrapup_free_hs_transform()
5467 * inappropriately. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005468 if (ssl->handshake != NULL) {
5469 mbedtls_ssl_handshake_free(ssl);
5470 mbedtls_free(ssl->handshake);
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02005471 ssl->handshake = NULL;
5472 }
5473
5474 /*
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005475 * Done - should have consumed entire buffer
5476 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005477 if (p != end) {
5478 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5479 }
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005480
Gilles Peskine449bd832023-01-11 14:50:10 +01005481 return 0;
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005482}
5483
5484/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02005485 * Deserialize context: public wrapper for error cleaning
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005486 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005487int mbedtls_ssl_context_load(mbedtls_ssl_context *context,
5488 const unsigned char *buf,
5489 size_t len)
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005490{
Gilles Peskine449bd832023-01-11 14:50:10 +01005491 int ret = ssl_context_load(context, buf, len);
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005492
Gilles Peskine449bd832023-01-11 14:50:10 +01005493 if (ret != 0) {
5494 mbedtls_ssl_free(context);
5495 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005496
Gilles Peskine449bd832023-01-11 14:50:10 +01005497 return ret;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005498}
Manuel Pégourié-Gonnard5c0e3772019-07-23 16:13:17 +02005499#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005500
5501/*
Paul Bakker5121ce52009-01-03 21:22:43 +00005502 * Free an SSL context
5503 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005504void mbedtls_ssl_free(mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00005505{
Gilles Peskine449bd832023-01-11 14:50:10 +01005506 if (ssl == NULL) {
Paul Bakkeraccaffe2014-06-26 13:37:14 +02005507 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01005508 }
Paul Bakkeraccaffe2014-06-26 13:37:14 +02005509
Gilles Peskine449bd832023-01-11 14:50:10 +01005510 MBEDTLS_SSL_DEBUG_MSG(2, ("=> free"));
Paul Bakker5121ce52009-01-03 21:22:43 +00005511
Gilles Peskine449bd832023-01-11 14:50:10 +01005512 if (ssl->out_buf != NULL) {
sander-visserb8aa2072020-05-06 22:05:13 +02005513#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
5514 size_t out_buf_len = ssl->out_buf_len;
5515#else
5516 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
5517#endif
5518
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005519 mbedtls_zeroize_and_free(ssl->out_buf, out_buf_len);
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05005520 ssl->out_buf = NULL;
Paul Bakker5121ce52009-01-03 21:22:43 +00005521 }
5522
Gilles Peskine449bd832023-01-11 14:50:10 +01005523 if (ssl->in_buf != NULL) {
sander-visserb8aa2072020-05-06 22:05:13 +02005524#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
5525 size_t in_buf_len = ssl->in_buf_len;
5526#else
5527 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
5528#endif
5529
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005530 mbedtls_zeroize_and_free(ssl->in_buf, in_buf_len);
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05005531 ssl->in_buf = NULL;
Paul Bakker5121ce52009-01-03 21:22:43 +00005532 }
5533
Gilles Peskine449bd832023-01-11 14:50:10 +01005534 if (ssl->transform) {
5535 mbedtls_ssl_transform_free(ssl->transform);
5536 mbedtls_free(ssl->transform);
Paul Bakker48916f92012-09-16 19:57:18 +00005537 }
5538
Gilles Peskine449bd832023-01-11 14:50:10 +01005539 if (ssl->handshake) {
5540 mbedtls_ssl_handshake_free(ssl);
5541 mbedtls_free(ssl->handshake);
Jerry Yu2e199812022-12-01 18:57:19 +08005542
5543#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005544 mbedtls_ssl_transform_free(ssl->transform_negotiate);
5545 mbedtls_free(ssl->transform_negotiate);
Jerry Yu2e199812022-12-01 18:57:19 +08005546#endif
5547
Gilles Peskine449bd832023-01-11 14:50:10 +01005548 mbedtls_ssl_session_free(ssl->session_negotiate);
5549 mbedtls_free(ssl->session_negotiate);
Paul Bakker48916f92012-09-16 19:57:18 +00005550 }
5551
Ronald Cron6f135e12021-12-08 16:57:54 +01005552#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01005553 mbedtls_ssl_transform_free(ssl->transform_application);
5554 mbedtls_free(ssl->transform_application);
Ronald Cron6f135e12021-12-08 16:57:54 +01005555#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker3aa186f2021-08-10 09:24:19 +01005556
Gilles Peskine449bd832023-01-11 14:50:10 +01005557 if (ssl->session) {
5558 mbedtls_ssl_session_free(ssl->session);
5559 mbedtls_free(ssl->session);
Paul Bakkerc0463502013-02-14 11:19:38 +01005560 }
5561
Manuel Pégourié-Gonnard55fab2d2015-05-11 16:15:19 +02005562#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005563 if (ssl->hostname != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005564 mbedtls_zeroize_and_free(ssl->hostname, strlen(ssl->hostname));
Paul Bakker5121ce52009-01-03 21:22:43 +00005565 }
Paul Bakker0be444a2013-08-27 21:55:01 +02005566#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00005567
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02005568#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005569 mbedtls_free(ssl->cli_id);
Manuel Pégourié-Gonnard43c02182014-07-22 17:32:01 +02005570#endif
5571
Gilles Peskine449bd832023-01-11 14:50:10 +01005572 MBEDTLS_SSL_DEBUG_MSG(2, ("<= free"));
Paul Bakker2da561c2009-02-05 18:00:28 +00005573
Paul Bakker86f04f42013-02-14 11:20:09 +01005574 /* Actually clear after last debug message */
Gilles Peskine449bd832023-01-11 14:50:10 +01005575 mbedtls_platform_zeroize(ssl, sizeof(mbedtls_ssl_context));
Paul Bakker5121ce52009-01-03 21:22:43 +00005576}
5577
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005578/*
Shaun Case8b0ecbc2021-12-20 21:14:10 -08005579 * Initialize mbedtls_ssl_config
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005580 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005581void mbedtls_ssl_config_init(mbedtls_ssl_config *conf)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005582{
Gilles Peskine449bd832023-01-11 14:50:10 +01005583 memset(conf, 0, sizeof(mbedtls_ssl_config));
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005584}
5585
Gilles Peskineae270bf2021-06-02 00:05:29 +02005586/* The selection should be the same as mbedtls_x509_crt_profile_default in
5587 * x509_crt.c, plus Montgomery curves for ECDHE. Here, the order matters:
Gilles Peskineb1940a72021-06-02 15:18:12 +02005588 * curves with a lower resource usage come first.
Gilles Peskineae270bf2021-06-02 00:05:29 +02005589 * See the documentation of mbedtls_ssl_conf_curves() for what we promise
Gilles Peskineb1940a72021-06-02 15:18:12 +02005590 * about this list.
5591 */
Chien Wong4e9683e2023-12-28 17:07:43 +08005592static const uint16_t ssl_preset_default_groups[] = {
Valerio Settidb6b4db2023-09-01 09:20:51 +02005593#if defined(MBEDTLS_ECP_HAVE_CURVE25519)
Brett Warrene0edc842021-08-17 09:53:13 +01005594 MBEDTLS_SSL_IANA_TLS_GROUP_X25519,
Gilles Peskineae270bf2021-06-02 00:05:29 +02005595#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005596#if defined(MBEDTLS_ECP_HAVE_SECP256R1)
Brett Warrene0edc842021-08-17 09:53:13 +01005597 MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1,
Gilles Peskineae270bf2021-06-02 00:05:29 +02005598#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005599#if defined(MBEDTLS_ECP_HAVE_SECP384R1)
Brett Warrene0edc842021-08-17 09:53:13 +01005600 MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02005601#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005602#if defined(MBEDTLS_ECP_HAVE_CURVE448)
Brett Warrene0edc842021-08-17 09:53:13 +01005603 MBEDTLS_SSL_IANA_TLS_GROUP_X448,
Gilles Peskineb1940a72021-06-02 15:18:12 +02005604#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005605#if defined(MBEDTLS_ECP_HAVE_SECP521R1)
Brett Warrene0edc842021-08-17 09:53:13 +01005606 MBEDTLS_SSL_IANA_TLS_GROUP_SECP521R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02005607#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005608#if defined(MBEDTLS_ECP_HAVE_BP256R1)
Brett Warrene0edc842021-08-17 09:53:13 +01005609 MBEDTLS_SSL_IANA_TLS_GROUP_BP256R1,
Gilles Peskineae270bf2021-06-02 00:05:29 +02005610#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005611#if defined(MBEDTLS_ECP_HAVE_BP384R1)
Brett Warrene0edc842021-08-17 09:53:13 +01005612 MBEDTLS_SSL_IANA_TLS_GROUP_BP384R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02005613#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005614#if defined(MBEDTLS_ECP_HAVE_BP512R1)
Brett Warrene0edc842021-08-17 09:53:13 +01005615 MBEDTLS_SSL_IANA_TLS_GROUP_BP512R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02005616#endif
Przemek Stekiel316c19e2023-05-31 15:25:11 +02005617#if defined(PSA_WANT_ALG_FFDH)
Przemek Stekiel383f4712022-12-12 14:48:57 +01005618 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE2048,
5619 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE3072,
5620 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE4096,
5621 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE6144,
5622 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE8192,
5623#endif
Brett Warrene0edc842021-08-17 09:53:13 +01005624 MBEDTLS_SSL_IANA_TLS_GROUP_NONE
Gilles Peskineae270bf2021-06-02 00:05:29 +02005625};
Gilles Peskineae270bf2021-06-02 00:05:29 +02005626
Alexey Tsvetkov2ca34372022-06-07 10:21:05 +03005627static const int ssl_preset_suiteb_ciphersuites[] = {
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005628 MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256,
5629 MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384,
5630 0
5631};
5632
Ronald Crone68ab4f2022-10-05 12:46:29 +02005633#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Hanno Becker9c6aa7b2021-08-10 13:50:43 +01005634
Jerry Yu909df7b2022-01-22 11:56:27 +08005635/* NOTICE:
Jerry Yu0b994b82022-01-25 17:22:12 +08005636 * For ssl_preset_*_sig_algs and ssl_tls12_preset_*_sig_algs, the following
Jerry Yu370e1462022-01-25 10:36:53 +08005637 * rules SHOULD be upheld.
5638 * - No duplicate entries.
5639 * - But if there is a good reason, do not change the order of the algorithms.
Jerry Yu09a99fc2022-07-28 14:22:17 +08005640 * - ssl_tls12_preset* is for TLS 1.2 use only.
Jerry Yu370e1462022-01-25 10:36:53 +08005641 * - ssl_preset_* is for TLS 1.3 only or hybrid TLS 1.3/1.2 handshakes.
Jerry Yu1a8b4812022-01-20 17:56:50 +08005642 */
Chien Wong4e9683e2023-12-28 17:07:43 +08005643static const uint16_t ssl_preset_default_sig_algs[] = {
Jerry Yu1a8b4812022-01-20 17:56:50 +08005644
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005645#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005646 defined(MBEDTLS_MD_CAN_SHA256) && \
Valerio Setticf29c5d2023-09-01 09:03:41 +02005647 defined(PSA_WANT_ECC_SECP_R1_256)
Jerry Yued5e9f42022-01-26 11:21:34 +08005648 MBEDTLS_TLS1_3_SIG_ECDSA_SECP256R1_SHA256,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005649 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256)
5650#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08005651
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005652#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005653 defined(MBEDTLS_MD_CAN_SHA384) && \
Valerio Setticf29c5d2023-09-01 09:03:41 +02005654 defined(PSA_WANT_ECC_SECP_R1_384)
Jerry Yu909df7b2022-01-22 11:56:27 +08005655 MBEDTLS_TLS1_3_SIG_ECDSA_SECP384R1_SHA384,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005656 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384)
5657#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08005658
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005659#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005660 defined(MBEDTLS_MD_CAN_SHA512) && \
Valerio Setticf29c5d2023-09-01 09:03:41 +02005661 defined(PSA_WANT_ECC_SECP_R1_521)
Jerry Yued5e9f42022-01-26 11:21:34 +08005662 MBEDTLS_TLS1_3_SIG_ECDSA_SECP521R1_SHA512,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005663 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA512)
5664#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08005665
Yanray Wang1136fad2023-11-22 16:54:31 +08005666#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && defined(MBEDTLS_MD_CAN_SHA512)
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005667 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA512,
Yanray Wang1136fad2023-11-22 16:54:31 +08005668#endif
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005669
Yanray Wang1136fad2023-11-22 16:54:31 +08005670#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && defined(MBEDTLS_MD_CAN_SHA384)
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005671 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA384,
Yanray Wang1136fad2023-11-22 16:54:31 +08005672#endif
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005673
Yanray Wang1136fad2023-11-22 16:54:31 +08005674#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && defined(MBEDTLS_MD_CAN_SHA256)
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005675 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256,
Yanray Wang1136fad2023-11-22 16:54:31 +08005676#endif
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005677
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005678#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_MD_CAN_SHA512)
Jerry Yu693a47a2022-06-23 14:02:28 +08005679 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA512,
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005680#endif /* MBEDTLS_RSA_C && MBEDTLS_MD_CAN_SHA512 */
Jerry Yu693a47a2022-06-23 14:02:28 +08005681
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005682#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_MD_CAN_SHA384)
Jerry Yu693a47a2022-06-23 14:02:28 +08005683 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA384,
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005684#endif /* MBEDTLS_RSA_C && MBEDTLS_MD_CAN_SHA384 */
Jerry Yu693a47a2022-06-23 14:02:28 +08005685
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005686#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_MD_CAN_SHA256)
Jerry Yu693a47a2022-06-23 14:02:28 +08005687 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA256,
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005688#endif /* MBEDTLS_RSA_C && MBEDTLS_MD_CAN_SHA256 */
Jerry Yu693a47a2022-06-23 14:02:28 +08005689
Gabor Mezei15b95a62022-05-09 16:37:58 +02005690 MBEDTLS_TLS_SIG_NONE
Jerry Yu909df7b2022-01-22 11:56:27 +08005691};
5692
5693/* NOTICE: see above */
5694#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
5695static uint16_t ssl_tls12_preset_default_sig_algs[] = {
Yanray Wang1136fad2023-11-22 16:54:31 +08005696
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005697#if defined(MBEDTLS_MD_CAN_SHA512)
Valerio Settie9646ec2023-08-02 20:02:28 +02005698#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005699 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA512),
Jerry Yu713013f2022-01-17 18:16:35 +08005700#endif
Jerry Yu09a99fc2022-07-28 14:22:17 +08005701#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT)
5702 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA512,
Yanray Wang1136fad2023-11-22 16:54:31 +08005703#endif
Gabor Mezeic1051b62022-05-10 13:13:58 +02005704#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005705 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA512),
Gabor Mezeic1051b62022-05-10 13:13:58 +02005706#endif
Yanray Wang1136fad2023-11-22 16:54:31 +08005707#endif /* MBEDTLS_MD_CAN_SHA512 */
5708
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005709#if defined(MBEDTLS_MD_CAN_SHA384)
Valerio Settie9646ec2023-08-02 20:02:28 +02005710#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005711 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384),
Jerry Yu11f0a9c2022-01-12 18:43:08 +08005712#endif
Jerry Yu09a99fc2022-07-28 14:22:17 +08005713#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT)
5714 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA384,
Yanray Wang1136fad2023-11-22 16:54:31 +08005715#endif
Gabor Mezeic1051b62022-05-10 13:13:58 +02005716#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005717 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA384),
Gabor Mezeic1051b62022-05-10 13:13:58 +02005718#endif
Yanray Wang1136fad2023-11-22 16:54:31 +08005719#endif /* MBEDTLS_MD_CAN_SHA384 */
5720
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005721#if defined(MBEDTLS_MD_CAN_SHA256)
Valerio Settie9646ec2023-08-02 20:02:28 +02005722#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005723 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256),
Jerry Yu11f0a9c2022-01-12 18:43:08 +08005724#endif
Jerry Yu09a99fc2022-07-28 14:22:17 +08005725#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT)
5726 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256,
Yanray Wang1136fad2023-11-22 16:54:31 +08005727#endif
Gabor Mezeic1051b62022-05-10 13:13:58 +02005728#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005729 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA256),
Gabor Mezeic1051b62022-05-10 13:13:58 +02005730#endif
Yanray Wang1136fad2023-11-22 16:54:31 +08005731#endif /* MBEDTLS_MD_CAN_SHA256 */
5732
Gabor Mezei15b95a62022-05-09 16:37:58 +02005733 MBEDTLS_TLS_SIG_NONE
Jerry Yu909df7b2022-01-22 11:56:27 +08005734};
5735#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Yanray Wang1136fad2023-11-22 16:54:31 +08005736
Jerry Yu909df7b2022-01-22 11:56:27 +08005737/* NOTICE: see above */
Chien Wong4e9683e2023-12-28 17:07:43 +08005738static const uint16_t ssl_preset_suiteb_sig_algs[] = {
Jerry Yu909df7b2022-01-22 11:56:27 +08005739
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005740#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Valerio Setti45d56f32023-07-13 17:23:20 +02005741 defined(MBEDTLS_MD_CAN_SHA256) && \
Valerio Settidb6b4db2023-09-01 09:20:51 +02005742 defined(MBEDTLS_ECP_HAVE_SECP256R1)
Jerry Yu909df7b2022-01-22 11:56:27 +08005743 MBEDTLS_TLS1_3_SIG_ECDSA_SECP256R1_SHA256,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005744 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256)
5745#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08005746
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005747#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Valerio Setti45d56f32023-07-13 17:23:20 +02005748 defined(MBEDTLS_MD_CAN_SHA384) && \
Valerio Settidb6b4db2023-09-01 09:20:51 +02005749 defined(MBEDTLS_ECP_HAVE_SECP384R1)
Jerry Yu53037892022-01-25 11:02:06 +08005750 MBEDTLS_TLS1_3_SIG_ECDSA_SECP384R1_SHA384,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005751 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384)
5752#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08005753
Gabor Mezei15b95a62022-05-09 16:37:58 +02005754 MBEDTLS_TLS_SIG_NONE
Jerry Yu713013f2022-01-17 18:16:35 +08005755};
Jerry Yu6106fdc2022-01-12 16:36:14 +08005756
Jerry Yu909df7b2022-01-22 11:56:27 +08005757/* NOTICE: see above */
5758#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
5759static uint16_t ssl_tls12_preset_suiteb_sig_algs[] = {
Yanray Wang1136fad2023-11-22 16:54:31 +08005760
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005761#if defined(MBEDTLS_MD_CAN_SHA256)
Valerio Settie9646ec2023-08-02 20:02:28 +02005762#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005763 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256),
Jerry Yu713013f2022-01-17 18:16:35 +08005764#endif
Yanray Wang1136fad2023-11-22 16:54:31 +08005765#endif /* MBEDTLS_MD_CAN_SHA256 */
Yanray Wang69ceb392023-11-22 16:32:39 +08005766
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005767#if defined(MBEDTLS_MD_CAN_SHA384)
Valerio Settie9646ec2023-08-02 20:02:28 +02005768#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005769 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384),
Jerry Yu18c833e2022-01-25 10:55:47 +08005770#endif
Yanray Wang1136fad2023-11-22 16:54:31 +08005771#endif /* MBEDTLS_MD_CAN_SHA384 */
5772
Gabor Mezei15b95a62022-05-09 16:37:58 +02005773 MBEDTLS_TLS_SIG_NONE
Hanno Becker9c6aa7b2021-08-10 13:50:43 +01005774};
Jerry Yu909df7b2022-01-22 11:56:27 +08005775#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
5776
Ronald Crone68ab4f2022-10-05 12:46:29 +02005777#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005778
Chien Wong4e9683e2023-12-28 17:07:43 +08005779static const uint16_t ssl_preset_suiteb_groups[] = {
Valerio Settidb6b4db2023-09-01 09:20:51 +02005780#if defined(MBEDTLS_ECP_HAVE_SECP256R1)
Brett Warrene0edc842021-08-17 09:53:13 +01005781 MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1,
Jaeden Amerod4311042019-06-03 08:27:16 +01005782#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005783#if defined(MBEDTLS_ECP_HAVE_SECP384R1)
Brett Warrene0edc842021-08-17 09:53:13 +01005784 MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1,
Jaeden Amerod4311042019-06-03 08:27:16 +01005785#endif
Brett Warrene0edc842021-08-17 09:53:13 +01005786 MBEDTLS_SSL_IANA_TLS_GROUP_NONE
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005787};
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005788
Ronald Crone68ab4f2022-10-05 12:46:29 +02005789#if defined(MBEDTLS_DEBUG_C) && defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu909df7b2022-01-22 11:56:27 +08005790/* Function for checking `ssl_preset_*_sig_algs` and `ssl_tls12_preset_*_sig_algs`
Jerry Yu370e1462022-01-25 10:36:53 +08005791 * to make sure there are no duplicated signature algorithm entries. */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005792MBEDTLS_CHECK_RETURN_CRITICAL
Chien Wong4e9683e2023-12-28 17:07:43 +08005793static int ssl_check_no_sig_alg_duplication(const uint16_t *sig_algs)
Jerry Yu1a8b4812022-01-20 17:56:50 +08005794{
5795 size_t i, j;
5796 int ret = 0;
Jerry Yu909df7b2022-01-22 11:56:27 +08005797
Gilles Peskine449bd832023-01-11 14:50:10 +01005798 for (i = 0; sig_algs[i] != MBEDTLS_TLS_SIG_NONE; i++) {
5799 for (j = 0; j < i; j++) {
5800 if (sig_algs[i] != sig_algs[j]) {
Jerry Yuf377d642022-01-25 10:43:59 +08005801 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01005802 }
5803 mbedtls_printf(" entry(%04x,%" MBEDTLS_PRINTF_SIZET
5804 ") is duplicated at %" MBEDTLS_PRINTF_SIZET "\n",
5805 sig_algs[i], j, i);
Jerry Yuf377d642022-01-25 10:43:59 +08005806 ret = -1;
Jerry Yu1a8b4812022-01-20 17:56:50 +08005807 }
5808 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005809 return ret;
Jerry Yu1a8b4812022-01-20 17:56:50 +08005810}
5811
Ronald Crone68ab4f2022-10-05 12:46:29 +02005812#endif /* MBEDTLS_DEBUG_C && MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Jerry Yu1a8b4812022-01-20 17:56:50 +08005813
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005814/*
Tillmann Karras588ad502015-09-25 04:27:22 +02005815 * Load default in mbedtls_ssl_config
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005816 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005817int mbedtls_ssl_config_defaults(mbedtls_ssl_config *conf,
5818 int endpoint, int transport, int preset)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005819{
Manuel Pégourié-Gonnard8b431fb2015-05-11 12:54:52 +02005820#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Janos Follath865b3eb2019-12-16 11:46:15 +00005821 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard8b431fb2015-05-11 12:54:52 +02005822#endif
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005823
Ronald Crone68ab4f2022-10-05 12:46:29 +02005824#if defined(MBEDTLS_DEBUG_C) && defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005825 if (ssl_check_no_sig_alg_duplication(ssl_preset_suiteb_sig_algs)) {
5826 mbedtls_printf("ssl_preset_suiteb_sig_algs has duplicated entries\n");
5827 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu1a8b4812022-01-20 17:56:50 +08005828 }
5829
Gilles Peskine449bd832023-01-11 14:50:10 +01005830 if (ssl_check_no_sig_alg_duplication(ssl_preset_default_sig_algs)) {
5831 mbedtls_printf("ssl_preset_default_sig_algs has duplicated entries\n");
5832 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu1a8b4812022-01-20 17:56:50 +08005833 }
Jerry Yu909df7b2022-01-22 11:56:27 +08005834
5835#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005836 if (ssl_check_no_sig_alg_duplication(ssl_tls12_preset_suiteb_sig_algs)) {
5837 mbedtls_printf("ssl_tls12_preset_suiteb_sig_algs has duplicated entries\n");
5838 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu909df7b2022-01-22 11:56:27 +08005839 }
5840
Gilles Peskine449bd832023-01-11 14:50:10 +01005841 if (ssl_check_no_sig_alg_duplication(ssl_tls12_preset_default_sig_algs)) {
5842 mbedtls_printf("ssl_tls12_preset_default_sig_algs has duplicated entries\n");
5843 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu909df7b2022-01-22 11:56:27 +08005844 }
5845#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Ronald Crone68ab4f2022-10-05 12:46:29 +02005846#endif /* MBEDTLS_DEBUG_C && MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Jerry Yu1a8b4812022-01-20 17:56:50 +08005847
Manuel Pégourié-Gonnard0de074f2015-05-14 12:58:01 +02005848 /* Use the functions here so that they are covered in tests,
5849 * but otherwise access member directly for efficiency */
Gilles Peskine449bd832023-01-11 14:50:10 +01005850 mbedtls_ssl_conf_endpoint(conf, endpoint);
5851 mbedtls_ssl_conf_transport(conf, transport);
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005852
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005853 /*
5854 * Things that are common to all presets
5855 */
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02005856#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005857 if (endpoint == MBEDTLS_SSL_IS_CLIENT) {
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02005858 conf->authmode = MBEDTLS_SSL_VERIFY_REQUIRED;
5859#if defined(MBEDTLS_SSL_SESSION_TICKETS)
5860 conf->session_tickets = MBEDTLS_SSL_SESSION_TICKETS_ENABLED;
5861#endif
5862 }
5863#endif
5864
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005865#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
5866 conf->encrypt_then_mac = MBEDTLS_SSL_ETM_ENABLED;
5867#endif
5868
5869#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
5870 conf->extended_ms = MBEDTLS_SSL_EXTENDED_MS_ENABLED;
5871#endif
5872
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02005873#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005874 conf->f_cookie_write = ssl_cookie_write_dummy;
5875 conf->f_cookie_check = ssl_cookie_check_dummy;
5876#endif
5877
5878#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
5879 conf->anti_replay = MBEDTLS_SSL_ANTI_REPLAY_ENABLED;
5880#endif
5881
Janos Follath088ce432017-04-10 12:42:31 +01005882#if defined(MBEDTLS_SSL_SRV_C)
5883 conf->cert_req_ca_list = MBEDTLS_SSL_CERT_REQ_CA_LIST_ENABLED;
TRodziewicz3946f792021-06-14 12:11:18 +02005884 conf->respect_cli_pref = MBEDTLS_SSL_SRV_CIPHERSUITE_ORDER_SERVER;
Janos Follath088ce432017-04-10 12:42:31 +01005885#endif
5886
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005887#if defined(MBEDTLS_SSL_PROTO_DTLS)
5888 conf->hs_timeout_min = MBEDTLS_SSL_DTLS_TIMEOUT_DFL_MIN;
5889 conf->hs_timeout_max = MBEDTLS_SSL_DTLS_TIMEOUT_DFL_MAX;
5890#endif
5891
5892#if defined(MBEDTLS_SSL_RENEGOTIATION)
5893 conf->renego_max_records = MBEDTLS_SSL_RENEGO_MAX_RECORDS_DEFAULT;
Gilles Peskine449bd832023-01-11 14:50:10 +01005894 memset(conf->renego_period, 0x00, 2);
5895 memset(conf->renego_period + 2, 0xFF, 6);
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005896#endif
5897
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005898#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005899 if (endpoint == MBEDTLS_SSL_IS_SERVER) {
Hanno Beckere2defad2021-07-24 05:59:17 +01005900 const unsigned char dhm_p[] =
5901 MBEDTLS_DHM_RFC3526_MODP_2048_P_BIN;
5902 const unsigned char dhm_g[] =
5903 MBEDTLS_DHM_RFC3526_MODP_2048_G_BIN;
Hanno Becker00d0a682017-10-04 13:14:29 +01005904
Gilles Peskine449bd832023-01-11 14:50:10 +01005905 if ((ret = mbedtls_ssl_conf_dh_param_bin(conf,
5906 dhm_p, sizeof(dhm_p),
5907 dhm_g, sizeof(dhm_g))) != 0) {
5908 return ret;
Hanno Beckere2defad2021-07-24 05:59:17 +01005909 }
5910 }
Manuel Pégourié-Gonnardbd990d62015-06-11 14:49:42 +02005911#endif
5912
Ronald Cron6f135e12021-12-08 16:57:54 +01005913#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yu6ee56aa2022-12-06 17:47:22 +08005914
5915#if defined(MBEDTLS_SSL_EARLY_DATA)
Yanray Wangd5ed36f2023-11-07 11:40:43 +08005916 mbedtls_ssl_conf_early_data(conf, MBEDTLS_SSL_EARLY_DATA_DISABLED);
Jerry Yu6ee56aa2022-12-06 17:47:22 +08005917#if defined(MBEDTLS_SSL_SRV_C)
Yanray Wang07517612023-11-07 11:47:36 +08005918 mbedtls_ssl_conf_max_early_data_size(conf, MBEDTLS_SSL_MAX_EARLY_DATA_SIZE);
Jerry Yu6ee56aa2022-12-06 17:47:22 +08005919#endif
5920#endif /* MBEDTLS_SSL_EARLY_DATA */
5921
Jerry Yud0766ec2022-09-22 10:46:57 +08005922#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Jerry Yu1ad7ace2022-08-09 13:28:39 +08005923 mbedtls_ssl_conf_new_session_tickets(
Gilles Peskine449bd832023-01-11 14:50:10 +01005924 conf, MBEDTLS_SSL_TLS1_3_DEFAULT_NEW_SESSION_TICKETS);
Jerry Yu1ad7ace2022-08-09 13:28:39 +08005925#endif
Hanno Becker71f1ed62021-07-24 06:01:47 +01005926 /*
5927 * Allow all TLS 1.3 key exchange modes by default.
5928 */
Xiaofei Bai746f9482021-11-12 08:53:56 +00005929 conf->tls13_kex_modes = MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_ALL;
Ronald Cron6f135e12021-12-08 16:57:54 +01005930#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker71f1ed62021-07-24 06:01:47 +01005931
Gilles Peskine449bd832023-01-11 14:50:10 +01005932 if (transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Glenn Strauss2dfcea22022-03-14 17:26:42 -04005933#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
XiaokangQian4d3a6042022-04-21 13:46:17 +00005934 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
XiaokangQian060d8672022-04-21 09:24:56 +00005935 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
XiaokangQian4d3a6042022-04-21 13:46:17 +00005936#else
Gilles Peskine449bd832023-01-11 14:50:10 +01005937 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
XiaokangQian060d8672022-04-21 09:24:56 +00005938#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01005939 } else {
XiaokangQian4d3a6042022-04-21 13:46:17 +00005940#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
Ronald Cron097ba142023-03-08 16:18:00 +01005941 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
5942 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
XiaokangQian4d3a6042022-04-21 13:46:17 +00005943#elif defined(MBEDTLS_SSL_PROTO_TLS1_3)
5944 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
5945 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
5946#elif defined(MBEDTLS_SSL_PROTO_TLS1_2)
5947 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
5948 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
5949#else
Gilles Peskine449bd832023-01-11 14:50:10 +01005950 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
XiaokangQian4d3a6042022-04-21 13:46:17 +00005951#endif
5952 }
Glenn Strauss2dfcea22022-03-14 17:26:42 -04005953
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005954 /*
5955 * Preset-specific defaults
5956 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005957 switch (preset) {
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005958 /*
5959 * NSA Suite B
5960 */
5961 case MBEDTLS_SSL_PRESET_SUITEB:
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005962
Hanno Beckerd60b6c62021-04-29 12:04:11 +01005963 conf->ciphersuite_list = ssl_preset_suiteb_ciphersuites;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005964
5965#if defined(MBEDTLS_X509_CRT_PARSE_C)
5966 conf->cert_profile = &mbedtls_x509_crt_profile_suiteb;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005967#endif
5968
Ronald Crone68ab4f2022-10-05 12:46:29 +02005969#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu909df7b2022-01-22 11:56:27 +08005970#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005971 if (mbedtls_ssl_conf_is_tls12_only(conf)) {
Jerry Yu909df7b2022-01-22 11:56:27 +08005972 conf->sig_algs = ssl_tls12_preset_suiteb_sig_algs;
Gilles Peskine449bd832023-01-11 14:50:10 +01005973 } else
Jerry Yu909df7b2022-01-22 11:56:27 +08005974#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005975 conf->sig_algs = ssl_preset_suiteb_sig_algs;
Ronald Crone68ab4f2022-10-05 12:46:29 +02005976#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005977
Manuel Pégourié-Gonnardf07ce3b2023-09-22 11:53:41 +02005978#if defined(MBEDTLS_ECP_C) && !defined(MBEDTLS_DEPRECATED_REMOVED)
Brett Warrene0edc842021-08-17 09:53:13 +01005979 conf->curve_list = NULL;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005980#endif
Brett Warrene0edc842021-08-17 09:53:13 +01005981 conf->group_list = ssl_preset_suiteb_groups;
Manuel Pégourié-Gonnardc98204e2015-08-11 04:21:01 +02005982 break;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005983
5984 /*
5985 * Default
5986 */
5987 default:
Ronald Cronf6606552022-03-15 11:23:25 +01005988
Hanno Beckerd60b6c62021-04-29 12:04:11 +01005989 conf->ciphersuite_list = mbedtls_ssl_list_ciphersuites();
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005990
5991#if defined(MBEDTLS_X509_CRT_PARSE_C)
5992 conf->cert_profile = &mbedtls_x509_crt_profile_default;
5993#endif
5994
Ronald Crone68ab4f2022-10-05 12:46:29 +02005995#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu909df7b2022-01-22 11:56:27 +08005996#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005997 if (mbedtls_ssl_conf_is_tls12_only(conf)) {
Jerry Yu909df7b2022-01-22 11:56:27 +08005998 conf->sig_algs = ssl_tls12_preset_default_sig_algs;
Gilles Peskine449bd832023-01-11 14:50:10 +01005999 } else
Jerry Yu909df7b2022-01-22 11:56:27 +08006000#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006001 conf->sig_algs = ssl_preset_default_sig_algs;
Ronald Crone68ab4f2022-10-05 12:46:29 +02006002#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02006003
Manuel Pégourié-Gonnardf07ce3b2023-09-22 11:53:41 +02006004#if defined(MBEDTLS_ECP_C) && !defined(MBEDTLS_DEPRECATED_REMOVED)
Brett Warrene0edc842021-08-17 09:53:13 +01006005 conf->curve_list = NULL;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02006006#endif
Brett Warrene0edc842021-08-17 09:53:13 +01006007 conf->group_list = ssl_preset_default_groups;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02006008
6009#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_CLI_C)
6010 conf->dhm_min_bitlen = 1024;
6011#endif
6012 }
6013
Gilles Peskine449bd832023-01-11 14:50:10 +01006014 return 0;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02006015}
6016
6017/*
6018 * Free mbedtls_ssl_config
6019 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006020void mbedtls_ssl_config_free(mbedtls_ssl_config *conf)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02006021{
6022#if defined(MBEDTLS_DHM_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01006023 mbedtls_mpi_free(&conf->dhm_P);
6024 mbedtls_mpi_free(&conf->dhm_G);
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02006025#endif
6026
Ronald Cron73fe8df2022-10-05 14:31:43 +02006027#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED)
Neil Armstrong501c9322022-05-03 09:35:09 +02006028#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01006029 if (!mbedtls_svc_key_id_is_null(conf->psk_opaque)) {
Neil Armstrong501c9322022-05-03 09:35:09 +02006030 conf->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
6031 }
Neil Armstrong8ecd6682022-05-05 11:40:35 +02006032#endif /* MBEDTLS_USE_PSA_CRYPTO */
Gilles Peskine449bd832023-01-11 14:50:10 +01006033 if (conf->psk != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01006034 mbedtls_zeroize_and_free(conf->psk, conf->psk_len);
Azim Khan27e8a122018-03-21 14:24:11 +00006035 conf->psk = NULL;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02006036 conf->psk_len = 0;
junyeonLEE316b1622017-12-20 16:29:30 +09006037 }
6038
Gilles Peskine449bd832023-01-11 14:50:10 +01006039 if (conf->psk_identity != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01006040 mbedtls_zeroize_and_free(conf->psk_identity, conf->psk_identity_len);
Azim Khan27e8a122018-03-21 14:24:11 +00006041 conf->psk_identity = NULL;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02006042 conf->psk_identity_len = 0;
6043 }
Ronald Cron73fe8df2022-10-05 14:31:43 +02006044#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED */
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02006045
6046#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01006047 ssl_key_cert_free(conf->key_cert);
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02006048#endif
6049
Gilles Peskine449bd832023-01-11 14:50:10 +01006050 mbedtls_platform_zeroize(conf, sizeof(mbedtls_ssl_config));
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02006051}
6052
Manuel Pégourié-Gonnard5674a972015-10-19 15:14:03 +02006053#if defined(MBEDTLS_PK_C) && \
Valerio Settie9646ec2023-08-02 20:02:28 +02006054 (defined(MBEDTLS_RSA_C) || defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED))
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02006055/*
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006056 * Convert between MBEDTLS_PK_XXX and SSL_SIG_XXX
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02006057 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006058unsigned char mbedtls_ssl_sig_from_pk(mbedtls_pk_context *pk)
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02006059{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006060#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01006061 if (mbedtls_pk_can_do(pk, MBEDTLS_PK_RSA)) {
6062 return MBEDTLS_SSL_SIG_RSA;
6063 }
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02006064#endif
Valerio Settie9646ec2023-08-02 20:02:28 +02006065#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01006066 if (mbedtls_pk_can_do(pk, MBEDTLS_PK_ECDSA)) {
6067 return MBEDTLS_SSL_SIG_ECDSA;
6068 }
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02006069#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01006070 return MBEDTLS_SSL_SIG_ANON;
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02006071}
6072
Gilles Peskine449bd832023-01-11 14:50:10 +01006073unsigned char mbedtls_ssl_sig_from_pk_alg(mbedtls_pk_type_t type)
Hanno Becker7e5437a2017-04-28 17:15:26 +01006074{
Gilles Peskine449bd832023-01-11 14:50:10 +01006075 switch (type) {
Hanno Becker7e5437a2017-04-28 17:15:26 +01006076 case MBEDTLS_PK_RSA:
Gilles Peskine449bd832023-01-11 14:50:10 +01006077 return MBEDTLS_SSL_SIG_RSA;
Hanno Becker7e5437a2017-04-28 17:15:26 +01006078 case MBEDTLS_PK_ECDSA:
6079 case MBEDTLS_PK_ECKEY:
Gilles Peskine449bd832023-01-11 14:50:10 +01006080 return MBEDTLS_SSL_SIG_ECDSA;
Hanno Becker7e5437a2017-04-28 17:15:26 +01006081 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006082 return MBEDTLS_SSL_SIG_ANON;
Hanno Becker7e5437a2017-04-28 17:15:26 +01006083 }
6084}
6085
Gilles Peskine449bd832023-01-11 14:50:10 +01006086mbedtls_pk_type_t mbedtls_ssl_pk_alg_from_sig(unsigned char sig)
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02006087{
Gilles Peskine449bd832023-01-11 14:50:10 +01006088 switch (sig) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006089#if defined(MBEDTLS_RSA_C)
6090 case MBEDTLS_SSL_SIG_RSA:
Gilles Peskine449bd832023-01-11 14:50:10 +01006091 return MBEDTLS_PK_RSA;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02006092#endif
Valerio Settie9646ec2023-08-02 20:02:28 +02006093#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006094 case MBEDTLS_SSL_SIG_ECDSA:
Gilles Peskine449bd832023-01-11 14:50:10 +01006095 return MBEDTLS_PK_ECDSA;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02006096#endif
6097 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006098 return MBEDTLS_PK_NONE;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02006099 }
6100}
Valerio Settie9646ec2023-08-02 20:02:28 +02006101#endif /* MBEDTLS_PK_C &&
6102 ( MBEDTLS_RSA_C || MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED ) */
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02006103
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02006104/*
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006105 * Convert from MBEDTLS_SSL_HASH_XXX to MBEDTLS_MD_XXX
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02006106 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006107mbedtls_md_type_t mbedtls_ssl_md_alg_from_hash(unsigned char hash)
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02006108{
Gilles Peskine449bd832023-01-11 14:50:10 +01006109 switch (hash) {
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006110#if defined(MBEDTLS_MD_CAN_MD5)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006111 case MBEDTLS_SSL_HASH_MD5:
Gilles Peskine449bd832023-01-11 14:50:10 +01006112 return MBEDTLS_MD_MD5;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02006113#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006114#if defined(MBEDTLS_MD_CAN_SHA1)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006115 case MBEDTLS_SSL_HASH_SHA1:
Gilles Peskine449bd832023-01-11 14:50:10 +01006116 return MBEDTLS_MD_SHA1;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02006117#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006118#if defined(MBEDTLS_MD_CAN_SHA224)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006119 case MBEDTLS_SSL_HASH_SHA224:
Gilles Peskine449bd832023-01-11 14:50:10 +01006120 return MBEDTLS_MD_SHA224;
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02006121#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006122#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006123 case MBEDTLS_SSL_HASH_SHA256:
Gilles Peskine449bd832023-01-11 14:50:10 +01006124 return MBEDTLS_MD_SHA256;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02006125#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006126#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006127 case MBEDTLS_SSL_HASH_SHA384:
Gilles Peskine449bd832023-01-11 14:50:10 +01006128 return MBEDTLS_MD_SHA384;
Mateusz Starzyk3352a532021-04-06 14:28:22 +02006129#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006130#if defined(MBEDTLS_MD_CAN_SHA512)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006131 case MBEDTLS_SSL_HASH_SHA512:
Gilles Peskine449bd832023-01-11 14:50:10 +01006132 return MBEDTLS_MD_SHA512;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02006133#endif
6134 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006135 return MBEDTLS_MD_NONE;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02006136 }
6137}
6138
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006139/*
6140 * Convert from MBEDTLS_MD_XXX to MBEDTLS_SSL_HASH_XXX
6141 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006142unsigned char mbedtls_ssl_hash_from_md_alg(int md)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006143{
Gilles Peskine449bd832023-01-11 14:50:10 +01006144 switch (md) {
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006145#if defined(MBEDTLS_MD_CAN_MD5)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006146 case MBEDTLS_MD_MD5:
Gilles Peskine449bd832023-01-11 14:50:10 +01006147 return MBEDTLS_SSL_HASH_MD5;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006148#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006149#if defined(MBEDTLS_MD_CAN_SHA1)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006150 case MBEDTLS_MD_SHA1:
Gilles Peskine449bd832023-01-11 14:50:10 +01006151 return MBEDTLS_SSL_HASH_SHA1;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006152#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006153#if defined(MBEDTLS_MD_CAN_SHA224)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006154 case MBEDTLS_MD_SHA224:
Gilles Peskine449bd832023-01-11 14:50:10 +01006155 return MBEDTLS_SSL_HASH_SHA224;
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02006156#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006157#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006158 case MBEDTLS_MD_SHA256:
Gilles Peskine449bd832023-01-11 14:50:10 +01006159 return MBEDTLS_SSL_HASH_SHA256;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006160#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006161#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006162 case MBEDTLS_MD_SHA384:
Gilles Peskine449bd832023-01-11 14:50:10 +01006163 return MBEDTLS_SSL_HASH_SHA384;
Mateusz Starzyk3352a532021-04-06 14:28:22 +02006164#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006165#if defined(MBEDTLS_MD_CAN_SHA512)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006166 case MBEDTLS_MD_SHA512:
Gilles Peskine449bd832023-01-11 14:50:10 +01006167 return MBEDTLS_SSL_HASH_SHA512;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006168#endif
6169 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006170 return MBEDTLS_SSL_HASH_NONE;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006171 }
6172}
6173
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01006174/*
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006175 * Check if a curve proposed by the peer is in our list.
Manuel Pégourié-Gonnard9d412d82015-06-17 12:10:46 +02006176 * Return 0 if we're willing to use it, -1 otherwise.
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01006177 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006178int mbedtls_ssl_check_curve_tls_id(const mbedtls_ssl_context *ssl, uint16_t tls_id)
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01006179{
Gilles Peskine449bd832023-01-11 14:50:10 +01006180 const uint16_t *group_list = mbedtls_ssl_get_groups(ssl);
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01006181
Gilles Peskine449bd832023-01-11 14:50:10 +01006182 if (group_list == NULL) {
6183 return -1;
Brett Warrene0edc842021-08-17 09:53:13 +01006184 }
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01006185
Gilles Peskine449bd832023-01-11 14:50:10 +01006186 for (; *group_list != 0; group_list++) {
6187 if (*group_list == tls_id) {
6188 return 0;
6189 }
6190 }
6191
6192 return -1;
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01006193}
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01006194
Valerio Setti49e69072023-06-27 17:27:51 +02006195#if defined(MBEDTLS_PK_HAVE_ECC_KEYS)
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01006196/*
6197 * Same as mbedtls_ssl_check_curve_tls_id() but with a mbedtls_ecp_group_id.
6198 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006199int mbedtls_ssl_check_curve(const mbedtls_ssl_context *ssl, mbedtls_ecp_group_id grp_id)
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01006200{
Gilles Peskine449bd832023-01-11 14:50:10 +01006201 uint16_t tls_id = mbedtls_ssl_get_tls_id_from_ecp_group_id(grp_id);
Leonid Rozenboim19e59732022-08-08 16:52:38 -07006202
Gilles Peskine449bd832023-01-11 14:50:10 +01006203 if (tls_id == 0) {
Leonid Rozenboim19e59732022-08-08 16:52:38 -07006204 return -1;
Gilles Peskine449bd832023-01-11 14:50:10 +01006205 }
Leonid Rozenboim19e59732022-08-08 16:52:38 -07006206
Gilles Peskine449bd832023-01-11 14:50:10 +01006207 return mbedtls_ssl_check_curve_tls_id(ssl, tls_id);
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01006208}
Valerio Setti49e69072023-06-27 17:27:51 +02006209#endif /* MBEDTLS_PK_HAVE_ECC_KEYS */
Valerio Setti67419f02023-01-04 16:12:42 +01006210
Valerio Setti18c9fed2022-12-30 17:44:24 +01006211static const struct {
6212 uint16_t tls_id;
6213 mbedtls_ecp_group_id ecp_group_id;
6214 psa_ecc_family_t psa_family;
6215 uint16_t bits;
Valerio Setti18c9fed2022-12-30 17:44:24 +01006216} tls_id_match_table[] =
6217{
Valerio Settidb6b4db2023-09-01 09:20:51 +02006218#if defined(MBEDTLS_ECP_HAVE_SECP521R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02006219 { 25, MBEDTLS_ECP_DP_SECP521R1, PSA_ECC_FAMILY_SECP_R1, 521 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006220#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02006221#if defined(MBEDTLS_ECP_HAVE_BP512R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02006222 { 28, MBEDTLS_ECP_DP_BP512R1, PSA_ECC_FAMILY_BRAINPOOL_P_R1, 512 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006223#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02006224#if defined(MBEDTLS_ECP_HAVE_SECP384R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02006225 { 24, MBEDTLS_ECP_DP_SECP384R1, PSA_ECC_FAMILY_SECP_R1, 384 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006226#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02006227#if defined(MBEDTLS_ECP_HAVE_BP384R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02006228 { 27, MBEDTLS_ECP_DP_BP384R1, PSA_ECC_FAMILY_BRAINPOOL_P_R1, 384 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006229#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02006230#if defined(MBEDTLS_ECP_HAVE_SECP256R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02006231 { 23, MBEDTLS_ECP_DP_SECP256R1, PSA_ECC_FAMILY_SECP_R1, 256 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006232#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02006233#if defined(MBEDTLS_ECP_HAVE_SECP256K1)
Valerio Settiacd32c02023-06-29 18:06:29 +02006234 { 22, MBEDTLS_ECP_DP_SECP256K1, PSA_ECC_FAMILY_SECP_K1, 256 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006235#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02006236#if defined(MBEDTLS_ECP_HAVE_BP256R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02006237 { 26, MBEDTLS_ECP_DP_BP256R1, PSA_ECC_FAMILY_BRAINPOOL_P_R1, 256 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006238#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02006239#if defined(MBEDTLS_ECP_HAVE_SECP224R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02006240 { 21, MBEDTLS_ECP_DP_SECP224R1, PSA_ECC_FAMILY_SECP_R1, 224 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006241#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02006242#if defined(MBEDTLS_ECP_HAVE_SECP224K1)
Valerio Settiacd32c02023-06-29 18:06:29 +02006243 { 20, MBEDTLS_ECP_DP_SECP224K1, PSA_ECC_FAMILY_SECP_K1, 224 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006244#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02006245#if defined(MBEDTLS_ECP_HAVE_SECP192R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02006246 { 19, MBEDTLS_ECP_DP_SECP192R1, PSA_ECC_FAMILY_SECP_R1, 192 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006247#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02006248#if defined(MBEDTLS_ECP_HAVE_SECP192K1)
Valerio Settiacd32c02023-06-29 18:06:29 +02006249 { 18, MBEDTLS_ECP_DP_SECP192K1, PSA_ECC_FAMILY_SECP_K1, 192 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006250#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02006251#if defined(MBEDTLS_ECP_HAVE_CURVE25519)
Valerio Settiacd32c02023-06-29 18:06:29 +02006252 { 29, MBEDTLS_ECP_DP_CURVE25519, PSA_ECC_FAMILY_MONTGOMERY, 255 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006253#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02006254#if defined(MBEDTLS_ECP_HAVE_CURVE448)
Valerio Settiacd32c02023-06-29 18:06:29 +02006255 { 30, MBEDTLS_ECP_DP_CURVE448, PSA_ECC_FAMILY_MONTGOMERY, 448 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006256#endif
Valerio Settiacd32c02023-06-29 18:06:29 +02006257 { 0, MBEDTLS_ECP_DP_NONE, 0, 0 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006258};
6259
Gilles Peskine449bd832023-01-11 14:50:10 +01006260int mbedtls_ssl_get_psa_curve_info_from_tls_id(uint16_t tls_id,
Przemek Stekielda4fba62023-06-02 14:52:28 +02006261 psa_key_type_t *type,
Gilles Peskine449bd832023-01-11 14:50:10 +01006262 size_t *bits)
Valerio Setti18c9fed2022-12-30 17:44:24 +01006263{
Gilles Peskine449bd832023-01-11 14:50:10 +01006264 for (int i = 0; tls_id_match_table[i].tls_id != 0; i++) {
6265 if (tls_id_match_table[i].tls_id == tls_id) {
Przemek Stekielda4fba62023-06-02 14:52:28 +02006266 if (type != NULL) {
6267 *type = PSA_KEY_TYPE_ECC_KEY_PAIR(tls_id_match_table[i].psa_family);
Gilles Peskine449bd832023-01-11 14:50:10 +01006268 }
6269 if (bits != NULL) {
Valerio Setti18c9fed2022-12-30 17:44:24 +01006270 *bits = tls_id_match_table[i].bits;
Gilles Peskine449bd832023-01-11 14:50:10 +01006271 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01006272 return PSA_SUCCESS;
6273 }
6274 }
6275
6276 return PSA_ERROR_NOT_SUPPORTED;
6277}
6278
Gilles Peskine449bd832023-01-11 14:50:10 +01006279mbedtls_ecp_group_id mbedtls_ssl_get_ecp_group_id_from_tls_id(uint16_t tls_id)
Valerio Setti18c9fed2022-12-30 17:44:24 +01006280{
Gilles Peskine449bd832023-01-11 14:50:10 +01006281 for (int i = 0; tls_id_match_table[i].tls_id != 0; i++) {
6282 if (tls_id_match_table[i].tls_id == tls_id) {
Valerio Setti18c9fed2022-12-30 17:44:24 +01006283 return tls_id_match_table[i].ecp_group_id;
Gilles Peskine449bd832023-01-11 14:50:10 +01006284 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01006285 }
6286
6287 return MBEDTLS_ECP_DP_NONE;
6288}
6289
Gilles Peskine449bd832023-01-11 14:50:10 +01006290uint16_t mbedtls_ssl_get_tls_id_from_ecp_group_id(mbedtls_ecp_group_id grp_id)
Valerio Setti18c9fed2022-12-30 17:44:24 +01006291{
Gilles Peskine449bd832023-01-11 14:50:10 +01006292 for (int i = 0; tls_id_match_table[i].ecp_group_id != MBEDTLS_ECP_DP_NONE;
6293 i++) {
6294 if (tls_id_match_table[i].ecp_group_id == grp_id) {
Valerio Setti18c9fed2022-12-30 17:44:24 +01006295 return tls_id_match_table[i].tls_id;
Gilles Peskine449bd832023-01-11 14:50:10 +01006296 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01006297 }
6298
6299 return 0;
6300}
6301
Valerio Setti67419f02023-01-04 16:12:42 +01006302#if defined(MBEDTLS_DEBUG_C)
Valerio Settiacd32c02023-06-29 18:06:29 +02006303static const struct {
6304 uint16_t tls_id;
6305 const char *name;
6306} tls_id_curve_name_table[] =
6307{
Valerio Setti54e23792023-07-07 10:49:27 +02006308 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP521R1, "secp521r1" },
6309 { MBEDTLS_SSL_IANA_TLS_GROUP_BP512R1, "brainpoolP512r1" },
6310 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1, "secp384r1" },
6311 { MBEDTLS_SSL_IANA_TLS_GROUP_BP384R1, "brainpoolP384r1" },
6312 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1, "secp256r1" },
6313 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP256K1, "secp256k1" },
6314 { MBEDTLS_SSL_IANA_TLS_GROUP_BP256R1, "brainpoolP256r1" },
6315 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP224R1, "secp224r1" },
6316 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP224K1, "secp224k1" },
6317 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP192R1, "secp192r1" },
6318 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP192K1, "secp192k1" },
6319 { MBEDTLS_SSL_IANA_TLS_GROUP_X25519, "x25519" },
6320 { MBEDTLS_SSL_IANA_TLS_GROUP_X448, "x448" },
Valerio Settiacd32c02023-06-29 18:06:29 +02006321 { 0, NULL },
6322};
6323
Gilles Peskine449bd832023-01-11 14:50:10 +01006324const char *mbedtls_ssl_get_curve_name_from_tls_id(uint16_t tls_id)
Valerio Setti18c9fed2022-12-30 17:44:24 +01006325{
Valerio Settiacd32c02023-06-29 18:06:29 +02006326 for (int i = 0; tls_id_curve_name_table[i].tls_id != 0; i++) {
6327 if (tls_id_curve_name_table[i].tls_id == tls_id) {
6328 return tls_id_curve_name_table[i].name;
Gilles Peskine449bd832023-01-11 14:50:10 +01006329 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01006330 }
6331
6332 return NULL;
6333}
Valerio Setti67419f02023-01-04 16:12:42 +01006334#endif
Valerio Setti18c9fed2022-12-30 17:44:24 +01006335
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006336#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01006337int mbedtls_ssl_check_cert_usage(const mbedtls_x509_crt *cert,
6338 const mbedtls_ssl_ciphersuite_t *ciphersuite,
6339 int cert_endpoint,
6340 uint32_t *flags)
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02006341{
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01006342 int ret = 0;
Dave Rodgmanc37ad442023-11-03 23:36:06 +00006343 unsigned int usage = 0;
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02006344 const char *ext_oid;
6345 size_t ext_len;
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02006346
Gilles Peskine449bd832023-01-11 14:50:10 +01006347 if (cert_endpoint == MBEDTLS_SSL_IS_SERVER) {
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02006348 /* Server part of the key exchange */
Gilles Peskine449bd832023-01-11 14:50:10 +01006349 switch (ciphersuite->key_exchange) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006350 case MBEDTLS_KEY_EXCHANGE_RSA:
6351 case MBEDTLS_KEY_EXCHANGE_RSA_PSK:
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01006352 usage = MBEDTLS_X509_KU_KEY_ENCIPHERMENT;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02006353 break;
6354
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006355 case MBEDTLS_KEY_EXCHANGE_DHE_RSA:
6356 case MBEDTLS_KEY_EXCHANGE_ECDHE_RSA:
6357 case MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA:
6358 usage = MBEDTLS_X509_KU_DIGITAL_SIGNATURE;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02006359 break;
6360
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006361 case MBEDTLS_KEY_EXCHANGE_ECDH_RSA:
6362 case MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA:
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01006363 usage = MBEDTLS_X509_KU_KEY_AGREEMENT;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02006364 break;
6365
6366 /* Don't use default: we want warnings when adding new values */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006367 case MBEDTLS_KEY_EXCHANGE_NONE:
6368 case MBEDTLS_KEY_EXCHANGE_PSK:
6369 case MBEDTLS_KEY_EXCHANGE_DHE_PSK:
6370 case MBEDTLS_KEY_EXCHANGE_ECDHE_PSK:
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +02006371 case MBEDTLS_KEY_EXCHANGE_ECJPAKE:
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02006372 usage = 0;
6373 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006374 } else {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006375 /* Client auth: we only implement rsa_sign and mbedtls_ecdsa_sign for now */
6376 usage = MBEDTLS_X509_KU_DIGITAL_SIGNATURE;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02006377 }
6378
Gilles Peskine449bd832023-01-11 14:50:10 +01006379 if (mbedtls_x509_crt_check_key_usage(cert, usage) != 0) {
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01006380 *flags |= MBEDTLS_X509_BADCERT_KEY_USAGE;
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01006381 ret = -1;
6382 }
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02006383
Gilles Peskine449bd832023-01-11 14:50:10 +01006384 if (cert_endpoint == MBEDTLS_SSL_IS_SERVER) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006385 ext_oid = MBEDTLS_OID_SERVER_AUTH;
Gilles Peskine449bd832023-01-11 14:50:10 +01006386 ext_len = MBEDTLS_OID_SIZE(MBEDTLS_OID_SERVER_AUTH);
6387 } else {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006388 ext_oid = MBEDTLS_OID_CLIENT_AUTH;
Gilles Peskine449bd832023-01-11 14:50:10 +01006389 ext_len = MBEDTLS_OID_SIZE(MBEDTLS_OID_CLIENT_AUTH);
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02006390 }
6391
Gilles Peskine449bd832023-01-11 14:50:10 +01006392 if (mbedtls_x509_crt_check_extended_key_usage(cert, ext_oid, ext_len) != 0) {
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01006393 *flags |= MBEDTLS_X509_BADCERT_EXT_KEY_USAGE;
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01006394 ret = -1;
6395 }
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02006396
Gilles Peskine449bd832023-01-11 14:50:10 +01006397 return ret;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02006398}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006399#endif /* MBEDTLS_X509_CRT_PARSE_C */
Manuel Pégourié-Gonnard3a306b92014-04-29 15:11:17 +02006400
Jerry Yu148165c2021-09-24 23:20:59 +08006401#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01006402int mbedtls_ssl_get_handshake_transcript(mbedtls_ssl_context *ssl,
6403 const mbedtls_md_type_t md,
6404 unsigned char *dst,
6405 size_t dst_len,
6406 size_t *olen)
Jerry Yu148165c2021-09-24 23:20:59 +08006407{
Ronald Cronf6893e12022-01-07 22:09:01 +01006408 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
6409 psa_hash_operation_t *hash_operation_to_clone;
6410 psa_hash_operation_t hash_operation = psa_hash_operation_init();
6411
Jerry Yu148165c2021-09-24 23:20:59 +08006412 *olen = 0;
Ronald Cronf6893e12022-01-07 22:09:01 +01006413
Gilles Peskine449bd832023-01-11 14:50:10 +01006414 switch (md) {
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006415#if defined(MBEDTLS_MD_CAN_SHA384)
Gilles Peskine449bd832023-01-11 14:50:10 +01006416 case MBEDTLS_MD_SHA384:
6417 hash_operation_to_clone = &ssl->handshake->fin_sha384_psa;
6418 break;
Ronald Cronf6893e12022-01-07 22:09:01 +01006419#endif
6420
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006421#if defined(MBEDTLS_MD_CAN_SHA256)
Gilles Peskine449bd832023-01-11 14:50:10 +01006422 case MBEDTLS_MD_SHA256:
6423 hash_operation_to_clone = &ssl->handshake->fin_sha256_psa;
6424 break;
Ronald Cronf6893e12022-01-07 22:09:01 +01006425#endif
6426
Gilles Peskine449bd832023-01-11 14:50:10 +01006427 default:
6428 goto exit;
6429 }
6430
6431 status = psa_hash_clone(hash_operation_to_clone, &hash_operation);
6432 if (status != PSA_SUCCESS) {
Ronald Cronf6893e12022-01-07 22:09:01 +01006433 goto exit;
6434 }
6435
Gilles Peskine449bd832023-01-11 14:50:10 +01006436 status = psa_hash_finish(&hash_operation, dst, dst_len, olen);
6437 if (status != PSA_SUCCESS) {
Ronald Cronf6893e12022-01-07 22:09:01 +01006438 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006439 }
Ronald Cronf6893e12022-01-07 22:09:01 +01006440
6441exit:
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006442#if !defined(MBEDTLS_MD_CAN_SHA384) && \
6443 !defined(MBEDTLS_MD_CAN_SHA256)
Andrzej Kurekeabeb302022-10-17 07:52:51 -04006444 (void) ssl;
6445#endif
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05006446 return PSA_TO_MBEDTLS_ERR(status);
Jerry Yu148165c2021-09-24 23:20:59 +08006447}
6448#else /* MBEDTLS_USE_PSA_CRYPTO */
6449
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006450#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006451MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006452static int ssl_get_handshake_transcript_sha384(mbedtls_ssl_context *ssl,
6453 unsigned char *dst,
6454 size_t dst_len,
6455 size_t *olen)
Jerry Yu24c0ec32021-09-09 14:21:07 +08006456{
Jerry Yu24c0ec32021-09-09 14:21:07 +08006457 int ret;
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01006458 mbedtls_md_context_t sha384;
Jerry Yu24c0ec32021-09-09 14:21:07 +08006459
Gilles Peskine449bd832023-01-11 14:50:10 +01006460 if (dst_len < 48) {
6461 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
6462 }
Jerry Yu24c0ec32021-09-09 14:21:07 +08006463
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01006464 mbedtls_md_init(&sha384);
6465 ret = mbedtls_md_setup(&sha384, mbedtls_md_info_from_type(MBEDTLS_MD_SHA384), 0);
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01006466 if (ret != 0) {
6467 goto exit;
6468 }
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01006469 ret = mbedtls_md_clone(&sha384, &ssl->handshake->fin_sha384);
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01006470 if (ret != 0) {
6471 goto exit;
6472 }
Jerry Yu24c0ec32021-09-09 14:21:07 +08006473
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01006474 if ((ret = mbedtls_md_finish(&sha384, dst)) != 0) {
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01006475 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_finish", ret);
Jerry Yu24c0ec32021-09-09 14:21:07 +08006476 goto exit;
6477 }
6478
6479 *olen = 48;
6480
6481exit:
6482
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01006483 mbedtls_md_free(&sha384);
Gilles Peskine449bd832023-01-11 14:50:10 +01006484 return ret;
Jerry Yu24c0ec32021-09-09 14:21:07 +08006485}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006486#endif /* MBEDTLS_MD_CAN_SHA384 */
Jerry Yu24c0ec32021-09-09 14:21:07 +08006487
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006488#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006489MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006490static int ssl_get_handshake_transcript_sha256(mbedtls_ssl_context *ssl,
6491 unsigned char *dst,
6492 size_t dst_len,
6493 size_t *olen)
Jerry Yu24c0ec32021-09-09 14:21:07 +08006494{
Jerry Yu24c0ec32021-09-09 14:21:07 +08006495 int ret;
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01006496 mbedtls_md_context_t sha256;
Jerry Yu24c0ec32021-09-09 14:21:07 +08006497
Gilles Peskine449bd832023-01-11 14:50:10 +01006498 if (dst_len < 32) {
6499 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
6500 }
Jerry Yu24c0ec32021-09-09 14:21:07 +08006501
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01006502 mbedtls_md_init(&sha256);
6503 ret = mbedtls_md_setup(&sha256, mbedtls_md_info_from_type(MBEDTLS_MD_SHA256), 0);
6504 if (ret != 0) {
6505 goto exit;
6506 }
6507 ret = mbedtls_md_clone(&sha256, &ssl->handshake->fin_sha256);
6508 if (ret != 0) {
6509 goto exit;
6510 }
Jerry Yuc5aef882021-12-23 20:15:02 +08006511
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01006512 if ((ret = mbedtls_md_finish(&sha256, dst)) != 0) {
6513 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_finish", ret);
Jerry Yu24c0ec32021-09-09 14:21:07 +08006514 goto exit;
6515 }
6516
6517 *olen = 32;
6518
6519exit:
6520
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01006521 mbedtls_md_free(&sha256);
Gilles Peskine449bd832023-01-11 14:50:10 +01006522 return ret;
Jerry Yu24c0ec32021-09-09 14:21:07 +08006523}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006524#endif /* MBEDTLS_MD_CAN_SHA256 */
Jerry Yu24c0ec32021-09-09 14:21:07 +08006525
Gilles Peskine449bd832023-01-11 14:50:10 +01006526int mbedtls_ssl_get_handshake_transcript(mbedtls_ssl_context *ssl,
6527 const mbedtls_md_type_t md,
6528 unsigned char *dst,
6529 size_t dst_len,
6530 size_t *olen)
Jerry Yu24c0ec32021-09-09 14:21:07 +08006531{
Gilles Peskine449bd832023-01-11 14:50:10 +01006532 switch (md) {
Jerry Yuc1ddeef2021-10-08 15:14:45 +08006533
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006534#if defined(MBEDTLS_MD_CAN_SHA384)
Gilles Peskine449bd832023-01-11 14:50:10 +01006535 case MBEDTLS_MD_SHA384:
6536 return ssl_get_handshake_transcript_sha384(ssl, dst, dst_len, olen);
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006537#endif /* MBEDTLS_MD_CAN_SHA384*/
Jerry Yuc1ddeef2021-10-08 15:14:45 +08006538
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006539#if defined(MBEDTLS_MD_CAN_SHA256)
Gilles Peskine449bd832023-01-11 14:50:10 +01006540 case MBEDTLS_MD_SHA256:
6541 return ssl_get_handshake_transcript_sha256(ssl, dst, dst_len, olen);
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006542#endif /* MBEDTLS_MD_CAN_SHA256*/
Jerry Yuc1ddeef2021-10-08 15:14:45 +08006543
Gilles Peskine449bd832023-01-11 14:50:10 +01006544 default:
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006545#if !defined(MBEDTLS_MD_CAN_SHA384) && \
6546 !defined(MBEDTLS_MD_CAN_SHA256)
Gilles Peskine449bd832023-01-11 14:50:10 +01006547 (void) ssl;
6548 (void) dst;
6549 (void) dst_len;
6550 (void) olen;
Andrzej Kurek409248a2022-10-24 10:33:21 -04006551#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01006552 break;
Jerry Yuc1ddeef2021-10-08 15:14:45 +08006553 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006554 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yu24c0ec32021-09-09 14:21:07 +08006555}
XiaokangQian647719a2021-12-07 09:16:29 +00006556
Jerry Yu148165c2021-09-24 23:20:59 +08006557#endif /* !MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu24c0ec32021-09-09 14:21:07 +08006558
Ronald Crone68ab4f2022-10-05 12:46:29 +02006559#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Gabor Mezei078e8032022-04-27 21:17:56 +02006560/* mbedtls_ssl_parse_sig_alg_ext()
6561 *
6562 * The `extension_data` field of signature algorithm contains a `SignatureSchemeList`
6563 * value (TLS 1.3 RFC8446):
6564 * enum {
6565 * ....
6566 * ecdsa_secp256r1_sha256( 0x0403 ),
6567 * ecdsa_secp384r1_sha384( 0x0503 ),
6568 * ecdsa_secp521r1_sha512( 0x0603 ),
6569 * ....
6570 * } SignatureScheme;
6571 *
6572 * struct {
6573 * SignatureScheme supported_signature_algorithms<2..2^16-2>;
6574 * } SignatureSchemeList;
6575 *
6576 * The `extension_data` field of signature algorithm contains a `SignatureAndHashAlgorithm`
6577 * value (TLS 1.2 RFC5246):
6578 * enum {
6579 * none(0), md5(1), sha1(2), sha224(3), sha256(4), sha384(5),
6580 * sha512(6), (255)
6581 * } HashAlgorithm;
6582 *
6583 * enum { anonymous(0), rsa(1), dsa(2), ecdsa(3), (255) }
6584 * SignatureAlgorithm;
6585 *
6586 * struct {
6587 * HashAlgorithm hash;
6588 * SignatureAlgorithm signature;
6589 * } SignatureAndHashAlgorithm;
6590 *
6591 * SignatureAndHashAlgorithm
6592 * supported_signature_algorithms<2..2^16-2>;
6593 *
6594 * The TLS 1.3 signature algorithm extension was defined to be a compatible
6595 * generalization of the TLS 1.2 signature algorithm extension.
6596 * `SignatureAndHashAlgorithm` field of TLS 1.2 can be represented by
6597 * `SignatureScheme` field of TLS 1.3
6598 *
6599 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006600int mbedtls_ssl_parse_sig_alg_ext(mbedtls_ssl_context *ssl,
6601 const unsigned char *buf,
6602 const unsigned char *end)
Gabor Mezei078e8032022-04-27 21:17:56 +02006603{
6604 const unsigned char *p = buf;
6605 size_t supported_sig_algs_len = 0;
6606 const unsigned char *supported_sig_algs_end;
6607 uint16_t sig_alg;
6608 uint32_t common_idx = 0;
6609
Gilles Peskine449bd832023-01-11 14:50:10 +01006610 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
6611 supported_sig_algs_len = MBEDTLS_GET_UINT16_BE(p, 0);
Gabor Mezei078e8032022-04-27 21:17:56 +02006612 p += 2;
6613
Gilles Peskine449bd832023-01-11 14:50:10 +01006614 memset(ssl->handshake->received_sig_algs, 0,
6615 sizeof(ssl->handshake->received_sig_algs));
Gabor Mezei078e8032022-04-27 21:17:56 +02006616
Gilles Peskine449bd832023-01-11 14:50:10 +01006617 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, supported_sig_algs_len);
Gabor Mezei078e8032022-04-27 21:17:56 +02006618 supported_sig_algs_end = p + supported_sig_algs_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01006619 while (p < supported_sig_algs_end) {
6620 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, supported_sig_algs_end, 2);
6621 sig_alg = MBEDTLS_GET_UINT16_BE(p, 0);
Gabor Mezei078e8032022-04-27 21:17:56 +02006622 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01006623 MBEDTLS_SSL_DEBUG_MSG(4, ("received signature algorithm: 0x%x %s",
6624 sig_alg,
6625 mbedtls_ssl_sig_alg_to_str(sig_alg)));
Jerry Yu2fe6c632022-06-29 10:02:38 +08006626#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01006627 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_2 &&
6628 (!(mbedtls_ssl_sig_alg_is_supported(ssl, sig_alg) &&
6629 mbedtls_ssl_sig_alg_is_offered(ssl, sig_alg)))) {
Gabor Mezei078e8032022-04-27 21:17:56 +02006630 continue;
Jerry Yu2fe6c632022-06-29 10:02:38 +08006631 }
6632#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gabor Mezei078e8032022-04-27 21:17:56 +02006633
Gilles Peskine449bd832023-01-11 14:50:10 +01006634 MBEDTLS_SSL_DEBUG_MSG(4, ("valid signature algorithm: %s",
6635 mbedtls_ssl_sig_alg_to_str(sig_alg)));
Gabor Mezei078e8032022-04-27 21:17:56 +02006636
Gilles Peskine449bd832023-01-11 14:50:10 +01006637 if (common_idx + 1 < MBEDTLS_RECEIVED_SIG_ALGS_SIZE) {
Gabor Mezei078e8032022-04-27 21:17:56 +02006638 ssl->handshake->received_sig_algs[common_idx] = sig_alg;
6639 common_idx += 1;
6640 }
6641 }
6642 /* Check that we consumed all the message. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006643 if (p != end) {
6644 MBEDTLS_SSL_DEBUG_MSG(1,
6645 ("Signature algorithms extension length misaligned"));
6646 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR,
6647 MBEDTLS_ERR_SSL_DECODE_ERROR);
6648 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Gabor Mezei078e8032022-04-27 21:17:56 +02006649 }
6650
Gilles Peskine449bd832023-01-11 14:50:10 +01006651 if (common_idx == 0) {
6652 MBEDTLS_SSL_DEBUG_MSG(3, ("no signature algorithm in common"));
6653 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE,
6654 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE);
6655 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Gabor Mezei078e8032022-04-27 21:17:56 +02006656 }
6657
Gabor Mezei15b95a62022-05-09 16:37:58 +02006658 ssl->handshake->received_sig_algs[common_idx] = MBEDTLS_TLS_SIG_NONE;
Gilles Peskine449bd832023-01-11 14:50:10 +01006659 return 0;
Gabor Mezei078e8032022-04-27 21:17:56 +02006660}
6661
Ronald Crone68ab4f2022-10-05 12:46:29 +02006662#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Gabor Mezei078e8032022-04-27 21:17:56 +02006663
Jerry Yudc7bd172022-02-17 13:44:15 +08006664#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
6665
6666#if defined(MBEDTLS_USE_PSA_CRYPTO)
6667
Gilles Peskine449bd832023-01-11 14:50:10 +01006668static psa_status_t setup_psa_key_derivation(psa_key_derivation_operation_t *derivation,
6669 mbedtls_svc_key_id_t key,
6670 psa_algorithm_t alg,
6671 const unsigned char *raw_psk, size_t raw_psk_length,
6672 const unsigned char *seed, size_t seed_length,
6673 const unsigned char *label, size_t label_length,
6674 const unsigned char *other_secret,
6675 size_t other_secret_length,
6676 size_t capacity)
Jerry Yudc7bd172022-02-17 13:44:15 +08006677{
6678 psa_status_t status;
6679
Gilles Peskine449bd832023-01-11 14:50:10 +01006680 status = psa_key_derivation_setup(derivation, alg);
6681 if (status != PSA_SUCCESS) {
6682 return status;
6683 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006684
Gilles Peskine449bd832023-01-11 14:50:10 +01006685 if (PSA_ALG_IS_TLS12_PRF(alg) || PSA_ALG_IS_TLS12_PSK_TO_MS(alg)) {
6686 status = psa_key_derivation_input_bytes(derivation,
6687 PSA_KEY_DERIVATION_INPUT_SEED,
6688 seed, seed_length);
6689 if (status != PSA_SUCCESS) {
6690 return status;
Przemek Stekiel1f027032022-04-05 17:12:11 +02006691 }
6692
Gilles Peskine449bd832023-01-11 14:50:10 +01006693 if (other_secret != NULL) {
6694 status = psa_key_derivation_input_bytes(derivation,
6695 PSA_KEY_DERIVATION_INPUT_OTHER_SECRET,
6696 other_secret, other_secret_length);
6697 if (status != PSA_SUCCESS) {
6698 return status;
6699 }
6700 }
6701
6702 if (mbedtls_svc_key_id_is_null(key)) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006703 status = psa_key_derivation_input_bytes(
6704 derivation, PSA_KEY_DERIVATION_INPUT_SECRET,
Gilles Peskine449bd832023-01-11 14:50:10 +01006705 raw_psk, raw_psk_length);
6706 } else {
Jerry Yudc7bd172022-02-17 13:44:15 +08006707 status = psa_key_derivation_input_key(
Gilles Peskine449bd832023-01-11 14:50:10 +01006708 derivation, PSA_KEY_DERIVATION_INPUT_SECRET, key);
Jerry Yudc7bd172022-02-17 13:44:15 +08006709 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006710 if (status != PSA_SUCCESS) {
6711 return status;
6712 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006713
Gilles Peskine449bd832023-01-11 14:50:10 +01006714 status = psa_key_derivation_input_bytes(derivation,
6715 PSA_KEY_DERIVATION_INPUT_LABEL,
6716 label, label_length);
6717 if (status != PSA_SUCCESS) {
6718 return status;
6719 }
6720 } else {
6721 return PSA_ERROR_NOT_SUPPORTED;
Jerry Yudc7bd172022-02-17 13:44:15 +08006722 }
6723
Gilles Peskine449bd832023-01-11 14:50:10 +01006724 status = psa_key_derivation_set_capacity(derivation, capacity);
6725 if (status != PSA_SUCCESS) {
6726 return status;
6727 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006728
Gilles Peskine449bd832023-01-11 14:50:10 +01006729 return PSA_SUCCESS;
Jerry Yudc7bd172022-02-17 13:44:15 +08006730}
6731
Andrzej Kurek57d10632022-10-24 10:32:01 -04006732#if defined(PSA_WANT_ALG_SHA_384) || \
6733 defined(PSA_WANT_ALG_SHA_256)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006734MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006735static int tls_prf_generic(mbedtls_md_type_t md_type,
6736 const unsigned char *secret, size_t slen,
6737 const char *label,
6738 const unsigned char *random, size_t rlen,
6739 unsigned char *dstbuf, size_t dlen)
Jerry Yudc7bd172022-02-17 13:44:15 +08006740{
6741 psa_status_t status;
6742 psa_algorithm_t alg;
6743 mbedtls_svc_key_id_t master_key = MBEDTLS_SVC_KEY_ID_INIT;
6744 psa_key_derivation_operation_t derivation =
6745 PSA_KEY_DERIVATION_OPERATION_INIT;
6746
Gilles Peskine449bd832023-01-11 14:50:10 +01006747 if (md_type == MBEDTLS_MD_SHA384) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006748 alg = PSA_ALG_TLS12_PRF(PSA_ALG_SHA_384);
Gilles Peskine449bd832023-01-11 14:50:10 +01006749 } else {
Jerry Yudc7bd172022-02-17 13:44:15 +08006750 alg = PSA_ALG_TLS12_PRF(PSA_ALG_SHA_256);
Gilles Peskine449bd832023-01-11 14:50:10 +01006751 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006752
6753 /* Normally a "secret" should be long enough to be impossible to
6754 * find by brute force, and in particular should not be empty. But
6755 * this PRF is also used to derive an IV, in particular in EAP-TLS,
6756 * and for this use case it makes sense to have a 0-length "secret".
6757 * Since the key API doesn't allow importing a key of length 0,
6758 * keep master_key=0, which setup_psa_key_derivation() understands
6759 * to mean a 0-length "secret" input. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006760 if (slen != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006761 psa_key_attributes_t key_attributes = psa_key_attributes_init();
Gilles Peskine449bd832023-01-11 14:50:10 +01006762 psa_set_key_usage_flags(&key_attributes, PSA_KEY_USAGE_DERIVE);
6763 psa_set_key_algorithm(&key_attributes, alg);
6764 psa_set_key_type(&key_attributes, PSA_KEY_TYPE_DERIVE);
Jerry Yudc7bd172022-02-17 13:44:15 +08006765
Gilles Peskine449bd832023-01-11 14:50:10 +01006766 status = psa_import_key(&key_attributes, secret, slen, &master_key);
6767 if (status != PSA_SUCCESS) {
6768 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
6769 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006770 }
6771
Gilles Peskine449bd832023-01-11 14:50:10 +01006772 status = setup_psa_key_derivation(&derivation,
6773 master_key, alg,
6774 NULL, 0,
6775 random, rlen,
6776 (unsigned char const *) label,
6777 (size_t) strlen(label),
6778 NULL, 0,
6779 dlen);
6780 if (status != PSA_SUCCESS) {
6781 psa_key_derivation_abort(&derivation);
6782 psa_destroy_key(master_key);
6783 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yudc7bd172022-02-17 13:44:15 +08006784 }
6785
Gilles Peskine449bd832023-01-11 14:50:10 +01006786 status = psa_key_derivation_output_bytes(&derivation, dstbuf, dlen);
6787 if (status != PSA_SUCCESS) {
6788 psa_key_derivation_abort(&derivation);
6789 psa_destroy_key(master_key);
6790 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yudc7bd172022-02-17 13:44:15 +08006791 }
6792
Gilles Peskine449bd832023-01-11 14:50:10 +01006793 status = psa_key_derivation_abort(&derivation);
6794 if (status != PSA_SUCCESS) {
6795 psa_destroy_key(master_key);
6796 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yudc7bd172022-02-17 13:44:15 +08006797 }
6798
Gilles Peskine449bd832023-01-11 14:50:10 +01006799 if (!mbedtls_svc_key_id_is_null(master_key)) {
6800 status = psa_destroy_key(master_key);
6801 }
6802 if (status != PSA_SUCCESS) {
6803 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
6804 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006805
Gilles Peskine449bd832023-01-11 14:50:10 +01006806 return 0;
Jerry Yudc7bd172022-02-17 13:44:15 +08006807}
Andrzej Kurek57d10632022-10-24 10:32:01 -04006808#endif /* PSA_WANT_ALG_SHA_256 || PSA_WANT_ALG_SHA_384 */
Jerry Yudc7bd172022-02-17 13:44:15 +08006809#else /* MBEDTLS_USE_PSA_CRYPTO */
6810
Andrzej Kurek57d10632022-10-24 10:32:01 -04006811#if defined(MBEDTLS_MD_C) && \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006812 (defined(MBEDTLS_MD_CAN_SHA256) || \
6813 defined(MBEDTLS_MD_CAN_SHA384))
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006814MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006815static int tls_prf_generic(mbedtls_md_type_t md_type,
6816 const unsigned char *secret, size_t slen,
6817 const char *label,
6818 const unsigned char *random, size_t rlen,
6819 unsigned char *dstbuf, size_t dlen)
Jerry Yudc7bd172022-02-17 13:44:15 +08006820{
6821 size_t nb;
6822 size_t i, j, k, md_len;
6823 unsigned char *tmp;
6824 size_t tmp_len = 0;
6825 unsigned char h_i[MBEDTLS_MD_MAX_SIZE];
6826 const mbedtls_md_info_t *md_info;
6827 mbedtls_md_context_t md_ctx;
6828 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6829
Gilles Peskine449bd832023-01-11 14:50:10 +01006830 mbedtls_md_init(&md_ctx);
Jerry Yudc7bd172022-02-17 13:44:15 +08006831
Gilles Peskine449bd832023-01-11 14:50:10 +01006832 if ((md_info = mbedtls_md_info_from_type(md_type)) == NULL) {
6833 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
6834 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006835
Gilles Peskine449bd832023-01-11 14:50:10 +01006836 md_len = mbedtls_md_get_size(md_info);
Jerry Yudc7bd172022-02-17 13:44:15 +08006837
Gilles Peskine449bd832023-01-11 14:50:10 +01006838 tmp_len = md_len + strlen(label) + rlen;
6839 tmp = mbedtls_calloc(1, tmp_len);
6840 if (tmp == NULL) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006841 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
6842 goto exit;
6843 }
6844
Gilles Peskine449bd832023-01-11 14:50:10 +01006845 nb = strlen(label);
6846 memcpy(tmp + md_len, label, nb);
6847 memcpy(tmp + md_len + nb, random, rlen);
Jerry Yudc7bd172022-02-17 13:44:15 +08006848 nb += rlen;
6849
6850 /*
6851 * Compute P_<hash>(secret, label + random)[0..dlen]
6852 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006853 if ((ret = mbedtls_md_setup(&md_ctx, md_info, 1)) != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006854 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006855 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006856
Gilles Peskine449bd832023-01-11 14:50:10 +01006857 ret = mbedtls_md_hmac_starts(&md_ctx, secret, slen);
6858 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006859 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006860 }
6861 ret = mbedtls_md_hmac_update(&md_ctx, tmp + md_len, nb);
6862 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006863 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006864 }
6865 ret = mbedtls_md_hmac_finish(&md_ctx, tmp);
6866 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006867 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006868 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006869
Gilles Peskine449bd832023-01-11 14:50:10 +01006870 for (i = 0; i < dlen; i += md_len) {
6871 ret = mbedtls_md_hmac_reset(&md_ctx);
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_update(&md_ctx, tmp, md_len + nb);
6876 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006877 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006878 }
6879 ret = mbedtls_md_hmac_finish(&md_ctx, h_i);
6880 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006881 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006882 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006883
Gilles Peskine449bd832023-01-11 14:50:10 +01006884 ret = mbedtls_md_hmac_reset(&md_ctx);
6885 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006886 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006887 }
6888 ret = mbedtls_md_hmac_update(&md_ctx, tmp, md_len);
6889 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006890 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006891 }
6892 ret = mbedtls_md_hmac_finish(&md_ctx, tmp);
6893 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006894 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006895 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006896
Gilles Peskine449bd832023-01-11 14:50:10 +01006897 k = (i + md_len > dlen) ? dlen % md_len : md_len;
Jerry Yudc7bd172022-02-17 13:44:15 +08006898
Gilles Peskine449bd832023-01-11 14:50:10 +01006899 for (j = 0; j < k; j++) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006900 dstbuf[i + j] = h_i[j];
Gilles Peskine449bd832023-01-11 14:50:10 +01006901 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006902 }
6903
6904exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01006905 mbedtls_md_free(&md_ctx);
Jerry Yudc7bd172022-02-17 13:44:15 +08006906
Gilles Peskine449bd832023-01-11 14:50:10 +01006907 if (tmp != NULL) {
6908 mbedtls_platform_zeroize(tmp, tmp_len);
6909 }
Dave Rodgman29b9b2b2022-11-01 16:08:14 +00006910
Gilles Peskine449bd832023-01-11 14:50:10 +01006911 mbedtls_platform_zeroize(h_i, sizeof(h_i));
Jerry Yudc7bd172022-02-17 13:44:15 +08006912
Gilles Peskine449bd832023-01-11 14:50:10 +01006913 mbedtls_free(tmp);
Jerry Yudc7bd172022-02-17 13:44:15 +08006914
Gilles Peskine449bd832023-01-11 14:50:10 +01006915 return ret;
Jerry Yudc7bd172022-02-17 13:44:15 +08006916}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006917#endif /* MBEDTLS_MD_C && ( MBEDTLS_MD_CAN_SHA256 || MBEDTLS_MD_CAN_SHA384 ) */
Jerry Yudc7bd172022-02-17 13:44:15 +08006918#endif /* MBEDTLS_USE_PSA_CRYPTO */
6919
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006920#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006921MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006922static int tls_prf_sha256(const unsigned char *secret, size_t slen,
6923 const char *label,
6924 const unsigned char *random, size_t rlen,
6925 unsigned char *dstbuf, size_t dlen)
Jerry Yudc7bd172022-02-17 13:44:15 +08006926{
Gilles Peskine449bd832023-01-11 14:50:10 +01006927 return tls_prf_generic(MBEDTLS_MD_SHA256, secret, slen,
6928 label, random, rlen, dstbuf, dlen);
Jerry Yudc7bd172022-02-17 13:44:15 +08006929}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006930#endif /* MBEDTLS_MD_CAN_SHA256*/
Jerry Yudc7bd172022-02-17 13:44:15 +08006931
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006932#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006933MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006934static int tls_prf_sha384(const unsigned char *secret, size_t slen,
6935 const char *label,
6936 const unsigned char *random, size_t rlen,
6937 unsigned char *dstbuf, size_t dlen)
Jerry Yudc7bd172022-02-17 13:44:15 +08006938{
Gilles Peskine449bd832023-01-11 14:50:10 +01006939 return tls_prf_generic(MBEDTLS_MD_SHA384, secret, slen,
6940 label, random, rlen, dstbuf, dlen);
Jerry Yudc7bd172022-02-17 13:44:15 +08006941}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006942#endif /* MBEDTLS_MD_CAN_SHA384*/
Jerry Yudc7bd172022-02-17 13:44:15 +08006943
Jerry Yuf009d862022-02-17 14:01:37 +08006944/*
6945 * Set appropriate PRF function and other SSL / TLS1.2 functions
6946 *
6947 * Inputs:
Jerry Yuf009d862022-02-17 14:01:37 +08006948 * - hash associated with the ciphersuite (only used by TLS 1.2)
6949 *
6950 * Outputs:
6951 * - the tls_prf, calc_verify and calc_finished members of handshake structure
6952 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006953MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006954static int ssl_set_handshake_prfs(mbedtls_ssl_handshake_params *handshake,
6955 mbedtls_md_type_t hash)
Jerry Yuf009d862022-02-17 14:01:37 +08006956{
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006957#if defined(MBEDTLS_MD_CAN_SHA384)
Gilles Peskine449bd832023-01-11 14:50:10 +01006958 if (hash == MBEDTLS_MD_SHA384) {
Jerry Yuf009d862022-02-17 14:01:37 +08006959 handshake->tls_prf = tls_prf_sha384;
6960 handshake->calc_verify = ssl_calc_verify_tls_sha384;
6961 handshake->calc_finished = ssl_calc_finished_tls_sha384;
Gilles Peskine449bd832023-01-11 14:50:10 +01006962 } else
Jerry Yuf009d862022-02-17 14:01:37 +08006963#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006964#if defined(MBEDTLS_MD_CAN_SHA256)
Jerry Yuf009d862022-02-17 14:01:37 +08006965 {
Ronald Cron81591aa2022-03-07 09:05:51 +01006966 (void) hash;
Jerry Yuf009d862022-02-17 14:01:37 +08006967 handshake->tls_prf = tls_prf_sha256;
6968 handshake->calc_verify = ssl_calc_verify_tls_sha256;
6969 handshake->calc_finished = ssl_calc_finished_tls_sha256;
6970 }
Ronald Cron81591aa2022-03-07 09:05:51 +01006971#else
Jerry Yuf009d862022-02-17 14:01:37 +08006972 {
Jerry Yuf009d862022-02-17 14:01:37 +08006973 (void) handshake;
Ronald Cron81591aa2022-03-07 09:05:51 +01006974 (void) hash;
Gilles Peskine449bd832023-01-11 14:50:10 +01006975 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yuf009d862022-02-17 14:01:37 +08006976 }
Ronald Cron81591aa2022-03-07 09:05:51 +01006977#endif
Jerry Yuf009d862022-02-17 14:01:37 +08006978
Gilles Peskine449bd832023-01-11 14:50:10 +01006979 return 0;
Jerry Yuf009d862022-02-17 14:01:37 +08006980}
Jerry Yud6ab2352022-02-17 14:03:43 +08006981
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006982/*
6983 * Compute master secret if needed
6984 *
6985 * Parameters:
6986 * [in/out] handshake
6987 * [in] resume, premaster, extended_ms, calc_verify, tls_prf
6988 * (PSA-PSK) ciphersuite_info, psk_opaque
6989 * [out] premaster (cleared)
6990 * [out] master
6991 * [in] ssl: optionally used for debugging, EMS and PSA-PSK
6992 * debug: conf->f_dbg, conf->p_dbg
6993 * EMS: passed to calc_verify (debug + session_negotiate)
Ronald Crona25cf582022-03-07 11:10:36 +01006994 * PSA-PSA: conf
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006995 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006996MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006997static int ssl_compute_master(mbedtls_ssl_handshake_params *handshake,
6998 unsigned char *master,
6999 const mbedtls_ssl_context *ssl)
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007000{
7001 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7002
7003 /* cf. RFC 5246, Section 8.1:
7004 * "The master secret is always exactly 48 bytes in length." */
7005 size_t const master_secret_len = 48;
7006
7007#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
7008 unsigned char session_hash[48];
7009#endif /* MBEDTLS_SSL_EXTENDED_MASTER_SECRET */
7010
7011 /* The label for the KDF used for key expansion.
7012 * This is either "master secret" or "extended master secret"
7013 * depending on whether the Extended Master Secret extension
7014 * is used. */
7015 char const *lbl = "master secret";
7016
Przemek Stekielae4ed302022-04-05 17:15:55 +02007017 /* The seed for the KDF used for key expansion.
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007018 * - If the Extended Master Secret extension is not used,
7019 * this is ClientHello.Random + ServerHello.Random
7020 * (see Sect. 8.1 in RFC 5246).
7021 * - If the Extended Master Secret extension is used,
7022 * this is the transcript of the handshake so far.
7023 * (see Sect. 4 in RFC 7627). */
Przemek Stekielae4ed302022-04-05 17:15:55 +02007024 unsigned char const *seed = handshake->randbytes;
7025 size_t seed_len = 64;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007026
7027#if !defined(MBEDTLS_DEBUG_C) && \
7028 !defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET) && \
7029 !(defined(MBEDTLS_USE_PSA_CRYPTO) && \
Gilles Peskine449bd832023-01-11 14:50:10 +01007030 defined(MBEDTLS_KEY_EXCHANGE_PSK_ENABLED))
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007031 ssl = NULL; /* make sure we don't use it except for those cases */
7032 (void) ssl;
7033#endif
7034
Gilles Peskine449bd832023-01-11 14:50:10 +01007035 if (handshake->resume != 0) {
7036 MBEDTLS_SSL_DEBUG_MSG(3, ("no premaster (session resumed)"));
7037 return 0;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007038 }
7039
7040#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
Gilles Peskine449bd832023-01-11 14:50:10 +01007041 if (handshake->extended_ms == MBEDTLS_SSL_EXTENDED_MS_ENABLED) {
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007042 lbl = "extended master secret";
Przemek Stekielae4ed302022-04-05 17:15:55 +02007043 seed = session_hash;
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01007044 ret = handshake->calc_verify(ssl, session_hash, &seed_len);
7045 if (ret != 0) {
7046 MBEDTLS_SSL_DEBUG_RET(1, "calc_verify", ret);
7047 }
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007048
Gilles Peskine449bd832023-01-11 14:50:10 +01007049 MBEDTLS_SSL_DEBUG_BUF(3, "session hash for extended master secret",
7050 session_hash, seed_len);
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007051 }
Przemek Stekiel169bf0b2022-04-29 07:53:29 +02007052#endif /* MBEDTLS_SSL_EXTENDED_MASTER_SECRET */
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007053
Przemek Stekiel99114f32022-04-22 11:20:09 +02007054#if defined(MBEDTLS_USE_PSA_CRYPTO) && \
Przemek Stekiel8a4b7fd2022-04-28 09:22:22 +02007055 defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007056 if (mbedtls_ssl_ciphersuite_uses_psk(handshake->ciphersuite_info) == 1) {
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007057 /* Perform PSK-to-MS expansion in a single step. */
7058 psa_status_t status;
7059 psa_algorithm_t alg;
7060 mbedtls_svc_key_id_t psk;
7061 psa_key_derivation_operation_t derivation =
7062 PSA_KEY_DERIVATION_OPERATION_INIT;
Dave Rodgman2eab4622023-10-05 13:30:37 +01007063 mbedtls_md_type_t hash_alg = (mbedtls_md_type_t) handshake->ciphersuite_info->mac;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007064
Gilles Peskine449bd832023-01-11 14:50:10 +01007065 MBEDTLS_SSL_DEBUG_MSG(2, ("perform PSA-based PSK-to-MS expansion"));
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007066
Gilles Peskine449bd832023-01-11 14:50:10 +01007067 psk = mbedtls_ssl_get_opaque_psk(ssl);
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007068
Gilles Peskine449bd832023-01-11 14:50:10 +01007069 if (hash_alg == MBEDTLS_MD_SHA384) {
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007070 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_384);
Gilles Peskine449bd832023-01-11 14:50:10 +01007071 } else {
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007072 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_256);
Gilles Peskine449bd832023-01-11 14:50:10 +01007073 }
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007074
Przemek Stekiel51a1f362022-04-13 08:57:06 +02007075 size_t other_secret_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01007076 unsigned char *other_secret = NULL;
Przemek Stekielc2033402022-04-05 17:19:41 +02007077
Gilles Peskine449bd832023-01-11 14:50:10 +01007078 switch (handshake->ciphersuite_info->key_exchange) {
Przemek Stekiel19b80f82022-04-14 08:29:31 +02007079 /* Provide other secret.
Przemek Stekiel51a1f362022-04-13 08:57:06 +02007080 * Other secret is stored in premaster, where first 2 bytes hold the
Przemek Stekiel19b80f82022-04-14 08:29:31 +02007081 * length of the other key.
Przemek Stekielc2033402022-04-05 17:19:41 +02007082 */
Przemek Stekiel19b80f82022-04-14 08:29:31 +02007083 case MBEDTLS_KEY_EXCHANGE_RSA_PSK:
Przemek Stekiel8abcee92022-04-28 09:16:28 +02007084 /* For RSA-PSK other key length is always 48 bytes. */
Przemek Stekiel19b80f82022-04-14 08:29:31 +02007085 other_secret_len = 48;
7086 other_secret = handshake->premaster + 2;
7087 break;
7088 case MBEDTLS_KEY_EXCHANGE_ECDHE_PSK:
Przemek Stekielb293aaa2022-04-19 12:22:38 +02007089 case MBEDTLS_KEY_EXCHANGE_DHE_PSK:
Przemek Stekiel19b80f82022-04-14 08:29:31 +02007090 other_secret_len = MBEDTLS_GET_UINT16_BE(handshake->premaster, 0);
7091 other_secret = handshake->premaster + 2;
7092 break;
7093 default:
7094 break;
Przemek Stekielc2033402022-04-05 17:19:41 +02007095 }
7096
Gilles Peskine449bd832023-01-11 14:50:10 +01007097 status = setup_psa_key_derivation(&derivation, psk, alg,
7098 ssl->conf->psk, ssl->conf->psk_len,
7099 seed, seed_len,
7100 (unsigned char const *) lbl,
7101 (size_t) strlen(lbl),
7102 other_secret, other_secret_len,
7103 master_secret_len);
7104 if (status != PSA_SUCCESS) {
7105 psa_key_derivation_abort(&derivation);
7106 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007107 }
7108
Gilles Peskine449bd832023-01-11 14:50:10 +01007109 status = psa_key_derivation_output_bytes(&derivation,
7110 master,
7111 master_secret_len);
7112 if (status != PSA_SUCCESS) {
7113 psa_key_derivation_abort(&derivation);
7114 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007115 }
7116
Gilles Peskine449bd832023-01-11 14:50:10 +01007117 status = psa_key_derivation_abort(&derivation);
7118 if (status != PSA_SUCCESS) {
7119 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
7120 }
7121 } else
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007122#endif
7123 {
Neil Armstrongca7d5062022-05-31 14:43:23 +02007124#if defined(MBEDTLS_USE_PSA_CRYPTO) && \
Gilles Peskine449bd832023-01-11 14:50:10 +01007125 defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
7126 if (handshake->ciphersuite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_ECJPAKE) {
Neil Armstrongca7d5062022-05-31 14:43:23 +02007127 psa_status_t status;
7128 psa_algorithm_t alg = PSA_ALG_TLS12_ECJPAKE_TO_PMS;
7129 psa_key_derivation_operation_t derivation =
7130 PSA_KEY_DERIVATION_OPERATION_INIT;
7131
Gilles Peskine449bd832023-01-11 14:50:10 +01007132 MBEDTLS_SSL_DEBUG_MSG(2, ("perform PSA-based PMS KDF for ECJPAKE"));
Neil Armstrongca7d5062022-05-31 14:43:23 +02007133
7134 handshake->pmslen = PSA_TLS12_ECJPAKE_TO_PMS_DATA_SIZE;
7135
Gilles Peskine449bd832023-01-11 14:50:10 +01007136 status = psa_key_derivation_setup(&derivation, alg);
7137 if (status != PSA_SUCCESS) {
7138 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Neil Armstrongca7d5062022-05-31 14:43:23 +02007139 }
7140
Gilles Peskine449bd832023-01-11 14:50:10 +01007141 status = psa_key_derivation_set_capacity(&derivation,
7142 PSA_TLS12_ECJPAKE_TO_PMS_DATA_SIZE);
7143 if (status != PSA_SUCCESS) {
7144 psa_key_derivation_abort(&derivation);
7145 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Neil Armstrongca7d5062022-05-31 14:43:23 +02007146 }
7147
Gilles Peskine449bd832023-01-11 14:50:10 +01007148 status = psa_pake_get_implicit_key(&handshake->psa_pake_ctx,
7149 &derivation);
7150 if (status != PSA_SUCCESS) {
7151 psa_key_derivation_abort(&derivation);
7152 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Neil Armstrongca7d5062022-05-31 14:43:23 +02007153 }
7154
Gilles Peskine449bd832023-01-11 14:50:10 +01007155 status = psa_key_derivation_output_bytes(&derivation,
7156 handshake->premaster,
7157 handshake->pmslen);
7158 if (status != PSA_SUCCESS) {
7159 psa_key_derivation_abort(&derivation);
7160 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
7161 }
7162
7163 status = psa_key_derivation_abort(&derivation);
7164 if (status != PSA_SUCCESS) {
7165 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Neil Armstrongca7d5062022-05-31 14:43:23 +02007166 }
7167 }
7168#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01007169 ret = handshake->tls_prf(handshake->premaster, handshake->pmslen,
7170 lbl, seed, seed_len,
7171 master,
7172 master_secret_len);
7173 if (ret != 0) {
7174 MBEDTLS_SSL_DEBUG_RET(1, "prf", ret);
7175 return ret;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007176 }
7177
Gilles Peskine449bd832023-01-11 14:50:10 +01007178 MBEDTLS_SSL_DEBUG_BUF(3, "premaster secret",
7179 handshake->premaster,
7180 handshake->pmslen);
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007181
Gilles Peskine449bd832023-01-11 14:50:10 +01007182 mbedtls_platform_zeroize(handshake->premaster,
7183 sizeof(handshake->premaster));
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007184 }
7185
Gilles Peskine449bd832023-01-11 14:50:10 +01007186 return 0;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007187}
7188
Gilles Peskine449bd832023-01-11 14:50:10 +01007189int mbedtls_ssl_derive_keys(mbedtls_ssl_context *ssl)
Jerry Yud62f87e2022-02-17 14:09:02 +08007190{
7191 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7192 const mbedtls_ssl_ciphersuite_t * const ciphersuite_info =
7193 ssl->handshake->ciphersuite_info;
7194
Gilles Peskine449bd832023-01-11 14:50:10 +01007195 MBEDTLS_SSL_DEBUG_MSG(2, ("=> derive keys"));
Jerry Yud62f87e2022-02-17 14:09:02 +08007196
7197 /* Set PRF, calc_verify and calc_finished function pointers */
Gilles Peskine449bd832023-01-11 14:50:10 +01007198 ret = ssl_set_handshake_prfs(ssl->handshake,
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01007199 (mbedtls_md_type_t) ciphersuite_info->mac);
Gilles Peskine449bd832023-01-11 14:50:10 +01007200 if (ret != 0) {
7201 MBEDTLS_SSL_DEBUG_RET(1, "ssl_set_handshake_prfs", ret);
7202 return ret;
Jerry Yud62f87e2022-02-17 14:09:02 +08007203 }
7204
7205 /* Compute master secret if needed */
Gilles Peskine449bd832023-01-11 14:50:10 +01007206 ret = ssl_compute_master(ssl->handshake,
7207 ssl->session_negotiate->master,
7208 ssl);
7209 if (ret != 0) {
7210 MBEDTLS_SSL_DEBUG_RET(1, "ssl_compute_master", ret);
7211 return ret;
Jerry Yud62f87e2022-02-17 14:09:02 +08007212 }
7213
7214 /* Swap the client and server random values:
7215 * - MS derivation wanted client+server (RFC 5246 8.1)
7216 * - key derivation wants server+client (RFC 5246 6.3) */
7217 {
7218 unsigned char tmp[64];
Gilles Peskine449bd832023-01-11 14:50:10 +01007219 memcpy(tmp, ssl->handshake->randbytes, 64);
7220 memcpy(ssl->handshake->randbytes, tmp + 32, 32);
7221 memcpy(ssl->handshake->randbytes + 32, tmp, 32);
7222 mbedtls_platform_zeroize(tmp, sizeof(tmp));
Jerry Yud62f87e2022-02-17 14:09:02 +08007223 }
7224
7225 /* Populate transform structure */
Gilles Peskine449bd832023-01-11 14:50:10 +01007226 ret = ssl_tls12_populate_transform(ssl->transform_negotiate,
7227 ssl->session_negotiate->ciphersuite,
7228 ssl->session_negotiate->master,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02007229#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01007230 ssl->session_negotiate->encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02007231#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01007232 ssl->handshake->tls_prf,
7233 ssl->handshake->randbytes,
7234 ssl->tls_version,
7235 ssl->conf->endpoint,
7236 ssl);
7237 if (ret != 0) {
7238 MBEDTLS_SSL_DEBUG_RET(1, "ssl_tls12_populate_transform", ret);
7239 return ret;
Jerry Yud62f87e2022-02-17 14:09:02 +08007240 }
7241
7242 /* We no longer need Server/ClientHello.random values */
Gilles Peskine449bd832023-01-11 14:50:10 +01007243 mbedtls_platform_zeroize(ssl->handshake->randbytes,
7244 sizeof(ssl->handshake->randbytes));
Jerry Yud62f87e2022-02-17 14:09:02 +08007245
Gilles Peskine449bd832023-01-11 14:50:10 +01007246 MBEDTLS_SSL_DEBUG_MSG(2, ("<= derive keys"));
Jerry Yud62f87e2022-02-17 14:09:02 +08007247
Gilles Peskine449bd832023-01-11 14:50:10 +01007248 return 0;
Jerry Yud62f87e2022-02-17 14:09:02 +08007249}
Jerry Yu8392e0d2022-02-17 14:10:24 +08007250
Gilles Peskine449bd832023-01-11 14:50:10 +01007251int mbedtls_ssl_set_calc_verify_md(mbedtls_ssl_context *ssl, int md)
Ronald Cron4dcbca92022-03-07 10:21:40 +01007252{
Gilles Peskine449bd832023-01-11 14:50:10 +01007253 switch (md) {
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01007254#if defined(MBEDTLS_MD_CAN_SHA384)
Ronald Cron4dcbca92022-03-07 10:21:40 +01007255 case MBEDTLS_SSL_HASH_SHA384:
7256 ssl->handshake->calc_verify = ssl_calc_verify_tls_sha384;
7257 break;
7258#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01007259#if defined(MBEDTLS_MD_CAN_SHA256)
Ronald Cron4dcbca92022-03-07 10:21:40 +01007260 case MBEDTLS_SSL_HASH_SHA256:
7261 ssl->handshake->calc_verify = ssl_calc_verify_tls_sha256;
7262 break;
7263#endif
7264 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01007265 return -1;
Ronald Cron4dcbca92022-03-07 10:21:40 +01007266 }
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01007267#if !defined(MBEDTLS_MD_CAN_SHA384) && \
7268 !defined(MBEDTLS_MD_CAN_SHA256)
Andrzej Kurekeabeb302022-10-17 07:52:51 -04007269 (void) ssl;
7270#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01007271 return 0;
Ronald Cron4dcbca92022-03-07 10:21:40 +01007272}
7273
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007274#if defined(MBEDTLS_USE_PSA_CRYPTO)
7275static int ssl_calc_verify_tls_psa(const mbedtls_ssl_context *ssl,
7276 const psa_hash_operation_t *hs_op,
7277 size_t buffer_size,
7278 unsigned char *hash,
7279 size_t *hlen)
7280{
7281 psa_status_t status;
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007282 psa_hash_operation_t cloned_op = psa_hash_operation_init();
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007283
7284#if !defined(MBEDTLS_DEBUG_C)
7285 (void) ssl;
7286#endif
7287 MBEDTLS_SSL_DEBUG_MSG(2, ("=> PSA calc verify"));
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007288 status = psa_hash_clone(hs_op, &cloned_op);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007289 if (status != PSA_SUCCESS) {
7290 goto exit;
7291 }
7292
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007293 status = psa_hash_finish(&cloned_op, hash, buffer_size, hlen);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007294 if (status != PSA_SUCCESS) {
7295 goto exit;
7296 }
7297
7298 MBEDTLS_SSL_DEBUG_BUF(3, "PSA calculated verify result", hash, *hlen);
7299 MBEDTLS_SSL_DEBUG_MSG(2, ("<= PSA calc verify"));
7300
7301exit:
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007302 psa_hash_abort(&cloned_op);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007303 return mbedtls_md_error_from_psa(status);
7304}
7305#else
7306static int ssl_calc_verify_tls_legacy(const mbedtls_ssl_context *ssl,
7307 const mbedtls_md_context_t *hs_ctx,
7308 unsigned char *hash,
7309 size_t *hlen)
7310{
7311 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007312 mbedtls_md_context_t cloned_ctx;
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007313
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007314 mbedtls_md_init(&cloned_ctx);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007315
7316#if !defined(MBEDTLS_DEBUG_C)
7317 (void) ssl;
7318#endif
7319 MBEDTLS_SSL_DEBUG_MSG(2, ("=> calc verify"));
7320
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007321 ret = mbedtls_md_setup(&cloned_ctx, mbedtls_md_info_from_ctx(hs_ctx), 0);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007322 if (ret != 0) {
7323 goto exit;
7324 }
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007325 ret = mbedtls_md_clone(&cloned_ctx, hs_ctx);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007326 if (ret != 0) {
7327 goto exit;
7328 }
7329
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007330 ret = mbedtls_md_finish(&cloned_ctx, hash);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007331 if (ret != 0) {
7332 goto exit;
7333 }
7334
7335 *hlen = mbedtls_md_get_size(mbedtls_md_info_from_ctx(hs_ctx));
7336
7337 MBEDTLS_SSL_DEBUG_BUF(3, "calculated verify result", hash, *hlen);
7338 MBEDTLS_SSL_DEBUG_MSG(2, ("<= calc verify"));
7339
7340exit:
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007341 mbedtls_md_free(&cloned_ctx);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007342 return ret;
7343}
7344#endif /* MBEDTLS_USE_PSA_CRYPTO */
7345
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01007346#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +01007347int ssl_calc_verify_tls_sha256(const mbedtls_ssl_context *ssl,
7348 unsigned char *hash,
7349 size_t *hlen)
Jerry Yu8392e0d2022-02-17 14:10:24 +08007350{
7351#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007352 return ssl_calc_verify_tls_psa(ssl, &ssl->handshake->fin_sha256_psa, 32,
7353 hash, hlen);
Jerry Yu8392e0d2022-02-17 14:10:24 +08007354#else
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007355 return ssl_calc_verify_tls_legacy(ssl, &ssl->handshake->fin_sha256,
7356 hash, hlen);
Jerry Yu8392e0d2022-02-17 14:10:24 +08007357#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu8392e0d2022-02-17 14:10:24 +08007358}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01007359#endif /* MBEDTLS_MD_CAN_SHA256 */
Jerry Yu8392e0d2022-02-17 14:10:24 +08007360
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01007361#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +01007362int ssl_calc_verify_tls_sha384(const mbedtls_ssl_context *ssl,
7363 unsigned char *hash,
7364 size_t *hlen)
Jerry Yuc1cb3842022-02-17 14:13:48 +08007365{
7366#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007367 return ssl_calc_verify_tls_psa(ssl, &ssl->handshake->fin_sha384_psa, 48,
7368 hash, hlen);
Jerry Yuc1cb3842022-02-17 14:13:48 +08007369#else
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007370 return ssl_calc_verify_tls_legacy(ssl, &ssl->handshake->fin_sha384,
7371 hash, hlen);
Jerry Yuc1cb3842022-02-17 14:13:48 +08007372#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yuc1cb3842022-02-17 14:13:48 +08007373}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01007374#endif /* MBEDTLS_MD_CAN_SHA384 */
Jerry Yuc1cb3842022-02-17 14:13:48 +08007375
Neil Armstrong80f6f322022-05-03 17:56:38 +02007376#if !defined(MBEDTLS_USE_PSA_CRYPTO) && \
7377 defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007378int mbedtls_ssl_psk_derive_premaster(mbedtls_ssl_context *ssl, mbedtls_key_exchange_type_t key_ex)
Jerry Yuce3dca42022-02-17 14:16:37 +08007379{
7380 unsigned char *p = ssl->handshake->premaster;
Gilles Peskine449bd832023-01-11 14:50:10 +01007381 unsigned char *end = p + sizeof(ssl->handshake->premaster);
Jerry Yuce3dca42022-02-17 14:16:37 +08007382 const unsigned char *psk = NULL;
7383 size_t psk_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01007384 int psk_ret = mbedtls_ssl_get_psk(ssl, &psk, &psk_len);
Jerry Yuce3dca42022-02-17 14:16:37 +08007385
Gilles Peskine449bd832023-01-11 14:50:10 +01007386 if (psk_ret == MBEDTLS_ERR_SSL_PRIVATE_KEY_REQUIRED) {
Jerry Yuce3dca42022-02-17 14:16:37 +08007387 /*
7388 * This should never happen because the existence of a PSK is always
Przemek Stekielb293aaa2022-04-19 12:22:38 +02007389 * checked before calling this function.
7390 *
7391 * The exception is opaque DHE-PSK. For DHE-PSK fill premaster with
Przemek Stekiel8abcee92022-04-28 09:16:28 +02007392 * the shared secret without PSK.
Jerry Yuce3dca42022-02-17 14:16:37 +08007393 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007394 if (key_ex != MBEDTLS_KEY_EXCHANGE_DHE_PSK) {
7395 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
7396 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Przemek Stekielb293aaa2022-04-19 12:22:38 +02007397 }
Jerry Yuce3dca42022-02-17 14:16:37 +08007398 }
7399
7400 /*
7401 * PMS = struct {
7402 * opaque other_secret<0..2^16-1>;
7403 * opaque psk<0..2^16-1>;
7404 * };
7405 * with "other_secret" depending on the particular key exchange
7406 */
7407#if defined(MBEDTLS_KEY_EXCHANGE_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007408 if (key_ex == MBEDTLS_KEY_EXCHANGE_PSK) {
7409 if (end - p < 2) {
7410 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
7411 }
Jerry Yuce3dca42022-02-17 14:16:37 +08007412
Gilles Peskine449bd832023-01-11 14:50:10 +01007413 MBEDTLS_PUT_UINT16_BE(psk_len, p, 0);
Jerry Yuce3dca42022-02-17 14:16:37 +08007414 p += 2;
7415
Gilles Peskine449bd832023-01-11 14:50:10 +01007416 if (end < p || (size_t) (end - p) < psk_len) {
7417 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
7418 }
Jerry Yuce3dca42022-02-17 14:16:37 +08007419
Gilles Peskine449bd832023-01-11 14:50:10 +01007420 memset(p, 0, psk_len);
Jerry Yuce3dca42022-02-17 14:16:37 +08007421 p += psk_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01007422 } else
Jerry Yuce3dca42022-02-17 14:16:37 +08007423#endif /* MBEDTLS_KEY_EXCHANGE_PSK_ENABLED */
7424#if defined(MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007425 if (key_ex == MBEDTLS_KEY_EXCHANGE_RSA_PSK) {
Jerry Yuce3dca42022-02-17 14:16:37 +08007426 /*
7427 * other_secret already set by the ClientKeyExchange message,
7428 * and is 48 bytes long
7429 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007430 if (end - p < 2) {
7431 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
7432 }
Jerry Yuce3dca42022-02-17 14:16:37 +08007433
7434 *p++ = 0;
7435 *p++ = 48;
7436 p += 48;
Gilles Peskine449bd832023-01-11 14:50:10 +01007437 } else
Jerry Yuce3dca42022-02-17 14:16:37 +08007438#endif /* MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED */
7439#if defined(MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007440 if (key_ex == MBEDTLS_KEY_EXCHANGE_DHE_PSK) {
Jerry Yuce3dca42022-02-17 14:16:37 +08007441 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7442 size_t len;
7443
7444 /* Write length only when we know the actual value */
Gilles Peskine449bd832023-01-11 14:50:10 +01007445 if ((ret = mbedtls_dhm_calc_secret(&ssl->handshake->dhm_ctx,
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00007446 p + 2, (size_t) (end - (p + 2)), &len,
Gilles Peskine449bd832023-01-11 14:50:10 +01007447 ssl->conf->f_rng, ssl->conf->p_rng)) != 0) {
7448 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_dhm_calc_secret", ret);
7449 return ret;
Jerry Yuce3dca42022-02-17 14:16:37 +08007450 }
Gilles Peskine449bd832023-01-11 14:50:10 +01007451 MBEDTLS_PUT_UINT16_BE(len, p, 0);
Jerry Yuce3dca42022-02-17 14:16:37 +08007452 p += 2 + len;
7453
Gilles Peskine449bd832023-01-11 14:50:10 +01007454 MBEDTLS_SSL_DEBUG_MPI(3, "DHM: K ", &ssl->handshake->dhm_ctx.K);
7455 } else
Jerry Yuce3dca42022-02-17 14:16:37 +08007456#endif /* MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED */
Neil Armstrong80f6f322022-05-03 17:56:38 +02007457#if defined(MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007458 if (key_ex == MBEDTLS_KEY_EXCHANGE_ECDHE_PSK) {
Jerry Yuce3dca42022-02-17 14:16:37 +08007459 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7460 size_t zlen;
7461
Gilles Peskine449bd832023-01-11 14:50:10 +01007462 if ((ret = mbedtls_ecdh_calc_secret(&ssl->handshake->ecdh_ctx, &zlen,
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00007463 p + 2, (size_t) (end - (p + 2)),
Gilles Peskine449bd832023-01-11 14:50:10 +01007464 ssl->conf->f_rng, ssl->conf->p_rng)) != 0) {
7465 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ecdh_calc_secret", ret);
7466 return ret;
Jerry Yuce3dca42022-02-17 14:16:37 +08007467 }
7468
Gilles Peskine449bd832023-01-11 14:50:10 +01007469 MBEDTLS_PUT_UINT16_BE(zlen, p, 0);
Jerry Yuce3dca42022-02-17 14:16:37 +08007470 p += 2 + zlen;
7471
Gilles Peskine449bd832023-01-11 14:50:10 +01007472 MBEDTLS_SSL_DEBUG_ECDH(3, &ssl->handshake->ecdh_ctx,
7473 MBEDTLS_DEBUG_ECDH_Z);
7474 } else
Neil Armstrong80f6f322022-05-03 17:56:38 +02007475#endif /* MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED */
Jerry Yuce3dca42022-02-17 14:16:37 +08007476 {
Gilles Peskine449bd832023-01-11 14:50:10 +01007477 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
7478 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yuce3dca42022-02-17 14:16:37 +08007479 }
7480
7481 /* opaque psk<0..2^16-1>; */
Gilles Peskine449bd832023-01-11 14:50:10 +01007482 if (end - p < 2) {
7483 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
7484 }
Jerry Yuce3dca42022-02-17 14:16:37 +08007485
Gilles Peskine449bd832023-01-11 14:50:10 +01007486 MBEDTLS_PUT_UINT16_BE(psk_len, p, 0);
Jerry Yuce3dca42022-02-17 14:16:37 +08007487 p += 2;
7488
Gilles Peskine449bd832023-01-11 14:50:10 +01007489 if (end < p || (size_t) (end - p) < psk_len) {
7490 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
7491 }
Jerry Yuce3dca42022-02-17 14:16:37 +08007492
Gilles Peskine449bd832023-01-11 14:50:10 +01007493 memcpy(p, psk, psk_len);
Jerry Yuce3dca42022-02-17 14:16:37 +08007494 p += psk_len;
7495
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00007496 ssl->handshake->pmslen = (size_t) (p - ssl->handshake->premaster);
Jerry Yuce3dca42022-02-17 14:16:37 +08007497
Gilles Peskine449bd832023-01-11 14:50:10 +01007498 return 0;
Jerry Yuce3dca42022-02-17 14:16:37 +08007499}
Neil Armstrong80f6f322022-05-03 17:56:38 +02007500#endif /* !MBEDTLS_USE_PSA_CRYPTO && MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
Jerry Yuc2c673d2022-02-17 14:20:39 +08007501
7502#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007503MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007504static int ssl_write_hello_request(mbedtls_ssl_context *ssl);
Jerry Yuc2c673d2022-02-17 14:20:39 +08007505
7506#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01007507int mbedtls_ssl_resend_hello_request(mbedtls_ssl_context *ssl)
Jerry Yuc2c673d2022-02-17 14:20:39 +08007508{
7509 /* If renegotiation is not enforced, retransmit until we would reach max
7510 * timeout if we were using the usual handshake doubling scheme */
Gilles Peskine449bd832023-01-11 14:50:10 +01007511 if (ssl->conf->renego_max_records < 0) {
Jerry Yuc2c673d2022-02-17 14:20:39 +08007512 uint32_t ratio = ssl->conf->hs_timeout_max / ssl->conf->hs_timeout_min + 1;
7513 unsigned char doublings = 1;
7514
Gilles Peskine449bd832023-01-11 14:50:10 +01007515 while (ratio != 0) {
Jerry Yuc2c673d2022-02-17 14:20:39 +08007516 ++doublings;
7517 ratio >>= 1;
7518 }
7519
Gilles Peskine449bd832023-01-11 14:50:10 +01007520 if (++ssl->renego_records_seen > doublings) {
7521 MBEDTLS_SSL_DEBUG_MSG(2, ("no longer retransmitting hello request"));
7522 return 0;
Jerry Yuc2c673d2022-02-17 14:20:39 +08007523 }
7524 }
7525
Gilles Peskine449bd832023-01-11 14:50:10 +01007526 return ssl_write_hello_request(ssl);
Jerry Yuc2c673d2022-02-17 14:20:39 +08007527}
7528#endif
7529#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_RENEGOTIATION */
Jerry Yud9526692022-02-17 14:23:47 +08007530
Jerry Yud9526692022-02-17 14:23:47 +08007531/*
7532 * Handshake functions
7533 */
7534#if !defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
7535/* No certificate support -> dummy functions */
Gilles Peskine449bd832023-01-11 14:50:10 +01007536int mbedtls_ssl_write_certificate(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08007537{
7538 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
7539 ssl->handshake->ciphersuite_info;
7540
Gilles Peskine449bd832023-01-11 14:50:10 +01007541 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007542
Gilles Peskine449bd832023-01-11 14:50:10 +01007543 if (!mbedtls_ssl_ciphersuite_uses_srv_cert(ciphersuite_info)) {
7544 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007545 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01007546 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007547 }
7548
Gilles Peskine449bd832023-01-11 14:50:10 +01007549 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
7550 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007551}
7552
Gilles Peskine449bd832023-01-11 14:50:10 +01007553int mbedtls_ssl_parse_certificate(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08007554{
7555 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
7556 ssl->handshake->ciphersuite_info;
7557
Gilles Peskine449bd832023-01-11 14:50:10 +01007558 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007559
Gilles Peskine449bd832023-01-11 14:50:10 +01007560 if (!mbedtls_ssl_ciphersuite_uses_srv_cert(ciphersuite_info)) {
7561 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007562 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01007563 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007564 }
7565
Gilles Peskine449bd832023-01-11 14:50:10 +01007566 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
7567 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007568}
7569
7570#else /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
7571/* Some certificate support -> implement write and parse */
7572
Gilles Peskine449bd832023-01-11 14:50:10 +01007573int mbedtls_ssl_write_certificate(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08007574{
7575 int ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
7576 size_t i, n;
7577 const mbedtls_x509_crt *crt;
7578 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
7579 ssl->handshake->ciphersuite_info;
7580
Gilles Peskine449bd832023-01-11 14:50:10 +01007581 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007582
Gilles Peskine449bd832023-01-11 14:50:10 +01007583 if (!mbedtls_ssl_ciphersuite_uses_srv_cert(ciphersuite_info)) {
7584 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007585 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01007586 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007587 }
7588
7589#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007590 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
7591 if (ssl->handshake->client_auth == 0) {
7592 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007593 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01007594 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007595 }
7596 }
7597#endif /* MBEDTLS_SSL_CLI_C */
7598#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007599 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
7600 if (mbedtls_ssl_own_cert(ssl) == NULL) {
Jerry Yud9526692022-02-17 14:23:47 +08007601 /* Should never happen because we shouldn't have picked the
7602 * ciphersuite if we don't have a certificate. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007603 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007604 }
7605 }
7606#endif
7607
Gilles Peskine449bd832023-01-11 14:50:10 +01007608 MBEDTLS_SSL_DEBUG_CRT(3, "own certificate", mbedtls_ssl_own_cert(ssl));
Jerry Yud9526692022-02-17 14:23:47 +08007609
7610 /*
7611 * 0 . 0 handshake type
7612 * 1 . 3 handshake length
7613 * 4 . 6 length of all certs
7614 * 7 . 9 length of cert. 1
7615 * 10 . n-1 peer certificate
7616 * n . n+2 length of cert. 2
7617 * n+3 . ... upper level cert, etc.
7618 */
7619 i = 7;
Gilles Peskine449bd832023-01-11 14:50:10 +01007620 crt = mbedtls_ssl_own_cert(ssl);
Jerry Yud9526692022-02-17 14:23:47 +08007621
Gilles Peskine449bd832023-01-11 14:50:10 +01007622 while (crt != NULL) {
Jerry Yud9526692022-02-17 14:23:47 +08007623 n = crt->raw.len;
Gilles Peskine449bd832023-01-11 14:50:10 +01007624 if (n > MBEDTLS_SSL_OUT_CONTENT_LEN - 3 - i) {
7625 MBEDTLS_SSL_DEBUG_MSG(1, ("certificate too large, %" MBEDTLS_PRINTF_SIZET
7626 " > %" MBEDTLS_PRINTF_SIZET,
7627 i + 3 + n, (size_t) MBEDTLS_SSL_OUT_CONTENT_LEN));
7628 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
Jerry Yud9526692022-02-17 14:23:47 +08007629 }
7630
Gilles Peskine449bd832023-01-11 14:50:10 +01007631 ssl->out_msg[i] = MBEDTLS_BYTE_2(n);
7632 ssl->out_msg[i + 1] = MBEDTLS_BYTE_1(n);
7633 ssl->out_msg[i + 2] = MBEDTLS_BYTE_0(n);
Jerry Yud9526692022-02-17 14:23:47 +08007634
Gilles Peskine449bd832023-01-11 14:50:10 +01007635 i += 3; memcpy(ssl->out_msg + i, crt->raw.p, n);
Jerry Yud9526692022-02-17 14:23:47 +08007636 i += n; crt = crt->next;
7637 }
7638
Gilles Peskine449bd832023-01-11 14:50:10 +01007639 ssl->out_msg[4] = MBEDTLS_BYTE_2(i - 7);
7640 ssl->out_msg[5] = MBEDTLS_BYTE_1(i - 7);
7641 ssl->out_msg[6] = MBEDTLS_BYTE_0(i - 7);
Jerry Yud9526692022-02-17 14:23:47 +08007642
7643 ssl->out_msglen = i;
7644 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
7645 ssl->out_msg[0] = MBEDTLS_SSL_HS_CERTIFICATE;
7646
7647 ssl->state++;
7648
Gilles Peskine449bd832023-01-11 14:50:10 +01007649 if ((ret = mbedtls_ssl_write_handshake_msg(ssl)) != 0) {
7650 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_handshake_msg", ret);
7651 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007652 }
7653
Gilles Peskine449bd832023-01-11 14:50:10 +01007654 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007655
Gilles Peskine449bd832023-01-11 14:50:10 +01007656 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007657}
7658
7659#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
7660
7661#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007662MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007663static int ssl_check_peer_crt_unchanged(mbedtls_ssl_context *ssl,
7664 unsigned char *crt_buf,
7665 size_t crt_buf_len)
Jerry Yud9526692022-02-17 14:23:47 +08007666{
7667 mbedtls_x509_crt const * const peer_crt = ssl->session->peer_cert;
7668
Gilles Peskine449bd832023-01-11 14:50:10 +01007669 if (peer_crt == NULL) {
7670 return -1;
7671 }
Jerry Yud9526692022-02-17 14:23:47 +08007672
Gilles Peskine449bd832023-01-11 14:50:10 +01007673 if (peer_crt->raw.len != crt_buf_len) {
7674 return -1;
7675 }
Jerry Yud9526692022-02-17 14:23:47 +08007676
Gilles Peskine449bd832023-01-11 14:50:10 +01007677 return memcmp(peer_crt->raw.p, crt_buf, peer_crt->raw.len);
Jerry Yud9526692022-02-17 14:23:47 +08007678}
7679#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007680MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007681static int ssl_check_peer_crt_unchanged(mbedtls_ssl_context *ssl,
7682 unsigned char *crt_buf,
7683 size_t crt_buf_len)
Jerry Yud9526692022-02-17 14:23:47 +08007684{
7685 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7686 unsigned char const * const peer_cert_digest =
7687 ssl->session->peer_cert_digest;
7688 mbedtls_md_type_t const peer_cert_digest_type =
7689 ssl->session->peer_cert_digest_type;
7690 mbedtls_md_info_t const * const digest_info =
Gilles Peskine449bd832023-01-11 14:50:10 +01007691 mbedtls_md_info_from_type(peer_cert_digest_type);
Jerry Yud9526692022-02-17 14:23:47 +08007692 unsigned char tmp_digest[MBEDTLS_SSL_PEER_CERT_DIGEST_MAX_LEN];
7693 size_t digest_len;
7694
Gilles Peskine449bd832023-01-11 14:50:10 +01007695 if (peer_cert_digest == NULL || digest_info == NULL) {
7696 return -1;
7697 }
Jerry Yud9526692022-02-17 14:23:47 +08007698
Gilles Peskine449bd832023-01-11 14:50:10 +01007699 digest_len = mbedtls_md_get_size(digest_info);
7700 if (digest_len > MBEDTLS_SSL_PEER_CERT_DIGEST_MAX_LEN) {
7701 return -1;
7702 }
Jerry Yud9526692022-02-17 14:23:47 +08007703
Gilles Peskine449bd832023-01-11 14:50:10 +01007704 ret = mbedtls_md(digest_info, crt_buf, crt_buf_len, tmp_digest);
7705 if (ret != 0) {
7706 return -1;
7707 }
Jerry Yud9526692022-02-17 14:23:47 +08007708
Gilles Peskine449bd832023-01-11 14:50:10 +01007709 return memcmp(tmp_digest, peer_cert_digest, digest_len);
Jerry Yud9526692022-02-17 14:23:47 +08007710}
7711#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7712#endif /* MBEDTLS_SSL_RENEGOTIATION && MBEDTLS_SSL_CLI_C */
7713
7714/*
7715 * Once the certificate message is read, parse it into a cert chain and
7716 * perform basic checks, but leave actual verification to the caller
7717 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007718MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007719static int ssl_parse_certificate_chain(mbedtls_ssl_context *ssl,
7720 mbedtls_x509_crt *chain)
Jerry Yud9526692022-02-17 14:23:47 +08007721{
7722 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7723#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007724 int crt_cnt = 0;
Jerry Yud9526692022-02-17 14:23:47 +08007725#endif
7726 size_t i, n;
7727 uint8_t alert;
7728
Gilles Peskine449bd832023-01-11 14:50:10 +01007729 if (ssl->in_msgtype != MBEDTLS_SSL_MSG_HANDSHAKE) {
7730 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7731 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7732 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
7733 return MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
Jerry Yud9526692022-02-17 14:23:47 +08007734 }
7735
Gilles Peskine449bd832023-01-11 14:50:10 +01007736 if (ssl->in_msg[0] != MBEDTLS_SSL_HS_CERTIFICATE) {
7737 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7738 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
7739 return MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
Jerry Yud9526692022-02-17 14:23:47 +08007740 }
7741
Gilles Peskine449bd832023-01-11 14:50:10 +01007742 if (ssl->in_hslen < mbedtls_ssl_hs_hdr_len(ssl) + 3 + 3) {
7743 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7744 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7745 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
7746 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007747 }
7748
Gilles Peskine449bd832023-01-11 14:50:10 +01007749 i = mbedtls_ssl_hs_hdr_len(ssl);
Jerry Yud9526692022-02-17 14:23:47 +08007750
7751 /*
7752 * Same message structure as in mbedtls_ssl_write_certificate()
7753 */
Dave Rodgmana3d0f612023-11-03 23:34:02 +00007754 n = MBEDTLS_GET_UINT16_BE(ssl->in_msg, i + 1);
Jerry Yud9526692022-02-17 14:23:47 +08007755
Gilles Peskine449bd832023-01-11 14:50:10 +01007756 if (ssl->in_msg[i] != 0 ||
7757 ssl->in_hslen != n + 3 + mbedtls_ssl_hs_hdr_len(ssl)) {
7758 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7759 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7760 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
7761 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007762 }
7763
7764 /* Make &ssl->in_msg[i] point to the beginning of the CRT chain. */
7765 i += 3;
7766
7767 /* Iterate through and parse the CRTs in the provided chain. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007768 while (i < ssl->in_hslen) {
Jerry Yud9526692022-02-17 14:23:47 +08007769 /* Check that there's room for the next CRT's length fields. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007770 if (i + 3 > ssl->in_hslen) {
7771 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7772 mbedtls_ssl_send_alert_message(ssl,
7773 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7774 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
7775 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007776 }
7777 /* In theory, the CRT can be up to 2**24 Bytes, but we don't support
7778 * anything beyond 2**16 ~ 64K. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007779 if (ssl->in_msg[i] != 0) {
7780 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7781 mbedtls_ssl_send_alert_message(ssl,
7782 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7783 MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT);
7784 return MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
Jerry Yud9526692022-02-17 14:23:47 +08007785 }
7786
7787 /* Read length of the next CRT in the chain. */
Dave Rodgmana3d0f612023-11-03 23:34:02 +00007788 n = MBEDTLS_GET_UINT16_BE(ssl->in_msg, i + 1);
Jerry Yud9526692022-02-17 14:23:47 +08007789 i += 3;
7790
Gilles Peskine449bd832023-01-11 14:50:10 +01007791 if (n < 128 || i + n > ssl->in_hslen) {
7792 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7793 mbedtls_ssl_send_alert_message(ssl,
7794 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7795 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
7796 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007797 }
7798
7799 /* Check if we're handling the first CRT in the chain. */
7800#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007801 if (crt_cnt++ == 0 &&
Jerry Yud9526692022-02-17 14:23:47 +08007802 ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
Gilles Peskine449bd832023-01-11 14:50:10 +01007803 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS) {
Jerry Yud9526692022-02-17 14:23:47 +08007804 /* During client-side renegotiation, check that the server's
7805 * end-CRTs hasn't changed compared to the initial handshake,
7806 * mitigating the triple handshake attack. On success, reuse
7807 * the original end-CRT instead of parsing it again. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007808 MBEDTLS_SSL_DEBUG_MSG(3, ("Check that peer CRT hasn't changed during renegotiation"));
7809 if (ssl_check_peer_crt_unchanged(ssl,
7810 &ssl->in_msg[i],
7811 n) != 0) {
7812 MBEDTLS_SSL_DEBUG_MSG(1, ("new server cert during renegotiation"));
7813 mbedtls_ssl_send_alert_message(ssl,
7814 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7815 MBEDTLS_SSL_ALERT_MSG_ACCESS_DENIED);
7816 return MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
Jerry Yud9526692022-02-17 14:23:47 +08007817 }
7818
7819 /* Now we can safely free the original chain. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007820 ssl_clear_peer_cert(ssl->session);
Jerry Yud9526692022-02-17 14:23:47 +08007821 }
7822#endif /* MBEDTLS_SSL_RENEGOTIATION && MBEDTLS_SSL_CLI_C */
7823
7824 /* Parse the next certificate in the chain. */
7825#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01007826 ret = mbedtls_x509_crt_parse_der(chain, ssl->in_msg + i, n);
Jerry Yud9526692022-02-17 14:23:47 +08007827#else
7828 /* If we don't need to store the CRT chain permanently, parse
7829 * it in-place from the input buffer instead of making a copy. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007830 ret = mbedtls_x509_crt_parse_der_nocopy(chain, ssl->in_msg + i, n);
Jerry Yud9526692022-02-17 14:23:47 +08007831#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Gilles Peskine449bd832023-01-11 14:50:10 +01007832 switch (ret) {
Jerry Yud9526692022-02-17 14:23:47 +08007833 case 0: /*ok*/
7834 case MBEDTLS_ERR_X509_UNKNOWN_SIG_ALG + MBEDTLS_ERR_OID_NOT_FOUND:
7835 /* Ignore certificate with an unknown algorithm: maybe a
7836 prior certificate was already trusted. */
7837 break;
7838
7839 case MBEDTLS_ERR_X509_ALLOC_FAILED:
7840 alert = MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR;
7841 goto crt_parse_der_failed;
7842
7843 case MBEDTLS_ERR_X509_UNKNOWN_VERSION:
7844 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
7845 goto crt_parse_der_failed;
7846
7847 default:
7848 alert = MBEDTLS_SSL_ALERT_MSG_BAD_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01007849crt_parse_der_failed:
7850 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL, alert);
7851 MBEDTLS_SSL_DEBUG_RET(1, " mbedtls_x509_crt_parse_der", ret);
7852 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007853 }
7854
7855 i += n;
7856 }
7857
Gilles Peskine449bd832023-01-11 14:50:10 +01007858 MBEDTLS_SSL_DEBUG_CRT(3, "peer certificate", chain);
7859 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007860}
7861
7862#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007863MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007864static int ssl_srv_check_client_no_crt_notification(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08007865{
Gilles Peskine449bd832023-01-11 14:50:10 +01007866 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
7867 return -1;
7868 }
Jerry Yud9526692022-02-17 14:23:47 +08007869
Gilles Peskine449bd832023-01-11 14:50:10 +01007870 if (ssl->in_hslen == 3 + mbedtls_ssl_hs_hdr_len(ssl) &&
Jerry Yud9526692022-02-17 14:23:47 +08007871 ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
7872 ssl->in_msg[0] == MBEDTLS_SSL_HS_CERTIFICATE &&
Gilles Peskine449bd832023-01-11 14:50:10 +01007873 memcmp(ssl->in_msg + mbedtls_ssl_hs_hdr_len(ssl), "\0\0\0", 3) == 0) {
7874 MBEDTLS_SSL_DEBUG_MSG(1, ("peer has no certificate"));
7875 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007876 }
Gilles Peskine449bd832023-01-11 14:50:10 +01007877 return -1;
Jerry Yud9526692022-02-17 14:23:47 +08007878}
7879#endif /* MBEDTLS_SSL_SRV_C */
7880
7881/* Check if a certificate message is expected.
7882 * Return either
7883 * - SSL_CERTIFICATE_EXPECTED, or
7884 * - SSL_CERTIFICATE_SKIP
7885 * indicating whether a Certificate message is expected or not.
7886 */
7887#define SSL_CERTIFICATE_EXPECTED 0
7888#define SSL_CERTIFICATE_SKIP 1
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007889MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007890static int ssl_parse_certificate_coordinate(mbedtls_ssl_context *ssl,
7891 int authmode)
Jerry Yud9526692022-02-17 14:23:47 +08007892{
7893 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
7894 ssl->handshake->ciphersuite_info;
7895
Gilles Peskine449bd832023-01-11 14:50:10 +01007896 if (!mbedtls_ssl_ciphersuite_uses_srv_cert(ciphersuite_info)) {
7897 return SSL_CERTIFICATE_SKIP;
7898 }
Jerry Yud9526692022-02-17 14:23:47 +08007899
7900#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007901 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
7902 if (ciphersuite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_RSA_PSK) {
7903 return SSL_CERTIFICATE_SKIP;
7904 }
Jerry Yud9526692022-02-17 14:23:47 +08007905
Gilles Peskine449bd832023-01-11 14:50:10 +01007906 if (authmode == MBEDTLS_SSL_VERIFY_NONE) {
Jerry Yud9526692022-02-17 14:23:47 +08007907 ssl->session_negotiate->verify_result =
7908 MBEDTLS_X509_BADCERT_SKIP_VERIFY;
Gilles Peskine449bd832023-01-11 14:50:10 +01007909 return SSL_CERTIFICATE_SKIP;
Jerry Yud9526692022-02-17 14:23:47 +08007910 }
7911 }
7912#else
7913 ((void) authmode);
7914#endif /* MBEDTLS_SSL_SRV_C */
7915
Gilles Peskine449bd832023-01-11 14:50:10 +01007916 return SSL_CERTIFICATE_EXPECTED;
Jerry Yud9526692022-02-17 14:23:47 +08007917}
7918
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007919MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007920static int ssl_parse_certificate_verify(mbedtls_ssl_context *ssl,
7921 int authmode,
7922 mbedtls_x509_crt *chain,
7923 void *rs_ctx)
Jerry Yud9526692022-02-17 14:23:47 +08007924{
7925 int ret = 0;
7926 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
7927 ssl->handshake->ciphersuite_info;
7928 int have_ca_chain = 0;
7929
7930 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *);
7931 void *p_vrfy;
7932
Gilles Peskine449bd832023-01-11 14:50:10 +01007933 if (authmode == MBEDTLS_SSL_VERIFY_NONE) {
7934 return 0;
7935 }
Jerry Yud9526692022-02-17 14:23:47 +08007936
Gilles Peskine449bd832023-01-11 14:50:10 +01007937 if (ssl->f_vrfy != NULL) {
7938 MBEDTLS_SSL_DEBUG_MSG(3, ("Use context-specific verification callback"));
Jerry Yud9526692022-02-17 14:23:47 +08007939 f_vrfy = ssl->f_vrfy;
7940 p_vrfy = ssl->p_vrfy;
Gilles Peskine449bd832023-01-11 14:50:10 +01007941 } else {
7942 MBEDTLS_SSL_DEBUG_MSG(3, ("Use configuration-specific verification callback"));
Jerry Yud9526692022-02-17 14:23:47 +08007943 f_vrfy = ssl->conf->f_vrfy;
7944 p_vrfy = ssl->conf->p_vrfy;
7945 }
7946
7947 /*
7948 * Main check: verify certificate
7949 */
7950#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
Gilles Peskine449bd832023-01-11 14:50:10 +01007951 if (ssl->conf->f_ca_cb != NULL) {
Jerry Yud9526692022-02-17 14:23:47 +08007952 ((void) rs_ctx);
7953 have_ca_chain = 1;
7954
Gilles Peskine449bd832023-01-11 14:50:10 +01007955 MBEDTLS_SSL_DEBUG_MSG(3, ("use CA callback for X.509 CRT verification"));
Jerry Yud9526692022-02-17 14:23:47 +08007956 ret = mbedtls_x509_crt_verify_with_ca_cb(
7957 chain,
7958 ssl->conf->f_ca_cb,
7959 ssl->conf->p_ca_cb,
7960 ssl->conf->cert_profile,
7961 ssl->hostname,
7962 &ssl->session_negotiate->verify_result,
Gilles Peskine449bd832023-01-11 14:50:10 +01007963 f_vrfy, p_vrfy);
7964 } else
Jerry Yud9526692022-02-17 14:23:47 +08007965#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
7966 {
7967 mbedtls_x509_crt *ca_chain;
7968 mbedtls_x509_crl *ca_crl;
7969
7970#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01007971 if (ssl->handshake->sni_ca_chain != NULL) {
Jerry Yud9526692022-02-17 14:23:47 +08007972 ca_chain = ssl->handshake->sni_ca_chain;
7973 ca_crl = ssl->handshake->sni_ca_crl;
Gilles Peskine449bd832023-01-11 14:50:10 +01007974 } else
Jerry Yud9526692022-02-17 14:23:47 +08007975#endif
7976 {
7977 ca_chain = ssl->conf->ca_chain;
7978 ca_crl = ssl->conf->ca_crl;
7979 }
7980
Gilles Peskine449bd832023-01-11 14:50:10 +01007981 if (ca_chain != NULL) {
Jerry Yud9526692022-02-17 14:23:47 +08007982 have_ca_chain = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01007983 }
Jerry Yud9526692022-02-17 14:23:47 +08007984
7985 ret = mbedtls_x509_crt_verify_restartable(
7986 chain,
7987 ca_chain, ca_crl,
7988 ssl->conf->cert_profile,
7989 ssl->hostname,
7990 &ssl->session_negotiate->verify_result,
Gilles Peskine449bd832023-01-11 14:50:10 +01007991 f_vrfy, p_vrfy, rs_ctx);
Jerry Yud9526692022-02-17 14:23:47 +08007992 }
7993
Gilles Peskine449bd832023-01-11 14:50:10 +01007994 if (ret != 0) {
7995 MBEDTLS_SSL_DEBUG_RET(1, "x509_verify_cert", ret);
Jerry Yud9526692022-02-17 14:23:47 +08007996 }
7997
7998#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007999 if (ret == MBEDTLS_ERR_ECP_IN_PROGRESS) {
8000 return MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS;
8001 }
Jerry Yud9526692022-02-17 14:23:47 +08008002#endif
8003
8004 /*
8005 * Secondary checks: always done, but change 'ret' only if it was 0
8006 */
8007
Valerio Settiacd32c02023-06-29 18:06:29 +02008008#if defined(MBEDTLS_PK_HAVE_ECC_KEYS)
Jerry Yud9526692022-02-17 14:23:47 +08008009 {
8010 const mbedtls_pk_context *pk = &chain->pk;
8011
Manuel Pégourié-Gonnard66b0d612022-06-17 10:49:29 +02008012 /* If certificate uses an EC key, make sure the curve is OK.
8013 * This is a public key, so it can't be opaque, so can_do() is a good
8014 * enough check to ensure pk_ec() is safe to use here. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008015 if (mbedtls_pk_can_do(pk, MBEDTLS_PK_ECKEY)) {
Leonid Rozenboim19e59732022-08-08 16:52:38 -07008016 /* and in the unlikely case the above assumption no longer holds
8017 * we are making sure that pk_ec() here does not return a NULL
8018 */
Valerio Settif9362b72023-11-29 08:42:27 +01008019 mbedtls_ecp_group_id grp_id = mbedtls_pk_get_ec_group_id(pk);
Valerio Settid0405092023-05-24 13:16:40 +02008020 if (grp_id == MBEDTLS_ECP_DP_NONE) {
8021 MBEDTLS_SSL_DEBUG_MSG(1, ("invalid group ID"));
Gilles Peskine449bd832023-01-11 14:50:10 +01008022 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Leonid Rozenboim19e59732022-08-08 16:52:38 -07008023 }
Valerio Setti97207782023-05-18 18:59:06 +02008024 if (mbedtls_ssl_check_curve(ssl, grp_id) != 0) {
Leonid Rozenboim19e59732022-08-08 16:52:38 -07008025 ssl->session_negotiate->verify_result |=
8026 MBEDTLS_X509_BADCERT_BAD_KEY;
8027
Gilles Peskine449bd832023-01-11 14:50:10 +01008028 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate (EC key curve)"));
8029 if (ret == 0) {
Leonid Rozenboim19e59732022-08-08 16:52:38 -07008030 ret = MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
Gilles Peskine449bd832023-01-11 14:50:10 +01008031 }
Leonid Rozenboim19e59732022-08-08 16:52:38 -07008032 }
Jerry Yud9526692022-02-17 14:23:47 +08008033 }
8034 }
Valerio Settiacd32c02023-06-29 18:06:29 +02008035#endif /* MBEDTLS_PK_HAVE_ECC_KEYS */
Jerry Yud9526692022-02-17 14:23:47 +08008036
Gilles Peskine449bd832023-01-11 14:50:10 +01008037 if (mbedtls_ssl_check_cert_usage(chain,
8038 ciphersuite_info,
8039 !ssl->conf->endpoint,
8040 &ssl->session_negotiate->verify_result) != 0) {
8041 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate (usage extensions)"));
8042 if (ret == 0) {
Jerry Yud9526692022-02-17 14:23:47 +08008043 ret = MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
Gilles Peskine449bd832023-01-11 14:50:10 +01008044 }
Jerry Yud9526692022-02-17 14:23:47 +08008045 }
8046
8047 /* mbedtls_x509_crt_verify_with_profile is supposed to report a
8048 * verification failure through MBEDTLS_ERR_X509_CERT_VERIFY_FAILED,
8049 * with details encoded in the verification flags. All other kinds
8050 * of error codes, including those from the user provided f_vrfy
8051 * functions, are treated as fatal and lead to a failure of
8052 * ssl_parse_certificate even if verification was optional. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008053 if (authmode == MBEDTLS_SSL_VERIFY_OPTIONAL &&
8054 (ret == MBEDTLS_ERR_X509_CERT_VERIFY_FAILED ||
8055 ret == MBEDTLS_ERR_SSL_BAD_CERTIFICATE)) {
Jerry Yud9526692022-02-17 14:23:47 +08008056 ret = 0;
8057 }
8058
Gilles Peskine449bd832023-01-11 14:50:10 +01008059 if (have_ca_chain == 0 && authmode == MBEDTLS_SSL_VERIFY_REQUIRED) {
8060 MBEDTLS_SSL_DEBUG_MSG(1, ("got no CA chain"));
Jerry Yud9526692022-02-17 14:23:47 +08008061 ret = MBEDTLS_ERR_SSL_CA_CHAIN_REQUIRED;
8062 }
8063
Gilles Peskine449bd832023-01-11 14:50:10 +01008064 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08008065 uint8_t alert;
8066
8067 /* The certificate may have been rejected for several reasons.
8068 Pick one and send the corresponding alert. Which alert to send
8069 may be a subject of debate in some cases. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008070 if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_OTHER) {
Jerry Yud9526692022-02-17 14:23:47 +08008071 alert = MBEDTLS_SSL_ALERT_MSG_ACCESS_DENIED;
Gilles Peskine449bd832023-01-11 14:50:10 +01008072 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_CN_MISMATCH) {
Jerry Yud9526692022-02-17 14:23:47 +08008073 alert = MBEDTLS_SSL_ALERT_MSG_BAD_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01008074 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_KEY_USAGE) {
Jerry Yud9526692022-02-17 14:23:47 +08008075 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01008076 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_EXT_KEY_USAGE) {
Jerry Yud9526692022-02-17 14:23:47 +08008077 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01008078 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_NS_CERT_TYPE) {
Jerry Yud9526692022-02-17 14:23:47 +08008079 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01008080 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_BAD_PK) {
Jerry Yud9526692022-02-17 14:23:47 +08008081 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01008082 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_BAD_KEY) {
Jerry Yud9526692022-02-17 14:23:47 +08008083 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01008084 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_EXPIRED) {
Jerry Yud9526692022-02-17 14:23:47 +08008085 alert = MBEDTLS_SSL_ALERT_MSG_CERT_EXPIRED;
Gilles Peskine449bd832023-01-11 14:50:10 +01008086 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_REVOKED) {
Jerry Yud9526692022-02-17 14:23:47 +08008087 alert = MBEDTLS_SSL_ALERT_MSG_CERT_REVOKED;
Gilles Peskine449bd832023-01-11 14:50:10 +01008088 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_NOT_TRUSTED) {
Jerry Yud9526692022-02-17 14:23:47 +08008089 alert = MBEDTLS_SSL_ALERT_MSG_UNKNOWN_CA;
Gilles Peskine449bd832023-01-11 14:50:10 +01008090 } else {
Jerry Yud9526692022-02-17 14:23:47 +08008091 alert = MBEDTLS_SSL_ALERT_MSG_CERT_UNKNOWN;
Gilles Peskine449bd832023-01-11 14:50:10 +01008092 }
8093 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8094 alert);
Jerry Yud9526692022-02-17 14:23:47 +08008095 }
8096
8097#if defined(MBEDTLS_DEBUG_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008098 if (ssl->session_negotiate->verify_result != 0) {
8099 MBEDTLS_SSL_DEBUG_MSG(3, ("! Certificate verification flags %08x",
8100 (unsigned int) ssl->session_negotiate->verify_result));
8101 } else {
8102 MBEDTLS_SSL_DEBUG_MSG(3, ("Certificate verification flags clear"));
Jerry Yud9526692022-02-17 14:23:47 +08008103 }
8104#endif /* MBEDTLS_DEBUG_C */
8105
Gilles Peskine449bd832023-01-11 14:50:10 +01008106 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08008107}
8108
8109#if !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02008110MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01008111static int ssl_remember_peer_crt_digest(mbedtls_ssl_context *ssl,
8112 unsigned char *start, size_t len)
Jerry Yud9526692022-02-17 14:23:47 +08008113{
8114 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
8115 /* Remember digest of the peer's end-CRT. */
8116 ssl->session_negotiate->peer_cert_digest =
Gilles Peskine449bd832023-01-11 14:50:10 +01008117 mbedtls_calloc(1, MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN);
8118 if (ssl->session_negotiate->peer_cert_digest == NULL) {
8119 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc(%d bytes) failed",
8120 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN));
8121 mbedtls_ssl_send_alert_message(ssl,
8122 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8123 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR);
Jerry Yud9526692022-02-17 14:23:47 +08008124
Gilles Peskine449bd832023-01-11 14:50:10 +01008125 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
Jerry Yud9526692022-02-17 14:23:47 +08008126 }
8127
Gilles Peskine449bd832023-01-11 14:50:10 +01008128 ret = mbedtls_md(mbedtls_md_info_from_type(
8129 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE),
8130 start, len,
8131 ssl->session_negotiate->peer_cert_digest);
Jerry Yud9526692022-02-17 14:23:47 +08008132
8133 ssl->session_negotiate->peer_cert_digest_type =
8134 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE;
8135 ssl->session_negotiate->peer_cert_digest_len =
8136 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN;
8137
Gilles Peskine449bd832023-01-11 14:50:10 +01008138 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08008139}
8140
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02008141MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01008142static int ssl_remember_peer_pubkey(mbedtls_ssl_context *ssl,
8143 unsigned char *start, size_t len)
Jerry Yud9526692022-02-17 14:23:47 +08008144{
8145 unsigned char *end = start + len;
8146 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
8147
8148 /* Make a copy of the peer's raw public key. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008149 mbedtls_pk_init(&ssl->handshake->peer_pubkey);
8150 ret = mbedtls_pk_parse_subpubkey(&start, end,
8151 &ssl->handshake->peer_pubkey);
8152 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08008153 /* We should have parsed the public key before. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008154 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08008155 }
8156
Gilles Peskine449bd832023-01-11 14:50:10 +01008157 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08008158}
8159#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
8160
Gilles Peskine449bd832023-01-11 14:50:10 +01008161int mbedtls_ssl_parse_certificate(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08008162{
8163 int ret = 0;
8164 int crt_expected;
8165#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
8166 const int authmode = ssl->handshake->sni_authmode != MBEDTLS_SSL_VERIFY_UNSET
8167 ? ssl->handshake->sni_authmode
8168 : ssl->conf->authmode;
8169#else
8170 const int authmode = ssl->conf->authmode;
8171#endif
8172 void *rs_ctx = NULL;
8173 mbedtls_x509_crt *chain = NULL;
8174
Gilles Peskine449bd832023-01-11 14:50:10 +01008175 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08008176
Gilles Peskine449bd832023-01-11 14:50:10 +01008177 crt_expected = ssl_parse_certificate_coordinate(ssl, authmode);
8178 if (crt_expected == SSL_CERTIFICATE_SKIP) {
8179 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08008180 goto exit;
8181 }
8182
8183#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01008184 if (ssl->handshake->ecrs_enabled &&
8185 ssl->handshake->ecrs_state == ssl_ecrs_crt_verify) {
Jerry Yud9526692022-02-17 14:23:47 +08008186 chain = ssl->handshake->ecrs_peer_cert;
8187 ssl->handshake->ecrs_peer_cert = NULL;
8188 goto crt_verify;
8189 }
8190#endif
8191
Gilles Peskine449bd832023-01-11 14:50:10 +01008192 if ((ret = mbedtls_ssl_read_record(ssl, 1)) != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08008193 /* mbedtls_ssl_read_record may have sent an alert already. We
8194 let it decide whether to alert. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008195 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_read_record", ret);
Jerry Yud9526692022-02-17 14:23:47 +08008196 goto exit;
8197 }
8198
8199#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008200 if (ssl_srv_check_client_no_crt_notification(ssl) == 0) {
Jerry Yud9526692022-02-17 14:23:47 +08008201 ssl->session_negotiate->verify_result = MBEDTLS_X509_BADCERT_MISSING;
8202
Gilles Peskine449bd832023-01-11 14:50:10 +01008203 if (authmode != MBEDTLS_SSL_VERIFY_OPTIONAL) {
Jerry Yud9526692022-02-17 14:23:47 +08008204 ret = MBEDTLS_ERR_SSL_NO_CLIENT_CERTIFICATE;
Gilles Peskine449bd832023-01-11 14:50:10 +01008205 }
Jerry Yud9526692022-02-17 14:23:47 +08008206
8207 goto exit;
8208 }
8209#endif /* MBEDTLS_SSL_SRV_C */
8210
8211 /* Clear existing peer CRT structure in case we tried to
8212 * reuse a session but it failed, and allocate a new one. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008213 ssl_clear_peer_cert(ssl->session_negotiate);
Jerry Yud9526692022-02-17 14:23:47 +08008214
Gilles Peskine449bd832023-01-11 14:50:10 +01008215 chain = mbedtls_calloc(1, sizeof(mbedtls_x509_crt));
8216 if (chain == NULL) {
8217 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc(%" MBEDTLS_PRINTF_SIZET " bytes) failed",
8218 sizeof(mbedtls_x509_crt)));
8219 mbedtls_ssl_send_alert_message(ssl,
8220 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8221 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR);
Jerry Yud9526692022-02-17 14:23:47 +08008222
8223 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
8224 goto exit;
8225 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008226 mbedtls_x509_crt_init(chain);
Jerry Yud9526692022-02-17 14:23:47 +08008227
Gilles Peskine449bd832023-01-11 14:50:10 +01008228 ret = ssl_parse_certificate_chain(ssl, chain);
8229 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08008230 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01008231 }
Jerry Yud9526692022-02-17 14:23:47 +08008232
8233#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01008234 if (ssl->handshake->ecrs_enabled) {
Jerry Yud9526692022-02-17 14:23:47 +08008235 ssl->handshake->ecrs_state = ssl_ecrs_crt_verify;
Gilles Peskine449bd832023-01-11 14:50:10 +01008236 }
Jerry Yud9526692022-02-17 14:23:47 +08008237
8238crt_verify:
Gilles Peskine449bd832023-01-11 14:50:10 +01008239 if (ssl->handshake->ecrs_enabled) {
Jerry Yud9526692022-02-17 14:23:47 +08008240 rs_ctx = &ssl->handshake->ecrs_ctx;
Gilles Peskine449bd832023-01-11 14:50:10 +01008241 }
Jerry Yud9526692022-02-17 14:23:47 +08008242#endif
8243
Gilles Peskine449bd832023-01-11 14:50:10 +01008244 ret = ssl_parse_certificate_verify(ssl, authmode,
8245 chain, rs_ctx);
8246 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08008247 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01008248 }
Jerry Yud9526692022-02-17 14:23:47 +08008249
8250#if !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
8251 {
8252 unsigned char *crt_start, *pk_start;
8253 size_t crt_len, pk_len;
8254
8255 /* We parse the CRT chain without copying, so
8256 * these pointers point into the input buffer,
8257 * and are hence still valid after freeing the
8258 * CRT chain. */
8259
8260 crt_start = chain->raw.p;
8261 crt_len = chain->raw.len;
8262
8263 pk_start = chain->pk_raw.p;
8264 pk_len = chain->pk_raw.len;
8265
8266 /* Free the CRT structures before computing
8267 * digest and copying the peer's public key. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008268 mbedtls_x509_crt_free(chain);
8269 mbedtls_free(chain);
Jerry Yud9526692022-02-17 14:23:47 +08008270 chain = NULL;
8271
Gilles Peskine449bd832023-01-11 14:50:10 +01008272 ret = ssl_remember_peer_crt_digest(ssl, crt_start, crt_len);
8273 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08008274 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01008275 }
Jerry Yud9526692022-02-17 14:23:47 +08008276
Gilles Peskine449bd832023-01-11 14:50:10 +01008277 ret = ssl_remember_peer_pubkey(ssl, pk_start, pk_len);
8278 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08008279 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01008280 }
Jerry Yud9526692022-02-17 14:23:47 +08008281 }
8282#else /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
8283 /* Pass ownership to session structure. */
8284 ssl->session_negotiate->peer_cert = chain;
8285 chain = NULL;
8286#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
8287
Gilles Peskine449bd832023-01-11 14:50:10 +01008288 MBEDTLS_SSL_DEBUG_MSG(2, ("<= parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08008289
8290exit:
8291
Gilles Peskine449bd832023-01-11 14:50:10 +01008292 if (ret == 0) {
Jerry Yud9526692022-02-17 14:23:47 +08008293 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01008294 }
Jerry Yud9526692022-02-17 14:23:47 +08008295
8296#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01008297 if (ret == MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS) {
Jerry Yud9526692022-02-17 14:23:47 +08008298 ssl->handshake->ecrs_peer_cert = chain;
8299 chain = NULL;
8300 }
8301#endif
8302
Gilles Peskine449bd832023-01-11 14:50:10 +01008303 if (chain != NULL) {
8304 mbedtls_x509_crt_free(chain);
8305 mbedtls_free(chain);
Jerry Yud9526692022-02-17 14:23:47 +08008306 }
8307
Gilles Peskine449bd832023-01-11 14:50:10 +01008308 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08008309}
8310#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
8311
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008312static int ssl_calc_finished_tls_generic(mbedtls_ssl_context *ssl, void *ctx,
8313 unsigned char *padbuf, size_t hlen,
8314 unsigned char *buf, int from)
Jerry Yu615bd6f2022-02-17 14:25:15 +08008315{
Dave Rodgmanc37ad442023-11-03 23:36:06 +00008316 unsigned int len = 12;
Jerry Yu615bd6f2022-02-17 14:25:15 +08008317 const char *sender;
Jerry Yu615bd6f2022-02-17 14:25:15 +08008318#if defined(MBEDTLS_USE_PSA_CRYPTO)
Jerry Yu615bd6f2022-02-17 14:25:15 +08008319 psa_status_t status;
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008320 psa_hash_operation_t *hs_op = ctx;
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02008321 psa_hash_operation_t cloned_op = PSA_HASH_OPERATION_INIT;
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008322 size_t hash_size;
Jerry Yu615bd6f2022-02-17 14:25:15 +08008323#else
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01008324 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008325 mbedtls_md_context_t *hs_ctx = ctx;
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02008326 mbedtls_md_context_t cloned_ctx;
8327 mbedtls_md_init(&cloned_ctx);
Jerry Yu615bd6f2022-02-17 14:25:15 +08008328#endif
8329
8330 mbedtls_ssl_session *session = ssl->session_negotiate;
Gilles Peskine449bd832023-01-11 14:50:10 +01008331 if (!session) {
Jerry Yu615bd6f2022-02-17 14:25:15 +08008332 session = ssl->session;
Gilles Peskine449bd832023-01-11 14:50:10 +01008333 }
Jerry Yu615bd6f2022-02-17 14:25:15 +08008334
Gilles Peskine449bd832023-01-11 14:50:10 +01008335 sender = (from == MBEDTLS_SSL_IS_CLIENT)
Jerry Yu615bd6f2022-02-17 14:25:15 +08008336 ? "client finished"
8337 : "server finished";
8338
8339#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008340 MBEDTLS_SSL_DEBUG_MSG(2, ("=> calc PSA finished tls"));
Jerry Yu615bd6f2022-02-17 14:25:15 +08008341
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02008342 status = psa_hash_clone(hs_op, &cloned_op);
Gilles Peskine449bd832023-01-11 14:50:10 +01008343 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01008344 goto exit;
Jerry Yu615bd6f2022-02-17 14:25:15 +08008345 }
8346
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02008347 status = psa_hash_finish(&cloned_op, padbuf, hlen, &hash_size);
Gilles Peskine449bd832023-01-11 14:50:10 +01008348 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01008349 goto exit;
Jerry Yu615bd6f2022-02-17 14:25:15 +08008350 }
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008351 MBEDTLS_SSL_DEBUG_BUF(3, "PSA calculated padbuf", padbuf, hlen);
Jerry Yu615bd6f2022-02-17 14:25:15 +08008352#else
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008353 MBEDTLS_SSL_DEBUG_MSG(2, ("=> calc finished tls"));
Jerry Yu615bd6f2022-02-17 14:25:15 +08008354
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02008355 ret = mbedtls_md_setup(&cloned_ctx, mbedtls_md_info_from_ctx(hs_ctx), 0);
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01008356 if (ret != 0) {
8357 goto exit;
8358 }
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02008359 ret = mbedtls_md_clone(&cloned_ctx, hs_ctx);
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01008360 if (ret != 0) {
8361 goto exit;
8362 }
Jerry Yu615bd6f2022-02-17 14:25:15 +08008363
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02008364 ret = mbedtls_md_finish(&cloned_ctx, padbuf);
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008365 if (ret != 0) {
8366 goto exit;
8367 }
8368#endif /* MBEDTLS_USE_PSA_CRYPTO */
8369
8370 MBEDTLS_SSL_DEBUG_BUF(4, "finished output", padbuf, hlen);
8371
Jerry Yu615bd6f2022-02-17 14:25:15 +08008372 /*
8373 * TLSv1.2:
8374 * hash = PRF( master, finished_label,
8375 * Hash( handshake ) )[0.11]
8376 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008377 ssl->handshake->tls_prf(session->master, 48, sender,
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008378 padbuf, hlen, buf, len);
Jerry Yu615bd6f2022-02-17 14:25:15 +08008379
Gilles Peskine449bd832023-01-11 14:50:10 +01008380 MBEDTLS_SSL_DEBUG_BUF(3, "calc finished result", buf, len);
Jerry Yu615bd6f2022-02-17 14:25:15 +08008381
Paul Elliottecb95be2023-08-11 16:41:04 +01008382 mbedtls_platform_zeroize(padbuf, hlen);
Jerry Yu615bd6f2022-02-17 14:25:15 +08008383
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008384 MBEDTLS_SSL_DEBUG_MSG(2, ("<= calc finished"));
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01008385
8386exit:
8387#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02008388 psa_hash_abort(&cloned_op);
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +02008389 return mbedtls_md_error_from_psa(status);
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01008390#else
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02008391 mbedtls_md_free(&cloned_ctx);
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01008392 return ret;
8393#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu615bd6f2022-02-17 14:25:15 +08008394}
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008395
8396#if defined(MBEDTLS_MD_CAN_SHA256)
8397static int ssl_calc_finished_tls_sha256(
8398 mbedtls_ssl_context *ssl, unsigned char *buf, int from)
8399{
8400 unsigned char padbuf[32];
8401 return ssl_calc_finished_tls_generic(ssl,
8402#if defined(MBEDTLS_USE_PSA_CRYPTO)
8403 &ssl->handshake->fin_sha256_psa,
8404#else
8405 &ssl->handshake->fin_sha256,
8406#endif
8407 padbuf, sizeof(padbuf),
8408 buf, from);
8409}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01008410#endif /* MBEDTLS_MD_CAN_SHA256*/
Jerry Yu615bd6f2022-02-17 14:25:15 +08008411
Jerry Yub7ba49e2022-02-17 14:25:53 +08008412
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01008413#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +01008414static int ssl_calc_finished_tls_sha384(
Gilles Peskine449bd832023-01-11 14:50:10 +01008415 mbedtls_ssl_context *ssl, unsigned char *buf, int from)
Jerry Yub7ba49e2022-02-17 14:25:53 +08008416{
Jerry Yub7ba49e2022-02-17 14:25:53 +08008417 unsigned char padbuf[48];
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008418 return ssl_calc_finished_tls_generic(ssl,
Jerry Yub7ba49e2022-02-17 14:25:53 +08008419#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008420 &ssl->handshake->fin_sha384_psa,
Jerry Yub7ba49e2022-02-17 14:25:53 +08008421#else
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008422 &ssl->handshake->fin_sha384,
Jerry Yub7ba49e2022-02-17 14:25:53 +08008423#endif
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008424 padbuf, sizeof(padbuf),
8425 buf, from);
Jerry Yub7ba49e2022-02-17 14:25:53 +08008426}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01008427#endif /* MBEDTLS_MD_CAN_SHA384*/
Jerry Yub7ba49e2022-02-17 14:25:53 +08008428
Gilles Peskine449bd832023-01-11 14:50:10 +01008429void mbedtls_ssl_handshake_wrapup_free_hs_transform(mbedtls_ssl_context *ssl)
Jerry Yuaef00152022-02-17 14:27:31 +08008430{
Gilles Peskine449bd832023-01-11 14:50:10 +01008431 MBEDTLS_SSL_DEBUG_MSG(3, ("=> handshake wrapup: final free"));
Jerry Yuaef00152022-02-17 14:27:31 +08008432
8433 /*
8434 * Free our handshake params
8435 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008436 mbedtls_ssl_handshake_free(ssl);
8437 mbedtls_free(ssl->handshake);
Jerry Yuaef00152022-02-17 14:27:31 +08008438 ssl->handshake = NULL;
8439
8440 /*
Shaun Case8b0ecbc2021-12-20 21:14:10 -08008441 * Free the previous transform and switch in the current one
Jerry Yuaef00152022-02-17 14:27:31 +08008442 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008443 if (ssl->transform) {
8444 mbedtls_ssl_transform_free(ssl->transform);
8445 mbedtls_free(ssl->transform);
Jerry Yuaef00152022-02-17 14:27:31 +08008446 }
8447 ssl->transform = ssl->transform_negotiate;
8448 ssl->transform_negotiate = NULL;
8449
Gilles Peskine449bd832023-01-11 14:50:10 +01008450 MBEDTLS_SSL_DEBUG_MSG(3, ("<= handshake wrapup: final free"));
Jerry Yuaef00152022-02-17 14:27:31 +08008451}
8452
Gilles Peskine449bd832023-01-11 14:50:10 +01008453void mbedtls_ssl_handshake_wrapup(mbedtls_ssl_context *ssl)
Jerry Yu2a9fff52022-02-17 14:28:51 +08008454{
8455 int resume = ssl->handshake->resume;
8456
Gilles Peskine449bd832023-01-11 14:50:10 +01008457 MBEDTLS_SSL_DEBUG_MSG(3, ("=> handshake wrapup"));
Jerry Yu2a9fff52022-02-17 14:28:51 +08008458
8459#if defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01008460 if (ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS) {
Jerry Yu2a9fff52022-02-17 14:28:51 +08008461 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_DONE;
8462 ssl->renego_records_seen = 0;
8463 }
8464#endif
8465
8466 /*
8467 * Free the previous session and switch in the current one
8468 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008469 if (ssl->session) {
Jerry Yu2a9fff52022-02-17 14:28:51 +08008470#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
8471 /* RFC 7366 3.1: keep the EtM state */
8472 ssl->session_negotiate->encrypt_then_mac =
Gilles Peskine449bd832023-01-11 14:50:10 +01008473 ssl->session->encrypt_then_mac;
Jerry Yu2a9fff52022-02-17 14:28:51 +08008474#endif
8475
Gilles Peskine449bd832023-01-11 14:50:10 +01008476 mbedtls_ssl_session_free(ssl->session);
8477 mbedtls_free(ssl->session);
Jerry Yu2a9fff52022-02-17 14:28:51 +08008478 }
8479 ssl->session = ssl->session_negotiate;
8480 ssl->session_negotiate = NULL;
8481
8482 /*
8483 * Add cache entry
8484 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008485 if (ssl->conf->f_set_cache != NULL &&
Jerry Yu2a9fff52022-02-17 14:28:51 +08008486 ssl->session->id_len != 0 &&
Gilles Peskine449bd832023-01-11 14:50:10 +01008487 resume == 0) {
8488 if (ssl->conf->f_set_cache(ssl->conf->p_cache,
8489 ssl->session->id,
8490 ssl->session->id_len,
8491 ssl->session) != 0) {
8492 MBEDTLS_SSL_DEBUG_MSG(1, ("cache did not store session"));
8493 }
Jerry Yu2a9fff52022-02-17 14:28:51 +08008494 }
8495
8496#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01008497 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
8498 ssl->handshake->flight != NULL) {
Jerry Yu2a9fff52022-02-17 14:28:51 +08008499 /* Cancel handshake timer */
Gilles Peskine449bd832023-01-11 14:50:10 +01008500 mbedtls_ssl_set_timer(ssl, 0);
Jerry Yu2a9fff52022-02-17 14:28:51 +08008501
8502 /* Keep last flight around in case we need to resend it:
8503 * we need the handshake and transform structures for that */
Gilles Peskine449bd832023-01-11 14:50:10 +01008504 MBEDTLS_SSL_DEBUG_MSG(3, ("skip freeing handshake and transform"));
8505 } else
Jerry Yu2a9fff52022-02-17 14:28:51 +08008506#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01008507 mbedtls_ssl_handshake_wrapup_free_hs_transform(ssl);
Jerry Yu2a9fff52022-02-17 14:28:51 +08008508
Jerry Yu5ed73ff2022-10-27 13:08:42 +08008509 ssl->state = MBEDTLS_SSL_HANDSHAKE_OVER;
Jerry Yu2a9fff52022-02-17 14:28:51 +08008510
Gilles Peskine449bd832023-01-11 14:50:10 +01008511 MBEDTLS_SSL_DEBUG_MSG(3, ("<= handshake wrapup"));
Jerry Yu2a9fff52022-02-17 14:28:51 +08008512}
8513
Gilles Peskine449bd832023-01-11 14:50:10 +01008514int mbedtls_ssl_write_finished(mbedtls_ssl_context *ssl)
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008515{
Dave Rodgmanc37ad442023-11-03 23:36:06 +00008516 int ret;
8517 unsigned int hash_len;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008518
Gilles Peskine449bd832023-01-11 14:50:10 +01008519 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write finished"));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008520
Gilles Peskine449bd832023-01-11 14:50:10 +01008521 mbedtls_ssl_update_out_pointers(ssl, ssl->transform_negotiate);
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008522
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01008523 ret = ssl->handshake->calc_finished(ssl, ssl->out_msg + 4, ssl->conf->endpoint);
8524 if (ret != 0) {
8525 MBEDTLS_SSL_DEBUG_RET(1, "calc_finished", ret);
8526 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008527
8528 /*
8529 * RFC 5246 7.4.9 (Page 63) says 12 is the default length and ciphersuites
8530 * may define some other value. Currently (early 2016), no defined
8531 * ciphersuite does this (and this is unlikely to change as activity has
8532 * moved to TLS 1.3 now) so we can keep the hardcoded 12 here.
8533 */
8534 hash_len = 12;
8535
8536#if defined(MBEDTLS_SSL_RENEGOTIATION)
8537 ssl->verify_data_len = hash_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01008538 memcpy(ssl->own_verify_data, ssl->out_msg + 4, hash_len);
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008539#endif
8540
8541 ssl->out_msglen = 4 + hash_len;
8542 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
8543 ssl->out_msg[0] = MBEDTLS_SSL_HS_FINISHED;
8544
8545 /*
8546 * In case of session resuming, invert the client and server
8547 * ChangeCipherSpec messages order.
8548 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008549 if (ssl->handshake->resume != 0) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008550#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008551 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008552 ssl->state = MBEDTLS_SSL_HANDSHAKE_WRAPUP;
Gilles Peskine449bd832023-01-11 14:50:10 +01008553 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008554#endif
8555#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008556 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008557 ssl->state = MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC;
Gilles Peskine449bd832023-01-11 14:50:10 +01008558 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008559#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01008560 } else {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008561 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01008562 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008563
8564 /*
8565 * Switch to our negotiated transform and session parameters for outbound
8566 * data.
8567 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008568 MBEDTLS_SSL_DEBUG_MSG(3, ("switching to new transform spec for outbound data"));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008569
8570#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01008571 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008572 unsigned char i;
8573
8574 /* Remember current epoch settings for resending */
8575 ssl->handshake->alt_transform_out = ssl->transform_out;
Gilles Peskine449bd832023-01-11 14:50:10 +01008576 memcpy(ssl->handshake->alt_out_ctr, ssl->cur_out_ctr,
8577 sizeof(ssl->handshake->alt_out_ctr));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008578
8579 /* Set sequence_number to zero */
Gilles Peskine449bd832023-01-11 14:50:10 +01008580 memset(&ssl->cur_out_ctr[2], 0, sizeof(ssl->cur_out_ctr) - 2);
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008581
8582
8583 /* Increment epoch */
Gilles Peskine449bd832023-01-11 14:50:10 +01008584 for (i = 2; i > 0; i--) {
8585 if (++ssl->cur_out_ctr[i - 1] != 0) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008586 break;
Gilles Peskine449bd832023-01-11 14:50:10 +01008587 }
8588 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008589
8590 /* The loop goes to its end iff the counter is wrapping */
Gilles Peskine449bd832023-01-11 14:50:10 +01008591 if (i == 0) {
8592 MBEDTLS_SSL_DEBUG_MSG(1, ("DTLS epoch would wrap"));
8593 return MBEDTLS_ERR_SSL_COUNTER_WRAPPING;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008594 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008595 } else
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008596#endif /* MBEDTLS_SSL_PROTO_DTLS */
Gilles Peskine449bd832023-01-11 14:50:10 +01008597 memset(ssl->cur_out_ctr, 0, sizeof(ssl->cur_out_ctr));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008598
8599 ssl->transform_out = ssl->transform_negotiate;
8600 ssl->session_out = ssl->session_negotiate;
8601
8602#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01008603 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
8604 mbedtls_ssl_send_flight_completed(ssl);
8605 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008606#endif
8607
Gilles Peskine449bd832023-01-11 14:50:10 +01008608 if ((ret = mbedtls_ssl_write_handshake_msg(ssl)) != 0) {
8609 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_handshake_msg", ret);
8610 return ret;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008611 }
8612
8613#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01008614 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
8615 (ret = mbedtls_ssl_flight_transmit(ssl)) != 0) {
8616 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_flight_transmit", ret);
8617 return ret;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008618 }
8619#endif
8620
Gilles Peskine449bd832023-01-11 14:50:10 +01008621 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write finished"));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008622
Gilles Peskine449bd832023-01-11 14:50:10 +01008623 return 0;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008624}
8625
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008626#define SSL_MAX_HASH_LEN 12
8627
Gilles Peskine449bd832023-01-11 14:50:10 +01008628int mbedtls_ssl_parse_finished(mbedtls_ssl_context *ssl)
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008629{
8630 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
8631 unsigned int hash_len = 12;
8632 unsigned char buf[SSL_MAX_HASH_LEN];
8633
Gilles Peskine449bd832023-01-11 14:50:10 +01008634 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse finished"));
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008635
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01008636 ret = ssl->handshake->calc_finished(ssl, buf, ssl->conf->endpoint ^ 1);
8637 if (ret != 0) {
8638 MBEDTLS_SSL_DEBUG_RET(1, "calc_finished", ret);
8639 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008640
Gilles Peskine449bd832023-01-11 14:50:10 +01008641 if ((ret = mbedtls_ssl_read_record(ssl, 1)) != 0) {
8642 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_read_record", ret);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008643 goto exit;
8644 }
8645
Gilles Peskine449bd832023-01-11 14:50:10 +01008646 if (ssl->in_msgtype != MBEDTLS_SSL_MSG_HANDSHAKE) {
8647 MBEDTLS_SSL_DEBUG_MSG(1, ("bad finished message"));
8648 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8649 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008650 ret = MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
8651 goto exit;
8652 }
8653
Gilles Peskine449bd832023-01-11 14:50:10 +01008654 if (ssl->in_msg[0] != MBEDTLS_SSL_HS_FINISHED) {
8655 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8656 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008657 ret = MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
8658 goto exit;
8659 }
8660
Gilles Peskine449bd832023-01-11 14:50:10 +01008661 if (ssl->in_hslen != mbedtls_ssl_hs_hdr_len(ssl) + hash_len) {
8662 MBEDTLS_SSL_DEBUG_MSG(1, ("bad finished message"));
8663 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8664 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008665 ret = MBEDTLS_ERR_SSL_DECODE_ERROR;
8666 goto exit;
8667 }
8668
Gilles Peskine449bd832023-01-11 14:50:10 +01008669 if (mbedtls_ct_memcmp(ssl->in_msg + mbedtls_ssl_hs_hdr_len(ssl),
8670 buf, hash_len) != 0) {
8671 MBEDTLS_SSL_DEBUG_MSG(1, ("bad finished message"));
8672 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8673 MBEDTLS_SSL_ALERT_MSG_DECRYPT_ERROR);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008674 ret = MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
8675 goto exit;
8676 }
8677
8678#if defined(MBEDTLS_SSL_RENEGOTIATION)
8679 ssl->verify_data_len = hash_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01008680 memcpy(ssl->peer_verify_data, buf, hash_len);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008681#endif
8682
Gilles Peskine449bd832023-01-11 14:50:10 +01008683 if (ssl->handshake->resume != 0) {
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008684#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008685 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008686 ssl->state = MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC;
Gilles Peskine449bd832023-01-11 14:50:10 +01008687 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008688#endif
8689#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008690 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008691 ssl->state = MBEDTLS_SSL_HANDSHAKE_WRAPUP;
Gilles Peskine449bd832023-01-11 14:50:10 +01008692 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008693#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01008694 } else {
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008695 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01008696 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008697
8698#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01008699 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
8700 mbedtls_ssl_recv_flight_completed(ssl);
8701 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008702#endif
8703
Gilles Peskine449bd832023-01-11 14:50:10 +01008704 MBEDTLS_SSL_DEBUG_MSG(2, ("<= parse finished"));
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008705
8706exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01008707 mbedtls_platform_zeroize(buf, hash_len);
8708 return ret;
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008709}
8710
Jerry Yu392112c2022-02-17 14:34:10 +08008711#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
8712/*
8713 * Helper to get TLS 1.2 PRF from ciphersuite
8714 * (Duplicates bits of logic from ssl_set_handshake_prfs().)
8715 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008716static tls_prf_fn ssl_tls12prf_from_cs(int ciphersuite_id)
Jerry Yu392112c2022-02-17 14:34:10 +08008717{
Jerry Yu392112c2022-02-17 14:34:10 +08008718 const mbedtls_ssl_ciphersuite_t * const ciphersuite_info =
Gilles Peskine449bd832023-01-11 14:50:10 +01008719 mbedtls_ssl_ciphersuite_from_id(ciphersuite_id);
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01008720#if defined(MBEDTLS_MD_CAN_SHA384)
Gilles Peskine449bd832023-01-11 14:50:10 +01008721 if (ciphersuite_info != NULL && ciphersuite_info->mac == MBEDTLS_MD_SHA384) {
8722 return tls_prf_sha384;
8723 } else
Jerry Yu392112c2022-02-17 14:34:10 +08008724#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01008725#if defined(MBEDTLS_MD_CAN_SHA256)
Andrzej Kurek894edde2022-09-29 06:31:14 -04008726 {
Gilles Peskine449bd832023-01-11 14:50:10 +01008727 if (ciphersuite_info != NULL && ciphersuite_info->mac == MBEDTLS_MD_SHA256) {
8728 return tls_prf_sha256;
8729 }
Andrzej Kurek894edde2022-09-29 06:31:14 -04008730 }
8731#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01008732#if !defined(MBEDTLS_MD_CAN_SHA384) && \
8733 !defined(MBEDTLS_MD_CAN_SHA256)
Andrzej Kurek894edde2022-09-29 06:31:14 -04008734 (void) ciphersuite_info;
8735#endif
Andrzej Kurekeabeb302022-10-17 07:52:51 -04008736
Gilles Peskine449bd832023-01-11 14:50:10 +01008737 return NULL;
Jerry Yu392112c2022-02-17 14:34:10 +08008738}
8739#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
Jerry Yue93ffcd2022-02-17 14:37:06 +08008740
Gilles Peskine449bd832023-01-11 14:50:10 +01008741static mbedtls_tls_prf_types tls_prf_get_type(mbedtls_ssl_tls_prf_cb *tls_prf)
Jerry Yue93ffcd2022-02-17 14:37:06 +08008742{
8743 ((void) tls_prf);
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01008744#if defined(MBEDTLS_MD_CAN_SHA384)
Gilles Peskine449bd832023-01-11 14:50:10 +01008745 if (tls_prf == tls_prf_sha384) {
8746 return MBEDTLS_SSL_TLS_PRF_SHA384;
8747 } else
Jerry Yue93ffcd2022-02-17 14:37:06 +08008748#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01008749#if defined(MBEDTLS_MD_CAN_SHA256)
Gilles Peskine449bd832023-01-11 14:50:10 +01008750 if (tls_prf == tls_prf_sha256) {
8751 return MBEDTLS_SSL_TLS_PRF_SHA256;
8752 } else
Jerry Yue93ffcd2022-02-17 14:37:06 +08008753#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01008754 return MBEDTLS_SSL_TLS_PRF_NONE;
Jerry Yue93ffcd2022-02-17 14:37:06 +08008755}
8756
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008757/*
8758 * Populate a transform structure with session keys and all the other
8759 * necessary information.
8760 *
8761 * Parameters:
8762 * - [in/out]: transform: structure to populate
8763 * [in] must be just initialised with mbedtls_ssl_transform_init()
8764 * [out] fully populated, ready for use by mbedtls_ssl_{en,de}crypt_buf()
8765 * - [in] ciphersuite
8766 * - [in] master
8767 * - [in] encrypt_then_mac
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008768 * - [in] tls_prf: pointer to PRF to use for key derivation
8769 * - [in] randbytes: buffer holding ServerHello.random + ClientHello.random
Glenn Strauss07c64162022-03-14 12:34:51 -04008770 * - [in] tls_version: TLS version
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008771 * - [in] endpoint: client or server
8772 * - [in] ssl: used for:
8773 * - ssl->conf->{f,p}_export_keys
8774 * [in] optionally used for:
8775 * - MBEDTLS_DEBUG_C: ssl->conf->{f,p}_dbg
8776 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02008777MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01008778static int ssl_tls12_populate_transform(mbedtls_ssl_transform *transform,
8779 int ciphersuite,
8780 const unsigned char master[48],
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008781#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01008782 int encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008783#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01008784 ssl_tls_prf_t tls_prf,
8785 const unsigned char randbytes[64],
8786 mbedtls_ssl_protocol_version tls_version,
8787 unsigned endpoint,
8788 const mbedtls_ssl_context *ssl)
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008789{
8790 int ret = 0;
8791 unsigned char keyblk[256];
8792 unsigned char *key1;
8793 unsigned char *key2;
8794 unsigned char *mac_enc;
8795 unsigned char *mac_dec;
8796 size_t mac_key_len = 0;
8797 size_t iv_copy_len;
8798 size_t keylen;
8799 const mbedtls_ssl_ciphersuite_t *ciphersuite_info;
Neil Armstrong7fea33e2022-04-01 15:40:25 +02008800 mbedtls_ssl_mode_t ssl_mode;
Neil Armstronge4512952022-03-08 09:08:22 +01008801#if !defined(MBEDTLS_USE_PSA_CRYPTO)
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008802 const mbedtls_cipher_info_t *cipher_info;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008803 const mbedtls_md_info_t *md_info;
Neil Armstronge4512952022-03-08 09:08:22 +01008804#endif /* !MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008805
8806#if defined(MBEDTLS_USE_PSA_CRYPTO)
8807 psa_key_type_t key_type;
8808 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
8809 psa_algorithm_t alg;
Neil Armstronge4512952022-03-08 09:08:22 +01008810 psa_algorithm_t mac_alg = 0;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008811 size_t key_bits;
8812 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
8813#endif
8814
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008815 /*
8816 * Some data just needs copying into the structure
8817 */
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008818#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008819 transform->encrypt_then_mac = encrypt_then_mac;
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008820#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Glenn Strauss07c64162022-03-14 12:34:51 -04008821 transform->tls_version = tls_version;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008822
8823#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01008824 memcpy(transform->randbytes, randbytes, sizeof(transform->randbytes));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008825#endif
8826
8827#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01008828 if (tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008829 /* At the moment, we keep TLS <= 1.2 and TLS 1.3 transform
8830 * generation separate. This should never happen. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008831 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008832 }
8833#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
8834
8835 /*
8836 * Get various info structures
8837 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008838 ciphersuite_info = mbedtls_ssl_ciphersuite_from_id(ciphersuite);
8839 if (ciphersuite_info == NULL) {
8840 MBEDTLS_SSL_DEBUG_MSG(1, ("ciphersuite info for %d not found",
8841 ciphersuite));
8842 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008843 }
8844
Neil Armstrongab555e02022-04-04 11:07:59 +02008845 ssl_mode = mbedtls_ssl_get_mode_from_ciphersuite(
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008846#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01008847 encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008848#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01008849 ciphersuite_info);
Neil Armstrong7fea33e2022-04-01 15:40:25 +02008850
Gilles Peskine449bd832023-01-11 14:50:10 +01008851 if (ssl_mode == MBEDTLS_SSL_MODE_AEAD) {
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008852 transform->taglen =
8853 ciphersuite_info->flags & MBEDTLS_CIPHERSUITE_SHORT_TAG ? 8 : 16;
Gilles Peskine449bd832023-01-11 14:50:10 +01008854 }
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008855
8856#if defined(MBEDTLS_USE_PSA_CRYPTO)
Dave Rodgman2eab4622023-10-05 13:30:37 +01008857 if ((status = mbedtls_ssl_cipher_to_psa((mbedtls_cipher_type_t) ciphersuite_info->cipher,
Gilles Peskine449bd832023-01-11 14:50:10 +01008858 transform->taglen,
8859 &alg,
8860 &key_type,
8861 &key_bits)) != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008862 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01008863 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_cipher_to_psa", ret);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008864 goto end;
8865 }
8866#else
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01008867 cipher_info = mbedtls_cipher_info_from_type((mbedtls_cipher_type_t) ciphersuite_info->cipher);
Gilles Peskine449bd832023-01-11 14:50:10 +01008868 if (cipher_info == NULL) {
8869 MBEDTLS_SSL_DEBUG_MSG(1, ("cipher info for %u not found",
8870 ciphersuite_info->cipher));
8871 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008872 }
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008873#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008874
Neil Armstronge4512952022-03-08 09:08:22 +01008875#if defined(MBEDTLS_USE_PSA_CRYPTO)
Dave Rodgman2eab4622023-10-05 13:30:37 +01008876 mac_alg = mbedtls_md_psa_alg_from_type((mbedtls_md_type_t) ciphersuite_info->mac);
Gilles Peskine449bd832023-01-11 14:50:10 +01008877 if (mac_alg == 0) {
Manuel Pégourié-Gonnard2d6d9932023-03-28 11:38:08 +02008878 MBEDTLS_SSL_DEBUG_MSG(1, ("mbedtls_md_psa_alg_from_type for %u not found",
Gilles Peskine449bd832023-01-11 14:50:10 +01008879 (unsigned) ciphersuite_info->mac));
8880 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Neil Armstronge4512952022-03-08 09:08:22 +01008881 }
8882#else
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01008883 md_info = mbedtls_md_info_from_type((mbedtls_md_type_t) ciphersuite_info->mac);
Gilles Peskine449bd832023-01-11 14:50:10 +01008884 if (md_info == NULL) {
8885 MBEDTLS_SSL_DEBUG_MSG(1, ("mbedtls_md info for %u not found",
8886 (unsigned) ciphersuite_info->mac));
8887 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008888 }
Neil Armstronge4512952022-03-08 09:08:22 +01008889#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008890
8891#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
8892 /* Copy own and peer's CID if the use of the CID
8893 * extension has been negotiated. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008894 if (ssl->handshake->cid_in_use == MBEDTLS_SSL_CID_ENABLED) {
8895 MBEDTLS_SSL_DEBUG_MSG(3, ("Copy CIDs into SSL transform"));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008896
8897 transform->in_cid_len = ssl->own_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01008898 memcpy(transform->in_cid, ssl->own_cid, ssl->own_cid_len);
8899 MBEDTLS_SSL_DEBUG_BUF(3, "Incoming CID", transform->in_cid,
8900 transform->in_cid_len);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008901
8902 transform->out_cid_len = ssl->handshake->peer_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01008903 memcpy(transform->out_cid, ssl->handshake->peer_cid,
8904 ssl->handshake->peer_cid_len);
8905 MBEDTLS_SSL_DEBUG_BUF(3, "Outgoing CID", transform->out_cid,
8906 transform->out_cid_len);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008907 }
8908#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
8909
8910 /*
8911 * Compute key block using the PRF
8912 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008913 ret = tls_prf(master, 48, "key expansion", randbytes, 64, keyblk, 256);
8914 if (ret != 0) {
8915 MBEDTLS_SSL_DEBUG_RET(1, "prf", ret);
8916 return ret;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008917 }
8918
Gilles Peskine449bd832023-01-11 14:50:10 +01008919 MBEDTLS_SSL_DEBUG_MSG(3, ("ciphersuite = %s",
8920 mbedtls_ssl_get_ciphersuite_name(ciphersuite)));
8921 MBEDTLS_SSL_DEBUG_BUF(3, "master secret", master, 48);
8922 MBEDTLS_SSL_DEBUG_BUF(4, "random bytes", randbytes, 64);
8923 MBEDTLS_SSL_DEBUG_BUF(4, "key block", keyblk, 256);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008924
8925 /*
8926 * Determine the appropriate key, IV and MAC length.
8927 */
8928
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008929#if defined(MBEDTLS_USE_PSA_CRYPTO)
8930 keylen = PSA_BITS_TO_BYTES(key_bits);
8931#else
Gilles Peskine449bd832023-01-11 14:50:10 +01008932 keylen = mbedtls_cipher_info_get_key_bitlen(cipher_info) / 8;
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008933#endif
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008934
Valerio Settie5707042023-10-11 11:54:42 +02008935#if defined(MBEDTLS_SSL_HAVE_AEAD)
Gilles Peskine449bd832023-01-11 14:50:10 +01008936 if (ssl_mode == MBEDTLS_SSL_MODE_AEAD) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008937 size_t explicit_ivlen;
8938
8939 transform->maclen = 0;
8940 mac_key_len = 0;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008941
8942 /* All modes haves 96-bit IVs, but the length of the static parts vary
8943 * with mode and version:
8944 * - For GCM and CCM in TLS 1.2, there's a static IV of 4 Bytes
8945 * (to be concatenated with a dynamically chosen IV of 8 Bytes)
8946 * - For ChaChaPoly in TLS 1.2, and all modes in TLS 1.3, there's
8947 * a static IV of 12 Bytes (to be XOR'ed with the 8 Byte record
8948 * sequence number).
8949 */
8950 transform->ivlen = 12;
David Horstmann3b2276a2022-10-06 14:49:08 +01008951
8952 int is_chachapoly = 0;
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008953#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01008954 is_chachapoly = (key_type == PSA_KEY_TYPE_CHACHA20);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008955#else
Gilles Peskine449bd832023-01-11 14:50:10 +01008956 is_chachapoly = (mbedtls_cipher_info_get_mode(cipher_info)
8957 == MBEDTLS_MODE_CHACHAPOLY);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008958#endif /* MBEDTLS_USE_PSA_CRYPTO */
David Horstmann3b2276a2022-10-06 14:49:08 +01008959
Gilles Peskine449bd832023-01-11 14:50:10 +01008960 if (is_chachapoly) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008961 transform->fixed_ivlen = 12;
Gilles Peskine449bd832023-01-11 14:50:10 +01008962 } else {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008963 transform->fixed_ivlen = 4;
Gilles Peskine449bd832023-01-11 14:50:10 +01008964 }
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008965
8966 /* Minimum length of encrypted record */
8967 explicit_ivlen = transform->ivlen - transform->fixed_ivlen;
8968 transform->minlen = explicit_ivlen + transform->taglen;
Gilles Peskine449bd832023-01-11 14:50:10 +01008969 } else
Valerio Settie5707042023-10-11 11:54:42 +02008970#endif /* MBEDTLS_SSL_HAVE_AEAD */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008971#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01008972 if (ssl_mode == MBEDTLS_SSL_MODE_STREAM ||
Neil Armstrong7fea33e2022-04-01 15:40:25 +02008973 ssl_mode == MBEDTLS_SSL_MODE_CBC ||
Gilles Peskine449bd832023-01-11 14:50:10 +01008974 ssl_mode == MBEDTLS_SSL_MODE_CBC_ETM) {
Neil Armstronge4512952022-03-08 09:08:22 +01008975#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01008976 size_t block_size = PSA_BLOCK_CIPHER_BLOCK_LENGTH(key_type);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008977#else
Dave Rodgman85a88132023-06-24 11:41:50 +01008978 size_t block_size = mbedtls_cipher_info_get_block_size(cipher_info);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008979#endif /* MBEDTLS_USE_PSA_CRYPTO */
8980
8981#if defined(MBEDTLS_USE_PSA_CRYPTO)
Neil Armstronge4512952022-03-08 09:08:22 +01008982 /* Get MAC length */
8983 mac_key_len = PSA_HASH_LENGTH(mac_alg);
8984#else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008985 /* Initialize HMAC contexts */
Gilles Peskine449bd832023-01-11 14:50:10 +01008986 if ((ret = mbedtls_md_setup(&transform->md_ctx_enc, md_info, 1)) != 0 ||
8987 (ret = mbedtls_md_setup(&transform->md_ctx_dec, md_info, 1)) != 0) {
8988 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_setup", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008989 goto end;
8990 }
8991
8992 /* Get MAC length */
Gilles Peskine449bd832023-01-11 14:50:10 +01008993 mac_key_len = mbedtls_md_get_size(md_info);
Neil Armstronge4512952022-03-08 09:08:22 +01008994#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008995 transform->maclen = mac_key_len;
8996
8997 /* IV length */
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008998#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01008999 transform->ivlen = PSA_CIPHER_IV_LENGTH(key_type, alg);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02009000#else
Dave Rodgmanbb521fd2023-06-24 11:21:25 +01009001 transform->ivlen = mbedtls_cipher_info_get_iv_size(cipher_info);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02009002#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009003
9004 /* Minimum length */
Gilles Peskine449bd832023-01-11 14:50:10 +01009005 if (ssl_mode == MBEDTLS_SSL_MODE_STREAM) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009006 transform->minlen = transform->maclen;
Gilles Peskine449bd832023-01-11 14:50:10 +01009007 } else {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009008 /*
9009 * GenericBlockCipher:
9010 * 1. if EtM is in use: one block plus MAC
9011 * otherwise: * first multiple of blocklen greater than maclen
9012 * 2. IV
9013 */
9014#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01009015 if (ssl_mode == MBEDTLS_SSL_MODE_CBC_ETM) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009016 transform->minlen = transform->maclen
Gilles Peskine449bd832023-01-11 14:50:10 +01009017 + block_size;
9018 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009019#endif
9020 {
9021 transform->minlen = transform->maclen
Gilles Peskine449bd832023-01-11 14:50:10 +01009022 + block_size
9023 - transform->maclen % block_size;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009024 }
9025
Gilles Peskine449bd832023-01-11 14:50:10 +01009026 if (tls_version == MBEDTLS_SSL_VERSION_TLS1_2) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009027 transform->minlen += transform->ivlen;
Gilles Peskine449bd832023-01-11 14:50:10 +01009028 } else {
9029 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009030 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
9031 goto end;
9032 }
9033 }
Gilles Peskine449bd832023-01-11 14:50:10 +01009034 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009035#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
9036 {
Gilles Peskine449bd832023-01-11 14:50:10 +01009037 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
9038 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009039 }
9040
Gilles Peskine449bd832023-01-11 14:50:10 +01009041 MBEDTLS_SSL_DEBUG_MSG(3, ("keylen: %u, minlen: %u, ivlen: %u, maclen: %u",
9042 (unsigned) keylen,
9043 (unsigned) transform->minlen,
9044 (unsigned) transform->ivlen,
9045 (unsigned) transform->maclen));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009046
9047 /*
9048 * Finally setup the cipher contexts, IVs and MAC secrets.
9049 */
9050#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01009051 if (endpoint == MBEDTLS_SSL_IS_CLIENT) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009052 key1 = keyblk + mac_key_len * 2;
9053 key2 = keyblk + mac_key_len * 2 + keylen;
9054
9055 mac_enc = keyblk;
9056 mac_dec = keyblk + mac_key_len;
9057
Gilles Peskine449bd832023-01-11 14:50:10 +01009058 iv_copy_len = (transform->fixed_ivlen) ?
9059 transform->fixed_ivlen : transform->ivlen;
9060 memcpy(transform->iv_enc, key2 + keylen, iv_copy_len);
9061 memcpy(transform->iv_dec, key2 + keylen + iv_copy_len,
9062 iv_copy_len);
9063 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009064#endif /* MBEDTLS_SSL_CLI_C */
9065#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01009066 if (endpoint == MBEDTLS_SSL_IS_SERVER) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009067 key1 = keyblk + mac_key_len * 2 + keylen;
9068 key2 = keyblk + mac_key_len * 2;
9069
9070 mac_enc = keyblk + mac_key_len;
9071 mac_dec = keyblk;
9072
Gilles Peskine449bd832023-01-11 14:50:10 +01009073 iv_copy_len = (transform->fixed_ivlen) ?
9074 transform->fixed_ivlen : transform->ivlen;
9075 memcpy(transform->iv_dec, key1 + keylen, iv_copy_len);
9076 memcpy(transform->iv_enc, key1 + keylen + iv_copy_len,
9077 iv_copy_len);
9078 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009079#endif /* MBEDTLS_SSL_SRV_C */
9080 {
Gilles Peskine449bd832023-01-11 14:50:10 +01009081 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009082 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
9083 goto end;
9084 }
9085
Paul Elliott4fb19552023-10-18 12:15:30 +01009086 if (ssl->f_export_keys != NULL) {
Gilles Peskine449bd832023-01-11 14:50:10 +01009087 ssl->f_export_keys(ssl->p_export_keys,
9088 MBEDTLS_SSL_KEY_EXPORT_TLS12_MASTER_SECRET,
9089 master, 48,
9090 randbytes + 32,
9091 randbytes,
9092 tls_prf_get_type(tls_prf));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009093 }
9094
9095#if defined(MBEDTLS_USE_PSA_CRYPTO)
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009096 transform->psa_alg = alg;
9097
Gilles Peskine449bd832023-01-11 14:50:10 +01009098 if (alg != MBEDTLS_SSL_NULL_CIPHER) {
9099 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_ENCRYPT);
9100 psa_set_key_algorithm(&attributes, alg);
9101 psa_set_key_type(&attributes, key_type);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009102
Gilles Peskine449bd832023-01-11 14:50:10 +01009103 if ((status = psa_import_key(&attributes,
9104 key1,
9105 PSA_BITS_TO_BYTES(key_bits),
9106 &transform->psa_key_enc)) != PSA_SUCCESS) {
9107 MBEDTLS_SSL_DEBUG_RET(3, "psa_import_key", (int) status);
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05009108 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01009109 MBEDTLS_SSL_DEBUG_RET(1, "psa_import_key", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009110 goto end;
9111 }
9112
Gilles Peskine449bd832023-01-11 14:50:10 +01009113 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_DECRYPT);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009114
Gilles Peskine449bd832023-01-11 14:50:10 +01009115 if ((status = psa_import_key(&attributes,
9116 key2,
9117 PSA_BITS_TO_BYTES(key_bits),
9118 &transform->psa_key_dec)) != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05009119 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01009120 MBEDTLS_SSL_DEBUG_RET(1, "psa_import_key", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009121 goto end;
9122 }
9123 }
9124#else
Gilles Peskine449bd832023-01-11 14:50:10 +01009125 if ((ret = mbedtls_cipher_setup(&transform->cipher_ctx_enc,
9126 cipher_info)) != 0) {
9127 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_setup", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009128 goto end;
9129 }
9130
Gilles Peskine449bd832023-01-11 14:50:10 +01009131 if ((ret = mbedtls_cipher_setup(&transform->cipher_ctx_dec,
9132 cipher_info)) != 0) {
9133 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_setup", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009134 goto end;
9135 }
9136
Gilles Peskine449bd832023-01-11 14:50:10 +01009137 if ((ret = mbedtls_cipher_setkey(&transform->cipher_ctx_enc, key1,
9138 (int) mbedtls_cipher_info_get_key_bitlen(cipher_info),
9139 MBEDTLS_ENCRYPT)) != 0) {
9140 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_setkey", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009141 goto end;
9142 }
9143
Gilles Peskine449bd832023-01-11 14:50:10 +01009144 if ((ret = mbedtls_cipher_setkey(&transform->cipher_ctx_dec, key2,
9145 (int) mbedtls_cipher_info_get_key_bitlen(cipher_info),
9146 MBEDTLS_DECRYPT)) != 0) {
9147 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_setkey", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009148 goto end;
9149 }
9150
9151#if defined(MBEDTLS_CIPHER_MODE_CBC)
Gilles Peskine449bd832023-01-11 14:50:10 +01009152 if (mbedtls_cipher_info_get_mode(cipher_info) == MBEDTLS_MODE_CBC) {
9153 if ((ret = mbedtls_cipher_set_padding_mode(&transform->cipher_ctx_enc,
9154 MBEDTLS_PADDING_NONE)) != 0) {
9155 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_set_padding_mode", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009156 goto end;
9157 }
9158
Gilles Peskine449bd832023-01-11 14:50:10 +01009159 if ((ret = mbedtls_cipher_set_padding_mode(&transform->cipher_ctx_dec,
9160 MBEDTLS_PADDING_NONE)) != 0) {
9161 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_set_padding_mode", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009162 goto end;
9163 }
9164 }
9165#endif /* MBEDTLS_CIPHER_MODE_CBC */
9166#endif /* MBEDTLS_USE_PSA_CRYPTO */
9167
Neil Armstrong29c0c042022-03-17 17:47:28 +01009168#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
9169 /* For HMAC-based ciphersuites, initialize the HMAC transforms.
9170 For AEAD-based ciphersuites, there is nothing to do here. */
Gilles Peskine449bd832023-01-11 14:50:10 +01009171 if (mac_key_len != 0) {
Neil Armstrong29c0c042022-03-17 17:47:28 +01009172#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01009173 transform->psa_mac_alg = PSA_ALG_HMAC(mac_alg);
Neil Armstrong29c0c042022-03-17 17:47:28 +01009174
Gilles Peskine449bd832023-01-11 14:50:10 +01009175 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_SIGN_MESSAGE);
9176 psa_set_key_algorithm(&attributes, PSA_ALG_HMAC(mac_alg));
9177 psa_set_key_type(&attributes, PSA_KEY_TYPE_HMAC);
Neil Armstrong29c0c042022-03-17 17:47:28 +01009178
Gilles Peskine449bd832023-01-11 14:50:10 +01009179 if ((status = psa_import_key(&attributes,
9180 mac_enc, mac_key_len,
9181 &transform->psa_mac_enc)) != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05009182 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01009183 MBEDTLS_SSL_DEBUG_RET(1, "psa_import_mac_key", ret);
Neil Armstrong29c0c042022-03-17 17:47:28 +01009184 goto end;
9185 }
9186
Gilles Peskine449bd832023-01-11 14:50:10 +01009187 if ((transform->psa_alg == MBEDTLS_SSL_NULL_CIPHER) ||
9188 ((transform->psa_alg == PSA_ALG_CBC_NO_PADDING)
Andrzej Kurek8c95ac42022-08-17 16:17:00 -04009189#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01009190 && (transform->encrypt_then_mac == MBEDTLS_SSL_ETM_DISABLED)
Andrzej Kurek8c95ac42022-08-17 16:17:00 -04009191#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01009192 )) {
Neil Armstrong29c0c042022-03-17 17:47:28 +01009193 /* mbedtls_ct_hmac() requires the key to be exportable */
Gilles Peskine449bd832023-01-11 14:50:10 +01009194 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_EXPORT |
9195 PSA_KEY_USAGE_VERIFY_HASH);
9196 } else {
9197 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_VERIFY_HASH);
9198 }
Neil Armstrong29c0c042022-03-17 17:47:28 +01009199
Gilles Peskine449bd832023-01-11 14:50:10 +01009200 if ((status = psa_import_key(&attributes,
9201 mac_dec, mac_key_len,
9202 &transform->psa_mac_dec)) != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05009203 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01009204 MBEDTLS_SSL_DEBUG_RET(1, "psa_import_mac_key", ret);
Neil Armstrong29c0c042022-03-17 17:47:28 +01009205 goto end;
9206 }
9207#else
Gilles Peskine449bd832023-01-11 14:50:10 +01009208 ret = mbedtls_md_hmac_starts(&transform->md_ctx_enc, mac_enc, mac_key_len);
9209 if (ret != 0) {
Neil Armstrong29c0c042022-03-17 17:47:28 +01009210 goto end;
Gilles Peskine449bd832023-01-11 14:50:10 +01009211 }
9212 ret = mbedtls_md_hmac_starts(&transform->md_ctx_dec, mac_dec, mac_key_len);
9213 if (ret != 0) {
Neil Armstrong29c0c042022-03-17 17:47:28 +01009214 goto end;
Gilles Peskine449bd832023-01-11 14:50:10 +01009215 }
Neil Armstrong29c0c042022-03-17 17:47:28 +01009216#endif /* MBEDTLS_USE_PSA_CRYPTO */
9217 }
9218#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
9219
9220 ((void) mac_dec);
9221 ((void) mac_enc);
9222
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009223end:
Gilles Peskine449bd832023-01-11 14:50:10 +01009224 mbedtls_platform_zeroize(keyblk, sizeof(keyblk));
9225 return ret;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009226}
9227
Valerio Settia08b1a42022-11-17 15:10:02 +01009228#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED) && \
9229 defined(MBEDTLS_USE_PSA_CRYPTO)
Valerio Setti6b3dab02022-11-17 17:14:54 +01009230int mbedtls_psa_ecjpake_read_round(
Gilles Peskine449bd832023-01-11 14:50:10 +01009231 psa_pake_operation_t *pake_ctx,
9232 const unsigned char *buf,
9233 size_t len, mbedtls_ecjpake_rounds_t round)
Valerio Settia08b1a42022-11-17 15:10:02 +01009234{
9235 psa_status_t status;
9236 size_t input_offset = 0;
Valerio Setti819de862022-11-17 18:05:19 +01009237 /*
Valerio Setti6b3dab02022-11-17 17:14:54 +01009238 * At round one repeat the KEY_SHARE, ZK_PUBLIC & ZF_PROOF twice
9239 * At round two perform a single cycle
9240 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009241 unsigned int remaining_steps = (round == MBEDTLS_ECJPAKE_ROUND_ONE) ? 2 : 1;
Valerio Settia08b1a42022-11-17 15:10:02 +01009242
Gilles Peskine449bd832023-01-11 14:50:10 +01009243 for (; remaining_steps > 0; remaining_steps--) {
9244 for (psa_pake_step_t step = PSA_PAKE_STEP_KEY_SHARE;
Valerio Settia08b1a42022-11-17 15:10:02 +01009245 step <= PSA_PAKE_STEP_ZK_PROOF;
Gilles Peskine449bd832023-01-11 14:50:10 +01009246 ++step) {
Valerio Settia08b1a42022-11-17 15:10:02 +01009247 /* Length is stored at the first byte */
9248 size_t length = buf[input_offset];
9249 input_offset += 1;
9250
Gilles Peskine449bd832023-01-11 14:50:10 +01009251 if (input_offset + length > len) {
Valerio Settia08b1a42022-11-17 15:10:02 +01009252 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
9253 }
9254
Gilles Peskine449bd832023-01-11 14:50:10 +01009255 status = psa_pake_input(pake_ctx, step,
9256 buf + input_offset, length);
9257 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05009258 return PSA_TO_MBEDTLS_ERR(status);
Valerio Settia08b1a42022-11-17 15:10:02 +01009259 }
9260
9261 input_offset += length;
9262 }
9263 }
9264
Gilles Peskine449bd832023-01-11 14:50:10 +01009265 if (input_offset != len) {
Valerio Setti61ea17d2022-11-18 12:11:00 +01009266 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Gilles Peskine449bd832023-01-11 14:50:10 +01009267 }
Valerio Setti30ebe112022-11-17 16:23:34 +01009268
Gilles Peskine449bd832023-01-11 14:50:10 +01009269 return 0;
Valerio Settia08b1a42022-11-17 15:10:02 +01009270}
9271
Valerio Setti6b3dab02022-11-17 17:14:54 +01009272int mbedtls_psa_ecjpake_write_round(
Gilles Peskine449bd832023-01-11 14:50:10 +01009273 psa_pake_operation_t *pake_ctx,
9274 unsigned char *buf,
9275 size_t len, size_t *olen,
9276 mbedtls_ecjpake_rounds_t round)
Valerio Settia08b1a42022-11-17 15:10:02 +01009277{
9278 psa_status_t status;
9279 size_t output_offset = 0;
9280 size_t output_len;
Valerio Setti819de862022-11-17 18:05:19 +01009281 /*
Valerio Setti6b3dab02022-11-17 17:14:54 +01009282 * At round one repeat the KEY_SHARE, ZK_PUBLIC & ZF_PROOF twice
9283 * At round two perform a single cycle
9284 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009285 unsigned int remaining_steps = (round == MBEDTLS_ECJPAKE_ROUND_ONE) ? 2 : 1;
Valerio Settia08b1a42022-11-17 15:10:02 +01009286
Gilles Peskine449bd832023-01-11 14:50:10 +01009287 for (; remaining_steps > 0; remaining_steps--) {
9288 for (psa_pake_step_t step = PSA_PAKE_STEP_KEY_SHARE;
9289 step <= PSA_PAKE_STEP_ZK_PROOF;
9290 ++step) {
Valerio Setti79f6b6b2022-11-21 14:17:03 +01009291 /*
Valerio Settid4a9b1a2022-11-22 11:11:10 +01009292 * For each step, prepend 1 byte with the length of the data as
9293 * given by psa_pake_output().
Valerio Setti79f6b6b2022-11-21 14:17:03 +01009294 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009295 status = psa_pake_output(pake_ctx, step,
9296 buf + output_offset + 1,
9297 len - output_offset - 1,
9298 &output_len);
9299 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05009300 return PSA_TO_MBEDTLS_ERR(status);
Valerio Settia08b1a42022-11-17 15:10:02 +01009301 }
9302
Valerio Setti99d88c12022-11-22 16:03:43 +01009303 *(buf + output_offset) = (uint8_t) output_len;
Valerio Setti79f6b6b2022-11-21 14:17:03 +01009304
9305 output_offset += output_len + 1;
Valerio Settia08b1a42022-11-17 15:10:02 +01009306 }
9307 }
9308
9309 *olen = output_offset;
9310
Gilles Peskine449bd832023-01-11 14:50:10 +01009311 return 0;
Valerio Settia08b1a42022-11-17 15:10:02 +01009312}
Valerio Settia08b1a42022-11-17 15:10:02 +01009313#endif //MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED && MBEDTLS_USE_PSA_CRYPTO
9314
Jerry Yuee40f9d2022-02-17 14:55:16 +08009315#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01009316int mbedtls_ssl_get_key_exchange_md_tls1_2(mbedtls_ssl_context *ssl,
9317 unsigned char *hash, size_t *hashlen,
9318 unsigned char *data, size_t data_len,
9319 mbedtls_md_type_t md_alg)
Jerry Yuee40f9d2022-02-17 14:55:16 +08009320{
9321 psa_status_t status;
9322 psa_hash_operation_t hash_operation = PSA_HASH_OPERATION_INIT;
Manuel Pégourié-Gonnard2d6d9932023-03-28 11:38:08 +02009323 psa_algorithm_t hash_alg = mbedtls_md_psa_alg_from_type(md_alg);
Jerry Yuee40f9d2022-02-17 14:55:16 +08009324
Gilles Peskine449bd832023-01-11 14:50:10 +01009325 MBEDTLS_SSL_DEBUG_MSG(3, ("Perform PSA-based computation of digest of ServerKeyExchange"));
Jerry Yuee40f9d2022-02-17 14:55:16 +08009326
Gilles Peskine449bd832023-01-11 14:50:10 +01009327 if ((status = psa_hash_setup(&hash_operation,
9328 hash_alg)) != PSA_SUCCESS) {
9329 MBEDTLS_SSL_DEBUG_RET(1, "psa_hash_setup", status);
Jerry Yuee40f9d2022-02-17 14:55:16 +08009330 goto exit;
9331 }
9332
Gilles Peskine449bd832023-01-11 14:50:10 +01009333 if ((status = psa_hash_update(&hash_operation, ssl->handshake->randbytes,
9334 64)) != PSA_SUCCESS) {
9335 MBEDTLS_SSL_DEBUG_RET(1, "psa_hash_update", status);
Jerry Yuee40f9d2022-02-17 14:55:16 +08009336 goto exit;
9337 }
9338
Gilles Peskine449bd832023-01-11 14:50:10 +01009339 if ((status = psa_hash_update(&hash_operation,
9340 data, data_len)) != PSA_SUCCESS) {
9341 MBEDTLS_SSL_DEBUG_RET(1, "psa_hash_update", status);
Jerry Yuee40f9d2022-02-17 14:55:16 +08009342 goto exit;
9343 }
9344
Gilles Peskine449bd832023-01-11 14:50:10 +01009345 if ((status = psa_hash_finish(&hash_operation, hash, PSA_HASH_MAX_SIZE,
9346 hashlen)) != PSA_SUCCESS) {
9347 MBEDTLS_SSL_DEBUG_RET(1, "psa_hash_finish", status);
9348 goto exit;
Jerry Yuee40f9d2022-02-17 14:55:16 +08009349 }
9350
9351exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01009352 if (status != PSA_SUCCESS) {
9353 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
9354 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR);
9355 switch (status) {
Jerry Yuee40f9d2022-02-17 14:55:16 +08009356 case PSA_ERROR_NOT_SUPPORTED:
Gilles Peskine449bd832023-01-11 14:50:10 +01009357 return MBEDTLS_ERR_MD_FEATURE_UNAVAILABLE;
Jerry Yuee40f9d2022-02-17 14:55:16 +08009358 case PSA_ERROR_BAD_STATE: /* Intentional fallthrough */
9359 case PSA_ERROR_BUFFER_TOO_SMALL:
Gilles Peskine449bd832023-01-11 14:50:10 +01009360 return MBEDTLS_ERR_MD_BAD_INPUT_DATA;
Jerry Yuee40f9d2022-02-17 14:55:16 +08009361 case PSA_ERROR_INSUFFICIENT_MEMORY:
Gilles Peskine449bd832023-01-11 14:50:10 +01009362 return MBEDTLS_ERR_MD_ALLOC_FAILED;
Jerry Yuee40f9d2022-02-17 14:55:16 +08009363 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01009364 return MBEDTLS_ERR_PLATFORM_HW_ACCEL_FAILED;
Jerry Yuee40f9d2022-02-17 14:55:16 +08009365 }
9366 }
Gilles Peskine449bd832023-01-11 14:50:10 +01009367 return 0;
Jerry Yuee40f9d2022-02-17 14:55:16 +08009368}
9369
9370#else
9371
Gilles Peskine449bd832023-01-11 14:50:10 +01009372int mbedtls_ssl_get_key_exchange_md_tls1_2(mbedtls_ssl_context *ssl,
9373 unsigned char *hash, size_t *hashlen,
9374 unsigned char *data, size_t data_len,
9375 mbedtls_md_type_t md_alg)
Jerry Yuee40f9d2022-02-17 14:55:16 +08009376{
9377 int ret = 0;
9378 mbedtls_md_context_t ctx;
Gilles Peskine449bd832023-01-11 14:50:10 +01009379 const mbedtls_md_info_t *md_info = mbedtls_md_info_from_type(md_alg);
9380 *hashlen = mbedtls_md_get_size(md_info);
Jerry Yuee40f9d2022-02-17 14:55:16 +08009381
Gilles Peskine449bd832023-01-11 14:50:10 +01009382 MBEDTLS_SSL_DEBUG_MSG(3, ("Perform mbedtls-based computation of digest of ServerKeyExchange"));
Jerry Yuee40f9d2022-02-17 14:55:16 +08009383
Gilles Peskine449bd832023-01-11 14:50:10 +01009384 mbedtls_md_init(&ctx);
Jerry Yuee40f9d2022-02-17 14:55:16 +08009385
9386 /*
9387 * digitally-signed struct {
9388 * opaque client_random[32];
9389 * opaque server_random[32];
9390 * ServerDHParams params;
9391 * };
9392 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009393 if ((ret = mbedtls_md_setup(&ctx, md_info, 0)) != 0) {
9394 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_setup", ret);
Jerry Yuee40f9d2022-02-17 14:55:16 +08009395 goto exit;
9396 }
Gilles Peskine449bd832023-01-11 14:50:10 +01009397 if ((ret = mbedtls_md_starts(&ctx)) != 0) {
9398 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_starts", ret);
Jerry Yuee40f9d2022-02-17 14:55:16 +08009399 goto exit;
9400 }
Gilles Peskine449bd832023-01-11 14:50:10 +01009401 if ((ret = mbedtls_md_update(&ctx, ssl->handshake->randbytes, 64)) != 0) {
9402 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_update", ret);
Jerry Yuee40f9d2022-02-17 14:55:16 +08009403 goto exit;
9404 }
Gilles Peskine449bd832023-01-11 14:50:10 +01009405 if ((ret = mbedtls_md_update(&ctx, data, data_len)) != 0) {
9406 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_update", ret);
Jerry Yuee40f9d2022-02-17 14:55:16 +08009407 goto exit;
9408 }
Gilles Peskine449bd832023-01-11 14:50:10 +01009409 if ((ret = mbedtls_md_finish(&ctx, hash)) != 0) {
9410 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_finish", ret);
Jerry Yuee40f9d2022-02-17 14:55:16 +08009411 goto exit;
9412 }
9413
9414exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01009415 mbedtls_md_free(&ctx);
Jerry Yuee40f9d2022-02-17 14:55:16 +08009416
Gilles Peskine449bd832023-01-11 14:50:10 +01009417 if (ret != 0) {
9418 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
9419 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR);
9420 }
Jerry Yuee40f9d2022-02-17 14:55:16 +08009421
Gilles Peskine449bd832023-01-11 14:50:10 +01009422 return ret;
Jerry Yuee40f9d2022-02-17 14:55:16 +08009423}
9424#endif /* MBEDTLS_USE_PSA_CRYPTO */
9425
Jerry Yud9d91da2022-02-17 14:57:06 +08009426#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
9427
Gabor Mezeia3d016c2022-05-10 12:44:09 +02009428/* Find the preferred hash for a given signature algorithm. */
9429unsigned int mbedtls_ssl_tls12_get_preferred_hash_for_sig_alg(
Gilles Peskine449bd832023-01-11 14:50:10 +01009430 mbedtls_ssl_context *ssl,
9431 unsigned int sig_alg)
Jerry Yud9d91da2022-02-17 14:57:06 +08009432{
Gabor Mezei078e8032022-04-27 21:17:56 +02009433 unsigned int i;
Gabor Mezeia3d016c2022-05-10 12:44:09 +02009434 uint16_t *received_sig_algs = ssl->handshake->received_sig_algs;
Gabor Mezei078e8032022-04-27 21:17:56 +02009435
Gilles Peskine449bd832023-01-11 14:50:10 +01009436 if (sig_alg == MBEDTLS_SSL_SIG_ANON) {
9437 return MBEDTLS_SSL_HASH_NONE;
9438 }
Gabor Mezei078e8032022-04-27 21:17:56 +02009439
Gilles Peskine449bd832023-01-11 14:50:10 +01009440 for (i = 0; received_sig_algs[i] != MBEDTLS_TLS_SIG_NONE; i++) {
Neil Armstrong9f1176a2022-06-24 18:19:19 +02009441 unsigned int hash_alg_received =
Gilles Peskine449bd832023-01-11 14:50:10 +01009442 MBEDTLS_SSL_TLS12_HASH_ALG_FROM_SIG_AND_HASH_ALG(
9443 received_sig_algs[i]);
Neil Armstrong9f1176a2022-06-24 18:19:19 +02009444 unsigned int sig_alg_received =
Gilles Peskine449bd832023-01-11 14:50:10 +01009445 MBEDTLS_SSL_TLS12_SIG_ALG_FROM_SIG_AND_HASH_ALG(
9446 received_sig_algs[i]);
Neil Armstrong9f1176a2022-06-24 18:19:19 +02009447
Manuel Pégourié-Gonnard47bb3802023-06-05 12:40:32 +02009448 mbedtls_md_type_t md_alg =
9449 mbedtls_ssl_md_alg_from_hash((unsigned char) hash_alg_received);
9450 if (md_alg == MBEDTLS_MD_NONE) {
9451 continue;
9452 }
9453
Gilles Peskine449bd832023-01-11 14:50:10 +01009454 if (sig_alg == sig_alg_received) {
Neil Armstrong9f1176a2022-06-24 18:19:19 +02009455#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01009456 if (ssl->handshake->key_cert && ssl->handshake->key_cert->key) {
Neil Armstrong96eceb82022-06-30 18:05:05 +02009457 psa_algorithm_t psa_hash_alg =
Manuel Pégourié-Gonnard47bb3802023-06-05 12:40:32 +02009458 mbedtls_md_psa_alg_from_type(md_alg);
Neil Armstrong9f1176a2022-06-24 18:19:19 +02009459
Gilles Peskine449bd832023-01-11 14:50:10 +01009460 if (sig_alg_received == MBEDTLS_SSL_SIG_ECDSA &&
9461 !mbedtls_pk_can_do_ext(ssl->handshake->key_cert->key,
9462 PSA_ALG_ECDSA(psa_hash_alg),
9463 PSA_KEY_USAGE_SIGN_HASH)) {
Neil Armstrong9f1176a2022-06-24 18:19:19 +02009464 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01009465 }
Neil Armstrong9f1176a2022-06-24 18:19:19 +02009466
Gilles Peskine449bd832023-01-11 14:50:10 +01009467 if (sig_alg_received == MBEDTLS_SSL_SIG_RSA &&
9468 !mbedtls_pk_can_do_ext(ssl->handshake->key_cert->key,
9469 PSA_ALG_RSA_PKCS1V15_SIGN(
9470 psa_hash_alg),
9471 PSA_KEY_USAGE_SIGN_HASH)) {
Neil Armstrong9f1176a2022-06-24 18:19:19 +02009472 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01009473 }
Neil Armstrong9f1176a2022-06-24 18:19:19 +02009474 }
Neil Armstrong9f1176a2022-06-24 18:19:19 +02009475#endif /* MBEDTLS_USE_PSA_CRYPTO */
Neil Armstrong96eceb82022-06-30 18:05:05 +02009476
Gilles Peskine449bd832023-01-11 14:50:10 +01009477 return hash_alg_received;
Neil Armstrong9f1176a2022-06-24 18:19:19 +02009478 }
Jerry Yud9d91da2022-02-17 14:57:06 +08009479 }
Jerry Yud9d91da2022-02-17 14:57:06 +08009480
Gilles Peskine449bd832023-01-11 14:50:10 +01009481 return MBEDTLS_SSL_HASH_NONE;
Jerry Yud9d91da2022-02-17 14:57:06 +08009482}
9483
9484#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
9485
Jerry Yudc7bd172022-02-17 13:44:15 +08009486#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
9487
XiaokangQian75d40ef2022-04-20 11:05:24 +00009488int mbedtls_ssl_validate_ciphersuite(
9489 const mbedtls_ssl_context *ssl,
9490 const mbedtls_ssl_ciphersuite_t *suite_info,
9491 mbedtls_ssl_protocol_version min_tls_version,
Gilles Peskine449bd832023-01-11 14:50:10 +01009492 mbedtls_ssl_protocol_version max_tls_version)
XiaokangQian75d40ef2022-04-20 11:05:24 +00009493{
9494 (void) ssl;
9495
Gilles Peskine449bd832023-01-11 14:50:10 +01009496 if (suite_info == NULL) {
9497 return -1;
9498 }
XiaokangQian75d40ef2022-04-20 11:05:24 +00009499
Gilles Peskine449bd832023-01-11 14:50:10 +01009500 if ((suite_info->min_tls_version > max_tls_version) ||
9501 (suite_info->max_tls_version < min_tls_version)) {
9502 return -1;
XiaokangQian75d40ef2022-04-20 11:05:24 +00009503 }
9504
XiaokangQian060d8672022-04-21 09:24:56 +00009505#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_CLI_C)
XiaokangQian75d40ef2022-04-20 11:05:24 +00009506#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Neil Armstrongca7d5062022-05-31 14:43:23 +02009507#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01009508 if (suite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_ECJPAKE &&
9509 ssl->handshake->psa_pake_ctx_is_ok != 1)
Neil Armstrongca7d5062022-05-31 14:43:23 +02009510#else
Gilles Peskine449bd832023-01-11 14:50:10 +01009511 if (suite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_ECJPAKE &&
9512 mbedtls_ecjpake_check(&ssl->handshake->ecjpake_ctx) != 0)
Neil Armstrongca7d5062022-05-31 14:43:23 +02009513#endif /* MBEDTLS_USE_PSA_CRYPTO */
XiaokangQian75d40ef2022-04-20 11:05:24 +00009514 {
Gilles Peskine449bd832023-01-11 14:50:10 +01009515 return -1;
XiaokangQian75d40ef2022-04-20 11:05:24 +00009516 }
9517#endif
9518
9519 /* Don't suggest PSK-based ciphersuite if no PSK is available. */
9520#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01009521 if (mbedtls_ssl_ciphersuite_uses_psk(suite_info) &&
9522 mbedtls_ssl_conf_has_static_psk(ssl->conf) == 0) {
9523 return -1;
XiaokangQian75d40ef2022-04-20 11:05:24 +00009524 }
9525#endif /* MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
9526#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
9527
Gilles Peskine449bd832023-01-11 14:50:10 +01009528 return 0;
XiaokangQian75d40ef2022-04-20 11:05:24 +00009529}
9530
Ronald Crone68ab4f2022-10-05 12:46:29 +02009531#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
XiaokangQianeaf36512022-04-24 09:07:44 +00009532/*
9533 * Function for writing a signature algorithm extension.
9534 *
9535 * The `extension_data` field of signature algorithm contains a `SignatureSchemeList`
9536 * value (TLS 1.3 RFC8446):
9537 * enum {
9538 * ....
9539 * ecdsa_secp256r1_sha256( 0x0403 ),
9540 * ecdsa_secp384r1_sha384( 0x0503 ),
9541 * ecdsa_secp521r1_sha512( 0x0603 ),
9542 * ....
9543 * } SignatureScheme;
9544 *
9545 * struct {
9546 * SignatureScheme supported_signature_algorithms<2..2^16-2>;
9547 * } SignatureSchemeList;
9548 *
9549 * The `extension_data` field of signature algorithm contains a `SignatureAndHashAlgorithm`
9550 * value (TLS 1.2 RFC5246):
9551 * enum {
9552 * none(0), md5(1), sha1(2), sha224(3), sha256(4), sha384(5),
9553 * sha512(6), (255)
9554 * } HashAlgorithm;
9555 *
9556 * enum { anonymous(0), rsa(1), dsa(2), ecdsa(3), (255) }
9557 * SignatureAlgorithm;
9558 *
9559 * struct {
9560 * HashAlgorithm hash;
9561 * SignatureAlgorithm signature;
9562 * } SignatureAndHashAlgorithm;
9563 *
9564 * SignatureAndHashAlgorithm
9565 * supported_signature_algorithms<2..2^16-2>;
9566 *
9567 * The TLS 1.3 signature algorithm extension was defined to be a compatible
9568 * generalization of the TLS 1.2 signature algorithm extension.
9569 * `SignatureAndHashAlgorithm` field of TLS 1.2 can be represented by
9570 * `SignatureScheme` field of TLS 1.3
9571 *
9572 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009573int mbedtls_ssl_write_sig_alg_ext(mbedtls_ssl_context *ssl, unsigned char *buf,
9574 const unsigned char *end, size_t *out_len)
XiaokangQianeaf36512022-04-24 09:07:44 +00009575{
9576 unsigned char *p = buf;
9577 unsigned char *supported_sig_alg; /* Start of supported_signature_algorithms */
9578 size_t supported_sig_alg_len = 0; /* Length of supported_signature_algorithms */
9579
9580 *out_len = 0;
9581
Gilles Peskine449bd832023-01-11 14:50:10 +01009582 MBEDTLS_SSL_DEBUG_MSG(3, ("adding signature_algorithms extension"));
XiaokangQianeaf36512022-04-24 09:07:44 +00009583
9584 /* Check if we have space for header and length field:
9585 * - extension_type (2 bytes)
9586 * - extension_data_length (2 bytes)
9587 * - supported_signature_algorithms_length (2 bytes)
9588 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009589 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 6);
XiaokangQianeaf36512022-04-24 09:07:44 +00009590 p += 6;
9591
9592 /*
9593 * Write supported_signature_algorithms
9594 */
9595 supported_sig_alg = p;
Gilles Peskine449bd832023-01-11 14:50:10 +01009596 const uint16_t *sig_alg = mbedtls_ssl_get_sig_algs(ssl);
9597 if (sig_alg == NULL) {
9598 return MBEDTLS_ERR_SSL_BAD_CONFIG;
9599 }
XiaokangQianeaf36512022-04-24 09:07:44 +00009600
Gilles Peskine449bd832023-01-11 14:50:10 +01009601 for (; *sig_alg != MBEDTLS_TLS1_3_SIG_NONE; sig_alg++) {
9602 MBEDTLS_SSL_DEBUG_MSG(3, ("got signature scheme [%x] %s",
9603 *sig_alg,
9604 mbedtls_ssl_sig_alg_to_str(*sig_alg)));
9605 if (!mbedtls_ssl_sig_alg_is_supported(ssl, *sig_alg)) {
XiaokangQianeaf36512022-04-24 09:07:44 +00009606 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01009607 }
9608 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 2);
9609 MBEDTLS_PUT_UINT16_BE(*sig_alg, p, 0);
XiaokangQianeaf36512022-04-24 09:07:44 +00009610 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01009611 MBEDTLS_SSL_DEBUG_MSG(3, ("sent signature scheme [%x] %s",
9612 *sig_alg,
9613 mbedtls_ssl_sig_alg_to_str(*sig_alg)));
XiaokangQianeaf36512022-04-24 09:07:44 +00009614 }
9615
9616 /* Length of supported_signature_algorithms */
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00009617 supported_sig_alg_len = (size_t) (p - supported_sig_alg);
Gilles Peskine449bd832023-01-11 14:50:10 +01009618 if (supported_sig_alg_len == 0) {
9619 MBEDTLS_SSL_DEBUG_MSG(1, ("No signature algorithms defined."));
9620 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
XiaokangQianeaf36512022-04-24 09:07:44 +00009621 }
9622
Gilles Peskine449bd832023-01-11 14:50:10 +01009623 MBEDTLS_PUT_UINT16_BE(MBEDTLS_TLS_EXT_SIG_ALG, buf, 0);
9624 MBEDTLS_PUT_UINT16_BE(supported_sig_alg_len + 2, buf, 2);
9625 MBEDTLS_PUT_UINT16_BE(supported_sig_alg_len, buf, 4);
XiaokangQianeaf36512022-04-24 09:07:44 +00009626
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00009627 *out_len = (size_t) (p - buf);
XiaokangQianeaf36512022-04-24 09:07:44 +00009628
9629#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01009630 mbedtls_ssl_tls13_set_hs_sent_ext_mask(ssl, MBEDTLS_TLS_EXT_SIG_ALG);
XiaokangQianeaf36512022-04-24 09:07:44 +00009631#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yu0c354a22022-08-29 15:25:36 +08009632
Gilles Peskine449bd832023-01-11 14:50:10 +01009633 return 0;
XiaokangQianeaf36512022-04-24 09:07:44 +00009634}
Ronald Crone68ab4f2022-10-05 12:46:29 +02009635#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
XiaokangQianeaf36512022-04-24 09:07:44 +00009636
XiaokangQian40a35232022-05-07 09:02:40 +00009637#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
XiaokangQian9b2b7712022-05-17 02:57:00 +00009638/*
9639 * mbedtls_ssl_parse_server_name_ext
9640 *
9641 * Structure of server_name extension:
9642 *
9643 * enum {
9644 * host_name(0), (255)
9645 * } NameType;
9646 * opaque HostName<1..2^16-1>;
9647 *
9648 * struct {
9649 * NameType name_type;
9650 * select (name_type) {
9651 * case host_name: HostName;
9652 * } name;
9653 * } ServerName;
9654 * struct {
9655 * ServerName server_name_list<1..2^16-1>
9656 * } ServerNameList;
9657 */
Ronald Cronce7d76e2022-07-08 18:56:49 +02009658MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01009659int mbedtls_ssl_parse_server_name_ext(mbedtls_ssl_context *ssl,
9660 const unsigned char *buf,
9661 const unsigned char *end)
XiaokangQian40a35232022-05-07 09:02:40 +00009662{
9663 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
9664 const unsigned char *p = buf;
XiaokangQian9b2b7712022-05-17 02:57:00 +00009665 size_t server_name_list_len, hostname_len;
9666 const unsigned char *server_name_list_end;
XiaokangQian40a35232022-05-07 09:02:40 +00009667
Gilles Peskine449bd832023-01-11 14:50:10 +01009668 MBEDTLS_SSL_DEBUG_MSG(3, ("parse ServerName extension"));
XiaokangQian40a35232022-05-07 09:02:40 +00009669
Gilles Peskine449bd832023-01-11 14:50:10 +01009670 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
9671 server_name_list_len = MBEDTLS_GET_UINT16_BE(p, 0);
XiaokangQian40a35232022-05-07 09:02:40 +00009672 p += 2;
9673
Gilles Peskine449bd832023-01-11 14:50:10 +01009674 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, server_name_list_len);
XiaokangQian9b2b7712022-05-17 02:57:00 +00009675 server_name_list_end = p + server_name_list_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01009676 while (p < server_name_list_end) {
9677 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, server_name_list_end, 3);
9678 hostname_len = MBEDTLS_GET_UINT16_BE(p, 1);
9679 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, server_name_list_end,
9680 hostname_len + 3);
XiaokangQian40a35232022-05-07 09:02:40 +00009681
Gilles Peskine449bd832023-01-11 14:50:10 +01009682 if (p[0] == MBEDTLS_TLS_EXT_SERVERNAME_HOSTNAME) {
XiaokangQian75fe8c72022-06-15 09:42:45 +00009683 /* sni_name is intended to be used only during the parsing of the
9684 * ClientHello message (it is reset to NULL before the end of
9685 * the message parsing). Thus it is ok to just point to the
9686 * reception buffer and not make a copy of it.
9687 */
XiaokangQianf2a94202022-05-20 06:44:24 +00009688 ssl->handshake->sni_name = p + 3;
9689 ssl->handshake->sni_name_len = hostname_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01009690 if (ssl->conf->f_sni == NULL) {
9691 return 0;
XiaokangQian40a35232022-05-07 09:02:40 +00009692 }
Gilles Peskine449bd832023-01-11 14:50:10 +01009693 ret = ssl->conf->f_sni(ssl->conf->p_sni,
9694 ssl, p + 3, hostname_len);
9695 if (ret != 0) {
9696 MBEDTLS_SSL_DEBUG_RET(1, "ssl_sni_wrapper", ret);
9697 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_UNRECOGNIZED_NAME,
9698 MBEDTLS_ERR_SSL_UNRECOGNIZED_NAME);
9699 return MBEDTLS_ERR_SSL_UNRECOGNIZED_NAME;
9700 }
9701 return 0;
XiaokangQian40a35232022-05-07 09:02:40 +00009702 }
9703
9704 p += hostname_len + 3;
9705 }
9706
Gilles Peskine449bd832023-01-11 14:50:10 +01009707 return 0;
XiaokangQian40a35232022-05-07 09:02:40 +00009708}
9709#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
9710
XiaokangQianacb39922022-06-17 10:18:48 +00009711#if defined(MBEDTLS_SSL_ALPN)
Ronald Cronce7d76e2022-07-08 18:56:49 +02009712MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01009713int mbedtls_ssl_parse_alpn_ext(mbedtls_ssl_context *ssl,
9714 const unsigned char *buf,
9715 const unsigned char *end)
XiaokangQianacb39922022-06-17 10:18:48 +00009716{
9717 const unsigned char *p = buf;
XiaokangQianc7403452022-06-23 03:24:12 +00009718 size_t protocol_name_list_len;
XiaokangQian95d5f542022-06-24 02:29:26 +00009719 const unsigned char *protocol_name_list;
9720 const unsigned char *protocol_name_list_end;
XiaokangQianc7403452022-06-23 03:24:12 +00009721 size_t protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00009722
9723 /* If ALPN not configured, just ignore the extension */
Gilles Peskine449bd832023-01-11 14:50:10 +01009724 if (ssl->conf->alpn_list == NULL) {
9725 return 0;
9726 }
XiaokangQianacb39922022-06-17 10:18:48 +00009727
9728 /*
XiaokangQianc7403452022-06-23 03:24:12 +00009729 * RFC7301, section 3.1
9730 * opaque ProtocolName<1..2^8-1>;
XiaokangQianacb39922022-06-17 10:18:48 +00009731 *
XiaokangQianc7403452022-06-23 03:24:12 +00009732 * struct {
9733 * ProtocolName protocol_name_list<2..2^16-1>
9734 * } ProtocolNameList;
XiaokangQianacb39922022-06-17 10:18:48 +00009735 */
9736
XiaokangQianc7403452022-06-23 03:24:12 +00009737 /*
XiaokangQian0b776e22022-06-24 09:04:59 +00009738 * protocol_name_list_len 2 bytes
9739 * protocol_name_len 1 bytes
9740 * protocol_name >=1 byte
XiaokangQianc7403452022-06-23 03:24:12 +00009741 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009742 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 4);
XiaokangQianacb39922022-06-17 10:18:48 +00009743
Gilles Peskine449bd832023-01-11 14:50:10 +01009744 protocol_name_list_len = MBEDTLS_GET_UINT16_BE(p, 0);
XiaokangQianacb39922022-06-17 10:18:48 +00009745 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01009746 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, protocol_name_list_len);
XiaokangQian95d5f542022-06-24 02:29:26 +00009747 protocol_name_list = p;
9748 protocol_name_list_end = p + protocol_name_list_len;
XiaokangQianacb39922022-06-17 10:18:48 +00009749
9750 /* Validate peer's list (lengths) */
Gilles Peskine449bd832023-01-11 14:50:10 +01009751 while (p < protocol_name_list_end) {
XiaokangQian95d5f542022-06-24 02:29:26 +00009752 protocol_name_len = *p++;
Gilles Peskine449bd832023-01-11 14:50:10 +01009753 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, protocol_name_list_end,
9754 protocol_name_len);
9755 if (protocol_name_len == 0) {
XiaokangQian95d5f542022-06-24 02:29:26 +00009756 MBEDTLS_SSL_PEND_FATAL_ALERT(
9757 MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
Gilles Peskine449bd832023-01-11 14:50:10 +01009758 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
9759 return MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
XiaokangQian95d5f542022-06-24 02:29:26 +00009760 }
9761
9762 p += protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00009763 }
9764
9765 /* Use our order of preference */
Gilles Peskine449bd832023-01-11 14:50:10 +01009766 for (const char **alpn = ssl->conf->alpn_list; *alpn != NULL; alpn++) {
9767 size_t const alpn_len = strlen(*alpn);
XiaokangQian95d5f542022-06-24 02:29:26 +00009768 p = protocol_name_list;
Gilles Peskine449bd832023-01-11 14:50:10 +01009769 while (p < protocol_name_list_end) {
XiaokangQian95d5f542022-06-24 02:29:26 +00009770 protocol_name_len = *p++;
Gilles Peskine449bd832023-01-11 14:50:10 +01009771 if (protocol_name_len == alpn_len &&
9772 memcmp(p, *alpn, alpn_len) == 0) {
XiaokangQianacb39922022-06-17 10:18:48 +00009773 ssl->alpn_chosen = *alpn;
Gilles Peskine449bd832023-01-11 14:50:10 +01009774 return 0;
XiaokangQianacb39922022-06-17 10:18:48 +00009775 }
XiaokangQian95d5f542022-06-24 02:29:26 +00009776
9777 p += protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00009778 }
9779 }
9780
XiaokangQian95d5f542022-06-24 02:29:26 +00009781 /* If we get here, no match was found */
XiaokangQianacb39922022-06-17 10:18:48 +00009782 MBEDTLS_SSL_PEND_FATAL_ALERT(
Gilles Peskine449bd832023-01-11 14:50:10 +01009783 MBEDTLS_SSL_ALERT_MSG_NO_APPLICATION_PROTOCOL,
9784 MBEDTLS_ERR_SSL_NO_APPLICATION_PROTOCOL);
9785 return MBEDTLS_ERR_SSL_NO_APPLICATION_PROTOCOL;
XiaokangQianacb39922022-06-17 10:18:48 +00009786}
9787
Gilles Peskine449bd832023-01-11 14:50:10 +01009788int mbedtls_ssl_write_alpn_ext(mbedtls_ssl_context *ssl,
9789 unsigned char *buf,
9790 unsigned char *end,
9791 size_t *out_len)
XiaokangQianacb39922022-06-17 10:18:48 +00009792{
9793 unsigned char *p = buf;
XiaokangQian95d5f542022-06-24 02:29:26 +00009794 size_t protocol_name_len;
XiaokangQianc7403452022-06-23 03:24:12 +00009795 *out_len = 0;
XiaokangQianacb39922022-06-17 10:18:48 +00009796
Gilles Peskine449bd832023-01-11 14:50:10 +01009797 if (ssl->alpn_chosen == NULL) {
9798 return 0;
XiaokangQianacb39922022-06-17 10:18:48 +00009799 }
9800
Gilles Peskine449bd832023-01-11 14:50:10 +01009801 protocol_name_len = strlen(ssl->alpn_chosen);
9802 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 7 + protocol_name_len);
XiaokangQianacb39922022-06-17 10:18:48 +00009803
Gilles Peskine449bd832023-01-11 14:50:10 +01009804 MBEDTLS_SSL_DEBUG_MSG(3, ("server side, adding alpn extension"));
XiaokangQianacb39922022-06-17 10:18:48 +00009805 /*
9806 * 0 . 1 ext identifier
9807 * 2 . 3 ext length
9808 * 4 . 5 protocol list length
9809 * 6 . 6 protocol name length
9810 * 7 . 7+n protocol name
9811 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009812 MBEDTLS_PUT_UINT16_BE(MBEDTLS_TLS_EXT_ALPN, p, 0);
XiaokangQianacb39922022-06-17 10:18:48 +00009813
XiaokangQian95d5f542022-06-24 02:29:26 +00009814 *out_len = 7 + protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00009815
Gilles Peskine449bd832023-01-11 14:50:10 +01009816 MBEDTLS_PUT_UINT16_BE(protocol_name_len + 3, p, 2);
9817 MBEDTLS_PUT_UINT16_BE(protocol_name_len + 1, p, 4);
XiaokangQian0b776e22022-06-24 09:04:59 +00009818 /* Note: the length of the chosen protocol has been checked to be less
9819 * than 255 bytes in `mbedtls_ssl_conf_alpn_protocols`.
9820 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009821 p[6] = MBEDTLS_BYTE_0(protocol_name_len);
XiaokangQianacb39922022-06-17 10:18:48 +00009822
Gilles Peskine449bd832023-01-11 14:50:10 +01009823 memcpy(p + 7, ssl->alpn_chosen, protocol_name_len);
Jerry Yub95dd362022-11-08 21:19:34 +08009824
9825#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01009826 mbedtls_ssl_tls13_set_hs_sent_ext_mask(ssl, MBEDTLS_TLS_EXT_ALPN);
Jerry Yub95dd362022-11-08 21:19:34 +08009827#endif
9828
Gilles Peskine449bd832023-01-11 14:50:10 +01009829 return 0;
XiaokangQianacb39922022-06-17 10:18:48 +00009830}
9831#endif /* MBEDTLS_SSL_ALPN */
9832
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009833#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && \
Xiaokang Qian03409292022-10-12 02:49:52 +00009834 defined(MBEDTLS_SSL_SESSION_TICKETS) && \
Xiaokang Qianed0620c2022-10-12 06:58:13 +00009835 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION) && \
Xiaokang Qianed3afcd2022-10-12 08:31:11 +00009836 defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01009837int mbedtls_ssl_session_set_hostname(mbedtls_ssl_session *session,
9838 const char *hostname)
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009839{
9840 /* Initialize to suppress unnecessary compiler warning */
9841 size_t hostname_len = 0;
9842
9843 /* Check if new hostname is valid before
9844 * making any change to current one */
Gilles Peskine449bd832023-01-11 14:50:10 +01009845 if (hostname != NULL) {
9846 hostname_len = strlen(hostname);
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009847
Gilles Peskine449bd832023-01-11 14:50:10 +01009848 if (hostname_len > MBEDTLS_SSL_MAX_HOST_NAME_LEN) {
9849 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9850 }
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009851 }
9852
9853 /* Now it's clear that we will overwrite the old hostname,
9854 * so we can free it safely */
Gilles Peskine449bd832023-01-11 14:50:10 +01009855 if (session->hostname != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01009856 mbedtls_zeroize_and_free(session->hostname,
Gilles Peskine449bd832023-01-11 14:50:10 +01009857 strlen(session->hostname));
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009858 }
9859
9860 /* Passing NULL as hostname shall clear the old one */
Gilles Peskine449bd832023-01-11 14:50:10 +01009861 if (hostname == NULL) {
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009862 session->hostname = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01009863 } else {
9864 session->hostname = mbedtls_calloc(1, hostname_len + 1);
9865 if (session->hostname == NULL) {
9866 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
9867 }
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009868
Gilles Peskine449bd832023-01-11 14:50:10 +01009869 memcpy(session->hostname, hostname, hostname_len);
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009870 }
9871
Gilles Peskine449bd832023-01-11 14:50:10 +01009872 return 0;
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009873}
Xiaokang Qian03409292022-10-12 02:49:52 +00009874#endif /* MBEDTLS_SSL_PROTO_TLS1_3 &&
9875 MBEDTLS_SSL_SESSION_TICKETS &&
Xiaokang Qianed0620c2022-10-12 06:58:13 +00009876 MBEDTLS_SSL_SERVER_NAME_INDICATION &&
Xiaokang Qianed3afcd2022-10-12 08:31:11 +00009877 MBEDTLS_SSL_CLI_C */
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009878
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00009879#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_EARLY_DATA) && \
9880 defined(MBEDTLS_SSL_ALPN)
Waleed Elmelegy7dfba342024-03-12 16:22:39 +00009881int mbedtls_ssl_session_set_ticket_alpn(mbedtls_ssl_session *session,
9882 const char *alpn)
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00009883{
9884 size_t alpn_len = 0;
9885
9886 if (alpn != NULL) {
9887 alpn_len = strlen(alpn);
9888
9889 if (alpn_len > MBEDTLS_SSL_MAX_ALPN_NAME_LEN) {
9890 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9891 }
9892 }
9893
9894 if (session->ticket_alpn != NULL) {
9895 mbedtls_zeroize_and_free(session->ticket_alpn,
9896 strlen(session->ticket_alpn));
Waleed Elmelegy7dfba342024-03-12 16:22:39 +00009897 session->ticket_alpn = NULL;
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00009898 }
9899
Waleed Elmelegy7dfba342024-03-12 16:22:39 +00009900 if (alpn != NULL) {
9901 session->ticket_alpn = mbedtls_calloc(alpn_len + 1, 1);
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00009902 if (session->ticket_alpn == NULL) {
9903 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
9904 }
Waleed Elmelegy7dfba342024-03-12 16:22:39 +00009905 memcpy(session->ticket_alpn, alpn, alpn_len);
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00009906 }
9907
9908 return 0;
9909}
9910#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_EARLY_DATA && MBEDTLS_SSL_ALPN */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02009911#endif /* MBEDTLS_SSL_TLS_C */