blob: 1e257e20998f3566d771c3f63112a3cf30d26412 [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 Elmelegydaa4da72024-03-13 16:25:34 +00003756 const size_t alpn_len = (session->ticket_alpn == NULL) ?
3757 0 : strlen(session->ticket_alpn) + 1;
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)
Waleed Elmelegydaa4da72024-03-13 16:25:34 +00003784 needed += 2 /* alpn_len */
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003785 + 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)
Waleed Elmelegydaa4da72024-03-13 16:25:34 +00003840 MBEDTLS_PUT_UINT16_BE(alpn_len, p, 0);
3841 p += 2;
3842
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003843 if (alpn_len > 0) {
3844 /* save chosen alpn */
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00003845 memcpy(p, session->ticket_alpn, alpn_len);
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003846 p += alpn_len;
3847 }
3848#endif /* MBEDTLS_SSL_EARLY_DATA && MBEDTLS_SSL_ALPN */
3849 }
3850#endif /* MBEDTLS_SSL_SRV_C */
3851
David Horstmanne59f9702024-02-29 16:08:57 +00003852#if defined(MBEDTLS_SSL_CLI_C)
3853 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
3854#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
3855 MBEDTLS_PUT_UINT16_BE(hostname_len, p, 0);
3856 p += 2;
3857 if (hostname_len > 0) {
3858 /* save host name */
3859 memcpy(p, session->hostname, hostname_len);
3860 p += hostname_len;
3861 }
3862#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
3863
3864#if defined(MBEDTLS_HAVE_TIME)
3865 MBEDTLS_PUT_UINT64_BE((uint64_t) session->ticket_reception_time, p, 0);
3866 p += 8;
3867#endif
3868 MBEDTLS_PUT_UINT32_BE(session->ticket_lifetime, p, 0);
3869 p += 4;
3870
3871 MBEDTLS_PUT_UINT16_BE(session->ticket_len, p, 0);
3872 p += 2;
3873
3874 if (session->ticket != NULL && session->ticket_len > 0) {
3875 memcpy(p, session->ticket, session->ticket_len);
3876 p += session->ticket_len;
3877 }
3878 }
3879#endif /* MBEDTLS_SSL_CLI_C */
3880 return 0;
3881}
3882
3883MBEDTLS_CHECK_RETURN_CRITICAL
3884static int ssl_tls13_session_load(mbedtls_ssl_session *session,
3885 const unsigned char *buf,
3886 size_t len)
3887{
3888 const unsigned char *p = buf;
3889 const unsigned char *end = buf + len;
3890
3891 if (end - p < 6) {
3892 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3893 }
3894 session->ticket_age_add = MBEDTLS_GET_UINT32_BE(p, 0);
3895 session->ticket_flags = p[4];
3896
3897 /* load resumption_key */
3898 session->resumption_key_len = p[5];
3899 p += 6;
3900
3901 if (end - p < session->resumption_key_len) {
3902 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3903 }
3904
3905 if (sizeof(session->resumption_key) < session->resumption_key_len) {
3906 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3907 }
3908 memcpy(session->resumption_key, p, session->resumption_key_len);
3909 p += session->resumption_key_len;
3910
3911#if defined(MBEDTLS_SSL_EARLY_DATA)
3912 if (end - p < 4) {
3913 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3914 }
3915 session->max_early_data_size = MBEDTLS_GET_UINT32_BE(p, 0);
3916 p += 4;
3917#endif
3918#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
3919 if (end - p < 2) {
3920 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3921 }
3922 session->record_size_limit = MBEDTLS_GET_UINT16_BE(p, 0);
3923 p += 2;
3924#endif /* MBEDTLS_SSL_RECORD_SIZE_LIMIT */
3925
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003926#if defined(MBEDTLS_SSL_SRV_C)
David Horstmanne59f9702024-02-29 16:08:57 +00003927 if (session->endpoint == MBEDTLS_SSL_IS_SERVER) {
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003928#if defined(MBEDTLS_HAVE_TIME)
David Horstmanne59f9702024-02-29 16:08:57 +00003929 if (end - p < 8) {
3930 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3931 }
3932 session->ticket_creation_time = MBEDTLS_GET_UINT64_BE(p, 0);
3933 p += 8;
David Horstmanne59f9702024-02-29 16:08:57 +00003934#endif /* MBEDTLS_HAVE_TIME */
3935
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003936#if defined(MBEDTLS_SSL_EARLY_DATA) && defined(MBEDTLS_SSL_ALPN)
Waleed Elmelegydaa4da72024-03-13 16:25:34 +00003937 size_t alpn_len;
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003938
Waleed Elmelegydaa4da72024-03-13 16:25:34 +00003939 if (end - p < 2) {
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003940 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3941 }
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00003942
Waleed Elmelegydaa4da72024-03-13 16:25:34 +00003943 alpn_len = MBEDTLS_GET_UINT16_BE(p, 0);
3944 p += 2;
3945
3946 if (end - p < (long int) alpn_len) {
Waleed Elmelegy7dfba342024-03-12 16:22:39 +00003947 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3948 }
3949
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003950 if (alpn_len > 0) {
Waleed Elmelegydaa4da72024-03-13 16:25:34 +00003951 int ret = mbedtls_ssl_session_set_ticket_alpn(session, (char *) p);
3952 if (ret != 0) {
3953 return ret;
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003954 }
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003955 p += alpn_len;
3956 }
3957#endif /* MBEDTLS_SSL_EARLY_DATA && MBEDTLS_SSL_ALPN */
3958 }
3959#endif /* MBEDTLS_SSL_SRV_C */
3960
David Horstmanne59f9702024-02-29 16:08:57 +00003961#if defined(MBEDTLS_SSL_CLI_C)
3962 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
3963#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
3964 size_t hostname_len;
3965 /* load host name */
3966 if (end - p < 2) {
3967 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3968 }
3969 hostname_len = MBEDTLS_GET_UINT16_BE(p, 0);
3970 p += 2;
3971
3972 if (end - p < (long int) hostname_len) {
3973 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3974 }
3975 if (hostname_len > 0) {
3976 session->hostname = mbedtls_calloc(1, hostname_len);
3977 if (session->hostname == NULL) {
3978 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
3979 }
3980 memcpy(session->hostname, p, hostname_len);
3981 p += hostname_len;
3982 }
3983#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
3984
3985#if defined(MBEDTLS_HAVE_TIME)
3986 if (end - p < 8) {
3987 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3988 }
3989 session->ticket_reception_time = MBEDTLS_GET_UINT64_BE(p, 0);
3990 p += 8;
3991#endif
3992 if (end - p < 4) {
3993 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3994 }
3995 session->ticket_lifetime = MBEDTLS_GET_UINT32_BE(p, 0);
3996 p += 4;
3997
3998 if (end - p < 2) {
3999 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4000 }
4001 session->ticket_len = MBEDTLS_GET_UINT16_BE(p, 0);
4002 p += 2;
4003
4004 if (end - p < (long int) session->ticket_len) {
4005 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4006 }
4007 if (session->ticket_len > 0) {
4008 session->ticket = mbedtls_calloc(1, session->ticket_len);
4009 if (session->ticket == NULL) {
4010 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
4011 }
4012 memcpy(session->ticket, p, session->ticket_len);
4013 p += session->ticket_len;
4014 }
4015 }
4016#endif /* MBEDTLS_SSL_CLI_C */
4017
4018 return 0;
4019
4020}
4021#else /* MBEDTLS_SSL_SESSION_TICKETS */
4022MBEDTLS_CHECK_RETURN_CRITICAL
4023static int ssl_tls13_session_save(const mbedtls_ssl_session *session,
4024 unsigned char *buf,
4025 size_t buf_len,
4026 size_t *olen)
4027{
4028 ((void) session);
4029 ((void) buf);
4030 ((void) buf_len);
4031 *olen = 0;
4032 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
4033}
4034
4035static int ssl_tls13_session_load(const mbedtls_ssl_session *session,
4036 unsigned char *buf,
4037 size_t buf_len)
4038{
4039 ((void) session);
4040 ((void) buf);
4041 ((void) buf_len);
4042 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
4043}
4044#endif /* !MBEDTLS_SSL_SESSION_TICKETS */
4045#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
4046
Paul Bakker5121ce52009-01-03 21:22:43 +00004047/*
Hanno Beckera835da52019-05-16 12:39:07 +01004048 * Define ticket header determining Mbed TLS version
4049 * and structure of the ticket.
4050 */
4051
Hanno Becker94ef3b32019-05-16 12:50:45 +01004052/*
Hanno Becker50b59662019-05-28 14:30:45 +01004053 * Define bitflag determining compile-time settings influencing
4054 * structure of serialized SSL sessions.
Hanno Becker94ef3b32019-05-16 12:50:45 +01004055 */
4056
Hanno Becker50b59662019-05-28 14:30:45 +01004057#if defined(MBEDTLS_HAVE_TIME)
Hanno Becker3e088662019-05-29 11:10:18 +01004058#define SSL_SERIALIZED_SESSION_CONFIG_TIME 1
Hanno Becker50b59662019-05-28 14:30:45 +01004059#else
Hanno Becker3e088662019-05-29 11:10:18 +01004060#define SSL_SERIALIZED_SESSION_CONFIG_TIME 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01004061#endif /* MBEDTLS_HAVE_TIME */
4062
4063#if defined(MBEDTLS_X509_CRT_PARSE_C)
Hanno Becker3e088662019-05-29 11:10:18 +01004064#define SSL_SERIALIZED_SESSION_CONFIG_CRT 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01004065#else
Hanno Becker3e088662019-05-29 11:10:18 +01004066#define SSL_SERIALIZED_SESSION_CONFIG_CRT 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01004067#endif /* MBEDTLS_X509_CRT_PARSE_C */
4068
David Horstmann5c5a32f2024-02-13 17:53:35 +00004069#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
David Horstmannf686f1d2024-03-01 11:20:32 +00004070#define SSL_SERIALIZED_SESSION_CONFIG_KEEP_PEER_CRT 1
David Horstmann5c5a32f2024-02-13 17:53:35 +00004071#else
David Horstmannf686f1d2024-03-01 11:20:32 +00004072#define SSL_SERIALIZED_SESSION_CONFIG_KEEP_PEER_CRT 0
David Horstmann5c5a32f2024-02-13 17:53:35 +00004073#endif /* MBEDTLS_SSL_SESSION_TICKETS */
4074
Hanno Becker94ef3b32019-05-16 12:50:45 +01004075#if defined(MBEDTLS_SSL_CLI_C) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Hanno Becker3e088662019-05-29 11:10:18 +01004076#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01004077#else
Hanno Becker3e088662019-05-29 11:10:18 +01004078#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01004079#endif /* MBEDTLS_SSL_CLI_C && MBEDTLS_SSL_SESSION_TICKETS */
4080
4081#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Hanno Becker3e088662019-05-29 11:10:18 +01004082#define SSL_SERIALIZED_SESSION_CONFIG_MFL 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01004083#else
Hanno Becker3e088662019-05-29 11:10:18 +01004084#define SSL_SERIALIZED_SESSION_CONFIG_MFL 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01004085#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
4086
Hanno Becker94ef3b32019-05-16 12:50:45 +01004087#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Hanno Becker3e088662019-05-29 11:10:18 +01004088#define SSL_SERIALIZED_SESSION_CONFIG_ETM 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01004089#else
Hanno Becker3e088662019-05-29 11:10:18 +01004090#define SSL_SERIALIZED_SESSION_CONFIG_ETM 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01004091#endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC */
4092
Hanno Becker94ef3b32019-05-16 12:50:45 +01004093#if defined(MBEDTLS_SSL_SESSION_TICKETS)
4094#define SSL_SERIALIZED_SESSION_CONFIG_TICKET 1
4095#else
4096#define SSL_SERIALIZED_SESSION_CONFIG_TICKET 0
4097#endif /* MBEDTLS_SSL_SESSION_TICKETS */
4098
David Horstmann92b258b2024-02-13 17:23:34 +00004099#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
4100#define SSL_SERIALIZED_SESSION_CONFIG_SNI 1
4101#else
4102#define SSL_SERIALIZED_SESSION_CONFIG_SNI 0
4103#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
4104
4105#if defined(MBEDTLS_SSL_EARLY_DATA)
4106#define SSL_SERIALIZED_SESSION_CONFIG_EARLY_DATA 1
4107#else
4108#define SSL_SERIALIZED_SESSION_CONFIG_EARLY_DATA 0
4109#endif /* MBEDTLS_SSL_EARLY_DATA */
4110
4111#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
4112#define SSL_SERIALIZED_SESSION_CONFIG_RECORD_SIZE 1
4113#else
4114#define SSL_SERIALIZED_SESSION_CONFIG_RECORD_SIZE 0
4115#endif /* MBEDTLS_SSL_RECORD_SIZE_LIMIT */
4116
Waleed Elmelegy7dfba342024-03-12 16:22:39 +00004117#if defined(MBEDTLS_SSL_ALPN) && defined(MBEDTLS_SSL_SRV_C) && \
4118 defined(MBEDTLS_SSL_EARLY_DATA)
Waleed Elmelegy11025632024-03-07 15:25:52 +00004119#define SSL_SERIALIZED_SESSION_CONFIG_ALPN 1
4120#else
4121#define SSL_SERIALIZED_SESSION_CONFIG_ALPN 0
4122#endif /* MBEDTLS_SSL_ALPN */
4123
Hanno Becker3e088662019-05-29 11:10:18 +01004124#define SSL_SERIALIZED_SESSION_CONFIG_TIME_BIT 0
4125#define SSL_SERIALIZED_SESSION_CONFIG_CRT_BIT 1
4126#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET_BIT 2
4127#define SSL_SERIALIZED_SESSION_CONFIG_MFL_BIT 3
Hanno Becker37bdbe62021-08-01 05:38:58 +01004128#define SSL_SERIALIZED_SESSION_CONFIG_ETM_BIT 4
4129#define SSL_SERIALIZED_SESSION_CONFIG_TICKET_BIT 5
David Horstmannf686f1d2024-03-01 11:20:32 +00004130#define SSL_SERIALIZED_SESSION_CONFIG_KEEP_PEER_CRT_BIT 6
David Horstmann92b258b2024-02-13 17:23:34 +00004131#define SSL_SERIALIZED_SESSION_CONFIG_SNI_BIT 7
4132#define SSL_SERIALIZED_SESSION_CONFIG_EARLY_DATA_BIT 8
4133#define SSL_SERIALIZED_SESSION_CONFIG_RECORD_SIZE_BIT 9
Waleed Elmelegy11025632024-03-07 15:25:52 +00004134#define SSL_SERIALIZED_SESSION_CONFIG_ALPN_BIT 10
Hanno Becker3e088662019-05-29 11:10:18 +01004135
Hanno Becker50b59662019-05-28 14:30:45 +01004136#define SSL_SERIALIZED_SESSION_CONFIG_BITFLAG \
Gilles Peskine449bd832023-01-11 14:50:10 +01004137 ((uint16_t) ( \
4138 (SSL_SERIALIZED_SESSION_CONFIG_TIME << SSL_SERIALIZED_SESSION_CONFIG_TIME_BIT) | \
4139 (SSL_SERIALIZED_SESSION_CONFIG_CRT << SSL_SERIALIZED_SESSION_CONFIG_CRT_BIT) | \
4140 (SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET << \
4141 SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET_BIT) | \
4142 (SSL_SERIALIZED_SESSION_CONFIG_MFL << SSL_SERIALIZED_SESSION_CONFIG_MFL_BIT) | \
4143 (SSL_SERIALIZED_SESSION_CONFIG_ETM << SSL_SERIALIZED_SESSION_CONFIG_ETM_BIT) | \
David Horstmann5c5a32f2024-02-13 17:53:35 +00004144 (SSL_SERIALIZED_SESSION_CONFIG_TICKET << SSL_SERIALIZED_SESSION_CONFIG_TICKET_BIT) | \
David Horstmann71fa1a92024-03-01 12:32:18 +00004145 (SSL_SERIALIZED_SESSION_CONFIG_KEEP_PEER_CRT << \
4146 SSL_SERIALIZED_SESSION_CONFIG_KEEP_PEER_CRT_BIT) | \
David Horstmann92b258b2024-02-13 17:23:34 +00004147 (SSL_SERIALIZED_SESSION_CONFIG_SNI << SSL_SERIALIZED_SESSION_CONFIG_SNI_BIT) | \
4148 (SSL_SERIALIZED_SESSION_CONFIG_EARLY_DATA << \
4149 SSL_SERIALIZED_SESSION_CONFIG_EARLY_DATA_BIT) | \
4150 (SSL_SERIALIZED_SESSION_CONFIG_RECORD_SIZE << \
Waleed Elmelegy11025632024-03-07 15:25:52 +00004151 SSL_SERIALIZED_SESSION_CONFIG_RECORD_SIZE_BIT) | \
Waleed Elmelegy75e33fa2024-03-07 16:57:58 +00004152 (SSL_SERIALIZED_SESSION_CONFIG_ALPN << \
Waleed Elmelegy11025632024-03-07 15:25:52 +00004153 SSL_SERIALIZED_SESSION_CONFIG_ALPN_BIT)))
Hanno Becker94ef3b32019-05-16 12:50:45 +01004154
Chien Wong4e9683e2023-12-28 17:07:43 +08004155static const unsigned char ssl_serialized_session_header[] = {
Hanno Becker94ef3b32019-05-16 12:50:45 +01004156 MBEDTLS_VERSION_MAJOR,
4157 MBEDTLS_VERSION_MINOR,
4158 MBEDTLS_VERSION_PATCH,
Gilles Peskine449bd832023-01-11 14:50:10 +01004159 MBEDTLS_BYTE_1(SSL_SERIALIZED_SESSION_CONFIG_BITFLAG),
4160 MBEDTLS_BYTE_0(SSL_SERIALIZED_SESSION_CONFIG_BITFLAG),
Hanno Beckerf8787072019-05-16 12:41:07 +01004161};
Hanno Beckera835da52019-05-16 12:39:07 +01004162
4163/*
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004164 * Serialize a session in the following format:
Manuel Pégourié-Gonnard35eb8022019-05-16 11:11:08 +02004165 * (in the presentation language of TLS, RFC 8446 section 3)
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004166 *
David Horstmanncb01b362024-02-29 17:31:46 +00004167 * TLS 1.2 session:
4168 *
4169 * struct {
4170 * #if defined(MBEDTLS_SSL_SESSION_TICKETS)
4171 * opaque ticket<0..2^24-1>; // length 0 means no ticket
4172 * uint32 ticket_lifetime;
4173 * #endif
4174 * } ClientOnlyData;
4175 *
4176 * struct {
4177 * #if defined(MBEDTLS_HAVE_TIME)
4178 * uint64 start_time;
4179 * #endif
4180 * uint8 session_id_len; // at most 32
4181 * opaque session_id[32];
4182 * opaque master[48]; // fixed length in the standard
4183 * uint32 verify_result;
4184 * #if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
4185 * opaque peer_cert<0..2^24-1>; // length 0 means no peer cert
4186 * #else
David Horstmann76ba26a2024-03-01 12:03:35 +00004187 * uint8 peer_cert_digest_type;
David Horstmanncb01b362024-02-29 17:31:46 +00004188 * opaque peer_cert_digest<0..2^8-1>
4189 * #endif
4190 * select (endpoint) {
4191 * case client: ClientOnlyData;
4192 * case server: uint64 ticket_creation_time;
4193 * };
4194 * #if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
4195 * uint8 mfl_code; // up to 255 according to standard
4196 * #endif
4197 * #if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
4198 * uint8 encrypt_then_mac; // 0 or 1
4199 * #endif
4200 * } serialized_session_tls12;
4201 *
4202 *
4203 * TLS 1.3 Session:
4204 *
4205 * struct {
4206 * #if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
4207 * opaque hostname<0..2^16-1>;
4208 * #endif
4209 * #if defined(MBEDTLS_HAVE_TIME)
4210 * uint64 ticket_reception_time;
4211 * #endif
4212 * uint32 ticket_lifetime;
4213 * opaque ticket<1..2^16-1>;
4214 * } ClientOnlyData;
4215 *
4216 * struct {
4217 * uint32 ticket_age_add;
4218 * uint8 ticket_flags;
4219 * opaque resumption_key<0..255>;
4220 * #if defined(MBEDTLS_SSL_EARLY_DATA)
4221 * uint32 max_early_data_size;
4222 * #endif
4223 * #if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
4224 * uint16 record_size_limit;
4225 * #endif
4226 * select ( endpoint ) {
4227 * case client: ClientOnlyData;
Waleed Elmelegy7dfba342024-03-12 16:22:39 +00004228 * case server:
David Horstmanncb01b362024-02-29 17:31:46 +00004229 * #if defined(MBEDTLS_HAVE_TIME)
Waleed Elmelegy7dfba342024-03-12 16:22:39 +00004230 * uint64 ticket_creation_time;
David Horstmanncb01b362024-02-29 17:31:46 +00004231 * #endif
Waleed Elmelegyfe9ae082024-03-07 15:47:31 +00004232 * #if defined(MBEDTLS_SSL_EARLY_DATA) && defined(MBEDTLS_SSL_ALPN)
Waleed Elmelegydaa4da72024-03-13 16:25:34 +00004233 * opaque ticket_alpn<0..256>;
Waleed Elmelegyfe9ae082024-03-07 15:47:31 +00004234 * #endif
David Horstmanncb01b362024-02-29 17:31:46 +00004235 * };
4236 * } serialized_session_tls13;
4237 *
4238 *
4239 * SSL session:
4240 *
4241 * struct {
Hanno Beckerdc28b6c2019-05-29 11:08:00 +01004242 *
Hanno Beckerdce50972021-08-01 05:39:23 +01004243 * opaque mbedtls_version[3]; // library version: major, minor, patch
4244 * opaque session_format[2]; // library-version specific 16-bit field
4245 * // determining the format of the remaining
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004246 * // serialized data.
Hanno Beckerdc28b6c2019-05-29 11:08:00 +01004247 *
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004248 * Note: When updating the format, remember to keep
4249 * these version+format bytes.
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004250 *
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004251 * // In this version, `session_format` determines
4252 * // the setting of those compile-time
4253 * // configuration options which influence
4254 * // the structure of mbedtls_ssl_session.
4255 *
Glenn Straussda7851c2022-03-14 13:29:48 -04004256 * uint8_t minor_ver; // Protocol minor version. Possible values:
Jerry Yu0c2a7382022-12-06 13:27:25 +08004257 * // - TLS 1.2 (0x0303)
4258 * // - TLS 1.3 (0x0304)
David Horstmann531aca22024-02-29 18:14:28 +00004259 * uint8_t endpoint;
4260 * uint16_t ciphersuite;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004261 *
Glenn Straussda7851c2022-03-14 13:29:48 -04004262 * select (serialized_session.tls_version) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004263 *
Glenn Straussda7851c2022-03-14 13:29:48 -04004264 * case MBEDTLS_SSL_VERSION_TLS1_2:
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004265 * serialized_session_tls12 data;
Jerry Yu0c2a7382022-12-06 13:27:25 +08004266 * case MBEDTLS_SSL_VERSION_TLS1_3:
Jerry Yuddda0502022-12-01 19:43:12 +08004267 * serialized_session_tls13 data;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004268 *
4269 * };
4270 *
4271 * } serialized_session;
4272 *
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004273 */
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004274
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004275MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004276static int ssl_session_save(const mbedtls_ssl_session *session,
4277 unsigned char omit_header,
4278 unsigned char *buf,
4279 size_t buf_len,
4280 size_t *olen)
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004281{
4282 unsigned char *p = buf;
4283 size_t used = 0;
Jerry Yu251a12e2022-07-13 15:15:48 +08004284 size_t remaining_len;
Jerry Yue36fdd62022-08-17 21:31:36 +08004285#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
4286 size_t out_len;
4287 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
4288#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01004289 if (session == NULL) {
4290 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
4291 }
Jerry Yu438ddd82022-07-07 06:55:50 +00004292
Gilles Peskine449bd832023-01-11 14:50:10 +01004293 if (!omit_header) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004294 /*
4295 * Add Mbed TLS version identifier
4296 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004297 used += sizeof(ssl_serialized_session_header);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004298
Gilles Peskine449bd832023-01-11 14:50:10 +01004299 if (used <= buf_len) {
4300 memcpy(p, ssl_serialized_session_header,
4301 sizeof(ssl_serialized_session_header));
4302 p += sizeof(ssl_serialized_session_header);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004303 }
4304 }
4305
4306 /*
Ronald Cron40a4ab02024-01-15 10:21:30 +01004307 * TLS version identifier, endpoint, ciphersuite
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004308 */
Ronald Cron40a4ab02024-01-15 10:21:30 +01004309 used += 1 /* TLS version */
4310 + 1 /* endpoint */
4311 + 2; /* ciphersuite */
Gilles Peskine449bd832023-01-11 14:50:10 +01004312 if (used <= buf_len) {
4313 *p++ = MBEDTLS_BYTE_0(session->tls_version);
Ronald Cron40a4ab02024-01-15 10:21:30 +01004314 *p++ = session->endpoint;
4315 MBEDTLS_PUT_UINT16_BE(session->ciphersuite, p, 0);
4316 p += 2;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004317 }
4318
4319 /* Forward to version-specific serialization routine. */
Jerry Yufca4d572022-07-21 10:37:48 +08004320 remaining_len = (buf_len >= used) ? buf_len - used : 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01004321 switch (session->tls_version) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004322#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01004323 case MBEDTLS_SSL_VERSION_TLS1_2:
4324 used += ssl_tls12_session_save(session, p, remaining_len);
4325 break;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004326#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
4327
Jerry Yu251a12e2022-07-13 15:15:48 +08004328#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004329 case MBEDTLS_SSL_VERSION_TLS1_3:
4330 ret = ssl_tls13_session_save(session, p, remaining_len, &out_len);
4331 if (ret != 0 && ret != MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL) {
4332 return ret;
4333 }
4334 used += out_len;
4335 break;
Jerry Yu251a12e2022-07-13 15:15:48 +08004336#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
4337
Gilles Peskine449bd832023-01-11 14:50:10 +01004338 default:
4339 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004340 }
4341
4342 *olen = used;
Gilles Peskine449bd832023-01-11 14:50:10 +01004343 if (used > buf_len) {
4344 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
4345 }
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004346
Gilles Peskine449bd832023-01-11 14:50:10 +01004347 return 0;
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004348}
4349
4350/*
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02004351 * Public wrapper for ssl_session_save()
4352 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004353int mbedtls_ssl_session_save(const mbedtls_ssl_session *session,
4354 unsigned char *buf,
4355 size_t buf_len,
4356 size_t *olen)
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02004357{
Gilles Peskine449bd832023-01-11 14:50:10 +01004358 return ssl_session_save(session, 0, buf, buf_len, olen);
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02004359}
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004360
Jerry Yuf1b23ca2022-02-18 11:48:47 +08004361/*
4362 * Deserialize session, see mbedtls_ssl_session_save() for format.
4363 *
4364 * This internal version is wrapped by a public function that cleans up in
4365 * case of error, and has an extra option omit_header.
4366 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004367MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004368static int ssl_session_load(mbedtls_ssl_session *session,
4369 unsigned char omit_header,
4370 const unsigned char *buf,
4371 size_t len)
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004372{
4373 const unsigned char *p = buf;
4374 const unsigned char * const end = buf + len;
Jerry Yu438ddd82022-07-07 06:55:50 +00004375 size_t remaining_len;
4376
4377
Gilles Peskine449bd832023-01-11 14:50:10 +01004378 if (session == NULL) {
4379 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
4380 }
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004381
Gilles Peskine449bd832023-01-11 14:50:10 +01004382 if (!omit_header) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004383 /*
4384 * Check Mbed TLS version identifier
4385 */
4386
Gilles Peskine449bd832023-01-11 14:50:10 +01004387 if ((size_t) (end - p) < sizeof(ssl_serialized_session_header)) {
4388 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004389 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004390
4391 if (memcmp(p, ssl_serialized_session_header,
4392 sizeof(ssl_serialized_session_header)) != 0) {
4393 return MBEDTLS_ERR_SSL_VERSION_MISMATCH;
4394 }
4395 p += sizeof(ssl_serialized_session_header);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004396 }
4397
4398 /*
Ronald Cron40a4ab02024-01-15 10:21:30 +01004399 * TLS version identifier, endpoint, ciphersuite
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004400 */
Ronald Cron40a4ab02024-01-15 10:21:30 +01004401 if (4 > (size_t) (end - p)) {
Gilles Peskine449bd832023-01-11 14:50:10 +01004402 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4403 }
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01004404 session->tls_version = (mbedtls_ssl_protocol_version) (0x0300 | *p++);
Ronald Cron40a4ab02024-01-15 10:21:30 +01004405 session->endpoint = *p++;
4406 session->ciphersuite = MBEDTLS_GET_UINT16_BE(p, 0);
4407 p += 2;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004408
4409 /* Dispatch according to TLS version. */
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00004410 remaining_len = (size_t) (end - p);
Gilles Peskine449bd832023-01-11 14:50:10 +01004411 switch (session->tls_version) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004412#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01004413 case MBEDTLS_SSL_VERSION_TLS1_2:
4414 return ssl_tls12_session_load(session, p, remaining_len);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004415#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
4416
Jerry Yu438ddd82022-07-07 06:55:50 +00004417#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004418 case MBEDTLS_SSL_VERSION_TLS1_3:
4419 return ssl_tls13_session_load(session, p, remaining_len);
Jerry Yu438ddd82022-07-07 06:55:50 +00004420#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
4421
Gilles Peskine449bd832023-01-11 14:50:10 +01004422 default:
4423 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004424 }
4425}
4426
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004427/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02004428 * Deserialize session: public wrapper for error cleaning
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02004429 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004430int mbedtls_ssl_session_load(mbedtls_ssl_session *session,
4431 const unsigned char *buf,
4432 size_t len)
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02004433{
Gilles Peskine449bd832023-01-11 14:50:10 +01004434 int ret = ssl_session_load(session, 0, buf, len);
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02004435
Gilles Peskine449bd832023-01-11 14:50:10 +01004436 if (ret != 0) {
4437 mbedtls_ssl_session_free(session);
4438 }
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02004439
Gilles Peskine449bd832023-01-11 14:50:10 +01004440 return ret;
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02004441}
4442
4443/*
Paul Bakker1961b702013-01-25 14:49:24 +01004444 * Perform a single step of the SSL handshake
Paul Bakker5121ce52009-01-03 21:22:43 +00004445 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004446MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004447static int ssl_prepare_handshake_step(mbedtls_ssl_context *ssl)
Hanno Becker41934dd2021-08-07 19:13:43 +01004448{
4449 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
4450
Ronald Cron66dbf912022-02-02 15:33:46 +01004451 /*
4452 * We may have not been able to send to the peer all the handshake data
Ronald Cron3f20b772022-03-08 16:00:02 +01004453 * that were written into the output buffer by the previous handshake step,
4454 * if the write to the network callback returned with the
Ronald Cron66dbf912022-02-02 15:33:46 +01004455 * #MBEDTLS_ERR_SSL_WANT_WRITE error code.
4456 * We proceed to the next handshake step only when all data from the
4457 * previous one have been sent to the peer, thus we make sure that this is
4458 * the case here by calling `mbedtls_ssl_flush_output()`. The function may
4459 * return with the #MBEDTLS_ERR_SSL_WANT_WRITE error code in which case
4460 * we have to wait before to go ahead.
4461 * In the case of TLS 1.3, handshake step handlers do not send data to the
4462 * peer. Data are only sent here and through
4463 * `mbedtls_ssl_handle_pending_alert` in case an error that triggered an
Andrzej Kurek5c65c572022-04-13 14:28:52 -04004464 * alert occurred.
Ronald Cron66dbf912022-02-02 15:33:46 +01004465 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004466 if ((ret = mbedtls_ssl_flush_output(ssl)) != 0) {
4467 return ret;
4468 }
Hanno Becker41934dd2021-08-07 19:13:43 +01004469
4470#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004471 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
4472 ssl->handshake->retransmit_state == MBEDTLS_SSL_RETRANS_SENDING) {
4473 if ((ret = mbedtls_ssl_flight_transmit(ssl)) != 0) {
4474 return ret;
4475 }
Hanno Becker41934dd2021-08-07 19:13:43 +01004476 }
4477#endif /* MBEDTLS_SSL_PROTO_DTLS */
4478
Gilles Peskine449bd832023-01-11 14:50:10 +01004479 return ret;
Hanno Becker41934dd2021-08-07 19:13:43 +01004480}
4481
Gilles Peskine449bd832023-01-11 14:50:10 +01004482int mbedtls_ssl_handshake_step(mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00004483{
Hanno Becker41934dd2021-08-07 19:13:43 +01004484 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00004485
Gilles Peskine449bd832023-01-11 14:50:10 +01004486 if (ssl == NULL ||
Hanno Becker41934dd2021-08-07 19:13:43 +01004487 ssl->conf == NULL ||
4488 ssl->handshake == NULL ||
Gilles Peskine449bd832023-01-11 14:50:10 +01004489 ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER) {
4490 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Becker41934dd2021-08-07 19:13:43 +01004491 }
4492
Gilles Peskine449bd832023-01-11 14:50:10 +01004493 ret = ssl_prepare_handshake_step(ssl);
4494 if (ret != 0) {
4495 return ret;
4496 }
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02004497
Gilles Peskine449bd832023-01-11 14:50:10 +01004498 ret = mbedtls_ssl_handle_pending_alert(ssl);
4499 if (ret != 0) {
Jerry Yue7047812021-09-13 19:26:39 +08004500 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01004501 }
Jerry Yue7047812021-09-13 19:26:39 +08004502
Tom Cosgrove2fdc7b32022-09-21 12:33:17 +01004503 /* If ssl->conf->endpoint is not one of MBEDTLS_SSL_IS_CLIENT or
4504 * MBEDTLS_SSL_IS_SERVER, this is the return code we give */
4505 ret = MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4506
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004507#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004508 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
4509 MBEDTLS_SSL_DEBUG_MSG(2, ("client state: %s",
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01004510 mbedtls_ssl_states_str((mbedtls_ssl_states) ssl->state)));
Jerry Yub9930e72021-08-06 17:11:51 +08004511
Gilles Peskine449bd832023-01-11 14:50:10 +01004512 switch (ssl->state) {
Ronald Cron9f0fba32022-02-10 16:45:15 +01004513 case MBEDTLS_SSL_HELLO_REQUEST:
4514 ssl->state = MBEDTLS_SSL_CLIENT_HELLO;
Tom Cosgrove87d9c6c2022-09-22 09:27:56 +01004515 ret = 0;
Ronald Cron9f0fba32022-02-10 16:45:15 +01004516 break;
Jerry Yub9930e72021-08-06 17:11:51 +08004517
Ronald Cron9f0fba32022-02-10 16:45:15 +01004518 case MBEDTLS_SSL_CLIENT_HELLO:
Gilles Peskine449bd832023-01-11 14:50:10 +01004519 ret = mbedtls_ssl_write_client_hello(ssl);
Ronald Cron9f0fba32022-02-10 16:45:15 +01004520 break;
4521
4522 default:
4523#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004524 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
4525 ret = mbedtls_ssl_tls13_handshake_client_step(ssl);
4526 } else {
4527 ret = mbedtls_ssl_handshake_client_step(ssl);
4528 }
Ronald Cron9f0fba32022-02-10 16:45:15 +01004529#elif defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01004530 ret = mbedtls_ssl_handshake_client_step(ssl);
Ronald Cron9f0fba32022-02-10 16:45:15 +01004531#else
Gilles Peskine449bd832023-01-11 14:50:10 +01004532 ret = mbedtls_ssl_tls13_handshake_client_step(ssl);
Ronald Cron9f0fba32022-02-10 16:45:15 +01004533#endif
4534 }
Jerry Yub9930e72021-08-06 17:11:51 +08004535 }
Ronald Cron6291b232023-03-08 15:51:25 +01004536#endif /* MBEDTLS_SSL_CLI_C */
4537
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004538#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004539 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Ronald Cron6291b232023-03-08 15:51:25 +01004540#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
4541 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Gilles Peskine449bd832023-01-11 14:50:10 +01004542 ret = mbedtls_ssl_tls13_handshake_server_step(ssl);
Ronald Cron6291b232023-03-08 15:51:25 +01004543 } else {
Gilles Peskine449bd832023-01-11 14:50:10 +01004544 ret = mbedtls_ssl_handshake_server_step(ssl);
4545 }
Ronald Cron6291b232023-03-08 15:51:25 +01004546#elif defined(MBEDTLS_SSL_PROTO_TLS1_2)
4547 ret = mbedtls_ssl_handshake_server_step(ssl);
4548#else
4549 ret = mbedtls_ssl_tls13_handshake_server_step(ssl);
Paul Bakker5121ce52009-01-03 21:22:43 +00004550#endif
Ronald Cron6291b232023-03-08 15:51:25 +01004551 }
4552#endif /* MBEDTLS_SSL_SRV_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00004553
Gilles Peskine449bd832023-01-11 14:50:10 +01004554 if (ret != 0) {
Jerry Yubbd5a3f2021-09-18 20:50:22 +08004555 /* handshake_step return error. And it is same
4556 * with alert_reason.
4557 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004558 if (ssl->send_alert) {
4559 ret = mbedtls_ssl_handle_pending_alert(ssl);
Jerry Yue7047812021-09-13 19:26:39 +08004560 goto cleanup;
4561 }
4562 }
4563
4564cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +01004565 return ret;
Paul Bakker1961b702013-01-25 14:49:24 +01004566}
4567
4568/*
4569 * Perform the SSL handshake
4570 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004571int mbedtls_ssl_handshake(mbedtls_ssl_context *ssl)
Paul Bakker1961b702013-01-25 14:49:24 +01004572{
4573 int ret = 0;
4574
Hanno Beckera817ea42020-10-20 15:20:23 +01004575 /* Sanity checks */
4576
Gilles Peskine449bd832023-01-11 14:50:10 +01004577 if (ssl == NULL || ssl->conf == NULL) {
4578 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4579 }
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02004580
Hanno Beckera817ea42020-10-20 15:20:23 +01004581#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004582 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
4583 (ssl->f_set_timer == NULL || ssl->f_get_timer == NULL)) {
4584 MBEDTLS_SSL_DEBUG_MSG(1, ("You must use "
4585 "mbedtls_ssl_set_timer_cb() for DTLS"));
4586 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Beckera817ea42020-10-20 15:20:23 +01004587 }
4588#endif /* MBEDTLS_SSL_PROTO_DTLS */
4589
Gilles Peskine449bd832023-01-11 14:50:10 +01004590 MBEDTLS_SSL_DEBUG_MSG(2, ("=> handshake"));
Paul Bakker1961b702013-01-25 14:49:24 +01004591
Hanno Beckera817ea42020-10-20 15:20:23 +01004592 /* Main handshake loop */
Gilles Peskine449bd832023-01-11 14:50:10 +01004593 while (ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER) {
4594 ret = mbedtls_ssl_handshake_step(ssl);
Paul Bakker1961b702013-01-25 14:49:24 +01004595
Gilles Peskine449bd832023-01-11 14:50:10 +01004596 if (ret != 0) {
Paul Bakker1961b702013-01-25 14:49:24 +01004597 break;
Gilles Peskine449bd832023-01-11 14:50:10 +01004598 }
Paul Bakker1961b702013-01-25 14:49:24 +01004599 }
4600
Gilles Peskine449bd832023-01-11 14:50:10 +01004601 MBEDTLS_SSL_DEBUG_MSG(2, ("<= handshake"));
Paul Bakker5121ce52009-01-03 21:22:43 +00004602
Gilles Peskine449bd832023-01-11 14:50:10 +01004603 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00004604}
4605
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004606#if defined(MBEDTLS_SSL_RENEGOTIATION)
4607#if defined(MBEDTLS_SSL_SRV_C)
Paul Bakker5121ce52009-01-03 21:22:43 +00004608/*
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004609 * Write HelloRequest to request renegotiation on server
Paul Bakker48916f92012-09-16 19:57:18 +00004610 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004611MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004612static int ssl_write_hello_request(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004613{
Janos Follath865b3eb2019-12-16 11:46:15 +00004614 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004615
Gilles Peskine449bd832023-01-11 14:50:10 +01004616 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write hello request"));
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004617
4618 ssl->out_msglen = 4;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004619 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
4620 ssl->out_msg[0] = MBEDTLS_SSL_HS_HELLO_REQUEST;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004621
Gilles Peskine449bd832023-01-11 14:50:10 +01004622 if ((ret = mbedtls_ssl_write_handshake_msg(ssl)) != 0) {
4623 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_handshake_msg", ret);
4624 return ret;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004625 }
4626
Gilles Peskine449bd832023-01-11 14:50:10 +01004627 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write hello request"));
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004628
Gilles Peskine449bd832023-01-11 14:50:10 +01004629 return 0;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004630}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004631#endif /* MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004632
4633/*
4634 * Actually renegotiate current connection, triggered by either:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004635 * - any side: calling mbedtls_ssl_renegotiate(),
4636 * - client: receiving a HelloRequest during mbedtls_ssl_read(),
4637 * - server: receiving any handshake message on server during mbedtls_ssl_read() after
Manuel Pégourié-Gonnard55e4ff22014-08-19 11:16:35 +02004638 * the initial handshake is completed.
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004639 * If the handshake doesn't complete due to waiting for I/O, it will continue
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004640 * during the next calls to mbedtls_ssl_renegotiate() or mbedtls_ssl_read() respectively.
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004641 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004642int mbedtls_ssl_start_renegotiation(mbedtls_ssl_context *ssl)
Paul Bakker48916f92012-09-16 19:57:18 +00004643{
Janos Follath865b3eb2019-12-16 11:46:15 +00004644 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker48916f92012-09-16 19:57:18 +00004645
Gilles Peskine449bd832023-01-11 14:50:10 +01004646 MBEDTLS_SSL_DEBUG_MSG(2, ("=> renegotiate"));
Paul Bakker48916f92012-09-16 19:57:18 +00004647
Gilles Peskine449bd832023-01-11 14:50:10 +01004648 if ((ret = ssl_handshake_init(ssl)) != 0) {
4649 return ret;
4650 }
Paul Bakker48916f92012-09-16 19:57:18 +00004651
Manuel Pégourié-Gonnard0557bd52014-08-19 19:18:39 +02004652 /* RFC 6347 4.2.2: "[...] the HelloRequest will have message_seq = 0 and
4653 * the ServerHello will have message_seq = 1" */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004654#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004655 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
4656 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING) {
4657 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02004658 ssl->handshake->out_msg_seq = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004659 } else {
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02004660 ssl->handshake->in_msg_seq = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004661 }
Manuel Pégourié-Gonnard0557bd52014-08-19 19:18:39 +02004662 }
4663#endif
4664
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004665 ssl->state = MBEDTLS_SSL_HELLO_REQUEST;
4666 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS;
Paul Bakker48916f92012-09-16 19:57:18 +00004667
Gilles Peskine449bd832023-01-11 14:50:10 +01004668 if ((ret = mbedtls_ssl_handshake(ssl)) != 0) {
4669 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_handshake", ret);
4670 return ret;
Paul Bakker48916f92012-09-16 19:57:18 +00004671 }
4672
Gilles Peskine449bd832023-01-11 14:50:10 +01004673 MBEDTLS_SSL_DEBUG_MSG(2, ("<= renegotiate"));
Paul Bakker48916f92012-09-16 19:57:18 +00004674
Gilles Peskine449bd832023-01-11 14:50:10 +01004675 return 0;
Paul Bakker48916f92012-09-16 19:57:18 +00004676}
4677
4678/*
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004679 * Renegotiate current connection on client,
4680 * or request renegotiation on server
4681 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004682int mbedtls_ssl_renegotiate(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004683{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004684 int ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004685
Gilles Peskine449bd832023-01-11 14:50:10 +01004686 if (ssl == NULL || ssl->conf == NULL) {
4687 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4688 }
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02004689
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004690#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004691 /* On server, just send the request */
Gilles Peskine449bd832023-01-11 14:50:10 +01004692 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
4693 if (mbedtls_ssl_is_handshake_over(ssl) == 0) {
4694 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4695 }
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004696
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004697 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_PENDING;
Manuel Pégourié-Gonnardf07f4212014-08-15 19:04:47 +02004698
4699 /* Did we already try/start sending HelloRequest? */
Gilles Peskine449bd832023-01-11 14:50:10 +01004700 if (ssl->out_left != 0) {
4701 return mbedtls_ssl_flush_output(ssl);
4702 }
Manuel Pégourié-Gonnardf07f4212014-08-15 19:04:47 +02004703
Gilles Peskine449bd832023-01-11 14:50:10 +01004704 return ssl_write_hello_request(ssl);
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004705 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004706#endif /* MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004707
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004708#if defined(MBEDTLS_SSL_CLI_C)
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004709 /*
4710 * On client, either start the renegotiation process or,
4711 * if already in progress, continue the handshake
4712 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004713 if (ssl->renego_status != MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS) {
4714 if (mbedtls_ssl_is_handshake_over(ssl) == 0) {
4715 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004716 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004717
4718 if ((ret = mbedtls_ssl_start_renegotiation(ssl)) != 0) {
4719 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_start_renegotiation", ret);
4720 return ret;
4721 }
4722 } else {
4723 if ((ret = mbedtls_ssl_handshake(ssl)) != 0) {
4724 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_handshake", ret);
4725 return ret;
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004726 }
4727 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004728#endif /* MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004729
Gilles Peskine449bd832023-01-11 14:50:10 +01004730 return ret;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004731}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004732#endif /* MBEDTLS_SSL_RENEGOTIATION */
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004733
Gilles Peskine449bd832023-01-11 14:50:10 +01004734void mbedtls_ssl_handshake_free(mbedtls_ssl_context *ssl)
Paul Bakker48916f92012-09-16 19:57:18 +00004735{
Gilles Peskine9b562d52018-04-25 20:32:43 +02004736 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
4737
Gilles Peskine449bd832023-01-11 14:50:10 +01004738 if (handshake == NULL) {
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004739 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01004740 }
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004741
Valerio Setti6f0441d2023-07-03 12:11:36 +02004742#if defined(MBEDTLS_PK_HAVE_ECC_KEYS)
Brett Warrene0edc842021-08-17 09:53:13 +01004743#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004744 if (ssl->handshake->group_list_heap_allocated) {
4745 mbedtls_free((void *) handshake->group_list);
4746 }
Brett Warrene0edc842021-08-17 09:53:13 +01004747 handshake->group_list = NULL;
4748#endif /* MBEDTLS_DEPRECATED_REMOVED */
Valerio Setti6f0441d2023-07-03 12:11:36 +02004749#endif /* MBEDTLS_PK_HAVE_ECC_KEYS */
Brett Warrene0edc842021-08-17 09:53:13 +01004750
Ronald Crone68ab4f2022-10-05 12:46:29 +02004751#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yuf017ee42022-01-12 15:49:48 +08004752#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004753 if (ssl->handshake->sig_algs_heap_allocated) {
4754 mbedtls_free((void *) handshake->sig_algs);
4755 }
Jerry Yuf017ee42022-01-12 15:49:48 +08004756 handshake->sig_algs = NULL;
4757#endif /* MBEDTLS_DEPRECATED_REMOVED */
Xiaofei Baic234ecf2022-02-08 09:59:23 +00004758#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004759 if (ssl->handshake->certificate_request_context) {
4760 mbedtls_free((void *) handshake->certificate_request_context);
Xiaofei Baic234ecf2022-02-08 09:59:23 +00004761 }
4762#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Ronald Crone68ab4f2022-10-05 12:46:29 +02004763#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Jerry Yuf017ee42022-01-12 15:49:48 +08004764
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02004765#if defined(MBEDTLS_SSL_ASYNC_PRIVATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01004766 if (ssl->conf->f_async_cancel != NULL && handshake->async_in_progress != 0) {
4767 ssl->conf->f_async_cancel(ssl);
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02004768 handshake->async_in_progress = 0;
4769 }
4770#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
4771
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01004772#if defined(MBEDTLS_MD_CAN_SHA256)
Andrzej Kurekeb342242019-01-29 09:14:33 -05004773#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01004774 psa_hash_abort(&handshake->fin_sha256_psa);
Andrzej Kurekeb342242019-01-29 09:14:33 -05004775#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01004776 mbedtls_md_free(&handshake->fin_sha256);
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02004777#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -05004778#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01004779#if defined(MBEDTLS_MD_CAN_SHA384)
Andrzej Kurekeb342242019-01-29 09:14:33 -05004780#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01004781 psa_hash_abort(&handshake->fin_sha384_psa);
Andrzej Kurekeb342242019-01-29 09:14:33 -05004782#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01004783 mbedtls_md_free(&handshake->fin_sha384);
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02004784#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -05004785#endif
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02004786
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004787#if defined(MBEDTLS_DHM_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004788 mbedtls_dhm_free(&handshake->dhm_ctx);
Paul Bakker48916f92012-09-16 19:57:18 +00004789#endif
Valerio Setti7aeec542023-07-05 18:57:21 +02004790#if !defined(MBEDTLS_USE_PSA_CRYPTO) && \
Valerio Setti6eb00542023-07-07 17:04:24 +02004791 defined(MBEDTLS_KEY_EXCHANGE_SOME_ECDH_OR_ECDHE_1_2_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004792 mbedtls_ecdh_free(&handshake->ecdh_ctx);
Paul Bakker61d113b2013-07-04 11:51:43 +02004793#endif
Valerio Setti02c25b52022-11-15 14:08:42 +01004794
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02004795#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Neil Armstrongca7d5062022-05-31 14:43:23 +02004796#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01004797 psa_pake_abort(&handshake->psa_pake_ctx);
Valerio Settieb3f7882022-12-08 18:42:58 +01004798 /*
4799 * Opaque keys are not stored in the handshake's data and it's the user
4800 * responsibility to destroy them. Clear ones, instead, are created by
4801 * the TLS library and should be destroyed at the same level
4802 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004803 if (!mbedtls_svc_key_id_is_null(handshake->psa_pake_password)) {
4804 psa_destroy_key(handshake->psa_pake_password);
Valerio Settieb3f7882022-12-08 18:42:58 +01004805 }
Neil Armstrongca7d5062022-05-31 14:43:23 +02004806 handshake->psa_pake_password = MBEDTLS_SVC_KEY_ID_INIT;
4807#else
Gilles Peskine449bd832023-01-11 14:50:10 +01004808 mbedtls_ecjpake_free(&handshake->ecjpake_ctx);
Neil Armstrongca7d5062022-05-31 14:43:23 +02004809#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard77c06462015-09-17 13:59:49 +02004810#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004811 mbedtls_free(handshake->ecjpake_cache);
Manuel Pégourié-Gonnard77c06462015-09-17 13:59:49 +02004812 handshake->ecjpake_cache = NULL;
4813 handshake->ecjpake_cache_len = 0;
4814#endif
Manuel Pégourié-Gonnard76cfd3f2015-09-15 12:10:54 +02004815#endif
Paul Bakker61d113b2013-07-04 11:51:43 +02004816
Valerio Setti7aeec542023-07-05 18:57:21 +02004817#if defined(MBEDTLS_KEY_EXCHANGE_SOME_ECDH_OR_ECDHE_ANY_ENABLED) || \
Valerio Setti45d56f32023-07-13 17:23:20 +02004818 defined(MBEDTLS_KEY_EXCHANGE_WITH_ECDSA_ANY_ENABLED) || \
Janos Follath4ae5c292016-02-10 11:27:43 +00004819 defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Paul Bakker9af723c2014-05-01 13:03:14 +02004820 /* explicit void pointer cast for buggy MS compiler */
Gilles Peskine449bd832023-01-11 14:50:10 +01004821 mbedtls_free((void *) handshake->curves_tls_id);
Manuel Pégourié-Gonnardd09453c2013-09-23 19:11:32 +02004822#endif
4823
Ronald Cron73fe8df2022-10-05 14:31:43 +02004824#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED)
Neil Armstrong501c9322022-05-03 09:35:09 +02004825#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01004826 if (!mbedtls_svc_key_id_is_null(ssl->handshake->psk_opaque)) {
Neil Armstrong501c9322022-05-03 09:35:09 +02004827 /* The maintenance of the external PSK key slot is the
4828 * user's responsibility. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004829 if (ssl->handshake->psk_opaque_is_internal) {
4830 psa_destroy_key(ssl->handshake->psk_opaque);
Neil Armstrong501c9322022-05-03 09:35:09 +02004831 ssl->handshake->psk_opaque_is_internal = 0;
4832 }
4833 ssl->handshake->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
4834 }
Neil Armstronge952a302022-05-03 10:22:14 +02004835#else
Gilles Peskine449bd832023-01-11 14:50:10 +01004836 if (handshake->psk != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01004837 mbedtls_zeroize_and_free(handshake->psk, handshake->psk_len);
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01004838 }
Neil Armstronge952a302022-05-03 10:22:14 +02004839#endif /* MBEDTLS_USE_PSA_CRYPTO */
Ronald Cron73fe8df2022-10-05 14:31:43 +02004840#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED */
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01004841
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004842#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
4843 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Manuel Pégourié-Gonnard83724542013-09-24 22:30:56 +02004844 /*
4845 * Free only the linked list wrapper, not the keys themselves
4846 * since the belong to the SNI callback
4847 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004848 ssl_key_cert_free(handshake->sni_key_cert);
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004849#endif /* MBEDTLS_X509_CRT_PARSE_C && MBEDTLS_SSL_SERVER_NAME_INDICATION */
Manuel Pégourié-Gonnard705fcca2013-09-23 20:04:20 +02004850
Gilles Peskineeccd8882020-03-10 12:19:08 +01004851#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004852 mbedtls_x509_crt_restart_free(&handshake->ecrs_ctx);
4853 if (handshake->ecrs_peer_cert != NULL) {
4854 mbedtls_x509_crt_free(handshake->ecrs_peer_cert);
4855 mbedtls_free(handshake->ecrs_peer_cert);
Hanno Becker3dad3112019-02-05 17:19:52 +00004856 }
Manuel Pégourié-Gonnard862cde52017-05-17 11:56:15 +02004857#endif
4858
Hanno Becker75173122019-02-06 16:18:31 +00004859#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
4860 !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01004861 mbedtls_pk_free(&handshake->peer_pubkey);
Hanno Becker75173122019-02-06 16:18:31 +00004862#endif /* MBEDTLS_X509_CRT_PARSE_C && !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
4863
XiaokangQian9b93c0d2022-02-09 06:02:25 +00004864#if defined(MBEDTLS_SSL_CLI_C) && \
Gilles Peskine449bd832023-01-11 14:50:10 +01004865 (defined(MBEDTLS_SSL_PROTO_DTLS) || defined(MBEDTLS_SSL_PROTO_TLS1_3))
4866 mbedtls_free(handshake->cookie);
XiaokangQian9b93c0d2022-02-09 06:02:25 +00004867#endif /* MBEDTLS_SSL_CLI_C &&
4868 ( MBEDTLS_SSL_PROTO_DTLS || MBEDTLS_SSL_PROTO_TLS1_3 ) */
XiaokangQian8499b6c2022-01-27 09:00:11 +00004869
4870#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004871 mbedtls_ssl_flight_free(handshake->flight);
4872 mbedtls_ssl_buffering_free(ssl);
XiaokangQian8499b6c2022-01-27 09:00:11 +00004873#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard74848812014-07-11 02:43:49 +02004874
Valerio Settiea59c432023-07-25 11:14:03 +02004875#if defined(MBEDTLS_KEY_EXCHANGE_SOME_XXDH_PSA_ANY_ENABLED)
Przemek Stekiel7ac93be2023-07-04 10:02:38 +02004876 if (handshake->xxdh_psa_privkey_is_external == 0) {
4877 psa_destroy_key(handshake->xxdh_psa_privkey);
Gilles Peskine449bd832023-01-11 14:50:10 +01004878 }
Valerio Settiea59c432023-07-25 11:14:03 +02004879#endif /* MBEDTLS_KEY_EXCHANGE_SOME_XXDH_PSA_ANY_ENABLED */
Hanno Becker4a63ed42019-01-08 11:39:35 +00004880
Ronald Cron6f135e12021-12-08 16:57:54 +01004881#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004882 mbedtls_ssl_transform_free(handshake->transform_handshake);
4883 mbedtls_free(handshake->transform_handshake);
Jerry Yu3d9b5902022-11-04 14:07:25 +08004884#if defined(MBEDTLS_SSL_EARLY_DATA)
Gilles Peskine449bd832023-01-11 14:50:10 +01004885 mbedtls_ssl_transform_free(handshake->transform_earlydata);
4886 mbedtls_free(handshake->transform_earlydata);
Jerry Yu3d9b5902022-11-04 14:07:25 +08004887#endif
Ronald Cron6f135e12021-12-08 16:57:54 +01004888#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yuba9c7272021-10-30 11:54:10 +08004889
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05004890
4891#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
4892 /* If the buffers are too big - reallocate. Because of the way Mbed TLS
4893 * processes datagrams and the fact that a datagram is allowed to have
4894 * several records in it, it is possible that the I/O buffers are not
4895 * empty at this stage */
Gilles Peskine449bd832023-01-11 14:50:10 +01004896 handle_buffer_resizing(ssl, 1, mbedtls_ssl_get_input_buflen(ssl),
4897 mbedtls_ssl_get_output_buflen(ssl));
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05004898#endif
Hanno Becker3aa186f2021-08-10 09:24:19 +01004899
Jerry Yuba9c7272021-10-30 11:54:10 +08004900 /* mbedtls_platform_zeroize MUST be last one in this function */
Gilles Peskine449bd832023-01-11 14:50:10 +01004901 mbedtls_platform_zeroize(handshake,
4902 sizeof(mbedtls_ssl_handshake_params));
Paul Bakker48916f92012-09-16 19:57:18 +00004903}
4904
Gilles Peskine449bd832023-01-11 14:50:10 +01004905void mbedtls_ssl_session_free(mbedtls_ssl_session *session)
Paul Bakker48916f92012-09-16 19:57:18 +00004906{
Gilles Peskine449bd832023-01-11 14:50:10 +01004907 if (session == NULL) {
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004908 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01004909 }
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004910
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004911#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004912 ssl_clear_peer_cert(session);
Paul Bakkered27a042013-04-18 22:46:23 +02004913#endif
Paul Bakker0a597072012-09-25 21:55:46 +00004914
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02004915#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
Xiaokang Qianbc663a02022-10-09 11:14:39 +00004916#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && \
4917 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01004918 mbedtls_free(session->hostname);
Xiaokang Qian281fd1b2022-09-20 11:35:41 +00004919#endif
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00004920 mbedtls_free(session->ticket);
4921#endif
4922
Waleed Elmelegy2824a202024-02-23 17:51:47 +00004923#if defined(MBEDTLS_SSL_EARLY_DATA) && defined(MBEDTLS_SSL_ALPN) && \
4924 defined(MBEDTLS_SSL_SRV_C)
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00004925 mbedtls_free(session->ticket_alpn);
Paul Bakkera503a632013-08-14 13:48:06 +02004926#endif
Manuel Pégourié-Gonnard75d44012013-08-02 14:44:04 +02004927
Gilles Peskine449bd832023-01-11 14:50:10 +01004928 mbedtls_platform_zeroize(session, sizeof(mbedtls_ssl_session));
Paul Bakker48916f92012-09-16 19:57:18 +00004929}
4930
Manuel Pégourié-Gonnard5c0e3772019-07-23 16:13:17 +02004931#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004932
4933#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
4934#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID 1u
4935#else
4936#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID 0u
4937#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
4938
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004939#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT 1u
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004940
4941#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
4942#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY 1u
4943#else
4944#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY 0u
4945#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
4946
4947#if defined(MBEDTLS_SSL_ALPN)
4948#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN 1u
4949#else
4950#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN 0u
4951#endif /* MBEDTLS_SSL_ALPN */
4952
4953#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID_BIT 0
4954#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT_BIT 1
4955#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY_BIT 2
4956#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN_BIT 3
4957
4958#define SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG \
Gilles Peskine449bd832023-01-11 14:50:10 +01004959 ((uint32_t) ( \
4960 (SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID << \
4961 SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID_BIT) | \
4962 (SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT << \
4963 SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT_BIT) | \
4964 (SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY << \
4965 SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY_BIT) | \
4966 (SSL_SERIALIZED_CONTEXT_CONFIG_ALPN << SSL_SERIALIZED_CONTEXT_CONFIG_ALPN_BIT) | \
4967 0u))
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004968
Chien Wong4e9683e2023-12-28 17:07:43 +08004969static const unsigned char ssl_serialized_context_header[] = {
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004970 MBEDTLS_VERSION_MAJOR,
4971 MBEDTLS_VERSION_MINOR,
4972 MBEDTLS_VERSION_PATCH,
Gilles Peskine449bd832023-01-11 14:50:10 +01004973 MBEDTLS_BYTE_1(SSL_SERIALIZED_SESSION_CONFIG_BITFLAG),
4974 MBEDTLS_BYTE_0(SSL_SERIALIZED_SESSION_CONFIG_BITFLAG),
4975 MBEDTLS_BYTE_2(SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG),
4976 MBEDTLS_BYTE_1(SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG),
4977 MBEDTLS_BYTE_0(SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG),
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004978};
4979
Paul Bakker5121ce52009-01-03 21:22:43 +00004980/*
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004981 * Serialize a full SSL context
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02004982 *
4983 * The format of the serialized data is:
4984 * (in the presentation language of TLS, RFC 8446 section 3)
4985 *
4986 * // header
4987 * opaque mbedtls_version[3]; // major, minor, patch
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004988 * opaque context_format[5]; // version-specific field determining
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02004989 * // the format of the remaining
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004990 * // serialized data.
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004991 * Note: When updating the format, remember to keep these
4992 * version+format bytes. (We may make their size part of the API.)
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02004993 *
4994 * // session sub-structure
4995 * opaque session<1..2^32-1>; // see mbedtls_ssl_session_save()
4996 * // transform sub-structure
4997 * uint8 random[64]; // ServerHello.random+ClientHello.random
4998 * uint8 in_cid<0..2^8-1> // Connection ID: expected incoming value
4999 * uint8 out_cid<0..2^8-1> // Connection ID: outgoing value to use
5000 * // fields from ssl_context
5001 * uint32 badmac_seen; // DTLS: number of records with failing MAC
5002 * uint64 in_window_top; // DTLS: last validated record seq_num
5003 * uint64 in_window; // DTLS: bitmask for replay protection
5004 * uint8 disable_datagram_packing; // DTLS: only one record per datagram
5005 * uint64 cur_out_ctr; // Record layer: outgoing sequence number
5006 * uint16 mtu; // DTLS: path mtu (max outgoing fragment size)
5007 * uint8 alpn_chosen<0..2^8-1> // ALPN: negotiated application protocol
5008 *
5009 * Note that many fields of the ssl_context or sub-structures are not
5010 * serialized, as they fall in one of the following categories:
5011 *
5012 * 1. forced value (eg in_left must be 0)
5013 * 2. pointer to dynamically-allocated memory (eg session, transform)
5014 * 3. value can be re-derived from other data (eg session keys from MS)
5015 * 4. value was temporary (eg content of input buffer)
5016 * 5. value will be provided by the user again (eg I/O callbacks and context)
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005017 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005018int mbedtls_ssl_context_save(mbedtls_ssl_context *ssl,
5019 unsigned char *buf,
5020 size_t buf_len,
5021 size_t *olen)
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005022{
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005023 unsigned char *p = buf;
5024 size_t used = 0;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005025 size_t session_len;
5026 int ret = 0;
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005027
Manuel Pégourié-Gonnard1aaf6692019-07-10 14:14:05 +02005028 /*
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02005029 * Enforce usage restrictions, see "return BAD_INPUT_DATA" in
5030 * this function's documentation.
5031 *
5032 * These are due to assumptions/limitations in the implementation. Some of
5033 * them are likely to stay (no handshake in progress) some might go away
5034 * (only DTLS) but are currently used to simplify the implementation.
Manuel Pégourié-Gonnard1aaf6692019-07-10 14:14:05 +02005035 */
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02005036 /* The initial handshake must be over */
Gilles Peskine449bd832023-01-11 14:50:10 +01005037 if (mbedtls_ssl_is_handshake_over(ssl) == 0) {
5038 MBEDTLS_SSL_DEBUG_MSG(1, ("Initial handshake isn't over"));
5039 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03005040 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005041 if (ssl->handshake != NULL) {
5042 MBEDTLS_SSL_DEBUG_MSG(1, ("Handshake isn't completed"));
5043 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03005044 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02005045 /* Double-check that sub-structures are indeed ready */
Gilles Peskine449bd832023-01-11 14:50:10 +01005046 if (ssl->transform == NULL || ssl->session == NULL) {
5047 MBEDTLS_SSL_DEBUG_MSG(1, ("Serialised structures aren't ready"));
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 /* There must be no pending incoming or outgoing data */
Gilles Peskine449bd832023-01-11 14:50:10 +01005051 if (mbedtls_ssl_check_pending(ssl) != 0) {
5052 MBEDTLS_SSL_DEBUG_MSG(1, ("There is pending incoming data"));
5053 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03005054 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005055 if (ssl->out_left != 0) {
5056 MBEDTLS_SSL_DEBUG_MSG(1, ("There is pending outgoing data"));
5057 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03005058 }
Dave Rodgman556e8a32022-12-06 16:31:25 +00005059 /* Protocol must be DTLS, not TLS */
Gilles Peskine449bd832023-01-11 14:50:10 +01005060 if (ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
5061 MBEDTLS_SSL_DEBUG_MSG(1, ("Only DTLS is supported"));
5062 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03005063 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02005064 /* Version must be 1.2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005065 if (ssl->tls_version != MBEDTLS_SSL_VERSION_TLS1_2) {
5066 MBEDTLS_SSL_DEBUG_MSG(1, ("Only version 1.2 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 /* We must be using an AEAD ciphersuite */
Gilles Peskine449bd832023-01-11 14:50:10 +01005070 if (mbedtls_ssl_transform_uses_aead(ssl->transform) != 1) {
5071 MBEDTLS_SSL_DEBUG_MSG(1, ("Only AEAD ciphersuites 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 /* Renegotiation must not be enabled */
5075#if defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01005076 if (ssl->conf->disable_renegotiation != MBEDTLS_SSL_RENEGOTIATION_DISABLED) {
5077 MBEDTLS_SSL_DEBUG_MSG(1, ("Renegotiation must not be enabled"));
5078 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03005079 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02005080#endif
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005081
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005082 /*
5083 * Version and format identifier
5084 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005085 used += sizeof(ssl_serialized_context_header);
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005086
Gilles Peskine449bd832023-01-11 14:50:10 +01005087 if (used <= buf_len) {
5088 memcpy(p, ssl_serialized_context_header,
5089 sizeof(ssl_serialized_context_header));
5090 p += sizeof(ssl_serialized_context_header);
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005091 }
5092
5093 /*
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005094 * Session (length + data)
5095 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005096 ret = ssl_session_save(ssl->session, 1, NULL, 0, &session_len);
5097 if (ret != MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL) {
5098 return ret;
5099 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005100
5101 used += 4 + session_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01005102 if (used <= buf_len) {
5103 MBEDTLS_PUT_UINT32_BE(session_len, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01005104 p += 4;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005105
Gilles Peskine449bd832023-01-11 14:50:10 +01005106 ret = ssl_session_save(ssl->session, 1,
5107 p, session_len, &session_len);
5108 if (ret != 0) {
5109 return ret;
5110 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005111
5112 p += session_len;
5113 }
5114
5115 /*
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005116 * Transform
5117 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005118 used += sizeof(ssl->transform->randbytes);
5119 if (used <= buf_len) {
5120 memcpy(p, ssl->transform->randbytes,
5121 sizeof(ssl->transform->randbytes));
5122 p += sizeof(ssl->transform->randbytes);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005123 }
5124
5125#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Dave Rodgmanc37ad442023-11-03 23:36:06 +00005126 used += 2U + ssl->transform->in_cid_len + ssl->transform->out_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01005127 if (used <= buf_len) {
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005128 *p++ = ssl->transform->in_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01005129 memcpy(p, ssl->transform->in_cid, ssl->transform->in_cid_len);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005130 p += ssl->transform->in_cid_len;
5131
5132 *p++ = ssl->transform->out_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01005133 memcpy(p, ssl->transform->out_cid, ssl->transform->out_cid_len);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005134 p += ssl->transform->out_cid_len;
5135 }
5136#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
5137
5138 /*
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005139 * Saved fields from top-level ssl_context structure
5140 */
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005141 used += 4;
Gilles Peskine449bd832023-01-11 14:50:10 +01005142 if (used <= buf_len) {
5143 MBEDTLS_PUT_UINT32_BE(ssl->badmac_seen, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01005144 p += 4;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005145 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005146
5147#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
5148 used += 16;
Gilles Peskine449bd832023-01-11 14:50:10 +01005149 if (used <= buf_len) {
5150 MBEDTLS_PUT_UINT64_BE(ssl->in_window_top, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01005151 p += 8;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005152
Gilles Peskine449bd832023-01-11 14:50:10 +01005153 MBEDTLS_PUT_UINT64_BE(ssl->in_window, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01005154 p += 8;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005155 }
5156#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
5157
5158#if defined(MBEDTLS_SSL_PROTO_DTLS)
5159 used += 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01005160 if (used <= buf_len) {
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005161 *p++ = ssl->disable_datagram_packing;
5162 }
5163#endif /* MBEDTLS_SSL_PROTO_DTLS */
5164
Jerry Yuae0b2e22021-10-08 15:21:19 +08005165 used += MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Gilles Peskine449bd832023-01-11 14:50:10 +01005166 if (used <= buf_len) {
5167 memcpy(p, ssl->cur_out_ctr, MBEDTLS_SSL_SEQUENCE_NUMBER_LEN);
Jerry Yuae0b2e22021-10-08 15:21:19 +08005168 p += MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005169 }
5170
5171#if defined(MBEDTLS_SSL_PROTO_DTLS)
5172 used += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01005173 if (used <= buf_len) {
5174 MBEDTLS_PUT_UINT16_BE(ssl->mtu, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01005175 p += 2;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005176 }
5177#endif /* MBEDTLS_SSL_PROTO_DTLS */
5178
5179#if defined(MBEDTLS_SSL_ALPN)
5180 {
5181 const uint8_t alpn_len = ssl->alpn_chosen
Gilles Peskine449bd832023-01-11 14:50:10 +01005182 ? (uint8_t) strlen(ssl->alpn_chosen)
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005183 : 0;
5184
5185 used += 1 + alpn_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01005186 if (used <= buf_len) {
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005187 *p++ = alpn_len;
5188
Gilles Peskine449bd832023-01-11 14:50:10 +01005189 if (ssl->alpn_chosen != NULL) {
5190 memcpy(p, ssl->alpn_chosen, alpn_len);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005191 p += alpn_len;
5192 }
5193 }
5194 }
5195#endif /* MBEDTLS_SSL_ALPN */
5196
5197 /*
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005198 * Done
5199 */
5200 *olen = used;
5201
Gilles Peskine449bd832023-01-11 14:50:10 +01005202 if (used > buf_len) {
5203 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
5204 }
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005205
Gilles Peskine449bd832023-01-11 14:50:10 +01005206 MBEDTLS_SSL_DEBUG_BUF(4, "saved context", buf, used);
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005207
Gilles Peskine449bd832023-01-11 14:50:10 +01005208 return mbedtls_ssl_session_reset_int(ssl, 0);
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005209}
5210
5211/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02005212 * Deserialize context, see mbedtls_ssl_context_save() for format.
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005213 *
5214 * This internal version is wrapped by a public function that cleans up in
5215 * case of error.
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005216 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005217MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01005218static int ssl_context_load(mbedtls_ssl_context *ssl,
5219 const unsigned char *buf,
5220 size_t len)
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005221{
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005222 const unsigned char *p = buf;
5223 const unsigned char * const end = buf + len;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005224 size_t session_len;
Janos Follath865b3eb2019-12-16 11:46:15 +00005225 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04005226#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Andrzej Kurek894edde2022-09-29 06:31:14 -04005227 tls_prf_fn prf_func = NULL;
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04005228#endif
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005229
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02005230 /*
5231 * The context should have been freshly setup or reset.
5232 * Give the user an error in case of obvious misuse.
Manuel Pégourié-Gonnard4ca930f2019-07-26 16:31:53 +02005233 * (Checking session is useful because it won't be NULL if we're
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02005234 * renegotiating, or if the user mistakenly loaded a session first.)
5235 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005236 if (ssl->state != MBEDTLS_SSL_HELLO_REQUEST ||
5237 ssl->session != NULL) {
5238 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02005239 }
5240
5241 /*
5242 * We can't check that the config matches the initial one, but we can at
5243 * least check it matches the requirements for serializing.
5244 */
Dave Rodgmane99b24d2023-09-14 15:45:03 +01005245 if (
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02005246#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard9a96fd72019-07-23 17:11:24 +02005247 ssl->conf->disable_renegotiation != MBEDTLS_SSL_RENEGOTIATION_DISABLED ||
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02005248#endif
Dave Rodgmane99b24d2023-09-14 15:45:03 +01005249 ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM ||
5250 ssl->conf->max_tls_version < MBEDTLS_SSL_VERSION_TLS1_2 ||
5251 ssl->conf->min_tls_version > MBEDTLS_SSL_VERSION_TLS1_2
5252 ) {
Gilles Peskine449bd832023-01-11 14:50:10 +01005253 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02005254 }
5255
Gilles Peskine449bd832023-01-11 14:50:10 +01005256 MBEDTLS_SSL_DEBUG_BUF(4, "context to load", buf, len);
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005257
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005258 /*
5259 * Check version identifier
5260 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005261 if ((size_t) (end - p) < sizeof(ssl_serialized_context_header)) {
5262 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005263 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005264
5265 if (memcmp(p, ssl_serialized_context_header,
5266 sizeof(ssl_serialized_context_header)) != 0) {
5267 return MBEDTLS_ERR_SSL_VERSION_MISMATCH;
5268 }
5269 p += sizeof(ssl_serialized_context_header);
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005270
5271 /*
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005272 * Session
5273 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005274 if ((size_t) (end - p) < 4) {
5275 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5276 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005277
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01005278 session_len = MBEDTLS_GET_UINT32_BE(p, 0);
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005279 p += 4;
5280
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02005281 /* This has been allocated by ssl_handshake_init(), called by
Hanno Becker43aefe22020-02-05 10:44:56 +00005282 * by either mbedtls_ssl_session_reset_int() or mbedtls_ssl_setup(). */
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02005283 ssl->session = ssl->session_negotiate;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005284 ssl->session_in = ssl->session;
5285 ssl->session_out = ssl->session;
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02005286 ssl->session_negotiate = NULL;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005287
Gilles Peskine449bd832023-01-11 14:50:10 +01005288 if ((size_t) (end - p) < session_len) {
5289 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5290 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005291
Gilles Peskine449bd832023-01-11 14:50:10 +01005292 ret = ssl_session_load(ssl->session, 1, p, session_len);
5293 if (ret != 0) {
5294 mbedtls_ssl_session_free(ssl->session);
5295 return ret;
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02005296 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005297
5298 p += session_len;
5299
5300 /*
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005301 * Transform
5302 */
5303
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02005304 /* This has been allocated by ssl_handshake_init(), called by
Hanno Becker43aefe22020-02-05 10:44:56 +00005305 * by either mbedtls_ssl_session_reset_int() or mbedtls_ssl_setup(). */
Jerry Yu2e199812022-12-01 18:57:19 +08005306#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02005307 ssl->transform = ssl->transform_negotiate;
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005308 ssl->transform_in = ssl->transform;
5309 ssl->transform_out = ssl->transform;
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02005310 ssl->transform_negotiate = NULL;
Jerry Yu2e199812022-12-01 18:57:19 +08005311#endif
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005312
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04005313#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005314 prf_func = ssl_tls12prf_from_cs(ssl->session->ciphersuite);
5315 if (prf_func == NULL) {
5316 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5317 }
Andrzej Kurek894edde2022-09-29 06:31:14 -04005318
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005319 /* Read random bytes and populate structure */
Gilles Peskine449bd832023-01-11 14:50:10 +01005320 if ((size_t) (end - p) < sizeof(ssl->transform->randbytes)) {
5321 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5322 }
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04005323
Gilles Peskine449bd832023-01-11 14:50:10 +01005324 ret = ssl_tls12_populate_transform(ssl->transform,
5325 ssl->session->ciphersuite,
5326 ssl->session->master,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02005327#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01005328 ssl->session->encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02005329#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01005330 prf_func,
5331 p, /* currently pointing to randbytes */
5332 MBEDTLS_SSL_VERSION_TLS1_2, /* (D)TLS 1.2 is forced */
5333 ssl->conf->endpoint,
5334 ssl);
5335 if (ret != 0) {
5336 return ret;
5337 }
Jerry Yu840fbb22022-02-17 14:59:29 +08005338#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005339 p += sizeof(ssl->transform->randbytes);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005340
5341#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
5342 /* Read connection IDs and store them */
Gilles Peskine449bd832023-01-11 14:50:10 +01005343 if ((size_t) (end - p) < 1) {
5344 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5345 }
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005346
5347 ssl->transform->in_cid_len = *p++;
5348
Gilles Peskine449bd832023-01-11 14:50:10 +01005349 if ((size_t) (end - p) < ssl->transform->in_cid_len + 1u) {
5350 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5351 }
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005352
Gilles Peskine449bd832023-01-11 14:50:10 +01005353 memcpy(ssl->transform->in_cid, p, ssl->transform->in_cid_len);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005354 p += ssl->transform->in_cid_len;
5355
5356 ssl->transform->out_cid_len = *p++;
5357
Gilles Peskine449bd832023-01-11 14:50:10 +01005358 if ((size_t) (end - p) < ssl->transform->out_cid_len) {
5359 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5360 }
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005361
Gilles Peskine449bd832023-01-11 14:50:10 +01005362 memcpy(ssl->transform->out_cid, p, ssl->transform->out_cid_len);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005363 p += ssl->transform->out_cid_len;
5364#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
5365
5366 /*
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005367 * Saved fields from top-level ssl_context structure
5368 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005369 if ((size_t) (end - p) < 4) {
5370 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5371 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005372
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01005373 ssl->badmac_seen = MBEDTLS_GET_UINT32_BE(p, 0);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005374 p += 4;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005375
5376#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Gilles Peskine449bd832023-01-11 14:50:10 +01005377 if ((size_t) (end - p) < 16) {
5378 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5379 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005380
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01005381 ssl->in_window_top = MBEDTLS_GET_UINT64_BE(p, 0);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005382 p += 8;
5383
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01005384 ssl->in_window = MBEDTLS_GET_UINT64_BE(p, 0);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005385 p += 8;
5386#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
5387
5388#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005389 if ((size_t) (end - p) < 1) {
5390 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5391 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005392
5393 ssl->disable_datagram_packing = *p++;
5394#endif /* MBEDTLS_SSL_PROTO_DTLS */
5395
Gilles Peskine449bd832023-01-11 14:50:10 +01005396 if ((size_t) (end - p) < sizeof(ssl->cur_out_ctr)) {
5397 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5398 }
5399 memcpy(ssl->cur_out_ctr, p, sizeof(ssl->cur_out_ctr));
5400 p += sizeof(ssl->cur_out_ctr);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005401
5402#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005403 if ((size_t) (end - p) < 2) {
5404 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5405 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005406
Dave Rodgmana3d0f612023-11-03 23:34:02 +00005407 ssl->mtu = MBEDTLS_GET_UINT16_BE(p, 0);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005408 p += 2;
5409#endif /* MBEDTLS_SSL_PROTO_DTLS */
5410
5411#if defined(MBEDTLS_SSL_ALPN)
5412 {
5413 uint8_t alpn_len;
5414 const char **cur;
5415
Gilles Peskine449bd832023-01-11 14:50:10 +01005416 if ((size_t) (end - p) < 1) {
5417 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5418 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005419
5420 alpn_len = *p++;
5421
Gilles Peskine449bd832023-01-11 14:50:10 +01005422 if (alpn_len != 0 && ssl->conf->alpn_list != NULL) {
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005423 /* alpn_chosen should point to an item in the configured list */
Gilles Peskine449bd832023-01-11 14:50:10 +01005424 for (cur = ssl->conf->alpn_list; *cur != NULL; cur++) {
5425 if (strlen(*cur) == alpn_len &&
5426 memcmp(p, cur, alpn_len) == 0) {
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005427 ssl->alpn_chosen = *cur;
5428 break;
5429 }
5430 }
5431 }
5432
5433 /* can only happen on conf mismatch */
Gilles Peskine449bd832023-01-11 14:50:10 +01005434 if (alpn_len != 0 && ssl->alpn_chosen == NULL) {
5435 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5436 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005437
5438 p += alpn_len;
5439 }
5440#endif /* MBEDTLS_SSL_ALPN */
5441
5442 /*
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02005443 * Forced fields from top-level ssl_context structure
5444 *
5445 * Most of them already set to the correct value by mbedtls_ssl_init() and
5446 * mbedtls_ssl_reset(), so we only need to set the remaining ones.
5447 */
5448 ssl->state = MBEDTLS_SSL_HANDSHAKE_OVER;
Glenn Strauss60bfe602022-03-14 19:04:24 -04005449 ssl->tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02005450
Hanno Becker361b10d2019-08-30 10:42:49 +01005451 /* Adjust pointers for header fields of outgoing records to
5452 * the given transform, accounting for explicit IV and CID. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005453 mbedtls_ssl_update_out_pointers(ssl, ssl->transform);
Hanno Becker361b10d2019-08-30 10:42:49 +01005454
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02005455#if defined(MBEDTLS_SSL_PROTO_DTLS)
5456 ssl->in_epoch = 1;
5457#endif
5458
5459 /* mbedtls_ssl_reset() leaves the handshake sub-structure allocated,
5460 * which we don't want - otherwise we'd end up freeing the wrong transform
Hanno Beckerce5f5fd2020-02-05 10:47:44 +00005461 * by calling mbedtls_ssl_handshake_wrapup_free_hs_transform()
5462 * inappropriately. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005463 if (ssl->handshake != NULL) {
5464 mbedtls_ssl_handshake_free(ssl);
5465 mbedtls_free(ssl->handshake);
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02005466 ssl->handshake = NULL;
5467 }
5468
5469 /*
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005470 * Done - should have consumed entire buffer
5471 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005472 if (p != end) {
5473 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5474 }
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005475
Gilles Peskine449bd832023-01-11 14:50:10 +01005476 return 0;
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005477}
5478
5479/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02005480 * Deserialize context: public wrapper for error cleaning
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005481 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005482int mbedtls_ssl_context_load(mbedtls_ssl_context *context,
5483 const unsigned char *buf,
5484 size_t len)
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005485{
Gilles Peskine449bd832023-01-11 14:50:10 +01005486 int ret = ssl_context_load(context, buf, len);
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005487
Gilles Peskine449bd832023-01-11 14:50:10 +01005488 if (ret != 0) {
5489 mbedtls_ssl_free(context);
5490 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005491
Gilles Peskine449bd832023-01-11 14:50:10 +01005492 return ret;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005493}
Manuel Pégourié-Gonnard5c0e3772019-07-23 16:13:17 +02005494#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005495
5496/*
Paul Bakker5121ce52009-01-03 21:22:43 +00005497 * Free an SSL context
5498 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005499void mbedtls_ssl_free(mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00005500{
Gilles Peskine449bd832023-01-11 14:50:10 +01005501 if (ssl == NULL) {
Paul Bakkeraccaffe2014-06-26 13:37:14 +02005502 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01005503 }
Paul Bakkeraccaffe2014-06-26 13:37:14 +02005504
Gilles Peskine449bd832023-01-11 14:50:10 +01005505 MBEDTLS_SSL_DEBUG_MSG(2, ("=> free"));
Paul Bakker5121ce52009-01-03 21:22:43 +00005506
Gilles Peskine449bd832023-01-11 14:50:10 +01005507 if (ssl->out_buf != NULL) {
sander-visserb8aa2072020-05-06 22:05:13 +02005508#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
5509 size_t out_buf_len = ssl->out_buf_len;
5510#else
5511 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
5512#endif
5513
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005514 mbedtls_zeroize_and_free(ssl->out_buf, out_buf_len);
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05005515 ssl->out_buf = NULL;
Paul Bakker5121ce52009-01-03 21:22:43 +00005516 }
5517
Gilles Peskine449bd832023-01-11 14:50:10 +01005518 if (ssl->in_buf != NULL) {
sander-visserb8aa2072020-05-06 22:05:13 +02005519#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
5520 size_t in_buf_len = ssl->in_buf_len;
5521#else
5522 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
5523#endif
5524
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005525 mbedtls_zeroize_and_free(ssl->in_buf, in_buf_len);
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05005526 ssl->in_buf = NULL;
Paul Bakker5121ce52009-01-03 21:22:43 +00005527 }
5528
Gilles Peskine449bd832023-01-11 14:50:10 +01005529 if (ssl->transform) {
5530 mbedtls_ssl_transform_free(ssl->transform);
5531 mbedtls_free(ssl->transform);
Paul Bakker48916f92012-09-16 19:57:18 +00005532 }
5533
Gilles Peskine449bd832023-01-11 14:50:10 +01005534 if (ssl->handshake) {
5535 mbedtls_ssl_handshake_free(ssl);
5536 mbedtls_free(ssl->handshake);
Jerry Yu2e199812022-12-01 18:57:19 +08005537
5538#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005539 mbedtls_ssl_transform_free(ssl->transform_negotiate);
5540 mbedtls_free(ssl->transform_negotiate);
Jerry Yu2e199812022-12-01 18:57:19 +08005541#endif
5542
Gilles Peskine449bd832023-01-11 14:50:10 +01005543 mbedtls_ssl_session_free(ssl->session_negotiate);
5544 mbedtls_free(ssl->session_negotiate);
Paul Bakker48916f92012-09-16 19:57:18 +00005545 }
5546
Ronald Cron6f135e12021-12-08 16:57:54 +01005547#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01005548 mbedtls_ssl_transform_free(ssl->transform_application);
5549 mbedtls_free(ssl->transform_application);
Ronald Cron6f135e12021-12-08 16:57:54 +01005550#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker3aa186f2021-08-10 09:24:19 +01005551
Gilles Peskine449bd832023-01-11 14:50:10 +01005552 if (ssl->session) {
5553 mbedtls_ssl_session_free(ssl->session);
5554 mbedtls_free(ssl->session);
Paul Bakkerc0463502013-02-14 11:19:38 +01005555 }
5556
Manuel Pégourié-Gonnard55fab2d2015-05-11 16:15:19 +02005557#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005558 if (ssl->hostname != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005559 mbedtls_zeroize_and_free(ssl->hostname, strlen(ssl->hostname));
Paul Bakker5121ce52009-01-03 21:22:43 +00005560 }
Paul Bakker0be444a2013-08-27 21:55:01 +02005561#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00005562
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02005563#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005564 mbedtls_free(ssl->cli_id);
Manuel Pégourié-Gonnard43c02182014-07-22 17:32:01 +02005565#endif
5566
Gilles Peskine449bd832023-01-11 14:50:10 +01005567 MBEDTLS_SSL_DEBUG_MSG(2, ("<= free"));
Paul Bakker2da561c2009-02-05 18:00:28 +00005568
Paul Bakker86f04f42013-02-14 11:20:09 +01005569 /* Actually clear after last debug message */
Gilles Peskine449bd832023-01-11 14:50:10 +01005570 mbedtls_platform_zeroize(ssl, sizeof(mbedtls_ssl_context));
Paul Bakker5121ce52009-01-03 21:22:43 +00005571}
5572
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005573/*
Shaun Case8b0ecbc2021-12-20 21:14:10 -08005574 * Initialize mbedtls_ssl_config
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005575 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005576void mbedtls_ssl_config_init(mbedtls_ssl_config *conf)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005577{
Gilles Peskine449bd832023-01-11 14:50:10 +01005578 memset(conf, 0, sizeof(mbedtls_ssl_config));
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005579}
5580
Gilles Peskineae270bf2021-06-02 00:05:29 +02005581/* The selection should be the same as mbedtls_x509_crt_profile_default in
5582 * x509_crt.c, plus Montgomery curves for ECDHE. Here, the order matters:
Gilles Peskineb1940a72021-06-02 15:18:12 +02005583 * curves with a lower resource usage come first.
Gilles Peskineae270bf2021-06-02 00:05:29 +02005584 * See the documentation of mbedtls_ssl_conf_curves() for what we promise
Gilles Peskineb1940a72021-06-02 15:18:12 +02005585 * about this list.
5586 */
Chien Wong4e9683e2023-12-28 17:07:43 +08005587static const uint16_t ssl_preset_default_groups[] = {
Valerio Settidb6b4db2023-09-01 09:20:51 +02005588#if defined(MBEDTLS_ECP_HAVE_CURVE25519)
Brett Warrene0edc842021-08-17 09:53:13 +01005589 MBEDTLS_SSL_IANA_TLS_GROUP_X25519,
Gilles Peskineae270bf2021-06-02 00:05:29 +02005590#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005591#if defined(MBEDTLS_ECP_HAVE_SECP256R1)
Brett Warrene0edc842021-08-17 09:53:13 +01005592 MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1,
Gilles Peskineae270bf2021-06-02 00:05:29 +02005593#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005594#if defined(MBEDTLS_ECP_HAVE_SECP384R1)
Brett Warrene0edc842021-08-17 09:53:13 +01005595 MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02005596#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005597#if defined(MBEDTLS_ECP_HAVE_CURVE448)
Brett Warrene0edc842021-08-17 09:53:13 +01005598 MBEDTLS_SSL_IANA_TLS_GROUP_X448,
Gilles Peskineb1940a72021-06-02 15:18:12 +02005599#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005600#if defined(MBEDTLS_ECP_HAVE_SECP521R1)
Brett Warrene0edc842021-08-17 09:53:13 +01005601 MBEDTLS_SSL_IANA_TLS_GROUP_SECP521R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02005602#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005603#if defined(MBEDTLS_ECP_HAVE_BP256R1)
Brett Warrene0edc842021-08-17 09:53:13 +01005604 MBEDTLS_SSL_IANA_TLS_GROUP_BP256R1,
Gilles Peskineae270bf2021-06-02 00:05:29 +02005605#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005606#if defined(MBEDTLS_ECP_HAVE_BP384R1)
Brett Warrene0edc842021-08-17 09:53:13 +01005607 MBEDTLS_SSL_IANA_TLS_GROUP_BP384R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02005608#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005609#if defined(MBEDTLS_ECP_HAVE_BP512R1)
Brett Warrene0edc842021-08-17 09:53:13 +01005610 MBEDTLS_SSL_IANA_TLS_GROUP_BP512R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02005611#endif
Przemek Stekiel316c19e2023-05-31 15:25:11 +02005612#if defined(PSA_WANT_ALG_FFDH)
Przemek Stekiel383f4712022-12-12 14:48:57 +01005613 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE2048,
5614 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE3072,
5615 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE4096,
5616 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE6144,
5617 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE8192,
5618#endif
Brett Warrene0edc842021-08-17 09:53:13 +01005619 MBEDTLS_SSL_IANA_TLS_GROUP_NONE
Gilles Peskineae270bf2021-06-02 00:05:29 +02005620};
Gilles Peskineae270bf2021-06-02 00:05:29 +02005621
Alexey Tsvetkov2ca34372022-06-07 10:21:05 +03005622static const int ssl_preset_suiteb_ciphersuites[] = {
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005623 MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256,
5624 MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384,
5625 0
5626};
5627
Ronald Crone68ab4f2022-10-05 12:46:29 +02005628#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Hanno Becker9c6aa7b2021-08-10 13:50:43 +01005629
Jerry Yu909df7b2022-01-22 11:56:27 +08005630/* NOTICE:
Jerry Yu0b994b82022-01-25 17:22:12 +08005631 * For ssl_preset_*_sig_algs and ssl_tls12_preset_*_sig_algs, the following
Jerry Yu370e1462022-01-25 10:36:53 +08005632 * rules SHOULD be upheld.
5633 * - No duplicate entries.
5634 * - But if there is a good reason, do not change the order of the algorithms.
Jerry Yu09a99fc2022-07-28 14:22:17 +08005635 * - ssl_tls12_preset* is for TLS 1.2 use only.
Jerry Yu370e1462022-01-25 10:36:53 +08005636 * - ssl_preset_* is for TLS 1.3 only or hybrid TLS 1.3/1.2 handshakes.
Jerry Yu1a8b4812022-01-20 17:56:50 +08005637 */
Chien Wong4e9683e2023-12-28 17:07:43 +08005638static const uint16_t ssl_preset_default_sig_algs[] = {
Jerry Yu1a8b4812022-01-20 17:56:50 +08005639
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005640#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005641 defined(MBEDTLS_MD_CAN_SHA256) && \
Valerio Setticf29c5d2023-09-01 09:03:41 +02005642 defined(PSA_WANT_ECC_SECP_R1_256)
Jerry Yued5e9f42022-01-26 11:21:34 +08005643 MBEDTLS_TLS1_3_SIG_ECDSA_SECP256R1_SHA256,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005644 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256)
5645#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08005646
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005647#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005648 defined(MBEDTLS_MD_CAN_SHA384) && \
Valerio Setticf29c5d2023-09-01 09:03:41 +02005649 defined(PSA_WANT_ECC_SECP_R1_384)
Jerry Yu909df7b2022-01-22 11:56:27 +08005650 MBEDTLS_TLS1_3_SIG_ECDSA_SECP384R1_SHA384,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005651 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384)
5652#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08005653
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005654#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005655 defined(MBEDTLS_MD_CAN_SHA512) && \
Valerio Setticf29c5d2023-09-01 09:03:41 +02005656 defined(PSA_WANT_ECC_SECP_R1_521)
Jerry Yued5e9f42022-01-26 11:21:34 +08005657 MBEDTLS_TLS1_3_SIG_ECDSA_SECP521R1_SHA512,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005658 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA512)
5659#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08005660
Yanray Wang1136fad2023-11-22 16:54:31 +08005661#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && defined(MBEDTLS_MD_CAN_SHA512)
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005662 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA512,
Yanray Wang1136fad2023-11-22 16:54:31 +08005663#endif
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005664
Yanray Wang1136fad2023-11-22 16:54:31 +08005665#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && defined(MBEDTLS_MD_CAN_SHA384)
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005666 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA384,
Yanray Wang1136fad2023-11-22 16:54:31 +08005667#endif
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005668
Yanray Wang1136fad2023-11-22 16:54:31 +08005669#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && defined(MBEDTLS_MD_CAN_SHA256)
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005670 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256,
Yanray Wang1136fad2023-11-22 16:54:31 +08005671#endif
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005672
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005673#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_MD_CAN_SHA512)
Jerry Yu693a47a2022-06-23 14:02:28 +08005674 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA512,
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005675#endif /* MBEDTLS_RSA_C && MBEDTLS_MD_CAN_SHA512 */
Jerry Yu693a47a2022-06-23 14:02:28 +08005676
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005677#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_MD_CAN_SHA384)
Jerry Yu693a47a2022-06-23 14:02:28 +08005678 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA384,
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005679#endif /* MBEDTLS_RSA_C && MBEDTLS_MD_CAN_SHA384 */
Jerry Yu693a47a2022-06-23 14:02:28 +08005680
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005681#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_MD_CAN_SHA256)
Jerry Yu693a47a2022-06-23 14:02:28 +08005682 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA256,
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005683#endif /* MBEDTLS_RSA_C && MBEDTLS_MD_CAN_SHA256 */
Jerry Yu693a47a2022-06-23 14:02:28 +08005684
Gabor Mezei15b95a62022-05-09 16:37:58 +02005685 MBEDTLS_TLS_SIG_NONE
Jerry Yu909df7b2022-01-22 11:56:27 +08005686};
5687
5688/* NOTICE: see above */
5689#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
5690static uint16_t ssl_tls12_preset_default_sig_algs[] = {
Yanray Wang1136fad2023-11-22 16:54:31 +08005691
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005692#if defined(MBEDTLS_MD_CAN_SHA512)
Valerio Settie9646ec2023-08-02 20:02:28 +02005693#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005694 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA512),
Jerry Yu713013f2022-01-17 18:16:35 +08005695#endif
Jerry Yu09a99fc2022-07-28 14:22:17 +08005696#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT)
5697 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA512,
Yanray Wang1136fad2023-11-22 16:54:31 +08005698#endif
Gabor Mezeic1051b62022-05-10 13:13:58 +02005699#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005700 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA512),
Gabor Mezeic1051b62022-05-10 13:13:58 +02005701#endif
Yanray Wang1136fad2023-11-22 16:54:31 +08005702#endif /* MBEDTLS_MD_CAN_SHA512 */
5703
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005704#if defined(MBEDTLS_MD_CAN_SHA384)
Valerio Settie9646ec2023-08-02 20:02:28 +02005705#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005706 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384),
Jerry Yu11f0a9c2022-01-12 18:43:08 +08005707#endif
Jerry Yu09a99fc2022-07-28 14:22:17 +08005708#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT)
5709 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA384,
Yanray Wang1136fad2023-11-22 16:54:31 +08005710#endif
Gabor Mezeic1051b62022-05-10 13:13:58 +02005711#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005712 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA384),
Gabor Mezeic1051b62022-05-10 13:13:58 +02005713#endif
Yanray Wang1136fad2023-11-22 16:54:31 +08005714#endif /* MBEDTLS_MD_CAN_SHA384 */
5715
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005716#if defined(MBEDTLS_MD_CAN_SHA256)
Valerio Settie9646ec2023-08-02 20:02:28 +02005717#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005718 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256),
Jerry Yu11f0a9c2022-01-12 18:43:08 +08005719#endif
Jerry Yu09a99fc2022-07-28 14:22:17 +08005720#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT)
5721 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256,
Yanray Wang1136fad2023-11-22 16:54:31 +08005722#endif
Gabor Mezeic1051b62022-05-10 13:13:58 +02005723#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005724 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA256),
Gabor Mezeic1051b62022-05-10 13:13:58 +02005725#endif
Yanray Wang1136fad2023-11-22 16:54:31 +08005726#endif /* MBEDTLS_MD_CAN_SHA256 */
5727
Gabor Mezei15b95a62022-05-09 16:37:58 +02005728 MBEDTLS_TLS_SIG_NONE
Jerry Yu909df7b2022-01-22 11:56:27 +08005729};
5730#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Yanray Wang1136fad2023-11-22 16:54:31 +08005731
Jerry Yu909df7b2022-01-22 11:56:27 +08005732/* NOTICE: see above */
Chien Wong4e9683e2023-12-28 17:07:43 +08005733static const uint16_t ssl_preset_suiteb_sig_algs[] = {
Jerry Yu909df7b2022-01-22 11:56:27 +08005734
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005735#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Valerio Setti45d56f32023-07-13 17:23:20 +02005736 defined(MBEDTLS_MD_CAN_SHA256) && \
Valerio Settidb6b4db2023-09-01 09:20:51 +02005737 defined(MBEDTLS_ECP_HAVE_SECP256R1)
Jerry Yu909df7b2022-01-22 11:56:27 +08005738 MBEDTLS_TLS1_3_SIG_ECDSA_SECP256R1_SHA256,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005739 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256)
5740#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08005741
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005742#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Valerio Setti45d56f32023-07-13 17:23:20 +02005743 defined(MBEDTLS_MD_CAN_SHA384) && \
Valerio Settidb6b4db2023-09-01 09:20:51 +02005744 defined(MBEDTLS_ECP_HAVE_SECP384R1)
Jerry Yu53037892022-01-25 11:02:06 +08005745 MBEDTLS_TLS1_3_SIG_ECDSA_SECP384R1_SHA384,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005746 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384)
5747#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08005748
Gabor Mezei15b95a62022-05-09 16:37:58 +02005749 MBEDTLS_TLS_SIG_NONE
Jerry Yu713013f2022-01-17 18:16:35 +08005750};
Jerry Yu6106fdc2022-01-12 16:36:14 +08005751
Jerry Yu909df7b2022-01-22 11:56:27 +08005752/* NOTICE: see above */
5753#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
5754static uint16_t ssl_tls12_preset_suiteb_sig_algs[] = {
Yanray Wang1136fad2023-11-22 16:54:31 +08005755
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005756#if defined(MBEDTLS_MD_CAN_SHA256)
Valerio Settie9646ec2023-08-02 20:02:28 +02005757#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005758 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256),
Jerry Yu713013f2022-01-17 18:16:35 +08005759#endif
Yanray Wang1136fad2023-11-22 16:54:31 +08005760#endif /* MBEDTLS_MD_CAN_SHA256 */
Yanray Wang69ceb392023-11-22 16:32:39 +08005761
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005762#if defined(MBEDTLS_MD_CAN_SHA384)
Valerio Settie9646ec2023-08-02 20:02:28 +02005763#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005764 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384),
Jerry Yu18c833e2022-01-25 10:55:47 +08005765#endif
Yanray Wang1136fad2023-11-22 16:54:31 +08005766#endif /* MBEDTLS_MD_CAN_SHA384 */
5767
Gabor Mezei15b95a62022-05-09 16:37:58 +02005768 MBEDTLS_TLS_SIG_NONE
Hanno Becker9c6aa7b2021-08-10 13:50:43 +01005769};
Jerry Yu909df7b2022-01-22 11:56:27 +08005770#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
5771
Ronald Crone68ab4f2022-10-05 12:46:29 +02005772#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005773
Chien Wong4e9683e2023-12-28 17:07:43 +08005774static const uint16_t ssl_preset_suiteb_groups[] = {
Valerio Settidb6b4db2023-09-01 09:20:51 +02005775#if defined(MBEDTLS_ECP_HAVE_SECP256R1)
Brett Warrene0edc842021-08-17 09:53:13 +01005776 MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1,
Jaeden Amerod4311042019-06-03 08:27:16 +01005777#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005778#if defined(MBEDTLS_ECP_HAVE_SECP384R1)
Brett Warrene0edc842021-08-17 09:53:13 +01005779 MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1,
Jaeden Amerod4311042019-06-03 08:27:16 +01005780#endif
Brett Warrene0edc842021-08-17 09:53:13 +01005781 MBEDTLS_SSL_IANA_TLS_GROUP_NONE
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005782};
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005783
Ronald Crone68ab4f2022-10-05 12:46:29 +02005784#if defined(MBEDTLS_DEBUG_C) && defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu909df7b2022-01-22 11:56:27 +08005785/* Function for checking `ssl_preset_*_sig_algs` and `ssl_tls12_preset_*_sig_algs`
Jerry Yu370e1462022-01-25 10:36:53 +08005786 * to make sure there are no duplicated signature algorithm entries. */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005787MBEDTLS_CHECK_RETURN_CRITICAL
Chien Wong4e9683e2023-12-28 17:07:43 +08005788static int ssl_check_no_sig_alg_duplication(const uint16_t *sig_algs)
Jerry Yu1a8b4812022-01-20 17:56:50 +08005789{
5790 size_t i, j;
5791 int ret = 0;
Jerry Yu909df7b2022-01-22 11:56:27 +08005792
Gilles Peskine449bd832023-01-11 14:50:10 +01005793 for (i = 0; sig_algs[i] != MBEDTLS_TLS_SIG_NONE; i++) {
5794 for (j = 0; j < i; j++) {
5795 if (sig_algs[i] != sig_algs[j]) {
Jerry Yuf377d642022-01-25 10:43:59 +08005796 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01005797 }
5798 mbedtls_printf(" entry(%04x,%" MBEDTLS_PRINTF_SIZET
5799 ") is duplicated at %" MBEDTLS_PRINTF_SIZET "\n",
5800 sig_algs[i], j, i);
Jerry Yuf377d642022-01-25 10:43:59 +08005801 ret = -1;
Jerry Yu1a8b4812022-01-20 17:56:50 +08005802 }
5803 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005804 return ret;
Jerry Yu1a8b4812022-01-20 17:56:50 +08005805}
5806
Ronald Crone68ab4f2022-10-05 12:46:29 +02005807#endif /* MBEDTLS_DEBUG_C && MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Jerry Yu1a8b4812022-01-20 17:56:50 +08005808
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005809/*
Tillmann Karras588ad502015-09-25 04:27:22 +02005810 * Load default in mbedtls_ssl_config
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005811 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005812int mbedtls_ssl_config_defaults(mbedtls_ssl_config *conf,
5813 int endpoint, int transport, int preset)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005814{
Manuel Pégourié-Gonnard8b431fb2015-05-11 12:54:52 +02005815#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Janos Follath865b3eb2019-12-16 11:46:15 +00005816 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard8b431fb2015-05-11 12:54:52 +02005817#endif
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005818
Ronald Crone68ab4f2022-10-05 12:46:29 +02005819#if defined(MBEDTLS_DEBUG_C) && defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005820 if (ssl_check_no_sig_alg_duplication(ssl_preset_suiteb_sig_algs)) {
5821 mbedtls_printf("ssl_preset_suiteb_sig_algs has duplicated entries\n");
5822 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu1a8b4812022-01-20 17:56:50 +08005823 }
5824
Gilles Peskine449bd832023-01-11 14:50:10 +01005825 if (ssl_check_no_sig_alg_duplication(ssl_preset_default_sig_algs)) {
5826 mbedtls_printf("ssl_preset_default_sig_algs has duplicated entries\n");
5827 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu1a8b4812022-01-20 17:56:50 +08005828 }
Jerry Yu909df7b2022-01-22 11:56:27 +08005829
5830#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005831 if (ssl_check_no_sig_alg_duplication(ssl_tls12_preset_suiteb_sig_algs)) {
5832 mbedtls_printf("ssl_tls12_preset_suiteb_sig_algs has duplicated entries\n");
5833 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu909df7b2022-01-22 11:56:27 +08005834 }
5835
Gilles Peskine449bd832023-01-11 14:50:10 +01005836 if (ssl_check_no_sig_alg_duplication(ssl_tls12_preset_default_sig_algs)) {
5837 mbedtls_printf("ssl_tls12_preset_default_sig_algs has duplicated entries\n");
5838 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu909df7b2022-01-22 11:56:27 +08005839 }
5840#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Ronald Crone68ab4f2022-10-05 12:46:29 +02005841#endif /* MBEDTLS_DEBUG_C && MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Jerry Yu1a8b4812022-01-20 17:56:50 +08005842
Manuel Pégourié-Gonnard0de074f2015-05-14 12:58:01 +02005843 /* Use the functions here so that they are covered in tests,
5844 * but otherwise access member directly for efficiency */
Gilles Peskine449bd832023-01-11 14:50:10 +01005845 mbedtls_ssl_conf_endpoint(conf, endpoint);
5846 mbedtls_ssl_conf_transport(conf, transport);
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005847
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005848 /*
5849 * Things that are common to all presets
5850 */
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02005851#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005852 if (endpoint == MBEDTLS_SSL_IS_CLIENT) {
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02005853 conf->authmode = MBEDTLS_SSL_VERIFY_REQUIRED;
5854#if defined(MBEDTLS_SSL_SESSION_TICKETS)
5855 conf->session_tickets = MBEDTLS_SSL_SESSION_TICKETS_ENABLED;
5856#endif
5857 }
5858#endif
5859
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005860#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
5861 conf->encrypt_then_mac = MBEDTLS_SSL_ETM_ENABLED;
5862#endif
5863
5864#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
5865 conf->extended_ms = MBEDTLS_SSL_EXTENDED_MS_ENABLED;
5866#endif
5867
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02005868#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005869 conf->f_cookie_write = ssl_cookie_write_dummy;
5870 conf->f_cookie_check = ssl_cookie_check_dummy;
5871#endif
5872
5873#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
5874 conf->anti_replay = MBEDTLS_SSL_ANTI_REPLAY_ENABLED;
5875#endif
5876
Janos Follath088ce432017-04-10 12:42:31 +01005877#if defined(MBEDTLS_SSL_SRV_C)
5878 conf->cert_req_ca_list = MBEDTLS_SSL_CERT_REQ_CA_LIST_ENABLED;
TRodziewicz3946f792021-06-14 12:11:18 +02005879 conf->respect_cli_pref = MBEDTLS_SSL_SRV_CIPHERSUITE_ORDER_SERVER;
Janos Follath088ce432017-04-10 12:42:31 +01005880#endif
5881
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005882#if defined(MBEDTLS_SSL_PROTO_DTLS)
5883 conf->hs_timeout_min = MBEDTLS_SSL_DTLS_TIMEOUT_DFL_MIN;
5884 conf->hs_timeout_max = MBEDTLS_SSL_DTLS_TIMEOUT_DFL_MAX;
5885#endif
5886
5887#if defined(MBEDTLS_SSL_RENEGOTIATION)
5888 conf->renego_max_records = MBEDTLS_SSL_RENEGO_MAX_RECORDS_DEFAULT;
Gilles Peskine449bd832023-01-11 14:50:10 +01005889 memset(conf->renego_period, 0x00, 2);
5890 memset(conf->renego_period + 2, 0xFF, 6);
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005891#endif
5892
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005893#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005894 if (endpoint == MBEDTLS_SSL_IS_SERVER) {
Hanno Beckere2defad2021-07-24 05:59:17 +01005895 const unsigned char dhm_p[] =
5896 MBEDTLS_DHM_RFC3526_MODP_2048_P_BIN;
5897 const unsigned char dhm_g[] =
5898 MBEDTLS_DHM_RFC3526_MODP_2048_G_BIN;
Hanno Becker00d0a682017-10-04 13:14:29 +01005899
Gilles Peskine449bd832023-01-11 14:50:10 +01005900 if ((ret = mbedtls_ssl_conf_dh_param_bin(conf,
5901 dhm_p, sizeof(dhm_p),
5902 dhm_g, sizeof(dhm_g))) != 0) {
5903 return ret;
Hanno Beckere2defad2021-07-24 05:59:17 +01005904 }
5905 }
Manuel Pégourié-Gonnardbd990d62015-06-11 14:49:42 +02005906#endif
5907
Ronald Cron6f135e12021-12-08 16:57:54 +01005908#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yu6ee56aa2022-12-06 17:47:22 +08005909
5910#if defined(MBEDTLS_SSL_EARLY_DATA)
Yanray Wangd5ed36f2023-11-07 11:40:43 +08005911 mbedtls_ssl_conf_early_data(conf, MBEDTLS_SSL_EARLY_DATA_DISABLED);
Jerry Yu6ee56aa2022-12-06 17:47:22 +08005912#if defined(MBEDTLS_SSL_SRV_C)
Yanray Wang07517612023-11-07 11:47:36 +08005913 mbedtls_ssl_conf_max_early_data_size(conf, MBEDTLS_SSL_MAX_EARLY_DATA_SIZE);
Jerry Yu6ee56aa2022-12-06 17:47:22 +08005914#endif
5915#endif /* MBEDTLS_SSL_EARLY_DATA */
5916
Jerry Yud0766ec2022-09-22 10:46:57 +08005917#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Jerry Yu1ad7ace2022-08-09 13:28:39 +08005918 mbedtls_ssl_conf_new_session_tickets(
Gilles Peskine449bd832023-01-11 14:50:10 +01005919 conf, MBEDTLS_SSL_TLS1_3_DEFAULT_NEW_SESSION_TICKETS);
Jerry Yu1ad7ace2022-08-09 13:28:39 +08005920#endif
Hanno Becker71f1ed62021-07-24 06:01:47 +01005921 /*
5922 * Allow all TLS 1.3 key exchange modes by default.
5923 */
Xiaofei Bai746f9482021-11-12 08:53:56 +00005924 conf->tls13_kex_modes = MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_ALL;
Ronald Cron6f135e12021-12-08 16:57:54 +01005925#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker71f1ed62021-07-24 06:01:47 +01005926
Gilles Peskine449bd832023-01-11 14:50:10 +01005927 if (transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Glenn Strauss2dfcea22022-03-14 17:26:42 -04005928#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
XiaokangQian4d3a6042022-04-21 13:46:17 +00005929 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
XiaokangQian060d8672022-04-21 09:24:56 +00005930 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
XiaokangQian4d3a6042022-04-21 13:46:17 +00005931#else
Gilles Peskine449bd832023-01-11 14:50:10 +01005932 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
XiaokangQian060d8672022-04-21 09:24:56 +00005933#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01005934 } else {
XiaokangQian4d3a6042022-04-21 13:46:17 +00005935#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
Ronald Cron097ba142023-03-08 16:18:00 +01005936 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
5937 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
XiaokangQian4d3a6042022-04-21 13:46:17 +00005938#elif defined(MBEDTLS_SSL_PROTO_TLS1_3)
5939 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
5940 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
5941#elif defined(MBEDTLS_SSL_PROTO_TLS1_2)
5942 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
5943 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
5944#else
Gilles Peskine449bd832023-01-11 14:50:10 +01005945 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
XiaokangQian4d3a6042022-04-21 13:46:17 +00005946#endif
5947 }
Glenn Strauss2dfcea22022-03-14 17:26:42 -04005948
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005949 /*
5950 * Preset-specific defaults
5951 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005952 switch (preset) {
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005953 /*
5954 * NSA Suite B
5955 */
5956 case MBEDTLS_SSL_PRESET_SUITEB:
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005957
Hanno Beckerd60b6c62021-04-29 12:04:11 +01005958 conf->ciphersuite_list = ssl_preset_suiteb_ciphersuites;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005959
5960#if defined(MBEDTLS_X509_CRT_PARSE_C)
5961 conf->cert_profile = &mbedtls_x509_crt_profile_suiteb;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005962#endif
5963
Ronald Crone68ab4f2022-10-05 12:46:29 +02005964#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu909df7b2022-01-22 11:56:27 +08005965#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005966 if (mbedtls_ssl_conf_is_tls12_only(conf)) {
Jerry Yu909df7b2022-01-22 11:56:27 +08005967 conf->sig_algs = ssl_tls12_preset_suiteb_sig_algs;
Gilles Peskine449bd832023-01-11 14:50:10 +01005968 } else
Jerry Yu909df7b2022-01-22 11:56:27 +08005969#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005970 conf->sig_algs = ssl_preset_suiteb_sig_algs;
Ronald Crone68ab4f2022-10-05 12:46:29 +02005971#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005972
Manuel Pégourié-Gonnardf07ce3b2023-09-22 11:53:41 +02005973#if defined(MBEDTLS_ECP_C) && !defined(MBEDTLS_DEPRECATED_REMOVED)
Brett Warrene0edc842021-08-17 09:53:13 +01005974 conf->curve_list = NULL;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005975#endif
Brett Warrene0edc842021-08-17 09:53:13 +01005976 conf->group_list = ssl_preset_suiteb_groups;
Manuel Pégourié-Gonnardc98204e2015-08-11 04:21:01 +02005977 break;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005978
5979 /*
5980 * Default
5981 */
5982 default:
Ronald Cronf6606552022-03-15 11:23:25 +01005983
Hanno Beckerd60b6c62021-04-29 12:04:11 +01005984 conf->ciphersuite_list = mbedtls_ssl_list_ciphersuites();
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005985
5986#if defined(MBEDTLS_X509_CRT_PARSE_C)
5987 conf->cert_profile = &mbedtls_x509_crt_profile_default;
5988#endif
5989
Ronald Crone68ab4f2022-10-05 12:46:29 +02005990#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu909df7b2022-01-22 11:56:27 +08005991#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005992 if (mbedtls_ssl_conf_is_tls12_only(conf)) {
Jerry Yu909df7b2022-01-22 11:56:27 +08005993 conf->sig_algs = ssl_tls12_preset_default_sig_algs;
Gilles Peskine449bd832023-01-11 14:50:10 +01005994 } else
Jerry Yu909df7b2022-01-22 11:56:27 +08005995#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005996 conf->sig_algs = ssl_preset_default_sig_algs;
Ronald Crone68ab4f2022-10-05 12:46:29 +02005997#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005998
Manuel Pégourié-Gonnardf07ce3b2023-09-22 11:53:41 +02005999#if defined(MBEDTLS_ECP_C) && !defined(MBEDTLS_DEPRECATED_REMOVED)
Brett Warrene0edc842021-08-17 09:53:13 +01006000 conf->curve_list = NULL;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02006001#endif
Brett Warrene0edc842021-08-17 09:53:13 +01006002 conf->group_list = ssl_preset_default_groups;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02006003
6004#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_CLI_C)
6005 conf->dhm_min_bitlen = 1024;
6006#endif
6007 }
6008
Gilles Peskine449bd832023-01-11 14:50:10 +01006009 return 0;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02006010}
6011
6012/*
6013 * Free mbedtls_ssl_config
6014 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006015void mbedtls_ssl_config_free(mbedtls_ssl_config *conf)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02006016{
6017#if defined(MBEDTLS_DHM_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01006018 mbedtls_mpi_free(&conf->dhm_P);
6019 mbedtls_mpi_free(&conf->dhm_G);
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02006020#endif
6021
Ronald Cron73fe8df2022-10-05 14:31:43 +02006022#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED)
Neil Armstrong501c9322022-05-03 09:35:09 +02006023#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01006024 if (!mbedtls_svc_key_id_is_null(conf->psk_opaque)) {
Neil Armstrong501c9322022-05-03 09:35:09 +02006025 conf->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
6026 }
Neil Armstrong8ecd6682022-05-05 11:40:35 +02006027#endif /* MBEDTLS_USE_PSA_CRYPTO */
Gilles Peskine449bd832023-01-11 14:50:10 +01006028 if (conf->psk != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01006029 mbedtls_zeroize_and_free(conf->psk, conf->psk_len);
Azim Khan27e8a122018-03-21 14:24:11 +00006030 conf->psk = NULL;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02006031 conf->psk_len = 0;
junyeonLEE316b1622017-12-20 16:29:30 +09006032 }
6033
Gilles Peskine449bd832023-01-11 14:50:10 +01006034 if (conf->psk_identity != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01006035 mbedtls_zeroize_and_free(conf->psk_identity, conf->psk_identity_len);
Azim Khan27e8a122018-03-21 14:24:11 +00006036 conf->psk_identity = NULL;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02006037 conf->psk_identity_len = 0;
6038 }
Ronald Cron73fe8df2022-10-05 14:31:43 +02006039#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED */
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02006040
6041#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01006042 ssl_key_cert_free(conf->key_cert);
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02006043#endif
6044
Gilles Peskine449bd832023-01-11 14:50:10 +01006045 mbedtls_platform_zeroize(conf, sizeof(mbedtls_ssl_config));
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02006046}
6047
Manuel Pégourié-Gonnard5674a972015-10-19 15:14:03 +02006048#if defined(MBEDTLS_PK_C) && \
Valerio Settie9646ec2023-08-02 20:02:28 +02006049 (defined(MBEDTLS_RSA_C) || defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED))
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02006050/*
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006051 * Convert between MBEDTLS_PK_XXX and SSL_SIG_XXX
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02006052 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006053unsigned char mbedtls_ssl_sig_from_pk(mbedtls_pk_context *pk)
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02006054{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006055#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01006056 if (mbedtls_pk_can_do(pk, MBEDTLS_PK_RSA)) {
6057 return MBEDTLS_SSL_SIG_RSA;
6058 }
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02006059#endif
Valerio Settie9646ec2023-08-02 20:02:28 +02006060#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01006061 if (mbedtls_pk_can_do(pk, MBEDTLS_PK_ECDSA)) {
6062 return MBEDTLS_SSL_SIG_ECDSA;
6063 }
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02006064#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01006065 return MBEDTLS_SSL_SIG_ANON;
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02006066}
6067
Gilles Peskine449bd832023-01-11 14:50:10 +01006068unsigned char mbedtls_ssl_sig_from_pk_alg(mbedtls_pk_type_t type)
Hanno Becker7e5437a2017-04-28 17:15:26 +01006069{
Gilles Peskine449bd832023-01-11 14:50:10 +01006070 switch (type) {
Hanno Becker7e5437a2017-04-28 17:15:26 +01006071 case MBEDTLS_PK_RSA:
Gilles Peskine449bd832023-01-11 14:50:10 +01006072 return MBEDTLS_SSL_SIG_RSA;
Hanno Becker7e5437a2017-04-28 17:15:26 +01006073 case MBEDTLS_PK_ECDSA:
6074 case MBEDTLS_PK_ECKEY:
Gilles Peskine449bd832023-01-11 14:50:10 +01006075 return MBEDTLS_SSL_SIG_ECDSA;
Hanno Becker7e5437a2017-04-28 17:15:26 +01006076 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006077 return MBEDTLS_SSL_SIG_ANON;
Hanno Becker7e5437a2017-04-28 17:15:26 +01006078 }
6079}
6080
Gilles Peskine449bd832023-01-11 14:50:10 +01006081mbedtls_pk_type_t mbedtls_ssl_pk_alg_from_sig(unsigned char sig)
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02006082{
Gilles Peskine449bd832023-01-11 14:50:10 +01006083 switch (sig) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006084#if defined(MBEDTLS_RSA_C)
6085 case MBEDTLS_SSL_SIG_RSA:
Gilles Peskine449bd832023-01-11 14:50:10 +01006086 return MBEDTLS_PK_RSA;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02006087#endif
Valerio Settie9646ec2023-08-02 20:02:28 +02006088#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006089 case MBEDTLS_SSL_SIG_ECDSA:
Gilles Peskine449bd832023-01-11 14:50:10 +01006090 return MBEDTLS_PK_ECDSA;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02006091#endif
6092 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006093 return MBEDTLS_PK_NONE;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02006094 }
6095}
Valerio Settie9646ec2023-08-02 20:02:28 +02006096#endif /* MBEDTLS_PK_C &&
6097 ( MBEDTLS_RSA_C || MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED ) */
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02006098
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02006099/*
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006100 * Convert from MBEDTLS_SSL_HASH_XXX to MBEDTLS_MD_XXX
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02006101 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006102mbedtls_md_type_t mbedtls_ssl_md_alg_from_hash(unsigned char hash)
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02006103{
Gilles Peskine449bd832023-01-11 14:50:10 +01006104 switch (hash) {
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006105#if defined(MBEDTLS_MD_CAN_MD5)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006106 case MBEDTLS_SSL_HASH_MD5:
Gilles Peskine449bd832023-01-11 14:50:10 +01006107 return MBEDTLS_MD_MD5;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02006108#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006109#if defined(MBEDTLS_MD_CAN_SHA1)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006110 case MBEDTLS_SSL_HASH_SHA1:
Gilles Peskine449bd832023-01-11 14:50:10 +01006111 return MBEDTLS_MD_SHA1;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02006112#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006113#if defined(MBEDTLS_MD_CAN_SHA224)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006114 case MBEDTLS_SSL_HASH_SHA224:
Gilles Peskine449bd832023-01-11 14:50:10 +01006115 return MBEDTLS_MD_SHA224;
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02006116#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006117#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006118 case MBEDTLS_SSL_HASH_SHA256:
Gilles Peskine449bd832023-01-11 14:50:10 +01006119 return MBEDTLS_MD_SHA256;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02006120#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006121#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006122 case MBEDTLS_SSL_HASH_SHA384:
Gilles Peskine449bd832023-01-11 14:50:10 +01006123 return MBEDTLS_MD_SHA384;
Mateusz Starzyk3352a532021-04-06 14:28:22 +02006124#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006125#if defined(MBEDTLS_MD_CAN_SHA512)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006126 case MBEDTLS_SSL_HASH_SHA512:
Gilles Peskine449bd832023-01-11 14:50:10 +01006127 return MBEDTLS_MD_SHA512;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02006128#endif
6129 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006130 return MBEDTLS_MD_NONE;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02006131 }
6132}
6133
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006134/*
6135 * Convert from MBEDTLS_MD_XXX to MBEDTLS_SSL_HASH_XXX
6136 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006137unsigned char mbedtls_ssl_hash_from_md_alg(int md)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006138{
Gilles Peskine449bd832023-01-11 14:50:10 +01006139 switch (md) {
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006140#if defined(MBEDTLS_MD_CAN_MD5)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006141 case MBEDTLS_MD_MD5:
Gilles Peskine449bd832023-01-11 14:50:10 +01006142 return MBEDTLS_SSL_HASH_MD5;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006143#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006144#if defined(MBEDTLS_MD_CAN_SHA1)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006145 case MBEDTLS_MD_SHA1:
Gilles Peskine449bd832023-01-11 14:50:10 +01006146 return MBEDTLS_SSL_HASH_SHA1;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006147#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006148#if defined(MBEDTLS_MD_CAN_SHA224)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006149 case MBEDTLS_MD_SHA224:
Gilles Peskine449bd832023-01-11 14:50:10 +01006150 return MBEDTLS_SSL_HASH_SHA224;
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02006151#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006152#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006153 case MBEDTLS_MD_SHA256:
Gilles Peskine449bd832023-01-11 14:50:10 +01006154 return MBEDTLS_SSL_HASH_SHA256;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006155#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006156#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006157 case MBEDTLS_MD_SHA384:
Gilles Peskine449bd832023-01-11 14:50:10 +01006158 return MBEDTLS_SSL_HASH_SHA384;
Mateusz Starzyk3352a532021-04-06 14:28:22 +02006159#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006160#if defined(MBEDTLS_MD_CAN_SHA512)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006161 case MBEDTLS_MD_SHA512:
Gilles Peskine449bd832023-01-11 14:50:10 +01006162 return MBEDTLS_SSL_HASH_SHA512;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006163#endif
6164 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006165 return MBEDTLS_SSL_HASH_NONE;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006166 }
6167}
6168
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01006169/*
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006170 * Check if a curve proposed by the peer is in our list.
Manuel Pégourié-Gonnard9d412d82015-06-17 12:10:46 +02006171 * Return 0 if we're willing to use it, -1 otherwise.
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01006172 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006173int mbedtls_ssl_check_curve_tls_id(const mbedtls_ssl_context *ssl, uint16_t tls_id)
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01006174{
Gilles Peskine449bd832023-01-11 14:50:10 +01006175 const uint16_t *group_list = mbedtls_ssl_get_groups(ssl);
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01006176
Gilles Peskine449bd832023-01-11 14:50:10 +01006177 if (group_list == NULL) {
6178 return -1;
Brett Warrene0edc842021-08-17 09:53:13 +01006179 }
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01006180
Gilles Peskine449bd832023-01-11 14:50:10 +01006181 for (; *group_list != 0; group_list++) {
6182 if (*group_list == tls_id) {
6183 return 0;
6184 }
6185 }
6186
6187 return -1;
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01006188}
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01006189
Valerio Setti49e69072023-06-27 17:27:51 +02006190#if defined(MBEDTLS_PK_HAVE_ECC_KEYS)
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01006191/*
6192 * Same as mbedtls_ssl_check_curve_tls_id() but with a mbedtls_ecp_group_id.
6193 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006194int mbedtls_ssl_check_curve(const mbedtls_ssl_context *ssl, mbedtls_ecp_group_id grp_id)
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01006195{
Gilles Peskine449bd832023-01-11 14:50:10 +01006196 uint16_t tls_id = mbedtls_ssl_get_tls_id_from_ecp_group_id(grp_id);
Leonid Rozenboim19e59732022-08-08 16:52:38 -07006197
Gilles Peskine449bd832023-01-11 14:50:10 +01006198 if (tls_id == 0) {
Leonid Rozenboim19e59732022-08-08 16:52:38 -07006199 return -1;
Gilles Peskine449bd832023-01-11 14:50:10 +01006200 }
Leonid Rozenboim19e59732022-08-08 16:52:38 -07006201
Gilles Peskine449bd832023-01-11 14:50:10 +01006202 return mbedtls_ssl_check_curve_tls_id(ssl, tls_id);
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01006203}
Valerio Setti49e69072023-06-27 17:27:51 +02006204#endif /* MBEDTLS_PK_HAVE_ECC_KEYS */
Valerio Setti67419f02023-01-04 16:12:42 +01006205
Valerio Setti18c9fed2022-12-30 17:44:24 +01006206static const struct {
6207 uint16_t tls_id;
6208 mbedtls_ecp_group_id ecp_group_id;
6209 psa_ecc_family_t psa_family;
6210 uint16_t bits;
Valerio Setti18c9fed2022-12-30 17:44:24 +01006211} tls_id_match_table[] =
6212{
Valerio Settidb6b4db2023-09-01 09:20:51 +02006213#if defined(MBEDTLS_ECP_HAVE_SECP521R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02006214 { 25, MBEDTLS_ECP_DP_SECP521R1, PSA_ECC_FAMILY_SECP_R1, 521 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006215#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02006216#if defined(MBEDTLS_ECP_HAVE_BP512R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02006217 { 28, MBEDTLS_ECP_DP_BP512R1, PSA_ECC_FAMILY_BRAINPOOL_P_R1, 512 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006218#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02006219#if defined(MBEDTLS_ECP_HAVE_SECP384R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02006220 { 24, MBEDTLS_ECP_DP_SECP384R1, PSA_ECC_FAMILY_SECP_R1, 384 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006221#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02006222#if defined(MBEDTLS_ECP_HAVE_BP384R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02006223 { 27, MBEDTLS_ECP_DP_BP384R1, PSA_ECC_FAMILY_BRAINPOOL_P_R1, 384 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006224#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02006225#if defined(MBEDTLS_ECP_HAVE_SECP256R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02006226 { 23, MBEDTLS_ECP_DP_SECP256R1, PSA_ECC_FAMILY_SECP_R1, 256 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006227#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02006228#if defined(MBEDTLS_ECP_HAVE_SECP256K1)
Valerio Settiacd32c02023-06-29 18:06:29 +02006229 { 22, MBEDTLS_ECP_DP_SECP256K1, PSA_ECC_FAMILY_SECP_K1, 256 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006230#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02006231#if defined(MBEDTLS_ECP_HAVE_BP256R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02006232 { 26, MBEDTLS_ECP_DP_BP256R1, PSA_ECC_FAMILY_BRAINPOOL_P_R1, 256 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006233#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02006234#if defined(MBEDTLS_ECP_HAVE_SECP224R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02006235 { 21, MBEDTLS_ECP_DP_SECP224R1, PSA_ECC_FAMILY_SECP_R1, 224 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006236#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02006237#if defined(MBEDTLS_ECP_HAVE_SECP224K1)
Valerio Settiacd32c02023-06-29 18:06:29 +02006238 { 20, MBEDTLS_ECP_DP_SECP224K1, PSA_ECC_FAMILY_SECP_K1, 224 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006239#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02006240#if defined(MBEDTLS_ECP_HAVE_SECP192R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02006241 { 19, MBEDTLS_ECP_DP_SECP192R1, PSA_ECC_FAMILY_SECP_R1, 192 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006242#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02006243#if defined(MBEDTLS_ECP_HAVE_SECP192K1)
Valerio Settiacd32c02023-06-29 18:06:29 +02006244 { 18, MBEDTLS_ECP_DP_SECP192K1, PSA_ECC_FAMILY_SECP_K1, 192 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006245#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02006246#if defined(MBEDTLS_ECP_HAVE_CURVE25519)
Valerio Settiacd32c02023-06-29 18:06:29 +02006247 { 29, MBEDTLS_ECP_DP_CURVE25519, PSA_ECC_FAMILY_MONTGOMERY, 255 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006248#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02006249#if defined(MBEDTLS_ECP_HAVE_CURVE448)
Valerio Settiacd32c02023-06-29 18:06:29 +02006250 { 30, MBEDTLS_ECP_DP_CURVE448, PSA_ECC_FAMILY_MONTGOMERY, 448 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006251#endif
Valerio Settiacd32c02023-06-29 18:06:29 +02006252 { 0, MBEDTLS_ECP_DP_NONE, 0, 0 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006253};
6254
Gilles Peskine449bd832023-01-11 14:50:10 +01006255int mbedtls_ssl_get_psa_curve_info_from_tls_id(uint16_t tls_id,
Przemek Stekielda4fba62023-06-02 14:52:28 +02006256 psa_key_type_t *type,
Gilles Peskine449bd832023-01-11 14:50:10 +01006257 size_t *bits)
Valerio Setti18c9fed2022-12-30 17:44:24 +01006258{
Gilles Peskine449bd832023-01-11 14:50:10 +01006259 for (int i = 0; tls_id_match_table[i].tls_id != 0; i++) {
6260 if (tls_id_match_table[i].tls_id == tls_id) {
Przemek Stekielda4fba62023-06-02 14:52:28 +02006261 if (type != NULL) {
6262 *type = PSA_KEY_TYPE_ECC_KEY_PAIR(tls_id_match_table[i].psa_family);
Gilles Peskine449bd832023-01-11 14:50:10 +01006263 }
6264 if (bits != NULL) {
Valerio Setti18c9fed2022-12-30 17:44:24 +01006265 *bits = tls_id_match_table[i].bits;
Gilles Peskine449bd832023-01-11 14:50:10 +01006266 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01006267 return PSA_SUCCESS;
6268 }
6269 }
6270
6271 return PSA_ERROR_NOT_SUPPORTED;
6272}
6273
Gilles Peskine449bd832023-01-11 14:50:10 +01006274mbedtls_ecp_group_id mbedtls_ssl_get_ecp_group_id_from_tls_id(uint16_t tls_id)
Valerio Setti18c9fed2022-12-30 17:44:24 +01006275{
Gilles Peskine449bd832023-01-11 14:50:10 +01006276 for (int i = 0; tls_id_match_table[i].tls_id != 0; i++) {
6277 if (tls_id_match_table[i].tls_id == tls_id) {
Valerio Setti18c9fed2022-12-30 17:44:24 +01006278 return tls_id_match_table[i].ecp_group_id;
Gilles Peskine449bd832023-01-11 14:50:10 +01006279 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01006280 }
6281
6282 return MBEDTLS_ECP_DP_NONE;
6283}
6284
Gilles Peskine449bd832023-01-11 14:50:10 +01006285uint16_t mbedtls_ssl_get_tls_id_from_ecp_group_id(mbedtls_ecp_group_id grp_id)
Valerio Setti18c9fed2022-12-30 17:44:24 +01006286{
Gilles Peskine449bd832023-01-11 14:50:10 +01006287 for (int i = 0; tls_id_match_table[i].ecp_group_id != MBEDTLS_ECP_DP_NONE;
6288 i++) {
6289 if (tls_id_match_table[i].ecp_group_id == grp_id) {
Valerio Setti18c9fed2022-12-30 17:44:24 +01006290 return tls_id_match_table[i].tls_id;
Gilles Peskine449bd832023-01-11 14:50:10 +01006291 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01006292 }
6293
6294 return 0;
6295}
6296
Valerio Setti67419f02023-01-04 16:12:42 +01006297#if defined(MBEDTLS_DEBUG_C)
Valerio Settiacd32c02023-06-29 18:06:29 +02006298static const struct {
6299 uint16_t tls_id;
6300 const char *name;
6301} tls_id_curve_name_table[] =
6302{
Valerio Setti54e23792023-07-07 10:49:27 +02006303 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP521R1, "secp521r1" },
6304 { MBEDTLS_SSL_IANA_TLS_GROUP_BP512R1, "brainpoolP512r1" },
6305 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1, "secp384r1" },
6306 { MBEDTLS_SSL_IANA_TLS_GROUP_BP384R1, "brainpoolP384r1" },
6307 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1, "secp256r1" },
6308 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP256K1, "secp256k1" },
6309 { MBEDTLS_SSL_IANA_TLS_GROUP_BP256R1, "brainpoolP256r1" },
6310 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP224R1, "secp224r1" },
6311 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP224K1, "secp224k1" },
6312 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP192R1, "secp192r1" },
6313 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP192K1, "secp192k1" },
6314 { MBEDTLS_SSL_IANA_TLS_GROUP_X25519, "x25519" },
6315 { MBEDTLS_SSL_IANA_TLS_GROUP_X448, "x448" },
Valerio Settiacd32c02023-06-29 18:06:29 +02006316 { 0, NULL },
6317};
6318
Gilles Peskine449bd832023-01-11 14:50:10 +01006319const char *mbedtls_ssl_get_curve_name_from_tls_id(uint16_t tls_id)
Valerio Setti18c9fed2022-12-30 17:44:24 +01006320{
Valerio Settiacd32c02023-06-29 18:06:29 +02006321 for (int i = 0; tls_id_curve_name_table[i].tls_id != 0; i++) {
6322 if (tls_id_curve_name_table[i].tls_id == tls_id) {
6323 return tls_id_curve_name_table[i].name;
Gilles Peskine449bd832023-01-11 14:50:10 +01006324 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01006325 }
6326
6327 return NULL;
6328}
Valerio Setti67419f02023-01-04 16:12:42 +01006329#endif
Valerio Setti18c9fed2022-12-30 17:44:24 +01006330
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006331#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01006332int mbedtls_ssl_check_cert_usage(const mbedtls_x509_crt *cert,
6333 const mbedtls_ssl_ciphersuite_t *ciphersuite,
6334 int cert_endpoint,
6335 uint32_t *flags)
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02006336{
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01006337 int ret = 0;
Dave Rodgmanc37ad442023-11-03 23:36:06 +00006338 unsigned int usage = 0;
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02006339 const char *ext_oid;
6340 size_t ext_len;
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02006341
Gilles Peskine449bd832023-01-11 14:50:10 +01006342 if (cert_endpoint == MBEDTLS_SSL_IS_SERVER) {
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02006343 /* Server part of the key exchange */
Gilles Peskine449bd832023-01-11 14:50:10 +01006344 switch (ciphersuite->key_exchange) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006345 case MBEDTLS_KEY_EXCHANGE_RSA:
6346 case MBEDTLS_KEY_EXCHANGE_RSA_PSK:
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01006347 usage = MBEDTLS_X509_KU_KEY_ENCIPHERMENT;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02006348 break;
6349
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006350 case MBEDTLS_KEY_EXCHANGE_DHE_RSA:
6351 case MBEDTLS_KEY_EXCHANGE_ECDHE_RSA:
6352 case MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA:
6353 usage = MBEDTLS_X509_KU_DIGITAL_SIGNATURE;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02006354 break;
6355
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006356 case MBEDTLS_KEY_EXCHANGE_ECDH_RSA:
6357 case MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA:
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01006358 usage = MBEDTLS_X509_KU_KEY_AGREEMENT;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02006359 break;
6360
6361 /* Don't use default: we want warnings when adding new values */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006362 case MBEDTLS_KEY_EXCHANGE_NONE:
6363 case MBEDTLS_KEY_EXCHANGE_PSK:
6364 case MBEDTLS_KEY_EXCHANGE_DHE_PSK:
6365 case MBEDTLS_KEY_EXCHANGE_ECDHE_PSK:
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +02006366 case MBEDTLS_KEY_EXCHANGE_ECJPAKE:
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02006367 usage = 0;
6368 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006369 } else {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006370 /* Client auth: we only implement rsa_sign and mbedtls_ecdsa_sign for now */
6371 usage = MBEDTLS_X509_KU_DIGITAL_SIGNATURE;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02006372 }
6373
Gilles Peskine449bd832023-01-11 14:50:10 +01006374 if (mbedtls_x509_crt_check_key_usage(cert, usage) != 0) {
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01006375 *flags |= MBEDTLS_X509_BADCERT_KEY_USAGE;
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01006376 ret = -1;
6377 }
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02006378
Gilles Peskine449bd832023-01-11 14:50:10 +01006379 if (cert_endpoint == MBEDTLS_SSL_IS_SERVER) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006380 ext_oid = MBEDTLS_OID_SERVER_AUTH;
Gilles Peskine449bd832023-01-11 14:50:10 +01006381 ext_len = MBEDTLS_OID_SIZE(MBEDTLS_OID_SERVER_AUTH);
6382 } else {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006383 ext_oid = MBEDTLS_OID_CLIENT_AUTH;
Gilles Peskine449bd832023-01-11 14:50:10 +01006384 ext_len = MBEDTLS_OID_SIZE(MBEDTLS_OID_CLIENT_AUTH);
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02006385 }
6386
Gilles Peskine449bd832023-01-11 14:50:10 +01006387 if (mbedtls_x509_crt_check_extended_key_usage(cert, ext_oid, ext_len) != 0) {
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01006388 *flags |= MBEDTLS_X509_BADCERT_EXT_KEY_USAGE;
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01006389 ret = -1;
6390 }
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02006391
Gilles Peskine449bd832023-01-11 14:50:10 +01006392 return ret;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02006393}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006394#endif /* MBEDTLS_X509_CRT_PARSE_C */
Manuel Pégourié-Gonnard3a306b92014-04-29 15:11:17 +02006395
Jerry Yu148165c2021-09-24 23:20:59 +08006396#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01006397int mbedtls_ssl_get_handshake_transcript(mbedtls_ssl_context *ssl,
6398 const mbedtls_md_type_t md,
6399 unsigned char *dst,
6400 size_t dst_len,
6401 size_t *olen)
Jerry Yu148165c2021-09-24 23:20:59 +08006402{
Ronald Cronf6893e12022-01-07 22:09:01 +01006403 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
6404 psa_hash_operation_t *hash_operation_to_clone;
6405 psa_hash_operation_t hash_operation = psa_hash_operation_init();
6406
Jerry Yu148165c2021-09-24 23:20:59 +08006407 *olen = 0;
Ronald Cronf6893e12022-01-07 22:09:01 +01006408
Gilles Peskine449bd832023-01-11 14:50:10 +01006409 switch (md) {
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006410#if defined(MBEDTLS_MD_CAN_SHA384)
Gilles Peskine449bd832023-01-11 14:50:10 +01006411 case MBEDTLS_MD_SHA384:
6412 hash_operation_to_clone = &ssl->handshake->fin_sha384_psa;
6413 break;
Ronald Cronf6893e12022-01-07 22:09:01 +01006414#endif
6415
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006416#if defined(MBEDTLS_MD_CAN_SHA256)
Gilles Peskine449bd832023-01-11 14:50:10 +01006417 case MBEDTLS_MD_SHA256:
6418 hash_operation_to_clone = &ssl->handshake->fin_sha256_psa;
6419 break;
Ronald Cronf6893e12022-01-07 22:09:01 +01006420#endif
6421
Gilles Peskine449bd832023-01-11 14:50:10 +01006422 default:
6423 goto exit;
6424 }
6425
6426 status = psa_hash_clone(hash_operation_to_clone, &hash_operation);
6427 if (status != PSA_SUCCESS) {
Ronald Cronf6893e12022-01-07 22:09:01 +01006428 goto exit;
6429 }
6430
Gilles Peskine449bd832023-01-11 14:50:10 +01006431 status = psa_hash_finish(&hash_operation, dst, dst_len, olen);
6432 if (status != PSA_SUCCESS) {
Ronald Cronf6893e12022-01-07 22:09:01 +01006433 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006434 }
Ronald Cronf6893e12022-01-07 22:09:01 +01006435
6436exit:
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006437#if !defined(MBEDTLS_MD_CAN_SHA384) && \
6438 !defined(MBEDTLS_MD_CAN_SHA256)
Andrzej Kurekeabeb302022-10-17 07:52:51 -04006439 (void) ssl;
6440#endif
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05006441 return PSA_TO_MBEDTLS_ERR(status);
Jerry Yu148165c2021-09-24 23:20:59 +08006442}
6443#else /* MBEDTLS_USE_PSA_CRYPTO */
6444
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006445#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006446MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006447static int ssl_get_handshake_transcript_sha384(mbedtls_ssl_context *ssl,
6448 unsigned char *dst,
6449 size_t dst_len,
6450 size_t *olen)
Jerry Yu24c0ec32021-09-09 14:21:07 +08006451{
Jerry Yu24c0ec32021-09-09 14:21:07 +08006452 int ret;
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01006453 mbedtls_md_context_t sha384;
Jerry Yu24c0ec32021-09-09 14:21:07 +08006454
Gilles Peskine449bd832023-01-11 14:50:10 +01006455 if (dst_len < 48) {
6456 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
6457 }
Jerry Yu24c0ec32021-09-09 14:21:07 +08006458
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01006459 mbedtls_md_init(&sha384);
6460 ret = mbedtls_md_setup(&sha384, mbedtls_md_info_from_type(MBEDTLS_MD_SHA384), 0);
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01006461 if (ret != 0) {
6462 goto exit;
6463 }
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01006464 ret = mbedtls_md_clone(&sha384, &ssl->handshake->fin_sha384);
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01006465 if (ret != 0) {
6466 goto exit;
6467 }
Jerry Yu24c0ec32021-09-09 14:21:07 +08006468
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01006469 if ((ret = mbedtls_md_finish(&sha384, dst)) != 0) {
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01006470 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_finish", ret);
Jerry Yu24c0ec32021-09-09 14:21:07 +08006471 goto exit;
6472 }
6473
6474 *olen = 48;
6475
6476exit:
6477
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01006478 mbedtls_md_free(&sha384);
Gilles Peskine449bd832023-01-11 14:50:10 +01006479 return ret;
Jerry Yu24c0ec32021-09-09 14:21:07 +08006480}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006481#endif /* MBEDTLS_MD_CAN_SHA384 */
Jerry Yu24c0ec32021-09-09 14:21:07 +08006482
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006483#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006484MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006485static int ssl_get_handshake_transcript_sha256(mbedtls_ssl_context *ssl,
6486 unsigned char *dst,
6487 size_t dst_len,
6488 size_t *olen)
Jerry Yu24c0ec32021-09-09 14:21:07 +08006489{
Jerry Yu24c0ec32021-09-09 14:21:07 +08006490 int ret;
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01006491 mbedtls_md_context_t sha256;
Jerry Yu24c0ec32021-09-09 14:21:07 +08006492
Gilles Peskine449bd832023-01-11 14:50:10 +01006493 if (dst_len < 32) {
6494 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
6495 }
Jerry Yu24c0ec32021-09-09 14:21:07 +08006496
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01006497 mbedtls_md_init(&sha256);
6498 ret = mbedtls_md_setup(&sha256, mbedtls_md_info_from_type(MBEDTLS_MD_SHA256), 0);
6499 if (ret != 0) {
6500 goto exit;
6501 }
6502 ret = mbedtls_md_clone(&sha256, &ssl->handshake->fin_sha256);
6503 if (ret != 0) {
6504 goto exit;
6505 }
Jerry Yuc5aef882021-12-23 20:15:02 +08006506
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01006507 if ((ret = mbedtls_md_finish(&sha256, dst)) != 0) {
6508 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_finish", ret);
Jerry Yu24c0ec32021-09-09 14:21:07 +08006509 goto exit;
6510 }
6511
6512 *olen = 32;
6513
6514exit:
6515
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01006516 mbedtls_md_free(&sha256);
Gilles Peskine449bd832023-01-11 14:50:10 +01006517 return ret;
Jerry Yu24c0ec32021-09-09 14:21:07 +08006518}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006519#endif /* MBEDTLS_MD_CAN_SHA256 */
Jerry Yu24c0ec32021-09-09 14:21:07 +08006520
Gilles Peskine449bd832023-01-11 14:50:10 +01006521int mbedtls_ssl_get_handshake_transcript(mbedtls_ssl_context *ssl,
6522 const mbedtls_md_type_t md,
6523 unsigned char *dst,
6524 size_t dst_len,
6525 size_t *olen)
Jerry Yu24c0ec32021-09-09 14:21:07 +08006526{
Gilles Peskine449bd832023-01-11 14:50:10 +01006527 switch (md) {
Jerry Yuc1ddeef2021-10-08 15:14:45 +08006528
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006529#if defined(MBEDTLS_MD_CAN_SHA384)
Gilles Peskine449bd832023-01-11 14:50:10 +01006530 case MBEDTLS_MD_SHA384:
6531 return ssl_get_handshake_transcript_sha384(ssl, dst, dst_len, olen);
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006532#endif /* MBEDTLS_MD_CAN_SHA384*/
Jerry Yuc1ddeef2021-10-08 15:14:45 +08006533
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006534#if defined(MBEDTLS_MD_CAN_SHA256)
Gilles Peskine449bd832023-01-11 14:50:10 +01006535 case MBEDTLS_MD_SHA256:
6536 return ssl_get_handshake_transcript_sha256(ssl, dst, dst_len, olen);
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006537#endif /* MBEDTLS_MD_CAN_SHA256*/
Jerry Yuc1ddeef2021-10-08 15:14:45 +08006538
Gilles Peskine449bd832023-01-11 14:50:10 +01006539 default:
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006540#if !defined(MBEDTLS_MD_CAN_SHA384) && \
6541 !defined(MBEDTLS_MD_CAN_SHA256)
Gilles Peskine449bd832023-01-11 14:50:10 +01006542 (void) ssl;
6543 (void) dst;
6544 (void) dst_len;
6545 (void) olen;
Andrzej Kurek409248a2022-10-24 10:33:21 -04006546#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01006547 break;
Jerry Yuc1ddeef2021-10-08 15:14:45 +08006548 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006549 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yu24c0ec32021-09-09 14:21:07 +08006550}
XiaokangQian647719a2021-12-07 09:16:29 +00006551
Jerry Yu148165c2021-09-24 23:20:59 +08006552#endif /* !MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu24c0ec32021-09-09 14:21:07 +08006553
Ronald Crone68ab4f2022-10-05 12:46:29 +02006554#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Gabor Mezei078e8032022-04-27 21:17:56 +02006555/* mbedtls_ssl_parse_sig_alg_ext()
6556 *
6557 * The `extension_data` field of signature algorithm contains a `SignatureSchemeList`
6558 * value (TLS 1.3 RFC8446):
6559 * enum {
6560 * ....
6561 * ecdsa_secp256r1_sha256( 0x0403 ),
6562 * ecdsa_secp384r1_sha384( 0x0503 ),
6563 * ecdsa_secp521r1_sha512( 0x0603 ),
6564 * ....
6565 * } SignatureScheme;
6566 *
6567 * struct {
6568 * SignatureScheme supported_signature_algorithms<2..2^16-2>;
6569 * } SignatureSchemeList;
6570 *
6571 * The `extension_data` field of signature algorithm contains a `SignatureAndHashAlgorithm`
6572 * value (TLS 1.2 RFC5246):
6573 * enum {
6574 * none(0), md5(1), sha1(2), sha224(3), sha256(4), sha384(5),
6575 * sha512(6), (255)
6576 * } HashAlgorithm;
6577 *
6578 * enum { anonymous(0), rsa(1), dsa(2), ecdsa(3), (255) }
6579 * SignatureAlgorithm;
6580 *
6581 * struct {
6582 * HashAlgorithm hash;
6583 * SignatureAlgorithm signature;
6584 * } SignatureAndHashAlgorithm;
6585 *
6586 * SignatureAndHashAlgorithm
6587 * supported_signature_algorithms<2..2^16-2>;
6588 *
6589 * The TLS 1.3 signature algorithm extension was defined to be a compatible
6590 * generalization of the TLS 1.2 signature algorithm extension.
6591 * `SignatureAndHashAlgorithm` field of TLS 1.2 can be represented by
6592 * `SignatureScheme` field of TLS 1.3
6593 *
6594 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006595int mbedtls_ssl_parse_sig_alg_ext(mbedtls_ssl_context *ssl,
6596 const unsigned char *buf,
6597 const unsigned char *end)
Gabor Mezei078e8032022-04-27 21:17:56 +02006598{
6599 const unsigned char *p = buf;
6600 size_t supported_sig_algs_len = 0;
6601 const unsigned char *supported_sig_algs_end;
6602 uint16_t sig_alg;
6603 uint32_t common_idx = 0;
6604
Gilles Peskine449bd832023-01-11 14:50:10 +01006605 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
6606 supported_sig_algs_len = MBEDTLS_GET_UINT16_BE(p, 0);
Gabor Mezei078e8032022-04-27 21:17:56 +02006607 p += 2;
6608
Gilles Peskine449bd832023-01-11 14:50:10 +01006609 memset(ssl->handshake->received_sig_algs, 0,
6610 sizeof(ssl->handshake->received_sig_algs));
Gabor Mezei078e8032022-04-27 21:17:56 +02006611
Gilles Peskine449bd832023-01-11 14:50:10 +01006612 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, supported_sig_algs_len);
Gabor Mezei078e8032022-04-27 21:17:56 +02006613 supported_sig_algs_end = p + supported_sig_algs_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01006614 while (p < supported_sig_algs_end) {
6615 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, supported_sig_algs_end, 2);
6616 sig_alg = MBEDTLS_GET_UINT16_BE(p, 0);
Gabor Mezei078e8032022-04-27 21:17:56 +02006617 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01006618 MBEDTLS_SSL_DEBUG_MSG(4, ("received signature algorithm: 0x%x %s",
6619 sig_alg,
6620 mbedtls_ssl_sig_alg_to_str(sig_alg)));
Jerry Yu2fe6c632022-06-29 10:02:38 +08006621#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01006622 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_2 &&
6623 (!(mbedtls_ssl_sig_alg_is_supported(ssl, sig_alg) &&
6624 mbedtls_ssl_sig_alg_is_offered(ssl, sig_alg)))) {
Gabor Mezei078e8032022-04-27 21:17:56 +02006625 continue;
Jerry Yu2fe6c632022-06-29 10:02:38 +08006626 }
6627#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gabor Mezei078e8032022-04-27 21:17:56 +02006628
Gilles Peskine449bd832023-01-11 14:50:10 +01006629 MBEDTLS_SSL_DEBUG_MSG(4, ("valid signature algorithm: %s",
6630 mbedtls_ssl_sig_alg_to_str(sig_alg)));
Gabor Mezei078e8032022-04-27 21:17:56 +02006631
Gilles Peskine449bd832023-01-11 14:50:10 +01006632 if (common_idx + 1 < MBEDTLS_RECEIVED_SIG_ALGS_SIZE) {
Gabor Mezei078e8032022-04-27 21:17:56 +02006633 ssl->handshake->received_sig_algs[common_idx] = sig_alg;
6634 common_idx += 1;
6635 }
6636 }
6637 /* Check that we consumed all the message. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006638 if (p != end) {
6639 MBEDTLS_SSL_DEBUG_MSG(1,
6640 ("Signature algorithms extension length misaligned"));
6641 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR,
6642 MBEDTLS_ERR_SSL_DECODE_ERROR);
6643 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Gabor Mezei078e8032022-04-27 21:17:56 +02006644 }
6645
Gilles Peskine449bd832023-01-11 14:50:10 +01006646 if (common_idx == 0) {
6647 MBEDTLS_SSL_DEBUG_MSG(3, ("no signature algorithm in common"));
6648 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE,
6649 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE);
6650 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Gabor Mezei078e8032022-04-27 21:17:56 +02006651 }
6652
Gabor Mezei15b95a62022-05-09 16:37:58 +02006653 ssl->handshake->received_sig_algs[common_idx] = MBEDTLS_TLS_SIG_NONE;
Gilles Peskine449bd832023-01-11 14:50:10 +01006654 return 0;
Gabor Mezei078e8032022-04-27 21:17:56 +02006655}
6656
Ronald Crone68ab4f2022-10-05 12:46:29 +02006657#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Gabor Mezei078e8032022-04-27 21:17:56 +02006658
Jerry Yudc7bd172022-02-17 13:44:15 +08006659#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
6660
6661#if defined(MBEDTLS_USE_PSA_CRYPTO)
6662
Gilles Peskine449bd832023-01-11 14:50:10 +01006663static psa_status_t setup_psa_key_derivation(psa_key_derivation_operation_t *derivation,
6664 mbedtls_svc_key_id_t key,
6665 psa_algorithm_t alg,
6666 const unsigned char *raw_psk, size_t raw_psk_length,
6667 const unsigned char *seed, size_t seed_length,
6668 const unsigned char *label, size_t label_length,
6669 const unsigned char *other_secret,
6670 size_t other_secret_length,
6671 size_t capacity)
Jerry Yudc7bd172022-02-17 13:44:15 +08006672{
6673 psa_status_t status;
6674
Gilles Peskine449bd832023-01-11 14:50:10 +01006675 status = psa_key_derivation_setup(derivation, alg);
6676 if (status != PSA_SUCCESS) {
6677 return status;
6678 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006679
Gilles Peskine449bd832023-01-11 14:50:10 +01006680 if (PSA_ALG_IS_TLS12_PRF(alg) || PSA_ALG_IS_TLS12_PSK_TO_MS(alg)) {
6681 status = psa_key_derivation_input_bytes(derivation,
6682 PSA_KEY_DERIVATION_INPUT_SEED,
6683 seed, seed_length);
6684 if (status != PSA_SUCCESS) {
6685 return status;
Przemek Stekiel1f027032022-04-05 17:12:11 +02006686 }
6687
Gilles Peskine449bd832023-01-11 14:50:10 +01006688 if (other_secret != NULL) {
6689 status = psa_key_derivation_input_bytes(derivation,
6690 PSA_KEY_DERIVATION_INPUT_OTHER_SECRET,
6691 other_secret, other_secret_length);
6692 if (status != PSA_SUCCESS) {
6693 return status;
6694 }
6695 }
6696
6697 if (mbedtls_svc_key_id_is_null(key)) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006698 status = psa_key_derivation_input_bytes(
6699 derivation, PSA_KEY_DERIVATION_INPUT_SECRET,
Gilles Peskine449bd832023-01-11 14:50:10 +01006700 raw_psk, raw_psk_length);
6701 } else {
Jerry Yudc7bd172022-02-17 13:44:15 +08006702 status = psa_key_derivation_input_key(
Gilles Peskine449bd832023-01-11 14:50:10 +01006703 derivation, PSA_KEY_DERIVATION_INPUT_SECRET, key);
Jerry Yudc7bd172022-02-17 13:44:15 +08006704 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006705 if (status != PSA_SUCCESS) {
6706 return status;
6707 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006708
Gilles Peskine449bd832023-01-11 14:50:10 +01006709 status = psa_key_derivation_input_bytes(derivation,
6710 PSA_KEY_DERIVATION_INPUT_LABEL,
6711 label, label_length);
6712 if (status != PSA_SUCCESS) {
6713 return status;
6714 }
6715 } else {
6716 return PSA_ERROR_NOT_SUPPORTED;
Jerry Yudc7bd172022-02-17 13:44:15 +08006717 }
6718
Gilles Peskine449bd832023-01-11 14:50:10 +01006719 status = psa_key_derivation_set_capacity(derivation, capacity);
6720 if (status != PSA_SUCCESS) {
6721 return status;
6722 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006723
Gilles Peskine449bd832023-01-11 14:50:10 +01006724 return PSA_SUCCESS;
Jerry Yudc7bd172022-02-17 13:44:15 +08006725}
6726
Andrzej Kurek57d10632022-10-24 10:32:01 -04006727#if defined(PSA_WANT_ALG_SHA_384) || \
6728 defined(PSA_WANT_ALG_SHA_256)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006729MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006730static int tls_prf_generic(mbedtls_md_type_t md_type,
6731 const unsigned char *secret, size_t slen,
6732 const char *label,
6733 const unsigned char *random, size_t rlen,
6734 unsigned char *dstbuf, size_t dlen)
Jerry Yudc7bd172022-02-17 13:44:15 +08006735{
6736 psa_status_t status;
6737 psa_algorithm_t alg;
6738 mbedtls_svc_key_id_t master_key = MBEDTLS_SVC_KEY_ID_INIT;
6739 psa_key_derivation_operation_t derivation =
6740 PSA_KEY_DERIVATION_OPERATION_INIT;
6741
Gilles Peskine449bd832023-01-11 14:50:10 +01006742 if (md_type == MBEDTLS_MD_SHA384) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006743 alg = PSA_ALG_TLS12_PRF(PSA_ALG_SHA_384);
Gilles Peskine449bd832023-01-11 14:50:10 +01006744 } else {
Jerry Yudc7bd172022-02-17 13:44:15 +08006745 alg = PSA_ALG_TLS12_PRF(PSA_ALG_SHA_256);
Gilles Peskine449bd832023-01-11 14:50:10 +01006746 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006747
6748 /* Normally a "secret" should be long enough to be impossible to
6749 * find by brute force, and in particular should not be empty. But
6750 * this PRF is also used to derive an IV, in particular in EAP-TLS,
6751 * and for this use case it makes sense to have a 0-length "secret".
6752 * Since the key API doesn't allow importing a key of length 0,
6753 * keep master_key=0, which setup_psa_key_derivation() understands
6754 * to mean a 0-length "secret" input. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006755 if (slen != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006756 psa_key_attributes_t key_attributes = psa_key_attributes_init();
Gilles Peskine449bd832023-01-11 14:50:10 +01006757 psa_set_key_usage_flags(&key_attributes, PSA_KEY_USAGE_DERIVE);
6758 psa_set_key_algorithm(&key_attributes, alg);
6759 psa_set_key_type(&key_attributes, PSA_KEY_TYPE_DERIVE);
Jerry Yudc7bd172022-02-17 13:44:15 +08006760
Gilles Peskine449bd832023-01-11 14:50:10 +01006761 status = psa_import_key(&key_attributes, secret, slen, &master_key);
6762 if (status != PSA_SUCCESS) {
6763 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
6764 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006765 }
6766
Gilles Peskine449bd832023-01-11 14:50:10 +01006767 status = setup_psa_key_derivation(&derivation,
6768 master_key, alg,
6769 NULL, 0,
6770 random, rlen,
6771 (unsigned char const *) label,
6772 (size_t) strlen(label),
6773 NULL, 0,
6774 dlen);
6775 if (status != PSA_SUCCESS) {
6776 psa_key_derivation_abort(&derivation);
6777 psa_destroy_key(master_key);
6778 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yudc7bd172022-02-17 13:44:15 +08006779 }
6780
Gilles Peskine449bd832023-01-11 14:50:10 +01006781 status = psa_key_derivation_output_bytes(&derivation, dstbuf, dlen);
6782 if (status != PSA_SUCCESS) {
6783 psa_key_derivation_abort(&derivation);
6784 psa_destroy_key(master_key);
6785 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yudc7bd172022-02-17 13:44:15 +08006786 }
6787
Gilles Peskine449bd832023-01-11 14:50:10 +01006788 status = psa_key_derivation_abort(&derivation);
6789 if (status != PSA_SUCCESS) {
6790 psa_destroy_key(master_key);
6791 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yudc7bd172022-02-17 13:44:15 +08006792 }
6793
Gilles Peskine449bd832023-01-11 14:50:10 +01006794 if (!mbedtls_svc_key_id_is_null(master_key)) {
6795 status = psa_destroy_key(master_key);
6796 }
6797 if (status != PSA_SUCCESS) {
6798 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
6799 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006800
Gilles Peskine449bd832023-01-11 14:50:10 +01006801 return 0;
Jerry Yudc7bd172022-02-17 13:44:15 +08006802}
Andrzej Kurek57d10632022-10-24 10:32:01 -04006803#endif /* PSA_WANT_ALG_SHA_256 || PSA_WANT_ALG_SHA_384 */
Jerry Yudc7bd172022-02-17 13:44:15 +08006804#else /* MBEDTLS_USE_PSA_CRYPTO */
6805
Andrzej Kurek57d10632022-10-24 10:32:01 -04006806#if defined(MBEDTLS_MD_C) && \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006807 (defined(MBEDTLS_MD_CAN_SHA256) || \
6808 defined(MBEDTLS_MD_CAN_SHA384))
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006809MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006810static int tls_prf_generic(mbedtls_md_type_t md_type,
6811 const unsigned char *secret, size_t slen,
6812 const char *label,
6813 const unsigned char *random, size_t rlen,
6814 unsigned char *dstbuf, size_t dlen)
Jerry Yudc7bd172022-02-17 13:44:15 +08006815{
6816 size_t nb;
6817 size_t i, j, k, md_len;
6818 unsigned char *tmp;
6819 size_t tmp_len = 0;
6820 unsigned char h_i[MBEDTLS_MD_MAX_SIZE];
6821 const mbedtls_md_info_t *md_info;
6822 mbedtls_md_context_t md_ctx;
6823 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6824
Gilles Peskine449bd832023-01-11 14:50:10 +01006825 mbedtls_md_init(&md_ctx);
Jerry Yudc7bd172022-02-17 13:44:15 +08006826
Gilles Peskine449bd832023-01-11 14:50:10 +01006827 if ((md_info = mbedtls_md_info_from_type(md_type)) == NULL) {
6828 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
6829 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006830
Gilles Peskine449bd832023-01-11 14:50:10 +01006831 md_len = mbedtls_md_get_size(md_info);
Jerry Yudc7bd172022-02-17 13:44:15 +08006832
Gilles Peskine449bd832023-01-11 14:50:10 +01006833 tmp_len = md_len + strlen(label) + rlen;
6834 tmp = mbedtls_calloc(1, tmp_len);
6835 if (tmp == NULL) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006836 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
6837 goto exit;
6838 }
6839
Gilles Peskine449bd832023-01-11 14:50:10 +01006840 nb = strlen(label);
6841 memcpy(tmp + md_len, label, nb);
6842 memcpy(tmp + md_len + nb, random, rlen);
Jerry Yudc7bd172022-02-17 13:44:15 +08006843 nb += rlen;
6844
6845 /*
6846 * Compute P_<hash>(secret, label + random)[0..dlen]
6847 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006848 if ((ret = mbedtls_md_setup(&md_ctx, md_info, 1)) != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006849 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006850 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006851
Gilles Peskine449bd832023-01-11 14:50:10 +01006852 ret = mbedtls_md_hmac_starts(&md_ctx, secret, slen);
6853 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006854 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006855 }
6856 ret = mbedtls_md_hmac_update(&md_ctx, tmp + md_len, nb);
6857 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006858 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006859 }
6860 ret = mbedtls_md_hmac_finish(&md_ctx, tmp);
6861 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006862 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006863 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006864
Gilles Peskine449bd832023-01-11 14:50:10 +01006865 for (i = 0; i < dlen; i += md_len) {
6866 ret = mbedtls_md_hmac_reset(&md_ctx);
6867 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006868 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006869 }
6870 ret = mbedtls_md_hmac_update(&md_ctx, tmp, md_len + nb);
6871 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006872 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006873 }
6874 ret = mbedtls_md_hmac_finish(&md_ctx, h_i);
6875 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006876 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006877 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006878
Gilles Peskine449bd832023-01-11 14:50:10 +01006879 ret = mbedtls_md_hmac_reset(&md_ctx);
6880 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006881 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006882 }
6883 ret = mbedtls_md_hmac_update(&md_ctx, tmp, md_len);
6884 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006885 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006886 }
6887 ret = mbedtls_md_hmac_finish(&md_ctx, tmp);
6888 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006889 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006890 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006891
Gilles Peskine449bd832023-01-11 14:50:10 +01006892 k = (i + md_len > dlen) ? dlen % md_len : md_len;
Jerry Yudc7bd172022-02-17 13:44:15 +08006893
Gilles Peskine449bd832023-01-11 14:50:10 +01006894 for (j = 0; j < k; j++) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006895 dstbuf[i + j] = h_i[j];
Gilles Peskine449bd832023-01-11 14:50:10 +01006896 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006897 }
6898
6899exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01006900 mbedtls_md_free(&md_ctx);
Jerry Yudc7bd172022-02-17 13:44:15 +08006901
Gilles Peskine449bd832023-01-11 14:50:10 +01006902 if (tmp != NULL) {
6903 mbedtls_platform_zeroize(tmp, tmp_len);
6904 }
Dave Rodgman29b9b2b2022-11-01 16:08:14 +00006905
Gilles Peskine449bd832023-01-11 14:50:10 +01006906 mbedtls_platform_zeroize(h_i, sizeof(h_i));
Jerry Yudc7bd172022-02-17 13:44:15 +08006907
Gilles Peskine449bd832023-01-11 14:50:10 +01006908 mbedtls_free(tmp);
Jerry Yudc7bd172022-02-17 13:44:15 +08006909
Gilles Peskine449bd832023-01-11 14:50:10 +01006910 return ret;
Jerry Yudc7bd172022-02-17 13:44:15 +08006911}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006912#endif /* MBEDTLS_MD_C && ( MBEDTLS_MD_CAN_SHA256 || MBEDTLS_MD_CAN_SHA384 ) */
Jerry Yudc7bd172022-02-17 13:44:15 +08006913#endif /* MBEDTLS_USE_PSA_CRYPTO */
6914
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006915#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006916MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006917static int tls_prf_sha256(const unsigned char *secret, size_t slen,
6918 const char *label,
6919 const unsigned char *random, size_t rlen,
6920 unsigned char *dstbuf, size_t dlen)
Jerry Yudc7bd172022-02-17 13:44:15 +08006921{
Gilles Peskine449bd832023-01-11 14:50:10 +01006922 return tls_prf_generic(MBEDTLS_MD_SHA256, secret, slen,
6923 label, random, rlen, dstbuf, dlen);
Jerry Yudc7bd172022-02-17 13:44:15 +08006924}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006925#endif /* MBEDTLS_MD_CAN_SHA256*/
Jerry Yudc7bd172022-02-17 13:44:15 +08006926
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006927#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006928MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006929static int tls_prf_sha384(const unsigned char *secret, size_t slen,
6930 const char *label,
6931 const unsigned char *random, size_t rlen,
6932 unsigned char *dstbuf, size_t dlen)
Jerry Yudc7bd172022-02-17 13:44:15 +08006933{
Gilles Peskine449bd832023-01-11 14:50:10 +01006934 return tls_prf_generic(MBEDTLS_MD_SHA384, secret, slen,
6935 label, random, rlen, dstbuf, dlen);
Jerry Yudc7bd172022-02-17 13:44:15 +08006936}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006937#endif /* MBEDTLS_MD_CAN_SHA384*/
Jerry Yudc7bd172022-02-17 13:44:15 +08006938
Jerry Yuf009d862022-02-17 14:01:37 +08006939/*
6940 * Set appropriate PRF function and other SSL / TLS1.2 functions
6941 *
6942 * Inputs:
Jerry Yuf009d862022-02-17 14:01:37 +08006943 * - hash associated with the ciphersuite (only used by TLS 1.2)
6944 *
6945 * Outputs:
6946 * - the tls_prf, calc_verify and calc_finished members of handshake structure
6947 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006948MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006949static int ssl_set_handshake_prfs(mbedtls_ssl_handshake_params *handshake,
6950 mbedtls_md_type_t hash)
Jerry Yuf009d862022-02-17 14:01:37 +08006951{
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006952#if defined(MBEDTLS_MD_CAN_SHA384)
Gilles Peskine449bd832023-01-11 14:50:10 +01006953 if (hash == MBEDTLS_MD_SHA384) {
Jerry Yuf009d862022-02-17 14:01:37 +08006954 handshake->tls_prf = tls_prf_sha384;
6955 handshake->calc_verify = ssl_calc_verify_tls_sha384;
6956 handshake->calc_finished = ssl_calc_finished_tls_sha384;
Gilles Peskine449bd832023-01-11 14:50:10 +01006957 } else
Jerry Yuf009d862022-02-17 14:01:37 +08006958#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006959#if defined(MBEDTLS_MD_CAN_SHA256)
Jerry Yuf009d862022-02-17 14:01:37 +08006960 {
Ronald Cron81591aa2022-03-07 09:05:51 +01006961 (void) hash;
Jerry Yuf009d862022-02-17 14:01:37 +08006962 handshake->tls_prf = tls_prf_sha256;
6963 handshake->calc_verify = ssl_calc_verify_tls_sha256;
6964 handshake->calc_finished = ssl_calc_finished_tls_sha256;
6965 }
Ronald Cron81591aa2022-03-07 09:05:51 +01006966#else
Jerry Yuf009d862022-02-17 14:01:37 +08006967 {
Jerry Yuf009d862022-02-17 14:01:37 +08006968 (void) handshake;
Ronald Cron81591aa2022-03-07 09:05:51 +01006969 (void) hash;
Gilles Peskine449bd832023-01-11 14:50:10 +01006970 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yuf009d862022-02-17 14:01:37 +08006971 }
Ronald Cron81591aa2022-03-07 09:05:51 +01006972#endif
Jerry Yuf009d862022-02-17 14:01:37 +08006973
Gilles Peskine449bd832023-01-11 14:50:10 +01006974 return 0;
Jerry Yuf009d862022-02-17 14:01:37 +08006975}
Jerry Yud6ab2352022-02-17 14:03:43 +08006976
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006977/*
6978 * Compute master secret if needed
6979 *
6980 * Parameters:
6981 * [in/out] handshake
6982 * [in] resume, premaster, extended_ms, calc_verify, tls_prf
6983 * (PSA-PSK) ciphersuite_info, psk_opaque
6984 * [out] premaster (cleared)
6985 * [out] master
6986 * [in] ssl: optionally used for debugging, EMS and PSA-PSK
6987 * debug: conf->f_dbg, conf->p_dbg
6988 * EMS: passed to calc_verify (debug + session_negotiate)
Ronald Crona25cf582022-03-07 11:10:36 +01006989 * PSA-PSA: conf
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006990 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006991MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006992static int ssl_compute_master(mbedtls_ssl_handshake_params *handshake,
6993 unsigned char *master,
6994 const mbedtls_ssl_context *ssl)
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006995{
6996 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6997
6998 /* cf. RFC 5246, Section 8.1:
6999 * "The master secret is always exactly 48 bytes in length." */
7000 size_t const master_secret_len = 48;
7001
7002#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
7003 unsigned char session_hash[48];
7004#endif /* MBEDTLS_SSL_EXTENDED_MASTER_SECRET */
7005
7006 /* The label for the KDF used for key expansion.
7007 * This is either "master secret" or "extended master secret"
7008 * depending on whether the Extended Master Secret extension
7009 * is used. */
7010 char const *lbl = "master secret";
7011
Przemek Stekielae4ed302022-04-05 17:15:55 +02007012 /* The seed for the KDF used for key expansion.
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007013 * - If the Extended Master Secret extension is not used,
7014 * this is ClientHello.Random + ServerHello.Random
7015 * (see Sect. 8.1 in RFC 5246).
7016 * - If the Extended Master Secret extension is used,
7017 * this is the transcript of the handshake so far.
7018 * (see Sect. 4 in RFC 7627). */
Przemek Stekielae4ed302022-04-05 17:15:55 +02007019 unsigned char const *seed = handshake->randbytes;
7020 size_t seed_len = 64;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007021
7022#if !defined(MBEDTLS_DEBUG_C) && \
7023 !defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET) && \
7024 !(defined(MBEDTLS_USE_PSA_CRYPTO) && \
Gilles Peskine449bd832023-01-11 14:50:10 +01007025 defined(MBEDTLS_KEY_EXCHANGE_PSK_ENABLED))
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007026 ssl = NULL; /* make sure we don't use it except for those cases */
7027 (void) ssl;
7028#endif
7029
Gilles Peskine449bd832023-01-11 14:50:10 +01007030 if (handshake->resume != 0) {
7031 MBEDTLS_SSL_DEBUG_MSG(3, ("no premaster (session resumed)"));
7032 return 0;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007033 }
7034
7035#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
Gilles Peskine449bd832023-01-11 14:50:10 +01007036 if (handshake->extended_ms == MBEDTLS_SSL_EXTENDED_MS_ENABLED) {
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007037 lbl = "extended master secret";
Przemek Stekielae4ed302022-04-05 17:15:55 +02007038 seed = session_hash;
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01007039 ret = handshake->calc_verify(ssl, session_hash, &seed_len);
7040 if (ret != 0) {
7041 MBEDTLS_SSL_DEBUG_RET(1, "calc_verify", ret);
7042 }
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007043
Gilles Peskine449bd832023-01-11 14:50:10 +01007044 MBEDTLS_SSL_DEBUG_BUF(3, "session hash for extended master secret",
7045 session_hash, seed_len);
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007046 }
Przemek Stekiel169bf0b2022-04-29 07:53:29 +02007047#endif /* MBEDTLS_SSL_EXTENDED_MASTER_SECRET */
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007048
Przemek Stekiel99114f32022-04-22 11:20:09 +02007049#if defined(MBEDTLS_USE_PSA_CRYPTO) && \
Przemek Stekiel8a4b7fd2022-04-28 09:22:22 +02007050 defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007051 if (mbedtls_ssl_ciphersuite_uses_psk(handshake->ciphersuite_info) == 1) {
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007052 /* Perform PSK-to-MS expansion in a single step. */
7053 psa_status_t status;
7054 psa_algorithm_t alg;
7055 mbedtls_svc_key_id_t psk;
7056 psa_key_derivation_operation_t derivation =
7057 PSA_KEY_DERIVATION_OPERATION_INIT;
Dave Rodgman2eab4622023-10-05 13:30:37 +01007058 mbedtls_md_type_t hash_alg = (mbedtls_md_type_t) handshake->ciphersuite_info->mac;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007059
Gilles Peskine449bd832023-01-11 14:50:10 +01007060 MBEDTLS_SSL_DEBUG_MSG(2, ("perform PSA-based PSK-to-MS expansion"));
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007061
Gilles Peskine449bd832023-01-11 14:50:10 +01007062 psk = mbedtls_ssl_get_opaque_psk(ssl);
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007063
Gilles Peskine449bd832023-01-11 14:50:10 +01007064 if (hash_alg == MBEDTLS_MD_SHA384) {
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007065 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_384);
Gilles Peskine449bd832023-01-11 14:50:10 +01007066 } else {
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007067 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_256);
Gilles Peskine449bd832023-01-11 14:50:10 +01007068 }
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007069
Przemek Stekiel51a1f362022-04-13 08:57:06 +02007070 size_t other_secret_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01007071 unsigned char *other_secret = NULL;
Przemek Stekielc2033402022-04-05 17:19:41 +02007072
Gilles Peskine449bd832023-01-11 14:50:10 +01007073 switch (handshake->ciphersuite_info->key_exchange) {
Przemek Stekiel19b80f82022-04-14 08:29:31 +02007074 /* Provide other secret.
Przemek Stekiel51a1f362022-04-13 08:57:06 +02007075 * Other secret is stored in premaster, where first 2 bytes hold the
Przemek Stekiel19b80f82022-04-14 08:29:31 +02007076 * length of the other key.
Przemek Stekielc2033402022-04-05 17:19:41 +02007077 */
Przemek Stekiel19b80f82022-04-14 08:29:31 +02007078 case MBEDTLS_KEY_EXCHANGE_RSA_PSK:
Przemek Stekiel8abcee92022-04-28 09:16:28 +02007079 /* For RSA-PSK other key length is always 48 bytes. */
Przemek Stekiel19b80f82022-04-14 08:29:31 +02007080 other_secret_len = 48;
7081 other_secret = handshake->premaster + 2;
7082 break;
7083 case MBEDTLS_KEY_EXCHANGE_ECDHE_PSK:
Przemek Stekielb293aaa2022-04-19 12:22:38 +02007084 case MBEDTLS_KEY_EXCHANGE_DHE_PSK:
Przemek Stekiel19b80f82022-04-14 08:29:31 +02007085 other_secret_len = MBEDTLS_GET_UINT16_BE(handshake->premaster, 0);
7086 other_secret = handshake->premaster + 2;
7087 break;
7088 default:
7089 break;
Przemek Stekielc2033402022-04-05 17:19:41 +02007090 }
7091
Gilles Peskine449bd832023-01-11 14:50:10 +01007092 status = setup_psa_key_derivation(&derivation, psk, alg,
7093 ssl->conf->psk, ssl->conf->psk_len,
7094 seed, seed_len,
7095 (unsigned char const *) lbl,
7096 (size_t) strlen(lbl),
7097 other_secret, other_secret_len,
7098 master_secret_len);
7099 if (status != PSA_SUCCESS) {
7100 psa_key_derivation_abort(&derivation);
7101 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007102 }
7103
Gilles Peskine449bd832023-01-11 14:50:10 +01007104 status = psa_key_derivation_output_bytes(&derivation,
7105 master,
7106 master_secret_len);
7107 if (status != PSA_SUCCESS) {
7108 psa_key_derivation_abort(&derivation);
7109 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007110 }
7111
Gilles Peskine449bd832023-01-11 14:50:10 +01007112 status = psa_key_derivation_abort(&derivation);
7113 if (status != PSA_SUCCESS) {
7114 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
7115 }
7116 } else
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007117#endif
7118 {
Neil Armstrongca7d5062022-05-31 14:43:23 +02007119#if defined(MBEDTLS_USE_PSA_CRYPTO) && \
Gilles Peskine449bd832023-01-11 14:50:10 +01007120 defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
7121 if (handshake->ciphersuite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_ECJPAKE) {
Neil Armstrongca7d5062022-05-31 14:43:23 +02007122 psa_status_t status;
7123 psa_algorithm_t alg = PSA_ALG_TLS12_ECJPAKE_TO_PMS;
7124 psa_key_derivation_operation_t derivation =
7125 PSA_KEY_DERIVATION_OPERATION_INIT;
7126
Gilles Peskine449bd832023-01-11 14:50:10 +01007127 MBEDTLS_SSL_DEBUG_MSG(2, ("perform PSA-based PMS KDF for ECJPAKE"));
Neil Armstrongca7d5062022-05-31 14:43:23 +02007128
7129 handshake->pmslen = PSA_TLS12_ECJPAKE_TO_PMS_DATA_SIZE;
7130
Gilles Peskine449bd832023-01-11 14:50:10 +01007131 status = psa_key_derivation_setup(&derivation, alg);
7132 if (status != PSA_SUCCESS) {
7133 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Neil Armstrongca7d5062022-05-31 14:43:23 +02007134 }
7135
Gilles Peskine449bd832023-01-11 14:50:10 +01007136 status = psa_key_derivation_set_capacity(&derivation,
7137 PSA_TLS12_ECJPAKE_TO_PMS_DATA_SIZE);
7138 if (status != PSA_SUCCESS) {
7139 psa_key_derivation_abort(&derivation);
7140 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Neil Armstrongca7d5062022-05-31 14:43:23 +02007141 }
7142
Gilles Peskine449bd832023-01-11 14:50:10 +01007143 status = psa_pake_get_implicit_key(&handshake->psa_pake_ctx,
7144 &derivation);
7145 if (status != PSA_SUCCESS) {
7146 psa_key_derivation_abort(&derivation);
7147 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Neil Armstrongca7d5062022-05-31 14:43:23 +02007148 }
7149
Gilles Peskine449bd832023-01-11 14:50:10 +01007150 status = psa_key_derivation_output_bytes(&derivation,
7151 handshake->premaster,
7152 handshake->pmslen);
7153 if (status != PSA_SUCCESS) {
7154 psa_key_derivation_abort(&derivation);
7155 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
7156 }
7157
7158 status = psa_key_derivation_abort(&derivation);
7159 if (status != PSA_SUCCESS) {
7160 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Neil Armstrongca7d5062022-05-31 14:43:23 +02007161 }
7162 }
7163#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01007164 ret = handshake->tls_prf(handshake->premaster, handshake->pmslen,
7165 lbl, seed, seed_len,
7166 master,
7167 master_secret_len);
7168 if (ret != 0) {
7169 MBEDTLS_SSL_DEBUG_RET(1, "prf", ret);
7170 return ret;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007171 }
7172
Gilles Peskine449bd832023-01-11 14:50:10 +01007173 MBEDTLS_SSL_DEBUG_BUF(3, "premaster secret",
7174 handshake->premaster,
7175 handshake->pmslen);
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007176
Gilles Peskine449bd832023-01-11 14:50:10 +01007177 mbedtls_platform_zeroize(handshake->premaster,
7178 sizeof(handshake->premaster));
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007179 }
7180
Gilles Peskine449bd832023-01-11 14:50:10 +01007181 return 0;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007182}
7183
Gilles Peskine449bd832023-01-11 14:50:10 +01007184int mbedtls_ssl_derive_keys(mbedtls_ssl_context *ssl)
Jerry Yud62f87e2022-02-17 14:09:02 +08007185{
7186 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7187 const mbedtls_ssl_ciphersuite_t * const ciphersuite_info =
7188 ssl->handshake->ciphersuite_info;
7189
Gilles Peskine449bd832023-01-11 14:50:10 +01007190 MBEDTLS_SSL_DEBUG_MSG(2, ("=> derive keys"));
Jerry Yud62f87e2022-02-17 14:09:02 +08007191
7192 /* Set PRF, calc_verify and calc_finished function pointers */
Gilles Peskine449bd832023-01-11 14:50:10 +01007193 ret = ssl_set_handshake_prfs(ssl->handshake,
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01007194 (mbedtls_md_type_t) ciphersuite_info->mac);
Gilles Peskine449bd832023-01-11 14:50:10 +01007195 if (ret != 0) {
7196 MBEDTLS_SSL_DEBUG_RET(1, "ssl_set_handshake_prfs", ret);
7197 return ret;
Jerry Yud62f87e2022-02-17 14:09:02 +08007198 }
7199
7200 /* Compute master secret if needed */
Gilles Peskine449bd832023-01-11 14:50:10 +01007201 ret = ssl_compute_master(ssl->handshake,
7202 ssl->session_negotiate->master,
7203 ssl);
7204 if (ret != 0) {
7205 MBEDTLS_SSL_DEBUG_RET(1, "ssl_compute_master", ret);
7206 return ret;
Jerry Yud62f87e2022-02-17 14:09:02 +08007207 }
7208
7209 /* Swap the client and server random values:
7210 * - MS derivation wanted client+server (RFC 5246 8.1)
7211 * - key derivation wants server+client (RFC 5246 6.3) */
7212 {
7213 unsigned char tmp[64];
Gilles Peskine449bd832023-01-11 14:50:10 +01007214 memcpy(tmp, ssl->handshake->randbytes, 64);
7215 memcpy(ssl->handshake->randbytes, tmp + 32, 32);
7216 memcpy(ssl->handshake->randbytes + 32, tmp, 32);
7217 mbedtls_platform_zeroize(tmp, sizeof(tmp));
Jerry Yud62f87e2022-02-17 14:09:02 +08007218 }
7219
7220 /* Populate transform structure */
Gilles Peskine449bd832023-01-11 14:50:10 +01007221 ret = ssl_tls12_populate_transform(ssl->transform_negotiate,
7222 ssl->session_negotiate->ciphersuite,
7223 ssl->session_negotiate->master,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02007224#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01007225 ssl->session_negotiate->encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02007226#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01007227 ssl->handshake->tls_prf,
7228 ssl->handshake->randbytes,
7229 ssl->tls_version,
7230 ssl->conf->endpoint,
7231 ssl);
7232 if (ret != 0) {
7233 MBEDTLS_SSL_DEBUG_RET(1, "ssl_tls12_populate_transform", ret);
7234 return ret;
Jerry Yud62f87e2022-02-17 14:09:02 +08007235 }
7236
7237 /* We no longer need Server/ClientHello.random values */
Gilles Peskine449bd832023-01-11 14:50:10 +01007238 mbedtls_platform_zeroize(ssl->handshake->randbytes,
7239 sizeof(ssl->handshake->randbytes));
Jerry Yud62f87e2022-02-17 14:09:02 +08007240
Gilles Peskine449bd832023-01-11 14:50:10 +01007241 MBEDTLS_SSL_DEBUG_MSG(2, ("<= derive keys"));
Jerry Yud62f87e2022-02-17 14:09:02 +08007242
Gilles Peskine449bd832023-01-11 14:50:10 +01007243 return 0;
Jerry Yud62f87e2022-02-17 14:09:02 +08007244}
Jerry Yu8392e0d2022-02-17 14:10:24 +08007245
Gilles Peskine449bd832023-01-11 14:50:10 +01007246int mbedtls_ssl_set_calc_verify_md(mbedtls_ssl_context *ssl, int md)
Ronald Cron4dcbca92022-03-07 10:21:40 +01007247{
Gilles Peskine449bd832023-01-11 14:50:10 +01007248 switch (md) {
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01007249#if defined(MBEDTLS_MD_CAN_SHA384)
Ronald Cron4dcbca92022-03-07 10:21:40 +01007250 case MBEDTLS_SSL_HASH_SHA384:
7251 ssl->handshake->calc_verify = ssl_calc_verify_tls_sha384;
7252 break;
7253#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01007254#if defined(MBEDTLS_MD_CAN_SHA256)
Ronald Cron4dcbca92022-03-07 10:21:40 +01007255 case MBEDTLS_SSL_HASH_SHA256:
7256 ssl->handshake->calc_verify = ssl_calc_verify_tls_sha256;
7257 break;
7258#endif
7259 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01007260 return -1;
Ronald Cron4dcbca92022-03-07 10:21:40 +01007261 }
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01007262#if !defined(MBEDTLS_MD_CAN_SHA384) && \
7263 !defined(MBEDTLS_MD_CAN_SHA256)
Andrzej Kurekeabeb302022-10-17 07:52:51 -04007264 (void) ssl;
7265#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01007266 return 0;
Ronald Cron4dcbca92022-03-07 10:21:40 +01007267}
7268
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007269#if defined(MBEDTLS_USE_PSA_CRYPTO)
7270static int ssl_calc_verify_tls_psa(const mbedtls_ssl_context *ssl,
7271 const psa_hash_operation_t *hs_op,
7272 size_t buffer_size,
7273 unsigned char *hash,
7274 size_t *hlen)
7275{
7276 psa_status_t status;
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007277 psa_hash_operation_t cloned_op = psa_hash_operation_init();
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007278
7279#if !defined(MBEDTLS_DEBUG_C)
7280 (void) ssl;
7281#endif
7282 MBEDTLS_SSL_DEBUG_MSG(2, ("=> PSA calc verify"));
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007283 status = psa_hash_clone(hs_op, &cloned_op);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007284 if (status != PSA_SUCCESS) {
7285 goto exit;
7286 }
7287
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007288 status = psa_hash_finish(&cloned_op, hash, buffer_size, hlen);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007289 if (status != PSA_SUCCESS) {
7290 goto exit;
7291 }
7292
7293 MBEDTLS_SSL_DEBUG_BUF(3, "PSA calculated verify result", hash, *hlen);
7294 MBEDTLS_SSL_DEBUG_MSG(2, ("<= PSA calc verify"));
7295
7296exit:
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007297 psa_hash_abort(&cloned_op);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007298 return mbedtls_md_error_from_psa(status);
7299}
7300#else
7301static int ssl_calc_verify_tls_legacy(const mbedtls_ssl_context *ssl,
7302 const mbedtls_md_context_t *hs_ctx,
7303 unsigned char *hash,
7304 size_t *hlen)
7305{
7306 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007307 mbedtls_md_context_t cloned_ctx;
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007308
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007309 mbedtls_md_init(&cloned_ctx);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007310
7311#if !defined(MBEDTLS_DEBUG_C)
7312 (void) ssl;
7313#endif
7314 MBEDTLS_SSL_DEBUG_MSG(2, ("=> calc verify"));
7315
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007316 ret = mbedtls_md_setup(&cloned_ctx, mbedtls_md_info_from_ctx(hs_ctx), 0);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007317 if (ret != 0) {
7318 goto exit;
7319 }
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007320 ret = mbedtls_md_clone(&cloned_ctx, hs_ctx);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007321 if (ret != 0) {
7322 goto exit;
7323 }
7324
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007325 ret = mbedtls_md_finish(&cloned_ctx, hash);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007326 if (ret != 0) {
7327 goto exit;
7328 }
7329
7330 *hlen = mbedtls_md_get_size(mbedtls_md_info_from_ctx(hs_ctx));
7331
7332 MBEDTLS_SSL_DEBUG_BUF(3, "calculated verify result", hash, *hlen);
7333 MBEDTLS_SSL_DEBUG_MSG(2, ("<= calc verify"));
7334
7335exit:
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007336 mbedtls_md_free(&cloned_ctx);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007337 return ret;
7338}
7339#endif /* MBEDTLS_USE_PSA_CRYPTO */
7340
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01007341#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +01007342int ssl_calc_verify_tls_sha256(const mbedtls_ssl_context *ssl,
7343 unsigned char *hash,
7344 size_t *hlen)
Jerry Yu8392e0d2022-02-17 14:10:24 +08007345{
7346#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007347 return ssl_calc_verify_tls_psa(ssl, &ssl->handshake->fin_sha256_psa, 32,
7348 hash, hlen);
Jerry Yu8392e0d2022-02-17 14:10:24 +08007349#else
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007350 return ssl_calc_verify_tls_legacy(ssl, &ssl->handshake->fin_sha256,
7351 hash, hlen);
Jerry Yu8392e0d2022-02-17 14:10:24 +08007352#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu8392e0d2022-02-17 14:10:24 +08007353}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01007354#endif /* MBEDTLS_MD_CAN_SHA256 */
Jerry Yu8392e0d2022-02-17 14:10:24 +08007355
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01007356#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +01007357int ssl_calc_verify_tls_sha384(const mbedtls_ssl_context *ssl,
7358 unsigned char *hash,
7359 size_t *hlen)
Jerry Yuc1cb3842022-02-17 14:13:48 +08007360{
7361#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007362 return ssl_calc_verify_tls_psa(ssl, &ssl->handshake->fin_sha384_psa, 48,
7363 hash, hlen);
Jerry Yuc1cb3842022-02-17 14:13:48 +08007364#else
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007365 return ssl_calc_verify_tls_legacy(ssl, &ssl->handshake->fin_sha384,
7366 hash, hlen);
Jerry Yuc1cb3842022-02-17 14:13:48 +08007367#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yuc1cb3842022-02-17 14:13:48 +08007368}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01007369#endif /* MBEDTLS_MD_CAN_SHA384 */
Jerry Yuc1cb3842022-02-17 14:13:48 +08007370
Neil Armstrong80f6f322022-05-03 17:56:38 +02007371#if !defined(MBEDTLS_USE_PSA_CRYPTO) && \
7372 defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007373int mbedtls_ssl_psk_derive_premaster(mbedtls_ssl_context *ssl, mbedtls_key_exchange_type_t key_ex)
Jerry Yuce3dca42022-02-17 14:16:37 +08007374{
7375 unsigned char *p = ssl->handshake->premaster;
Gilles Peskine449bd832023-01-11 14:50:10 +01007376 unsigned char *end = p + sizeof(ssl->handshake->premaster);
Jerry Yuce3dca42022-02-17 14:16:37 +08007377 const unsigned char *psk = NULL;
7378 size_t psk_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01007379 int psk_ret = mbedtls_ssl_get_psk(ssl, &psk, &psk_len);
Jerry Yuce3dca42022-02-17 14:16:37 +08007380
Gilles Peskine449bd832023-01-11 14:50:10 +01007381 if (psk_ret == MBEDTLS_ERR_SSL_PRIVATE_KEY_REQUIRED) {
Jerry Yuce3dca42022-02-17 14:16:37 +08007382 /*
7383 * This should never happen because the existence of a PSK is always
Przemek Stekielb293aaa2022-04-19 12:22:38 +02007384 * checked before calling this function.
7385 *
7386 * The exception is opaque DHE-PSK. For DHE-PSK fill premaster with
Przemek Stekiel8abcee92022-04-28 09:16:28 +02007387 * the shared secret without PSK.
Jerry Yuce3dca42022-02-17 14:16:37 +08007388 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007389 if (key_ex != MBEDTLS_KEY_EXCHANGE_DHE_PSK) {
7390 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
7391 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Przemek Stekielb293aaa2022-04-19 12:22:38 +02007392 }
Jerry Yuce3dca42022-02-17 14:16:37 +08007393 }
7394
7395 /*
7396 * PMS = struct {
7397 * opaque other_secret<0..2^16-1>;
7398 * opaque psk<0..2^16-1>;
7399 * };
7400 * with "other_secret" depending on the particular key exchange
7401 */
7402#if defined(MBEDTLS_KEY_EXCHANGE_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007403 if (key_ex == MBEDTLS_KEY_EXCHANGE_PSK) {
7404 if (end - p < 2) {
7405 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
7406 }
Jerry Yuce3dca42022-02-17 14:16:37 +08007407
Gilles Peskine449bd832023-01-11 14:50:10 +01007408 MBEDTLS_PUT_UINT16_BE(psk_len, p, 0);
Jerry Yuce3dca42022-02-17 14:16:37 +08007409 p += 2;
7410
Gilles Peskine449bd832023-01-11 14:50:10 +01007411 if (end < p || (size_t) (end - p) < psk_len) {
7412 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
7413 }
Jerry Yuce3dca42022-02-17 14:16:37 +08007414
Gilles Peskine449bd832023-01-11 14:50:10 +01007415 memset(p, 0, psk_len);
Jerry Yuce3dca42022-02-17 14:16:37 +08007416 p += psk_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01007417 } else
Jerry Yuce3dca42022-02-17 14:16:37 +08007418#endif /* MBEDTLS_KEY_EXCHANGE_PSK_ENABLED */
7419#if defined(MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007420 if (key_ex == MBEDTLS_KEY_EXCHANGE_RSA_PSK) {
Jerry Yuce3dca42022-02-17 14:16:37 +08007421 /*
7422 * other_secret already set by the ClientKeyExchange message,
7423 * and is 48 bytes long
7424 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007425 if (end - p < 2) {
7426 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
7427 }
Jerry Yuce3dca42022-02-17 14:16:37 +08007428
7429 *p++ = 0;
7430 *p++ = 48;
7431 p += 48;
Gilles Peskine449bd832023-01-11 14:50:10 +01007432 } else
Jerry Yuce3dca42022-02-17 14:16:37 +08007433#endif /* MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED */
7434#if defined(MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007435 if (key_ex == MBEDTLS_KEY_EXCHANGE_DHE_PSK) {
Jerry Yuce3dca42022-02-17 14:16:37 +08007436 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7437 size_t len;
7438
7439 /* Write length only when we know the actual value */
Gilles Peskine449bd832023-01-11 14:50:10 +01007440 if ((ret = mbedtls_dhm_calc_secret(&ssl->handshake->dhm_ctx,
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00007441 p + 2, (size_t) (end - (p + 2)), &len,
Gilles Peskine449bd832023-01-11 14:50:10 +01007442 ssl->conf->f_rng, ssl->conf->p_rng)) != 0) {
7443 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_dhm_calc_secret", ret);
7444 return ret;
Jerry Yuce3dca42022-02-17 14:16:37 +08007445 }
Gilles Peskine449bd832023-01-11 14:50:10 +01007446 MBEDTLS_PUT_UINT16_BE(len, p, 0);
Jerry Yuce3dca42022-02-17 14:16:37 +08007447 p += 2 + len;
7448
Gilles Peskine449bd832023-01-11 14:50:10 +01007449 MBEDTLS_SSL_DEBUG_MPI(3, "DHM: K ", &ssl->handshake->dhm_ctx.K);
7450 } else
Jerry Yuce3dca42022-02-17 14:16:37 +08007451#endif /* MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED */
Neil Armstrong80f6f322022-05-03 17:56:38 +02007452#if defined(MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007453 if (key_ex == MBEDTLS_KEY_EXCHANGE_ECDHE_PSK) {
Jerry Yuce3dca42022-02-17 14:16:37 +08007454 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7455 size_t zlen;
7456
Gilles Peskine449bd832023-01-11 14:50:10 +01007457 if ((ret = mbedtls_ecdh_calc_secret(&ssl->handshake->ecdh_ctx, &zlen,
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00007458 p + 2, (size_t) (end - (p + 2)),
Gilles Peskine449bd832023-01-11 14:50:10 +01007459 ssl->conf->f_rng, ssl->conf->p_rng)) != 0) {
7460 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ecdh_calc_secret", ret);
7461 return ret;
Jerry Yuce3dca42022-02-17 14:16:37 +08007462 }
7463
Gilles Peskine449bd832023-01-11 14:50:10 +01007464 MBEDTLS_PUT_UINT16_BE(zlen, p, 0);
Jerry Yuce3dca42022-02-17 14:16:37 +08007465 p += 2 + zlen;
7466
Gilles Peskine449bd832023-01-11 14:50:10 +01007467 MBEDTLS_SSL_DEBUG_ECDH(3, &ssl->handshake->ecdh_ctx,
7468 MBEDTLS_DEBUG_ECDH_Z);
7469 } else
Neil Armstrong80f6f322022-05-03 17:56:38 +02007470#endif /* MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED */
Jerry Yuce3dca42022-02-17 14:16:37 +08007471 {
Gilles Peskine449bd832023-01-11 14:50:10 +01007472 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
7473 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yuce3dca42022-02-17 14:16:37 +08007474 }
7475
7476 /* opaque psk<0..2^16-1>; */
Gilles Peskine449bd832023-01-11 14:50:10 +01007477 if (end - p < 2) {
7478 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
7479 }
Jerry Yuce3dca42022-02-17 14:16:37 +08007480
Gilles Peskine449bd832023-01-11 14:50:10 +01007481 MBEDTLS_PUT_UINT16_BE(psk_len, p, 0);
Jerry Yuce3dca42022-02-17 14:16:37 +08007482 p += 2;
7483
Gilles Peskine449bd832023-01-11 14:50:10 +01007484 if (end < p || (size_t) (end - p) < psk_len) {
7485 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
7486 }
Jerry Yuce3dca42022-02-17 14:16:37 +08007487
Gilles Peskine449bd832023-01-11 14:50:10 +01007488 memcpy(p, psk, psk_len);
Jerry Yuce3dca42022-02-17 14:16:37 +08007489 p += psk_len;
7490
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00007491 ssl->handshake->pmslen = (size_t) (p - ssl->handshake->premaster);
Jerry Yuce3dca42022-02-17 14:16:37 +08007492
Gilles Peskine449bd832023-01-11 14:50:10 +01007493 return 0;
Jerry Yuce3dca42022-02-17 14:16:37 +08007494}
Neil Armstrong80f6f322022-05-03 17:56:38 +02007495#endif /* !MBEDTLS_USE_PSA_CRYPTO && MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
Jerry Yuc2c673d2022-02-17 14:20:39 +08007496
7497#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007498MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007499static int ssl_write_hello_request(mbedtls_ssl_context *ssl);
Jerry Yuc2c673d2022-02-17 14:20:39 +08007500
7501#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01007502int mbedtls_ssl_resend_hello_request(mbedtls_ssl_context *ssl)
Jerry Yuc2c673d2022-02-17 14:20:39 +08007503{
7504 /* If renegotiation is not enforced, retransmit until we would reach max
7505 * timeout if we were using the usual handshake doubling scheme */
Gilles Peskine449bd832023-01-11 14:50:10 +01007506 if (ssl->conf->renego_max_records < 0) {
Jerry Yuc2c673d2022-02-17 14:20:39 +08007507 uint32_t ratio = ssl->conf->hs_timeout_max / ssl->conf->hs_timeout_min + 1;
7508 unsigned char doublings = 1;
7509
Gilles Peskine449bd832023-01-11 14:50:10 +01007510 while (ratio != 0) {
Jerry Yuc2c673d2022-02-17 14:20:39 +08007511 ++doublings;
7512 ratio >>= 1;
7513 }
7514
Gilles Peskine449bd832023-01-11 14:50:10 +01007515 if (++ssl->renego_records_seen > doublings) {
7516 MBEDTLS_SSL_DEBUG_MSG(2, ("no longer retransmitting hello request"));
7517 return 0;
Jerry Yuc2c673d2022-02-17 14:20:39 +08007518 }
7519 }
7520
Gilles Peskine449bd832023-01-11 14:50:10 +01007521 return ssl_write_hello_request(ssl);
Jerry Yuc2c673d2022-02-17 14:20:39 +08007522}
7523#endif
7524#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_RENEGOTIATION */
Jerry Yud9526692022-02-17 14:23:47 +08007525
Jerry Yud9526692022-02-17 14:23:47 +08007526/*
7527 * Handshake functions
7528 */
7529#if !defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
7530/* No certificate support -> dummy functions */
Gilles Peskine449bd832023-01-11 14:50:10 +01007531int mbedtls_ssl_write_certificate(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08007532{
7533 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
7534 ssl->handshake->ciphersuite_info;
7535
Gilles Peskine449bd832023-01-11 14:50:10 +01007536 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007537
Gilles Peskine449bd832023-01-11 14:50:10 +01007538 if (!mbedtls_ssl_ciphersuite_uses_srv_cert(ciphersuite_info)) {
7539 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007540 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01007541 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007542 }
7543
Gilles Peskine449bd832023-01-11 14:50:10 +01007544 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
7545 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007546}
7547
Gilles Peskine449bd832023-01-11 14:50:10 +01007548int mbedtls_ssl_parse_certificate(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08007549{
7550 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
7551 ssl->handshake->ciphersuite_info;
7552
Gilles Peskine449bd832023-01-11 14:50:10 +01007553 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007554
Gilles Peskine449bd832023-01-11 14:50:10 +01007555 if (!mbedtls_ssl_ciphersuite_uses_srv_cert(ciphersuite_info)) {
7556 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007557 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01007558 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007559 }
7560
Gilles Peskine449bd832023-01-11 14:50:10 +01007561 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
7562 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007563}
7564
7565#else /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
7566/* Some certificate support -> implement write and parse */
7567
Gilles Peskine449bd832023-01-11 14:50:10 +01007568int mbedtls_ssl_write_certificate(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08007569{
7570 int ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
7571 size_t i, n;
7572 const mbedtls_x509_crt *crt;
7573 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
7574 ssl->handshake->ciphersuite_info;
7575
Gilles Peskine449bd832023-01-11 14:50:10 +01007576 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007577
Gilles Peskine449bd832023-01-11 14:50:10 +01007578 if (!mbedtls_ssl_ciphersuite_uses_srv_cert(ciphersuite_info)) {
7579 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007580 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01007581 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007582 }
7583
7584#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007585 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
7586 if (ssl->handshake->client_auth == 0) {
7587 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007588 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01007589 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007590 }
7591 }
7592#endif /* MBEDTLS_SSL_CLI_C */
7593#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007594 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
7595 if (mbedtls_ssl_own_cert(ssl) == NULL) {
Jerry Yud9526692022-02-17 14:23:47 +08007596 /* Should never happen because we shouldn't have picked the
7597 * ciphersuite if we don't have a certificate. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007598 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007599 }
7600 }
7601#endif
7602
Gilles Peskine449bd832023-01-11 14:50:10 +01007603 MBEDTLS_SSL_DEBUG_CRT(3, "own certificate", mbedtls_ssl_own_cert(ssl));
Jerry Yud9526692022-02-17 14:23:47 +08007604
7605 /*
7606 * 0 . 0 handshake type
7607 * 1 . 3 handshake length
7608 * 4 . 6 length of all certs
7609 * 7 . 9 length of cert. 1
7610 * 10 . n-1 peer certificate
7611 * n . n+2 length of cert. 2
7612 * n+3 . ... upper level cert, etc.
7613 */
7614 i = 7;
Gilles Peskine449bd832023-01-11 14:50:10 +01007615 crt = mbedtls_ssl_own_cert(ssl);
Jerry Yud9526692022-02-17 14:23:47 +08007616
Gilles Peskine449bd832023-01-11 14:50:10 +01007617 while (crt != NULL) {
Jerry Yud9526692022-02-17 14:23:47 +08007618 n = crt->raw.len;
Gilles Peskine449bd832023-01-11 14:50:10 +01007619 if (n > MBEDTLS_SSL_OUT_CONTENT_LEN - 3 - i) {
7620 MBEDTLS_SSL_DEBUG_MSG(1, ("certificate too large, %" MBEDTLS_PRINTF_SIZET
7621 " > %" MBEDTLS_PRINTF_SIZET,
7622 i + 3 + n, (size_t) MBEDTLS_SSL_OUT_CONTENT_LEN));
7623 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
Jerry Yud9526692022-02-17 14:23:47 +08007624 }
7625
Gilles Peskine449bd832023-01-11 14:50:10 +01007626 ssl->out_msg[i] = MBEDTLS_BYTE_2(n);
7627 ssl->out_msg[i + 1] = MBEDTLS_BYTE_1(n);
7628 ssl->out_msg[i + 2] = MBEDTLS_BYTE_0(n);
Jerry Yud9526692022-02-17 14:23:47 +08007629
Gilles Peskine449bd832023-01-11 14:50:10 +01007630 i += 3; memcpy(ssl->out_msg + i, crt->raw.p, n);
Jerry Yud9526692022-02-17 14:23:47 +08007631 i += n; crt = crt->next;
7632 }
7633
Gilles Peskine449bd832023-01-11 14:50:10 +01007634 ssl->out_msg[4] = MBEDTLS_BYTE_2(i - 7);
7635 ssl->out_msg[5] = MBEDTLS_BYTE_1(i - 7);
7636 ssl->out_msg[6] = MBEDTLS_BYTE_0(i - 7);
Jerry Yud9526692022-02-17 14:23:47 +08007637
7638 ssl->out_msglen = i;
7639 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
7640 ssl->out_msg[0] = MBEDTLS_SSL_HS_CERTIFICATE;
7641
7642 ssl->state++;
7643
Gilles Peskine449bd832023-01-11 14:50:10 +01007644 if ((ret = mbedtls_ssl_write_handshake_msg(ssl)) != 0) {
7645 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_handshake_msg", ret);
7646 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007647 }
7648
Gilles Peskine449bd832023-01-11 14:50:10 +01007649 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007650
Gilles Peskine449bd832023-01-11 14:50:10 +01007651 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007652}
7653
7654#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
7655
7656#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007657MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007658static int ssl_check_peer_crt_unchanged(mbedtls_ssl_context *ssl,
7659 unsigned char *crt_buf,
7660 size_t crt_buf_len)
Jerry Yud9526692022-02-17 14:23:47 +08007661{
7662 mbedtls_x509_crt const * const peer_crt = ssl->session->peer_cert;
7663
Gilles Peskine449bd832023-01-11 14:50:10 +01007664 if (peer_crt == NULL) {
7665 return -1;
7666 }
Jerry Yud9526692022-02-17 14:23:47 +08007667
Gilles Peskine449bd832023-01-11 14:50:10 +01007668 if (peer_crt->raw.len != crt_buf_len) {
7669 return -1;
7670 }
Jerry Yud9526692022-02-17 14:23:47 +08007671
Gilles Peskine449bd832023-01-11 14:50:10 +01007672 return memcmp(peer_crt->raw.p, crt_buf, peer_crt->raw.len);
Jerry Yud9526692022-02-17 14:23:47 +08007673}
7674#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007675MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007676static int ssl_check_peer_crt_unchanged(mbedtls_ssl_context *ssl,
7677 unsigned char *crt_buf,
7678 size_t crt_buf_len)
Jerry Yud9526692022-02-17 14:23:47 +08007679{
7680 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7681 unsigned char const * const peer_cert_digest =
7682 ssl->session->peer_cert_digest;
7683 mbedtls_md_type_t const peer_cert_digest_type =
7684 ssl->session->peer_cert_digest_type;
7685 mbedtls_md_info_t const * const digest_info =
Gilles Peskine449bd832023-01-11 14:50:10 +01007686 mbedtls_md_info_from_type(peer_cert_digest_type);
Jerry Yud9526692022-02-17 14:23:47 +08007687 unsigned char tmp_digest[MBEDTLS_SSL_PEER_CERT_DIGEST_MAX_LEN];
7688 size_t digest_len;
7689
Gilles Peskine449bd832023-01-11 14:50:10 +01007690 if (peer_cert_digest == NULL || digest_info == NULL) {
7691 return -1;
7692 }
Jerry Yud9526692022-02-17 14:23:47 +08007693
Gilles Peskine449bd832023-01-11 14:50:10 +01007694 digest_len = mbedtls_md_get_size(digest_info);
7695 if (digest_len > MBEDTLS_SSL_PEER_CERT_DIGEST_MAX_LEN) {
7696 return -1;
7697 }
Jerry Yud9526692022-02-17 14:23:47 +08007698
Gilles Peskine449bd832023-01-11 14:50:10 +01007699 ret = mbedtls_md(digest_info, crt_buf, crt_buf_len, tmp_digest);
7700 if (ret != 0) {
7701 return -1;
7702 }
Jerry Yud9526692022-02-17 14:23:47 +08007703
Gilles Peskine449bd832023-01-11 14:50:10 +01007704 return memcmp(tmp_digest, peer_cert_digest, digest_len);
Jerry Yud9526692022-02-17 14:23:47 +08007705}
7706#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7707#endif /* MBEDTLS_SSL_RENEGOTIATION && MBEDTLS_SSL_CLI_C */
7708
7709/*
7710 * Once the certificate message is read, parse it into a cert chain and
7711 * perform basic checks, but leave actual verification to the caller
7712 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007713MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007714static int ssl_parse_certificate_chain(mbedtls_ssl_context *ssl,
7715 mbedtls_x509_crt *chain)
Jerry Yud9526692022-02-17 14:23:47 +08007716{
7717 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7718#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007719 int crt_cnt = 0;
Jerry Yud9526692022-02-17 14:23:47 +08007720#endif
7721 size_t i, n;
7722 uint8_t alert;
7723
Gilles Peskine449bd832023-01-11 14:50:10 +01007724 if (ssl->in_msgtype != MBEDTLS_SSL_MSG_HANDSHAKE) {
7725 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7726 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7727 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
7728 return MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
Jerry Yud9526692022-02-17 14:23:47 +08007729 }
7730
Gilles Peskine449bd832023-01-11 14:50:10 +01007731 if (ssl->in_msg[0] != MBEDTLS_SSL_HS_CERTIFICATE) {
7732 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7733 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
7734 return MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
Jerry Yud9526692022-02-17 14:23:47 +08007735 }
7736
Gilles Peskine449bd832023-01-11 14:50:10 +01007737 if (ssl->in_hslen < mbedtls_ssl_hs_hdr_len(ssl) + 3 + 3) {
7738 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7739 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7740 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
7741 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007742 }
7743
Gilles Peskine449bd832023-01-11 14:50:10 +01007744 i = mbedtls_ssl_hs_hdr_len(ssl);
Jerry Yud9526692022-02-17 14:23:47 +08007745
7746 /*
7747 * Same message structure as in mbedtls_ssl_write_certificate()
7748 */
Dave Rodgmana3d0f612023-11-03 23:34:02 +00007749 n = MBEDTLS_GET_UINT16_BE(ssl->in_msg, i + 1);
Jerry Yud9526692022-02-17 14:23:47 +08007750
Gilles Peskine449bd832023-01-11 14:50:10 +01007751 if (ssl->in_msg[i] != 0 ||
7752 ssl->in_hslen != n + 3 + mbedtls_ssl_hs_hdr_len(ssl)) {
7753 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7754 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7755 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
7756 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007757 }
7758
7759 /* Make &ssl->in_msg[i] point to the beginning of the CRT chain. */
7760 i += 3;
7761
7762 /* Iterate through and parse the CRTs in the provided chain. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007763 while (i < ssl->in_hslen) {
Jerry Yud9526692022-02-17 14:23:47 +08007764 /* Check that there's room for the next CRT's length fields. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007765 if (i + 3 > ssl->in_hslen) {
7766 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7767 mbedtls_ssl_send_alert_message(ssl,
7768 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7769 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
7770 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007771 }
7772 /* In theory, the CRT can be up to 2**24 Bytes, but we don't support
7773 * anything beyond 2**16 ~ 64K. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007774 if (ssl->in_msg[i] != 0) {
7775 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7776 mbedtls_ssl_send_alert_message(ssl,
7777 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7778 MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT);
7779 return MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
Jerry Yud9526692022-02-17 14:23:47 +08007780 }
7781
7782 /* Read length of the next CRT in the chain. */
Dave Rodgmana3d0f612023-11-03 23:34:02 +00007783 n = MBEDTLS_GET_UINT16_BE(ssl->in_msg, i + 1);
Jerry Yud9526692022-02-17 14:23:47 +08007784 i += 3;
7785
Gilles Peskine449bd832023-01-11 14:50:10 +01007786 if (n < 128 || i + n > ssl->in_hslen) {
7787 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7788 mbedtls_ssl_send_alert_message(ssl,
7789 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7790 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
7791 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007792 }
7793
7794 /* Check if we're handling the first CRT in the chain. */
7795#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007796 if (crt_cnt++ == 0 &&
Jerry Yud9526692022-02-17 14:23:47 +08007797 ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
Gilles Peskine449bd832023-01-11 14:50:10 +01007798 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS) {
Jerry Yud9526692022-02-17 14:23:47 +08007799 /* During client-side renegotiation, check that the server's
7800 * end-CRTs hasn't changed compared to the initial handshake,
7801 * mitigating the triple handshake attack. On success, reuse
7802 * the original end-CRT instead of parsing it again. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007803 MBEDTLS_SSL_DEBUG_MSG(3, ("Check that peer CRT hasn't changed during renegotiation"));
7804 if (ssl_check_peer_crt_unchanged(ssl,
7805 &ssl->in_msg[i],
7806 n) != 0) {
7807 MBEDTLS_SSL_DEBUG_MSG(1, ("new server cert during renegotiation"));
7808 mbedtls_ssl_send_alert_message(ssl,
7809 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7810 MBEDTLS_SSL_ALERT_MSG_ACCESS_DENIED);
7811 return MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
Jerry Yud9526692022-02-17 14:23:47 +08007812 }
7813
7814 /* Now we can safely free the original chain. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007815 ssl_clear_peer_cert(ssl->session);
Jerry Yud9526692022-02-17 14:23:47 +08007816 }
7817#endif /* MBEDTLS_SSL_RENEGOTIATION && MBEDTLS_SSL_CLI_C */
7818
7819 /* Parse the next certificate in the chain. */
7820#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01007821 ret = mbedtls_x509_crt_parse_der(chain, ssl->in_msg + i, n);
Jerry Yud9526692022-02-17 14:23:47 +08007822#else
7823 /* If we don't need to store the CRT chain permanently, parse
7824 * it in-place from the input buffer instead of making a copy. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007825 ret = mbedtls_x509_crt_parse_der_nocopy(chain, ssl->in_msg + i, n);
Jerry Yud9526692022-02-17 14:23:47 +08007826#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Gilles Peskine449bd832023-01-11 14:50:10 +01007827 switch (ret) {
Jerry Yud9526692022-02-17 14:23:47 +08007828 case 0: /*ok*/
7829 case MBEDTLS_ERR_X509_UNKNOWN_SIG_ALG + MBEDTLS_ERR_OID_NOT_FOUND:
7830 /* Ignore certificate with an unknown algorithm: maybe a
7831 prior certificate was already trusted. */
7832 break;
7833
7834 case MBEDTLS_ERR_X509_ALLOC_FAILED:
7835 alert = MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR;
7836 goto crt_parse_der_failed;
7837
7838 case MBEDTLS_ERR_X509_UNKNOWN_VERSION:
7839 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
7840 goto crt_parse_der_failed;
7841
7842 default:
7843 alert = MBEDTLS_SSL_ALERT_MSG_BAD_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01007844crt_parse_der_failed:
7845 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL, alert);
7846 MBEDTLS_SSL_DEBUG_RET(1, " mbedtls_x509_crt_parse_der", ret);
7847 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007848 }
7849
7850 i += n;
7851 }
7852
Gilles Peskine449bd832023-01-11 14:50:10 +01007853 MBEDTLS_SSL_DEBUG_CRT(3, "peer certificate", chain);
7854 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007855}
7856
7857#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007858MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007859static int ssl_srv_check_client_no_crt_notification(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08007860{
Gilles Peskine449bd832023-01-11 14:50:10 +01007861 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
7862 return -1;
7863 }
Jerry Yud9526692022-02-17 14:23:47 +08007864
Gilles Peskine449bd832023-01-11 14:50:10 +01007865 if (ssl->in_hslen == 3 + mbedtls_ssl_hs_hdr_len(ssl) &&
Jerry Yud9526692022-02-17 14:23:47 +08007866 ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
7867 ssl->in_msg[0] == MBEDTLS_SSL_HS_CERTIFICATE &&
Gilles Peskine449bd832023-01-11 14:50:10 +01007868 memcmp(ssl->in_msg + mbedtls_ssl_hs_hdr_len(ssl), "\0\0\0", 3) == 0) {
7869 MBEDTLS_SSL_DEBUG_MSG(1, ("peer has no certificate"));
7870 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007871 }
Gilles Peskine449bd832023-01-11 14:50:10 +01007872 return -1;
Jerry Yud9526692022-02-17 14:23:47 +08007873}
7874#endif /* MBEDTLS_SSL_SRV_C */
7875
7876/* Check if a certificate message is expected.
7877 * Return either
7878 * - SSL_CERTIFICATE_EXPECTED, or
7879 * - SSL_CERTIFICATE_SKIP
7880 * indicating whether a Certificate message is expected or not.
7881 */
7882#define SSL_CERTIFICATE_EXPECTED 0
7883#define SSL_CERTIFICATE_SKIP 1
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007884MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007885static int ssl_parse_certificate_coordinate(mbedtls_ssl_context *ssl,
7886 int authmode)
Jerry Yud9526692022-02-17 14:23:47 +08007887{
7888 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
7889 ssl->handshake->ciphersuite_info;
7890
Gilles Peskine449bd832023-01-11 14:50:10 +01007891 if (!mbedtls_ssl_ciphersuite_uses_srv_cert(ciphersuite_info)) {
7892 return SSL_CERTIFICATE_SKIP;
7893 }
Jerry Yud9526692022-02-17 14:23:47 +08007894
7895#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007896 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
7897 if (ciphersuite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_RSA_PSK) {
7898 return SSL_CERTIFICATE_SKIP;
7899 }
Jerry Yud9526692022-02-17 14:23:47 +08007900
Gilles Peskine449bd832023-01-11 14:50:10 +01007901 if (authmode == MBEDTLS_SSL_VERIFY_NONE) {
Jerry Yud9526692022-02-17 14:23:47 +08007902 ssl->session_negotiate->verify_result =
7903 MBEDTLS_X509_BADCERT_SKIP_VERIFY;
Gilles Peskine449bd832023-01-11 14:50:10 +01007904 return SSL_CERTIFICATE_SKIP;
Jerry Yud9526692022-02-17 14:23:47 +08007905 }
7906 }
7907#else
7908 ((void) authmode);
7909#endif /* MBEDTLS_SSL_SRV_C */
7910
Gilles Peskine449bd832023-01-11 14:50:10 +01007911 return SSL_CERTIFICATE_EXPECTED;
Jerry Yud9526692022-02-17 14:23:47 +08007912}
7913
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007914MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007915static int ssl_parse_certificate_verify(mbedtls_ssl_context *ssl,
7916 int authmode,
7917 mbedtls_x509_crt *chain,
7918 void *rs_ctx)
Jerry Yud9526692022-02-17 14:23:47 +08007919{
7920 int ret = 0;
7921 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
7922 ssl->handshake->ciphersuite_info;
7923 int have_ca_chain = 0;
7924
7925 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *);
7926 void *p_vrfy;
7927
Gilles Peskine449bd832023-01-11 14:50:10 +01007928 if (authmode == MBEDTLS_SSL_VERIFY_NONE) {
7929 return 0;
7930 }
Jerry Yud9526692022-02-17 14:23:47 +08007931
Gilles Peskine449bd832023-01-11 14:50:10 +01007932 if (ssl->f_vrfy != NULL) {
7933 MBEDTLS_SSL_DEBUG_MSG(3, ("Use context-specific verification callback"));
Jerry Yud9526692022-02-17 14:23:47 +08007934 f_vrfy = ssl->f_vrfy;
7935 p_vrfy = ssl->p_vrfy;
Gilles Peskine449bd832023-01-11 14:50:10 +01007936 } else {
7937 MBEDTLS_SSL_DEBUG_MSG(3, ("Use configuration-specific verification callback"));
Jerry Yud9526692022-02-17 14:23:47 +08007938 f_vrfy = ssl->conf->f_vrfy;
7939 p_vrfy = ssl->conf->p_vrfy;
7940 }
7941
7942 /*
7943 * Main check: verify certificate
7944 */
7945#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
Gilles Peskine449bd832023-01-11 14:50:10 +01007946 if (ssl->conf->f_ca_cb != NULL) {
Jerry Yud9526692022-02-17 14:23:47 +08007947 ((void) rs_ctx);
7948 have_ca_chain = 1;
7949
Gilles Peskine449bd832023-01-11 14:50:10 +01007950 MBEDTLS_SSL_DEBUG_MSG(3, ("use CA callback for X.509 CRT verification"));
Jerry Yud9526692022-02-17 14:23:47 +08007951 ret = mbedtls_x509_crt_verify_with_ca_cb(
7952 chain,
7953 ssl->conf->f_ca_cb,
7954 ssl->conf->p_ca_cb,
7955 ssl->conf->cert_profile,
7956 ssl->hostname,
7957 &ssl->session_negotiate->verify_result,
Gilles Peskine449bd832023-01-11 14:50:10 +01007958 f_vrfy, p_vrfy);
7959 } else
Jerry Yud9526692022-02-17 14:23:47 +08007960#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
7961 {
7962 mbedtls_x509_crt *ca_chain;
7963 mbedtls_x509_crl *ca_crl;
7964
7965#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01007966 if (ssl->handshake->sni_ca_chain != NULL) {
Jerry Yud9526692022-02-17 14:23:47 +08007967 ca_chain = ssl->handshake->sni_ca_chain;
7968 ca_crl = ssl->handshake->sni_ca_crl;
Gilles Peskine449bd832023-01-11 14:50:10 +01007969 } else
Jerry Yud9526692022-02-17 14:23:47 +08007970#endif
7971 {
7972 ca_chain = ssl->conf->ca_chain;
7973 ca_crl = ssl->conf->ca_crl;
7974 }
7975
Gilles Peskine449bd832023-01-11 14:50:10 +01007976 if (ca_chain != NULL) {
Jerry Yud9526692022-02-17 14:23:47 +08007977 have_ca_chain = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01007978 }
Jerry Yud9526692022-02-17 14:23:47 +08007979
7980 ret = mbedtls_x509_crt_verify_restartable(
7981 chain,
7982 ca_chain, ca_crl,
7983 ssl->conf->cert_profile,
7984 ssl->hostname,
7985 &ssl->session_negotiate->verify_result,
Gilles Peskine449bd832023-01-11 14:50:10 +01007986 f_vrfy, p_vrfy, rs_ctx);
Jerry Yud9526692022-02-17 14:23:47 +08007987 }
7988
Gilles Peskine449bd832023-01-11 14:50:10 +01007989 if (ret != 0) {
7990 MBEDTLS_SSL_DEBUG_RET(1, "x509_verify_cert", ret);
Jerry Yud9526692022-02-17 14:23:47 +08007991 }
7992
7993#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007994 if (ret == MBEDTLS_ERR_ECP_IN_PROGRESS) {
7995 return MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS;
7996 }
Jerry Yud9526692022-02-17 14:23:47 +08007997#endif
7998
7999 /*
8000 * Secondary checks: always done, but change 'ret' only if it was 0
8001 */
8002
Valerio Settiacd32c02023-06-29 18:06:29 +02008003#if defined(MBEDTLS_PK_HAVE_ECC_KEYS)
Jerry Yud9526692022-02-17 14:23:47 +08008004 {
8005 const mbedtls_pk_context *pk = &chain->pk;
8006
Manuel Pégourié-Gonnard66b0d612022-06-17 10:49:29 +02008007 /* If certificate uses an EC key, make sure the curve is OK.
8008 * This is a public key, so it can't be opaque, so can_do() is a good
8009 * enough check to ensure pk_ec() is safe to use here. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008010 if (mbedtls_pk_can_do(pk, MBEDTLS_PK_ECKEY)) {
Leonid Rozenboim19e59732022-08-08 16:52:38 -07008011 /* and in the unlikely case the above assumption no longer holds
8012 * we are making sure that pk_ec() here does not return a NULL
8013 */
Valerio Settif9362b72023-11-29 08:42:27 +01008014 mbedtls_ecp_group_id grp_id = mbedtls_pk_get_ec_group_id(pk);
Valerio Settid0405092023-05-24 13:16:40 +02008015 if (grp_id == MBEDTLS_ECP_DP_NONE) {
8016 MBEDTLS_SSL_DEBUG_MSG(1, ("invalid group ID"));
Gilles Peskine449bd832023-01-11 14:50:10 +01008017 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Leonid Rozenboim19e59732022-08-08 16:52:38 -07008018 }
Valerio Setti97207782023-05-18 18:59:06 +02008019 if (mbedtls_ssl_check_curve(ssl, grp_id) != 0) {
Leonid Rozenboim19e59732022-08-08 16:52:38 -07008020 ssl->session_negotiate->verify_result |=
8021 MBEDTLS_X509_BADCERT_BAD_KEY;
8022
Gilles Peskine449bd832023-01-11 14:50:10 +01008023 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate (EC key curve)"));
8024 if (ret == 0) {
Leonid Rozenboim19e59732022-08-08 16:52:38 -07008025 ret = MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
Gilles Peskine449bd832023-01-11 14:50:10 +01008026 }
Leonid Rozenboim19e59732022-08-08 16:52:38 -07008027 }
Jerry Yud9526692022-02-17 14:23:47 +08008028 }
8029 }
Valerio Settiacd32c02023-06-29 18:06:29 +02008030#endif /* MBEDTLS_PK_HAVE_ECC_KEYS */
Jerry Yud9526692022-02-17 14:23:47 +08008031
Gilles Peskine449bd832023-01-11 14:50:10 +01008032 if (mbedtls_ssl_check_cert_usage(chain,
8033 ciphersuite_info,
8034 !ssl->conf->endpoint,
8035 &ssl->session_negotiate->verify_result) != 0) {
8036 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate (usage extensions)"));
8037 if (ret == 0) {
Jerry Yud9526692022-02-17 14:23:47 +08008038 ret = MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
Gilles Peskine449bd832023-01-11 14:50:10 +01008039 }
Jerry Yud9526692022-02-17 14:23:47 +08008040 }
8041
8042 /* mbedtls_x509_crt_verify_with_profile is supposed to report a
8043 * verification failure through MBEDTLS_ERR_X509_CERT_VERIFY_FAILED,
8044 * with details encoded in the verification flags. All other kinds
8045 * of error codes, including those from the user provided f_vrfy
8046 * functions, are treated as fatal and lead to a failure of
8047 * ssl_parse_certificate even if verification was optional. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008048 if (authmode == MBEDTLS_SSL_VERIFY_OPTIONAL &&
8049 (ret == MBEDTLS_ERR_X509_CERT_VERIFY_FAILED ||
8050 ret == MBEDTLS_ERR_SSL_BAD_CERTIFICATE)) {
Jerry Yud9526692022-02-17 14:23:47 +08008051 ret = 0;
8052 }
8053
Gilles Peskine449bd832023-01-11 14:50:10 +01008054 if (have_ca_chain == 0 && authmode == MBEDTLS_SSL_VERIFY_REQUIRED) {
8055 MBEDTLS_SSL_DEBUG_MSG(1, ("got no CA chain"));
Jerry Yud9526692022-02-17 14:23:47 +08008056 ret = MBEDTLS_ERR_SSL_CA_CHAIN_REQUIRED;
8057 }
8058
Gilles Peskine449bd832023-01-11 14:50:10 +01008059 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08008060 uint8_t alert;
8061
8062 /* The certificate may have been rejected for several reasons.
8063 Pick one and send the corresponding alert. Which alert to send
8064 may be a subject of debate in some cases. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008065 if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_OTHER) {
Jerry Yud9526692022-02-17 14:23:47 +08008066 alert = MBEDTLS_SSL_ALERT_MSG_ACCESS_DENIED;
Gilles Peskine449bd832023-01-11 14:50:10 +01008067 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_CN_MISMATCH) {
Jerry Yud9526692022-02-17 14:23:47 +08008068 alert = MBEDTLS_SSL_ALERT_MSG_BAD_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01008069 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_KEY_USAGE) {
Jerry Yud9526692022-02-17 14:23:47 +08008070 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01008071 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_EXT_KEY_USAGE) {
Jerry Yud9526692022-02-17 14:23:47 +08008072 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01008073 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_NS_CERT_TYPE) {
Jerry Yud9526692022-02-17 14:23:47 +08008074 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01008075 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_BAD_PK) {
Jerry Yud9526692022-02-17 14:23:47 +08008076 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01008077 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_BAD_KEY) {
Jerry Yud9526692022-02-17 14:23:47 +08008078 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01008079 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_EXPIRED) {
Jerry Yud9526692022-02-17 14:23:47 +08008080 alert = MBEDTLS_SSL_ALERT_MSG_CERT_EXPIRED;
Gilles Peskine449bd832023-01-11 14:50:10 +01008081 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_REVOKED) {
Jerry Yud9526692022-02-17 14:23:47 +08008082 alert = MBEDTLS_SSL_ALERT_MSG_CERT_REVOKED;
Gilles Peskine449bd832023-01-11 14:50:10 +01008083 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_NOT_TRUSTED) {
Jerry Yud9526692022-02-17 14:23:47 +08008084 alert = MBEDTLS_SSL_ALERT_MSG_UNKNOWN_CA;
Gilles Peskine449bd832023-01-11 14:50:10 +01008085 } else {
Jerry Yud9526692022-02-17 14:23:47 +08008086 alert = MBEDTLS_SSL_ALERT_MSG_CERT_UNKNOWN;
Gilles Peskine449bd832023-01-11 14:50:10 +01008087 }
8088 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8089 alert);
Jerry Yud9526692022-02-17 14:23:47 +08008090 }
8091
8092#if defined(MBEDTLS_DEBUG_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008093 if (ssl->session_negotiate->verify_result != 0) {
8094 MBEDTLS_SSL_DEBUG_MSG(3, ("! Certificate verification flags %08x",
8095 (unsigned int) ssl->session_negotiate->verify_result));
8096 } else {
8097 MBEDTLS_SSL_DEBUG_MSG(3, ("Certificate verification flags clear"));
Jerry Yud9526692022-02-17 14:23:47 +08008098 }
8099#endif /* MBEDTLS_DEBUG_C */
8100
Gilles Peskine449bd832023-01-11 14:50:10 +01008101 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08008102}
8103
8104#if !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02008105MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01008106static int ssl_remember_peer_crt_digest(mbedtls_ssl_context *ssl,
8107 unsigned char *start, size_t len)
Jerry Yud9526692022-02-17 14:23:47 +08008108{
8109 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
8110 /* Remember digest of the peer's end-CRT. */
8111 ssl->session_negotiate->peer_cert_digest =
Gilles Peskine449bd832023-01-11 14:50:10 +01008112 mbedtls_calloc(1, MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN);
8113 if (ssl->session_negotiate->peer_cert_digest == NULL) {
8114 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc(%d bytes) failed",
8115 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN));
8116 mbedtls_ssl_send_alert_message(ssl,
8117 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8118 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR);
Jerry Yud9526692022-02-17 14:23:47 +08008119
Gilles Peskine449bd832023-01-11 14:50:10 +01008120 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
Jerry Yud9526692022-02-17 14:23:47 +08008121 }
8122
Gilles Peskine449bd832023-01-11 14:50:10 +01008123 ret = mbedtls_md(mbedtls_md_info_from_type(
8124 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE),
8125 start, len,
8126 ssl->session_negotiate->peer_cert_digest);
Jerry Yud9526692022-02-17 14:23:47 +08008127
8128 ssl->session_negotiate->peer_cert_digest_type =
8129 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE;
8130 ssl->session_negotiate->peer_cert_digest_len =
8131 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN;
8132
Gilles Peskine449bd832023-01-11 14:50:10 +01008133 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08008134}
8135
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02008136MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01008137static int ssl_remember_peer_pubkey(mbedtls_ssl_context *ssl,
8138 unsigned char *start, size_t len)
Jerry Yud9526692022-02-17 14:23:47 +08008139{
8140 unsigned char *end = start + len;
8141 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
8142
8143 /* Make a copy of the peer's raw public key. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008144 mbedtls_pk_init(&ssl->handshake->peer_pubkey);
8145 ret = mbedtls_pk_parse_subpubkey(&start, end,
8146 &ssl->handshake->peer_pubkey);
8147 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08008148 /* We should have parsed the public key before. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008149 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08008150 }
8151
Gilles Peskine449bd832023-01-11 14:50:10 +01008152 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08008153}
8154#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
8155
Gilles Peskine449bd832023-01-11 14:50:10 +01008156int mbedtls_ssl_parse_certificate(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08008157{
8158 int ret = 0;
8159 int crt_expected;
8160#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
8161 const int authmode = ssl->handshake->sni_authmode != MBEDTLS_SSL_VERIFY_UNSET
8162 ? ssl->handshake->sni_authmode
8163 : ssl->conf->authmode;
8164#else
8165 const int authmode = ssl->conf->authmode;
8166#endif
8167 void *rs_ctx = NULL;
8168 mbedtls_x509_crt *chain = NULL;
8169
Gilles Peskine449bd832023-01-11 14:50:10 +01008170 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08008171
Gilles Peskine449bd832023-01-11 14:50:10 +01008172 crt_expected = ssl_parse_certificate_coordinate(ssl, authmode);
8173 if (crt_expected == SSL_CERTIFICATE_SKIP) {
8174 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08008175 goto exit;
8176 }
8177
8178#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01008179 if (ssl->handshake->ecrs_enabled &&
8180 ssl->handshake->ecrs_state == ssl_ecrs_crt_verify) {
Jerry Yud9526692022-02-17 14:23:47 +08008181 chain = ssl->handshake->ecrs_peer_cert;
8182 ssl->handshake->ecrs_peer_cert = NULL;
8183 goto crt_verify;
8184 }
8185#endif
8186
Gilles Peskine449bd832023-01-11 14:50:10 +01008187 if ((ret = mbedtls_ssl_read_record(ssl, 1)) != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08008188 /* mbedtls_ssl_read_record may have sent an alert already. We
8189 let it decide whether to alert. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008190 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_read_record", ret);
Jerry Yud9526692022-02-17 14:23:47 +08008191 goto exit;
8192 }
8193
8194#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008195 if (ssl_srv_check_client_no_crt_notification(ssl) == 0) {
Jerry Yud9526692022-02-17 14:23:47 +08008196 ssl->session_negotiate->verify_result = MBEDTLS_X509_BADCERT_MISSING;
8197
Gilles Peskine449bd832023-01-11 14:50:10 +01008198 if (authmode != MBEDTLS_SSL_VERIFY_OPTIONAL) {
Jerry Yud9526692022-02-17 14:23:47 +08008199 ret = MBEDTLS_ERR_SSL_NO_CLIENT_CERTIFICATE;
Gilles Peskine449bd832023-01-11 14:50:10 +01008200 }
Jerry Yud9526692022-02-17 14:23:47 +08008201
8202 goto exit;
8203 }
8204#endif /* MBEDTLS_SSL_SRV_C */
8205
8206 /* Clear existing peer CRT structure in case we tried to
8207 * reuse a session but it failed, and allocate a new one. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008208 ssl_clear_peer_cert(ssl->session_negotiate);
Jerry Yud9526692022-02-17 14:23:47 +08008209
Gilles Peskine449bd832023-01-11 14:50:10 +01008210 chain = mbedtls_calloc(1, sizeof(mbedtls_x509_crt));
8211 if (chain == NULL) {
8212 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc(%" MBEDTLS_PRINTF_SIZET " bytes) failed",
8213 sizeof(mbedtls_x509_crt)));
8214 mbedtls_ssl_send_alert_message(ssl,
8215 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8216 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR);
Jerry Yud9526692022-02-17 14:23:47 +08008217
8218 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
8219 goto exit;
8220 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008221 mbedtls_x509_crt_init(chain);
Jerry Yud9526692022-02-17 14:23:47 +08008222
Gilles Peskine449bd832023-01-11 14:50:10 +01008223 ret = ssl_parse_certificate_chain(ssl, chain);
8224 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08008225 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01008226 }
Jerry Yud9526692022-02-17 14:23:47 +08008227
8228#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01008229 if (ssl->handshake->ecrs_enabled) {
Jerry Yud9526692022-02-17 14:23:47 +08008230 ssl->handshake->ecrs_state = ssl_ecrs_crt_verify;
Gilles Peskine449bd832023-01-11 14:50:10 +01008231 }
Jerry Yud9526692022-02-17 14:23:47 +08008232
8233crt_verify:
Gilles Peskine449bd832023-01-11 14:50:10 +01008234 if (ssl->handshake->ecrs_enabled) {
Jerry Yud9526692022-02-17 14:23:47 +08008235 rs_ctx = &ssl->handshake->ecrs_ctx;
Gilles Peskine449bd832023-01-11 14:50:10 +01008236 }
Jerry Yud9526692022-02-17 14:23:47 +08008237#endif
8238
Gilles Peskine449bd832023-01-11 14:50:10 +01008239 ret = ssl_parse_certificate_verify(ssl, authmode,
8240 chain, rs_ctx);
8241 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08008242 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01008243 }
Jerry Yud9526692022-02-17 14:23:47 +08008244
8245#if !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
8246 {
8247 unsigned char *crt_start, *pk_start;
8248 size_t crt_len, pk_len;
8249
8250 /* We parse the CRT chain without copying, so
8251 * these pointers point into the input buffer,
8252 * and are hence still valid after freeing the
8253 * CRT chain. */
8254
8255 crt_start = chain->raw.p;
8256 crt_len = chain->raw.len;
8257
8258 pk_start = chain->pk_raw.p;
8259 pk_len = chain->pk_raw.len;
8260
8261 /* Free the CRT structures before computing
8262 * digest and copying the peer's public key. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008263 mbedtls_x509_crt_free(chain);
8264 mbedtls_free(chain);
Jerry Yud9526692022-02-17 14:23:47 +08008265 chain = NULL;
8266
Gilles Peskine449bd832023-01-11 14:50:10 +01008267 ret = ssl_remember_peer_crt_digest(ssl, crt_start, crt_len);
8268 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08008269 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01008270 }
Jerry Yud9526692022-02-17 14:23:47 +08008271
Gilles Peskine449bd832023-01-11 14:50:10 +01008272 ret = ssl_remember_peer_pubkey(ssl, pk_start, pk_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 }
8277#else /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
8278 /* Pass ownership to session structure. */
8279 ssl->session_negotiate->peer_cert = chain;
8280 chain = NULL;
8281#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
8282
Gilles Peskine449bd832023-01-11 14:50:10 +01008283 MBEDTLS_SSL_DEBUG_MSG(2, ("<= parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08008284
8285exit:
8286
Gilles Peskine449bd832023-01-11 14:50:10 +01008287 if (ret == 0) {
Jerry Yud9526692022-02-17 14:23:47 +08008288 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01008289 }
Jerry Yud9526692022-02-17 14:23:47 +08008290
8291#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01008292 if (ret == MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS) {
Jerry Yud9526692022-02-17 14:23:47 +08008293 ssl->handshake->ecrs_peer_cert = chain;
8294 chain = NULL;
8295 }
8296#endif
8297
Gilles Peskine449bd832023-01-11 14:50:10 +01008298 if (chain != NULL) {
8299 mbedtls_x509_crt_free(chain);
8300 mbedtls_free(chain);
Jerry Yud9526692022-02-17 14:23:47 +08008301 }
8302
Gilles Peskine449bd832023-01-11 14:50:10 +01008303 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08008304}
8305#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
8306
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008307static int ssl_calc_finished_tls_generic(mbedtls_ssl_context *ssl, void *ctx,
8308 unsigned char *padbuf, size_t hlen,
8309 unsigned char *buf, int from)
Jerry Yu615bd6f2022-02-17 14:25:15 +08008310{
Dave Rodgmanc37ad442023-11-03 23:36:06 +00008311 unsigned int len = 12;
Jerry Yu615bd6f2022-02-17 14:25:15 +08008312 const char *sender;
Jerry Yu615bd6f2022-02-17 14:25:15 +08008313#if defined(MBEDTLS_USE_PSA_CRYPTO)
Jerry Yu615bd6f2022-02-17 14:25:15 +08008314 psa_status_t status;
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008315 psa_hash_operation_t *hs_op = ctx;
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02008316 psa_hash_operation_t cloned_op = PSA_HASH_OPERATION_INIT;
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008317 size_t hash_size;
Jerry Yu615bd6f2022-02-17 14:25:15 +08008318#else
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01008319 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008320 mbedtls_md_context_t *hs_ctx = ctx;
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02008321 mbedtls_md_context_t cloned_ctx;
8322 mbedtls_md_init(&cloned_ctx);
Jerry Yu615bd6f2022-02-17 14:25:15 +08008323#endif
8324
8325 mbedtls_ssl_session *session = ssl->session_negotiate;
Gilles Peskine449bd832023-01-11 14:50:10 +01008326 if (!session) {
Jerry Yu615bd6f2022-02-17 14:25:15 +08008327 session = ssl->session;
Gilles Peskine449bd832023-01-11 14:50:10 +01008328 }
Jerry Yu615bd6f2022-02-17 14:25:15 +08008329
Gilles Peskine449bd832023-01-11 14:50:10 +01008330 sender = (from == MBEDTLS_SSL_IS_CLIENT)
Jerry Yu615bd6f2022-02-17 14:25:15 +08008331 ? "client finished"
8332 : "server finished";
8333
8334#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008335 MBEDTLS_SSL_DEBUG_MSG(2, ("=> calc PSA finished tls"));
Jerry Yu615bd6f2022-02-17 14:25:15 +08008336
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02008337 status = psa_hash_clone(hs_op, &cloned_op);
Gilles Peskine449bd832023-01-11 14:50:10 +01008338 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01008339 goto exit;
Jerry Yu615bd6f2022-02-17 14:25:15 +08008340 }
8341
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02008342 status = psa_hash_finish(&cloned_op, padbuf, hlen, &hash_size);
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 }
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008346 MBEDTLS_SSL_DEBUG_BUF(3, "PSA calculated padbuf", padbuf, hlen);
Jerry Yu615bd6f2022-02-17 14:25:15 +08008347#else
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008348 MBEDTLS_SSL_DEBUG_MSG(2, ("=> calc finished tls"));
Jerry Yu615bd6f2022-02-17 14:25:15 +08008349
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02008350 ret = mbedtls_md_setup(&cloned_ctx, mbedtls_md_info_from_ctx(hs_ctx), 0);
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01008351 if (ret != 0) {
8352 goto exit;
8353 }
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02008354 ret = mbedtls_md_clone(&cloned_ctx, hs_ctx);
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01008355 if (ret != 0) {
8356 goto exit;
8357 }
Jerry Yu615bd6f2022-02-17 14:25:15 +08008358
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02008359 ret = mbedtls_md_finish(&cloned_ctx, padbuf);
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008360 if (ret != 0) {
8361 goto exit;
8362 }
8363#endif /* MBEDTLS_USE_PSA_CRYPTO */
8364
8365 MBEDTLS_SSL_DEBUG_BUF(4, "finished output", padbuf, hlen);
8366
Jerry Yu615bd6f2022-02-17 14:25:15 +08008367 /*
8368 * TLSv1.2:
8369 * hash = PRF( master, finished_label,
8370 * Hash( handshake ) )[0.11]
8371 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008372 ssl->handshake->tls_prf(session->master, 48, sender,
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008373 padbuf, hlen, buf, len);
Jerry Yu615bd6f2022-02-17 14:25:15 +08008374
Gilles Peskine449bd832023-01-11 14:50:10 +01008375 MBEDTLS_SSL_DEBUG_BUF(3, "calc finished result", buf, len);
Jerry Yu615bd6f2022-02-17 14:25:15 +08008376
Paul Elliottecb95be2023-08-11 16:41:04 +01008377 mbedtls_platform_zeroize(padbuf, hlen);
Jerry Yu615bd6f2022-02-17 14:25:15 +08008378
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008379 MBEDTLS_SSL_DEBUG_MSG(2, ("<= calc finished"));
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01008380
8381exit:
8382#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02008383 psa_hash_abort(&cloned_op);
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +02008384 return mbedtls_md_error_from_psa(status);
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01008385#else
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02008386 mbedtls_md_free(&cloned_ctx);
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01008387 return ret;
8388#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu615bd6f2022-02-17 14:25:15 +08008389}
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008390
8391#if defined(MBEDTLS_MD_CAN_SHA256)
8392static int ssl_calc_finished_tls_sha256(
8393 mbedtls_ssl_context *ssl, unsigned char *buf, int from)
8394{
8395 unsigned char padbuf[32];
8396 return ssl_calc_finished_tls_generic(ssl,
8397#if defined(MBEDTLS_USE_PSA_CRYPTO)
8398 &ssl->handshake->fin_sha256_psa,
8399#else
8400 &ssl->handshake->fin_sha256,
8401#endif
8402 padbuf, sizeof(padbuf),
8403 buf, from);
8404}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01008405#endif /* MBEDTLS_MD_CAN_SHA256*/
Jerry Yu615bd6f2022-02-17 14:25:15 +08008406
Jerry Yub7ba49e2022-02-17 14:25:53 +08008407
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01008408#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +01008409static int ssl_calc_finished_tls_sha384(
Gilles Peskine449bd832023-01-11 14:50:10 +01008410 mbedtls_ssl_context *ssl, unsigned char *buf, int from)
Jerry Yub7ba49e2022-02-17 14:25:53 +08008411{
Jerry Yub7ba49e2022-02-17 14:25:53 +08008412 unsigned char padbuf[48];
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008413 return ssl_calc_finished_tls_generic(ssl,
Jerry Yub7ba49e2022-02-17 14:25:53 +08008414#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008415 &ssl->handshake->fin_sha384_psa,
Jerry Yub7ba49e2022-02-17 14:25:53 +08008416#else
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008417 &ssl->handshake->fin_sha384,
Jerry Yub7ba49e2022-02-17 14:25:53 +08008418#endif
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008419 padbuf, sizeof(padbuf),
8420 buf, from);
Jerry Yub7ba49e2022-02-17 14:25:53 +08008421}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01008422#endif /* MBEDTLS_MD_CAN_SHA384*/
Jerry Yub7ba49e2022-02-17 14:25:53 +08008423
Gilles Peskine449bd832023-01-11 14:50:10 +01008424void mbedtls_ssl_handshake_wrapup_free_hs_transform(mbedtls_ssl_context *ssl)
Jerry Yuaef00152022-02-17 14:27:31 +08008425{
Gilles Peskine449bd832023-01-11 14:50:10 +01008426 MBEDTLS_SSL_DEBUG_MSG(3, ("=> handshake wrapup: final free"));
Jerry Yuaef00152022-02-17 14:27:31 +08008427
8428 /*
8429 * Free our handshake params
8430 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008431 mbedtls_ssl_handshake_free(ssl);
8432 mbedtls_free(ssl->handshake);
Jerry Yuaef00152022-02-17 14:27:31 +08008433 ssl->handshake = NULL;
8434
8435 /*
Shaun Case8b0ecbc2021-12-20 21:14:10 -08008436 * Free the previous transform and switch in the current one
Jerry Yuaef00152022-02-17 14:27:31 +08008437 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008438 if (ssl->transform) {
8439 mbedtls_ssl_transform_free(ssl->transform);
8440 mbedtls_free(ssl->transform);
Jerry Yuaef00152022-02-17 14:27:31 +08008441 }
8442 ssl->transform = ssl->transform_negotiate;
8443 ssl->transform_negotiate = NULL;
8444
Gilles Peskine449bd832023-01-11 14:50:10 +01008445 MBEDTLS_SSL_DEBUG_MSG(3, ("<= handshake wrapup: final free"));
Jerry Yuaef00152022-02-17 14:27:31 +08008446}
8447
Gilles Peskine449bd832023-01-11 14:50:10 +01008448void mbedtls_ssl_handshake_wrapup(mbedtls_ssl_context *ssl)
Jerry Yu2a9fff52022-02-17 14:28:51 +08008449{
8450 int resume = ssl->handshake->resume;
8451
Gilles Peskine449bd832023-01-11 14:50:10 +01008452 MBEDTLS_SSL_DEBUG_MSG(3, ("=> handshake wrapup"));
Jerry Yu2a9fff52022-02-17 14:28:51 +08008453
8454#if defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01008455 if (ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS) {
Jerry Yu2a9fff52022-02-17 14:28:51 +08008456 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_DONE;
8457 ssl->renego_records_seen = 0;
8458 }
8459#endif
8460
8461 /*
8462 * Free the previous session and switch in the current one
8463 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008464 if (ssl->session) {
Jerry Yu2a9fff52022-02-17 14:28:51 +08008465#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
8466 /* RFC 7366 3.1: keep the EtM state */
8467 ssl->session_negotiate->encrypt_then_mac =
Gilles Peskine449bd832023-01-11 14:50:10 +01008468 ssl->session->encrypt_then_mac;
Jerry Yu2a9fff52022-02-17 14:28:51 +08008469#endif
8470
Gilles Peskine449bd832023-01-11 14:50:10 +01008471 mbedtls_ssl_session_free(ssl->session);
8472 mbedtls_free(ssl->session);
Jerry Yu2a9fff52022-02-17 14:28:51 +08008473 }
8474 ssl->session = ssl->session_negotiate;
8475 ssl->session_negotiate = NULL;
8476
8477 /*
8478 * Add cache entry
8479 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008480 if (ssl->conf->f_set_cache != NULL &&
Jerry Yu2a9fff52022-02-17 14:28:51 +08008481 ssl->session->id_len != 0 &&
Gilles Peskine449bd832023-01-11 14:50:10 +01008482 resume == 0) {
8483 if (ssl->conf->f_set_cache(ssl->conf->p_cache,
8484 ssl->session->id,
8485 ssl->session->id_len,
8486 ssl->session) != 0) {
8487 MBEDTLS_SSL_DEBUG_MSG(1, ("cache did not store session"));
8488 }
Jerry Yu2a9fff52022-02-17 14:28:51 +08008489 }
8490
8491#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01008492 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
8493 ssl->handshake->flight != NULL) {
Jerry Yu2a9fff52022-02-17 14:28:51 +08008494 /* Cancel handshake timer */
Gilles Peskine449bd832023-01-11 14:50:10 +01008495 mbedtls_ssl_set_timer(ssl, 0);
Jerry Yu2a9fff52022-02-17 14:28:51 +08008496
8497 /* Keep last flight around in case we need to resend it:
8498 * we need the handshake and transform structures for that */
Gilles Peskine449bd832023-01-11 14:50:10 +01008499 MBEDTLS_SSL_DEBUG_MSG(3, ("skip freeing handshake and transform"));
8500 } else
Jerry Yu2a9fff52022-02-17 14:28:51 +08008501#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01008502 mbedtls_ssl_handshake_wrapup_free_hs_transform(ssl);
Jerry Yu2a9fff52022-02-17 14:28:51 +08008503
Jerry Yu5ed73ff2022-10-27 13:08:42 +08008504 ssl->state = MBEDTLS_SSL_HANDSHAKE_OVER;
Jerry Yu2a9fff52022-02-17 14:28:51 +08008505
Gilles Peskine449bd832023-01-11 14:50:10 +01008506 MBEDTLS_SSL_DEBUG_MSG(3, ("<= handshake wrapup"));
Jerry Yu2a9fff52022-02-17 14:28:51 +08008507}
8508
Gilles Peskine449bd832023-01-11 14:50:10 +01008509int mbedtls_ssl_write_finished(mbedtls_ssl_context *ssl)
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008510{
Dave Rodgmanc37ad442023-11-03 23:36:06 +00008511 int ret;
8512 unsigned int hash_len;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008513
Gilles Peskine449bd832023-01-11 14:50:10 +01008514 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write finished"));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008515
Gilles Peskine449bd832023-01-11 14:50:10 +01008516 mbedtls_ssl_update_out_pointers(ssl, ssl->transform_negotiate);
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008517
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01008518 ret = ssl->handshake->calc_finished(ssl, ssl->out_msg + 4, ssl->conf->endpoint);
8519 if (ret != 0) {
8520 MBEDTLS_SSL_DEBUG_RET(1, "calc_finished", ret);
8521 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008522
8523 /*
8524 * RFC 5246 7.4.9 (Page 63) says 12 is the default length and ciphersuites
8525 * may define some other value. Currently (early 2016), no defined
8526 * ciphersuite does this (and this is unlikely to change as activity has
8527 * moved to TLS 1.3 now) so we can keep the hardcoded 12 here.
8528 */
8529 hash_len = 12;
8530
8531#if defined(MBEDTLS_SSL_RENEGOTIATION)
8532 ssl->verify_data_len = hash_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01008533 memcpy(ssl->own_verify_data, ssl->out_msg + 4, hash_len);
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008534#endif
8535
8536 ssl->out_msglen = 4 + hash_len;
8537 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
8538 ssl->out_msg[0] = MBEDTLS_SSL_HS_FINISHED;
8539
8540 /*
8541 * In case of session resuming, invert the client and server
8542 * ChangeCipherSpec messages order.
8543 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008544 if (ssl->handshake->resume != 0) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008545#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008546 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008547 ssl->state = MBEDTLS_SSL_HANDSHAKE_WRAPUP;
Gilles Peskine449bd832023-01-11 14:50:10 +01008548 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008549#endif
8550#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008551 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008552 ssl->state = MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC;
Gilles Peskine449bd832023-01-11 14:50:10 +01008553 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008554#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01008555 } else {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008556 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01008557 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008558
8559 /*
8560 * Switch to our negotiated transform and session parameters for outbound
8561 * data.
8562 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008563 MBEDTLS_SSL_DEBUG_MSG(3, ("switching to new transform spec for outbound data"));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008564
8565#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01008566 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008567 unsigned char i;
8568
8569 /* Remember current epoch settings for resending */
8570 ssl->handshake->alt_transform_out = ssl->transform_out;
Gilles Peskine449bd832023-01-11 14:50:10 +01008571 memcpy(ssl->handshake->alt_out_ctr, ssl->cur_out_ctr,
8572 sizeof(ssl->handshake->alt_out_ctr));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008573
8574 /* Set sequence_number to zero */
Gilles Peskine449bd832023-01-11 14:50:10 +01008575 memset(&ssl->cur_out_ctr[2], 0, sizeof(ssl->cur_out_ctr) - 2);
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008576
8577
8578 /* Increment epoch */
Gilles Peskine449bd832023-01-11 14:50:10 +01008579 for (i = 2; i > 0; i--) {
8580 if (++ssl->cur_out_ctr[i - 1] != 0) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008581 break;
Gilles Peskine449bd832023-01-11 14:50:10 +01008582 }
8583 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008584
8585 /* The loop goes to its end iff the counter is wrapping */
Gilles Peskine449bd832023-01-11 14:50:10 +01008586 if (i == 0) {
8587 MBEDTLS_SSL_DEBUG_MSG(1, ("DTLS epoch would wrap"));
8588 return MBEDTLS_ERR_SSL_COUNTER_WRAPPING;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008589 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008590 } else
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008591#endif /* MBEDTLS_SSL_PROTO_DTLS */
Gilles Peskine449bd832023-01-11 14:50:10 +01008592 memset(ssl->cur_out_ctr, 0, sizeof(ssl->cur_out_ctr));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008593
8594 ssl->transform_out = ssl->transform_negotiate;
8595 ssl->session_out = ssl->session_negotiate;
8596
8597#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01008598 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
8599 mbedtls_ssl_send_flight_completed(ssl);
8600 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008601#endif
8602
Gilles Peskine449bd832023-01-11 14:50:10 +01008603 if ((ret = mbedtls_ssl_write_handshake_msg(ssl)) != 0) {
8604 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_handshake_msg", ret);
8605 return ret;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008606 }
8607
8608#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01008609 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
8610 (ret = mbedtls_ssl_flight_transmit(ssl)) != 0) {
8611 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_flight_transmit", ret);
8612 return ret;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008613 }
8614#endif
8615
Gilles Peskine449bd832023-01-11 14:50:10 +01008616 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write finished"));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008617
Gilles Peskine449bd832023-01-11 14:50:10 +01008618 return 0;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008619}
8620
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008621#define SSL_MAX_HASH_LEN 12
8622
Gilles Peskine449bd832023-01-11 14:50:10 +01008623int mbedtls_ssl_parse_finished(mbedtls_ssl_context *ssl)
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008624{
8625 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
8626 unsigned int hash_len = 12;
8627 unsigned char buf[SSL_MAX_HASH_LEN];
8628
Gilles Peskine449bd832023-01-11 14:50:10 +01008629 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse finished"));
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008630
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01008631 ret = ssl->handshake->calc_finished(ssl, buf, ssl->conf->endpoint ^ 1);
8632 if (ret != 0) {
8633 MBEDTLS_SSL_DEBUG_RET(1, "calc_finished", ret);
8634 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008635
Gilles Peskine449bd832023-01-11 14:50:10 +01008636 if ((ret = mbedtls_ssl_read_record(ssl, 1)) != 0) {
8637 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_read_record", ret);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008638 goto exit;
8639 }
8640
Gilles Peskine449bd832023-01-11 14:50:10 +01008641 if (ssl->in_msgtype != MBEDTLS_SSL_MSG_HANDSHAKE) {
8642 MBEDTLS_SSL_DEBUG_MSG(1, ("bad finished message"));
8643 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8644 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008645 ret = MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
8646 goto exit;
8647 }
8648
Gilles Peskine449bd832023-01-11 14:50:10 +01008649 if (ssl->in_msg[0] != MBEDTLS_SSL_HS_FINISHED) {
8650 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8651 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008652 ret = MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
8653 goto exit;
8654 }
8655
Gilles Peskine449bd832023-01-11 14:50:10 +01008656 if (ssl->in_hslen != mbedtls_ssl_hs_hdr_len(ssl) + hash_len) {
8657 MBEDTLS_SSL_DEBUG_MSG(1, ("bad finished message"));
8658 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8659 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008660 ret = MBEDTLS_ERR_SSL_DECODE_ERROR;
8661 goto exit;
8662 }
8663
Gilles Peskine449bd832023-01-11 14:50:10 +01008664 if (mbedtls_ct_memcmp(ssl->in_msg + mbedtls_ssl_hs_hdr_len(ssl),
8665 buf, hash_len) != 0) {
8666 MBEDTLS_SSL_DEBUG_MSG(1, ("bad finished message"));
8667 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8668 MBEDTLS_SSL_ALERT_MSG_DECRYPT_ERROR);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008669 ret = MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
8670 goto exit;
8671 }
8672
8673#if defined(MBEDTLS_SSL_RENEGOTIATION)
8674 ssl->verify_data_len = hash_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01008675 memcpy(ssl->peer_verify_data, buf, hash_len);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008676#endif
8677
Gilles Peskine449bd832023-01-11 14:50:10 +01008678 if (ssl->handshake->resume != 0) {
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008679#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008680 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008681 ssl->state = MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC;
Gilles Peskine449bd832023-01-11 14:50:10 +01008682 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008683#endif
8684#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008685 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008686 ssl->state = MBEDTLS_SSL_HANDSHAKE_WRAPUP;
Gilles Peskine449bd832023-01-11 14:50:10 +01008687 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008688#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01008689 } else {
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008690 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01008691 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008692
8693#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01008694 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
8695 mbedtls_ssl_recv_flight_completed(ssl);
8696 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008697#endif
8698
Gilles Peskine449bd832023-01-11 14:50:10 +01008699 MBEDTLS_SSL_DEBUG_MSG(2, ("<= parse finished"));
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008700
8701exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01008702 mbedtls_platform_zeroize(buf, hash_len);
8703 return ret;
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008704}
8705
Jerry Yu392112c2022-02-17 14:34:10 +08008706#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
8707/*
8708 * Helper to get TLS 1.2 PRF from ciphersuite
8709 * (Duplicates bits of logic from ssl_set_handshake_prfs().)
8710 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008711static tls_prf_fn ssl_tls12prf_from_cs(int ciphersuite_id)
Jerry Yu392112c2022-02-17 14:34:10 +08008712{
Jerry Yu392112c2022-02-17 14:34:10 +08008713 const mbedtls_ssl_ciphersuite_t * const ciphersuite_info =
Gilles Peskine449bd832023-01-11 14:50:10 +01008714 mbedtls_ssl_ciphersuite_from_id(ciphersuite_id);
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01008715#if defined(MBEDTLS_MD_CAN_SHA384)
Gilles Peskine449bd832023-01-11 14:50:10 +01008716 if (ciphersuite_info != NULL && ciphersuite_info->mac == MBEDTLS_MD_SHA384) {
8717 return tls_prf_sha384;
8718 } else
Jerry Yu392112c2022-02-17 14:34:10 +08008719#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01008720#if defined(MBEDTLS_MD_CAN_SHA256)
Andrzej Kurek894edde2022-09-29 06:31:14 -04008721 {
Gilles Peskine449bd832023-01-11 14:50:10 +01008722 if (ciphersuite_info != NULL && ciphersuite_info->mac == MBEDTLS_MD_SHA256) {
8723 return tls_prf_sha256;
8724 }
Andrzej Kurek894edde2022-09-29 06:31:14 -04008725 }
8726#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01008727#if !defined(MBEDTLS_MD_CAN_SHA384) && \
8728 !defined(MBEDTLS_MD_CAN_SHA256)
Andrzej Kurek894edde2022-09-29 06:31:14 -04008729 (void) ciphersuite_info;
8730#endif
Andrzej Kurekeabeb302022-10-17 07:52:51 -04008731
Gilles Peskine449bd832023-01-11 14:50:10 +01008732 return NULL;
Jerry Yu392112c2022-02-17 14:34:10 +08008733}
8734#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
Jerry Yue93ffcd2022-02-17 14:37:06 +08008735
Gilles Peskine449bd832023-01-11 14:50:10 +01008736static mbedtls_tls_prf_types tls_prf_get_type(mbedtls_ssl_tls_prf_cb *tls_prf)
Jerry Yue93ffcd2022-02-17 14:37:06 +08008737{
8738 ((void) tls_prf);
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01008739#if defined(MBEDTLS_MD_CAN_SHA384)
Gilles Peskine449bd832023-01-11 14:50:10 +01008740 if (tls_prf == tls_prf_sha384) {
8741 return MBEDTLS_SSL_TLS_PRF_SHA384;
8742 } else
Jerry Yue93ffcd2022-02-17 14:37:06 +08008743#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01008744#if defined(MBEDTLS_MD_CAN_SHA256)
Gilles Peskine449bd832023-01-11 14:50:10 +01008745 if (tls_prf == tls_prf_sha256) {
8746 return MBEDTLS_SSL_TLS_PRF_SHA256;
8747 } else
Jerry Yue93ffcd2022-02-17 14:37:06 +08008748#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01008749 return MBEDTLS_SSL_TLS_PRF_NONE;
Jerry Yue93ffcd2022-02-17 14:37:06 +08008750}
8751
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008752/*
8753 * Populate a transform structure with session keys and all the other
8754 * necessary information.
8755 *
8756 * Parameters:
8757 * - [in/out]: transform: structure to populate
8758 * [in] must be just initialised with mbedtls_ssl_transform_init()
8759 * [out] fully populated, ready for use by mbedtls_ssl_{en,de}crypt_buf()
8760 * - [in] ciphersuite
8761 * - [in] master
8762 * - [in] encrypt_then_mac
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008763 * - [in] tls_prf: pointer to PRF to use for key derivation
8764 * - [in] randbytes: buffer holding ServerHello.random + ClientHello.random
Glenn Strauss07c64162022-03-14 12:34:51 -04008765 * - [in] tls_version: TLS version
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008766 * - [in] endpoint: client or server
8767 * - [in] ssl: used for:
8768 * - ssl->conf->{f,p}_export_keys
8769 * [in] optionally used for:
8770 * - MBEDTLS_DEBUG_C: ssl->conf->{f,p}_dbg
8771 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02008772MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01008773static int ssl_tls12_populate_transform(mbedtls_ssl_transform *transform,
8774 int ciphersuite,
8775 const unsigned char master[48],
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008776#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01008777 int encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008778#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01008779 ssl_tls_prf_t tls_prf,
8780 const unsigned char randbytes[64],
8781 mbedtls_ssl_protocol_version tls_version,
8782 unsigned endpoint,
8783 const mbedtls_ssl_context *ssl)
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008784{
8785 int ret = 0;
8786 unsigned char keyblk[256];
8787 unsigned char *key1;
8788 unsigned char *key2;
8789 unsigned char *mac_enc;
8790 unsigned char *mac_dec;
8791 size_t mac_key_len = 0;
8792 size_t iv_copy_len;
8793 size_t keylen;
8794 const mbedtls_ssl_ciphersuite_t *ciphersuite_info;
Neil Armstrong7fea33e2022-04-01 15:40:25 +02008795 mbedtls_ssl_mode_t ssl_mode;
Neil Armstronge4512952022-03-08 09:08:22 +01008796#if !defined(MBEDTLS_USE_PSA_CRYPTO)
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008797 const mbedtls_cipher_info_t *cipher_info;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008798 const mbedtls_md_info_t *md_info;
Neil Armstronge4512952022-03-08 09:08:22 +01008799#endif /* !MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008800
8801#if defined(MBEDTLS_USE_PSA_CRYPTO)
8802 psa_key_type_t key_type;
8803 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
8804 psa_algorithm_t alg;
Neil Armstronge4512952022-03-08 09:08:22 +01008805 psa_algorithm_t mac_alg = 0;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008806 size_t key_bits;
8807 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
8808#endif
8809
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008810 /*
8811 * Some data just needs copying into the structure
8812 */
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008813#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008814 transform->encrypt_then_mac = encrypt_then_mac;
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008815#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Glenn Strauss07c64162022-03-14 12:34:51 -04008816 transform->tls_version = tls_version;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008817
8818#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01008819 memcpy(transform->randbytes, randbytes, sizeof(transform->randbytes));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008820#endif
8821
8822#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01008823 if (tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008824 /* At the moment, we keep TLS <= 1.2 and TLS 1.3 transform
8825 * generation separate. This should never happen. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008826 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008827 }
8828#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
8829
8830 /*
8831 * Get various info structures
8832 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008833 ciphersuite_info = mbedtls_ssl_ciphersuite_from_id(ciphersuite);
8834 if (ciphersuite_info == NULL) {
8835 MBEDTLS_SSL_DEBUG_MSG(1, ("ciphersuite info for %d not found",
8836 ciphersuite));
8837 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008838 }
8839
Neil Armstrongab555e02022-04-04 11:07:59 +02008840 ssl_mode = mbedtls_ssl_get_mode_from_ciphersuite(
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008841#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01008842 encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008843#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01008844 ciphersuite_info);
Neil Armstrong7fea33e2022-04-01 15:40:25 +02008845
Gilles Peskine449bd832023-01-11 14:50:10 +01008846 if (ssl_mode == MBEDTLS_SSL_MODE_AEAD) {
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008847 transform->taglen =
8848 ciphersuite_info->flags & MBEDTLS_CIPHERSUITE_SHORT_TAG ? 8 : 16;
Gilles Peskine449bd832023-01-11 14:50:10 +01008849 }
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008850
8851#if defined(MBEDTLS_USE_PSA_CRYPTO)
Dave Rodgman2eab4622023-10-05 13:30:37 +01008852 if ((status = mbedtls_ssl_cipher_to_psa((mbedtls_cipher_type_t) ciphersuite_info->cipher,
Gilles Peskine449bd832023-01-11 14:50:10 +01008853 transform->taglen,
8854 &alg,
8855 &key_type,
8856 &key_bits)) != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008857 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01008858 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_cipher_to_psa", ret);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008859 goto end;
8860 }
8861#else
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01008862 cipher_info = mbedtls_cipher_info_from_type((mbedtls_cipher_type_t) ciphersuite_info->cipher);
Gilles Peskine449bd832023-01-11 14:50:10 +01008863 if (cipher_info == NULL) {
8864 MBEDTLS_SSL_DEBUG_MSG(1, ("cipher info for %u not found",
8865 ciphersuite_info->cipher));
8866 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008867 }
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008868#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008869
Neil Armstronge4512952022-03-08 09:08:22 +01008870#if defined(MBEDTLS_USE_PSA_CRYPTO)
Dave Rodgman2eab4622023-10-05 13:30:37 +01008871 mac_alg = mbedtls_md_psa_alg_from_type((mbedtls_md_type_t) ciphersuite_info->mac);
Gilles Peskine449bd832023-01-11 14:50:10 +01008872 if (mac_alg == 0) {
Manuel Pégourié-Gonnard2d6d9932023-03-28 11:38:08 +02008873 MBEDTLS_SSL_DEBUG_MSG(1, ("mbedtls_md_psa_alg_from_type for %u not found",
Gilles Peskine449bd832023-01-11 14:50:10 +01008874 (unsigned) ciphersuite_info->mac));
8875 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Neil Armstronge4512952022-03-08 09:08:22 +01008876 }
8877#else
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01008878 md_info = mbedtls_md_info_from_type((mbedtls_md_type_t) ciphersuite_info->mac);
Gilles Peskine449bd832023-01-11 14:50:10 +01008879 if (md_info == NULL) {
8880 MBEDTLS_SSL_DEBUG_MSG(1, ("mbedtls_md info for %u not found",
8881 (unsigned) ciphersuite_info->mac));
8882 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008883 }
Neil Armstronge4512952022-03-08 09:08:22 +01008884#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008885
8886#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
8887 /* Copy own and peer's CID if the use of the CID
8888 * extension has been negotiated. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008889 if (ssl->handshake->cid_in_use == MBEDTLS_SSL_CID_ENABLED) {
8890 MBEDTLS_SSL_DEBUG_MSG(3, ("Copy CIDs into SSL transform"));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008891
8892 transform->in_cid_len = ssl->own_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01008893 memcpy(transform->in_cid, ssl->own_cid, ssl->own_cid_len);
8894 MBEDTLS_SSL_DEBUG_BUF(3, "Incoming CID", transform->in_cid,
8895 transform->in_cid_len);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008896
8897 transform->out_cid_len = ssl->handshake->peer_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01008898 memcpy(transform->out_cid, ssl->handshake->peer_cid,
8899 ssl->handshake->peer_cid_len);
8900 MBEDTLS_SSL_DEBUG_BUF(3, "Outgoing CID", transform->out_cid,
8901 transform->out_cid_len);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008902 }
8903#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
8904
8905 /*
8906 * Compute key block using the PRF
8907 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008908 ret = tls_prf(master, 48, "key expansion", randbytes, 64, keyblk, 256);
8909 if (ret != 0) {
8910 MBEDTLS_SSL_DEBUG_RET(1, "prf", ret);
8911 return ret;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008912 }
8913
Gilles Peskine449bd832023-01-11 14:50:10 +01008914 MBEDTLS_SSL_DEBUG_MSG(3, ("ciphersuite = %s",
8915 mbedtls_ssl_get_ciphersuite_name(ciphersuite)));
8916 MBEDTLS_SSL_DEBUG_BUF(3, "master secret", master, 48);
8917 MBEDTLS_SSL_DEBUG_BUF(4, "random bytes", randbytes, 64);
8918 MBEDTLS_SSL_DEBUG_BUF(4, "key block", keyblk, 256);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008919
8920 /*
8921 * Determine the appropriate key, IV and MAC length.
8922 */
8923
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008924#if defined(MBEDTLS_USE_PSA_CRYPTO)
8925 keylen = PSA_BITS_TO_BYTES(key_bits);
8926#else
Gilles Peskine449bd832023-01-11 14:50:10 +01008927 keylen = mbedtls_cipher_info_get_key_bitlen(cipher_info) / 8;
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008928#endif
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008929
Valerio Settie5707042023-10-11 11:54:42 +02008930#if defined(MBEDTLS_SSL_HAVE_AEAD)
Gilles Peskine449bd832023-01-11 14:50:10 +01008931 if (ssl_mode == MBEDTLS_SSL_MODE_AEAD) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008932 size_t explicit_ivlen;
8933
8934 transform->maclen = 0;
8935 mac_key_len = 0;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008936
8937 /* All modes haves 96-bit IVs, but the length of the static parts vary
8938 * with mode and version:
8939 * - For GCM and CCM in TLS 1.2, there's a static IV of 4 Bytes
8940 * (to be concatenated with a dynamically chosen IV of 8 Bytes)
8941 * - For ChaChaPoly in TLS 1.2, and all modes in TLS 1.3, there's
8942 * a static IV of 12 Bytes (to be XOR'ed with the 8 Byte record
8943 * sequence number).
8944 */
8945 transform->ivlen = 12;
David Horstmann3b2276a2022-10-06 14:49:08 +01008946
8947 int is_chachapoly = 0;
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008948#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01008949 is_chachapoly = (key_type == PSA_KEY_TYPE_CHACHA20);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008950#else
Gilles Peskine449bd832023-01-11 14:50:10 +01008951 is_chachapoly = (mbedtls_cipher_info_get_mode(cipher_info)
8952 == MBEDTLS_MODE_CHACHAPOLY);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008953#endif /* MBEDTLS_USE_PSA_CRYPTO */
David Horstmann3b2276a2022-10-06 14:49:08 +01008954
Gilles Peskine449bd832023-01-11 14:50:10 +01008955 if (is_chachapoly) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008956 transform->fixed_ivlen = 12;
Gilles Peskine449bd832023-01-11 14:50:10 +01008957 } else {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008958 transform->fixed_ivlen = 4;
Gilles Peskine449bd832023-01-11 14:50:10 +01008959 }
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008960
8961 /* Minimum length of encrypted record */
8962 explicit_ivlen = transform->ivlen - transform->fixed_ivlen;
8963 transform->minlen = explicit_ivlen + transform->taglen;
Gilles Peskine449bd832023-01-11 14:50:10 +01008964 } else
Valerio Settie5707042023-10-11 11:54:42 +02008965#endif /* MBEDTLS_SSL_HAVE_AEAD */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008966#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01008967 if (ssl_mode == MBEDTLS_SSL_MODE_STREAM ||
Neil Armstrong7fea33e2022-04-01 15:40:25 +02008968 ssl_mode == MBEDTLS_SSL_MODE_CBC ||
Gilles Peskine449bd832023-01-11 14:50:10 +01008969 ssl_mode == MBEDTLS_SSL_MODE_CBC_ETM) {
Neil Armstronge4512952022-03-08 09:08:22 +01008970#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01008971 size_t block_size = PSA_BLOCK_CIPHER_BLOCK_LENGTH(key_type);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008972#else
Dave Rodgman85a88132023-06-24 11:41:50 +01008973 size_t block_size = mbedtls_cipher_info_get_block_size(cipher_info);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008974#endif /* MBEDTLS_USE_PSA_CRYPTO */
8975
8976#if defined(MBEDTLS_USE_PSA_CRYPTO)
Neil Armstronge4512952022-03-08 09:08:22 +01008977 /* Get MAC length */
8978 mac_key_len = PSA_HASH_LENGTH(mac_alg);
8979#else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008980 /* Initialize HMAC contexts */
Gilles Peskine449bd832023-01-11 14:50:10 +01008981 if ((ret = mbedtls_md_setup(&transform->md_ctx_enc, md_info, 1)) != 0 ||
8982 (ret = mbedtls_md_setup(&transform->md_ctx_dec, md_info, 1)) != 0) {
8983 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_setup", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008984 goto end;
8985 }
8986
8987 /* Get MAC length */
Gilles Peskine449bd832023-01-11 14:50:10 +01008988 mac_key_len = mbedtls_md_get_size(md_info);
Neil Armstronge4512952022-03-08 09:08:22 +01008989#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008990 transform->maclen = mac_key_len;
8991
8992 /* IV length */
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008993#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01008994 transform->ivlen = PSA_CIPHER_IV_LENGTH(key_type, alg);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008995#else
Dave Rodgmanbb521fd2023-06-24 11:21:25 +01008996 transform->ivlen = mbedtls_cipher_info_get_iv_size(cipher_info);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008997#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008998
8999 /* Minimum length */
Gilles Peskine449bd832023-01-11 14:50:10 +01009000 if (ssl_mode == MBEDTLS_SSL_MODE_STREAM) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009001 transform->minlen = transform->maclen;
Gilles Peskine449bd832023-01-11 14:50:10 +01009002 } else {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009003 /*
9004 * GenericBlockCipher:
9005 * 1. if EtM is in use: one block plus MAC
9006 * otherwise: * first multiple of blocklen greater than maclen
9007 * 2. IV
9008 */
9009#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01009010 if (ssl_mode == MBEDTLS_SSL_MODE_CBC_ETM) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009011 transform->minlen = transform->maclen
Gilles Peskine449bd832023-01-11 14:50:10 +01009012 + block_size;
9013 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009014#endif
9015 {
9016 transform->minlen = transform->maclen
Gilles Peskine449bd832023-01-11 14:50:10 +01009017 + block_size
9018 - transform->maclen % block_size;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009019 }
9020
Gilles Peskine449bd832023-01-11 14:50:10 +01009021 if (tls_version == MBEDTLS_SSL_VERSION_TLS1_2) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009022 transform->minlen += transform->ivlen;
Gilles Peskine449bd832023-01-11 14:50:10 +01009023 } else {
9024 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009025 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
9026 goto end;
9027 }
9028 }
Gilles Peskine449bd832023-01-11 14:50:10 +01009029 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009030#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
9031 {
Gilles Peskine449bd832023-01-11 14:50:10 +01009032 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
9033 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009034 }
9035
Gilles Peskine449bd832023-01-11 14:50:10 +01009036 MBEDTLS_SSL_DEBUG_MSG(3, ("keylen: %u, minlen: %u, ivlen: %u, maclen: %u",
9037 (unsigned) keylen,
9038 (unsigned) transform->minlen,
9039 (unsigned) transform->ivlen,
9040 (unsigned) transform->maclen));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009041
9042 /*
9043 * Finally setup the cipher contexts, IVs and MAC secrets.
9044 */
9045#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01009046 if (endpoint == MBEDTLS_SSL_IS_CLIENT) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009047 key1 = keyblk + mac_key_len * 2;
9048 key2 = keyblk + mac_key_len * 2 + keylen;
9049
9050 mac_enc = keyblk;
9051 mac_dec = keyblk + mac_key_len;
9052
Gilles Peskine449bd832023-01-11 14:50:10 +01009053 iv_copy_len = (transform->fixed_ivlen) ?
9054 transform->fixed_ivlen : transform->ivlen;
9055 memcpy(transform->iv_enc, key2 + keylen, iv_copy_len);
9056 memcpy(transform->iv_dec, key2 + keylen + iv_copy_len,
9057 iv_copy_len);
9058 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009059#endif /* MBEDTLS_SSL_CLI_C */
9060#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01009061 if (endpoint == MBEDTLS_SSL_IS_SERVER) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009062 key1 = keyblk + mac_key_len * 2 + keylen;
9063 key2 = keyblk + mac_key_len * 2;
9064
9065 mac_enc = keyblk + mac_key_len;
9066 mac_dec = keyblk;
9067
Gilles Peskine449bd832023-01-11 14:50:10 +01009068 iv_copy_len = (transform->fixed_ivlen) ?
9069 transform->fixed_ivlen : transform->ivlen;
9070 memcpy(transform->iv_dec, key1 + keylen, iv_copy_len);
9071 memcpy(transform->iv_enc, key1 + keylen + iv_copy_len,
9072 iv_copy_len);
9073 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009074#endif /* MBEDTLS_SSL_SRV_C */
9075 {
Gilles Peskine449bd832023-01-11 14:50:10 +01009076 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009077 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
9078 goto end;
9079 }
9080
Paul Elliott4fb19552023-10-18 12:15:30 +01009081 if (ssl->f_export_keys != NULL) {
Gilles Peskine449bd832023-01-11 14:50:10 +01009082 ssl->f_export_keys(ssl->p_export_keys,
9083 MBEDTLS_SSL_KEY_EXPORT_TLS12_MASTER_SECRET,
9084 master, 48,
9085 randbytes + 32,
9086 randbytes,
9087 tls_prf_get_type(tls_prf));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009088 }
9089
9090#if defined(MBEDTLS_USE_PSA_CRYPTO)
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009091 transform->psa_alg = alg;
9092
Gilles Peskine449bd832023-01-11 14:50:10 +01009093 if (alg != MBEDTLS_SSL_NULL_CIPHER) {
9094 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_ENCRYPT);
9095 psa_set_key_algorithm(&attributes, alg);
9096 psa_set_key_type(&attributes, key_type);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009097
Gilles Peskine449bd832023-01-11 14:50:10 +01009098 if ((status = psa_import_key(&attributes,
9099 key1,
9100 PSA_BITS_TO_BYTES(key_bits),
9101 &transform->psa_key_enc)) != PSA_SUCCESS) {
9102 MBEDTLS_SSL_DEBUG_RET(3, "psa_import_key", (int) status);
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05009103 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01009104 MBEDTLS_SSL_DEBUG_RET(1, "psa_import_key", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009105 goto end;
9106 }
9107
Gilles Peskine449bd832023-01-11 14:50:10 +01009108 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_DECRYPT);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009109
Gilles Peskine449bd832023-01-11 14:50:10 +01009110 if ((status = psa_import_key(&attributes,
9111 key2,
9112 PSA_BITS_TO_BYTES(key_bits),
9113 &transform->psa_key_dec)) != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05009114 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01009115 MBEDTLS_SSL_DEBUG_RET(1, "psa_import_key", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009116 goto end;
9117 }
9118 }
9119#else
Gilles Peskine449bd832023-01-11 14:50:10 +01009120 if ((ret = mbedtls_cipher_setup(&transform->cipher_ctx_enc,
9121 cipher_info)) != 0) {
9122 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_setup", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009123 goto end;
9124 }
9125
Gilles Peskine449bd832023-01-11 14:50:10 +01009126 if ((ret = mbedtls_cipher_setup(&transform->cipher_ctx_dec,
9127 cipher_info)) != 0) {
9128 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_setup", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009129 goto end;
9130 }
9131
Gilles Peskine449bd832023-01-11 14:50:10 +01009132 if ((ret = mbedtls_cipher_setkey(&transform->cipher_ctx_enc, key1,
9133 (int) mbedtls_cipher_info_get_key_bitlen(cipher_info),
9134 MBEDTLS_ENCRYPT)) != 0) {
9135 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_setkey", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009136 goto end;
9137 }
9138
Gilles Peskine449bd832023-01-11 14:50:10 +01009139 if ((ret = mbedtls_cipher_setkey(&transform->cipher_ctx_dec, key2,
9140 (int) mbedtls_cipher_info_get_key_bitlen(cipher_info),
9141 MBEDTLS_DECRYPT)) != 0) {
9142 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_setkey", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009143 goto end;
9144 }
9145
9146#if defined(MBEDTLS_CIPHER_MODE_CBC)
Gilles Peskine449bd832023-01-11 14:50:10 +01009147 if (mbedtls_cipher_info_get_mode(cipher_info) == MBEDTLS_MODE_CBC) {
9148 if ((ret = mbedtls_cipher_set_padding_mode(&transform->cipher_ctx_enc,
9149 MBEDTLS_PADDING_NONE)) != 0) {
9150 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_set_padding_mode", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009151 goto end;
9152 }
9153
Gilles Peskine449bd832023-01-11 14:50:10 +01009154 if ((ret = mbedtls_cipher_set_padding_mode(&transform->cipher_ctx_dec,
9155 MBEDTLS_PADDING_NONE)) != 0) {
9156 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_set_padding_mode", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009157 goto end;
9158 }
9159 }
9160#endif /* MBEDTLS_CIPHER_MODE_CBC */
9161#endif /* MBEDTLS_USE_PSA_CRYPTO */
9162
Neil Armstrong29c0c042022-03-17 17:47:28 +01009163#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
9164 /* For HMAC-based ciphersuites, initialize the HMAC transforms.
9165 For AEAD-based ciphersuites, there is nothing to do here. */
Gilles Peskine449bd832023-01-11 14:50:10 +01009166 if (mac_key_len != 0) {
Neil Armstrong29c0c042022-03-17 17:47:28 +01009167#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01009168 transform->psa_mac_alg = PSA_ALG_HMAC(mac_alg);
Neil Armstrong29c0c042022-03-17 17:47:28 +01009169
Gilles Peskine449bd832023-01-11 14:50:10 +01009170 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_SIGN_MESSAGE);
9171 psa_set_key_algorithm(&attributes, PSA_ALG_HMAC(mac_alg));
9172 psa_set_key_type(&attributes, PSA_KEY_TYPE_HMAC);
Neil Armstrong29c0c042022-03-17 17:47:28 +01009173
Gilles Peskine449bd832023-01-11 14:50:10 +01009174 if ((status = psa_import_key(&attributes,
9175 mac_enc, mac_key_len,
9176 &transform->psa_mac_enc)) != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05009177 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01009178 MBEDTLS_SSL_DEBUG_RET(1, "psa_import_mac_key", ret);
Neil Armstrong29c0c042022-03-17 17:47:28 +01009179 goto end;
9180 }
9181
Gilles Peskine449bd832023-01-11 14:50:10 +01009182 if ((transform->psa_alg == MBEDTLS_SSL_NULL_CIPHER) ||
9183 ((transform->psa_alg == PSA_ALG_CBC_NO_PADDING)
Andrzej Kurek8c95ac42022-08-17 16:17:00 -04009184#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01009185 && (transform->encrypt_then_mac == MBEDTLS_SSL_ETM_DISABLED)
Andrzej Kurek8c95ac42022-08-17 16:17:00 -04009186#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01009187 )) {
Neil Armstrong29c0c042022-03-17 17:47:28 +01009188 /* mbedtls_ct_hmac() requires the key to be exportable */
Gilles Peskine449bd832023-01-11 14:50:10 +01009189 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_EXPORT |
9190 PSA_KEY_USAGE_VERIFY_HASH);
9191 } else {
9192 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_VERIFY_HASH);
9193 }
Neil Armstrong29c0c042022-03-17 17:47:28 +01009194
Gilles Peskine449bd832023-01-11 14:50:10 +01009195 if ((status = psa_import_key(&attributes,
9196 mac_dec, mac_key_len,
9197 &transform->psa_mac_dec)) != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05009198 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01009199 MBEDTLS_SSL_DEBUG_RET(1, "psa_import_mac_key", ret);
Neil Armstrong29c0c042022-03-17 17:47:28 +01009200 goto end;
9201 }
9202#else
Gilles Peskine449bd832023-01-11 14:50:10 +01009203 ret = mbedtls_md_hmac_starts(&transform->md_ctx_enc, mac_enc, mac_key_len);
9204 if (ret != 0) {
Neil Armstrong29c0c042022-03-17 17:47:28 +01009205 goto end;
Gilles Peskine449bd832023-01-11 14:50:10 +01009206 }
9207 ret = mbedtls_md_hmac_starts(&transform->md_ctx_dec, mac_dec, mac_key_len);
9208 if (ret != 0) {
Neil Armstrong29c0c042022-03-17 17:47:28 +01009209 goto end;
Gilles Peskine449bd832023-01-11 14:50:10 +01009210 }
Neil Armstrong29c0c042022-03-17 17:47:28 +01009211#endif /* MBEDTLS_USE_PSA_CRYPTO */
9212 }
9213#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
9214
9215 ((void) mac_dec);
9216 ((void) mac_enc);
9217
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009218end:
Gilles Peskine449bd832023-01-11 14:50:10 +01009219 mbedtls_platform_zeroize(keyblk, sizeof(keyblk));
9220 return ret;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009221}
9222
Valerio Settia08b1a42022-11-17 15:10:02 +01009223#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED) && \
9224 defined(MBEDTLS_USE_PSA_CRYPTO)
Valerio Setti6b3dab02022-11-17 17:14:54 +01009225int mbedtls_psa_ecjpake_read_round(
Gilles Peskine449bd832023-01-11 14:50:10 +01009226 psa_pake_operation_t *pake_ctx,
9227 const unsigned char *buf,
9228 size_t len, mbedtls_ecjpake_rounds_t round)
Valerio Settia08b1a42022-11-17 15:10:02 +01009229{
9230 psa_status_t status;
9231 size_t input_offset = 0;
Valerio Setti819de862022-11-17 18:05:19 +01009232 /*
Valerio Setti6b3dab02022-11-17 17:14:54 +01009233 * At round one repeat the KEY_SHARE, ZK_PUBLIC & ZF_PROOF twice
9234 * At round two perform a single cycle
9235 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009236 unsigned int remaining_steps = (round == MBEDTLS_ECJPAKE_ROUND_ONE) ? 2 : 1;
Valerio Settia08b1a42022-11-17 15:10:02 +01009237
Gilles Peskine449bd832023-01-11 14:50:10 +01009238 for (; remaining_steps > 0; remaining_steps--) {
9239 for (psa_pake_step_t step = PSA_PAKE_STEP_KEY_SHARE;
Valerio Settia08b1a42022-11-17 15:10:02 +01009240 step <= PSA_PAKE_STEP_ZK_PROOF;
Gilles Peskine449bd832023-01-11 14:50:10 +01009241 ++step) {
Valerio Settia08b1a42022-11-17 15:10:02 +01009242 /* Length is stored at the first byte */
9243 size_t length = buf[input_offset];
9244 input_offset += 1;
9245
Gilles Peskine449bd832023-01-11 14:50:10 +01009246 if (input_offset + length > len) {
Valerio Settia08b1a42022-11-17 15:10:02 +01009247 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
9248 }
9249
Gilles Peskine449bd832023-01-11 14:50:10 +01009250 status = psa_pake_input(pake_ctx, step,
9251 buf + input_offset, length);
9252 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05009253 return PSA_TO_MBEDTLS_ERR(status);
Valerio Settia08b1a42022-11-17 15:10:02 +01009254 }
9255
9256 input_offset += length;
9257 }
9258 }
9259
Gilles Peskine449bd832023-01-11 14:50:10 +01009260 if (input_offset != len) {
Valerio Setti61ea17d2022-11-18 12:11:00 +01009261 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Gilles Peskine449bd832023-01-11 14:50:10 +01009262 }
Valerio Setti30ebe112022-11-17 16:23:34 +01009263
Gilles Peskine449bd832023-01-11 14:50:10 +01009264 return 0;
Valerio Settia08b1a42022-11-17 15:10:02 +01009265}
9266
Valerio Setti6b3dab02022-11-17 17:14:54 +01009267int mbedtls_psa_ecjpake_write_round(
Gilles Peskine449bd832023-01-11 14:50:10 +01009268 psa_pake_operation_t *pake_ctx,
9269 unsigned char *buf,
9270 size_t len, size_t *olen,
9271 mbedtls_ecjpake_rounds_t round)
Valerio Settia08b1a42022-11-17 15:10:02 +01009272{
9273 psa_status_t status;
9274 size_t output_offset = 0;
9275 size_t output_len;
Valerio Setti819de862022-11-17 18:05:19 +01009276 /*
Valerio Setti6b3dab02022-11-17 17:14:54 +01009277 * At round one repeat the KEY_SHARE, ZK_PUBLIC & ZF_PROOF twice
9278 * At round two perform a single cycle
9279 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009280 unsigned int remaining_steps = (round == MBEDTLS_ECJPAKE_ROUND_ONE) ? 2 : 1;
Valerio Settia08b1a42022-11-17 15:10:02 +01009281
Gilles Peskine449bd832023-01-11 14:50:10 +01009282 for (; remaining_steps > 0; remaining_steps--) {
9283 for (psa_pake_step_t step = PSA_PAKE_STEP_KEY_SHARE;
9284 step <= PSA_PAKE_STEP_ZK_PROOF;
9285 ++step) {
Valerio Setti79f6b6b2022-11-21 14:17:03 +01009286 /*
Valerio Settid4a9b1a2022-11-22 11:11:10 +01009287 * For each step, prepend 1 byte with the length of the data as
9288 * given by psa_pake_output().
Valerio Setti79f6b6b2022-11-21 14:17:03 +01009289 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009290 status = psa_pake_output(pake_ctx, step,
9291 buf + output_offset + 1,
9292 len - output_offset - 1,
9293 &output_len);
9294 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05009295 return PSA_TO_MBEDTLS_ERR(status);
Valerio Settia08b1a42022-11-17 15:10:02 +01009296 }
9297
Valerio Setti99d88c12022-11-22 16:03:43 +01009298 *(buf + output_offset) = (uint8_t) output_len;
Valerio Setti79f6b6b2022-11-21 14:17:03 +01009299
9300 output_offset += output_len + 1;
Valerio Settia08b1a42022-11-17 15:10:02 +01009301 }
9302 }
9303
9304 *olen = output_offset;
9305
Gilles Peskine449bd832023-01-11 14:50:10 +01009306 return 0;
Valerio Settia08b1a42022-11-17 15:10:02 +01009307}
Valerio Settia08b1a42022-11-17 15:10:02 +01009308#endif //MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED && MBEDTLS_USE_PSA_CRYPTO
9309
Jerry Yuee40f9d2022-02-17 14:55:16 +08009310#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01009311int mbedtls_ssl_get_key_exchange_md_tls1_2(mbedtls_ssl_context *ssl,
9312 unsigned char *hash, size_t *hashlen,
9313 unsigned char *data, size_t data_len,
9314 mbedtls_md_type_t md_alg)
Jerry Yuee40f9d2022-02-17 14:55:16 +08009315{
9316 psa_status_t status;
9317 psa_hash_operation_t hash_operation = PSA_HASH_OPERATION_INIT;
Manuel Pégourié-Gonnard2d6d9932023-03-28 11:38:08 +02009318 psa_algorithm_t hash_alg = mbedtls_md_psa_alg_from_type(md_alg);
Jerry Yuee40f9d2022-02-17 14:55:16 +08009319
Gilles Peskine449bd832023-01-11 14:50:10 +01009320 MBEDTLS_SSL_DEBUG_MSG(3, ("Perform PSA-based computation of digest of ServerKeyExchange"));
Jerry Yuee40f9d2022-02-17 14:55:16 +08009321
Gilles Peskine449bd832023-01-11 14:50:10 +01009322 if ((status = psa_hash_setup(&hash_operation,
9323 hash_alg)) != PSA_SUCCESS) {
9324 MBEDTLS_SSL_DEBUG_RET(1, "psa_hash_setup", status);
Jerry Yuee40f9d2022-02-17 14:55:16 +08009325 goto exit;
9326 }
9327
Gilles Peskine449bd832023-01-11 14:50:10 +01009328 if ((status = psa_hash_update(&hash_operation, ssl->handshake->randbytes,
9329 64)) != PSA_SUCCESS) {
9330 MBEDTLS_SSL_DEBUG_RET(1, "psa_hash_update", status);
Jerry Yuee40f9d2022-02-17 14:55:16 +08009331 goto exit;
9332 }
9333
Gilles Peskine449bd832023-01-11 14:50:10 +01009334 if ((status = psa_hash_update(&hash_operation,
9335 data, data_len)) != PSA_SUCCESS) {
9336 MBEDTLS_SSL_DEBUG_RET(1, "psa_hash_update", status);
Jerry Yuee40f9d2022-02-17 14:55:16 +08009337 goto exit;
9338 }
9339
Gilles Peskine449bd832023-01-11 14:50:10 +01009340 if ((status = psa_hash_finish(&hash_operation, hash, PSA_HASH_MAX_SIZE,
9341 hashlen)) != PSA_SUCCESS) {
9342 MBEDTLS_SSL_DEBUG_RET(1, "psa_hash_finish", status);
9343 goto exit;
Jerry Yuee40f9d2022-02-17 14:55:16 +08009344 }
9345
9346exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01009347 if (status != PSA_SUCCESS) {
9348 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
9349 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR);
9350 switch (status) {
Jerry Yuee40f9d2022-02-17 14:55:16 +08009351 case PSA_ERROR_NOT_SUPPORTED:
Gilles Peskine449bd832023-01-11 14:50:10 +01009352 return MBEDTLS_ERR_MD_FEATURE_UNAVAILABLE;
Jerry Yuee40f9d2022-02-17 14:55:16 +08009353 case PSA_ERROR_BAD_STATE: /* Intentional fallthrough */
9354 case PSA_ERROR_BUFFER_TOO_SMALL:
Gilles Peskine449bd832023-01-11 14:50:10 +01009355 return MBEDTLS_ERR_MD_BAD_INPUT_DATA;
Jerry Yuee40f9d2022-02-17 14:55:16 +08009356 case PSA_ERROR_INSUFFICIENT_MEMORY:
Gilles Peskine449bd832023-01-11 14:50:10 +01009357 return MBEDTLS_ERR_MD_ALLOC_FAILED;
Jerry Yuee40f9d2022-02-17 14:55:16 +08009358 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01009359 return MBEDTLS_ERR_PLATFORM_HW_ACCEL_FAILED;
Jerry Yuee40f9d2022-02-17 14:55:16 +08009360 }
9361 }
Gilles Peskine449bd832023-01-11 14:50:10 +01009362 return 0;
Jerry Yuee40f9d2022-02-17 14:55:16 +08009363}
9364
9365#else
9366
Gilles Peskine449bd832023-01-11 14:50:10 +01009367int mbedtls_ssl_get_key_exchange_md_tls1_2(mbedtls_ssl_context *ssl,
9368 unsigned char *hash, size_t *hashlen,
9369 unsigned char *data, size_t data_len,
9370 mbedtls_md_type_t md_alg)
Jerry Yuee40f9d2022-02-17 14:55:16 +08009371{
9372 int ret = 0;
9373 mbedtls_md_context_t ctx;
Gilles Peskine449bd832023-01-11 14:50:10 +01009374 const mbedtls_md_info_t *md_info = mbedtls_md_info_from_type(md_alg);
9375 *hashlen = mbedtls_md_get_size(md_info);
Jerry Yuee40f9d2022-02-17 14:55:16 +08009376
Gilles Peskine449bd832023-01-11 14:50:10 +01009377 MBEDTLS_SSL_DEBUG_MSG(3, ("Perform mbedtls-based computation of digest of ServerKeyExchange"));
Jerry Yuee40f9d2022-02-17 14:55:16 +08009378
Gilles Peskine449bd832023-01-11 14:50:10 +01009379 mbedtls_md_init(&ctx);
Jerry Yuee40f9d2022-02-17 14:55:16 +08009380
9381 /*
9382 * digitally-signed struct {
9383 * opaque client_random[32];
9384 * opaque server_random[32];
9385 * ServerDHParams params;
9386 * };
9387 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009388 if ((ret = mbedtls_md_setup(&ctx, md_info, 0)) != 0) {
9389 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_setup", ret);
Jerry Yuee40f9d2022-02-17 14:55:16 +08009390 goto exit;
9391 }
Gilles Peskine449bd832023-01-11 14:50:10 +01009392 if ((ret = mbedtls_md_starts(&ctx)) != 0) {
9393 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_starts", ret);
Jerry Yuee40f9d2022-02-17 14:55:16 +08009394 goto exit;
9395 }
Gilles Peskine449bd832023-01-11 14:50:10 +01009396 if ((ret = mbedtls_md_update(&ctx, ssl->handshake->randbytes, 64)) != 0) {
9397 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_update", ret);
Jerry Yuee40f9d2022-02-17 14:55:16 +08009398 goto exit;
9399 }
Gilles Peskine449bd832023-01-11 14:50:10 +01009400 if ((ret = mbedtls_md_update(&ctx, data, data_len)) != 0) {
9401 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_update", ret);
Jerry Yuee40f9d2022-02-17 14:55:16 +08009402 goto exit;
9403 }
Gilles Peskine449bd832023-01-11 14:50:10 +01009404 if ((ret = mbedtls_md_finish(&ctx, hash)) != 0) {
9405 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_finish", ret);
Jerry Yuee40f9d2022-02-17 14:55:16 +08009406 goto exit;
9407 }
9408
9409exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01009410 mbedtls_md_free(&ctx);
Jerry Yuee40f9d2022-02-17 14:55:16 +08009411
Gilles Peskine449bd832023-01-11 14:50:10 +01009412 if (ret != 0) {
9413 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
9414 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR);
9415 }
Jerry Yuee40f9d2022-02-17 14:55:16 +08009416
Gilles Peskine449bd832023-01-11 14:50:10 +01009417 return ret;
Jerry Yuee40f9d2022-02-17 14:55:16 +08009418}
9419#endif /* MBEDTLS_USE_PSA_CRYPTO */
9420
Jerry Yud9d91da2022-02-17 14:57:06 +08009421#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
9422
Gabor Mezeia3d016c2022-05-10 12:44:09 +02009423/* Find the preferred hash for a given signature algorithm. */
9424unsigned int mbedtls_ssl_tls12_get_preferred_hash_for_sig_alg(
Gilles Peskine449bd832023-01-11 14:50:10 +01009425 mbedtls_ssl_context *ssl,
9426 unsigned int sig_alg)
Jerry Yud9d91da2022-02-17 14:57:06 +08009427{
Gabor Mezei078e8032022-04-27 21:17:56 +02009428 unsigned int i;
Gabor Mezeia3d016c2022-05-10 12:44:09 +02009429 uint16_t *received_sig_algs = ssl->handshake->received_sig_algs;
Gabor Mezei078e8032022-04-27 21:17:56 +02009430
Gilles Peskine449bd832023-01-11 14:50:10 +01009431 if (sig_alg == MBEDTLS_SSL_SIG_ANON) {
9432 return MBEDTLS_SSL_HASH_NONE;
9433 }
Gabor Mezei078e8032022-04-27 21:17:56 +02009434
Gilles Peskine449bd832023-01-11 14:50:10 +01009435 for (i = 0; received_sig_algs[i] != MBEDTLS_TLS_SIG_NONE; i++) {
Neil Armstrong9f1176a2022-06-24 18:19:19 +02009436 unsigned int hash_alg_received =
Gilles Peskine449bd832023-01-11 14:50:10 +01009437 MBEDTLS_SSL_TLS12_HASH_ALG_FROM_SIG_AND_HASH_ALG(
9438 received_sig_algs[i]);
Neil Armstrong9f1176a2022-06-24 18:19:19 +02009439 unsigned int sig_alg_received =
Gilles Peskine449bd832023-01-11 14:50:10 +01009440 MBEDTLS_SSL_TLS12_SIG_ALG_FROM_SIG_AND_HASH_ALG(
9441 received_sig_algs[i]);
Neil Armstrong9f1176a2022-06-24 18:19:19 +02009442
Manuel Pégourié-Gonnard47bb3802023-06-05 12:40:32 +02009443 mbedtls_md_type_t md_alg =
9444 mbedtls_ssl_md_alg_from_hash((unsigned char) hash_alg_received);
9445 if (md_alg == MBEDTLS_MD_NONE) {
9446 continue;
9447 }
9448
Gilles Peskine449bd832023-01-11 14:50:10 +01009449 if (sig_alg == sig_alg_received) {
Neil Armstrong9f1176a2022-06-24 18:19:19 +02009450#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01009451 if (ssl->handshake->key_cert && ssl->handshake->key_cert->key) {
Neil Armstrong96eceb82022-06-30 18:05:05 +02009452 psa_algorithm_t psa_hash_alg =
Manuel Pégourié-Gonnard47bb3802023-06-05 12:40:32 +02009453 mbedtls_md_psa_alg_from_type(md_alg);
Neil Armstrong9f1176a2022-06-24 18:19:19 +02009454
Gilles Peskine449bd832023-01-11 14:50:10 +01009455 if (sig_alg_received == MBEDTLS_SSL_SIG_ECDSA &&
9456 !mbedtls_pk_can_do_ext(ssl->handshake->key_cert->key,
9457 PSA_ALG_ECDSA(psa_hash_alg),
9458 PSA_KEY_USAGE_SIGN_HASH)) {
Neil Armstrong9f1176a2022-06-24 18:19:19 +02009459 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01009460 }
Neil Armstrong9f1176a2022-06-24 18:19:19 +02009461
Gilles Peskine449bd832023-01-11 14:50:10 +01009462 if (sig_alg_received == MBEDTLS_SSL_SIG_RSA &&
9463 !mbedtls_pk_can_do_ext(ssl->handshake->key_cert->key,
9464 PSA_ALG_RSA_PKCS1V15_SIGN(
9465 psa_hash_alg),
9466 PSA_KEY_USAGE_SIGN_HASH)) {
Neil Armstrong9f1176a2022-06-24 18:19:19 +02009467 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01009468 }
Neil Armstrong9f1176a2022-06-24 18:19:19 +02009469 }
Neil Armstrong9f1176a2022-06-24 18:19:19 +02009470#endif /* MBEDTLS_USE_PSA_CRYPTO */
Neil Armstrong96eceb82022-06-30 18:05:05 +02009471
Gilles Peskine449bd832023-01-11 14:50:10 +01009472 return hash_alg_received;
Neil Armstrong9f1176a2022-06-24 18:19:19 +02009473 }
Jerry Yud9d91da2022-02-17 14:57:06 +08009474 }
Jerry Yud9d91da2022-02-17 14:57:06 +08009475
Gilles Peskine449bd832023-01-11 14:50:10 +01009476 return MBEDTLS_SSL_HASH_NONE;
Jerry Yud9d91da2022-02-17 14:57:06 +08009477}
9478
9479#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
9480
Jerry Yudc7bd172022-02-17 13:44:15 +08009481#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
9482
XiaokangQian75d40ef2022-04-20 11:05:24 +00009483int mbedtls_ssl_validate_ciphersuite(
9484 const mbedtls_ssl_context *ssl,
9485 const mbedtls_ssl_ciphersuite_t *suite_info,
9486 mbedtls_ssl_protocol_version min_tls_version,
Gilles Peskine449bd832023-01-11 14:50:10 +01009487 mbedtls_ssl_protocol_version max_tls_version)
XiaokangQian75d40ef2022-04-20 11:05:24 +00009488{
9489 (void) ssl;
9490
Gilles Peskine449bd832023-01-11 14:50:10 +01009491 if (suite_info == NULL) {
9492 return -1;
9493 }
XiaokangQian75d40ef2022-04-20 11:05:24 +00009494
Gilles Peskine449bd832023-01-11 14:50:10 +01009495 if ((suite_info->min_tls_version > max_tls_version) ||
9496 (suite_info->max_tls_version < min_tls_version)) {
9497 return -1;
XiaokangQian75d40ef2022-04-20 11:05:24 +00009498 }
9499
XiaokangQian060d8672022-04-21 09:24:56 +00009500#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_CLI_C)
XiaokangQian75d40ef2022-04-20 11:05:24 +00009501#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Neil Armstrongca7d5062022-05-31 14:43:23 +02009502#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01009503 if (suite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_ECJPAKE &&
9504 ssl->handshake->psa_pake_ctx_is_ok != 1)
Neil Armstrongca7d5062022-05-31 14:43:23 +02009505#else
Gilles Peskine449bd832023-01-11 14:50:10 +01009506 if (suite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_ECJPAKE &&
9507 mbedtls_ecjpake_check(&ssl->handshake->ecjpake_ctx) != 0)
Neil Armstrongca7d5062022-05-31 14:43:23 +02009508#endif /* MBEDTLS_USE_PSA_CRYPTO */
XiaokangQian75d40ef2022-04-20 11:05:24 +00009509 {
Gilles Peskine449bd832023-01-11 14:50:10 +01009510 return -1;
XiaokangQian75d40ef2022-04-20 11:05:24 +00009511 }
9512#endif
9513
9514 /* Don't suggest PSK-based ciphersuite if no PSK is available. */
9515#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01009516 if (mbedtls_ssl_ciphersuite_uses_psk(suite_info) &&
9517 mbedtls_ssl_conf_has_static_psk(ssl->conf) == 0) {
9518 return -1;
XiaokangQian75d40ef2022-04-20 11:05:24 +00009519 }
9520#endif /* MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
9521#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
9522
Gilles Peskine449bd832023-01-11 14:50:10 +01009523 return 0;
XiaokangQian75d40ef2022-04-20 11:05:24 +00009524}
9525
Ronald Crone68ab4f2022-10-05 12:46:29 +02009526#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
XiaokangQianeaf36512022-04-24 09:07:44 +00009527/*
9528 * Function for writing a signature algorithm extension.
9529 *
9530 * The `extension_data` field of signature algorithm contains a `SignatureSchemeList`
9531 * value (TLS 1.3 RFC8446):
9532 * enum {
9533 * ....
9534 * ecdsa_secp256r1_sha256( 0x0403 ),
9535 * ecdsa_secp384r1_sha384( 0x0503 ),
9536 * ecdsa_secp521r1_sha512( 0x0603 ),
9537 * ....
9538 * } SignatureScheme;
9539 *
9540 * struct {
9541 * SignatureScheme supported_signature_algorithms<2..2^16-2>;
9542 * } SignatureSchemeList;
9543 *
9544 * The `extension_data` field of signature algorithm contains a `SignatureAndHashAlgorithm`
9545 * value (TLS 1.2 RFC5246):
9546 * enum {
9547 * none(0), md5(1), sha1(2), sha224(3), sha256(4), sha384(5),
9548 * sha512(6), (255)
9549 * } HashAlgorithm;
9550 *
9551 * enum { anonymous(0), rsa(1), dsa(2), ecdsa(3), (255) }
9552 * SignatureAlgorithm;
9553 *
9554 * struct {
9555 * HashAlgorithm hash;
9556 * SignatureAlgorithm signature;
9557 * } SignatureAndHashAlgorithm;
9558 *
9559 * SignatureAndHashAlgorithm
9560 * supported_signature_algorithms<2..2^16-2>;
9561 *
9562 * The TLS 1.3 signature algorithm extension was defined to be a compatible
9563 * generalization of the TLS 1.2 signature algorithm extension.
9564 * `SignatureAndHashAlgorithm` field of TLS 1.2 can be represented by
9565 * `SignatureScheme` field of TLS 1.3
9566 *
9567 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009568int mbedtls_ssl_write_sig_alg_ext(mbedtls_ssl_context *ssl, unsigned char *buf,
9569 const unsigned char *end, size_t *out_len)
XiaokangQianeaf36512022-04-24 09:07:44 +00009570{
9571 unsigned char *p = buf;
9572 unsigned char *supported_sig_alg; /* Start of supported_signature_algorithms */
9573 size_t supported_sig_alg_len = 0; /* Length of supported_signature_algorithms */
9574
9575 *out_len = 0;
9576
Gilles Peskine449bd832023-01-11 14:50:10 +01009577 MBEDTLS_SSL_DEBUG_MSG(3, ("adding signature_algorithms extension"));
XiaokangQianeaf36512022-04-24 09:07:44 +00009578
9579 /* Check if we have space for header and length field:
9580 * - extension_type (2 bytes)
9581 * - extension_data_length (2 bytes)
9582 * - supported_signature_algorithms_length (2 bytes)
9583 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009584 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 6);
XiaokangQianeaf36512022-04-24 09:07:44 +00009585 p += 6;
9586
9587 /*
9588 * Write supported_signature_algorithms
9589 */
9590 supported_sig_alg = p;
Gilles Peskine449bd832023-01-11 14:50:10 +01009591 const uint16_t *sig_alg = mbedtls_ssl_get_sig_algs(ssl);
9592 if (sig_alg == NULL) {
9593 return MBEDTLS_ERR_SSL_BAD_CONFIG;
9594 }
XiaokangQianeaf36512022-04-24 09:07:44 +00009595
Gilles Peskine449bd832023-01-11 14:50:10 +01009596 for (; *sig_alg != MBEDTLS_TLS1_3_SIG_NONE; sig_alg++) {
9597 MBEDTLS_SSL_DEBUG_MSG(3, ("got signature scheme [%x] %s",
9598 *sig_alg,
9599 mbedtls_ssl_sig_alg_to_str(*sig_alg)));
9600 if (!mbedtls_ssl_sig_alg_is_supported(ssl, *sig_alg)) {
XiaokangQianeaf36512022-04-24 09:07:44 +00009601 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01009602 }
9603 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 2);
9604 MBEDTLS_PUT_UINT16_BE(*sig_alg, p, 0);
XiaokangQianeaf36512022-04-24 09:07:44 +00009605 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01009606 MBEDTLS_SSL_DEBUG_MSG(3, ("sent signature scheme [%x] %s",
9607 *sig_alg,
9608 mbedtls_ssl_sig_alg_to_str(*sig_alg)));
XiaokangQianeaf36512022-04-24 09:07:44 +00009609 }
9610
9611 /* Length of supported_signature_algorithms */
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00009612 supported_sig_alg_len = (size_t) (p - supported_sig_alg);
Gilles Peskine449bd832023-01-11 14:50:10 +01009613 if (supported_sig_alg_len == 0) {
9614 MBEDTLS_SSL_DEBUG_MSG(1, ("No signature algorithms defined."));
9615 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
XiaokangQianeaf36512022-04-24 09:07:44 +00009616 }
9617
Gilles Peskine449bd832023-01-11 14:50:10 +01009618 MBEDTLS_PUT_UINT16_BE(MBEDTLS_TLS_EXT_SIG_ALG, buf, 0);
9619 MBEDTLS_PUT_UINT16_BE(supported_sig_alg_len + 2, buf, 2);
9620 MBEDTLS_PUT_UINT16_BE(supported_sig_alg_len, buf, 4);
XiaokangQianeaf36512022-04-24 09:07:44 +00009621
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00009622 *out_len = (size_t) (p - buf);
XiaokangQianeaf36512022-04-24 09:07:44 +00009623
9624#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01009625 mbedtls_ssl_tls13_set_hs_sent_ext_mask(ssl, MBEDTLS_TLS_EXT_SIG_ALG);
XiaokangQianeaf36512022-04-24 09:07:44 +00009626#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yu0c354a22022-08-29 15:25:36 +08009627
Gilles Peskine449bd832023-01-11 14:50:10 +01009628 return 0;
XiaokangQianeaf36512022-04-24 09:07:44 +00009629}
Ronald Crone68ab4f2022-10-05 12:46:29 +02009630#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
XiaokangQianeaf36512022-04-24 09:07:44 +00009631
XiaokangQian40a35232022-05-07 09:02:40 +00009632#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
XiaokangQian9b2b7712022-05-17 02:57:00 +00009633/*
9634 * mbedtls_ssl_parse_server_name_ext
9635 *
9636 * Structure of server_name extension:
9637 *
9638 * enum {
9639 * host_name(0), (255)
9640 * } NameType;
9641 * opaque HostName<1..2^16-1>;
9642 *
9643 * struct {
9644 * NameType name_type;
9645 * select (name_type) {
9646 * case host_name: HostName;
9647 * } name;
9648 * } ServerName;
9649 * struct {
9650 * ServerName server_name_list<1..2^16-1>
9651 * } ServerNameList;
9652 */
Ronald Cronce7d76e2022-07-08 18:56:49 +02009653MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01009654int mbedtls_ssl_parse_server_name_ext(mbedtls_ssl_context *ssl,
9655 const unsigned char *buf,
9656 const unsigned char *end)
XiaokangQian40a35232022-05-07 09:02:40 +00009657{
9658 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
9659 const unsigned char *p = buf;
XiaokangQian9b2b7712022-05-17 02:57:00 +00009660 size_t server_name_list_len, hostname_len;
9661 const unsigned char *server_name_list_end;
XiaokangQian40a35232022-05-07 09:02:40 +00009662
Gilles Peskine449bd832023-01-11 14:50:10 +01009663 MBEDTLS_SSL_DEBUG_MSG(3, ("parse ServerName extension"));
XiaokangQian40a35232022-05-07 09:02:40 +00009664
Gilles Peskine449bd832023-01-11 14:50:10 +01009665 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
9666 server_name_list_len = MBEDTLS_GET_UINT16_BE(p, 0);
XiaokangQian40a35232022-05-07 09:02:40 +00009667 p += 2;
9668
Gilles Peskine449bd832023-01-11 14:50:10 +01009669 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, server_name_list_len);
XiaokangQian9b2b7712022-05-17 02:57:00 +00009670 server_name_list_end = p + server_name_list_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01009671 while (p < server_name_list_end) {
9672 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, server_name_list_end, 3);
9673 hostname_len = MBEDTLS_GET_UINT16_BE(p, 1);
9674 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, server_name_list_end,
9675 hostname_len + 3);
XiaokangQian40a35232022-05-07 09:02:40 +00009676
Gilles Peskine449bd832023-01-11 14:50:10 +01009677 if (p[0] == MBEDTLS_TLS_EXT_SERVERNAME_HOSTNAME) {
XiaokangQian75fe8c72022-06-15 09:42:45 +00009678 /* sni_name is intended to be used only during the parsing of the
9679 * ClientHello message (it is reset to NULL before the end of
9680 * the message parsing). Thus it is ok to just point to the
9681 * reception buffer and not make a copy of it.
9682 */
XiaokangQianf2a94202022-05-20 06:44:24 +00009683 ssl->handshake->sni_name = p + 3;
9684 ssl->handshake->sni_name_len = hostname_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01009685 if (ssl->conf->f_sni == NULL) {
9686 return 0;
XiaokangQian40a35232022-05-07 09:02:40 +00009687 }
Gilles Peskine449bd832023-01-11 14:50:10 +01009688 ret = ssl->conf->f_sni(ssl->conf->p_sni,
9689 ssl, p + 3, hostname_len);
9690 if (ret != 0) {
9691 MBEDTLS_SSL_DEBUG_RET(1, "ssl_sni_wrapper", ret);
9692 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_UNRECOGNIZED_NAME,
9693 MBEDTLS_ERR_SSL_UNRECOGNIZED_NAME);
9694 return MBEDTLS_ERR_SSL_UNRECOGNIZED_NAME;
9695 }
9696 return 0;
XiaokangQian40a35232022-05-07 09:02:40 +00009697 }
9698
9699 p += hostname_len + 3;
9700 }
9701
Gilles Peskine449bd832023-01-11 14:50:10 +01009702 return 0;
XiaokangQian40a35232022-05-07 09:02:40 +00009703}
9704#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
9705
XiaokangQianacb39922022-06-17 10:18:48 +00009706#if defined(MBEDTLS_SSL_ALPN)
Ronald Cronce7d76e2022-07-08 18:56:49 +02009707MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01009708int mbedtls_ssl_parse_alpn_ext(mbedtls_ssl_context *ssl,
9709 const unsigned char *buf,
9710 const unsigned char *end)
XiaokangQianacb39922022-06-17 10:18:48 +00009711{
9712 const unsigned char *p = buf;
XiaokangQianc7403452022-06-23 03:24:12 +00009713 size_t protocol_name_list_len;
XiaokangQian95d5f542022-06-24 02:29:26 +00009714 const unsigned char *protocol_name_list;
9715 const unsigned char *protocol_name_list_end;
XiaokangQianc7403452022-06-23 03:24:12 +00009716 size_t protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00009717
9718 /* If ALPN not configured, just ignore the extension */
Gilles Peskine449bd832023-01-11 14:50:10 +01009719 if (ssl->conf->alpn_list == NULL) {
9720 return 0;
9721 }
XiaokangQianacb39922022-06-17 10:18:48 +00009722
9723 /*
XiaokangQianc7403452022-06-23 03:24:12 +00009724 * RFC7301, section 3.1
9725 * opaque ProtocolName<1..2^8-1>;
XiaokangQianacb39922022-06-17 10:18:48 +00009726 *
XiaokangQianc7403452022-06-23 03:24:12 +00009727 * struct {
9728 * ProtocolName protocol_name_list<2..2^16-1>
9729 * } ProtocolNameList;
XiaokangQianacb39922022-06-17 10:18:48 +00009730 */
9731
XiaokangQianc7403452022-06-23 03:24:12 +00009732 /*
XiaokangQian0b776e22022-06-24 09:04:59 +00009733 * protocol_name_list_len 2 bytes
9734 * protocol_name_len 1 bytes
9735 * protocol_name >=1 byte
XiaokangQianc7403452022-06-23 03:24:12 +00009736 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009737 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 4);
XiaokangQianacb39922022-06-17 10:18:48 +00009738
Gilles Peskine449bd832023-01-11 14:50:10 +01009739 protocol_name_list_len = MBEDTLS_GET_UINT16_BE(p, 0);
XiaokangQianacb39922022-06-17 10:18:48 +00009740 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01009741 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, protocol_name_list_len);
XiaokangQian95d5f542022-06-24 02:29:26 +00009742 protocol_name_list = p;
9743 protocol_name_list_end = p + protocol_name_list_len;
XiaokangQianacb39922022-06-17 10:18:48 +00009744
9745 /* Validate peer's list (lengths) */
Gilles Peskine449bd832023-01-11 14:50:10 +01009746 while (p < protocol_name_list_end) {
XiaokangQian95d5f542022-06-24 02:29:26 +00009747 protocol_name_len = *p++;
Gilles Peskine449bd832023-01-11 14:50:10 +01009748 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, protocol_name_list_end,
9749 protocol_name_len);
9750 if (protocol_name_len == 0) {
XiaokangQian95d5f542022-06-24 02:29:26 +00009751 MBEDTLS_SSL_PEND_FATAL_ALERT(
9752 MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
Gilles Peskine449bd832023-01-11 14:50:10 +01009753 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
9754 return MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
XiaokangQian95d5f542022-06-24 02:29:26 +00009755 }
9756
9757 p += protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00009758 }
9759
9760 /* Use our order of preference */
Gilles Peskine449bd832023-01-11 14:50:10 +01009761 for (const char **alpn = ssl->conf->alpn_list; *alpn != NULL; alpn++) {
9762 size_t const alpn_len = strlen(*alpn);
XiaokangQian95d5f542022-06-24 02:29:26 +00009763 p = protocol_name_list;
Gilles Peskine449bd832023-01-11 14:50:10 +01009764 while (p < protocol_name_list_end) {
XiaokangQian95d5f542022-06-24 02:29:26 +00009765 protocol_name_len = *p++;
Gilles Peskine449bd832023-01-11 14:50:10 +01009766 if (protocol_name_len == alpn_len &&
9767 memcmp(p, *alpn, alpn_len) == 0) {
XiaokangQianacb39922022-06-17 10:18:48 +00009768 ssl->alpn_chosen = *alpn;
Gilles Peskine449bd832023-01-11 14:50:10 +01009769 return 0;
XiaokangQianacb39922022-06-17 10:18:48 +00009770 }
XiaokangQian95d5f542022-06-24 02:29:26 +00009771
9772 p += protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00009773 }
9774 }
9775
XiaokangQian95d5f542022-06-24 02:29:26 +00009776 /* If we get here, no match was found */
XiaokangQianacb39922022-06-17 10:18:48 +00009777 MBEDTLS_SSL_PEND_FATAL_ALERT(
Gilles Peskine449bd832023-01-11 14:50:10 +01009778 MBEDTLS_SSL_ALERT_MSG_NO_APPLICATION_PROTOCOL,
9779 MBEDTLS_ERR_SSL_NO_APPLICATION_PROTOCOL);
9780 return MBEDTLS_ERR_SSL_NO_APPLICATION_PROTOCOL;
XiaokangQianacb39922022-06-17 10:18:48 +00009781}
9782
Gilles Peskine449bd832023-01-11 14:50:10 +01009783int mbedtls_ssl_write_alpn_ext(mbedtls_ssl_context *ssl,
9784 unsigned char *buf,
9785 unsigned char *end,
9786 size_t *out_len)
XiaokangQianacb39922022-06-17 10:18:48 +00009787{
9788 unsigned char *p = buf;
XiaokangQian95d5f542022-06-24 02:29:26 +00009789 size_t protocol_name_len;
XiaokangQianc7403452022-06-23 03:24:12 +00009790 *out_len = 0;
XiaokangQianacb39922022-06-17 10:18:48 +00009791
Gilles Peskine449bd832023-01-11 14:50:10 +01009792 if (ssl->alpn_chosen == NULL) {
9793 return 0;
XiaokangQianacb39922022-06-17 10:18:48 +00009794 }
9795
Gilles Peskine449bd832023-01-11 14:50:10 +01009796 protocol_name_len = strlen(ssl->alpn_chosen);
9797 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 7 + protocol_name_len);
XiaokangQianacb39922022-06-17 10:18:48 +00009798
Gilles Peskine449bd832023-01-11 14:50:10 +01009799 MBEDTLS_SSL_DEBUG_MSG(3, ("server side, adding alpn extension"));
XiaokangQianacb39922022-06-17 10:18:48 +00009800 /*
9801 * 0 . 1 ext identifier
9802 * 2 . 3 ext length
9803 * 4 . 5 protocol list length
9804 * 6 . 6 protocol name length
9805 * 7 . 7+n protocol name
9806 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009807 MBEDTLS_PUT_UINT16_BE(MBEDTLS_TLS_EXT_ALPN, p, 0);
XiaokangQianacb39922022-06-17 10:18:48 +00009808
XiaokangQian95d5f542022-06-24 02:29:26 +00009809 *out_len = 7 + protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00009810
Gilles Peskine449bd832023-01-11 14:50:10 +01009811 MBEDTLS_PUT_UINT16_BE(protocol_name_len + 3, p, 2);
9812 MBEDTLS_PUT_UINT16_BE(protocol_name_len + 1, p, 4);
XiaokangQian0b776e22022-06-24 09:04:59 +00009813 /* Note: the length of the chosen protocol has been checked to be less
9814 * than 255 bytes in `mbedtls_ssl_conf_alpn_protocols`.
9815 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009816 p[6] = MBEDTLS_BYTE_0(protocol_name_len);
XiaokangQianacb39922022-06-17 10:18:48 +00009817
Gilles Peskine449bd832023-01-11 14:50:10 +01009818 memcpy(p + 7, ssl->alpn_chosen, protocol_name_len);
Jerry Yub95dd362022-11-08 21:19:34 +08009819
9820#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01009821 mbedtls_ssl_tls13_set_hs_sent_ext_mask(ssl, MBEDTLS_TLS_EXT_ALPN);
Jerry Yub95dd362022-11-08 21:19:34 +08009822#endif
9823
Gilles Peskine449bd832023-01-11 14:50:10 +01009824 return 0;
XiaokangQianacb39922022-06-17 10:18:48 +00009825}
9826#endif /* MBEDTLS_SSL_ALPN */
9827
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009828#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && \
Xiaokang Qian03409292022-10-12 02:49:52 +00009829 defined(MBEDTLS_SSL_SESSION_TICKETS) && \
Xiaokang Qianed0620c2022-10-12 06:58:13 +00009830 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION) && \
Xiaokang Qianed3afcd2022-10-12 08:31:11 +00009831 defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01009832int mbedtls_ssl_session_set_hostname(mbedtls_ssl_session *session,
9833 const char *hostname)
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009834{
9835 /* Initialize to suppress unnecessary compiler warning */
9836 size_t hostname_len = 0;
9837
9838 /* Check if new hostname is valid before
9839 * making any change to current one */
Gilles Peskine449bd832023-01-11 14:50:10 +01009840 if (hostname != NULL) {
9841 hostname_len = strlen(hostname);
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009842
Gilles Peskine449bd832023-01-11 14:50:10 +01009843 if (hostname_len > MBEDTLS_SSL_MAX_HOST_NAME_LEN) {
9844 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9845 }
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009846 }
9847
9848 /* Now it's clear that we will overwrite the old hostname,
9849 * so we can free it safely */
Gilles Peskine449bd832023-01-11 14:50:10 +01009850 if (session->hostname != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01009851 mbedtls_zeroize_and_free(session->hostname,
Gilles Peskine449bd832023-01-11 14:50:10 +01009852 strlen(session->hostname));
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009853 }
9854
9855 /* Passing NULL as hostname shall clear the old one */
Gilles Peskine449bd832023-01-11 14:50:10 +01009856 if (hostname == NULL) {
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009857 session->hostname = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01009858 } else {
9859 session->hostname = mbedtls_calloc(1, hostname_len + 1);
9860 if (session->hostname == NULL) {
9861 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
9862 }
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009863
Gilles Peskine449bd832023-01-11 14:50:10 +01009864 memcpy(session->hostname, hostname, hostname_len);
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009865 }
9866
Gilles Peskine449bd832023-01-11 14:50:10 +01009867 return 0;
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009868}
Xiaokang Qian03409292022-10-12 02:49:52 +00009869#endif /* MBEDTLS_SSL_PROTO_TLS1_3 &&
9870 MBEDTLS_SSL_SESSION_TICKETS &&
Xiaokang Qianed0620c2022-10-12 06:58:13 +00009871 MBEDTLS_SSL_SERVER_NAME_INDICATION &&
Xiaokang Qianed3afcd2022-10-12 08:31:11 +00009872 MBEDTLS_SSL_CLI_C */
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009873
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00009874#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_EARLY_DATA) && \
9875 defined(MBEDTLS_SSL_ALPN)
Waleed Elmelegy7dfba342024-03-12 16:22:39 +00009876int mbedtls_ssl_session_set_ticket_alpn(mbedtls_ssl_session *session,
9877 const char *alpn)
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00009878{
9879 size_t alpn_len = 0;
9880
9881 if (alpn != NULL) {
9882 alpn_len = strlen(alpn);
9883
9884 if (alpn_len > MBEDTLS_SSL_MAX_ALPN_NAME_LEN) {
9885 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9886 }
9887 }
9888
9889 if (session->ticket_alpn != NULL) {
9890 mbedtls_zeroize_and_free(session->ticket_alpn,
9891 strlen(session->ticket_alpn));
Waleed Elmelegy7dfba342024-03-12 16:22:39 +00009892 session->ticket_alpn = NULL;
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00009893 }
9894
Waleed Elmelegy7dfba342024-03-12 16:22:39 +00009895 if (alpn != NULL) {
9896 session->ticket_alpn = mbedtls_calloc(alpn_len + 1, 1);
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00009897 if (session->ticket_alpn == NULL) {
9898 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
9899 }
Waleed Elmelegy7dfba342024-03-12 16:22:39 +00009900 memcpy(session->ticket_alpn, alpn, alpn_len);
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00009901 }
9902
9903 return 0;
9904}
9905#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_EARLY_DATA && MBEDTLS_SSL_ALPN */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02009906#endif /* MBEDTLS_SSL_TLS_C */