blob: 7dd8e4d76315603e950f62e69a1efded1c6a23e1 [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 Cron90e22332024-01-22 15:24:21 +01001099 ssl->early_data_status = MBEDTLS_SSL_EARLY_DATA_STATUS_UNKNOWN;
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
1104#endif /* MBEDTLS_SSL_EARLY_DATA */
Ronald Cron5d0ae902024-01-05 14:20:35 +01001105
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001106 /* Initialize structures */
Gilles Peskine449bd832023-01-11 14:50:10 +01001107 mbedtls_ssl_session_init(ssl->session_negotiate);
1108 ssl_handshake_params_init(ssl->handshake);
Paul Bakker968afaa2014-07-09 11:09:24 +02001109
Jerry Yu2e199812022-12-01 18:57:19 +08001110#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01001111 mbedtls_ssl_transform_init(ssl->transform_negotiate);
Jerry Yu2e199812022-12-01 18:57:19 +08001112#endif
1113
Manuel Pégourié-Gonnard537f2312023-02-05 10:17:45 +01001114 /* Setup handshake checksums */
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01001115 ret = mbedtls_ssl_reset_checksum(ssl);
1116 if (ret != 0) {
1117 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_reset_checksum", ret);
1118 return ret;
1119 }
Manuel Pégourié-Gonnard537f2312023-02-05 10:17:45 +01001120
Jerry Yud0766ec2022-09-22 10:46:57 +08001121#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && \
1122 defined(MBEDTLS_SSL_SRV_C) && \
1123 defined(MBEDTLS_SSL_SESSION_TICKETS)
1124 ssl->handshake->new_session_tickets_count =
Gilles Peskine449bd832023-01-11 14:50:10 +01001125 ssl->conf->new_session_tickets_count;
Jerry Yud0766ec2022-09-22 10:46:57 +08001126#endif
1127
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001128#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01001129 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +02001130 ssl->handshake->alt_transform_out = ssl->transform_out;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02001131
Gilles Peskine449bd832023-01-11 14:50:10 +01001132 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +02001133 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_PREPARING;
Gilles Peskine449bd832023-01-11 14:50:10 +01001134 } else {
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +02001135 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_WAITING;
Gilles Peskine449bd832023-01-11 14:50:10 +01001136 }
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001137
Gilles Peskine449bd832023-01-11 14:50:10 +01001138 mbedtls_ssl_set_timer(ssl, 0);
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +02001139 }
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02001140#endif
1141
Brett Warrene0edc842021-08-17 09:53:13 +01001142/*
1143 * curve_list is translated to IANA TLS group identifiers here because
1144 * mbedtls_ssl_conf_curves returns void and so can't return
1145 * any error codes.
1146 */
Manuel Pégourié-Gonnardf07ce3b2023-09-22 11:53:41 +02001147#if defined(MBEDTLS_ECP_C)
Brett Warrene0edc842021-08-17 09:53:13 +01001148#if !defined(MBEDTLS_DEPRECATED_REMOVED)
1149 /* Heap allocate and translate curve_list from internal to IANA group ids */
Gilles Peskine449bd832023-01-11 14:50:10 +01001150 if (ssl->conf->curve_list != NULL) {
Brett Warrene0edc842021-08-17 09:53:13 +01001151 size_t length;
1152 const mbedtls_ecp_group_id *curve_list = ssl->conf->curve_list;
1153
Thomas Daubney850a0792023-05-22 12:05:03 +01001154 for (length = 0; (curve_list[length] != MBEDTLS_ECP_DP_NONE); length++) {
Gilles Peskine449bd832023-01-11 14:50:10 +01001155 }
Brett Warrene0edc842021-08-17 09:53:13 +01001156
1157 /* Leave room for zero termination */
Gilles Peskine449bd832023-01-11 14:50:10 +01001158 uint16_t *group_list = mbedtls_calloc(length + 1, sizeof(uint16_t));
1159 if (group_list == NULL) {
1160 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
1161 }
Brett Warrene0edc842021-08-17 09:53:13 +01001162
Gilles Peskine449bd832023-01-11 14:50:10 +01001163 for (size_t i = 0; i < length; i++) {
Valerio Setti18c9fed2022-12-30 17:44:24 +01001164 uint16_t tls_id = mbedtls_ssl_get_tls_id_from_ecp_group_id(
Gilles Peskine449bd832023-01-11 14:50:10 +01001165 curve_list[i]);
1166 if (tls_id == 0) {
1167 mbedtls_free(group_list);
1168 return MBEDTLS_ERR_SSL_BAD_CONFIG;
Brett Warrene0edc842021-08-17 09:53:13 +01001169 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01001170 group_list[i] = tls_id;
Brett Warrene0edc842021-08-17 09:53:13 +01001171 }
1172
1173 group_list[length] = 0;
1174
1175 ssl->handshake->group_list = group_list;
1176 ssl->handshake->group_list_heap_allocated = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01001177 } else {
Brett Warrene0edc842021-08-17 09:53:13 +01001178 ssl->handshake->group_list = ssl->conf->group_list;
1179 ssl->handshake->group_list_heap_allocated = 0;
1180 }
1181#endif /* MBEDTLS_DEPRECATED_REMOVED */
Manuel Pégourié-Gonnardf07ce3b2023-09-22 11:53:41 +02001182#endif /* MBEDTLS_ECP_C */
Brett Warrene0edc842021-08-17 09:53:13 +01001183
Ronald Crone68ab4f2022-10-05 12:46:29 +02001184#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yuf017ee42022-01-12 15:49:48 +08001185#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Jerry Yua69269a2022-01-17 21:06:01 +08001186#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Jerry Yu713013f2022-01-17 18:16:35 +08001187 /* Heap allocate and translate sig_hashes from internal hash identifiers to
1188 signature algorithms IANA identifiers. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001189 if (mbedtls_ssl_conf_is_tls12_only(ssl->conf) &&
1190 ssl->conf->sig_hashes != NULL) {
Jerry Yuf017ee42022-01-12 15:49:48 +08001191 const int *md;
1192 const int *sig_hashes = ssl->conf->sig_hashes;
Jerry Yub476a442022-01-21 18:14:45 +08001193 size_t sig_algs_len = 0;
Jerry Yuf017ee42022-01-12 15:49:48 +08001194 uint16_t *p;
1195
Tom Cosgrove6ef9bb32023-03-08 14:19:51 +00001196 MBEDTLS_STATIC_ASSERT(MBEDTLS_SSL_MAX_SIG_ALG_LIST_LEN
1197 <= (SIZE_MAX - (2 * sizeof(uint16_t))),
1198 "MBEDTLS_SSL_MAX_SIG_ALG_LIST_LEN too big");
Jerry Yua68dca22022-01-20 16:28:27 +08001199
Gilles Peskine449bd832023-01-11 14:50:10 +01001200 for (md = sig_hashes; *md != MBEDTLS_MD_NONE; md++) {
1201 if (mbedtls_ssl_hash_from_md_alg(*md) == MBEDTLS_SSL_HASH_NONE) {
Jerry Yuf017ee42022-01-12 15:49:48 +08001202 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01001203 }
Valerio Settie9646ec2023-08-02 20:02:28 +02001204#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01001205 sig_algs_len += sizeof(uint16_t);
Jerry Yub476a442022-01-21 18:14:45 +08001206#endif
Jerry Yua68dca22022-01-20 16:28:27 +08001207
Jerry Yub476a442022-01-21 18:14:45 +08001208#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001209 sig_algs_len += sizeof(uint16_t);
Jerry Yub476a442022-01-21 18:14:45 +08001210#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001211 if (sig_algs_len > MBEDTLS_SSL_MAX_SIG_ALG_LIST_LEN) {
1212 return MBEDTLS_ERR_SSL_BAD_CONFIG;
1213 }
Jerry Yuf017ee42022-01-12 15:49:48 +08001214 }
1215
Gilles Peskine449bd832023-01-11 14:50:10 +01001216 if (sig_algs_len < MBEDTLS_SSL_MIN_SIG_ALG_LIST_LEN) {
1217 return MBEDTLS_ERR_SSL_BAD_CONFIG;
1218 }
Jerry Yuf017ee42022-01-12 15:49:48 +08001219
Gilles Peskine449bd832023-01-11 14:50:10 +01001220 ssl->handshake->sig_algs = mbedtls_calloc(1, sig_algs_len +
1221 sizeof(uint16_t));
1222 if (ssl->handshake->sig_algs == NULL) {
1223 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
1224 }
Jerry Yuf017ee42022-01-12 15:49:48 +08001225
Gilles Peskine449bd832023-01-11 14:50:10 +01001226 p = (uint16_t *) ssl->handshake->sig_algs;
1227 for (md = sig_hashes; *md != MBEDTLS_MD_NONE; md++) {
1228 unsigned char hash = mbedtls_ssl_hash_from_md_alg(*md);
1229 if (hash == MBEDTLS_SSL_HASH_NONE) {
Jerry Yuf017ee42022-01-12 15:49:48 +08001230 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01001231 }
Valerio Settie9646ec2023-08-02 20:02:28 +02001232#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01001233 *p = ((hash << 8) | MBEDTLS_SSL_SIG_ECDSA);
Jerry Yuf017ee42022-01-12 15:49:48 +08001234 p++;
Jerry Yu6106fdc2022-01-12 16:36:14 +08001235#endif
1236#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001237 *p = ((hash << 8) | MBEDTLS_SSL_SIG_RSA);
Jerry Yuf017ee42022-01-12 15:49:48 +08001238 p++;
Jerry Yu6106fdc2022-01-12 16:36:14 +08001239#endif
Jerry Yuf017ee42022-01-12 15:49:48 +08001240 }
Gabor Mezei15b95a62022-05-09 16:37:58 +02001241 *p = MBEDTLS_TLS_SIG_NONE;
Jerry Yuf017ee42022-01-12 15:49:48 +08001242 ssl->handshake->sig_algs_heap_allocated = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01001243 } else
Jerry Yua69269a2022-01-17 21:06:01 +08001244#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Jerry Yuf017ee42022-01-12 15:49:48 +08001245 {
Jerry Yuf017ee42022-01-12 15:49:48 +08001246 ssl->handshake->sig_algs_heap_allocated = 0;
1247 }
Jerry Yucc539102022-06-27 16:27:35 +08001248#endif /* !MBEDTLS_DEPRECATED_REMOVED */
Ronald Crone68ab4f2022-10-05 12:46:29 +02001249#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Gilles Peskine449bd832023-01-11 14:50:10 +01001250 return 0;
Paul Bakker48916f92012-09-16 19:57:18 +00001251}
1252
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001253#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001254/* Dummy cookie callbacks for defaults */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001255MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001256static int ssl_cookie_write_dummy(void *ctx,
1257 unsigned char **p, unsigned char *end,
1258 const unsigned char *cli_id, size_t cli_id_len)
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001259{
1260 ((void) ctx);
1261 ((void) p);
1262 ((void) end);
1263 ((void) cli_id);
1264 ((void) cli_id_len);
1265
Gilles Peskine449bd832023-01-11 14:50:10 +01001266 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001267}
1268
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001269MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001270static int ssl_cookie_check_dummy(void *ctx,
1271 const unsigned char *cookie, size_t cookie_len,
1272 const unsigned char *cli_id, size_t cli_id_len)
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001273{
1274 ((void) ctx);
1275 ((void) cookie);
1276 ((void) cookie_len);
1277 ((void) cli_id);
1278 ((void) cli_id_len);
1279
Gilles Peskine449bd832023-01-11 14:50:10 +01001280 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001281}
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001282#endif /* MBEDTLS_SSL_DTLS_HELLO_VERIFY && MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001283
Paul Bakker5121ce52009-01-03 21:22:43 +00001284/*
1285 * Initialize an SSL context
1286 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001287void mbedtls_ssl_init(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +02001288{
Gilles Peskine449bd832023-01-11 14:50:10 +01001289 memset(ssl, 0, sizeof(mbedtls_ssl_context));
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +02001290}
1291
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001292MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001293static int ssl_conf_version_check(const mbedtls_ssl_context *ssl)
Jerry Yu60835a82021-08-04 10:13:52 +08001294{
Ronald Cron086ee0b2022-03-15 15:18:51 +01001295 const mbedtls_ssl_config *conf = ssl->conf;
1296
Ronald Cron6f135e12021-12-08 16:57:54 +01001297#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01001298 if (mbedtls_ssl_conf_is_tls13_only(conf)) {
1299 if (conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
1300 MBEDTLS_SSL_DEBUG_MSG(1, ("DTLS 1.3 is not yet supported."));
1301 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
XiaokangQianed582dd2022-04-13 08:21:05 +00001302 }
1303
Gilles Peskine449bd832023-01-11 14:50:10 +01001304 MBEDTLS_SSL_DEBUG_MSG(4, ("The SSL configuration is tls13 only."));
1305 return 0;
Jerry Yu60835a82021-08-04 10:13:52 +08001306 }
1307#endif
1308
1309#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01001310 if (mbedtls_ssl_conf_is_tls12_only(conf)) {
1311 MBEDTLS_SSL_DEBUG_MSG(4, ("The SSL configuration is tls12 only."));
1312 return 0;
Jerry Yu60835a82021-08-04 10:13:52 +08001313 }
1314#endif
1315
Ronald Cron6f135e12021-12-08 16:57:54 +01001316#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01001317 if (mbedtls_ssl_conf_is_hybrid_tls12_tls13(conf)) {
1318 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
1319 MBEDTLS_SSL_DEBUG_MSG(1, ("DTLS not yet supported in Hybrid TLS 1.3 + TLS 1.2"));
1320 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
XiaokangQianed582dd2022-04-13 08:21:05 +00001321 }
1322
Gilles Peskine449bd832023-01-11 14:50:10 +01001323 MBEDTLS_SSL_DEBUG_MSG(4, ("The SSL configuration is TLS 1.3 or TLS 1.2."));
1324 return 0;
Jerry Yu60835a82021-08-04 10:13:52 +08001325 }
1326#endif
1327
Gilles Peskine449bd832023-01-11 14:50:10 +01001328 MBEDTLS_SSL_DEBUG_MSG(1, ("The SSL configuration is invalid."));
1329 return MBEDTLS_ERR_SSL_BAD_CONFIG;
Jerry Yu60835a82021-08-04 10:13:52 +08001330}
1331
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001332MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu60835a82021-08-04 10:13:52 +08001333static int ssl_conf_check(const mbedtls_ssl_context *ssl)
1334{
1335 int ret;
Gilles Peskine449bd832023-01-11 14:50:10 +01001336 ret = ssl_conf_version_check(ssl);
1337 if (ret != 0) {
1338 return ret;
1339 }
Jerry Yu60835a82021-08-04 10:13:52 +08001340
Jerry Yudef7ae42022-10-30 14:13:19 +08001341#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
1342 /* RFC 8446 section 4.4.3
1343 *
1344 * If the verification fails, the receiver MUST terminate the handshake with
1345 * a "decrypt_error" alert.
1346 *
1347 * If the client is configured as TLS 1.3 only with optional verify, return
1348 * bad config.
1349 *
1350 */
Pengyu Lv0a1ff2b2023-11-14 11:03:32 +08001351 if (mbedtls_ssl_conf_tls13_is_ephemeral_enabled(
Gilles Peskine449bd832023-01-11 14:50:10 +01001352 (mbedtls_ssl_context *) ssl) &&
Jerry Yudef7ae42022-10-30 14:13:19 +08001353 ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
1354 ssl->conf->max_tls_version == MBEDTLS_SSL_VERSION_TLS1_3 &&
1355 ssl->conf->min_tls_version == MBEDTLS_SSL_VERSION_TLS1_3 &&
Gilles Peskine449bd832023-01-11 14:50:10 +01001356 ssl->conf->authmode == MBEDTLS_SSL_VERIFY_OPTIONAL) {
Jerry Yudef7ae42022-10-30 14:13:19 +08001357 MBEDTLS_SSL_DEBUG_MSG(
Gilles Peskine449bd832023-01-11 14:50:10 +01001358 1, ("Optional verify auth mode "
1359 "is not available for TLS 1.3 client"));
1360 return MBEDTLS_ERR_SSL_BAD_CONFIG;
Jerry Yudef7ae42022-10-30 14:13:19 +08001361 }
1362#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
1363
Jerry Yu60835a82021-08-04 10:13:52 +08001364 /* Space for further checks */
1365
Gilles Peskine449bd832023-01-11 14:50:10 +01001366 return 0;
Jerry Yu60835a82021-08-04 10:13:52 +08001367}
1368
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +02001369/*
1370 * Setup an SSL context
1371 */
Hanno Becker2a43f6f2018-08-10 11:12:52 +01001372
Gilles Peskine449bd832023-01-11 14:50:10 +01001373int mbedtls_ssl_setup(mbedtls_ssl_context *ssl,
1374 const mbedtls_ssl_config *conf)
Paul Bakker5121ce52009-01-03 21:22:43 +00001375{
Janos Follath865b3eb2019-12-16 11:46:15 +00001376 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Darryl Greenb33cc762019-11-28 14:29:44 +00001377 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
1378 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
Paul Bakker5121ce52009-01-03 21:22:43 +00001379
Manuel Pégourié-Gonnarddef0bbe2015-05-04 14:56:36 +02001380 ssl->conf = conf;
Paul Bakker62f2dee2012-09-28 07:31:51 +00001381
Gilles Peskine449bd832023-01-11 14:50:10 +01001382 if ((ret = ssl_conf_check(ssl)) != 0) {
1383 return ret;
1384 }
Ronald Cron8a12aee2023-03-08 15:30:43 +01001385 ssl->tls_version = ssl->conf->max_tls_version;
Jerry Yu60835a82021-08-04 10:13:52 +08001386
Paul Bakker62f2dee2012-09-28 07:31:51 +00001387 /*
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01001388 * Prepare base structures
Paul Bakker62f2dee2012-09-28 07:31:51 +00001389 */
k-stachowiakc9a5f022018-07-24 13:53:31 +02001390
1391 /* Set to NULL in case of an error condition */
1392 ssl->out_buf = NULL;
k-stachowiaka47911c2018-07-04 17:41:58 +02001393
Darryl Greenb33cc762019-11-28 14:29:44 +00001394#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1395 ssl->in_buf_len = in_buf_len;
1396#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001397 ssl->in_buf = mbedtls_calloc(1, in_buf_len);
1398 if (ssl->in_buf == NULL) {
1399 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc(%" MBEDTLS_PRINTF_SIZET " bytes) failed", in_buf_len));
k-stachowiak9f7798e2018-07-31 16:52:32 +02001400 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
k-stachowiaka47911c2018-07-04 17:41:58 +02001401 goto error;
Angus Grattond8213d02016-05-25 20:56:48 +10001402 }
1403
Darryl Greenb33cc762019-11-28 14:29:44 +00001404#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1405 ssl->out_buf_len = out_buf_len;
1406#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001407 ssl->out_buf = mbedtls_calloc(1, out_buf_len);
1408 if (ssl->out_buf == NULL) {
1409 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc(%" MBEDTLS_PRINTF_SIZET " bytes) failed", out_buf_len));
k-stachowiak9f7798e2018-07-31 16:52:32 +02001410 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
k-stachowiaka47911c2018-07-04 17:41:58 +02001411 goto error;
Paul Bakker5121ce52009-01-03 21:22:43 +00001412 }
1413
Gilles Peskine449bd832023-01-11 14:50:10 +01001414 mbedtls_ssl_reset_in_out_pointers(ssl);
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02001415
Johan Pascalb62bb512015-12-03 21:56:45 +01001416#if defined(MBEDTLS_SSL_DTLS_SRTP)
Gilles Peskine449bd832023-01-11 14:50:10 +01001417 memset(&ssl->dtls_srtp_info, 0, sizeof(ssl->dtls_srtp_info));
Johan Pascalb62bb512015-12-03 21:56:45 +01001418#endif
1419
Gilles Peskine449bd832023-01-11 14:50:10 +01001420 if ((ret = ssl_handshake_init(ssl)) != 0) {
k-stachowiaka47911c2018-07-04 17:41:58 +02001421 goto error;
Gilles Peskine449bd832023-01-11 14:50:10 +01001422 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001423
Gilles Peskine449bd832023-01-11 14:50:10 +01001424 return 0;
k-stachowiaka47911c2018-07-04 17:41:58 +02001425
1426error:
Gilles Peskine449bd832023-01-11 14:50:10 +01001427 mbedtls_free(ssl->in_buf);
1428 mbedtls_free(ssl->out_buf);
k-stachowiaka47911c2018-07-04 17:41:58 +02001429
1430 ssl->conf = NULL;
1431
Darryl Greenb33cc762019-11-28 14:29:44 +00001432#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1433 ssl->in_buf_len = 0;
1434 ssl->out_buf_len = 0;
1435#endif
k-stachowiaka47911c2018-07-04 17:41:58 +02001436 ssl->in_buf = NULL;
1437 ssl->out_buf = NULL;
1438
1439 ssl->in_hdr = NULL;
1440 ssl->in_ctr = NULL;
1441 ssl->in_len = NULL;
1442 ssl->in_iv = NULL;
1443 ssl->in_msg = NULL;
1444
1445 ssl->out_hdr = NULL;
1446 ssl->out_ctr = NULL;
1447 ssl->out_len = NULL;
1448 ssl->out_iv = NULL;
1449 ssl->out_msg = NULL;
1450
Gilles Peskine449bd832023-01-11 14:50:10 +01001451 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00001452}
1453
1454/*
Paul Bakker7eb013f2011-10-06 12:37:39 +00001455 * Reset an initialized and used SSL context for re-use while retaining
1456 * all application-set variables, function pointers and data.
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001457 *
1458 * If partial is non-zero, keep data in the input buffer and client ID.
1459 * (Use when a DTLS client reconnects from the same port.)
Paul Bakker7eb013f2011-10-06 12:37:39 +00001460 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001461void mbedtls_ssl_session_reset_msg_layer(mbedtls_ssl_context *ssl,
1462 int partial)
Paul Bakker7eb013f2011-10-06 12:37:39 +00001463{
Darryl Greenb33cc762019-11-28 14:29:44 +00001464#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1465 size_t in_buf_len = ssl->in_buf_len;
1466 size_t out_buf_len = ssl->out_buf_len;
1467#else
1468 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
1469 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
1470#endif
Paul Bakker48916f92012-09-16 19:57:18 +00001471
Hanno Beckerb0302c42021-08-03 09:39:42 +01001472#if !defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE) || !defined(MBEDTLS_SSL_SRV_C)
1473 partial = 0;
Hanno Becker7e772132018-08-10 12:38:21 +01001474#endif
1475
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001476 /* Cancel any possibly running timer */
Gilles Peskine449bd832023-01-11 14:50:10 +01001477 mbedtls_ssl_set_timer(ssl, 0);
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001478
Gilles Peskine449bd832023-01-11 14:50:10 +01001479 mbedtls_ssl_reset_in_out_pointers(ssl);
Hanno Beckerb0302c42021-08-03 09:39:42 +01001480
1481 /* Reset incoming message parsing */
1482 ssl->in_offt = NULL;
1483 ssl->nb_zero = 0;
1484 ssl->in_msgtype = 0;
1485 ssl->in_msglen = 0;
1486 ssl->in_hslen = 0;
1487 ssl->keep_current_message = 0;
1488 ssl->transform_in = NULL;
1489
1490#if defined(MBEDTLS_SSL_PROTO_DTLS)
1491 ssl->next_record_offset = 0;
1492 ssl->in_epoch = 0;
1493#endif
1494
1495 /* Keep current datagram if partial == 1 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001496 if (partial == 0) {
Hanno Beckerb0302c42021-08-03 09:39:42 +01001497 ssl->in_left = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01001498 memset(ssl->in_buf, 0, in_buf_len);
Hanno Beckerb0302c42021-08-03 09:39:42 +01001499 }
1500
Ronald Cronad8c17b2022-06-10 17:18:09 +02001501 ssl->send_alert = 0;
1502
Hanno Beckerb0302c42021-08-03 09:39:42 +01001503 /* Reset outgoing message writing */
1504 ssl->out_msgtype = 0;
1505 ssl->out_msglen = 0;
1506 ssl->out_left = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01001507 memset(ssl->out_buf, 0, out_buf_len);
1508 memset(ssl->cur_out_ctr, 0, sizeof(ssl->cur_out_ctr));
Hanno Beckerb0302c42021-08-03 09:39:42 +01001509 ssl->transform_out = NULL;
1510
1511#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Gilles Peskine449bd832023-01-11 14:50:10 +01001512 mbedtls_ssl_dtls_replay_reset(ssl);
Hanno Beckerb0302c42021-08-03 09:39:42 +01001513#endif
1514
XiaokangQian2b01dc32022-01-21 02:53:13 +00001515#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01001516 if (ssl->transform) {
1517 mbedtls_ssl_transform_free(ssl->transform);
1518 mbedtls_free(ssl->transform);
Hanno Beckerb0302c42021-08-03 09:39:42 +01001519 ssl->transform = NULL;
1520 }
XiaokangQian2b01dc32022-01-21 02:53:13 +00001521#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
1522
XiaokangQian2b01dc32022-01-21 02:53:13 +00001523#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01001524 mbedtls_ssl_transform_free(ssl->transform_application);
1525 mbedtls_free(ssl->transform_application);
XiaokangQian2b01dc32022-01-21 02:53:13 +00001526 ssl->transform_application = NULL;
1527
Gilles Peskine449bd832023-01-11 14:50:10 +01001528 if (ssl->handshake != NULL) {
Jerry Yu3d9b5902022-11-04 14:07:25 +08001529#if defined(MBEDTLS_SSL_EARLY_DATA)
Gilles Peskine449bd832023-01-11 14:50:10 +01001530 mbedtls_ssl_transform_free(ssl->handshake->transform_earlydata);
1531 mbedtls_free(ssl->handshake->transform_earlydata);
XiaokangQian2b01dc32022-01-21 02:53:13 +00001532 ssl->handshake->transform_earlydata = NULL;
Jerry Yu3d9b5902022-11-04 14:07:25 +08001533#endif
XiaokangQian2b01dc32022-01-21 02:53:13 +00001534
Gilles Peskine449bd832023-01-11 14:50:10 +01001535 mbedtls_ssl_transform_free(ssl->handshake->transform_handshake);
1536 mbedtls_free(ssl->handshake->transform_handshake);
XiaokangQian2b01dc32022-01-21 02:53:13 +00001537 ssl->handshake->transform_handshake = NULL;
1538 }
1539
XiaokangQian2b01dc32022-01-21 02:53:13 +00001540#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Beckerb0302c42021-08-03 09:39:42 +01001541}
1542
Gilles Peskine449bd832023-01-11 14:50:10 +01001543int mbedtls_ssl_session_reset_int(mbedtls_ssl_context *ssl, int partial)
Hanno Beckerb0302c42021-08-03 09:39:42 +01001544{
1545 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1546
1547 ssl->state = MBEDTLS_SSL_HELLO_REQUEST;
1548
Gilles Peskine449bd832023-01-11 14:50:10 +01001549 mbedtls_ssl_session_reset_msg_layer(ssl, partial);
Hanno Beckerb0302c42021-08-03 09:39:42 +01001550
1551 /* Reset renegotiation state */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001552#if defined(MBEDTLS_SSL_RENEGOTIATION)
1553 ssl->renego_status = MBEDTLS_SSL_INITIAL_HANDSHAKE;
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001554 ssl->renego_records_seen = 0;
Paul Bakker48916f92012-09-16 19:57:18 +00001555
1556 ssl->verify_data_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01001557 memset(ssl->own_verify_data, 0, MBEDTLS_SSL_VERIFY_DATA_MAX_LEN);
1558 memset(ssl->peer_verify_data, 0, MBEDTLS_SSL_VERIFY_DATA_MAX_LEN);
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001559#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001560 ssl->secure_renegotiation = MBEDTLS_SSL_LEGACY_RENEGOTIATION;
Paul Bakker48916f92012-09-16 19:57:18 +00001561
Hanno Beckerb0302c42021-08-03 09:39:42 +01001562 ssl->session_in = NULL;
Hanno Becker78640902018-08-13 16:35:15 +01001563 ssl->session_out = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01001564 if (ssl->session) {
1565 mbedtls_ssl_session_free(ssl->session);
1566 mbedtls_free(ssl->session);
Paul Bakkerc0463502013-02-14 11:19:38 +01001567 ssl->session = NULL;
1568 }
1569
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001570#if defined(MBEDTLS_SSL_ALPN)
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001571 ssl->alpn_chosen = NULL;
1572#endif
1573
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001574#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
David Horstmann3b2276a2022-10-06 14:49:08 +01001575 int free_cli_id = 1;
Hanno Becker4ccbf062018-08-10 11:20:38 +01001576#if defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE)
Gilles Peskine449bd832023-01-11 14:50:10 +01001577 free_cli_id = (partial == 0);
Hanno Becker4ccbf062018-08-10 11:20:38 +01001578#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001579 if (free_cli_id) {
1580 mbedtls_free(ssl->cli_id);
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001581 ssl->cli_id = NULL;
1582 ssl->cli_id_len = 0;
1583 }
Manuel Pégourié-Gonnard43c02182014-07-22 17:32:01 +02001584#endif
1585
Gilles Peskine449bd832023-01-11 14:50:10 +01001586 if ((ret = ssl_handshake_init(ssl)) != 0) {
1587 return ret;
1588 }
Paul Bakker2770fbd2012-07-03 13:30:23 +00001589
Gilles Peskine449bd832023-01-11 14:50:10 +01001590 return 0;
Paul Bakker7eb013f2011-10-06 12:37:39 +00001591}
1592
Manuel Pégourié-Gonnard779e4292013-08-03 13:50:48 +02001593/*
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001594 * Reset an initialized and used SSL context for re-use while retaining
1595 * all application-set variables, function pointers and data.
1596 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001597int mbedtls_ssl_session_reset(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001598{
Gilles Peskine449bd832023-01-11 14:50:10 +01001599 return mbedtls_ssl_session_reset_int(ssl, 0);
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001600}
1601
1602/*
Paul Bakker5121ce52009-01-03 21:22:43 +00001603 * SSL set accessors
1604 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001605void mbedtls_ssl_conf_endpoint(mbedtls_ssl_config *conf, int endpoint)
Paul Bakker5121ce52009-01-03 21:22:43 +00001606{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001607 conf->endpoint = endpoint;
Paul Bakker5121ce52009-01-03 21:22:43 +00001608}
1609
Gilles Peskine449bd832023-01-11 14:50:10 +01001610void mbedtls_ssl_conf_transport(mbedtls_ssl_config *conf, int transport)
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001611{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001612 conf->transport = transport;
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001613}
1614
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001615#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Gilles Peskine449bd832023-01-11 14:50:10 +01001616void mbedtls_ssl_conf_dtls_anti_replay(mbedtls_ssl_config *conf, char mode)
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02001617{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001618 conf->anti_replay = mode;
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02001619}
1620#endif
1621
Gilles Peskine449bd832023-01-11 14:50:10 +01001622void mbedtls_ssl_conf_dtls_badmac_limit(mbedtls_ssl_config *conf, unsigned limit)
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001623{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001624 conf->badmac_limit = limit;
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001625}
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001626
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001627#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker04da1892018-08-14 13:22:10 +01001628
Gilles Peskine449bd832023-01-11 14:50:10 +01001629void mbedtls_ssl_set_datagram_packing(mbedtls_ssl_context *ssl,
1630 unsigned allow_packing)
Hanno Becker04da1892018-08-14 13:22:10 +01001631{
1632 ssl->disable_datagram_packing = !allow_packing;
1633}
1634
Gilles Peskine449bd832023-01-11 14:50:10 +01001635void mbedtls_ssl_conf_handshake_timeout(mbedtls_ssl_config *conf,
1636 uint32_t min, uint32_t max)
Manuel Pégourié-Gonnard905dd242014-10-01 12:03:55 +02001637{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001638 conf->hs_timeout_min = min;
1639 conf->hs_timeout_max = max;
Manuel Pégourié-Gonnard905dd242014-10-01 12:03:55 +02001640}
1641#endif
1642
Gilles Peskine449bd832023-01-11 14:50:10 +01001643void mbedtls_ssl_conf_authmode(mbedtls_ssl_config *conf, int authmode)
Paul Bakker5121ce52009-01-03 21:22:43 +00001644{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001645 conf->authmode = authmode;
Paul Bakker5121ce52009-01-03 21:22:43 +00001646}
1647
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001648#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001649void mbedtls_ssl_conf_verify(mbedtls_ssl_config *conf,
1650 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *),
1651 void *p_vrfy)
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001652{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001653 conf->f_vrfy = f_vrfy;
1654 conf->p_vrfy = p_vrfy;
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001655}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001656#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001657
Gilles Peskine449bd832023-01-11 14:50:10 +01001658void mbedtls_ssl_conf_rng(mbedtls_ssl_config *conf,
1659 int (*f_rng)(void *, unsigned char *, size_t),
1660 void *p_rng)
Paul Bakker5121ce52009-01-03 21:22:43 +00001661{
Manuel Pégourié-Gonnard750e4d72015-05-07 12:35:38 +01001662 conf->f_rng = f_rng;
1663 conf->p_rng = p_rng;
Paul Bakker5121ce52009-01-03 21:22:43 +00001664}
1665
Gilles Peskine449bd832023-01-11 14:50:10 +01001666void mbedtls_ssl_conf_dbg(mbedtls_ssl_config *conf,
1667 void (*f_dbg)(void *, int, const char *, int, const char *),
1668 void *p_dbg)
Paul Bakker5121ce52009-01-03 21:22:43 +00001669{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001670 conf->f_dbg = f_dbg;
1671 conf->p_dbg = p_dbg;
Paul Bakker5121ce52009-01-03 21:22:43 +00001672}
1673
Gilles Peskine449bd832023-01-11 14:50:10 +01001674void mbedtls_ssl_set_bio(mbedtls_ssl_context *ssl,
1675 void *p_bio,
1676 mbedtls_ssl_send_t *f_send,
1677 mbedtls_ssl_recv_t *f_recv,
1678 mbedtls_ssl_recv_timeout_t *f_recv_timeout)
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02001679{
1680 ssl->p_bio = p_bio;
1681 ssl->f_send = f_send;
1682 ssl->f_recv = f_recv;
1683 ssl->f_recv_timeout = f_recv_timeout;
Manuel Pégourié-Gonnard97fd52c2015-05-06 15:38:52 +01001684}
1685
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02001686#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01001687void mbedtls_ssl_set_mtu(mbedtls_ssl_context *ssl, uint16_t mtu)
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02001688{
1689 ssl->mtu = mtu;
1690}
1691#endif
1692
Gilles Peskine449bd832023-01-11 14:50:10 +01001693void mbedtls_ssl_conf_read_timeout(mbedtls_ssl_config *conf, uint32_t timeout)
Manuel Pégourié-Gonnard97fd52c2015-05-06 15:38:52 +01001694{
1695 conf->read_timeout = timeout;
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02001696}
1697
Gilles Peskine449bd832023-01-11 14:50:10 +01001698void mbedtls_ssl_set_timer_cb(mbedtls_ssl_context *ssl,
1699 void *p_timer,
1700 mbedtls_ssl_set_timer_t *f_set_timer,
1701 mbedtls_ssl_get_timer_t *f_get_timer)
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02001702{
1703 ssl->p_timer = p_timer;
1704 ssl->f_set_timer = f_set_timer;
1705 ssl->f_get_timer = f_get_timer;
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001706
1707 /* Make sure we start with no timer running */
Gilles Peskine449bd832023-01-11 14:50:10 +01001708 mbedtls_ssl_set_timer(ssl, 0);
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02001709}
1710
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001711#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001712void mbedtls_ssl_conf_session_cache(mbedtls_ssl_config *conf,
1713 void *p_cache,
1714 mbedtls_ssl_cache_get_t *f_get_cache,
1715 mbedtls_ssl_cache_set_t *f_set_cache)
Paul Bakker5121ce52009-01-03 21:22:43 +00001716{
Manuel Pégourié-Gonnard5cb33082015-05-06 18:06:26 +01001717 conf->p_cache = p_cache;
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001718 conf->f_get_cache = f_get_cache;
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001719 conf->f_set_cache = f_set_cache;
Paul Bakker5121ce52009-01-03 21:22:43 +00001720}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001721#endif /* MBEDTLS_SSL_SRV_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00001722
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001723#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001724int mbedtls_ssl_set_session(mbedtls_ssl_context *ssl, const mbedtls_ssl_session *session)
Paul Bakker5121ce52009-01-03 21:22:43 +00001725{
Janos Follath865b3eb2019-12-16 11:46:15 +00001726 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001727
Gilles Peskine449bd832023-01-11 14:50:10 +01001728 if (ssl == NULL ||
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001729 session == NULL ||
1730 ssl->session_negotiate == NULL ||
Gilles Peskine449bd832023-01-11 14:50:10 +01001731 ssl->conf->endpoint != MBEDTLS_SSL_IS_CLIENT) {
1732 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001733 }
1734
Gilles Peskine449bd832023-01-11 14:50:10 +01001735 if (ssl->handshake->resume == 1) {
1736 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
1737 }
Hanno Beckere810bbc2021-05-14 16:01:05 +01001738
Jerry Yu21092062022-10-10 21:21:31 +08001739#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01001740 if (session->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Jerry Yu21092062022-10-10 21:21:31 +08001741 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
Gilles Peskine449bd832023-01-11 14:50:10 +01001742 mbedtls_ssl_ciphersuite_from_id(session->ciphersuite);
Jerry Yu21092062022-10-10 21:21:31 +08001743
Gilles Peskine449bd832023-01-11 14:50:10 +01001744 if (mbedtls_ssl_validate_ciphersuite(
Jerry Yu21092062022-10-10 21:21:31 +08001745 ssl, ciphersuite_info, MBEDTLS_SSL_VERSION_TLS1_3,
Gilles Peskine449bd832023-01-11 14:50:10 +01001746 MBEDTLS_SSL_VERSION_TLS1_3) != 0) {
1747 MBEDTLS_SSL_DEBUG_MSG(4, ("%d is not a valid TLS 1.3 ciphersuite.",
1748 session->ciphersuite));
1749 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jerry Yu21092062022-10-10 21:21:31 +08001750 }
Jerry Yu40afab62022-10-08 10:42:13 +08001751 }
Jerry Yu21092062022-10-10 21:21:31 +08001752#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yu40afab62022-10-08 10:42:13 +08001753
Gilles Peskine449bd832023-01-11 14:50:10 +01001754 if ((ret = mbedtls_ssl_session_copy(ssl->session_negotiate,
1755 session)) != 0) {
1756 return ret;
1757 }
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001758
Paul Bakker0a597072012-09-25 21:55:46 +00001759 ssl->handshake->resume = 1;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001760
Gilles Peskine449bd832023-01-11 14:50:10 +01001761 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00001762}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001763#endif /* MBEDTLS_SSL_CLI_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00001764
Gilles Peskine449bd832023-01-11 14:50:10 +01001765void mbedtls_ssl_conf_ciphersuites(mbedtls_ssl_config *conf,
1766 const int *ciphersuites)
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001767{
Hanno Beckerd60b6c62021-04-29 12:04:11 +01001768 conf->ciphersuite_list = ciphersuites;
Paul Bakker5121ce52009-01-03 21:22:43 +00001769}
1770
Ronald Cron6f135e12021-12-08 16:57:54 +01001771#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01001772void mbedtls_ssl_conf_tls13_key_exchange_modes(mbedtls_ssl_config *conf,
1773 const int kex_modes)
Hanno Becker71f1ed62021-07-24 06:01:47 +01001774{
Xiaofei Bai746f9482021-11-12 08:53:56 +00001775 conf->tls13_kex_modes = kex_modes & MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_ALL;
Hanno Becker71f1ed62021-07-24 06:01:47 +01001776}
Xiaokang Qian72de95d2022-10-25 02:54:33 +00001777
1778#if defined(MBEDTLS_SSL_EARLY_DATA)
Yanray Wangd5ed36f2023-11-07 11:40:43 +08001779void mbedtls_ssl_conf_early_data(mbedtls_ssl_config *conf,
1780 int early_data_enabled)
Xiaokang Qian72de95d2022-10-25 02:54:33 +00001781{
1782 conf->early_data_enabled = early_data_enabled;
1783}
Jerry Yucc4e0072022-11-22 17:22:22 +08001784
1785#if defined(MBEDTLS_SSL_SRV_C)
Yanray Wang07517612023-11-07 11:47:36 +08001786void mbedtls_ssl_conf_max_early_data_size(
Gilles Peskine449bd832023-01-11 14:50:10 +01001787 mbedtls_ssl_config *conf, uint32_t max_early_data_size)
Jerry Yucc4e0072022-11-22 17:22:22 +08001788{
Jerry Yu39da9852022-12-06 16:58:36 +08001789 conf->max_early_data_size = max_early_data_size;
Jerry Yucc4e0072022-11-22 17:22:22 +08001790}
1791#endif /* MBEDTLS_SSL_SRV_C */
1792
Xiaokang Qian72de95d2022-10-25 02:54:33 +00001793#endif /* MBEDTLS_SSL_EARLY_DATA */
Ronald Cron6f135e12021-12-08 16:57:54 +01001794#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker71f1ed62021-07-24 06:01:47 +01001795
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001796#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001797void mbedtls_ssl_conf_cert_profile(mbedtls_ssl_config *conf,
1798 const mbedtls_x509_crt_profile *profile)
Manuel Pégourié-Gonnard6e3ee3a2015-06-17 10:58:20 +02001799{
1800 conf->cert_profile = profile;
1801}
1802
Gilles Peskine449bd832023-01-11 14:50:10 +01001803static void ssl_key_cert_free(mbedtls_ssl_key_cert *key_cert)
Glenn Strauss36872db2022-01-22 05:06:31 -05001804{
1805 mbedtls_ssl_key_cert *cur = key_cert, *next;
1806
Gilles Peskine449bd832023-01-11 14:50:10 +01001807 while (cur != NULL) {
Glenn Strauss36872db2022-01-22 05:06:31 -05001808 next = cur->next;
Gilles Peskine449bd832023-01-11 14:50:10 +01001809 mbedtls_free(cur);
Glenn Strauss36872db2022-01-22 05:06:31 -05001810 cur = next;
1811 }
1812}
1813
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001814/* Append a new keycert entry to a (possibly empty) list */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001815MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001816static int ssl_append_key_cert(mbedtls_ssl_key_cert **head,
1817 mbedtls_x509_crt *cert,
1818 mbedtls_pk_context *key)
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001819{
niisato8ee24222018-06-25 19:05:48 +09001820 mbedtls_ssl_key_cert *new_cert;
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001821
Gilles Peskine449bd832023-01-11 14:50:10 +01001822 if (cert == NULL) {
Glenn Strauss36872db2022-01-22 05:06:31 -05001823 /* Free list if cert is null */
Gilles Peskine449bd832023-01-11 14:50:10 +01001824 ssl_key_cert_free(*head);
Glenn Strauss36872db2022-01-22 05:06:31 -05001825 *head = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01001826 return 0;
Glenn Strauss36872db2022-01-22 05:06:31 -05001827 }
1828
Gilles Peskine449bd832023-01-11 14:50:10 +01001829 new_cert = mbedtls_calloc(1, sizeof(mbedtls_ssl_key_cert));
1830 if (new_cert == NULL) {
1831 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
1832 }
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001833
niisato8ee24222018-06-25 19:05:48 +09001834 new_cert->cert = cert;
1835 new_cert->key = key;
1836 new_cert->next = NULL;
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001837
Glenn Strauss36872db2022-01-22 05:06:31 -05001838 /* Update head if the list was null, else add to the end */
Gilles Peskine449bd832023-01-11 14:50:10 +01001839 if (*head == NULL) {
niisato8ee24222018-06-25 19:05:48 +09001840 *head = new_cert;
Gilles Peskine449bd832023-01-11 14:50:10 +01001841 } else {
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001842 mbedtls_ssl_key_cert *cur = *head;
Gilles Peskine449bd832023-01-11 14:50:10 +01001843 while (cur->next != NULL) {
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001844 cur = cur->next;
Gilles Peskine449bd832023-01-11 14:50:10 +01001845 }
niisato8ee24222018-06-25 19:05:48 +09001846 cur->next = new_cert;
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001847 }
1848
Gilles Peskine449bd832023-01-11 14:50:10 +01001849 return 0;
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001850}
1851
Gilles Peskine449bd832023-01-11 14:50:10 +01001852int mbedtls_ssl_conf_own_cert(mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001853 mbedtls_x509_crt *own_cert,
Gilles Peskine449bd832023-01-11 14:50:10 +01001854 mbedtls_pk_context *pk_key)
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001855{
Gilles Peskine449bd832023-01-11 14:50:10 +01001856 return ssl_append_key_cert(&conf->key_cert, own_cert, pk_key);
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001857}
1858
Gilles Peskine449bd832023-01-11 14:50:10 +01001859void mbedtls_ssl_conf_ca_chain(mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01001860 mbedtls_x509_crt *ca_chain,
Gilles Peskine449bd832023-01-11 14:50:10 +01001861 mbedtls_x509_crl *ca_crl)
Paul Bakker5121ce52009-01-03 21:22:43 +00001862{
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01001863 conf->ca_chain = ca_chain;
1864 conf->ca_crl = ca_crl;
Hanno Becker5adaad92019-03-27 16:54:37 +00001865
1866#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
1867 /* mbedtls_ssl_conf_ca_chain() and mbedtls_ssl_conf_ca_cb()
1868 * cannot be used together. */
1869 conf->f_ca_cb = NULL;
1870 conf->p_ca_cb = NULL;
1871#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
Paul Bakker5121ce52009-01-03 21:22:43 +00001872}
Hanno Becker5adaad92019-03-27 16:54:37 +00001873
1874#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
Gilles Peskine449bd832023-01-11 14:50:10 +01001875void mbedtls_ssl_conf_ca_cb(mbedtls_ssl_config *conf,
1876 mbedtls_x509_crt_ca_cb_t f_ca_cb,
1877 void *p_ca_cb)
Hanno Becker5adaad92019-03-27 16:54:37 +00001878{
1879 conf->f_ca_cb = f_ca_cb;
1880 conf->p_ca_cb = p_ca_cb;
1881
1882 /* mbedtls_ssl_conf_ca_chain() and mbedtls_ssl_conf_ca_cb()
1883 * cannot be used together. */
1884 conf->ca_chain = NULL;
1885 conf->ca_crl = NULL;
1886}
1887#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001888#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkereb2c6582012-09-27 19:15:01 +00001889
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001890#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01001891const unsigned char *mbedtls_ssl_get_hs_sni(mbedtls_ssl_context *ssl,
1892 size_t *name_len)
Glenn Strauss69894072022-01-24 12:58:00 -05001893{
1894 *name_len = ssl->handshake->sni_name_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01001895 return ssl->handshake->sni_name;
Glenn Strauss69894072022-01-24 12:58:00 -05001896}
1897
Gilles Peskine449bd832023-01-11 14:50:10 +01001898int mbedtls_ssl_set_hs_own_cert(mbedtls_ssl_context *ssl,
1899 mbedtls_x509_crt *own_cert,
1900 mbedtls_pk_context *pk_key)
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001901{
Gilles Peskine449bd832023-01-11 14:50:10 +01001902 return ssl_append_key_cert(&ssl->handshake->sni_key_cert,
1903 own_cert, pk_key);
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001904}
Manuel Pégourié-Gonnard22bfa4b2015-05-11 08:46:37 +02001905
Gilles Peskine449bd832023-01-11 14:50:10 +01001906void mbedtls_ssl_set_hs_ca_chain(mbedtls_ssl_context *ssl,
1907 mbedtls_x509_crt *ca_chain,
1908 mbedtls_x509_crl *ca_crl)
Manuel Pégourié-Gonnard22bfa4b2015-05-11 08:46:37 +02001909{
1910 ssl->handshake->sni_ca_chain = ca_chain;
1911 ssl->handshake->sni_ca_crl = ca_crl;
1912}
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +02001913
Glenn Strauss999ef702022-03-11 01:37:23 -05001914#if defined(MBEDTLS_KEY_EXCHANGE_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01001915void mbedtls_ssl_set_hs_dn_hints(mbedtls_ssl_context *ssl,
1916 const mbedtls_x509_crt *crt)
Glenn Strauss999ef702022-03-11 01:37:23 -05001917{
1918 ssl->handshake->dn_hints = crt;
1919}
1920#endif /* MBEDTLS_KEY_EXCHANGE_CERT_REQ_ALLOWED_ENABLED */
1921
Gilles Peskine449bd832023-01-11 14:50:10 +01001922void mbedtls_ssl_set_hs_authmode(mbedtls_ssl_context *ssl,
1923 int authmode)
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +02001924{
1925 ssl->handshake->sni_authmode = authmode;
1926}
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001927#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
1928
Hanno Becker8927c832019-04-03 12:52:50 +01001929#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001930void mbedtls_ssl_set_verify(mbedtls_ssl_context *ssl,
1931 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *),
1932 void *p_vrfy)
Hanno Becker8927c832019-04-03 12:52:50 +01001933{
1934 ssl->f_vrfy = f_vrfy;
1935 ssl->p_vrfy = p_vrfy;
1936}
1937#endif
1938
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02001939#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02001940
Valerio Setti016f6822022-12-09 14:17:50 +01001941#if defined(MBEDTLS_USE_PSA_CRYPTO)
Przemek Stekielfde11282023-03-13 16:06:09 +01001942static const uint8_t jpake_server_id[] = { 's', 'e', 'r', 'v', 'e', 'r' };
1943static const uint8_t jpake_client_id[] = { 'c', 'l', 'i', 'e', 'n', 't' };
1944
Valerio Setti016f6822022-12-09 14:17:50 +01001945static psa_status_t mbedtls_ssl_set_hs_ecjpake_password_common(
Gilles Peskine449bd832023-01-11 14:50:10 +01001946 mbedtls_ssl_context *ssl,
1947 mbedtls_svc_key_id_t pwd)
Valerio Setti016f6822022-12-09 14:17:50 +01001948{
1949 psa_status_t status;
Valerio Setti016f6822022-12-09 14:17:50 +01001950 psa_pake_cipher_suite_t cipher_suite = psa_pake_cipher_suite_init();
Przemek Stekielfde11282023-03-13 16:06:09 +01001951 const uint8_t *user = NULL;
Przemek Stekiel4cd20312023-03-01 11:11:28 +01001952 size_t user_len = 0;
Przemek Stekielfde11282023-03-13 16:06:09 +01001953 const uint8_t *peer = NULL;
Przemek Stekiel4cd20312023-03-01 11:11:28 +01001954 size_t peer_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01001955 psa_pake_cs_set_algorithm(&cipher_suite, PSA_ALG_JPAKE);
1956 psa_pake_cs_set_primitive(&cipher_suite,
1957 PSA_PAKE_PRIMITIVE(PSA_PAKE_PRIMITIVE_TYPE_ECC,
1958 PSA_ECC_FAMILY_SECP_R1,
1959 256));
1960 psa_pake_cs_set_hash(&cipher_suite, PSA_ALG_SHA_256);
Valerio Setti016f6822022-12-09 14:17:50 +01001961
Gilles Peskine449bd832023-01-11 14:50:10 +01001962 status = psa_pake_setup(&ssl->handshake->psa_pake_ctx, &cipher_suite);
1963 if (status != PSA_SUCCESS) {
Valerio Setti016f6822022-12-09 14:17:50 +01001964 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001965 }
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02001966
Gilles Peskine449bd832023-01-11 14:50:10 +01001967 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Przemek Stekielfde11282023-03-13 16:06:09 +01001968 user = jpake_server_id;
1969 user_len = sizeof(jpake_server_id);
1970 peer = jpake_client_id;
1971 peer_len = sizeof(jpake_client_id);
Gilles Peskine449bd832023-01-11 14:50:10 +01001972 } else {
Przemek Stekielfde11282023-03-13 16:06:09 +01001973 user = jpake_client_id;
1974 user_len = sizeof(jpake_client_id);
1975 peer = jpake_server_id;
1976 peer_len = sizeof(jpake_server_id);
Gilles Peskine449bd832023-01-11 14:50:10 +01001977 }
Neil Armstrongca7d5062022-05-31 14:43:23 +02001978
Przemek Stekiel4cd20312023-03-01 11:11:28 +01001979 status = psa_pake_set_user(&ssl->handshake->psa_pake_ctx, user, user_len);
1980 if (status != PSA_SUCCESS) {
1981 return status;
1982 }
1983
1984 status = psa_pake_set_peer(&ssl->handshake->psa_pake_ctx, peer, peer_len);
Gilles Peskine449bd832023-01-11 14:50:10 +01001985 if (status != PSA_SUCCESS) {
Valerio Setti016f6822022-12-09 14:17:50 +01001986 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001987 }
Valerio Setti016f6822022-12-09 14:17:50 +01001988
Gilles Peskine449bd832023-01-11 14:50:10 +01001989 status = psa_pake_set_password_key(&ssl->handshake->psa_pake_ctx, pwd);
1990 if (status != PSA_SUCCESS) {
Valerio Setti016f6822022-12-09 14:17:50 +01001991 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001992 }
Valerio Setti016f6822022-12-09 14:17:50 +01001993
1994 ssl->handshake->psa_pake_ctx_is_ok = 1;
1995
Gilles Peskine449bd832023-01-11 14:50:10 +01001996 return PSA_SUCCESS;
Valerio Setti016f6822022-12-09 14:17:50 +01001997}
1998
Gilles Peskine449bd832023-01-11 14:50:10 +01001999int mbedtls_ssl_set_hs_ecjpake_password(mbedtls_ssl_context *ssl,
2000 const unsigned char *pw,
2001 size_t pw_len)
Valerio Setti016f6822022-12-09 14:17:50 +01002002{
2003 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
2004 psa_status_t status;
2005
Gilles Peskine449bd832023-01-11 14:50:10 +01002006 if (ssl->handshake == NULL || ssl->conf == NULL) {
2007 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Neil Armstrongca7d5062022-05-31 14:43:23 +02002008 }
2009
Gilles Peskine449bd832023-01-11 14:50:10 +01002010 /* Empty password is not valid */
2011 if ((pw == NULL) || (pw_len == 0)) {
2012 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2013 }
2014
2015 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_DERIVE);
2016 psa_set_key_algorithm(&attributes, PSA_ALG_JPAKE);
2017 psa_set_key_type(&attributes, PSA_KEY_TYPE_PASSWORD);
2018
2019 status = psa_import_key(&attributes, pw, pw_len,
2020 &ssl->handshake->psa_pake_password);
2021 if (status != PSA_SUCCESS) {
2022 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
2023 }
2024
2025 status = mbedtls_ssl_set_hs_ecjpake_password_common(ssl,
2026 ssl->handshake->psa_pake_password);
2027 if (status != PSA_SUCCESS) {
2028 psa_destroy_key(ssl->handshake->psa_pake_password);
2029 psa_pake_abort(&ssl->handshake->psa_pake_ctx);
2030 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
2031 }
2032
2033 return 0;
Valerio Setti02c25b52022-11-15 14:08:42 +01002034}
Valerio Settia9a97dc2022-11-28 18:26:16 +01002035
Gilles Peskine449bd832023-01-11 14:50:10 +01002036int mbedtls_ssl_set_hs_ecjpake_password_opaque(mbedtls_ssl_context *ssl,
2037 mbedtls_svc_key_id_t pwd)
Valerio Settia9a97dc2022-11-28 18:26:16 +01002038{
Valerio Settia9a97dc2022-11-28 18:26:16 +01002039 psa_status_t status;
2040
Gilles Peskine449bd832023-01-11 14:50:10 +01002041 if (ssl->handshake == NULL || ssl->conf == NULL) {
2042 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Neil Armstrongca7d5062022-05-31 14:43:23 +02002043 }
2044
Gilles Peskine449bd832023-01-11 14:50:10 +01002045 if (mbedtls_svc_key_id_is_null(pwd)) {
2046 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2047 }
2048
2049 status = mbedtls_ssl_set_hs_ecjpake_password_common(ssl, pwd);
2050 if (status != PSA_SUCCESS) {
2051 psa_pake_abort(&ssl->handshake->psa_pake_ctx);
2052 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
2053 }
2054
2055 return 0;
Valerio Setti02c25b52022-11-15 14:08:42 +01002056}
2057#else /* MBEDTLS_USE_PSA_CRYPTO */
Gilles Peskine449bd832023-01-11 14:50:10 +01002058int mbedtls_ssl_set_hs_ecjpake_password(mbedtls_ssl_context *ssl,
2059 const unsigned char *pw,
2060 size_t pw_len)
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002061{
2062 mbedtls_ecjpake_role role;
2063
Gilles Peskine449bd832023-01-11 14:50:10 +01002064 if (ssl->handshake == NULL || ssl->conf == NULL) {
2065 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2066 }
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002067
Valerio Settic689ed82022-12-07 14:40:38 +01002068 /* Empty password is not valid */
Gilles Peskine449bd832023-01-11 14:50:10 +01002069 if ((pw == NULL) || (pw_len == 0)) {
2070 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2071 }
Valerio Settic689ed82022-12-07 14:40:38 +01002072
Gilles Peskine449bd832023-01-11 14:50:10 +01002073 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002074 role = MBEDTLS_ECJPAKE_SERVER;
Gilles Peskine449bd832023-01-11 14:50:10 +01002075 } else {
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002076 role = MBEDTLS_ECJPAKE_CLIENT;
Gilles Peskine449bd832023-01-11 14:50:10 +01002077 }
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002078
Gilles Peskine449bd832023-01-11 14:50:10 +01002079 return mbedtls_ecjpake_setup(&ssl->handshake->ecjpake_ctx,
2080 role,
2081 MBEDTLS_MD_SHA256,
2082 MBEDTLS_ECP_DP_SECP256R1,
2083 pw, pw_len);
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002084}
Valerio Setti02c25b52022-11-15 14:08:42 +01002085#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02002086#endif /* MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED */
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002087
Ronald Cron73fe8df2022-10-05 14:31:43 +02002088#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01002089int mbedtls_ssl_conf_has_static_psk(mbedtls_ssl_config const *conf)
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002090{
Gilles Peskine449bd832023-01-11 14:50:10 +01002091 if (conf->psk_identity == NULL ||
2092 conf->psk_identity_len == 0) {
2093 return 0;
Ronald Crond29e13e2022-10-19 10:33:48 +02002094 }
2095
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002096#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01002097 if (!mbedtls_svc_key_id_is_null(conf->psk_opaque)) {
2098 return 1;
2099 }
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002100#endif /* MBEDTLS_USE_PSA_CRYPTO */
Ronald Crond29e13e2022-10-19 10:33:48 +02002101
Gilles Peskine449bd832023-01-11 14:50:10 +01002102 if (conf->psk != NULL && conf->psk_len != 0) {
2103 return 1;
2104 }
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002105
Gilles Peskine449bd832023-01-11 14:50:10 +01002106 return 0;
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002107}
2108
Gilles Peskine449bd832023-01-11 14:50:10 +01002109static void ssl_conf_remove_psk(mbedtls_ssl_config *conf)
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002110{
2111 /* Remove reference to existing PSK, if any. */
2112#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01002113 if (!mbedtls_svc_key_id_is_null(conf->psk_opaque)) {
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002114 /* The maintenance of the PSK key slot is the
2115 * user's responsibility. */
Ronald Croncf56a0a2020-08-04 09:51:30 +02002116 conf->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002117 }
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002118#endif /* MBEDTLS_USE_PSA_CRYPTO */
Gilles Peskine449bd832023-01-11 14:50:10 +01002119 if (conf->psk != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01002120 mbedtls_zeroize_and_free(conf->psk, conf->psk_len);
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002121 conf->psk = NULL;
2122 conf->psk_len = 0;
2123 }
2124
2125 /* Remove reference to PSK identity, if any. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002126 if (conf->psk_identity != NULL) {
2127 mbedtls_free(conf->psk_identity);
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002128 conf->psk_identity = NULL;
2129 conf->psk_identity_len = 0;
2130 }
2131}
2132
Hanno Becker7390c712018-11-15 13:33:04 +00002133/* This function assumes that PSK identity in the SSL config is unset.
2134 * It checks that the provided identity is well-formed and attempts
2135 * to make a copy of it in the SSL config.
2136 * On failure, the PSK identity in the config remains unset. */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002137MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002138static int ssl_conf_set_psk_identity(mbedtls_ssl_config *conf,
2139 unsigned char const *psk_identity,
2140 size_t psk_identity_len)
Paul Bakkerd4a56ec2013-04-16 18:05:29 +02002141{
Manuel Pégourié-Gonnardc6b5d832015-08-27 16:37:35 +02002142 /* Identity len will be encoded on two bytes */
Gilles Peskine449bd832023-01-11 14:50:10 +01002143 if (psk_identity == NULL ||
Ronald Cron2a87e9b2022-10-19 10:55:26 +02002144 psk_identity_len == 0 ||
Gilles Peskine449bd832023-01-11 14:50:10 +01002145 (psk_identity_len >> 16) != 0 ||
2146 psk_identity_len > MBEDTLS_SSL_OUT_CONTENT_LEN) {
2147 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnardc6b5d832015-08-27 16:37:35 +02002148 }
2149
Gilles Peskine449bd832023-01-11 14:50:10 +01002150 conf->psk_identity = mbedtls_calloc(1, psk_identity_len);
2151 if (conf->psk_identity == NULL) {
2152 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
2153 }
Paul Bakker6db455e2013-09-18 17:29:31 +02002154
Manuel Pégourié-Gonnard120fdbd2015-05-07 17:07:50 +01002155 conf->psk_identity_len = psk_identity_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01002156 memcpy(conf->psk_identity, psk_identity, conf->psk_identity_len);
Paul Bakker5ad403f2013-09-18 21:21:30 +02002157
Gilles Peskine449bd832023-01-11 14:50:10 +01002158 return 0;
Paul Bakker6db455e2013-09-18 17:29:31 +02002159}
2160
Gilles Peskine449bd832023-01-11 14:50:10 +01002161int mbedtls_ssl_conf_psk(mbedtls_ssl_config *conf,
2162 const unsigned char *psk, size_t psk_len,
2163 const unsigned char *psk_identity, size_t psk_identity_len)
Hanno Becker7390c712018-11-15 13:33:04 +00002164{
Janos Follath865b3eb2019-12-16 11:46:15 +00002165 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002166
2167 /* We currently only support one PSK, raw or opaque. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002168 if (mbedtls_ssl_conf_has_static_psk(conf)) {
2169 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
2170 }
Hanno Becker7390c712018-11-15 13:33:04 +00002171
2172 /* Check and set raw PSK */
Gilles Peskine449bd832023-01-11 14:50:10 +01002173 if (psk == NULL) {
2174 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2175 }
2176 if (psk_len == 0) {
2177 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2178 }
2179 if (psk_len > MBEDTLS_PSK_MAX_LEN) {
2180 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2181 }
Piotr Nowicki9926eaf2019-11-20 14:54:36 +01002182
Gilles Peskine449bd832023-01-11 14:50:10 +01002183 if ((conf->psk = mbedtls_calloc(1, psk_len)) == NULL) {
2184 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
2185 }
Hanno Becker7390c712018-11-15 13:33:04 +00002186 conf->psk_len = psk_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01002187 memcpy(conf->psk, psk, conf->psk_len);
Hanno Becker7390c712018-11-15 13:33:04 +00002188
2189 /* Check and set PSK Identity */
Gilles Peskine449bd832023-01-11 14:50:10 +01002190 ret = ssl_conf_set_psk_identity(conf, psk_identity, psk_identity_len);
2191 if (ret != 0) {
2192 ssl_conf_remove_psk(conf);
2193 }
Hanno Becker7390c712018-11-15 13:33:04 +00002194
Gilles Peskine449bd832023-01-11 14:50:10 +01002195 return ret;
Hanno Becker7390c712018-11-15 13:33:04 +00002196}
2197
Gilles Peskine449bd832023-01-11 14:50:10 +01002198static void ssl_remove_psk(mbedtls_ssl_context *ssl)
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002199{
2200#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01002201 if (!mbedtls_svc_key_id_is_null(ssl->handshake->psk_opaque)) {
Neil Armstrong501c9322022-05-03 09:35:09 +02002202 /* The maintenance of the external PSK key slot is the
2203 * user's responsibility. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002204 if (ssl->handshake->psk_opaque_is_internal) {
2205 psa_destroy_key(ssl->handshake->psk_opaque);
Neil Armstrong501c9322022-05-03 09:35:09 +02002206 ssl->handshake->psk_opaque_is_internal = 0;
2207 }
Ronald Croncf56a0a2020-08-04 09:51:30 +02002208 ssl->handshake->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002209 }
Neil Armstronge952a302022-05-03 10:22:14 +02002210#else
Gilles Peskine449bd832023-01-11 14:50:10 +01002211 if (ssl->handshake->psk != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01002212 mbedtls_zeroize_and_free(ssl->handshake->psk,
Gilles Peskine449bd832023-01-11 14:50:10 +01002213 ssl->handshake->psk_len);
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002214 ssl->handshake->psk_len = 0;
2215 }
Neil Armstronge952a302022-05-03 10:22:14 +02002216#endif /* MBEDTLS_USE_PSA_CRYPTO */
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002217}
2218
Gilles Peskine449bd832023-01-11 14:50:10 +01002219int mbedtls_ssl_set_hs_psk(mbedtls_ssl_context *ssl,
2220 const unsigned char *psk, size_t psk_len)
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002221{
Neil Armstrong501c9322022-05-03 09:35:09 +02002222#if defined(MBEDTLS_USE_PSA_CRYPTO)
2223 psa_key_attributes_t key_attributes = psa_key_attributes_init();
Jerry Yu5d01c052022-08-17 10:18:10 +08002224 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Jerry Yu24b8c812022-08-20 19:06:56 +08002225 psa_algorithm_t alg = PSA_ALG_NONE;
Jerry Yu5d01c052022-08-17 10:18:10 +08002226 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Neil Armstrong501c9322022-05-03 09:35:09 +02002227#endif /* MBEDTLS_USE_PSA_CRYPTO */
2228
Gilles Peskine449bd832023-01-11 14:50:10 +01002229 if (psk == NULL || ssl->handshake == NULL) {
2230 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2231 }
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002232
Gilles Peskine449bd832023-01-11 14:50:10 +01002233 if (psk_len > MBEDTLS_PSK_MAX_LEN) {
2234 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2235 }
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002236
Gilles Peskine449bd832023-01-11 14:50:10 +01002237 ssl_remove_psk(ssl);
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002238
Neil Armstrong501c9322022-05-03 09:35:09 +02002239#if defined(MBEDTLS_USE_PSA_CRYPTO)
Jerry Yuccc68a42022-07-26 16:39:20 +08002240#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01002241 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_2) {
2242 if (ssl->handshake->ciphersuite_info->mac == MBEDTLS_MD_SHA384) {
2243 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_384);
2244 } else {
2245 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_256);
2246 }
2247 psa_set_key_usage_flags(&key_attributes, PSA_KEY_USAGE_DERIVE);
Jerry Yuccc68a42022-07-26 16:39:20 +08002248 }
2249#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Neil Armstrong501c9322022-05-03 09:35:09 +02002250
Jerry Yu568ec252022-07-22 21:27:34 +08002251#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01002252 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
2253 alg = PSA_ALG_HKDF_EXTRACT(PSA_ALG_ANY_HASH);
2254 psa_set_key_usage_flags(&key_attributes,
2255 PSA_KEY_USAGE_DERIVE | PSA_KEY_USAGE_EXPORT);
Jerry Yuccc68a42022-07-26 16:39:20 +08002256 }
2257#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
2258
Gilles Peskine449bd832023-01-11 14:50:10 +01002259 psa_set_key_algorithm(&key_attributes, alg);
2260 psa_set_key_type(&key_attributes, PSA_KEY_TYPE_DERIVE);
Neil Armstrong501c9322022-05-03 09:35:09 +02002261
Gilles Peskine449bd832023-01-11 14:50:10 +01002262 status = psa_import_key(&key_attributes, psk, psk_len, &key);
2263 if (status != PSA_SUCCESS) {
2264 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
2265 }
Neil Armstrong501c9322022-05-03 09:35:09 +02002266
2267 /* Allow calling psa_destroy_key() on psk remove */
2268 ssl->handshake->psk_opaque_is_internal = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01002269 return mbedtls_ssl_set_hs_psk_opaque(ssl, key);
Neil Armstrong501c9322022-05-03 09:35:09 +02002270#else
Gilles Peskine449bd832023-01-11 14:50:10 +01002271 if ((ssl->handshake->psk = mbedtls_calloc(1, psk_len)) == NULL) {
2272 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
2273 }
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002274
2275 ssl->handshake->psk_len = psk_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01002276 memcpy(ssl->handshake->psk, psk, ssl->handshake->psk_len);
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002277
Gilles Peskine449bd832023-01-11 14:50:10 +01002278 return 0;
Neil Armstrong501c9322022-05-03 09:35:09 +02002279#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002280}
2281
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002282#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01002283int mbedtls_ssl_conf_psk_opaque(mbedtls_ssl_config *conf,
2284 mbedtls_svc_key_id_t psk,
2285 const unsigned char *psk_identity,
2286 size_t psk_identity_len)
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002287{
Janos Follath865b3eb2019-12-16 11:46:15 +00002288 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002289
2290 /* We currently only support one PSK, raw or opaque. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002291 if (mbedtls_ssl_conf_has_static_psk(conf)) {
2292 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
2293 }
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002294
Hanno Becker7390c712018-11-15 13:33:04 +00002295 /* Check and set opaque PSK */
Gilles Peskine449bd832023-01-11 14:50:10 +01002296 if (mbedtls_svc_key_id_is_null(psk)) {
2297 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2298 }
Ronald Croncf56a0a2020-08-04 09:51:30 +02002299 conf->psk_opaque = psk;
Hanno Becker7390c712018-11-15 13:33:04 +00002300
2301 /* Check and set PSK Identity */
Gilles Peskine449bd832023-01-11 14:50:10 +01002302 ret = ssl_conf_set_psk_identity(conf, psk_identity,
2303 psk_identity_len);
2304 if (ret != 0) {
2305 ssl_conf_remove_psk(conf);
2306 }
Hanno Becker7390c712018-11-15 13:33:04 +00002307
Gilles Peskine449bd832023-01-11 14:50:10 +01002308 return ret;
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002309}
2310
Gilles Peskine449bd832023-01-11 14:50:10 +01002311int mbedtls_ssl_set_hs_psk_opaque(mbedtls_ssl_context *ssl,
2312 mbedtls_svc_key_id_t psk)
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002313{
Gilles Peskine449bd832023-01-11 14:50:10 +01002314 if ((mbedtls_svc_key_id_is_null(psk)) ||
2315 (ssl->handshake == NULL)) {
2316 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2317 }
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002318
Gilles Peskine449bd832023-01-11 14:50:10 +01002319 ssl_remove_psk(ssl);
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002320 ssl->handshake->psk_opaque = psk;
Gilles Peskine449bd832023-01-11 14:50:10 +01002321 return 0;
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002322}
2323#endif /* MBEDTLS_USE_PSA_CRYPTO */
2324
Jerry Yu8897c072022-08-12 13:56:53 +08002325#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002326void mbedtls_ssl_conf_psk_cb(mbedtls_ssl_config *conf,
2327 int (*f_psk)(void *, mbedtls_ssl_context *, const unsigned char *,
2328 size_t),
2329 void *p_psk)
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002330{
2331 conf->f_psk = f_psk;
2332 conf->p_psk = p_psk;
2333}
Jerry Yu8897c072022-08-12 13:56:53 +08002334#endif /* MBEDTLS_SSL_SRV_C */
2335
Ronald Cron73fe8df2022-10-05 14:31:43 +02002336#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED */
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002337
2338#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine301711e2022-04-26 16:57:05 +02002339static mbedtls_ssl_mode_t mbedtls_ssl_get_base_mode(
Gilles Peskine449bd832023-01-11 14:50:10 +01002340 psa_algorithm_t alg)
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002341{
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002342#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01002343 if (alg == PSA_ALG_CBC_NO_PADDING) {
2344 return MBEDTLS_SSL_MODE_CBC;
2345 }
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002346#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
Gilles Peskine449bd832023-01-11 14:50:10 +01002347 if (PSA_ALG_IS_AEAD(alg)) {
2348 return MBEDTLS_SSL_MODE_AEAD;
2349 }
2350 return MBEDTLS_SSL_MODE_STREAM;
Gilles Peskine301711e2022-04-26 16:57:05 +02002351}
2352
2353#else /* MBEDTLS_USE_PSA_CRYPTO */
2354
2355static mbedtls_ssl_mode_t mbedtls_ssl_get_base_mode(
Gilles Peskine449bd832023-01-11 14:50:10 +01002356 mbedtls_cipher_mode_t mode)
Gilles Peskine301711e2022-04-26 16:57:05 +02002357{
2358#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01002359 if (mode == MBEDTLS_MODE_CBC) {
2360 return MBEDTLS_SSL_MODE_CBC;
2361 }
Gilles Peskine301711e2022-04-26 16:57:05 +02002362#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
2363
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002364#if defined(MBEDTLS_GCM_C) || \
2365 defined(MBEDTLS_CCM_C) || \
2366 defined(MBEDTLS_CHACHAPOLY_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002367 if (mode == MBEDTLS_MODE_GCM ||
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002368 mode == MBEDTLS_MODE_CCM ||
Gilles Peskine449bd832023-01-11 14:50:10 +01002369 mode == MBEDTLS_MODE_CHACHAPOLY) {
2370 return MBEDTLS_SSL_MODE_AEAD;
2371 }
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002372#endif /* MBEDTLS_GCM_C || MBEDTLS_CCM_C || MBEDTLS_CHACHAPOLY_C */
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002373
Gilles Peskine449bd832023-01-11 14:50:10 +01002374 return MBEDTLS_SSL_MODE_STREAM;
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002375}
Gilles Peskine301711e2022-04-26 16:57:05 +02002376#endif /* MBEDTLS_USE_PSA_CRYPTO */
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002377
Gilles Peskinee108d982022-04-26 16:50:40 +02002378static mbedtls_ssl_mode_t mbedtls_ssl_get_actual_mode(
2379 mbedtls_ssl_mode_t base_mode,
Gilles Peskine449bd832023-01-11 14:50:10 +01002380 int encrypt_then_mac)
Gilles Peskinee108d982022-04-26 16:50:40 +02002381{
2382#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01002383 if (encrypt_then_mac == MBEDTLS_SSL_ETM_ENABLED &&
2384 base_mode == MBEDTLS_SSL_MODE_CBC) {
2385 return MBEDTLS_SSL_MODE_CBC_ETM;
Gilles Peskinee108d982022-04-26 16:50:40 +02002386 }
2387#else
2388 (void) encrypt_then_mac;
2389#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002390 return base_mode;
Gilles Peskinee108d982022-04-26 16:50:40 +02002391}
2392
Neil Armstrongab555e02022-04-04 11:07:59 +02002393mbedtls_ssl_mode_t mbedtls_ssl_get_mode_from_transform(
Gilles Peskine449bd832023-01-11 14:50:10 +01002394 const mbedtls_ssl_transform *transform)
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002395{
Gilles Peskinee108d982022-04-26 16:50:40 +02002396 mbedtls_ssl_mode_t base_mode = mbedtls_ssl_get_base_mode(
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002397#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01002398 transform->psa_alg
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002399#else
Gilles Peskine449bd832023-01-11 14:50:10 +01002400 mbedtls_cipher_get_cipher_mode(&transform->cipher_ctx_enc)
Gilles Peskinee108d982022-04-26 16:50:40 +02002401#endif
2402 );
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002403
Gilles Peskinee108d982022-04-26 16:50:40 +02002404 int encrypt_then_mac = 0;
Neil Armstrongf2c82f02022-04-05 11:16:53 +02002405#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskinee108d982022-04-26 16:50:40 +02002406 encrypt_then_mac = transform->encrypt_then_mac;
2407#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002408 return mbedtls_ssl_get_actual_mode(base_mode, encrypt_then_mac);
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002409}
2410
Neil Armstrongab555e02022-04-04 11:07:59 +02002411mbedtls_ssl_mode_t mbedtls_ssl_get_mode_from_ciphersuite(
Neil Armstrongf2c82f02022-04-05 11:16:53 +02002412#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01002413 int encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02002414#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01002415 const mbedtls_ssl_ciphersuite_t *suite)
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002416{
Gilles Peskinee108d982022-04-26 16:50:40 +02002417 mbedtls_ssl_mode_t base_mode = MBEDTLS_SSL_MODE_STREAM;
2418
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002419#if defined(MBEDTLS_USE_PSA_CRYPTO)
2420 psa_status_t status;
2421 psa_algorithm_t alg;
2422 psa_key_type_t type;
2423 size_t size;
Dave Rodgman2eab4622023-10-05 13:30:37 +01002424 status = mbedtls_ssl_cipher_to_psa((mbedtls_cipher_type_t) suite->cipher,
2425 0, &alg, &type, &size);
Gilles Peskine449bd832023-01-11 14:50:10 +01002426 if (status == PSA_SUCCESS) {
2427 base_mode = mbedtls_ssl_get_base_mode(alg);
2428 }
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002429#else
2430 const mbedtls_cipher_info_t *cipher =
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01002431 mbedtls_cipher_info_from_type((mbedtls_cipher_type_t) suite->cipher);
Gilles Peskine449bd832023-01-11 14:50:10 +01002432 if (cipher != NULL) {
Gilles Peskinee108d982022-04-26 16:50:40 +02002433 base_mode =
2434 mbedtls_ssl_get_base_mode(
Gilles Peskine449bd832023-01-11 14:50:10 +01002435 mbedtls_cipher_info_get_mode(cipher));
Gilles Peskinee108d982022-04-26 16:50:40 +02002436 }
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002437#endif /* MBEDTLS_USE_PSA_CRYPTO */
2438
Gilles Peskinee108d982022-04-26 16:50:40 +02002439#if !defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
2440 int encrypt_then_mac = 0;
2441#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002442 return mbedtls_ssl_get_actual_mode(base_mode, encrypt_then_mac);
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002443}
2444
Neil Armstrong8395d7a2022-05-18 11:44:56 +02002445#if defined(MBEDTLS_USE_PSA_CRYPTO) || defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yu251a12e2022-07-13 15:15:48 +08002446
Gilles Peskine449bd832023-01-11 14:50:10 +01002447psa_status_t mbedtls_ssl_cipher_to_psa(mbedtls_cipher_type_t mbedtls_cipher_type,
2448 size_t taglen,
2449 psa_algorithm_t *alg,
2450 psa_key_type_t *key_type,
2451 size_t *key_size)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002452{
Yanray Wang19e4dc82023-11-16 18:02:05 +08002453#if !defined(MBEDTLS_SSL_HAVE_CCM)
2454 (void) taglen;
2455#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002456 switch (mbedtls_cipher_type) {
Yanray Wang1a369d62023-11-16 15:17:31 +08002457#if defined(MBEDTLS_SSL_HAVE_AES) && defined(MBEDTLS_SSL_HAVE_CBC)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002458 case MBEDTLS_CIPHER_AES_128_CBC:
2459 *alg = PSA_ALG_CBC_NO_PADDING;
2460 *key_type = PSA_KEY_TYPE_AES;
2461 *key_size = 128;
2462 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002463#endif
2464#if defined(MBEDTLS_SSL_HAVE_AES) && defined(MBEDTLS_SSL_HAVE_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002465 case MBEDTLS_CIPHER_AES_128_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002466 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002467 *key_type = PSA_KEY_TYPE_AES;
2468 *key_size = 128;
2469 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002470#endif
2471#if defined(MBEDTLS_SSL_HAVE_AES) && defined(MBEDTLS_SSL_HAVE_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002472 case MBEDTLS_CIPHER_AES_128_GCM:
2473 *alg = PSA_ALG_GCM;
2474 *key_type = PSA_KEY_TYPE_AES;
2475 *key_size = 128;
2476 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002477#endif
2478#if defined(MBEDTLS_SSL_HAVE_AES) && defined(MBEDTLS_SSL_HAVE_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002479 case MBEDTLS_CIPHER_AES_192_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002480 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002481 *key_type = PSA_KEY_TYPE_AES;
2482 *key_size = 192;
2483 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002484#endif
2485#if defined(MBEDTLS_SSL_HAVE_AES) && defined(MBEDTLS_SSL_HAVE_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002486 case MBEDTLS_CIPHER_AES_192_GCM:
2487 *alg = PSA_ALG_GCM;
2488 *key_type = PSA_KEY_TYPE_AES;
2489 *key_size = 192;
2490 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002491#endif
2492#if defined(MBEDTLS_SSL_HAVE_AES) && defined(MBEDTLS_SSL_HAVE_CBC)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002493 case MBEDTLS_CIPHER_AES_256_CBC:
2494 *alg = PSA_ALG_CBC_NO_PADDING;
2495 *key_type = PSA_KEY_TYPE_AES;
2496 *key_size = 256;
2497 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002498#endif
2499#if defined(MBEDTLS_SSL_HAVE_AES) && defined(MBEDTLS_SSL_HAVE_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002500 case MBEDTLS_CIPHER_AES_256_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002501 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002502 *key_type = PSA_KEY_TYPE_AES;
2503 *key_size = 256;
2504 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002505#endif
2506#if defined(MBEDTLS_SSL_HAVE_AES) && defined(MBEDTLS_SSL_HAVE_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002507 case MBEDTLS_CIPHER_AES_256_GCM:
2508 *alg = PSA_ALG_GCM;
2509 *key_type = PSA_KEY_TYPE_AES;
2510 *key_size = 256;
2511 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002512#endif
2513#if defined(MBEDTLS_SSL_HAVE_ARIA) && defined(MBEDTLS_SSL_HAVE_CBC)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002514 case MBEDTLS_CIPHER_ARIA_128_CBC:
2515 *alg = PSA_ALG_CBC_NO_PADDING;
2516 *key_type = PSA_KEY_TYPE_ARIA;
2517 *key_size = 128;
2518 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002519#endif
2520#if defined(MBEDTLS_SSL_HAVE_ARIA) && defined(MBEDTLS_SSL_HAVE_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002521 case MBEDTLS_CIPHER_ARIA_128_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002522 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002523 *key_type = PSA_KEY_TYPE_ARIA;
2524 *key_size = 128;
2525 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002526#endif
2527#if defined(MBEDTLS_SSL_HAVE_ARIA) && defined(MBEDTLS_SSL_HAVE_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002528 case MBEDTLS_CIPHER_ARIA_128_GCM:
2529 *alg = PSA_ALG_GCM;
2530 *key_type = PSA_KEY_TYPE_ARIA;
2531 *key_size = 128;
2532 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002533#endif
2534#if defined(MBEDTLS_SSL_HAVE_ARIA) && defined(MBEDTLS_SSL_HAVE_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002535 case MBEDTLS_CIPHER_ARIA_192_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002536 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002537 *key_type = PSA_KEY_TYPE_ARIA;
2538 *key_size = 192;
2539 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002540#endif
2541#if defined(MBEDTLS_SSL_HAVE_ARIA) && defined(MBEDTLS_SSL_HAVE_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002542 case MBEDTLS_CIPHER_ARIA_192_GCM:
2543 *alg = PSA_ALG_GCM;
2544 *key_type = PSA_KEY_TYPE_ARIA;
2545 *key_size = 192;
2546 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002547#endif
2548#if defined(MBEDTLS_SSL_HAVE_ARIA) && defined(MBEDTLS_SSL_HAVE_CBC)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002549 case MBEDTLS_CIPHER_ARIA_256_CBC:
2550 *alg = PSA_ALG_CBC_NO_PADDING;
2551 *key_type = PSA_KEY_TYPE_ARIA;
2552 *key_size = 256;
2553 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002554#endif
2555#if defined(MBEDTLS_SSL_HAVE_ARIA) && defined(MBEDTLS_SSL_HAVE_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002556 case MBEDTLS_CIPHER_ARIA_256_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002557 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002558 *key_type = PSA_KEY_TYPE_ARIA;
2559 *key_size = 256;
2560 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002561#endif
2562#if defined(MBEDTLS_SSL_HAVE_ARIA) && defined(MBEDTLS_SSL_HAVE_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002563 case MBEDTLS_CIPHER_ARIA_256_GCM:
2564 *alg = PSA_ALG_GCM;
2565 *key_type = PSA_KEY_TYPE_ARIA;
2566 *key_size = 256;
2567 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002568#endif
2569#if defined(MBEDTLS_SSL_HAVE_CAMELLIA) && defined(MBEDTLS_SSL_HAVE_CBC)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002570 case MBEDTLS_CIPHER_CAMELLIA_128_CBC:
2571 *alg = PSA_ALG_CBC_NO_PADDING;
2572 *key_type = PSA_KEY_TYPE_CAMELLIA;
2573 *key_size = 128;
2574 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002575#endif
2576#if defined(MBEDTLS_SSL_HAVE_CAMELLIA) && defined(MBEDTLS_SSL_HAVE_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002577 case MBEDTLS_CIPHER_CAMELLIA_128_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002578 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002579 *key_type = PSA_KEY_TYPE_CAMELLIA;
2580 *key_size = 128;
2581 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002582#endif
2583#if defined(MBEDTLS_SSL_HAVE_CAMELLIA) && defined(MBEDTLS_SSL_HAVE_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002584 case MBEDTLS_CIPHER_CAMELLIA_128_GCM:
2585 *alg = PSA_ALG_GCM;
2586 *key_type = PSA_KEY_TYPE_CAMELLIA;
2587 *key_size = 128;
2588 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002589#endif
2590#if defined(MBEDTLS_SSL_HAVE_CAMELLIA) && defined(MBEDTLS_SSL_HAVE_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002591 case MBEDTLS_CIPHER_CAMELLIA_192_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002592 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002593 *key_type = PSA_KEY_TYPE_CAMELLIA;
2594 *key_size = 192;
2595 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002596#endif
2597#if defined(MBEDTLS_SSL_HAVE_CAMELLIA) && defined(MBEDTLS_SSL_HAVE_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002598 case MBEDTLS_CIPHER_CAMELLIA_192_GCM:
2599 *alg = PSA_ALG_GCM;
2600 *key_type = PSA_KEY_TYPE_CAMELLIA;
2601 *key_size = 192;
2602 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002603#endif
2604#if defined(MBEDTLS_SSL_HAVE_CAMELLIA) && defined(MBEDTLS_SSL_HAVE_CBC)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002605 case MBEDTLS_CIPHER_CAMELLIA_256_CBC:
2606 *alg = PSA_ALG_CBC_NO_PADDING;
2607 *key_type = PSA_KEY_TYPE_CAMELLIA;
2608 *key_size = 256;
2609 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002610#endif
2611#if defined(MBEDTLS_SSL_HAVE_CAMELLIA) && defined(MBEDTLS_SSL_HAVE_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002612 case MBEDTLS_CIPHER_CAMELLIA_256_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002613 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002614 *key_type = PSA_KEY_TYPE_CAMELLIA;
2615 *key_size = 256;
2616 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002617#endif
2618#if defined(MBEDTLS_SSL_HAVE_CAMELLIA) && defined(MBEDTLS_SSL_HAVE_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002619 case MBEDTLS_CIPHER_CAMELLIA_256_GCM:
2620 *alg = PSA_ALG_GCM;
2621 *key_type = PSA_KEY_TYPE_CAMELLIA;
2622 *key_size = 256;
2623 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002624#endif
2625#if defined(MBEDTLS_SSL_HAVE_CHACHAPOLY)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002626 case MBEDTLS_CIPHER_CHACHA20_POLY1305:
2627 *alg = PSA_ALG_CHACHA20_POLY1305;
2628 *key_type = PSA_KEY_TYPE_CHACHA20;
2629 *key_size = 256;
2630 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002631#endif
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002632 case MBEDTLS_CIPHER_NULL:
2633 *alg = MBEDTLS_SSL_NULL_CIPHER;
2634 *key_type = 0;
2635 *key_size = 0;
2636 break;
2637 default:
2638 return PSA_ERROR_NOT_SUPPORTED;
2639 }
2640
2641 return PSA_SUCCESS;
2642}
Neil Armstrong8395d7a2022-05-18 11:44:56 +02002643#endif /* MBEDTLS_USE_PSA_CRYPTO || MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002644
Manuel Pégourié-Gonnardcf141ca2015-05-20 10:35:51 +02002645#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002646int mbedtls_ssl_conf_dh_param_bin(mbedtls_ssl_config *conf,
2647 const unsigned char *dhm_P, size_t P_len,
2648 const unsigned char *dhm_G, size_t G_len)
Hanno Beckera90658f2017-10-04 15:29:08 +01002649{
Janos Follath865b3eb2019-12-16 11:46:15 +00002650 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Beckera90658f2017-10-04 15:29:08 +01002651
Gilles Peskine449bd832023-01-11 14:50:10 +01002652 mbedtls_mpi_free(&conf->dhm_P);
2653 mbedtls_mpi_free(&conf->dhm_G);
Glenn Strausscee11292021-12-20 01:43:17 -05002654
Gilles Peskine449bd832023-01-11 14:50:10 +01002655 if ((ret = mbedtls_mpi_read_binary(&conf->dhm_P, dhm_P, P_len)) != 0 ||
2656 (ret = mbedtls_mpi_read_binary(&conf->dhm_G, dhm_G, G_len)) != 0) {
2657 mbedtls_mpi_free(&conf->dhm_P);
2658 mbedtls_mpi_free(&conf->dhm_G);
2659 return ret;
Hanno Beckera90658f2017-10-04 15:29:08 +01002660 }
2661
Gilles Peskine449bd832023-01-11 14:50:10 +01002662 return 0;
Hanno Beckera90658f2017-10-04 15:29:08 +01002663}
Paul Bakker5121ce52009-01-03 21:22:43 +00002664
Gilles Peskine449bd832023-01-11 14:50:10 +01002665int mbedtls_ssl_conf_dh_param_ctx(mbedtls_ssl_config *conf, mbedtls_dhm_context *dhm_ctx)
Paul Bakker1b57b062011-01-06 15:48:19 +00002666{
Janos Follath865b3eb2019-12-16 11:46:15 +00002667 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker1b57b062011-01-06 15:48:19 +00002668
Gilles Peskine449bd832023-01-11 14:50:10 +01002669 mbedtls_mpi_free(&conf->dhm_P);
2670 mbedtls_mpi_free(&conf->dhm_G);
Glenn Strausscee11292021-12-20 01:43:17 -05002671
Gilles Peskine449bd832023-01-11 14:50:10 +01002672 if ((ret = mbedtls_dhm_get_value(dhm_ctx, MBEDTLS_DHM_PARAM_P,
2673 &conf->dhm_P)) != 0 ||
2674 (ret = mbedtls_dhm_get_value(dhm_ctx, MBEDTLS_DHM_PARAM_G,
2675 &conf->dhm_G)) != 0) {
2676 mbedtls_mpi_free(&conf->dhm_P);
2677 mbedtls_mpi_free(&conf->dhm_G);
2678 return ret;
Manuel Pégourié-Gonnard1028b742015-05-06 17:33:07 +01002679 }
Paul Bakker1b57b062011-01-06 15:48:19 +00002680
Gilles Peskine449bd832023-01-11 14:50:10 +01002681 return 0;
Paul Bakker1b57b062011-01-06 15:48:19 +00002682}
Manuel Pégourié-Gonnardcf141ca2015-05-20 10:35:51 +02002683#endif /* MBEDTLS_DHM_C && MBEDTLS_SSL_SRV_C */
Paul Bakker1b57b062011-01-06 15:48:19 +00002684
Manuel Pégourié-Gonnardbd990d62015-06-11 14:49:42 +02002685#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_CLI_C)
2686/*
2687 * Set the minimum length for Diffie-Hellman parameters
2688 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002689void mbedtls_ssl_conf_dhm_min_bitlen(mbedtls_ssl_config *conf,
2690 unsigned int bitlen)
Manuel Pégourié-Gonnardbd990d62015-06-11 14:49:42 +02002691{
2692 conf->dhm_min_bitlen = bitlen;
2693}
2694#endif /* MBEDTLS_DHM_C && MBEDTLS_SSL_CLI_C */
2695
Ronald Crone68ab4f2022-10-05 12:46:29 +02002696#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu7ddc38c2022-01-19 11:08:05 +08002697#if !defined(MBEDTLS_DEPRECATED_REMOVED) && defined(MBEDTLS_SSL_PROTO_TLS1_2)
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02002698/*
2699 * Set allowed/preferred hashes for handshake signatures
2700 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002701void mbedtls_ssl_conf_sig_hashes(mbedtls_ssl_config *conf,
2702 const int *hashes)
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02002703{
2704 conf->sig_hashes = hashes;
2705}
Jerry Yu7ddc38c2022-01-19 11:08:05 +08002706#endif /* !MBEDTLS_DEPRECATED_REMOVED && MBEDTLS_SSL_PROTO_TLS1_2 */
Hanno Becker1cd6e002021-08-10 13:27:10 +01002707
Jerry Yuf017ee42022-01-12 15:49:48 +08002708/* Configure allowed signature algorithms for handshake */
Gilles Peskine449bd832023-01-11 14:50:10 +01002709void mbedtls_ssl_conf_sig_algs(mbedtls_ssl_config *conf,
2710 const uint16_t *sig_algs)
Hanno Becker1cd6e002021-08-10 13:27:10 +01002711{
Jerry Yuf017ee42022-01-12 15:49:48 +08002712#if !defined(MBEDTLS_DEPRECATED_REMOVED)
2713 conf->sig_hashes = NULL;
2714#endif /* !MBEDTLS_DEPRECATED_REMOVED */
2715 conf->sig_algs = sig_algs;
Hanno Becker1cd6e002021-08-10 13:27:10 +01002716}
Ronald Crone68ab4f2022-10-05 12:46:29 +02002717#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02002718
Manuel Pégourié-Gonnardf07ce3b2023-09-22 11:53:41 +02002719#if defined(MBEDTLS_ECP_C)
Brett Warrene0edc842021-08-17 09:53:13 +01002720#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002721/*
2722 * Set the allowed elliptic curves
Brett Warrene0edc842021-08-17 09:53:13 +01002723 *
2724 * mbedtls_ssl_setup() takes the provided list
2725 * and translates it to a list of IANA TLS group identifiers,
2726 * stored in ssl->handshake->group_list.
2727 *
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002728 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002729void mbedtls_ssl_conf_curves(mbedtls_ssl_config *conf,
2730 const mbedtls_ecp_group_id *curve_list)
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002731{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002732 conf->curve_list = curve_list;
Brett Warrene0edc842021-08-17 09:53:13 +01002733 conf->group_list = NULL;
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002734}
Brett Warrene0edc842021-08-17 09:53:13 +01002735#endif /* MBEDTLS_DEPRECATED_REMOVED */
Manuel Pégourié-Gonnardf07ce3b2023-09-22 11:53:41 +02002736#endif /* MBEDTLS_ECP_C */
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002737
Brett Warrene0edc842021-08-17 09:53:13 +01002738/*
2739 * Set the allowed groups
2740 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002741void mbedtls_ssl_conf_groups(mbedtls_ssl_config *conf,
2742 const uint16_t *group_list)
Brett Warrene0edc842021-08-17 09:53:13 +01002743{
Manuel Pégourié-Gonnardf07ce3b2023-09-22 11:53:41 +02002744#if defined(MBEDTLS_ECP_C) && !defined(MBEDTLS_DEPRECATED_REMOVED)
Brett Warrene0edc842021-08-17 09:53:13 +01002745 conf->curve_list = NULL;
2746#endif
2747 conf->group_list = group_list;
2748}
2749
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01002750#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002751int mbedtls_ssl_set_hostname(mbedtls_ssl_context *ssl, const char *hostname)
Paul Bakker5121ce52009-01-03 21:22:43 +00002752{
Hanno Becker947194e2017-04-07 13:25:49 +01002753 /* Initialize to suppress unnecessary compiler warning */
2754 size_t hostname_len = 0;
2755
2756 /* Check if new hostname is valid before
2757 * making any change to current one */
Gilles Peskine449bd832023-01-11 14:50:10 +01002758 if (hostname != NULL) {
2759 hostname_len = strlen(hostname);
Hanno Becker947194e2017-04-07 13:25:49 +01002760
Gilles Peskine449bd832023-01-11 14:50:10 +01002761 if (hostname_len > MBEDTLS_SSL_MAX_HOST_NAME_LEN) {
2762 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2763 }
Hanno Becker947194e2017-04-07 13:25:49 +01002764 }
2765
2766 /* Now it's clear that we will overwrite the old hostname,
2767 * so we can free it safely */
2768
Gilles Peskine449bd832023-01-11 14:50:10 +01002769 if (ssl->hostname != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01002770 mbedtls_zeroize_and_free(ssl->hostname, strlen(ssl->hostname));
Hanno Becker947194e2017-04-07 13:25:49 +01002771 }
2772
2773 /* Passing NULL as hostname shall clear the old one */
Manuel Pégourié-Gonnardba26c242015-05-06 10:47:06 +01002774
Gilles Peskine449bd832023-01-11 14:50:10 +01002775 if (hostname == NULL) {
Hanno Becker947194e2017-04-07 13:25:49 +01002776 ssl->hostname = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01002777 } else {
2778 ssl->hostname = mbedtls_calloc(1, hostname_len + 1);
2779 if (ssl->hostname == NULL) {
2780 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
2781 }
Paul Bakker75c1a6f2013-08-19 14:25:29 +02002782
Gilles Peskine449bd832023-01-11 14:50:10 +01002783 memcpy(ssl->hostname, hostname, hostname_len);
Paul Bakker75c1a6f2013-08-19 14:25:29 +02002784
Hanno Becker947194e2017-04-07 13:25:49 +01002785 ssl->hostname[hostname_len] = '\0';
2786 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002787
Gilles Peskine449bd832023-01-11 14:50:10 +01002788 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00002789}
Hanno Becker1a9a51c2017-04-07 13:02:16 +01002790#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00002791
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01002792#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01002793void mbedtls_ssl_conf_sni(mbedtls_ssl_config *conf,
2794 int (*f_sni)(void *, mbedtls_ssl_context *,
2795 const unsigned char *, size_t),
2796 void *p_sni)
Paul Bakker5701cdc2012-09-27 21:49:42 +00002797{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002798 conf->f_sni = f_sni;
2799 conf->p_sni = p_sni;
Paul Bakker5701cdc2012-09-27 21:49:42 +00002800}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002801#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
Paul Bakker5701cdc2012-09-27 21:49:42 +00002802
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002803#if defined(MBEDTLS_SSL_ALPN)
Gilles Peskine449bd832023-01-11 14:50:10 +01002804int mbedtls_ssl_conf_alpn_protocols(mbedtls_ssl_config *conf, const char **protos)
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002805{
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002806 size_t cur_len, tot_len;
2807 const char **p;
2808
2809 /*
Brian J Murray1903fb32016-11-06 04:45:15 -08002810 * RFC 7301 3.1: "Empty strings MUST NOT be included and byte strings
2811 * MUST NOT be truncated."
2812 * We check lengths now rather than later.
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002813 */
2814 tot_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01002815 for (p = protos; *p != NULL; p++) {
2816 cur_len = strlen(*p);
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002817 tot_len += cur_len;
2818
Gilles Peskine449bd832023-01-11 14:50:10 +01002819 if ((cur_len == 0) ||
2820 (cur_len > MBEDTLS_SSL_MAX_ALPN_NAME_LEN) ||
2821 (tot_len > MBEDTLS_SSL_MAX_ALPN_LIST_LEN)) {
2822 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2823 }
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002824 }
2825
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002826 conf->alpn_list = protos;
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002827
Gilles Peskine449bd832023-01-11 14:50:10 +01002828 return 0;
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002829}
2830
Gilles Peskine449bd832023-01-11 14:50:10 +01002831const char *mbedtls_ssl_get_alpn_protocol(const mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002832{
Gilles Peskine449bd832023-01-11 14:50:10 +01002833 return ssl->alpn_chosen;
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002834}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002835#endif /* MBEDTLS_SSL_ALPN */
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002836
Johan Pascalb62bb512015-12-03 21:56:45 +01002837#if defined(MBEDTLS_SSL_DTLS_SRTP)
Gilles Peskine449bd832023-01-11 14:50:10 +01002838void mbedtls_ssl_conf_srtp_mki_value_supported(mbedtls_ssl_config *conf,
2839 int support_mki_value)
Ron Eldor591f1622018-01-22 12:30:04 +02002840{
2841 conf->dtls_srtp_mki_support = support_mki_value;
2842}
2843
Gilles Peskine449bd832023-01-11 14:50:10 +01002844int mbedtls_ssl_dtls_srtp_set_mki_value(mbedtls_ssl_context *ssl,
2845 unsigned char *mki_value,
2846 uint16_t mki_len)
Ron Eldor591f1622018-01-22 12:30:04 +02002847{
Gilles Peskine449bd832023-01-11 14:50:10 +01002848 if (mki_len > MBEDTLS_TLS_SRTP_MAX_MKI_LENGTH) {
2849 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Ron Eldora9788042018-12-05 11:04:31 +02002850 }
Ron Eldor591f1622018-01-22 12:30:04 +02002851
Gilles Peskine449bd832023-01-11 14:50:10 +01002852 if (ssl->conf->dtls_srtp_mki_support == MBEDTLS_SSL_DTLS_SRTP_MKI_UNSUPPORTED) {
2853 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Ron Eldora9788042018-12-05 11:04:31 +02002854 }
Ron Eldor591f1622018-01-22 12:30:04 +02002855
Gilles Peskine449bd832023-01-11 14:50:10 +01002856 memcpy(ssl->dtls_srtp_info.mki_value, mki_value, mki_len);
Ron Eldor591f1622018-01-22 12:30:04 +02002857 ssl->dtls_srtp_info.mki_len = mki_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01002858 return 0;
Ron Eldor591f1622018-01-22 12:30:04 +02002859}
2860
Gilles Peskine449bd832023-01-11 14:50:10 +01002861int mbedtls_ssl_conf_dtls_srtp_protection_profiles(mbedtls_ssl_config *conf,
2862 const mbedtls_ssl_srtp_profile *profiles)
Johan Pascalb62bb512015-12-03 21:56:45 +01002863{
Johan Pascal253d0262020-09-22 13:04:45 +02002864 const mbedtls_ssl_srtp_profile *p;
2865 size_t list_size = 0;
Johan Pascalb62bb512015-12-03 21:56:45 +01002866
Johan Pascal253d0262020-09-22 13:04:45 +02002867 /* check the profiles list: all entry must be valid,
2868 * its size cannot be more than the total number of supported profiles, currently 4 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002869 for (p = profiles; *p != MBEDTLS_TLS_SRTP_UNSET &&
2870 list_size <= MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH;
2871 p++) {
2872 if (mbedtls_ssl_check_srtp_profile_value(*p) != MBEDTLS_TLS_SRTP_UNSET) {
Johan Pascal76fdf1d2020-10-22 23:31:00 +02002873 list_size++;
Gilles Peskine449bd832023-01-11 14:50:10 +01002874 } else {
Johan Pascal76fdf1d2020-10-22 23:31:00 +02002875 /* unsupported value, stop parsing and set the size to an error value */
2876 list_size = MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH + 1;
Johan Pascalb62bb512015-12-03 21:56:45 +01002877 }
2878 }
2879
Gilles Peskine449bd832023-01-11 14:50:10 +01002880 if (list_size > MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH) {
2881 conf->dtls_srtp_profile_list = NULL;
2882 conf->dtls_srtp_profile_list_len = 0;
2883 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Johan Pascal253d0262020-09-22 13:04:45 +02002884 }
2885
Johan Pascal9bc97ca2020-09-21 23:44:45 +02002886 conf->dtls_srtp_profile_list = profiles;
Johan Pascal253d0262020-09-22 13:04:45 +02002887 conf->dtls_srtp_profile_list_len = list_size;
Johan Pascalb62bb512015-12-03 21:56:45 +01002888
Gilles Peskine449bd832023-01-11 14:50:10 +01002889 return 0;
Johan Pascalb62bb512015-12-03 21:56:45 +01002890}
2891
Gilles Peskine449bd832023-01-11 14:50:10 +01002892void mbedtls_ssl_get_dtls_srtp_negotiation_result(const mbedtls_ssl_context *ssl,
2893 mbedtls_dtls_srtp_info *dtls_srtp_info)
Johan Pascalb62bb512015-12-03 21:56:45 +01002894{
Johan Pascal2258a4f2020-10-28 13:53:09 +01002895 dtls_srtp_info->chosen_dtls_srtp_profile = ssl->dtls_srtp_info.chosen_dtls_srtp_profile;
2896 /* do not copy the mki value if there is no chosen profile */
Gilles Peskine449bd832023-01-11 14:50:10 +01002897 if (dtls_srtp_info->chosen_dtls_srtp_profile == MBEDTLS_TLS_SRTP_UNSET) {
Johan Pascal2258a4f2020-10-28 13:53:09 +01002898 dtls_srtp_info->mki_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01002899 } else {
Johan Pascal2258a4f2020-10-28 13:53:09 +01002900 dtls_srtp_info->mki_len = ssl->dtls_srtp_info.mki_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01002901 memcpy(dtls_srtp_info->mki_value, ssl->dtls_srtp_info.mki_value,
2902 ssl->dtls_srtp_info.mki_len);
Johan Pascal2258a4f2020-10-28 13:53:09 +01002903 }
Johan Pascalb62bb512015-12-03 21:56:45 +01002904}
Johan Pascalb62bb512015-12-03 21:56:45 +01002905#endif /* MBEDTLS_SSL_DTLS_SRTP */
2906
Aditya Patwardhan3096f332022-07-26 14:31:46 +05302907#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Gilles Peskine449bd832023-01-11 14:50:10 +01002908void mbedtls_ssl_conf_max_version(mbedtls_ssl_config *conf, int major, int minor)
Paul Bakker490ecc82011-10-06 13:04:09 +00002909{
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01002910 conf->max_tls_version = (mbedtls_ssl_protocol_version) ((major << 8) | minor);
Paul Bakker490ecc82011-10-06 13:04:09 +00002911}
2912
Gilles Peskine449bd832023-01-11 14:50:10 +01002913void mbedtls_ssl_conf_min_version(mbedtls_ssl_config *conf, int major, int minor)
Paul Bakker1d29fb52012-09-28 13:28:45 +00002914{
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01002915 conf->min_tls_version = (mbedtls_ssl_protocol_version) ((major << 8) | minor);
Paul Bakker1d29fb52012-09-28 13:28:45 +00002916}
Aditya Patwardhan3096f332022-07-26 14:31:46 +05302917#endif /* MBEDTLS_DEPRECATED_REMOVED */
Paul Bakker1d29fb52012-09-28 13:28:45 +00002918
Janos Follath088ce432017-04-10 12:42:31 +01002919#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002920void mbedtls_ssl_conf_cert_req_ca_list(mbedtls_ssl_config *conf,
2921 char cert_req_ca_list)
Janos Follath088ce432017-04-10 12:42:31 +01002922{
2923 conf->cert_req_ca_list = cert_req_ca_list;
2924}
2925#endif
2926
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002927#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01002928void mbedtls_ssl_conf_encrypt_then_mac(mbedtls_ssl_config *conf, char etm)
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01002929{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002930 conf->encrypt_then_mac = etm;
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01002931}
2932#endif
2933
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002934#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
Gilles Peskine449bd832023-01-11 14:50:10 +01002935void mbedtls_ssl_conf_extended_master_secret(mbedtls_ssl_config *conf, char ems)
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02002936{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002937 conf->extended_ms = ems;
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02002938}
2939#endif
2940
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002941#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01002942int mbedtls_ssl_conf_max_frag_len(mbedtls_ssl_config *conf, unsigned char mfl_code)
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002943{
Gilles Peskine449bd832023-01-11 14:50:10 +01002944 if (mfl_code >= MBEDTLS_SSL_MAX_FRAG_LEN_INVALID ||
2945 ssl_mfl_code_to_length(mfl_code) > MBEDTLS_TLS_EXT_ADV_CONTENT_LEN) {
2946 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002947 }
2948
Manuel Pégourié-Gonnard6bf89d62015-05-05 17:01:57 +01002949 conf->mfl_code = mfl_code;
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002950
Gilles Peskine449bd832023-01-11 14:50:10 +01002951 return 0;
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002952}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002953#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002954
Gilles Peskine449bd832023-01-11 14:50:10 +01002955void mbedtls_ssl_conf_legacy_renegotiation(mbedtls_ssl_config *conf, int allow_legacy)
Paul Bakker48916f92012-09-16 19:57:18 +00002956{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002957 conf->allow_legacy_renegotiation = allow_legacy;
Paul Bakker48916f92012-09-16 19:57:18 +00002958}
2959
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002960#if defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01002961void mbedtls_ssl_conf_renegotiation(mbedtls_ssl_config *conf, int renegotiation)
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01002962{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002963 conf->disable_renegotiation = renegotiation;
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01002964}
2965
Gilles Peskine449bd832023-01-11 14:50:10 +01002966void mbedtls_ssl_conf_renegotiation_enforced(mbedtls_ssl_config *conf, int max_records)
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02002967{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002968 conf->renego_max_records = max_records;
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02002969}
2970
Gilles Peskine449bd832023-01-11 14:50:10 +01002971void mbedtls_ssl_conf_renegotiation_period(mbedtls_ssl_config *conf,
2972 const unsigned char period[8])
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01002973{
Gilles Peskine449bd832023-01-11 14:50:10 +01002974 memcpy(conf->renego_period, period, 8);
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01002975}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002976#endif /* MBEDTLS_SSL_RENEGOTIATION */
Paul Bakker5121ce52009-01-03 21:22:43 +00002977
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002978#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02002979#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002980void mbedtls_ssl_conf_session_tickets(mbedtls_ssl_config *conf, int use_tickets)
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02002981{
Manuel Pégourié-Gonnard2b494452015-05-06 10:05:11 +01002982 conf->session_tickets = use_tickets;
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02002983}
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02002984#endif
Paul Bakker606b4ba2013-08-14 16:52:14 +02002985
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02002986#if defined(MBEDTLS_SSL_SRV_C)
Jerry Yu1ad7ace2022-08-09 13:28:39 +08002987
Jerry Yud0766ec2022-09-22 10:46:57 +08002988#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Gilles Peskine449bd832023-01-11 14:50:10 +01002989void mbedtls_ssl_conf_new_session_tickets(mbedtls_ssl_config *conf,
2990 uint16_t num_tickets)
Jerry Yu1ad7ace2022-08-09 13:28:39 +08002991{
Jerry Yud0766ec2022-09-22 10:46:57 +08002992 conf->new_session_tickets_count = num_tickets;
Jerry Yu1ad7ace2022-08-09 13:28:39 +08002993}
2994#endif
2995
Gilles Peskine449bd832023-01-11 14:50:10 +01002996void mbedtls_ssl_conf_session_tickets_cb(mbedtls_ssl_config *conf,
2997 mbedtls_ssl_ticket_write_t *f_ticket_write,
2998 mbedtls_ssl_ticket_parse_t *f_ticket_parse,
2999 void *p_ticket)
Paul Bakker606b4ba2013-08-14 16:52:14 +02003000{
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02003001 conf->f_ticket_write = f_ticket_write;
3002 conf->f_ticket_parse = f_ticket_parse;
3003 conf->p_ticket = p_ticket;
Paul Bakker606b4ba2013-08-14 16:52:14 +02003004}
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02003005#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003006#endif /* MBEDTLS_SSL_SESSION_TICKETS */
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02003007
Gilles Peskine449bd832023-01-11 14:50:10 +01003008void mbedtls_ssl_set_export_keys_cb(mbedtls_ssl_context *ssl,
3009 mbedtls_ssl_export_keys_t *f_export_keys,
3010 void *p_export_keys)
Robert Cragie4feb7ae2015-10-02 13:33:37 +01003011{
Hanno Becker7e6c1782021-06-08 09:24:55 +01003012 ssl->f_export_keys = f_export_keys;
3013 ssl->p_export_keys = p_export_keys;
Ron Eldorf5cc10d2019-05-07 18:33:40 +03003014}
Robert Cragie4feb7ae2015-10-02 13:33:37 +01003015
Gilles Peskineb74a1c72018-04-24 13:09:22 +02003016#if defined(MBEDTLS_SSL_ASYNC_PRIVATE)
Gilles Peskine8bf79f62018-01-05 21:11:53 +01003017void mbedtls_ssl_conf_async_private_cb(
3018 mbedtls_ssl_config *conf,
3019 mbedtls_ssl_async_sign_t *f_async_sign,
3020 mbedtls_ssl_async_decrypt_t *f_async_decrypt,
3021 mbedtls_ssl_async_resume_t *f_async_resume,
3022 mbedtls_ssl_async_cancel_t *f_async_cancel,
Gilles Peskine449bd832023-01-11 14:50:10 +01003023 void *async_config_data)
Gilles Peskine8bf79f62018-01-05 21:11:53 +01003024{
3025 conf->f_async_sign_start = f_async_sign;
3026 conf->f_async_decrypt_start = f_async_decrypt;
3027 conf->f_async_resume = f_async_resume;
3028 conf->f_async_cancel = f_async_cancel;
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003029 conf->p_async_config_data = async_config_data;
3030}
3031
Gilles Peskine449bd832023-01-11 14:50:10 +01003032void *mbedtls_ssl_conf_get_async_config_data(const mbedtls_ssl_config *conf)
Gilles Peskine8f97af72018-04-26 11:46:10 +02003033{
Gilles Peskine449bd832023-01-11 14:50:10 +01003034 return conf->p_async_config_data;
Gilles Peskine8f97af72018-04-26 11:46:10 +02003035}
3036
Gilles Peskine449bd832023-01-11 14:50:10 +01003037void *mbedtls_ssl_get_async_operation_data(const mbedtls_ssl_context *ssl)
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003038{
Gilles Peskine449bd832023-01-11 14:50:10 +01003039 if (ssl->handshake == NULL) {
3040 return NULL;
3041 } else {
3042 return ssl->handshake->user_async_ctx;
3043 }
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003044}
3045
Gilles Peskine449bd832023-01-11 14:50:10 +01003046void mbedtls_ssl_set_async_operation_data(mbedtls_ssl_context *ssl,
3047 void *ctx)
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003048{
Gilles Peskine449bd832023-01-11 14:50:10 +01003049 if (ssl->handshake != NULL) {
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003050 ssl->handshake->user_async_ctx = ctx;
Gilles Peskine449bd832023-01-11 14:50:10 +01003051 }
Gilles Peskine8bf79f62018-01-05 21:11:53 +01003052}
Gilles Peskineb74a1c72018-04-24 13:09:22 +02003053#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
Gilles Peskine8bf79f62018-01-05 21:11:53 +01003054
Paul Bakker5121ce52009-01-03 21:22:43 +00003055/*
3056 * SSL get accessors
3057 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003058uint32_t mbedtls_ssl_get_verify_result(const mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00003059{
Gilles Peskine449bd832023-01-11 14:50:10 +01003060 if (ssl->session != NULL) {
3061 return ssl->session->verify_result;
3062 }
Manuel Pégourié-Gonnarde89163c2015-01-23 14:30:57 +00003063
Gilles Peskine449bd832023-01-11 14:50:10 +01003064 if (ssl->session_negotiate != NULL) {
3065 return ssl->session_negotiate->verify_result;
3066 }
Manuel Pégourié-Gonnarde89163c2015-01-23 14:30:57 +00003067
Gilles Peskine449bd832023-01-11 14:50:10 +01003068 return 0xFFFFFFFF;
Paul Bakker5121ce52009-01-03 21:22:43 +00003069}
3070
Gilles Peskine449bd832023-01-11 14:50:10 +01003071int mbedtls_ssl_get_ciphersuite_id_from_ssl(const mbedtls_ssl_context *ssl)
Glenn Strauss8f526902022-01-13 00:04:49 -05003072{
Gilles Peskine449bd832023-01-11 14:50:10 +01003073 if (ssl == NULL || ssl->session == NULL) {
3074 return 0;
3075 }
Glenn Strauss8f526902022-01-13 00:04:49 -05003076
Gilles Peskine449bd832023-01-11 14:50:10 +01003077 return ssl->session->ciphersuite;
Glenn Strauss8f526902022-01-13 00:04:49 -05003078}
3079
Gilles Peskine449bd832023-01-11 14:50:10 +01003080const char *mbedtls_ssl_get_ciphersuite(const mbedtls_ssl_context *ssl)
Paul Bakker72f62662011-01-16 21:27:44 +00003081{
Gilles Peskine449bd832023-01-11 14:50:10 +01003082 if (ssl == NULL || ssl->session == NULL) {
3083 return NULL;
3084 }
Paul Bakker926c8e42013-03-06 10:23:34 +01003085
Gilles Peskine449bd832023-01-11 14:50:10 +01003086 return mbedtls_ssl_get_ciphersuite_name(ssl->session->ciphersuite);
Paul Bakker72f62662011-01-16 21:27:44 +00003087}
3088
Gilles Peskine449bd832023-01-11 14:50:10 +01003089const char *mbedtls_ssl_get_version(const mbedtls_ssl_context *ssl)
Paul Bakker43ca69c2011-01-15 17:35:19 +00003090{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003091#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003092 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
3093 switch (ssl->tls_version) {
Glenn Strauss60bfe602022-03-14 19:04:24 -04003094 case MBEDTLS_SSL_VERSION_TLS1_2:
Gilles Peskine449bd832023-01-11 14:50:10 +01003095 return "DTLSv1.2";
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01003096 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01003097 return "unknown (DTLS)";
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01003098 }
3099 }
3100#endif
3101
Gilles Peskine449bd832023-01-11 14:50:10 +01003102 switch (ssl->tls_version) {
Glenn Strauss60bfe602022-03-14 19:04:24 -04003103 case MBEDTLS_SSL_VERSION_TLS1_2:
Gilles Peskine449bd832023-01-11 14:50:10 +01003104 return "TLSv1.2";
Glenn Strauss60bfe602022-03-14 19:04:24 -04003105 case MBEDTLS_SSL_VERSION_TLS1_3:
Gilles Peskine449bd832023-01-11 14:50:10 +01003106 return "TLSv1.3";
Paul Bakker43ca69c2011-01-15 17:35:19 +00003107 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01003108 return "unknown";
Paul Bakker43ca69c2011-01-15 17:35:19 +00003109 }
Paul Bakker43ca69c2011-01-15 17:35:19 +00003110}
3111
Waleed Elmelegy6a971fd2023-12-28 17:48:16 +00003112#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
3113
3114size_t mbedtls_ssl_get_output_record_size_limit(const mbedtls_ssl_context *ssl)
3115{
3116 const size_t max_len = MBEDTLS_SSL_OUT_CONTENT_LEN;
3117 size_t record_size_limit = max_len;
3118
3119 if (ssl->session != NULL &&
3120 ssl->session->record_size_limit >= MBEDTLS_SSL_RECORD_SIZE_LIMIT_MIN &&
3121 ssl->session->record_size_limit < max_len) {
3122 record_size_limit = ssl->session->record_size_limit;
3123 }
3124
3125 // TODO: this is currently untested
3126 /* During a handshake, use the value being negotiated */
3127 if (ssl->session_negotiate != NULL &&
3128 ssl->session_negotiate->record_size_limit >= MBEDTLS_SSL_RECORD_SIZE_LIMIT_MIN &&
3129 ssl->session_negotiate->record_size_limit < max_len) {
3130 record_size_limit = ssl->session_negotiate->record_size_limit;
3131 }
3132
3133 return record_size_limit;
3134}
3135#endif /* MBEDTLS_SSL_RECORD_SIZE_LIMIT */
3136
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02003137#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01003138size_t mbedtls_ssl_get_input_max_frag_len(const mbedtls_ssl_context *ssl)
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003139{
David Horstmann95d516f2021-05-04 18:36:56 +01003140 size_t max_len = MBEDTLS_SSL_IN_CONTENT_LEN;
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003141 size_t read_mfl;
3142
Jerry Yuddda0502022-12-01 19:43:12 +08003143#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003144 /* Use the configured MFL for the client if we're past SERVER_HELLO_DONE */
Gilles Peskine449bd832023-01-11 14:50:10 +01003145 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
3146 ssl->state >= MBEDTLS_SSL_SERVER_HELLO_DONE) {
3147 return ssl_mfl_code_to_length(ssl->conf->mfl_code);
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003148 }
Jerry Yuddda0502022-12-01 19:43:12 +08003149#endif
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003150
3151 /* Check if a smaller max length was negotiated */
Gilles Peskine449bd832023-01-11 14:50:10 +01003152 if (ssl->session_out != NULL) {
3153 read_mfl = ssl_mfl_code_to_length(ssl->session_out->mfl_code);
3154 if (read_mfl < max_len) {
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003155 max_len = read_mfl;
3156 }
3157 }
3158
Jerry Yuddda0502022-12-01 19:43:12 +08003159 /* During a handshake, use the value being negotiated */
Gilles Peskine449bd832023-01-11 14:50:10 +01003160 if (ssl->session_negotiate != NULL) {
3161 read_mfl = ssl_mfl_code_to_length(ssl->session_negotiate->mfl_code);
3162 if (read_mfl < max_len) {
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003163 max_len = read_mfl;
3164 }
3165 }
3166
Gilles Peskine449bd832023-01-11 14:50:10 +01003167 return max_len;
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003168}
3169
Gilles Peskine449bd832023-01-11 14:50:10 +01003170size_t mbedtls_ssl_get_output_max_frag_len(const mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02003171{
3172 size_t max_len;
3173
3174 /*
3175 * Assume mfl_code is correct since it was checked when set
3176 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003177 max_len = ssl_mfl_code_to_length(ssl->conf->mfl_code);
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02003178
Manuel Pégourié-Gonnard2cb17e22017-09-19 13:00:47 +02003179 /* Check if a smaller max length was negotiated */
Gilles Peskine449bd832023-01-11 14:50:10 +01003180 if (ssl->session_out != NULL &&
3181 ssl_mfl_code_to_length(ssl->session_out->mfl_code) < max_len) {
3182 max_len = ssl_mfl_code_to_length(ssl->session_out->mfl_code);
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02003183 }
3184
Manuel Pégourié-Gonnard2cb17e22017-09-19 13:00:47 +02003185 /* During a handshake, use the value being negotiated */
Gilles Peskine449bd832023-01-11 14:50:10 +01003186 if (ssl->session_negotiate != NULL &&
3187 ssl_mfl_code_to_length(ssl->session_negotiate->mfl_code) < max_len) {
3188 max_len = ssl_mfl_code_to_length(ssl->session_negotiate->mfl_code);
Manuel Pégourié-Gonnard2cb17e22017-09-19 13:00:47 +02003189 }
3190
Gilles Peskine449bd832023-01-11 14:50:10 +01003191 return max_len;
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02003192}
3193#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
3194
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003195#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003196size_t mbedtls_ssl_get_current_mtu(const mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003197{
Andrzej Kurekef43ce62018-10-09 08:24:12 -04003198 /* Return unlimited mtu for client hello messages to avoid fragmentation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01003199 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
3200 (ssl->state == MBEDTLS_SSL_CLIENT_HELLO ||
3201 ssl->state == MBEDTLS_SSL_SERVER_HELLO)) {
3202 return 0;
3203 }
Andrzej Kurekef43ce62018-10-09 08:24:12 -04003204
Gilles Peskine449bd832023-01-11 14:50:10 +01003205 if (ssl->handshake == NULL || ssl->handshake->mtu == 0) {
3206 return ssl->mtu;
3207 }
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003208
Gilles Peskine449bd832023-01-11 14:50:10 +01003209 if (ssl->mtu == 0) {
3210 return ssl->handshake->mtu;
3211 }
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003212
Gilles Peskine449bd832023-01-11 14:50:10 +01003213 return ssl->mtu < ssl->handshake->mtu ?
3214 ssl->mtu : ssl->handshake->mtu;
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003215}
3216#endif /* MBEDTLS_SSL_PROTO_DTLS */
3217
Gilles Peskine449bd832023-01-11 14:50:10 +01003218int mbedtls_ssl_get_max_out_record_payload(const mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003219{
3220 size_t max_len = MBEDTLS_SSL_OUT_CONTENT_LEN;
3221
Manuel Pégourié-Gonnard000281e2018-08-21 11:20:58 +02003222#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH) && \
Jan Brucknerf482dcc2023-03-15 09:09:06 +01003223 !defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT) && \
Manuel Pégourié-Gonnard000281e2018-08-21 11:20:58 +02003224 !defined(MBEDTLS_SSL_PROTO_DTLS)
3225 (void) ssl;
3226#endif
3227
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003228#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01003229 const size_t mfl = mbedtls_ssl_get_output_max_frag_len(ssl);
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003230
Gilles Peskine449bd832023-01-11 14:50:10 +01003231 if (max_len > mfl) {
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003232 max_len = mfl;
Gilles Peskine449bd832023-01-11 14:50:10 +01003233 }
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003234#endif
3235
Jan Brucknerf482dcc2023-03-15 09:09:06 +01003236#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
3237 const size_t record_size_limit = mbedtls_ssl_get_output_record_size_limit(ssl);
3238
3239 if (max_len > record_size_limit) {
3240 max_len = record_size_limit;
3241 }
3242#endif
3243
Waleed Elmelegy6a971fd2023-12-28 17:48:16 +00003244 if (ssl->transform_out != NULL &&
3245 ssl->transform_out->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Waleed Elmelegyf5017902024-01-09 14:18:34 +00003246 /*
3247 * In TLS 1.3 case, when records are protected, `max_len` as computed
3248 * above is the maximum length of the TLSInnerPlaintext structure that
3249 * along the plaintext payload contains the inner content type (one byte)
3250 * and some zero padding. Given the algorithm used for padding
3251 * in mbedtls_ssl_encrypt_buf(), compute the maximum length for
3252 * the plaintext payload. Round down to a multiple of
3253 * MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY and
3254 * subtract 1.
Waleed Elmelegy6a971fd2023-12-28 17:48:16 +00003255 */
3256 max_len = ((max_len / MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY) *
3257 MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY) - 1;
3258 }
3259
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003260#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003261 if (mbedtls_ssl_get_current_mtu(ssl) != 0) {
3262 const size_t mtu = mbedtls_ssl_get_current_mtu(ssl);
3263 const int ret = mbedtls_ssl_get_record_expansion(ssl);
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003264 const size_t overhead = (size_t) ret;
3265
Gilles Peskine449bd832023-01-11 14:50:10 +01003266 if (ret < 0) {
3267 return ret;
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003268 }
3269
Gilles Peskine449bd832023-01-11 14:50:10 +01003270 if (mtu <= overhead) {
3271 MBEDTLS_SSL_DEBUG_MSG(1, ("MTU too low for record expansion"));
3272 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
3273 }
3274
3275 if (max_len > mtu - overhead) {
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003276 max_len = mtu - overhead;
Gilles Peskine449bd832023-01-11 14:50:10 +01003277 }
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003278 }
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003279#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003280
Hanno Becker0defedb2018-08-10 12:35:02 +01003281#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH) && \
Waleed Elmelegy049cd302023-12-20 17:28:31 +00003282 !defined(MBEDTLS_SSL_PROTO_DTLS) && \
3283 !defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
Hanno Becker0defedb2018-08-10 12:35:02 +01003284 ((void) ssl);
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003285#endif
3286
Gilles Peskine449bd832023-01-11 14:50:10 +01003287 return (int) max_len;
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003288}
3289
Gilles Peskine449bd832023-01-11 14:50:10 +01003290int mbedtls_ssl_get_max_in_record_payload(const mbedtls_ssl_context *ssl)
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003291{
3292 size_t max_len = MBEDTLS_SSL_IN_CONTENT_LEN;
3293
3294#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
3295 (void) ssl;
3296#endif
3297
3298#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01003299 const size_t mfl = mbedtls_ssl_get_input_max_frag_len(ssl);
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003300
Gilles Peskine449bd832023-01-11 14:50:10 +01003301 if (max_len > mfl) {
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003302 max_len = mfl;
Gilles Peskine449bd832023-01-11 14:50:10 +01003303 }
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003304#endif
3305
Gilles Peskine449bd832023-01-11 14:50:10 +01003306 return (int) max_len;
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003307}
3308
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003309#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01003310const mbedtls_x509_crt *mbedtls_ssl_get_peer_cert(const mbedtls_ssl_context *ssl)
Paul Bakkerb0550d92012-10-30 07:51:03 +00003311{
Gilles Peskine449bd832023-01-11 14:50:10 +01003312 if (ssl == NULL || ssl->session == NULL) {
3313 return NULL;
3314 }
Paul Bakkerb0550d92012-10-30 07:51:03 +00003315
Hanno Beckere6824572019-02-07 13:18:46 +00003316#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01003317 return ssl->session->peer_cert;
Hanno Beckere6824572019-02-07 13:18:46 +00003318#else
Gilles Peskine449bd832023-01-11 14:50:10 +01003319 return NULL;
Hanno Beckere6824572019-02-07 13:18:46 +00003320#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Paul Bakkerb0550d92012-10-30 07:51:03 +00003321}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003322#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkerb0550d92012-10-30 07:51:03 +00003323
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003324#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01003325int mbedtls_ssl_get_session(const mbedtls_ssl_context *ssl,
3326 mbedtls_ssl_session *dst)
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003327{
Hanno Beckere810bbc2021-05-14 16:01:05 +01003328 int ret;
3329
Gilles Peskine449bd832023-01-11 14:50:10 +01003330 if (ssl == NULL ||
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003331 dst == NULL ||
3332 ssl->session == NULL ||
Gilles Peskine449bd832023-01-11 14:50:10 +01003333 ssl->conf->endpoint != MBEDTLS_SSL_IS_CLIENT) {
3334 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003335 }
3336
Hanno Beckere810bbc2021-05-14 16:01:05 +01003337 /* Since Mbed TLS 3.0, mbedtls_ssl_get_session() is no longer
3338 * idempotent: Each session can only be exported once.
3339 *
3340 * (This is in preparation for TLS 1.3 support where we will
3341 * need the ability to export multiple sessions (aka tickets),
3342 * which will be achieved by calling mbedtls_ssl_get_session()
3343 * multiple times until it fails.)
3344 *
3345 * Check whether we have already exported the current session,
3346 * and fail if so.
3347 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003348 if (ssl->session->exported == 1) {
3349 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
3350 }
Hanno Beckere810bbc2021-05-14 16:01:05 +01003351
Gilles Peskine449bd832023-01-11 14:50:10 +01003352 ret = mbedtls_ssl_session_copy(dst, ssl->session);
3353 if (ret != 0) {
3354 return ret;
3355 }
Hanno Beckere810bbc2021-05-14 16:01:05 +01003356
3357 /* Remember that we've exported the session. */
3358 ssl->session->exported = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01003359 return 0;
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003360}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003361#endif /* MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003362
David Horstmanncb01b362024-02-29 17:31:46 +00003363#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
3364
3365/* Serialization of TLS 1.2 sessions
David Horstmanne59f9702024-02-29 16:08:57 +00003366 *
David Horstmanncb01b362024-02-29 17:31:46 +00003367 * For more detail, see the description of ssl_session_save().
David Horstmanne59f9702024-02-29 16:08:57 +00003368 */
3369static size_t ssl_tls12_session_save(const mbedtls_ssl_session *session,
3370 unsigned char *buf,
3371 size_t buf_len)
3372{
3373 unsigned char *p = buf;
3374 size_t used = 0;
3375
3376#if defined(MBEDTLS_HAVE_TIME)
3377 uint64_t start;
3378#endif
3379#if defined(MBEDTLS_X509_CRT_PARSE_C)
3380#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
3381 size_t cert_len;
3382#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3383#endif /* MBEDTLS_X509_CRT_PARSE_C */
3384
3385 /*
3386 * Time
3387 */
3388#if defined(MBEDTLS_HAVE_TIME)
3389 used += 8;
3390
3391 if (used <= buf_len) {
3392 start = (uint64_t) session->start;
3393
3394 MBEDTLS_PUT_UINT64_BE(start, p, 0);
3395 p += 8;
3396 }
3397#endif /* MBEDTLS_HAVE_TIME */
3398
3399 /*
3400 * Basic mandatory fields
3401 */
3402 used += 1 /* id_len */
3403 + sizeof(session->id)
3404 + sizeof(session->master)
3405 + 4; /* verify_result */
3406
3407 if (used <= buf_len) {
3408 *p++ = MBEDTLS_BYTE_0(session->id_len);
3409 memcpy(p, session->id, 32);
3410 p += 32;
3411
3412 memcpy(p, session->master, 48);
3413 p += 48;
3414
3415 MBEDTLS_PUT_UINT32_BE(session->verify_result, p, 0);
3416 p += 4;
3417 }
3418
3419 /*
3420 * Peer's end-entity certificate
3421 */
3422#if defined(MBEDTLS_X509_CRT_PARSE_C)
3423#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
3424 if (session->peer_cert == NULL) {
3425 cert_len = 0;
3426 } else {
3427 cert_len = session->peer_cert->raw.len;
3428 }
3429
3430 used += 3 + cert_len;
3431
3432 if (used <= buf_len) {
3433 *p++ = MBEDTLS_BYTE_2(cert_len);
3434 *p++ = MBEDTLS_BYTE_1(cert_len);
3435 *p++ = MBEDTLS_BYTE_0(cert_len);
3436
3437 if (session->peer_cert != NULL) {
3438 memcpy(p, session->peer_cert->raw.p, cert_len);
3439 p += cert_len;
3440 }
3441 }
3442#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3443 if (session->peer_cert_digest != NULL) {
3444 used += 1 /* type */ + 1 /* length */ + session->peer_cert_digest_len;
3445 if (used <= buf_len) {
3446 *p++ = (unsigned char) session->peer_cert_digest_type;
3447 *p++ = (unsigned char) session->peer_cert_digest_len;
3448 memcpy(p, session->peer_cert_digest,
3449 session->peer_cert_digest_len);
3450 p += session->peer_cert_digest_len;
3451 }
3452 } else {
3453 used += 2;
3454 if (used <= buf_len) {
3455 *p++ = (unsigned char) MBEDTLS_MD_NONE;
3456 *p++ = 0;
3457 }
3458 }
3459#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3460#endif /* MBEDTLS_X509_CRT_PARSE_C */
3461
3462 /*
3463 * Session ticket if any, plus associated data
3464 */
3465#if defined(MBEDTLS_SSL_SESSION_TICKETS)
3466#if defined(MBEDTLS_SSL_CLI_C)
3467 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
3468 used += 3 + session->ticket_len + 4; /* len + ticket + lifetime */
3469
3470 if (used <= buf_len) {
3471 *p++ = MBEDTLS_BYTE_2(session->ticket_len);
3472 *p++ = MBEDTLS_BYTE_1(session->ticket_len);
3473 *p++ = MBEDTLS_BYTE_0(session->ticket_len);
3474
3475 if (session->ticket != NULL) {
3476 memcpy(p, session->ticket, session->ticket_len);
3477 p += session->ticket_len;
3478 }
3479
3480 MBEDTLS_PUT_UINT32_BE(session->ticket_lifetime, p, 0);
3481 p += 4;
3482 }
3483 }
3484#endif /* MBEDTLS_SSL_CLI_C */
3485#if defined(MBEDTLS_HAVE_TIME) && defined(MBEDTLS_SSL_SRV_C)
3486 if (session->endpoint == MBEDTLS_SSL_IS_SERVER) {
3487 used += 8;
3488
3489 if (used <= buf_len) {
3490 MBEDTLS_PUT_UINT64_BE((uint64_t) session->ticket_creation_time, p, 0);
3491 p += 8;
3492 }
3493 }
3494#endif /* MBEDTLS_HAVE_TIME && MBEDTLS_SSL_SRV_C */
3495#endif /* MBEDTLS_SSL_SESSION_TICKETS */
3496
3497 /*
3498 * Misc extension-related info
3499 */
3500#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
3501 used += 1;
3502
3503 if (used <= buf_len) {
3504 *p++ = session->mfl_code;
3505 }
3506#endif
3507
3508#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
3509 used += 1;
3510
3511 if (used <= buf_len) {
3512 *p++ = MBEDTLS_BYTE_0(session->encrypt_then_mac);
3513 }
3514#endif
3515
3516 return used;
3517}
3518
3519MBEDTLS_CHECK_RETURN_CRITICAL
3520static int ssl_tls12_session_load(mbedtls_ssl_session *session,
3521 const unsigned char *buf,
3522 size_t len)
3523{
3524#if defined(MBEDTLS_HAVE_TIME)
3525 uint64_t start;
3526#endif
3527#if defined(MBEDTLS_X509_CRT_PARSE_C)
3528#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
3529 size_t cert_len;
3530#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3531#endif /* MBEDTLS_X509_CRT_PARSE_C */
3532
3533 const unsigned char *p = buf;
3534 const unsigned char * const end = buf + len;
3535
3536 /*
3537 * Time
3538 */
3539#if defined(MBEDTLS_HAVE_TIME)
3540 if (8 > (size_t) (end - p)) {
3541 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3542 }
3543
3544 start = MBEDTLS_GET_UINT64_BE(p, 0);
3545 p += 8;
3546
3547 session->start = (time_t) start;
3548#endif /* MBEDTLS_HAVE_TIME */
3549
3550 /*
3551 * Basic mandatory fields
3552 */
3553 if (1 + 32 + 48 + 4 > (size_t) (end - p)) {
3554 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3555 }
3556
3557 session->id_len = *p++;
3558 memcpy(session->id, p, 32);
3559 p += 32;
3560
3561 memcpy(session->master, p, 48);
3562 p += 48;
3563
3564 session->verify_result = MBEDTLS_GET_UINT32_BE(p, 0);
3565 p += 4;
3566
3567 /* Immediately clear invalid pointer values that have been read, in case
3568 * we exit early before we replaced them with valid ones. */
3569#if defined(MBEDTLS_X509_CRT_PARSE_C)
3570#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
3571 session->peer_cert = NULL;
3572#else
3573 session->peer_cert_digest = NULL;
3574#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3575#endif /* MBEDTLS_X509_CRT_PARSE_C */
3576#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
3577 session->ticket = NULL;
3578#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
3579
3580 /*
3581 * Peer certificate
3582 */
3583#if defined(MBEDTLS_X509_CRT_PARSE_C)
3584#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
3585 /* Deserialize CRT from the end of the ticket. */
3586 if (3 > (size_t) (end - p)) {
3587 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3588 }
3589
3590 cert_len = MBEDTLS_GET_UINT24_BE(p, 0);
3591 p += 3;
3592
3593 if (cert_len != 0) {
3594 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
3595
3596 if (cert_len > (size_t) (end - p)) {
3597 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3598 }
3599
3600 session->peer_cert = mbedtls_calloc(1, sizeof(mbedtls_x509_crt));
3601
3602 if (session->peer_cert == NULL) {
3603 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
3604 }
3605
3606 mbedtls_x509_crt_init(session->peer_cert);
3607
3608 if ((ret = mbedtls_x509_crt_parse_der(session->peer_cert,
3609 p, cert_len)) != 0) {
3610 mbedtls_x509_crt_free(session->peer_cert);
3611 mbedtls_free(session->peer_cert);
3612 session->peer_cert = NULL;
3613 return ret;
3614 }
3615
3616 p += cert_len;
3617 }
3618#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3619 /* Deserialize CRT digest from the end of the ticket. */
3620 if (2 > (size_t) (end - p)) {
3621 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3622 }
3623
3624 session->peer_cert_digest_type = (mbedtls_md_type_t) *p++;
3625 session->peer_cert_digest_len = (size_t) *p++;
3626
3627 if (session->peer_cert_digest_len != 0) {
3628 const mbedtls_md_info_t *md_info =
3629 mbedtls_md_info_from_type(session->peer_cert_digest_type);
3630 if (md_info == NULL) {
3631 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3632 }
3633 if (session->peer_cert_digest_len != mbedtls_md_get_size(md_info)) {
3634 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3635 }
3636
3637 if (session->peer_cert_digest_len > (size_t) (end - p)) {
3638 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3639 }
3640
3641 session->peer_cert_digest =
3642 mbedtls_calloc(1, session->peer_cert_digest_len);
3643 if (session->peer_cert_digest == NULL) {
3644 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
3645 }
3646
3647 memcpy(session->peer_cert_digest, p,
3648 session->peer_cert_digest_len);
3649 p += session->peer_cert_digest_len;
3650 }
3651#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3652#endif /* MBEDTLS_X509_CRT_PARSE_C */
3653
3654 /*
3655 * Session ticket and associated data
3656 */
3657#if defined(MBEDTLS_SSL_SESSION_TICKETS)
3658#if defined(MBEDTLS_SSL_CLI_C)
3659 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
3660 if (3 > (size_t) (end - p)) {
3661 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3662 }
3663
3664 session->ticket_len = MBEDTLS_GET_UINT24_BE(p, 0);
3665 p += 3;
3666
3667 if (session->ticket_len != 0) {
3668 if (session->ticket_len > (size_t) (end - p)) {
3669 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3670 }
3671
3672 session->ticket = mbedtls_calloc(1, session->ticket_len);
3673 if (session->ticket == NULL) {
3674 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
3675 }
3676
3677 memcpy(session->ticket, p, session->ticket_len);
3678 p += session->ticket_len;
3679 }
3680
3681 if (4 > (size_t) (end - p)) {
3682 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3683 }
3684
3685 session->ticket_lifetime = MBEDTLS_GET_UINT32_BE(p, 0);
3686 p += 4;
3687 }
3688#endif /* MBEDTLS_SSL_CLI_C */
3689#if defined(MBEDTLS_HAVE_TIME) && defined(MBEDTLS_SSL_SRV_C)
3690 if (session->endpoint == MBEDTLS_SSL_IS_SERVER) {
3691 if (8 > (size_t) (end - p)) {
3692 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3693 }
3694 session->ticket_creation_time = MBEDTLS_GET_UINT64_BE(p, 0);
3695 p += 8;
3696 }
3697#endif /* MBEDTLS_HAVE_TIME && MBEDTLS_SSL_SRV_C */
3698#endif /* MBEDTLS_SSL_SESSION_TICKETS */
3699
3700 /*
3701 * Misc extension-related info
3702 */
3703#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
3704 if (1 > (size_t) (end - p)) {
3705 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3706 }
3707
3708 session->mfl_code = *p++;
3709#endif
3710
3711#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
3712 if (1 > (size_t) (end - p)) {
3713 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3714 }
3715
3716 session->encrypt_then_mac = *p++;
3717#endif
3718
3719 /* Done, should have consumed entire buffer */
3720 if (p != end) {
3721 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3722 }
3723
3724 return 0;
3725}
3726
3727#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
3728
3729#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
3730/* Serialization of TLS 1.3 sessions:
3731 *
David Horstmanncb01b362024-02-29 17:31:46 +00003732 * For more detail, see the description of ssl_session_save().
David Horstmanne59f9702024-02-29 16:08:57 +00003733 */
3734#if defined(MBEDTLS_SSL_SESSION_TICKETS)
3735MBEDTLS_CHECK_RETURN_CRITICAL
3736static int ssl_tls13_session_save(const mbedtls_ssl_session *session,
3737 unsigned char *buf,
3738 size_t buf_len,
3739 size_t *olen)
3740{
3741 unsigned char *p = buf;
3742#if defined(MBEDTLS_SSL_CLI_C) && \
3743 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
3744 size_t hostname_len = (session->hostname == NULL) ?
3745 0 : strlen(session->hostname) + 1;
3746#endif
3747 size_t needed = 4 /* ticket_age_add */
3748 + 1 /* ticket_flags */
3749 + 1; /* resumption_key length */
3750 *olen = 0;
3751
3752 if (session->resumption_key_len > MBEDTLS_SSL_TLS1_3_TICKET_RESUMPTION_KEY_LEN) {
3753 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3754 }
3755 needed += session->resumption_key_len; /* resumption_key */
3756
3757#if defined(MBEDTLS_SSL_EARLY_DATA)
3758 needed += 4; /* max_early_data_size */
3759#endif
3760#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
3761 needed += 2; /* record_size_limit */
3762#endif /* MBEDTLS_SSL_RECORD_SIZE_LIMIT */
3763
3764#if defined(MBEDTLS_HAVE_TIME)
3765 needed += 8; /* ticket_creation_time or ticket_reception_time */
3766#endif
3767
3768#if defined(MBEDTLS_SSL_CLI_C)
3769 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
3770#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
3771 needed += 2 /* hostname_len */
3772 + hostname_len; /* hostname */
3773#endif
3774
3775 needed += 4 /* ticket_lifetime */
3776 + 2; /* ticket_len */
3777
3778 /* Check size_t overflow */
3779 if (session->ticket_len > SIZE_MAX - needed) {
3780 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3781 }
3782
3783 needed += session->ticket_len; /* ticket */
3784 }
3785#endif /* MBEDTLS_SSL_CLI_C */
3786
3787 *olen = needed;
3788 if (needed > buf_len) {
3789 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
3790 }
3791
3792 MBEDTLS_PUT_UINT32_BE(session->ticket_age_add, p, 0);
3793 p[4] = session->ticket_flags;
3794
3795 /* save resumption_key */
3796 p[5] = session->resumption_key_len;
3797 p += 6;
3798 memcpy(p, session->resumption_key, session->resumption_key_len);
3799 p += session->resumption_key_len;
3800
3801#if defined(MBEDTLS_SSL_EARLY_DATA)
3802 MBEDTLS_PUT_UINT32_BE(session->max_early_data_size, p, 0);
3803 p += 4;
3804#endif
3805#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
3806 MBEDTLS_PUT_UINT16_BE(session->record_size_limit, p, 0);
3807 p += 2;
3808#endif /* MBEDTLS_SSL_RECORD_SIZE_LIMIT */
3809
3810#if defined(MBEDTLS_HAVE_TIME) && defined(MBEDTLS_SSL_SRV_C)
3811 if (session->endpoint == MBEDTLS_SSL_IS_SERVER) {
3812 MBEDTLS_PUT_UINT64_BE((uint64_t) session->ticket_creation_time, p, 0);
3813 p += 8;
3814 }
3815#endif /* MBEDTLS_HAVE_TIME */
3816
3817#if defined(MBEDTLS_SSL_CLI_C)
3818 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
3819#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
3820 MBEDTLS_PUT_UINT16_BE(hostname_len, p, 0);
3821 p += 2;
3822 if (hostname_len > 0) {
3823 /* save host name */
3824 memcpy(p, session->hostname, hostname_len);
3825 p += hostname_len;
3826 }
3827#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
3828
3829#if defined(MBEDTLS_HAVE_TIME)
3830 MBEDTLS_PUT_UINT64_BE((uint64_t) session->ticket_reception_time, p, 0);
3831 p += 8;
3832#endif
3833 MBEDTLS_PUT_UINT32_BE(session->ticket_lifetime, p, 0);
3834 p += 4;
3835
3836 MBEDTLS_PUT_UINT16_BE(session->ticket_len, p, 0);
3837 p += 2;
3838
3839 if (session->ticket != NULL && session->ticket_len > 0) {
3840 memcpy(p, session->ticket, session->ticket_len);
3841 p += session->ticket_len;
3842 }
3843 }
3844#endif /* MBEDTLS_SSL_CLI_C */
3845 return 0;
3846}
3847
3848MBEDTLS_CHECK_RETURN_CRITICAL
3849static int ssl_tls13_session_load(mbedtls_ssl_session *session,
3850 const unsigned char *buf,
3851 size_t len)
3852{
3853 const unsigned char *p = buf;
3854 const unsigned char *end = buf + len;
3855
3856 if (end - p < 6) {
3857 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3858 }
3859 session->ticket_age_add = MBEDTLS_GET_UINT32_BE(p, 0);
3860 session->ticket_flags = p[4];
3861
3862 /* load resumption_key */
3863 session->resumption_key_len = p[5];
3864 p += 6;
3865
3866 if (end - p < session->resumption_key_len) {
3867 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3868 }
3869
3870 if (sizeof(session->resumption_key) < session->resumption_key_len) {
3871 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3872 }
3873 memcpy(session->resumption_key, p, session->resumption_key_len);
3874 p += session->resumption_key_len;
3875
3876#if defined(MBEDTLS_SSL_EARLY_DATA)
3877 if (end - p < 4) {
3878 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3879 }
3880 session->max_early_data_size = MBEDTLS_GET_UINT32_BE(p, 0);
3881 p += 4;
3882#endif
3883#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
3884 if (end - p < 2) {
3885 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3886 }
3887 session->record_size_limit = MBEDTLS_GET_UINT16_BE(p, 0);
3888 p += 2;
3889#endif /* MBEDTLS_SSL_RECORD_SIZE_LIMIT */
3890
3891#if defined(MBEDTLS_HAVE_TIME) && defined(MBEDTLS_SSL_SRV_C)
3892 if (session->endpoint == MBEDTLS_SSL_IS_SERVER) {
3893 if (end - p < 8) {
3894 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3895 }
3896 session->ticket_creation_time = MBEDTLS_GET_UINT64_BE(p, 0);
3897 p += 8;
3898 }
3899#endif /* MBEDTLS_HAVE_TIME */
3900
3901#if defined(MBEDTLS_SSL_CLI_C)
3902 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
3903#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
3904 size_t hostname_len;
3905 /* load host name */
3906 if (end - p < 2) {
3907 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3908 }
3909 hostname_len = MBEDTLS_GET_UINT16_BE(p, 0);
3910 p += 2;
3911
3912 if (end - p < (long int) hostname_len) {
3913 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3914 }
3915 if (hostname_len > 0) {
3916 session->hostname = mbedtls_calloc(1, hostname_len);
3917 if (session->hostname == NULL) {
3918 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
3919 }
3920 memcpy(session->hostname, p, hostname_len);
3921 p += hostname_len;
3922 }
3923#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
3924
3925#if defined(MBEDTLS_HAVE_TIME)
3926 if (end - p < 8) {
3927 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3928 }
3929 session->ticket_reception_time = MBEDTLS_GET_UINT64_BE(p, 0);
3930 p += 8;
3931#endif
3932 if (end - p < 4) {
3933 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3934 }
3935 session->ticket_lifetime = MBEDTLS_GET_UINT32_BE(p, 0);
3936 p += 4;
3937
3938 if (end - p < 2) {
3939 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3940 }
3941 session->ticket_len = MBEDTLS_GET_UINT16_BE(p, 0);
3942 p += 2;
3943
3944 if (end - p < (long int) session->ticket_len) {
3945 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3946 }
3947 if (session->ticket_len > 0) {
3948 session->ticket = mbedtls_calloc(1, session->ticket_len);
3949 if (session->ticket == NULL) {
3950 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
3951 }
3952 memcpy(session->ticket, p, session->ticket_len);
3953 p += session->ticket_len;
3954 }
3955 }
3956#endif /* MBEDTLS_SSL_CLI_C */
3957
3958 return 0;
3959
3960}
3961#else /* MBEDTLS_SSL_SESSION_TICKETS */
3962MBEDTLS_CHECK_RETURN_CRITICAL
3963static int ssl_tls13_session_save(const mbedtls_ssl_session *session,
3964 unsigned char *buf,
3965 size_t buf_len,
3966 size_t *olen)
3967{
3968 ((void) session);
3969 ((void) buf);
3970 ((void) buf_len);
3971 *olen = 0;
3972 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
3973}
3974
3975static int ssl_tls13_session_load(const mbedtls_ssl_session *session,
3976 unsigned char *buf,
3977 size_t buf_len)
3978{
3979 ((void) session);
3980 ((void) buf);
3981 ((void) buf_len);
3982 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
3983}
3984#endif /* !MBEDTLS_SSL_SESSION_TICKETS */
3985#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
3986
Paul Bakker5121ce52009-01-03 21:22:43 +00003987/*
Hanno Beckera835da52019-05-16 12:39:07 +01003988 * Define ticket header determining Mbed TLS version
3989 * and structure of the ticket.
3990 */
3991
Hanno Becker94ef3b32019-05-16 12:50:45 +01003992/*
Hanno Becker50b59662019-05-28 14:30:45 +01003993 * Define bitflag determining compile-time settings influencing
3994 * structure of serialized SSL sessions.
Hanno Becker94ef3b32019-05-16 12:50:45 +01003995 */
3996
Hanno Becker50b59662019-05-28 14:30:45 +01003997#if defined(MBEDTLS_HAVE_TIME)
Hanno Becker3e088662019-05-29 11:10:18 +01003998#define SSL_SERIALIZED_SESSION_CONFIG_TIME 1
Hanno Becker50b59662019-05-28 14:30:45 +01003999#else
Hanno Becker3e088662019-05-29 11:10:18 +01004000#define SSL_SERIALIZED_SESSION_CONFIG_TIME 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01004001#endif /* MBEDTLS_HAVE_TIME */
4002
4003#if defined(MBEDTLS_X509_CRT_PARSE_C)
Hanno Becker3e088662019-05-29 11:10:18 +01004004#define SSL_SERIALIZED_SESSION_CONFIG_CRT 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01004005#else
Hanno Becker3e088662019-05-29 11:10:18 +01004006#define SSL_SERIALIZED_SESSION_CONFIG_CRT 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01004007#endif /* MBEDTLS_X509_CRT_PARSE_C */
4008
David Horstmann5c5a32f2024-02-13 17:53:35 +00004009#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
David Horstmannf686f1d2024-03-01 11:20:32 +00004010#define SSL_SERIALIZED_SESSION_CONFIG_KEEP_PEER_CRT 1
David Horstmann5c5a32f2024-02-13 17:53:35 +00004011#else
David Horstmannf686f1d2024-03-01 11:20:32 +00004012#define SSL_SERIALIZED_SESSION_CONFIG_KEEP_PEER_CRT 0
David Horstmann5c5a32f2024-02-13 17:53:35 +00004013#endif /* MBEDTLS_SSL_SESSION_TICKETS */
4014
Hanno Becker94ef3b32019-05-16 12:50:45 +01004015#if defined(MBEDTLS_SSL_CLI_C) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Hanno Becker3e088662019-05-29 11:10:18 +01004016#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01004017#else
Hanno Becker3e088662019-05-29 11:10:18 +01004018#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01004019#endif /* MBEDTLS_SSL_CLI_C && MBEDTLS_SSL_SESSION_TICKETS */
4020
4021#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Hanno Becker3e088662019-05-29 11:10:18 +01004022#define SSL_SERIALIZED_SESSION_CONFIG_MFL 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01004023#else
Hanno Becker3e088662019-05-29 11:10:18 +01004024#define SSL_SERIALIZED_SESSION_CONFIG_MFL 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01004025#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
4026
Hanno Becker94ef3b32019-05-16 12:50:45 +01004027#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Hanno Becker3e088662019-05-29 11:10:18 +01004028#define SSL_SERIALIZED_SESSION_CONFIG_ETM 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01004029#else
Hanno Becker3e088662019-05-29 11:10:18 +01004030#define SSL_SERIALIZED_SESSION_CONFIG_ETM 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01004031#endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC */
4032
Hanno Becker94ef3b32019-05-16 12:50:45 +01004033#if defined(MBEDTLS_SSL_SESSION_TICKETS)
4034#define SSL_SERIALIZED_SESSION_CONFIG_TICKET 1
4035#else
4036#define SSL_SERIALIZED_SESSION_CONFIG_TICKET 0
4037#endif /* MBEDTLS_SSL_SESSION_TICKETS */
4038
David Horstmann92b258b2024-02-13 17:23:34 +00004039#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
4040#define SSL_SERIALIZED_SESSION_CONFIG_SNI 1
4041#else
4042#define SSL_SERIALIZED_SESSION_CONFIG_SNI 0
4043#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
4044
4045#if defined(MBEDTLS_SSL_EARLY_DATA)
4046#define SSL_SERIALIZED_SESSION_CONFIG_EARLY_DATA 1
4047#else
4048#define SSL_SERIALIZED_SESSION_CONFIG_EARLY_DATA 0
4049#endif /* MBEDTLS_SSL_EARLY_DATA */
4050
4051#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
4052#define SSL_SERIALIZED_SESSION_CONFIG_RECORD_SIZE 1
4053#else
4054#define SSL_SERIALIZED_SESSION_CONFIG_RECORD_SIZE 0
4055#endif /* MBEDTLS_SSL_RECORD_SIZE_LIMIT */
4056
Hanno Becker3e088662019-05-29 11:10:18 +01004057#define SSL_SERIALIZED_SESSION_CONFIG_TIME_BIT 0
4058#define SSL_SERIALIZED_SESSION_CONFIG_CRT_BIT 1
4059#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET_BIT 2
4060#define SSL_SERIALIZED_SESSION_CONFIG_MFL_BIT 3
Hanno Becker37bdbe62021-08-01 05:38:58 +01004061#define SSL_SERIALIZED_SESSION_CONFIG_ETM_BIT 4
4062#define SSL_SERIALIZED_SESSION_CONFIG_TICKET_BIT 5
David Horstmannf686f1d2024-03-01 11:20:32 +00004063#define SSL_SERIALIZED_SESSION_CONFIG_KEEP_PEER_CRT_BIT 6
David Horstmann92b258b2024-02-13 17:23:34 +00004064#define SSL_SERIALIZED_SESSION_CONFIG_SNI_BIT 7
4065#define SSL_SERIALIZED_SESSION_CONFIG_EARLY_DATA_BIT 8
4066#define SSL_SERIALIZED_SESSION_CONFIG_RECORD_SIZE_BIT 9
Hanno Becker3e088662019-05-29 11:10:18 +01004067
Hanno Becker50b59662019-05-28 14:30:45 +01004068#define SSL_SERIALIZED_SESSION_CONFIG_BITFLAG \
Gilles Peskine449bd832023-01-11 14:50:10 +01004069 ((uint16_t) ( \
4070 (SSL_SERIALIZED_SESSION_CONFIG_TIME << SSL_SERIALIZED_SESSION_CONFIG_TIME_BIT) | \
4071 (SSL_SERIALIZED_SESSION_CONFIG_CRT << SSL_SERIALIZED_SESSION_CONFIG_CRT_BIT) | \
4072 (SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET << \
4073 SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET_BIT) | \
4074 (SSL_SERIALIZED_SESSION_CONFIG_MFL << SSL_SERIALIZED_SESSION_CONFIG_MFL_BIT) | \
4075 (SSL_SERIALIZED_SESSION_CONFIG_ETM << SSL_SERIALIZED_SESSION_CONFIG_ETM_BIT) | \
David Horstmann5c5a32f2024-02-13 17:53:35 +00004076 (SSL_SERIALIZED_SESSION_CONFIG_TICKET << SSL_SERIALIZED_SESSION_CONFIG_TICKET_BIT) | \
David Horstmannf686f1d2024-03-01 11:20:32 +00004077 (SSL_SERIALIZED_SESSION_CONFIG_KEEP_PEER_CRT << SSL_SERIALIZED_SESSION_CONFIG_KEEP_PEER_CRT_BIT) | \
David Horstmann92b258b2024-02-13 17:23:34 +00004078 (SSL_SERIALIZED_SESSION_CONFIG_SNI << SSL_SERIALIZED_SESSION_CONFIG_SNI_BIT) | \
4079 (SSL_SERIALIZED_SESSION_CONFIG_EARLY_DATA << \
4080 SSL_SERIALIZED_SESSION_CONFIG_EARLY_DATA_BIT) | \
4081 (SSL_SERIALIZED_SESSION_CONFIG_RECORD_SIZE << \
4082 SSL_SERIALIZED_SESSION_CONFIG_RECORD_SIZE_BIT)))
Hanno Becker94ef3b32019-05-16 12:50:45 +01004083
Chien Wong4e9683e2023-12-28 17:07:43 +08004084static const unsigned char ssl_serialized_session_header[] = {
Hanno Becker94ef3b32019-05-16 12:50:45 +01004085 MBEDTLS_VERSION_MAJOR,
4086 MBEDTLS_VERSION_MINOR,
4087 MBEDTLS_VERSION_PATCH,
Gilles Peskine449bd832023-01-11 14:50:10 +01004088 MBEDTLS_BYTE_1(SSL_SERIALIZED_SESSION_CONFIG_BITFLAG),
4089 MBEDTLS_BYTE_0(SSL_SERIALIZED_SESSION_CONFIG_BITFLAG),
Hanno Beckerf8787072019-05-16 12:41:07 +01004090};
Hanno Beckera835da52019-05-16 12:39:07 +01004091
4092/*
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004093 * Serialize a session in the following format:
Manuel Pégourié-Gonnard35eb8022019-05-16 11:11:08 +02004094 * (in the presentation language of TLS, RFC 8446 section 3)
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004095 *
David Horstmanncb01b362024-02-29 17:31:46 +00004096 * TLS 1.2 session:
4097 *
4098 * struct {
4099 * #if defined(MBEDTLS_SSL_SESSION_TICKETS)
4100 * opaque ticket<0..2^24-1>; // length 0 means no ticket
4101 * uint32 ticket_lifetime;
4102 * #endif
4103 * } ClientOnlyData;
4104 *
4105 * struct {
4106 * #if defined(MBEDTLS_HAVE_TIME)
4107 * uint64 start_time;
4108 * #endif
4109 * uint8 session_id_len; // at most 32
4110 * opaque session_id[32];
4111 * opaque master[48]; // fixed length in the standard
4112 * uint32 verify_result;
4113 * #if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
4114 * opaque peer_cert<0..2^24-1>; // length 0 means no peer cert
4115 * #else
David Horstmann76ba26a2024-03-01 12:03:35 +00004116 * uint8 peer_cert_digest_type;
David Horstmanncb01b362024-02-29 17:31:46 +00004117 * opaque peer_cert_digest<0..2^8-1>
4118 * #endif
4119 * select (endpoint) {
4120 * case client: ClientOnlyData;
4121 * case server: uint64 ticket_creation_time;
4122 * };
4123 * #if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
4124 * uint8 mfl_code; // up to 255 according to standard
4125 * #endif
4126 * #if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
4127 * uint8 encrypt_then_mac; // 0 or 1
4128 * #endif
4129 * } serialized_session_tls12;
4130 *
4131 *
4132 * TLS 1.3 Session:
4133 *
4134 * struct {
4135 * #if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
4136 * opaque hostname<0..2^16-1>;
4137 * #endif
4138 * #if defined(MBEDTLS_HAVE_TIME)
4139 * uint64 ticket_reception_time;
4140 * #endif
4141 * uint32 ticket_lifetime;
4142 * opaque ticket<1..2^16-1>;
4143 * } ClientOnlyData;
4144 *
4145 * struct {
4146 * uint32 ticket_age_add;
4147 * uint8 ticket_flags;
4148 * opaque resumption_key<0..255>;
4149 * #if defined(MBEDTLS_SSL_EARLY_DATA)
4150 * uint32 max_early_data_size;
4151 * #endif
4152 * #if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
4153 * uint16 record_size_limit;
4154 * #endif
4155 * select ( endpoint ) {
4156 * case client: ClientOnlyData;
4157 * #if defined(MBEDTLS_HAVE_TIME)
4158 * case server: uint64 ticket_creation_time;
4159 * #endif
4160 * };
4161 * } serialized_session_tls13;
4162 *
4163 *
4164 * SSL session:
4165 *
4166 * struct {
Hanno Beckerdc28b6c2019-05-29 11:08:00 +01004167 *
Hanno Beckerdce50972021-08-01 05:39:23 +01004168 * opaque mbedtls_version[3]; // library version: major, minor, patch
4169 * opaque session_format[2]; // library-version specific 16-bit field
4170 * // determining the format of the remaining
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004171 * // serialized data.
Hanno Beckerdc28b6c2019-05-29 11:08:00 +01004172 *
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004173 * Note: When updating the format, remember to keep
4174 * these version+format bytes.
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004175 *
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004176 * // In this version, `session_format` determines
4177 * // the setting of those compile-time
4178 * // configuration options which influence
4179 * // the structure of mbedtls_ssl_session.
4180 *
Glenn Straussda7851c2022-03-14 13:29:48 -04004181 * uint8_t minor_ver; // Protocol minor version. Possible values:
Jerry Yu0c2a7382022-12-06 13:27:25 +08004182 * // - TLS 1.2 (0x0303)
4183 * // - TLS 1.3 (0x0304)
David Horstmann531aca22024-02-29 18:14:28 +00004184 * uint8_t endpoint;
4185 * uint16_t ciphersuite;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004186 *
Glenn Straussda7851c2022-03-14 13:29:48 -04004187 * select (serialized_session.tls_version) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004188 *
Glenn Straussda7851c2022-03-14 13:29:48 -04004189 * case MBEDTLS_SSL_VERSION_TLS1_2:
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004190 * serialized_session_tls12 data;
Jerry Yu0c2a7382022-12-06 13:27:25 +08004191 * case MBEDTLS_SSL_VERSION_TLS1_3:
Jerry Yuddda0502022-12-01 19:43:12 +08004192 * serialized_session_tls13 data;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004193 *
4194 * };
4195 *
4196 * } serialized_session;
4197 *
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004198 */
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004199
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004200MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004201static int ssl_session_save(const mbedtls_ssl_session *session,
4202 unsigned char omit_header,
4203 unsigned char *buf,
4204 size_t buf_len,
4205 size_t *olen)
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004206{
4207 unsigned char *p = buf;
4208 size_t used = 0;
Jerry Yu251a12e2022-07-13 15:15:48 +08004209 size_t remaining_len;
Jerry Yue36fdd62022-08-17 21:31:36 +08004210#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
4211 size_t out_len;
4212 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
4213#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01004214 if (session == NULL) {
4215 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
4216 }
Jerry Yu438ddd82022-07-07 06:55:50 +00004217
Gilles Peskine449bd832023-01-11 14:50:10 +01004218 if (!omit_header) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004219 /*
4220 * Add Mbed TLS version identifier
4221 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004222 used += sizeof(ssl_serialized_session_header);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004223
Gilles Peskine449bd832023-01-11 14:50:10 +01004224 if (used <= buf_len) {
4225 memcpy(p, ssl_serialized_session_header,
4226 sizeof(ssl_serialized_session_header));
4227 p += sizeof(ssl_serialized_session_header);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004228 }
4229 }
4230
4231 /*
Ronald Cron40a4ab02024-01-15 10:21:30 +01004232 * TLS version identifier, endpoint, ciphersuite
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004233 */
Ronald Cron40a4ab02024-01-15 10:21:30 +01004234 used += 1 /* TLS version */
4235 + 1 /* endpoint */
4236 + 2; /* ciphersuite */
Gilles Peskine449bd832023-01-11 14:50:10 +01004237 if (used <= buf_len) {
4238 *p++ = MBEDTLS_BYTE_0(session->tls_version);
Ronald Cron40a4ab02024-01-15 10:21:30 +01004239 *p++ = session->endpoint;
4240 MBEDTLS_PUT_UINT16_BE(session->ciphersuite, p, 0);
4241 p += 2;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004242 }
4243
4244 /* Forward to version-specific serialization routine. */
Jerry Yufca4d572022-07-21 10:37:48 +08004245 remaining_len = (buf_len >= used) ? buf_len - used : 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01004246 switch (session->tls_version) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004247#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01004248 case MBEDTLS_SSL_VERSION_TLS1_2:
4249 used += ssl_tls12_session_save(session, p, remaining_len);
4250 break;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004251#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
4252
Jerry Yu251a12e2022-07-13 15:15:48 +08004253#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004254 case MBEDTLS_SSL_VERSION_TLS1_3:
4255 ret = ssl_tls13_session_save(session, p, remaining_len, &out_len);
4256 if (ret != 0 && ret != MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL) {
4257 return ret;
4258 }
4259 used += out_len;
4260 break;
Jerry Yu251a12e2022-07-13 15:15:48 +08004261#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
4262
Gilles Peskine449bd832023-01-11 14:50:10 +01004263 default:
4264 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004265 }
4266
4267 *olen = used;
Gilles Peskine449bd832023-01-11 14:50:10 +01004268 if (used > buf_len) {
4269 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
4270 }
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004271
Gilles Peskine449bd832023-01-11 14:50:10 +01004272 return 0;
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004273}
4274
4275/*
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02004276 * Public wrapper for ssl_session_save()
4277 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004278int mbedtls_ssl_session_save(const mbedtls_ssl_session *session,
4279 unsigned char *buf,
4280 size_t buf_len,
4281 size_t *olen)
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02004282{
Gilles Peskine449bd832023-01-11 14:50:10 +01004283 return ssl_session_save(session, 0, buf, buf_len, olen);
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02004284}
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004285
Jerry Yuf1b23ca2022-02-18 11:48:47 +08004286/*
4287 * Deserialize session, see mbedtls_ssl_session_save() for format.
4288 *
4289 * This internal version is wrapped by a public function that cleans up in
4290 * case of error, and has an extra option omit_header.
4291 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004292MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004293static int ssl_session_load(mbedtls_ssl_session *session,
4294 unsigned char omit_header,
4295 const unsigned char *buf,
4296 size_t len)
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004297{
4298 const unsigned char *p = buf;
4299 const unsigned char * const end = buf + len;
Jerry Yu438ddd82022-07-07 06:55:50 +00004300 size_t remaining_len;
4301
4302
Gilles Peskine449bd832023-01-11 14:50:10 +01004303 if (session == NULL) {
4304 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
4305 }
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004306
Gilles Peskine449bd832023-01-11 14:50:10 +01004307 if (!omit_header) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004308 /*
4309 * Check Mbed TLS version identifier
4310 */
4311
Gilles Peskine449bd832023-01-11 14:50:10 +01004312 if ((size_t) (end - p) < sizeof(ssl_serialized_session_header)) {
4313 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004314 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004315
4316 if (memcmp(p, ssl_serialized_session_header,
4317 sizeof(ssl_serialized_session_header)) != 0) {
4318 return MBEDTLS_ERR_SSL_VERSION_MISMATCH;
4319 }
4320 p += sizeof(ssl_serialized_session_header);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004321 }
4322
4323 /*
Ronald Cron40a4ab02024-01-15 10:21:30 +01004324 * TLS version identifier, endpoint, ciphersuite
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004325 */
Ronald Cron40a4ab02024-01-15 10:21:30 +01004326 if (4 > (size_t) (end - p)) {
Gilles Peskine449bd832023-01-11 14:50:10 +01004327 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4328 }
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01004329 session->tls_version = (mbedtls_ssl_protocol_version) (0x0300 | *p++);
Ronald Cron40a4ab02024-01-15 10:21:30 +01004330 session->endpoint = *p++;
4331 session->ciphersuite = MBEDTLS_GET_UINT16_BE(p, 0);
4332 p += 2;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004333
4334 /* Dispatch according to TLS version. */
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00004335 remaining_len = (size_t) (end - p);
Gilles Peskine449bd832023-01-11 14:50:10 +01004336 switch (session->tls_version) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004337#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01004338 case MBEDTLS_SSL_VERSION_TLS1_2:
4339 return ssl_tls12_session_load(session, p, remaining_len);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004340#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
4341
Jerry Yu438ddd82022-07-07 06:55:50 +00004342#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004343 case MBEDTLS_SSL_VERSION_TLS1_3:
4344 return ssl_tls13_session_load(session, p, remaining_len);
Jerry Yu438ddd82022-07-07 06:55:50 +00004345#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
4346
Gilles Peskine449bd832023-01-11 14:50:10 +01004347 default:
4348 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004349 }
4350}
4351
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004352/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02004353 * Deserialize session: public wrapper for error cleaning
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02004354 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004355int mbedtls_ssl_session_load(mbedtls_ssl_session *session,
4356 const unsigned char *buf,
4357 size_t len)
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02004358{
Gilles Peskine449bd832023-01-11 14:50:10 +01004359 int ret = ssl_session_load(session, 0, buf, len);
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02004360
Gilles Peskine449bd832023-01-11 14:50:10 +01004361 if (ret != 0) {
4362 mbedtls_ssl_session_free(session);
4363 }
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02004364
Gilles Peskine449bd832023-01-11 14:50:10 +01004365 return ret;
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02004366}
4367
4368/*
Paul Bakker1961b702013-01-25 14:49:24 +01004369 * Perform a single step of the SSL handshake
Paul Bakker5121ce52009-01-03 21:22:43 +00004370 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004371MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004372static int ssl_prepare_handshake_step(mbedtls_ssl_context *ssl)
Hanno Becker41934dd2021-08-07 19:13:43 +01004373{
4374 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
4375
Ronald Cron66dbf912022-02-02 15:33:46 +01004376 /*
4377 * We may have not been able to send to the peer all the handshake data
Ronald Cron3f20b772022-03-08 16:00:02 +01004378 * that were written into the output buffer by the previous handshake step,
4379 * if the write to the network callback returned with the
Ronald Cron66dbf912022-02-02 15:33:46 +01004380 * #MBEDTLS_ERR_SSL_WANT_WRITE error code.
4381 * We proceed to the next handshake step only when all data from the
4382 * previous one have been sent to the peer, thus we make sure that this is
4383 * the case here by calling `mbedtls_ssl_flush_output()`. The function may
4384 * return with the #MBEDTLS_ERR_SSL_WANT_WRITE error code in which case
4385 * we have to wait before to go ahead.
4386 * In the case of TLS 1.3, handshake step handlers do not send data to the
4387 * peer. Data are only sent here and through
4388 * `mbedtls_ssl_handle_pending_alert` in case an error that triggered an
Andrzej Kurek5c65c572022-04-13 14:28:52 -04004389 * alert occurred.
Ronald Cron66dbf912022-02-02 15:33:46 +01004390 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004391 if ((ret = mbedtls_ssl_flush_output(ssl)) != 0) {
4392 return ret;
4393 }
Hanno Becker41934dd2021-08-07 19:13:43 +01004394
4395#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004396 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
4397 ssl->handshake->retransmit_state == MBEDTLS_SSL_RETRANS_SENDING) {
4398 if ((ret = mbedtls_ssl_flight_transmit(ssl)) != 0) {
4399 return ret;
4400 }
Hanno Becker41934dd2021-08-07 19:13:43 +01004401 }
4402#endif /* MBEDTLS_SSL_PROTO_DTLS */
4403
Gilles Peskine449bd832023-01-11 14:50:10 +01004404 return ret;
Hanno Becker41934dd2021-08-07 19:13:43 +01004405}
4406
Gilles Peskine449bd832023-01-11 14:50:10 +01004407int mbedtls_ssl_handshake_step(mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00004408{
Hanno Becker41934dd2021-08-07 19:13:43 +01004409 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00004410
Gilles Peskine449bd832023-01-11 14:50:10 +01004411 if (ssl == NULL ||
Hanno Becker41934dd2021-08-07 19:13:43 +01004412 ssl->conf == NULL ||
4413 ssl->handshake == NULL ||
Gilles Peskine449bd832023-01-11 14:50:10 +01004414 ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER) {
4415 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Becker41934dd2021-08-07 19:13:43 +01004416 }
4417
Gilles Peskine449bd832023-01-11 14:50:10 +01004418 ret = ssl_prepare_handshake_step(ssl);
4419 if (ret != 0) {
4420 return ret;
4421 }
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02004422
Gilles Peskine449bd832023-01-11 14:50:10 +01004423 ret = mbedtls_ssl_handle_pending_alert(ssl);
4424 if (ret != 0) {
Jerry Yue7047812021-09-13 19:26:39 +08004425 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01004426 }
Jerry Yue7047812021-09-13 19:26:39 +08004427
Tom Cosgrove2fdc7b32022-09-21 12:33:17 +01004428 /* If ssl->conf->endpoint is not one of MBEDTLS_SSL_IS_CLIENT or
4429 * MBEDTLS_SSL_IS_SERVER, this is the return code we give */
4430 ret = MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4431
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004432#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004433 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
4434 MBEDTLS_SSL_DEBUG_MSG(2, ("client state: %s",
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01004435 mbedtls_ssl_states_str((mbedtls_ssl_states) ssl->state)));
Jerry Yub9930e72021-08-06 17:11:51 +08004436
Gilles Peskine449bd832023-01-11 14:50:10 +01004437 switch (ssl->state) {
Ronald Cron9f0fba32022-02-10 16:45:15 +01004438 case MBEDTLS_SSL_HELLO_REQUEST:
4439 ssl->state = MBEDTLS_SSL_CLIENT_HELLO;
Tom Cosgrove87d9c6c2022-09-22 09:27:56 +01004440 ret = 0;
Ronald Cron9f0fba32022-02-10 16:45:15 +01004441 break;
Jerry Yub9930e72021-08-06 17:11:51 +08004442
Ronald Cron9f0fba32022-02-10 16:45:15 +01004443 case MBEDTLS_SSL_CLIENT_HELLO:
Gilles Peskine449bd832023-01-11 14:50:10 +01004444 ret = mbedtls_ssl_write_client_hello(ssl);
Ronald Cron9f0fba32022-02-10 16:45:15 +01004445 break;
4446
4447 default:
4448#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004449 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
4450 ret = mbedtls_ssl_tls13_handshake_client_step(ssl);
4451 } else {
4452 ret = mbedtls_ssl_handshake_client_step(ssl);
4453 }
Ronald Cron9f0fba32022-02-10 16:45:15 +01004454#elif defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01004455 ret = mbedtls_ssl_handshake_client_step(ssl);
Ronald Cron9f0fba32022-02-10 16:45:15 +01004456#else
Gilles Peskine449bd832023-01-11 14:50:10 +01004457 ret = mbedtls_ssl_tls13_handshake_client_step(ssl);
Ronald Cron9f0fba32022-02-10 16:45:15 +01004458#endif
4459 }
Jerry Yub9930e72021-08-06 17:11:51 +08004460 }
Ronald Cron6291b232023-03-08 15:51:25 +01004461#endif /* MBEDTLS_SSL_CLI_C */
4462
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004463#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004464 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Ronald Cron6291b232023-03-08 15:51:25 +01004465#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
4466 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Gilles Peskine449bd832023-01-11 14:50:10 +01004467 ret = mbedtls_ssl_tls13_handshake_server_step(ssl);
Ronald Cron6291b232023-03-08 15:51:25 +01004468 } else {
Gilles Peskine449bd832023-01-11 14:50:10 +01004469 ret = mbedtls_ssl_handshake_server_step(ssl);
4470 }
Ronald Cron6291b232023-03-08 15:51:25 +01004471#elif defined(MBEDTLS_SSL_PROTO_TLS1_2)
4472 ret = mbedtls_ssl_handshake_server_step(ssl);
4473#else
4474 ret = mbedtls_ssl_tls13_handshake_server_step(ssl);
Paul Bakker5121ce52009-01-03 21:22:43 +00004475#endif
Ronald Cron6291b232023-03-08 15:51:25 +01004476 }
4477#endif /* MBEDTLS_SSL_SRV_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00004478
Gilles Peskine449bd832023-01-11 14:50:10 +01004479 if (ret != 0) {
Jerry Yubbd5a3f2021-09-18 20:50:22 +08004480 /* handshake_step return error. And it is same
4481 * with alert_reason.
4482 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004483 if (ssl->send_alert) {
4484 ret = mbedtls_ssl_handle_pending_alert(ssl);
Jerry Yue7047812021-09-13 19:26:39 +08004485 goto cleanup;
4486 }
4487 }
4488
4489cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +01004490 return ret;
Paul Bakker1961b702013-01-25 14:49:24 +01004491}
4492
4493/*
4494 * Perform the SSL handshake
4495 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004496int mbedtls_ssl_handshake(mbedtls_ssl_context *ssl)
Paul Bakker1961b702013-01-25 14:49:24 +01004497{
4498 int ret = 0;
4499
Hanno Beckera817ea42020-10-20 15:20:23 +01004500 /* Sanity checks */
4501
Gilles Peskine449bd832023-01-11 14:50:10 +01004502 if (ssl == NULL || ssl->conf == NULL) {
4503 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4504 }
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02004505
Hanno Beckera817ea42020-10-20 15:20:23 +01004506#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004507 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
4508 (ssl->f_set_timer == NULL || ssl->f_get_timer == NULL)) {
4509 MBEDTLS_SSL_DEBUG_MSG(1, ("You must use "
4510 "mbedtls_ssl_set_timer_cb() for DTLS"));
4511 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Beckera817ea42020-10-20 15:20:23 +01004512 }
4513#endif /* MBEDTLS_SSL_PROTO_DTLS */
4514
Gilles Peskine449bd832023-01-11 14:50:10 +01004515 MBEDTLS_SSL_DEBUG_MSG(2, ("=> handshake"));
Paul Bakker1961b702013-01-25 14:49:24 +01004516
Hanno Beckera817ea42020-10-20 15:20:23 +01004517 /* Main handshake loop */
Gilles Peskine449bd832023-01-11 14:50:10 +01004518 while (ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER) {
4519 ret = mbedtls_ssl_handshake_step(ssl);
Paul Bakker1961b702013-01-25 14:49:24 +01004520
Gilles Peskine449bd832023-01-11 14:50:10 +01004521 if (ret != 0) {
Paul Bakker1961b702013-01-25 14:49:24 +01004522 break;
Gilles Peskine449bd832023-01-11 14:50:10 +01004523 }
Paul Bakker1961b702013-01-25 14:49:24 +01004524 }
4525
Gilles Peskine449bd832023-01-11 14:50:10 +01004526 MBEDTLS_SSL_DEBUG_MSG(2, ("<= handshake"));
Paul Bakker5121ce52009-01-03 21:22:43 +00004527
Gilles Peskine449bd832023-01-11 14:50:10 +01004528 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00004529}
4530
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004531#if defined(MBEDTLS_SSL_RENEGOTIATION)
4532#if defined(MBEDTLS_SSL_SRV_C)
Paul Bakker5121ce52009-01-03 21:22:43 +00004533/*
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004534 * Write HelloRequest to request renegotiation on server
Paul Bakker48916f92012-09-16 19:57:18 +00004535 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004536MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004537static int ssl_write_hello_request(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004538{
Janos Follath865b3eb2019-12-16 11:46:15 +00004539 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004540
Gilles Peskine449bd832023-01-11 14:50:10 +01004541 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write hello request"));
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004542
4543 ssl->out_msglen = 4;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004544 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
4545 ssl->out_msg[0] = MBEDTLS_SSL_HS_HELLO_REQUEST;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004546
Gilles Peskine449bd832023-01-11 14:50:10 +01004547 if ((ret = mbedtls_ssl_write_handshake_msg(ssl)) != 0) {
4548 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_handshake_msg", ret);
4549 return ret;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004550 }
4551
Gilles Peskine449bd832023-01-11 14:50:10 +01004552 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write hello request"));
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004553
Gilles Peskine449bd832023-01-11 14:50:10 +01004554 return 0;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004555}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004556#endif /* MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004557
4558/*
4559 * Actually renegotiate current connection, triggered by either:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004560 * - any side: calling mbedtls_ssl_renegotiate(),
4561 * - client: receiving a HelloRequest during mbedtls_ssl_read(),
4562 * - server: receiving any handshake message on server during mbedtls_ssl_read() after
Manuel Pégourié-Gonnard55e4ff22014-08-19 11:16:35 +02004563 * the initial handshake is completed.
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004564 * If the handshake doesn't complete due to waiting for I/O, it will continue
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004565 * during the next calls to mbedtls_ssl_renegotiate() or mbedtls_ssl_read() respectively.
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004566 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004567int mbedtls_ssl_start_renegotiation(mbedtls_ssl_context *ssl)
Paul Bakker48916f92012-09-16 19:57:18 +00004568{
Janos Follath865b3eb2019-12-16 11:46:15 +00004569 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker48916f92012-09-16 19:57:18 +00004570
Gilles Peskine449bd832023-01-11 14:50:10 +01004571 MBEDTLS_SSL_DEBUG_MSG(2, ("=> renegotiate"));
Paul Bakker48916f92012-09-16 19:57:18 +00004572
Gilles Peskine449bd832023-01-11 14:50:10 +01004573 if ((ret = ssl_handshake_init(ssl)) != 0) {
4574 return ret;
4575 }
Paul Bakker48916f92012-09-16 19:57:18 +00004576
Manuel Pégourié-Gonnard0557bd52014-08-19 19:18:39 +02004577 /* RFC 6347 4.2.2: "[...] the HelloRequest will have message_seq = 0 and
4578 * the ServerHello will have message_seq = 1" */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004579#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004580 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
4581 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING) {
4582 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02004583 ssl->handshake->out_msg_seq = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004584 } else {
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02004585 ssl->handshake->in_msg_seq = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004586 }
Manuel Pégourié-Gonnard0557bd52014-08-19 19:18:39 +02004587 }
4588#endif
4589
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004590 ssl->state = MBEDTLS_SSL_HELLO_REQUEST;
4591 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS;
Paul Bakker48916f92012-09-16 19:57:18 +00004592
Gilles Peskine449bd832023-01-11 14:50:10 +01004593 if ((ret = mbedtls_ssl_handshake(ssl)) != 0) {
4594 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_handshake", ret);
4595 return ret;
Paul Bakker48916f92012-09-16 19:57:18 +00004596 }
4597
Gilles Peskine449bd832023-01-11 14:50:10 +01004598 MBEDTLS_SSL_DEBUG_MSG(2, ("<= renegotiate"));
Paul Bakker48916f92012-09-16 19:57:18 +00004599
Gilles Peskine449bd832023-01-11 14:50:10 +01004600 return 0;
Paul Bakker48916f92012-09-16 19:57:18 +00004601}
4602
4603/*
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004604 * Renegotiate current connection on client,
4605 * or request renegotiation on server
4606 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004607int mbedtls_ssl_renegotiate(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004608{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004609 int ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004610
Gilles Peskine449bd832023-01-11 14:50:10 +01004611 if (ssl == NULL || ssl->conf == NULL) {
4612 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4613 }
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02004614
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004615#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004616 /* On server, just send the request */
Gilles Peskine449bd832023-01-11 14:50:10 +01004617 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
4618 if (mbedtls_ssl_is_handshake_over(ssl) == 0) {
4619 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4620 }
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004621
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004622 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_PENDING;
Manuel Pégourié-Gonnardf07f4212014-08-15 19:04:47 +02004623
4624 /* Did we already try/start sending HelloRequest? */
Gilles Peskine449bd832023-01-11 14:50:10 +01004625 if (ssl->out_left != 0) {
4626 return mbedtls_ssl_flush_output(ssl);
4627 }
Manuel Pégourié-Gonnardf07f4212014-08-15 19:04:47 +02004628
Gilles Peskine449bd832023-01-11 14:50:10 +01004629 return ssl_write_hello_request(ssl);
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004630 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004631#endif /* MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004632
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004633#if defined(MBEDTLS_SSL_CLI_C)
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004634 /*
4635 * On client, either start the renegotiation process or,
4636 * if already in progress, continue the handshake
4637 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004638 if (ssl->renego_status != MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS) {
4639 if (mbedtls_ssl_is_handshake_over(ssl) == 0) {
4640 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004641 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004642
4643 if ((ret = mbedtls_ssl_start_renegotiation(ssl)) != 0) {
4644 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_start_renegotiation", ret);
4645 return ret;
4646 }
4647 } else {
4648 if ((ret = mbedtls_ssl_handshake(ssl)) != 0) {
4649 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_handshake", ret);
4650 return ret;
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004651 }
4652 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004653#endif /* MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004654
Gilles Peskine449bd832023-01-11 14:50:10 +01004655 return ret;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004656}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004657#endif /* MBEDTLS_SSL_RENEGOTIATION */
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004658
Gilles Peskine449bd832023-01-11 14:50:10 +01004659void mbedtls_ssl_handshake_free(mbedtls_ssl_context *ssl)
Paul Bakker48916f92012-09-16 19:57:18 +00004660{
Gilles Peskine9b562d52018-04-25 20:32:43 +02004661 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
4662
Gilles Peskine449bd832023-01-11 14:50:10 +01004663 if (handshake == NULL) {
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004664 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01004665 }
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004666
Valerio Setti6f0441d2023-07-03 12:11:36 +02004667#if defined(MBEDTLS_PK_HAVE_ECC_KEYS)
Brett Warrene0edc842021-08-17 09:53:13 +01004668#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004669 if (ssl->handshake->group_list_heap_allocated) {
4670 mbedtls_free((void *) handshake->group_list);
4671 }
Brett Warrene0edc842021-08-17 09:53:13 +01004672 handshake->group_list = NULL;
4673#endif /* MBEDTLS_DEPRECATED_REMOVED */
Valerio Setti6f0441d2023-07-03 12:11:36 +02004674#endif /* MBEDTLS_PK_HAVE_ECC_KEYS */
Brett Warrene0edc842021-08-17 09:53:13 +01004675
Ronald Crone68ab4f2022-10-05 12:46:29 +02004676#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yuf017ee42022-01-12 15:49:48 +08004677#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004678 if (ssl->handshake->sig_algs_heap_allocated) {
4679 mbedtls_free((void *) handshake->sig_algs);
4680 }
Jerry Yuf017ee42022-01-12 15:49:48 +08004681 handshake->sig_algs = NULL;
4682#endif /* MBEDTLS_DEPRECATED_REMOVED */
Xiaofei Baic234ecf2022-02-08 09:59:23 +00004683#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004684 if (ssl->handshake->certificate_request_context) {
4685 mbedtls_free((void *) handshake->certificate_request_context);
Xiaofei Baic234ecf2022-02-08 09:59:23 +00004686 }
4687#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Ronald Crone68ab4f2022-10-05 12:46:29 +02004688#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Jerry Yuf017ee42022-01-12 15:49:48 +08004689
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02004690#if defined(MBEDTLS_SSL_ASYNC_PRIVATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01004691 if (ssl->conf->f_async_cancel != NULL && handshake->async_in_progress != 0) {
4692 ssl->conf->f_async_cancel(ssl);
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02004693 handshake->async_in_progress = 0;
4694 }
4695#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
4696
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01004697#if defined(MBEDTLS_MD_CAN_SHA256)
Andrzej Kurekeb342242019-01-29 09:14:33 -05004698#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01004699 psa_hash_abort(&handshake->fin_sha256_psa);
Andrzej Kurekeb342242019-01-29 09:14:33 -05004700#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01004701 mbedtls_md_free(&handshake->fin_sha256);
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02004702#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -05004703#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01004704#if defined(MBEDTLS_MD_CAN_SHA384)
Andrzej Kurekeb342242019-01-29 09:14:33 -05004705#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01004706 psa_hash_abort(&handshake->fin_sha384_psa);
Andrzej Kurekeb342242019-01-29 09:14:33 -05004707#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01004708 mbedtls_md_free(&handshake->fin_sha384);
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02004709#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -05004710#endif
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02004711
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004712#if defined(MBEDTLS_DHM_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004713 mbedtls_dhm_free(&handshake->dhm_ctx);
Paul Bakker48916f92012-09-16 19:57:18 +00004714#endif
Valerio Setti7aeec542023-07-05 18:57:21 +02004715#if !defined(MBEDTLS_USE_PSA_CRYPTO) && \
Valerio Setti6eb00542023-07-07 17:04:24 +02004716 defined(MBEDTLS_KEY_EXCHANGE_SOME_ECDH_OR_ECDHE_1_2_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004717 mbedtls_ecdh_free(&handshake->ecdh_ctx);
Paul Bakker61d113b2013-07-04 11:51:43 +02004718#endif
Valerio Setti02c25b52022-11-15 14:08:42 +01004719
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02004720#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Neil Armstrongca7d5062022-05-31 14:43:23 +02004721#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01004722 psa_pake_abort(&handshake->psa_pake_ctx);
Valerio Settieb3f7882022-12-08 18:42:58 +01004723 /*
4724 * Opaque keys are not stored in the handshake's data and it's the user
4725 * responsibility to destroy them. Clear ones, instead, are created by
4726 * the TLS library and should be destroyed at the same level
4727 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004728 if (!mbedtls_svc_key_id_is_null(handshake->psa_pake_password)) {
4729 psa_destroy_key(handshake->psa_pake_password);
Valerio Settieb3f7882022-12-08 18:42:58 +01004730 }
Neil Armstrongca7d5062022-05-31 14:43:23 +02004731 handshake->psa_pake_password = MBEDTLS_SVC_KEY_ID_INIT;
4732#else
Gilles Peskine449bd832023-01-11 14:50:10 +01004733 mbedtls_ecjpake_free(&handshake->ecjpake_ctx);
Neil Armstrongca7d5062022-05-31 14:43:23 +02004734#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard77c06462015-09-17 13:59:49 +02004735#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004736 mbedtls_free(handshake->ecjpake_cache);
Manuel Pégourié-Gonnard77c06462015-09-17 13:59:49 +02004737 handshake->ecjpake_cache = NULL;
4738 handshake->ecjpake_cache_len = 0;
4739#endif
Manuel Pégourié-Gonnard76cfd3f2015-09-15 12:10:54 +02004740#endif
Paul Bakker61d113b2013-07-04 11:51:43 +02004741
Valerio Setti7aeec542023-07-05 18:57:21 +02004742#if defined(MBEDTLS_KEY_EXCHANGE_SOME_ECDH_OR_ECDHE_ANY_ENABLED) || \
Valerio Setti45d56f32023-07-13 17:23:20 +02004743 defined(MBEDTLS_KEY_EXCHANGE_WITH_ECDSA_ANY_ENABLED) || \
Janos Follath4ae5c292016-02-10 11:27:43 +00004744 defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Paul Bakker9af723c2014-05-01 13:03:14 +02004745 /* explicit void pointer cast for buggy MS compiler */
Gilles Peskine449bd832023-01-11 14:50:10 +01004746 mbedtls_free((void *) handshake->curves_tls_id);
Manuel Pégourié-Gonnardd09453c2013-09-23 19:11:32 +02004747#endif
4748
Ronald Cron73fe8df2022-10-05 14:31:43 +02004749#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED)
Neil Armstrong501c9322022-05-03 09:35:09 +02004750#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01004751 if (!mbedtls_svc_key_id_is_null(ssl->handshake->psk_opaque)) {
Neil Armstrong501c9322022-05-03 09:35:09 +02004752 /* The maintenance of the external PSK key slot is the
4753 * user's responsibility. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004754 if (ssl->handshake->psk_opaque_is_internal) {
4755 psa_destroy_key(ssl->handshake->psk_opaque);
Neil Armstrong501c9322022-05-03 09:35:09 +02004756 ssl->handshake->psk_opaque_is_internal = 0;
4757 }
4758 ssl->handshake->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
4759 }
Neil Armstronge952a302022-05-03 10:22:14 +02004760#else
Gilles Peskine449bd832023-01-11 14:50:10 +01004761 if (handshake->psk != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01004762 mbedtls_zeroize_and_free(handshake->psk, handshake->psk_len);
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01004763 }
Neil Armstronge952a302022-05-03 10:22:14 +02004764#endif /* MBEDTLS_USE_PSA_CRYPTO */
Ronald Cron73fe8df2022-10-05 14:31:43 +02004765#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED */
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01004766
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004767#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
4768 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Manuel Pégourié-Gonnard83724542013-09-24 22:30:56 +02004769 /*
4770 * Free only the linked list wrapper, not the keys themselves
4771 * since the belong to the SNI callback
4772 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004773 ssl_key_cert_free(handshake->sni_key_cert);
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004774#endif /* MBEDTLS_X509_CRT_PARSE_C && MBEDTLS_SSL_SERVER_NAME_INDICATION */
Manuel Pégourié-Gonnard705fcca2013-09-23 20:04:20 +02004775
Gilles Peskineeccd8882020-03-10 12:19:08 +01004776#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004777 mbedtls_x509_crt_restart_free(&handshake->ecrs_ctx);
4778 if (handshake->ecrs_peer_cert != NULL) {
4779 mbedtls_x509_crt_free(handshake->ecrs_peer_cert);
4780 mbedtls_free(handshake->ecrs_peer_cert);
Hanno Becker3dad3112019-02-05 17:19:52 +00004781 }
Manuel Pégourié-Gonnard862cde52017-05-17 11:56:15 +02004782#endif
4783
Hanno Becker75173122019-02-06 16:18:31 +00004784#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
4785 !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01004786 mbedtls_pk_free(&handshake->peer_pubkey);
Hanno Becker75173122019-02-06 16:18:31 +00004787#endif /* MBEDTLS_X509_CRT_PARSE_C && !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
4788
XiaokangQian9b93c0d2022-02-09 06:02:25 +00004789#if defined(MBEDTLS_SSL_CLI_C) && \
Gilles Peskine449bd832023-01-11 14:50:10 +01004790 (defined(MBEDTLS_SSL_PROTO_DTLS) || defined(MBEDTLS_SSL_PROTO_TLS1_3))
4791 mbedtls_free(handshake->cookie);
XiaokangQian9b93c0d2022-02-09 06:02:25 +00004792#endif /* MBEDTLS_SSL_CLI_C &&
4793 ( MBEDTLS_SSL_PROTO_DTLS || MBEDTLS_SSL_PROTO_TLS1_3 ) */
XiaokangQian8499b6c2022-01-27 09:00:11 +00004794
4795#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004796 mbedtls_ssl_flight_free(handshake->flight);
4797 mbedtls_ssl_buffering_free(ssl);
XiaokangQian8499b6c2022-01-27 09:00:11 +00004798#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard74848812014-07-11 02:43:49 +02004799
Valerio Settiea59c432023-07-25 11:14:03 +02004800#if defined(MBEDTLS_KEY_EXCHANGE_SOME_XXDH_PSA_ANY_ENABLED)
Przemek Stekiel7ac93be2023-07-04 10:02:38 +02004801 if (handshake->xxdh_psa_privkey_is_external == 0) {
4802 psa_destroy_key(handshake->xxdh_psa_privkey);
Gilles Peskine449bd832023-01-11 14:50:10 +01004803 }
Valerio Settiea59c432023-07-25 11:14:03 +02004804#endif /* MBEDTLS_KEY_EXCHANGE_SOME_XXDH_PSA_ANY_ENABLED */
Hanno Becker4a63ed42019-01-08 11:39:35 +00004805
Ronald Cron6f135e12021-12-08 16:57:54 +01004806#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004807 mbedtls_ssl_transform_free(handshake->transform_handshake);
4808 mbedtls_free(handshake->transform_handshake);
Jerry Yu3d9b5902022-11-04 14:07:25 +08004809#if defined(MBEDTLS_SSL_EARLY_DATA)
Gilles Peskine449bd832023-01-11 14:50:10 +01004810 mbedtls_ssl_transform_free(handshake->transform_earlydata);
4811 mbedtls_free(handshake->transform_earlydata);
Jerry Yu3d9b5902022-11-04 14:07:25 +08004812#endif
Ronald Cron6f135e12021-12-08 16:57:54 +01004813#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yuba9c7272021-10-30 11:54:10 +08004814
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05004815
4816#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
4817 /* If the buffers are too big - reallocate. Because of the way Mbed TLS
4818 * processes datagrams and the fact that a datagram is allowed to have
4819 * several records in it, it is possible that the I/O buffers are not
4820 * empty at this stage */
Gilles Peskine449bd832023-01-11 14:50:10 +01004821 handle_buffer_resizing(ssl, 1, mbedtls_ssl_get_input_buflen(ssl),
4822 mbedtls_ssl_get_output_buflen(ssl));
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05004823#endif
Hanno Becker3aa186f2021-08-10 09:24:19 +01004824
Jerry Yuba9c7272021-10-30 11:54:10 +08004825 /* mbedtls_platform_zeroize MUST be last one in this function */
Gilles Peskine449bd832023-01-11 14:50:10 +01004826 mbedtls_platform_zeroize(handshake,
4827 sizeof(mbedtls_ssl_handshake_params));
Paul Bakker48916f92012-09-16 19:57:18 +00004828}
4829
Gilles Peskine449bd832023-01-11 14:50:10 +01004830void mbedtls_ssl_session_free(mbedtls_ssl_session *session)
Paul Bakker48916f92012-09-16 19:57:18 +00004831{
Gilles Peskine449bd832023-01-11 14:50:10 +01004832 if (session == NULL) {
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004833 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01004834 }
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004835
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004836#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004837 ssl_clear_peer_cert(session);
Paul Bakkered27a042013-04-18 22:46:23 +02004838#endif
Paul Bakker0a597072012-09-25 21:55:46 +00004839
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02004840#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
Xiaokang Qianbc663a02022-10-09 11:14:39 +00004841#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && \
4842 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01004843 mbedtls_free(session->hostname);
Xiaokang Qian281fd1b2022-09-20 11:35:41 +00004844#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01004845 mbedtls_free(session->ticket);
Paul Bakkera503a632013-08-14 13:48:06 +02004846#endif
Manuel Pégourié-Gonnard75d44012013-08-02 14:44:04 +02004847
Gilles Peskine449bd832023-01-11 14:50:10 +01004848 mbedtls_platform_zeroize(session, sizeof(mbedtls_ssl_session));
Paul Bakker48916f92012-09-16 19:57:18 +00004849}
4850
Manuel Pégourié-Gonnard5c0e3772019-07-23 16:13:17 +02004851#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004852
4853#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
4854#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID 1u
4855#else
4856#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID 0u
4857#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
4858
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004859#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT 1u
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004860
4861#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
4862#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY 1u
4863#else
4864#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY 0u
4865#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
4866
4867#if defined(MBEDTLS_SSL_ALPN)
4868#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN 1u
4869#else
4870#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN 0u
4871#endif /* MBEDTLS_SSL_ALPN */
4872
4873#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID_BIT 0
4874#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT_BIT 1
4875#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY_BIT 2
4876#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN_BIT 3
4877
4878#define SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG \
Gilles Peskine449bd832023-01-11 14:50:10 +01004879 ((uint32_t) ( \
4880 (SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID << \
4881 SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID_BIT) | \
4882 (SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT << \
4883 SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT_BIT) | \
4884 (SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY << \
4885 SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY_BIT) | \
4886 (SSL_SERIALIZED_CONTEXT_CONFIG_ALPN << SSL_SERIALIZED_CONTEXT_CONFIG_ALPN_BIT) | \
4887 0u))
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004888
Chien Wong4e9683e2023-12-28 17:07:43 +08004889static const unsigned char ssl_serialized_context_header[] = {
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004890 MBEDTLS_VERSION_MAJOR,
4891 MBEDTLS_VERSION_MINOR,
4892 MBEDTLS_VERSION_PATCH,
Gilles Peskine449bd832023-01-11 14:50:10 +01004893 MBEDTLS_BYTE_1(SSL_SERIALIZED_SESSION_CONFIG_BITFLAG),
4894 MBEDTLS_BYTE_0(SSL_SERIALIZED_SESSION_CONFIG_BITFLAG),
4895 MBEDTLS_BYTE_2(SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG),
4896 MBEDTLS_BYTE_1(SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG),
4897 MBEDTLS_BYTE_0(SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG),
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004898};
4899
Paul Bakker5121ce52009-01-03 21:22:43 +00004900/*
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004901 * Serialize a full SSL context
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02004902 *
4903 * The format of the serialized data is:
4904 * (in the presentation language of TLS, RFC 8446 section 3)
4905 *
4906 * // header
4907 * opaque mbedtls_version[3]; // major, minor, patch
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004908 * opaque context_format[5]; // version-specific field determining
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02004909 * // the format of the remaining
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004910 * // serialized data.
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004911 * Note: When updating the format, remember to keep these
4912 * version+format bytes. (We may make their size part of the API.)
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02004913 *
4914 * // session sub-structure
4915 * opaque session<1..2^32-1>; // see mbedtls_ssl_session_save()
4916 * // transform sub-structure
4917 * uint8 random[64]; // ServerHello.random+ClientHello.random
4918 * uint8 in_cid<0..2^8-1> // Connection ID: expected incoming value
4919 * uint8 out_cid<0..2^8-1> // Connection ID: outgoing value to use
4920 * // fields from ssl_context
4921 * uint32 badmac_seen; // DTLS: number of records with failing MAC
4922 * uint64 in_window_top; // DTLS: last validated record seq_num
4923 * uint64 in_window; // DTLS: bitmask for replay protection
4924 * uint8 disable_datagram_packing; // DTLS: only one record per datagram
4925 * uint64 cur_out_ctr; // Record layer: outgoing sequence number
4926 * uint16 mtu; // DTLS: path mtu (max outgoing fragment size)
4927 * uint8 alpn_chosen<0..2^8-1> // ALPN: negotiated application protocol
4928 *
4929 * Note that many fields of the ssl_context or sub-structures are not
4930 * serialized, as they fall in one of the following categories:
4931 *
4932 * 1. forced value (eg in_left must be 0)
4933 * 2. pointer to dynamically-allocated memory (eg session, transform)
4934 * 3. value can be re-derived from other data (eg session keys from MS)
4935 * 4. value was temporary (eg content of input buffer)
4936 * 5. value will be provided by the user again (eg I/O callbacks and context)
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004937 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004938int mbedtls_ssl_context_save(mbedtls_ssl_context *ssl,
4939 unsigned char *buf,
4940 size_t buf_len,
4941 size_t *olen)
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004942{
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004943 unsigned char *p = buf;
4944 size_t used = 0;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004945 size_t session_len;
4946 int ret = 0;
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004947
Manuel Pégourié-Gonnard1aaf6692019-07-10 14:14:05 +02004948 /*
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004949 * Enforce usage restrictions, see "return BAD_INPUT_DATA" in
4950 * this function's documentation.
4951 *
4952 * These are due to assumptions/limitations in the implementation. Some of
4953 * them are likely to stay (no handshake in progress) some might go away
4954 * (only DTLS) but are currently used to simplify the implementation.
Manuel Pégourié-Gonnard1aaf6692019-07-10 14:14:05 +02004955 */
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004956 /* The initial handshake must be over */
Gilles Peskine449bd832023-01-11 14:50:10 +01004957 if (mbedtls_ssl_is_handshake_over(ssl) == 0) {
4958 MBEDTLS_SSL_DEBUG_MSG(1, ("Initial handshake isn't over"));
4959 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004960 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004961 if (ssl->handshake != NULL) {
4962 MBEDTLS_SSL_DEBUG_MSG(1, ("Handshake isn't completed"));
4963 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004964 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004965 /* Double-check that sub-structures are indeed ready */
Gilles Peskine449bd832023-01-11 14:50:10 +01004966 if (ssl->transform == NULL || ssl->session == NULL) {
4967 MBEDTLS_SSL_DEBUG_MSG(1, ("Serialised structures aren't ready"));
4968 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004969 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004970 /* There must be no pending incoming or outgoing data */
Gilles Peskine449bd832023-01-11 14:50:10 +01004971 if (mbedtls_ssl_check_pending(ssl) != 0) {
4972 MBEDTLS_SSL_DEBUG_MSG(1, ("There is pending incoming data"));
4973 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004974 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004975 if (ssl->out_left != 0) {
4976 MBEDTLS_SSL_DEBUG_MSG(1, ("There is pending outgoing data"));
4977 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004978 }
Dave Rodgman556e8a32022-12-06 16:31:25 +00004979 /* Protocol must be DTLS, not TLS */
Gilles Peskine449bd832023-01-11 14:50:10 +01004980 if (ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
4981 MBEDTLS_SSL_DEBUG_MSG(1, ("Only DTLS is supported"));
4982 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004983 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004984 /* Version must be 1.2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004985 if (ssl->tls_version != MBEDTLS_SSL_VERSION_TLS1_2) {
4986 MBEDTLS_SSL_DEBUG_MSG(1, ("Only version 1.2 supported"));
4987 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004988 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004989 /* We must be using an AEAD ciphersuite */
Gilles Peskine449bd832023-01-11 14:50:10 +01004990 if (mbedtls_ssl_transform_uses_aead(ssl->transform) != 1) {
4991 MBEDTLS_SSL_DEBUG_MSG(1, ("Only AEAD ciphersuites supported"));
4992 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004993 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004994 /* Renegotiation must not be enabled */
4995#if defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01004996 if (ssl->conf->disable_renegotiation != MBEDTLS_SSL_RENEGOTIATION_DISABLED) {
4997 MBEDTLS_SSL_DEBUG_MSG(1, ("Renegotiation must not be enabled"));
4998 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004999 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02005000#endif
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005001
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005002 /*
5003 * Version and format identifier
5004 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005005 used += sizeof(ssl_serialized_context_header);
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005006
Gilles Peskine449bd832023-01-11 14:50:10 +01005007 if (used <= buf_len) {
5008 memcpy(p, ssl_serialized_context_header,
5009 sizeof(ssl_serialized_context_header));
5010 p += sizeof(ssl_serialized_context_header);
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005011 }
5012
5013 /*
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005014 * Session (length + data)
5015 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005016 ret = ssl_session_save(ssl->session, 1, NULL, 0, &session_len);
5017 if (ret != MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL) {
5018 return ret;
5019 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005020
5021 used += 4 + session_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01005022 if (used <= buf_len) {
5023 MBEDTLS_PUT_UINT32_BE(session_len, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01005024 p += 4;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005025
Gilles Peskine449bd832023-01-11 14:50:10 +01005026 ret = ssl_session_save(ssl->session, 1,
5027 p, session_len, &session_len);
5028 if (ret != 0) {
5029 return ret;
5030 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005031
5032 p += session_len;
5033 }
5034
5035 /*
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005036 * Transform
5037 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005038 used += sizeof(ssl->transform->randbytes);
5039 if (used <= buf_len) {
5040 memcpy(p, ssl->transform->randbytes,
5041 sizeof(ssl->transform->randbytes));
5042 p += sizeof(ssl->transform->randbytes);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005043 }
5044
5045#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Dave Rodgmanc37ad442023-11-03 23:36:06 +00005046 used += 2U + ssl->transform->in_cid_len + ssl->transform->out_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01005047 if (used <= buf_len) {
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005048 *p++ = ssl->transform->in_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01005049 memcpy(p, ssl->transform->in_cid, ssl->transform->in_cid_len);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005050 p += ssl->transform->in_cid_len;
5051
5052 *p++ = ssl->transform->out_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01005053 memcpy(p, ssl->transform->out_cid, ssl->transform->out_cid_len);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005054 p += ssl->transform->out_cid_len;
5055 }
5056#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
5057
5058 /*
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005059 * Saved fields from top-level ssl_context structure
5060 */
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005061 used += 4;
Gilles Peskine449bd832023-01-11 14:50:10 +01005062 if (used <= buf_len) {
5063 MBEDTLS_PUT_UINT32_BE(ssl->badmac_seen, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01005064 p += 4;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005065 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005066
5067#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
5068 used += 16;
Gilles Peskine449bd832023-01-11 14:50:10 +01005069 if (used <= buf_len) {
5070 MBEDTLS_PUT_UINT64_BE(ssl->in_window_top, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01005071 p += 8;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005072
Gilles Peskine449bd832023-01-11 14:50:10 +01005073 MBEDTLS_PUT_UINT64_BE(ssl->in_window, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01005074 p += 8;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005075 }
5076#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
5077
5078#if defined(MBEDTLS_SSL_PROTO_DTLS)
5079 used += 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01005080 if (used <= buf_len) {
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005081 *p++ = ssl->disable_datagram_packing;
5082 }
5083#endif /* MBEDTLS_SSL_PROTO_DTLS */
5084
Jerry Yuae0b2e22021-10-08 15:21:19 +08005085 used += MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Gilles Peskine449bd832023-01-11 14:50:10 +01005086 if (used <= buf_len) {
5087 memcpy(p, ssl->cur_out_ctr, MBEDTLS_SSL_SEQUENCE_NUMBER_LEN);
Jerry Yuae0b2e22021-10-08 15:21:19 +08005088 p += MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005089 }
5090
5091#if defined(MBEDTLS_SSL_PROTO_DTLS)
5092 used += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01005093 if (used <= buf_len) {
5094 MBEDTLS_PUT_UINT16_BE(ssl->mtu, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01005095 p += 2;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005096 }
5097#endif /* MBEDTLS_SSL_PROTO_DTLS */
5098
5099#if defined(MBEDTLS_SSL_ALPN)
5100 {
5101 const uint8_t alpn_len = ssl->alpn_chosen
Gilles Peskine449bd832023-01-11 14:50:10 +01005102 ? (uint8_t) strlen(ssl->alpn_chosen)
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005103 : 0;
5104
5105 used += 1 + alpn_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01005106 if (used <= buf_len) {
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005107 *p++ = alpn_len;
5108
Gilles Peskine449bd832023-01-11 14:50:10 +01005109 if (ssl->alpn_chosen != NULL) {
5110 memcpy(p, ssl->alpn_chosen, alpn_len);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005111 p += alpn_len;
5112 }
5113 }
5114 }
5115#endif /* MBEDTLS_SSL_ALPN */
5116
5117 /*
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005118 * Done
5119 */
5120 *olen = used;
5121
Gilles Peskine449bd832023-01-11 14:50:10 +01005122 if (used > buf_len) {
5123 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
5124 }
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005125
Gilles Peskine449bd832023-01-11 14:50:10 +01005126 MBEDTLS_SSL_DEBUG_BUF(4, "saved context", buf, used);
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005127
Gilles Peskine449bd832023-01-11 14:50:10 +01005128 return mbedtls_ssl_session_reset_int(ssl, 0);
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005129}
5130
5131/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02005132 * Deserialize context, see mbedtls_ssl_context_save() for format.
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005133 *
5134 * This internal version is wrapped by a public function that cleans up in
5135 * case of error.
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005136 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005137MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01005138static int ssl_context_load(mbedtls_ssl_context *ssl,
5139 const unsigned char *buf,
5140 size_t len)
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005141{
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005142 const unsigned char *p = buf;
5143 const unsigned char * const end = buf + len;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005144 size_t session_len;
Janos Follath865b3eb2019-12-16 11:46:15 +00005145 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04005146#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Andrzej Kurek894edde2022-09-29 06:31:14 -04005147 tls_prf_fn prf_func = NULL;
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04005148#endif
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005149
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02005150 /*
5151 * The context should have been freshly setup or reset.
5152 * Give the user an error in case of obvious misuse.
Manuel Pégourié-Gonnard4ca930f2019-07-26 16:31:53 +02005153 * (Checking session is useful because it won't be NULL if we're
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02005154 * renegotiating, or if the user mistakenly loaded a session first.)
5155 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005156 if (ssl->state != MBEDTLS_SSL_HELLO_REQUEST ||
5157 ssl->session != NULL) {
5158 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02005159 }
5160
5161 /*
5162 * We can't check that the config matches the initial one, but we can at
5163 * least check it matches the requirements for serializing.
5164 */
Dave Rodgmane99b24d2023-09-14 15:45:03 +01005165 if (
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02005166#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard9a96fd72019-07-23 17:11:24 +02005167 ssl->conf->disable_renegotiation != MBEDTLS_SSL_RENEGOTIATION_DISABLED ||
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02005168#endif
Dave Rodgmane99b24d2023-09-14 15:45:03 +01005169 ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM ||
5170 ssl->conf->max_tls_version < MBEDTLS_SSL_VERSION_TLS1_2 ||
5171 ssl->conf->min_tls_version > MBEDTLS_SSL_VERSION_TLS1_2
5172 ) {
Gilles Peskine449bd832023-01-11 14:50:10 +01005173 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02005174 }
5175
Gilles Peskine449bd832023-01-11 14:50:10 +01005176 MBEDTLS_SSL_DEBUG_BUF(4, "context to load", buf, len);
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005177
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005178 /*
5179 * Check version identifier
5180 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005181 if ((size_t) (end - p) < sizeof(ssl_serialized_context_header)) {
5182 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005183 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005184
5185 if (memcmp(p, ssl_serialized_context_header,
5186 sizeof(ssl_serialized_context_header)) != 0) {
5187 return MBEDTLS_ERR_SSL_VERSION_MISMATCH;
5188 }
5189 p += sizeof(ssl_serialized_context_header);
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005190
5191 /*
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005192 * Session
5193 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005194 if ((size_t) (end - p) < 4) {
5195 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5196 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005197
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01005198 session_len = MBEDTLS_GET_UINT32_BE(p, 0);
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005199 p += 4;
5200
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02005201 /* This has been allocated by ssl_handshake_init(), called by
Hanno Becker43aefe22020-02-05 10:44:56 +00005202 * by either mbedtls_ssl_session_reset_int() or mbedtls_ssl_setup(). */
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02005203 ssl->session = ssl->session_negotiate;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005204 ssl->session_in = ssl->session;
5205 ssl->session_out = ssl->session;
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02005206 ssl->session_negotiate = NULL;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005207
Gilles Peskine449bd832023-01-11 14:50:10 +01005208 if ((size_t) (end - p) < session_len) {
5209 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5210 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005211
Gilles Peskine449bd832023-01-11 14:50:10 +01005212 ret = ssl_session_load(ssl->session, 1, p, session_len);
5213 if (ret != 0) {
5214 mbedtls_ssl_session_free(ssl->session);
5215 return ret;
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02005216 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005217
5218 p += session_len;
5219
5220 /*
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005221 * Transform
5222 */
5223
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02005224 /* This has been allocated by ssl_handshake_init(), called by
Hanno Becker43aefe22020-02-05 10:44:56 +00005225 * by either mbedtls_ssl_session_reset_int() or mbedtls_ssl_setup(). */
Jerry Yu2e199812022-12-01 18:57:19 +08005226#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02005227 ssl->transform = ssl->transform_negotiate;
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005228 ssl->transform_in = ssl->transform;
5229 ssl->transform_out = ssl->transform;
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02005230 ssl->transform_negotiate = NULL;
Jerry Yu2e199812022-12-01 18:57:19 +08005231#endif
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005232
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04005233#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005234 prf_func = ssl_tls12prf_from_cs(ssl->session->ciphersuite);
5235 if (prf_func == NULL) {
5236 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5237 }
Andrzej Kurek894edde2022-09-29 06:31:14 -04005238
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005239 /* Read random bytes and populate structure */
Gilles Peskine449bd832023-01-11 14:50:10 +01005240 if ((size_t) (end - p) < sizeof(ssl->transform->randbytes)) {
5241 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5242 }
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04005243
Gilles Peskine449bd832023-01-11 14:50:10 +01005244 ret = ssl_tls12_populate_transform(ssl->transform,
5245 ssl->session->ciphersuite,
5246 ssl->session->master,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02005247#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01005248 ssl->session->encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02005249#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01005250 prf_func,
5251 p, /* currently pointing to randbytes */
5252 MBEDTLS_SSL_VERSION_TLS1_2, /* (D)TLS 1.2 is forced */
5253 ssl->conf->endpoint,
5254 ssl);
5255 if (ret != 0) {
5256 return ret;
5257 }
Jerry Yu840fbb22022-02-17 14:59:29 +08005258#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005259 p += sizeof(ssl->transform->randbytes);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005260
5261#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
5262 /* Read connection IDs and store them */
Gilles Peskine449bd832023-01-11 14:50:10 +01005263 if ((size_t) (end - p) < 1) {
5264 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5265 }
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005266
5267 ssl->transform->in_cid_len = *p++;
5268
Gilles Peskine449bd832023-01-11 14:50:10 +01005269 if ((size_t) (end - p) < ssl->transform->in_cid_len + 1u) {
5270 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5271 }
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005272
Gilles Peskine449bd832023-01-11 14:50:10 +01005273 memcpy(ssl->transform->in_cid, p, ssl->transform->in_cid_len);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005274 p += ssl->transform->in_cid_len;
5275
5276 ssl->transform->out_cid_len = *p++;
5277
Gilles Peskine449bd832023-01-11 14:50:10 +01005278 if ((size_t) (end - p) < ssl->transform->out_cid_len) {
5279 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5280 }
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005281
Gilles Peskine449bd832023-01-11 14:50:10 +01005282 memcpy(ssl->transform->out_cid, p, ssl->transform->out_cid_len);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005283 p += ssl->transform->out_cid_len;
5284#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
5285
5286 /*
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005287 * Saved fields from top-level ssl_context structure
5288 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005289 if ((size_t) (end - p) < 4) {
5290 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5291 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005292
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01005293 ssl->badmac_seen = MBEDTLS_GET_UINT32_BE(p, 0);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005294 p += 4;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005295
5296#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Gilles Peskine449bd832023-01-11 14:50:10 +01005297 if ((size_t) (end - p) < 16) {
5298 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5299 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005300
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01005301 ssl->in_window_top = MBEDTLS_GET_UINT64_BE(p, 0);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005302 p += 8;
5303
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01005304 ssl->in_window = MBEDTLS_GET_UINT64_BE(p, 0);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005305 p += 8;
5306#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
5307
5308#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005309 if ((size_t) (end - p) < 1) {
5310 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5311 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005312
5313 ssl->disable_datagram_packing = *p++;
5314#endif /* MBEDTLS_SSL_PROTO_DTLS */
5315
Gilles Peskine449bd832023-01-11 14:50:10 +01005316 if ((size_t) (end - p) < sizeof(ssl->cur_out_ctr)) {
5317 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5318 }
5319 memcpy(ssl->cur_out_ctr, p, sizeof(ssl->cur_out_ctr));
5320 p += sizeof(ssl->cur_out_ctr);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005321
5322#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005323 if ((size_t) (end - p) < 2) {
5324 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5325 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005326
Dave Rodgmana3d0f612023-11-03 23:34:02 +00005327 ssl->mtu = MBEDTLS_GET_UINT16_BE(p, 0);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005328 p += 2;
5329#endif /* MBEDTLS_SSL_PROTO_DTLS */
5330
5331#if defined(MBEDTLS_SSL_ALPN)
5332 {
5333 uint8_t alpn_len;
5334 const char **cur;
5335
Gilles Peskine449bd832023-01-11 14:50:10 +01005336 if ((size_t) (end - p) < 1) {
5337 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5338 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005339
5340 alpn_len = *p++;
5341
Gilles Peskine449bd832023-01-11 14:50:10 +01005342 if (alpn_len != 0 && ssl->conf->alpn_list != NULL) {
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005343 /* alpn_chosen should point to an item in the configured list */
Gilles Peskine449bd832023-01-11 14:50:10 +01005344 for (cur = ssl->conf->alpn_list; *cur != NULL; cur++) {
5345 if (strlen(*cur) == alpn_len &&
5346 memcmp(p, cur, alpn_len) == 0) {
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005347 ssl->alpn_chosen = *cur;
5348 break;
5349 }
5350 }
5351 }
5352
5353 /* can only happen on conf mismatch */
Gilles Peskine449bd832023-01-11 14:50:10 +01005354 if (alpn_len != 0 && ssl->alpn_chosen == NULL) {
5355 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5356 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005357
5358 p += alpn_len;
5359 }
5360#endif /* MBEDTLS_SSL_ALPN */
5361
5362 /*
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02005363 * Forced fields from top-level ssl_context structure
5364 *
5365 * Most of them already set to the correct value by mbedtls_ssl_init() and
5366 * mbedtls_ssl_reset(), so we only need to set the remaining ones.
5367 */
5368 ssl->state = MBEDTLS_SSL_HANDSHAKE_OVER;
Glenn Strauss60bfe602022-03-14 19:04:24 -04005369 ssl->tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02005370
Hanno Becker361b10d2019-08-30 10:42:49 +01005371 /* Adjust pointers for header fields of outgoing records to
5372 * the given transform, accounting for explicit IV and CID. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005373 mbedtls_ssl_update_out_pointers(ssl, ssl->transform);
Hanno Becker361b10d2019-08-30 10:42:49 +01005374
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02005375#if defined(MBEDTLS_SSL_PROTO_DTLS)
5376 ssl->in_epoch = 1;
5377#endif
5378
5379 /* mbedtls_ssl_reset() leaves the handshake sub-structure allocated,
5380 * which we don't want - otherwise we'd end up freeing the wrong transform
Hanno Beckerce5f5fd2020-02-05 10:47:44 +00005381 * by calling mbedtls_ssl_handshake_wrapup_free_hs_transform()
5382 * inappropriately. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005383 if (ssl->handshake != NULL) {
5384 mbedtls_ssl_handshake_free(ssl);
5385 mbedtls_free(ssl->handshake);
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02005386 ssl->handshake = NULL;
5387 }
5388
5389 /*
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005390 * Done - should have consumed entire buffer
5391 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005392 if (p != end) {
5393 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5394 }
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005395
Gilles Peskine449bd832023-01-11 14:50:10 +01005396 return 0;
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005397}
5398
5399/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02005400 * Deserialize context: public wrapper for error cleaning
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005401 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005402int mbedtls_ssl_context_load(mbedtls_ssl_context *context,
5403 const unsigned char *buf,
5404 size_t len)
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005405{
Gilles Peskine449bd832023-01-11 14:50:10 +01005406 int ret = ssl_context_load(context, buf, len);
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005407
Gilles Peskine449bd832023-01-11 14:50:10 +01005408 if (ret != 0) {
5409 mbedtls_ssl_free(context);
5410 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005411
Gilles Peskine449bd832023-01-11 14:50:10 +01005412 return ret;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005413}
Manuel Pégourié-Gonnard5c0e3772019-07-23 16:13:17 +02005414#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005415
5416/*
Paul Bakker5121ce52009-01-03 21:22:43 +00005417 * Free an SSL context
5418 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005419void mbedtls_ssl_free(mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00005420{
Gilles Peskine449bd832023-01-11 14:50:10 +01005421 if (ssl == NULL) {
Paul Bakkeraccaffe2014-06-26 13:37:14 +02005422 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01005423 }
Paul Bakkeraccaffe2014-06-26 13:37:14 +02005424
Gilles Peskine449bd832023-01-11 14:50:10 +01005425 MBEDTLS_SSL_DEBUG_MSG(2, ("=> free"));
Paul Bakker5121ce52009-01-03 21:22:43 +00005426
Gilles Peskine449bd832023-01-11 14:50:10 +01005427 if (ssl->out_buf != NULL) {
sander-visserb8aa2072020-05-06 22:05:13 +02005428#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
5429 size_t out_buf_len = ssl->out_buf_len;
5430#else
5431 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
5432#endif
5433
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005434 mbedtls_zeroize_and_free(ssl->out_buf, out_buf_len);
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05005435 ssl->out_buf = NULL;
Paul Bakker5121ce52009-01-03 21:22:43 +00005436 }
5437
Gilles Peskine449bd832023-01-11 14:50:10 +01005438 if (ssl->in_buf != NULL) {
sander-visserb8aa2072020-05-06 22:05:13 +02005439#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
5440 size_t in_buf_len = ssl->in_buf_len;
5441#else
5442 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
5443#endif
5444
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005445 mbedtls_zeroize_and_free(ssl->in_buf, in_buf_len);
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05005446 ssl->in_buf = NULL;
Paul Bakker5121ce52009-01-03 21:22:43 +00005447 }
5448
Gilles Peskine449bd832023-01-11 14:50:10 +01005449 if (ssl->transform) {
5450 mbedtls_ssl_transform_free(ssl->transform);
5451 mbedtls_free(ssl->transform);
Paul Bakker48916f92012-09-16 19:57:18 +00005452 }
5453
Gilles Peskine449bd832023-01-11 14:50:10 +01005454 if (ssl->handshake) {
5455 mbedtls_ssl_handshake_free(ssl);
5456 mbedtls_free(ssl->handshake);
Jerry Yu2e199812022-12-01 18:57:19 +08005457
5458#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005459 mbedtls_ssl_transform_free(ssl->transform_negotiate);
5460 mbedtls_free(ssl->transform_negotiate);
Jerry Yu2e199812022-12-01 18:57:19 +08005461#endif
5462
Gilles Peskine449bd832023-01-11 14:50:10 +01005463 mbedtls_ssl_session_free(ssl->session_negotiate);
5464 mbedtls_free(ssl->session_negotiate);
Paul Bakker48916f92012-09-16 19:57:18 +00005465 }
5466
Ronald Cron6f135e12021-12-08 16:57:54 +01005467#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01005468 mbedtls_ssl_transform_free(ssl->transform_application);
5469 mbedtls_free(ssl->transform_application);
Ronald Cron6f135e12021-12-08 16:57:54 +01005470#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker3aa186f2021-08-10 09:24:19 +01005471
Gilles Peskine449bd832023-01-11 14:50:10 +01005472 if (ssl->session) {
5473 mbedtls_ssl_session_free(ssl->session);
5474 mbedtls_free(ssl->session);
Paul Bakkerc0463502013-02-14 11:19:38 +01005475 }
5476
Manuel Pégourié-Gonnard55fab2d2015-05-11 16:15:19 +02005477#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005478 if (ssl->hostname != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005479 mbedtls_zeroize_and_free(ssl->hostname, strlen(ssl->hostname));
Paul Bakker5121ce52009-01-03 21:22:43 +00005480 }
Paul Bakker0be444a2013-08-27 21:55:01 +02005481#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00005482
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02005483#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005484 mbedtls_free(ssl->cli_id);
Manuel Pégourié-Gonnard43c02182014-07-22 17:32:01 +02005485#endif
5486
Gilles Peskine449bd832023-01-11 14:50:10 +01005487 MBEDTLS_SSL_DEBUG_MSG(2, ("<= free"));
Paul Bakker2da561c2009-02-05 18:00:28 +00005488
Paul Bakker86f04f42013-02-14 11:20:09 +01005489 /* Actually clear after last debug message */
Gilles Peskine449bd832023-01-11 14:50:10 +01005490 mbedtls_platform_zeroize(ssl, sizeof(mbedtls_ssl_context));
Paul Bakker5121ce52009-01-03 21:22:43 +00005491}
5492
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005493/*
Shaun Case8b0ecbc2021-12-20 21:14:10 -08005494 * Initialize mbedtls_ssl_config
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005495 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005496void mbedtls_ssl_config_init(mbedtls_ssl_config *conf)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005497{
Gilles Peskine449bd832023-01-11 14:50:10 +01005498 memset(conf, 0, sizeof(mbedtls_ssl_config));
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005499}
5500
Gilles Peskineae270bf2021-06-02 00:05:29 +02005501/* The selection should be the same as mbedtls_x509_crt_profile_default in
5502 * x509_crt.c, plus Montgomery curves for ECDHE. Here, the order matters:
Gilles Peskineb1940a72021-06-02 15:18:12 +02005503 * curves with a lower resource usage come first.
Gilles Peskineae270bf2021-06-02 00:05:29 +02005504 * See the documentation of mbedtls_ssl_conf_curves() for what we promise
Gilles Peskineb1940a72021-06-02 15:18:12 +02005505 * about this list.
5506 */
Chien Wong4e9683e2023-12-28 17:07:43 +08005507static const uint16_t ssl_preset_default_groups[] = {
Valerio Settidb6b4db2023-09-01 09:20:51 +02005508#if defined(MBEDTLS_ECP_HAVE_CURVE25519)
Brett Warrene0edc842021-08-17 09:53:13 +01005509 MBEDTLS_SSL_IANA_TLS_GROUP_X25519,
Gilles Peskineae270bf2021-06-02 00:05:29 +02005510#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005511#if defined(MBEDTLS_ECP_HAVE_SECP256R1)
Brett Warrene0edc842021-08-17 09:53:13 +01005512 MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1,
Gilles Peskineae270bf2021-06-02 00:05:29 +02005513#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005514#if defined(MBEDTLS_ECP_HAVE_SECP384R1)
Brett Warrene0edc842021-08-17 09:53:13 +01005515 MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02005516#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005517#if defined(MBEDTLS_ECP_HAVE_CURVE448)
Brett Warrene0edc842021-08-17 09:53:13 +01005518 MBEDTLS_SSL_IANA_TLS_GROUP_X448,
Gilles Peskineb1940a72021-06-02 15:18:12 +02005519#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005520#if defined(MBEDTLS_ECP_HAVE_SECP521R1)
Brett Warrene0edc842021-08-17 09:53:13 +01005521 MBEDTLS_SSL_IANA_TLS_GROUP_SECP521R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02005522#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005523#if defined(MBEDTLS_ECP_HAVE_BP256R1)
Brett Warrene0edc842021-08-17 09:53:13 +01005524 MBEDTLS_SSL_IANA_TLS_GROUP_BP256R1,
Gilles Peskineae270bf2021-06-02 00:05:29 +02005525#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005526#if defined(MBEDTLS_ECP_HAVE_BP384R1)
Brett Warrene0edc842021-08-17 09:53:13 +01005527 MBEDTLS_SSL_IANA_TLS_GROUP_BP384R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02005528#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005529#if defined(MBEDTLS_ECP_HAVE_BP512R1)
Brett Warrene0edc842021-08-17 09:53:13 +01005530 MBEDTLS_SSL_IANA_TLS_GROUP_BP512R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02005531#endif
Przemek Stekiel316c19e2023-05-31 15:25:11 +02005532#if defined(PSA_WANT_ALG_FFDH)
Przemek Stekiel383f4712022-12-12 14:48:57 +01005533 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE2048,
5534 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE3072,
5535 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE4096,
5536 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE6144,
5537 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE8192,
5538#endif
Brett Warrene0edc842021-08-17 09:53:13 +01005539 MBEDTLS_SSL_IANA_TLS_GROUP_NONE
Gilles Peskineae270bf2021-06-02 00:05:29 +02005540};
Gilles Peskineae270bf2021-06-02 00:05:29 +02005541
Alexey Tsvetkov2ca34372022-06-07 10:21:05 +03005542static const int ssl_preset_suiteb_ciphersuites[] = {
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005543 MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256,
5544 MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384,
5545 0
5546};
5547
Ronald Crone68ab4f2022-10-05 12:46:29 +02005548#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Hanno Becker9c6aa7b2021-08-10 13:50:43 +01005549
Jerry Yu909df7b2022-01-22 11:56:27 +08005550/* NOTICE:
Jerry Yu0b994b82022-01-25 17:22:12 +08005551 * For ssl_preset_*_sig_algs and ssl_tls12_preset_*_sig_algs, the following
Jerry Yu370e1462022-01-25 10:36:53 +08005552 * rules SHOULD be upheld.
5553 * - No duplicate entries.
5554 * - But if there is a good reason, do not change the order of the algorithms.
Jerry Yu09a99fc2022-07-28 14:22:17 +08005555 * - ssl_tls12_preset* is for TLS 1.2 use only.
Jerry Yu370e1462022-01-25 10:36:53 +08005556 * - ssl_preset_* is for TLS 1.3 only or hybrid TLS 1.3/1.2 handshakes.
Jerry Yu1a8b4812022-01-20 17:56:50 +08005557 */
Chien Wong4e9683e2023-12-28 17:07:43 +08005558static const uint16_t ssl_preset_default_sig_algs[] = {
Jerry Yu1a8b4812022-01-20 17:56:50 +08005559
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005560#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005561 defined(MBEDTLS_MD_CAN_SHA256) && \
Valerio Setticf29c5d2023-09-01 09:03:41 +02005562 defined(PSA_WANT_ECC_SECP_R1_256)
Jerry Yued5e9f42022-01-26 11:21:34 +08005563 MBEDTLS_TLS1_3_SIG_ECDSA_SECP256R1_SHA256,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005564 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256)
5565#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08005566
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005567#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005568 defined(MBEDTLS_MD_CAN_SHA384) && \
Valerio Setticf29c5d2023-09-01 09:03:41 +02005569 defined(PSA_WANT_ECC_SECP_R1_384)
Jerry Yu909df7b2022-01-22 11:56:27 +08005570 MBEDTLS_TLS1_3_SIG_ECDSA_SECP384R1_SHA384,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005571 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384)
5572#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08005573
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005574#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005575 defined(MBEDTLS_MD_CAN_SHA512) && \
Valerio Setticf29c5d2023-09-01 09:03:41 +02005576 defined(PSA_WANT_ECC_SECP_R1_521)
Jerry Yued5e9f42022-01-26 11:21:34 +08005577 MBEDTLS_TLS1_3_SIG_ECDSA_SECP521R1_SHA512,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005578 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA512)
5579#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08005580
Yanray Wang1136fad2023-11-22 16:54:31 +08005581#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && defined(MBEDTLS_MD_CAN_SHA512)
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005582 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA512,
Yanray Wang1136fad2023-11-22 16:54:31 +08005583#endif
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005584
Yanray Wang1136fad2023-11-22 16:54:31 +08005585#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && defined(MBEDTLS_MD_CAN_SHA384)
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005586 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA384,
Yanray Wang1136fad2023-11-22 16:54:31 +08005587#endif
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005588
Yanray Wang1136fad2023-11-22 16:54:31 +08005589#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && defined(MBEDTLS_MD_CAN_SHA256)
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005590 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256,
Yanray Wang1136fad2023-11-22 16:54:31 +08005591#endif
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005592
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005593#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_MD_CAN_SHA512)
Jerry Yu693a47a2022-06-23 14:02:28 +08005594 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA512,
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005595#endif /* MBEDTLS_RSA_C && MBEDTLS_MD_CAN_SHA512 */
Jerry Yu693a47a2022-06-23 14:02:28 +08005596
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005597#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_MD_CAN_SHA384)
Jerry Yu693a47a2022-06-23 14:02:28 +08005598 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA384,
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005599#endif /* MBEDTLS_RSA_C && MBEDTLS_MD_CAN_SHA384 */
Jerry Yu693a47a2022-06-23 14:02:28 +08005600
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005601#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_MD_CAN_SHA256)
Jerry Yu693a47a2022-06-23 14:02:28 +08005602 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA256,
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005603#endif /* MBEDTLS_RSA_C && MBEDTLS_MD_CAN_SHA256 */
Jerry Yu693a47a2022-06-23 14:02:28 +08005604
Gabor Mezei15b95a62022-05-09 16:37:58 +02005605 MBEDTLS_TLS_SIG_NONE
Jerry Yu909df7b2022-01-22 11:56:27 +08005606};
5607
5608/* NOTICE: see above */
5609#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
5610static uint16_t ssl_tls12_preset_default_sig_algs[] = {
Yanray Wang1136fad2023-11-22 16:54:31 +08005611
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005612#if defined(MBEDTLS_MD_CAN_SHA512)
Valerio Settie9646ec2023-08-02 20:02:28 +02005613#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005614 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA512),
Jerry Yu713013f2022-01-17 18:16:35 +08005615#endif
Jerry Yu09a99fc2022-07-28 14:22:17 +08005616#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT)
5617 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA512,
Yanray Wang1136fad2023-11-22 16:54:31 +08005618#endif
Gabor Mezeic1051b62022-05-10 13:13:58 +02005619#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005620 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA512),
Gabor Mezeic1051b62022-05-10 13:13:58 +02005621#endif
Yanray Wang1136fad2023-11-22 16:54:31 +08005622#endif /* MBEDTLS_MD_CAN_SHA512 */
5623
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005624#if defined(MBEDTLS_MD_CAN_SHA384)
Valerio Settie9646ec2023-08-02 20:02:28 +02005625#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005626 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384),
Jerry Yu11f0a9c2022-01-12 18:43:08 +08005627#endif
Jerry Yu09a99fc2022-07-28 14:22:17 +08005628#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT)
5629 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA384,
Yanray Wang1136fad2023-11-22 16:54:31 +08005630#endif
Gabor Mezeic1051b62022-05-10 13:13:58 +02005631#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005632 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA384),
Gabor Mezeic1051b62022-05-10 13:13:58 +02005633#endif
Yanray Wang1136fad2023-11-22 16:54:31 +08005634#endif /* MBEDTLS_MD_CAN_SHA384 */
5635
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005636#if defined(MBEDTLS_MD_CAN_SHA256)
Valerio Settie9646ec2023-08-02 20:02:28 +02005637#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005638 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256),
Jerry Yu11f0a9c2022-01-12 18:43:08 +08005639#endif
Jerry Yu09a99fc2022-07-28 14:22:17 +08005640#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT)
5641 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256,
Yanray Wang1136fad2023-11-22 16:54:31 +08005642#endif
Gabor Mezeic1051b62022-05-10 13:13:58 +02005643#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005644 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA256),
Gabor Mezeic1051b62022-05-10 13:13:58 +02005645#endif
Yanray Wang1136fad2023-11-22 16:54:31 +08005646#endif /* MBEDTLS_MD_CAN_SHA256 */
5647
Gabor Mezei15b95a62022-05-09 16:37:58 +02005648 MBEDTLS_TLS_SIG_NONE
Jerry Yu909df7b2022-01-22 11:56:27 +08005649};
5650#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Yanray Wang1136fad2023-11-22 16:54:31 +08005651
Jerry Yu909df7b2022-01-22 11:56:27 +08005652/* NOTICE: see above */
Chien Wong4e9683e2023-12-28 17:07:43 +08005653static const uint16_t ssl_preset_suiteb_sig_algs[] = {
Jerry Yu909df7b2022-01-22 11:56:27 +08005654
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005655#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Valerio Setti45d56f32023-07-13 17:23:20 +02005656 defined(MBEDTLS_MD_CAN_SHA256) && \
Valerio Settidb6b4db2023-09-01 09:20:51 +02005657 defined(MBEDTLS_ECP_HAVE_SECP256R1)
Jerry Yu909df7b2022-01-22 11:56:27 +08005658 MBEDTLS_TLS1_3_SIG_ECDSA_SECP256R1_SHA256,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005659 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256)
5660#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08005661
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005662#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Valerio Setti45d56f32023-07-13 17:23:20 +02005663 defined(MBEDTLS_MD_CAN_SHA384) && \
Valerio Settidb6b4db2023-09-01 09:20:51 +02005664 defined(MBEDTLS_ECP_HAVE_SECP384R1)
Jerry Yu53037892022-01-25 11:02:06 +08005665 MBEDTLS_TLS1_3_SIG_ECDSA_SECP384R1_SHA384,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005666 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384)
5667#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08005668
Gabor Mezei15b95a62022-05-09 16:37:58 +02005669 MBEDTLS_TLS_SIG_NONE
Jerry Yu713013f2022-01-17 18:16:35 +08005670};
Jerry Yu6106fdc2022-01-12 16:36:14 +08005671
Jerry Yu909df7b2022-01-22 11:56:27 +08005672/* NOTICE: see above */
5673#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
5674static uint16_t ssl_tls12_preset_suiteb_sig_algs[] = {
Yanray Wang1136fad2023-11-22 16:54:31 +08005675
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005676#if defined(MBEDTLS_MD_CAN_SHA256)
Valerio Settie9646ec2023-08-02 20:02:28 +02005677#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005678 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256),
Jerry Yu713013f2022-01-17 18:16:35 +08005679#endif
Yanray Wang1136fad2023-11-22 16:54:31 +08005680#endif /* MBEDTLS_MD_CAN_SHA256 */
Yanray Wang69ceb392023-11-22 16:32:39 +08005681
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005682#if defined(MBEDTLS_MD_CAN_SHA384)
Valerio Settie9646ec2023-08-02 20:02:28 +02005683#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005684 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384),
Jerry Yu18c833e2022-01-25 10:55:47 +08005685#endif
Yanray Wang1136fad2023-11-22 16:54:31 +08005686#endif /* MBEDTLS_MD_CAN_SHA384 */
5687
Gabor Mezei15b95a62022-05-09 16:37:58 +02005688 MBEDTLS_TLS_SIG_NONE
Hanno Becker9c6aa7b2021-08-10 13:50:43 +01005689};
Jerry Yu909df7b2022-01-22 11:56:27 +08005690#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
5691
Ronald Crone68ab4f2022-10-05 12:46:29 +02005692#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005693
Chien Wong4e9683e2023-12-28 17:07:43 +08005694static const uint16_t ssl_preset_suiteb_groups[] = {
Valerio Settidb6b4db2023-09-01 09:20:51 +02005695#if defined(MBEDTLS_ECP_HAVE_SECP256R1)
Brett Warrene0edc842021-08-17 09:53:13 +01005696 MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1,
Jaeden Amerod4311042019-06-03 08:27:16 +01005697#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005698#if defined(MBEDTLS_ECP_HAVE_SECP384R1)
Brett Warrene0edc842021-08-17 09:53:13 +01005699 MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1,
Jaeden Amerod4311042019-06-03 08:27:16 +01005700#endif
Brett Warrene0edc842021-08-17 09:53:13 +01005701 MBEDTLS_SSL_IANA_TLS_GROUP_NONE
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005702};
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005703
Ronald Crone68ab4f2022-10-05 12:46:29 +02005704#if defined(MBEDTLS_DEBUG_C) && defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu909df7b2022-01-22 11:56:27 +08005705/* Function for checking `ssl_preset_*_sig_algs` and `ssl_tls12_preset_*_sig_algs`
Jerry Yu370e1462022-01-25 10:36:53 +08005706 * to make sure there are no duplicated signature algorithm entries. */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005707MBEDTLS_CHECK_RETURN_CRITICAL
Chien Wong4e9683e2023-12-28 17:07:43 +08005708static int ssl_check_no_sig_alg_duplication(const uint16_t *sig_algs)
Jerry Yu1a8b4812022-01-20 17:56:50 +08005709{
5710 size_t i, j;
5711 int ret = 0;
Jerry Yu909df7b2022-01-22 11:56:27 +08005712
Gilles Peskine449bd832023-01-11 14:50:10 +01005713 for (i = 0; sig_algs[i] != MBEDTLS_TLS_SIG_NONE; i++) {
5714 for (j = 0; j < i; j++) {
5715 if (sig_algs[i] != sig_algs[j]) {
Jerry Yuf377d642022-01-25 10:43:59 +08005716 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01005717 }
5718 mbedtls_printf(" entry(%04x,%" MBEDTLS_PRINTF_SIZET
5719 ") is duplicated at %" MBEDTLS_PRINTF_SIZET "\n",
5720 sig_algs[i], j, i);
Jerry Yuf377d642022-01-25 10:43:59 +08005721 ret = -1;
Jerry Yu1a8b4812022-01-20 17:56:50 +08005722 }
5723 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005724 return ret;
Jerry Yu1a8b4812022-01-20 17:56:50 +08005725}
5726
Ronald Crone68ab4f2022-10-05 12:46:29 +02005727#endif /* MBEDTLS_DEBUG_C && MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Jerry Yu1a8b4812022-01-20 17:56:50 +08005728
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005729/*
Tillmann Karras588ad502015-09-25 04:27:22 +02005730 * Load default in mbedtls_ssl_config
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005731 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005732int mbedtls_ssl_config_defaults(mbedtls_ssl_config *conf,
5733 int endpoint, int transport, int preset)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005734{
Manuel Pégourié-Gonnard8b431fb2015-05-11 12:54:52 +02005735#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Janos Follath865b3eb2019-12-16 11:46:15 +00005736 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard8b431fb2015-05-11 12:54:52 +02005737#endif
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005738
Ronald Crone68ab4f2022-10-05 12:46:29 +02005739#if defined(MBEDTLS_DEBUG_C) && defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005740 if (ssl_check_no_sig_alg_duplication(ssl_preset_suiteb_sig_algs)) {
5741 mbedtls_printf("ssl_preset_suiteb_sig_algs has duplicated entries\n");
5742 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu1a8b4812022-01-20 17:56:50 +08005743 }
5744
Gilles Peskine449bd832023-01-11 14:50:10 +01005745 if (ssl_check_no_sig_alg_duplication(ssl_preset_default_sig_algs)) {
5746 mbedtls_printf("ssl_preset_default_sig_algs has duplicated entries\n");
5747 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu1a8b4812022-01-20 17:56:50 +08005748 }
Jerry Yu909df7b2022-01-22 11:56:27 +08005749
5750#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005751 if (ssl_check_no_sig_alg_duplication(ssl_tls12_preset_suiteb_sig_algs)) {
5752 mbedtls_printf("ssl_tls12_preset_suiteb_sig_algs has duplicated entries\n");
5753 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu909df7b2022-01-22 11:56:27 +08005754 }
5755
Gilles Peskine449bd832023-01-11 14:50:10 +01005756 if (ssl_check_no_sig_alg_duplication(ssl_tls12_preset_default_sig_algs)) {
5757 mbedtls_printf("ssl_tls12_preset_default_sig_algs has duplicated entries\n");
5758 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu909df7b2022-01-22 11:56:27 +08005759 }
5760#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Ronald Crone68ab4f2022-10-05 12:46:29 +02005761#endif /* MBEDTLS_DEBUG_C && MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Jerry Yu1a8b4812022-01-20 17:56:50 +08005762
Manuel Pégourié-Gonnard0de074f2015-05-14 12:58:01 +02005763 /* Use the functions here so that they are covered in tests,
5764 * but otherwise access member directly for efficiency */
Gilles Peskine449bd832023-01-11 14:50:10 +01005765 mbedtls_ssl_conf_endpoint(conf, endpoint);
5766 mbedtls_ssl_conf_transport(conf, transport);
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005767
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005768 /*
5769 * Things that are common to all presets
5770 */
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02005771#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005772 if (endpoint == MBEDTLS_SSL_IS_CLIENT) {
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02005773 conf->authmode = MBEDTLS_SSL_VERIFY_REQUIRED;
5774#if defined(MBEDTLS_SSL_SESSION_TICKETS)
5775 conf->session_tickets = MBEDTLS_SSL_SESSION_TICKETS_ENABLED;
5776#endif
5777 }
5778#endif
5779
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005780#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
5781 conf->encrypt_then_mac = MBEDTLS_SSL_ETM_ENABLED;
5782#endif
5783
5784#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
5785 conf->extended_ms = MBEDTLS_SSL_EXTENDED_MS_ENABLED;
5786#endif
5787
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02005788#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005789 conf->f_cookie_write = ssl_cookie_write_dummy;
5790 conf->f_cookie_check = ssl_cookie_check_dummy;
5791#endif
5792
5793#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
5794 conf->anti_replay = MBEDTLS_SSL_ANTI_REPLAY_ENABLED;
5795#endif
5796
Janos Follath088ce432017-04-10 12:42:31 +01005797#if defined(MBEDTLS_SSL_SRV_C)
5798 conf->cert_req_ca_list = MBEDTLS_SSL_CERT_REQ_CA_LIST_ENABLED;
TRodziewicz3946f792021-06-14 12:11:18 +02005799 conf->respect_cli_pref = MBEDTLS_SSL_SRV_CIPHERSUITE_ORDER_SERVER;
Janos Follath088ce432017-04-10 12:42:31 +01005800#endif
5801
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005802#if defined(MBEDTLS_SSL_PROTO_DTLS)
5803 conf->hs_timeout_min = MBEDTLS_SSL_DTLS_TIMEOUT_DFL_MIN;
5804 conf->hs_timeout_max = MBEDTLS_SSL_DTLS_TIMEOUT_DFL_MAX;
5805#endif
5806
5807#if defined(MBEDTLS_SSL_RENEGOTIATION)
5808 conf->renego_max_records = MBEDTLS_SSL_RENEGO_MAX_RECORDS_DEFAULT;
Gilles Peskine449bd832023-01-11 14:50:10 +01005809 memset(conf->renego_period, 0x00, 2);
5810 memset(conf->renego_period + 2, 0xFF, 6);
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005811#endif
5812
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005813#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005814 if (endpoint == MBEDTLS_SSL_IS_SERVER) {
Hanno Beckere2defad2021-07-24 05:59:17 +01005815 const unsigned char dhm_p[] =
5816 MBEDTLS_DHM_RFC3526_MODP_2048_P_BIN;
5817 const unsigned char dhm_g[] =
5818 MBEDTLS_DHM_RFC3526_MODP_2048_G_BIN;
Hanno Becker00d0a682017-10-04 13:14:29 +01005819
Gilles Peskine449bd832023-01-11 14:50:10 +01005820 if ((ret = mbedtls_ssl_conf_dh_param_bin(conf,
5821 dhm_p, sizeof(dhm_p),
5822 dhm_g, sizeof(dhm_g))) != 0) {
5823 return ret;
Hanno Beckere2defad2021-07-24 05:59:17 +01005824 }
5825 }
Manuel Pégourié-Gonnardbd990d62015-06-11 14:49:42 +02005826#endif
5827
Ronald Cron6f135e12021-12-08 16:57:54 +01005828#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yu6ee56aa2022-12-06 17:47:22 +08005829
5830#if defined(MBEDTLS_SSL_EARLY_DATA)
Yanray Wangd5ed36f2023-11-07 11:40:43 +08005831 mbedtls_ssl_conf_early_data(conf, MBEDTLS_SSL_EARLY_DATA_DISABLED);
Jerry Yu6ee56aa2022-12-06 17:47:22 +08005832#if defined(MBEDTLS_SSL_SRV_C)
Yanray Wang07517612023-11-07 11:47:36 +08005833 mbedtls_ssl_conf_max_early_data_size(conf, MBEDTLS_SSL_MAX_EARLY_DATA_SIZE);
Jerry Yu6ee56aa2022-12-06 17:47:22 +08005834#endif
5835#endif /* MBEDTLS_SSL_EARLY_DATA */
5836
Jerry Yud0766ec2022-09-22 10:46:57 +08005837#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Jerry Yu1ad7ace2022-08-09 13:28:39 +08005838 mbedtls_ssl_conf_new_session_tickets(
Gilles Peskine449bd832023-01-11 14:50:10 +01005839 conf, MBEDTLS_SSL_TLS1_3_DEFAULT_NEW_SESSION_TICKETS);
Jerry Yu1ad7ace2022-08-09 13:28:39 +08005840#endif
Hanno Becker71f1ed62021-07-24 06:01:47 +01005841 /*
5842 * Allow all TLS 1.3 key exchange modes by default.
5843 */
Xiaofei Bai746f9482021-11-12 08:53:56 +00005844 conf->tls13_kex_modes = MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_ALL;
Ronald Cron6f135e12021-12-08 16:57:54 +01005845#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker71f1ed62021-07-24 06:01:47 +01005846
Gilles Peskine449bd832023-01-11 14:50:10 +01005847 if (transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Glenn Strauss2dfcea22022-03-14 17:26:42 -04005848#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
XiaokangQian4d3a6042022-04-21 13:46:17 +00005849 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
XiaokangQian060d8672022-04-21 09:24:56 +00005850 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
XiaokangQian4d3a6042022-04-21 13:46:17 +00005851#else
Gilles Peskine449bd832023-01-11 14:50:10 +01005852 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
XiaokangQian060d8672022-04-21 09:24:56 +00005853#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01005854 } else {
XiaokangQian4d3a6042022-04-21 13:46:17 +00005855#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
Ronald Cron097ba142023-03-08 16:18:00 +01005856 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
5857 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
XiaokangQian4d3a6042022-04-21 13:46:17 +00005858#elif defined(MBEDTLS_SSL_PROTO_TLS1_3)
5859 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
5860 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
5861#elif defined(MBEDTLS_SSL_PROTO_TLS1_2)
5862 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
5863 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
5864#else
Gilles Peskine449bd832023-01-11 14:50:10 +01005865 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
XiaokangQian4d3a6042022-04-21 13:46:17 +00005866#endif
5867 }
Glenn Strauss2dfcea22022-03-14 17:26:42 -04005868
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005869 /*
5870 * Preset-specific defaults
5871 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005872 switch (preset) {
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005873 /*
5874 * NSA Suite B
5875 */
5876 case MBEDTLS_SSL_PRESET_SUITEB:
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005877
Hanno Beckerd60b6c62021-04-29 12:04:11 +01005878 conf->ciphersuite_list = ssl_preset_suiteb_ciphersuites;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005879
5880#if defined(MBEDTLS_X509_CRT_PARSE_C)
5881 conf->cert_profile = &mbedtls_x509_crt_profile_suiteb;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005882#endif
5883
Ronald Crone68ab4f2022-10-05 12:46:29 +02005884#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu909df7b2022-01-22 11:56:27 +08005885#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005886 if (mbedtls_ssl_conf_is_tls12_only(conf)) {
Jerry Yu909df7b2022-01-22 11:56:27 +08005887 conf->sig_algs = ssl_tls12_preset_suiteb_sig_algs;
Gilles Peskine449bd832023-01-11 14:50:10 +01005888 } else
Jerry Yu909df7b2022-01-22 11:56:27 +08005889#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005890 conf->sig_algs = ssl_preset_suiteb_sig_algs;
Ronald Crone68ab4f2022-10-05 12:46:29 +02005891#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005892
Manuel Pégourié-Gonnardf07ce3b2023-09-22 11:53:41 +02005893#if defined(MBEDTLS_ECP_C) && !defined(MBEDTLS_DEPRECATED_REMOVED)
Brett Warrene0edc842021-08-17 09:53:13 +01005894 conf->curve_list = NULL;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005895#endif
Brett Warrene0edc842021-08-17 09:53:13 +01005896 conf->group_list = ssl_preset_suiteb_groups;
Manuel Pégourié-Gonnardc98204e2015-08-11 04:21:01 +02005897 break;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005898
5899 /*
5900 * Default
5901 */
5902 default:
Ronald Cronf6606552022-03-15 11:23:25 +01005903
Hanno Beckerd60b6c62021-04-29 12:04:11 +01005904 conf->ciphersuite_list = mbedtls_ssl_list_ciphersuites();
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005905
5906#if defined(MBEDTLS_X509_CRT_PARSE_C)
5907 conf->cert_profile = &mbedtls_x509_crt_profile_default;
5908#endif
5909
Ronald Crone68ab4f2022-10-05 12:46:29 +02005910#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu909df7b2022-01-22 11:56:27 +08005911#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005912 if (mbedtls_ssl_conf_is_tls12_only(conf)) {
Jerry Yu909df7b2022-01-22 11:56:27 +08005913 conf->sig_algs = ssl_tls12_preset_default_sig_algs;
Gilles Peskine449bd832023-01-11 14:50:10 +01005914 } else
Jerry Yu909df7b2022-01-22 11:56:27 +08005915#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005916 conf->sig_algs = ssl_preset_default_sig_algs;
Ronald Crone68ab4f2022-10-05 12:46:29 +02005917#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005918
Manuel Pégourié-Gonnardf07ce3b2023-09-22 11:53:41 +02005919#if defined(MBEDTLS_ECP_C) && !defined(MBEDTLS_DEPRECATED_REMOVED)
Brett Warrene0edc842021-08-17 09:53:13 +01005920 conf->curve_list = NULL;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005921#endif
Brett Warrene0edc842021-08-17 09:53:13 +01005922 conf->group_list = ssl_preset_default_groups;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005923
5924#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_CLI_C)
5925 conf->dhm_min_bitlen = 1024;
5926#endif
5927 }
5928
Gilles Peskine449bd832023-01-11 14:50:10 +01005929 return 0;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005930}
5931
5932/*
5933 * Free mbedtls_ssl_config
5934 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005935void mbedtls_ssl_config_free(mbedtls_ssl_config *conf)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005936{
5937#if defined(MBEDTLS_DHM_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005938 mbedtls_mpi_free(&conf->dhm_P);
5939 mbedtls_mpi_free(&conf->dhm_G);
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005940#endif
5941
Ronald Cron73fe8df2022-10-05 14:31:43 +02005942#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED)
Neil Armstrong501c9322022-05-03 09:35:09 +02005943#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01005944 if (!mbedtls_svc_key_id_is_null(conf->psk_opaque)) {
Neil Armstrong501c9322022-05-03 09:35:09 +02005945 conf->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
5946 }
Neil Armstrong8ecd6682022-05-05 11:40:35 +02005947#endif /* MBEDTLS_USE_PSA_CRYPTO */
Gilles Peskine449bd832023-01-11 14:50:10 +01005948 if (conf->psk != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005949 mbedtls_zeroize_and_free(conf->psk, conf->psk_len);
Azim Khan27e8a122018-03-21 14:24:11 +00005950 conf->psk = NULL;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005951 conf->psk_len = 0;
junyeonLEE316b1622017-12-20 16:29:30 +09005952 }
5953
Gilles Peskine449bd832023-01-11 14:50:10 +01005954 if (conf->psk_identity != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005955 mbedtls_zeroize_and_free(conf->psk_identity, conf->psk_identity_len);
Azim Khan27e8a122018-03-21 14:24:11 +00005956 conf->psk_identity = NULL;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005957 conf->psk_identity_len = 0;
5958 }
Ronald Cron73fe8df2022-10-05 14:31:43 +02005959#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED */
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005960
5961#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005962 ssl_key_cert_free(conf->key_cert);
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005963#endif
5964
Gilles Peskine449bd832023-01-11 14:50:10 +01005965 mbedtls_platform_zeroize(conf, sizeof(mbedtls_ssl_config));
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005966}
5967
Manuel Pégourié-Gonnard5674a972015-10-19 15:14:03 +02005968#if defined(MBEDTLS_PK_C) && \
Valerio Settie9646ec2023-08-02 20:02:28 +02005969 (defined(MBEDTLS_RSA_C) || defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED))
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005970/*
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005971 * Convert between MBEDTLS_PK_XXX and SSL_SIG_XXX
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005972 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005973unsigned char mbedtls_ssl_sig_from_pk(mbedtls_pk_context *pk)
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005974{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005975#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005976 if (mbedtls_pk_can_do(pk, MBEDTLS_PK_RSA)) {
5977 return MBEDTLS_SSL_SIG_RSA;
5978 }
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005979#endif
Valerio Settie9646ec2023-08-02 20:02:28 +02005980#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005981 if (mbedtls_pk_can_do(pk, MBEDTLS_PK_ECDSA)) {
5982 return MBEDTLS_SSL_SIG_ECDSA;
5983 }
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005984#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01005985 return MBEDTLS_SSL_SIG_ANON;
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005986}
5987
Gilles Peskine449bd832023-01-11 14:50:10 +01005988unsigned char mbedtls_ssl_sig_from_pk_alg(mbedtls_pk_type_t type)
Hanno Becker7e5437a2017-04-28 17:15:26 +01005989{
Gilles Peskine449bd832023-01-11 14:50:10 +01005990 switch (type) {
Hanno Becker7e5437a2017-04-28 17:15:26 +01005991 case MBEDTLS_PK_RSA:
Gilles Peskine449bd832023-01-11 14:50:10 +01005992 return MBEDTLS_SSL_SIG_RSA;
Hanno Becker7e5437a2017-04-28 17:15:26 +01005993 case MBEDTLS_PK_ECDSA:
5994 case MBEDTLS_PK_ECKEY:
Gilles Peskine449bd832023-01-11 14:50:10 +01005995 return MBEDTLS_SSL_SIG_ECDSA;
Hanno Becker7e5437a2017-04-28 17:15:26 +01005996 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005997 return MBEDTLS_SSL_SIG_ANON;
Hanno Becker7e5437a2017-04-28 17:15:26 +01005998 }
5999}
6000
Gilles Peskine449bd832023-01-11 14:50:10 +01006001mbedtls_pk_type_t mbedtls_ssl_pk_alg_from_sig(unsigned char sig)
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02006002{
Gilles Peskine449bd832023-01-11 14:50:10 +01006003 switch (sig) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006004#if defined(MBEDTLS_RSA_C)
6005 case MBEDTLS_SSL_SIG_RSA:
Gilles Peskine449bd832023-01-11 14:50:10 +01006006 return MBEDTLS_PK_RSA;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02006007#endif
Valerio Settie9646ec2023-08-02 20:02:28 +02006008#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006009 case MBEDTLS_SSL_SIG_ECDSA:
Gilles Peskine449bd832023-01-11 14:50:10 +01006010 return MBEDTLS_PK_ECDSA;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02006011#endif
6012 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006013 return MBEDTLS_PK_NONE;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02006014 }
6015}
Valerio Settie9646ec2023-08-02 20:02:28 +02006016#endif /* MBEDTLS_PK_C &&
6017 ( MBEDTLS_RSA_C || MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED ) */
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02006018
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02006019/*
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006020 * Convert from MBEDTLS_SSL_HASH_XXX to MBEDTLS_MD_XXX
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02006021 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006022mbedtls_md_type_t mbedtls_ssl_md_alg_from_hash(unsigned char hash)
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02006023{
Gilles Peskine449bd832023-01-11 14:50:10 +01006024 switch (hash) {
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006025#if defined(MBEDTLS_MD_CAN_MD5)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006026 case MBEDTLS_SSL_HASH_MD5:
Gilles Peskine449bd832023-01-11 14:50:10 +01006027 return MBEDTLS_MD_MD5;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02006028#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006029#if defined(MBEDTLS_MD_CAN_SHA1)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006030 case MBEDTLS_SSL_HASH_SHA1:
Gilles Peskine449bd832023-01-11 14:50:10 +01006031 return MBEDTLS_MD_SHA1;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02006032#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006033#if defined(MBEDTLS_MD_CAN_SHA224)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006034 case MBEDTLS_SSL_HASH_SHA224:
Gilles Peskine449bd832023-01-11 14:50:10 +01006035 return MBEDTLS_MD_SHA224;
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02006036#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006037#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006038 case MBEDTLS_SSL_HASH_SHA256:
Gilles Peskine449bd832023-01-11 14:50:10 +01006039 return MBEDTLS_MD_SHA256;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02006040#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006041#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006042 case MBEDTLS_SSL_HASH_SHA384:
Gilles Peskine449bd832023-01-11 14:50:10 +01006043 return MBEDTLS_MD_SHA384;
Mateusz Starzyk3352a532021-04-06 14:28:22 +02006044#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006045#if defined(MBEDTLS_MD_CAN_SHA512)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006046 case MBEDTLS_SSL_HASH_SHA512:
Gilles Peskine449bd832023-01-11 14:50:10 +01006047 return MBEDTLS_MD_SHA512;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02006048#endif
6049 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006050 return MBEDTLS_MD_NONE;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02006051 }
6052}
6053
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006054/*
6055 * Convert from MBEDTLS_MD_XXX to MBEDTLS_SSL_HASH_XXX
6056 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006057unsigned char mbedtls_ssl_hash_from_md_alg(int md)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006058{
Gilles Peskine449bd832023-01-11 14:50:10 +01006059 switch (md) {
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006060#if defined(MBEDTLS_MD_CAN_MD5)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006061 case MBEDTLS_MD_MD5:
Gilles Peskine449bd832023-01-11 14:50:10 +01006062 return MBEDTLS_SSL_HASH_MD5;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006063#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006064#if defined(MBEDTLS_MD_CAN_SHA1)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006065 case MBEDTLS_MD_SHA1:
Gilles Peskine449bd832023-01-11 14:50:10 +01006066 return MBEDTLS_SSL_HASH_SHA1;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006067#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006068#if defined(MBEDTLS_MD_CAN_SHA224)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006069 case MBEDTLS_MD_SHA224:
Gilles Peskine449bd832023-01-11 14:50:10 +01006070 return MBEDTLS_SSL_HASH_SHA224;
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02006071#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006072#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006073 case MBEDTLS_MD_SHA256:
Gilles Peskine449bd832023-01-11 14:50:10 +01006074 return MBEDTLS_SSL_HASH_SHA256;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006075#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006076#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006077 case MBEDTLS_MD_SHA384:
Gilles Peskine449bd832023-01-11 14:50:10 +01006078 return MBEDTLS_SSL_HASH_SHA384;
Mateusz Starzyk3352a532021-04-06 14:28:22 +02006079#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006080#if defined(MBEDTLS_MD_CAN_SHA512)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006081 case MBEDTLS_MD_SHA512:
Gilles Peskine449bd832023-01-11 14:50:10 +01006082 return MBEDTLS_SSL_HASH_SHA512;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006083#endif
6084 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006085 return MBEDTLS_SSL_HASH_NONE;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006086 }
6087}
6088
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01006089/*
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006090 * Check if a curve proposed by the peer is in our list.
Manuel Pégourié-Gonnard9d412d82015-06-17 12:10:46 +02006091 * Return 0 if we're willing to use it, -1 otherwise.
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01006092 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006093int mbedtls_ssl_check_curve_tls_id(const mbedtls_ssl_context *ssl, uint16_t tls_id)
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01006094{
Gilles Peskine449bd832023-01-11 14:50:10 +01006095 const uint16_t *group_list = mbedtls_ssl_get_groups(ssl);
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01006096
Gilles Peskine449bd832023-01-11 14:50:10 +01006097 if (group_list == NULL) {
6098 return -1;
Brett Warrene0edc842021-08-17 09:53:13 +01006099 }
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01006100
Gilles Peskine449bd832023-01-11 14:50:10 +01006101 for (; *group_list != 0; group_list++) {
6102 if (*group_list == tls_id) {
6103 return 0;
6104 }
6105 }
6106
6107 return -1;
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01006108}
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01006109
Valerio Setti49e69072023-06-27 17:27:51 +02006110#if defined(MBEDTLS_PK_HAVE_ECC_KEYS)
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01006111/*
6112 * Same as mbedtls_ssl_check_curve_tls_id() but with a mbedtls_ecp_group_id.
6113 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006114int mbedtls_ssl_check_curve(const mbedtls_ssl_context *ssl, mbedtls_ecp_group_id grp_id)
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01006115{
Gilles Peskine449bd832023-01-11 14:50:10 +01006116 uint16_t tls_id = mbedtls_ssl_get_tls_id_from_ecp_group_id(grp_id);
Leonid Rozenboim19e59732022-08-08 16:52:38 -07006117
Gilles Peskine449bd832023-01-11 14:50:10 +01006118 if (tls_id == 0) {
Leonid Rozenboim19e59732022-08-08 16:52:38 -07006119 return -1;
Gilles Peskine449bd832023-01-11 14:50:10 +01006120 }
Leonid Rozenboim19e59732022-08-08 16:52:38 -07006121
Gilles Peskine449bd832023-01-11 14:50:10 +01006122 return mbedtls_ssl_check_curve_tls_id(ssl, tls_id);
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01006123}
Valerio Setti49e69072023-06-27 17:27:51 +02006124#endif /* MBEDTLS_PK_HAVE_ECC_KEYS */
Valerio Setti67419f02023-01-04 16:12:42 +01006125
Valerio Setti18c9fed2022-12-30 17:44:24 +01006126static const struct {
6127 uint16_t tls_id;
6128 mbedtls_ecp_group_id ecp_group_id;
6129 psa_ecc_family_t psa_family;
6130 uint16_t bits;
Valerio Setti18c9fed2022-12-30 17:44:24 +01006131} tls_id_match_table[] =
6132{
Valerio Settidb6b4db2023-09-01 09:20:51 +02006133#if defined(MBEDTLS_ECP_HAVE_SECP521R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02006134 { 25, MBEDTLS_ECP_DP_SECP521R1, PSA_ECC_FAMILY_SECP_R1, 521 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006135#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02006136#if defined(MBEDTLS_ECP_HAVE_BP512R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02006137 { 28, MBEDTLS_ECP_DP_BP512R1, PSA_ECC_FAMILY_BRAINPOOL_P_R1, 512 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006138#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02006139#if defined(MBEDTLS_ECP_HAVE_SECP384R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02006140 { 24, MBEDTLS_ECP_DP_SECP384R1, PSA_ECC_FAMILY_SECP_R1, 384 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006141#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02006142#if defined(MBEDTLS_ECP_HAVE_BP384R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02006143 { 27, MBEDTLS_ECP_DP_BP384R1, PSA_ECC_FAMILY_BRAINPOOL_P_R1, 384 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006144#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02006145#if defined(MBEDTLS_ECP_HAVE_SECP256R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02006146 { 23, MBEDTLS_ECP_DP_SECP256R1, PSA_ECC_FAMILY_SECP_R1, 256 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006147#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02006148#if defined(MBEDTLS_ECP_HAVE_SECP256K1)
Valerio Settiacd32c02023-06-29 18:06:29 +02006149 { 22, MBEDTLS_ECP_DP_SECP256K1, PSA_ECC_FAMILY_SECP_K1, 256 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006150#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02006151#if defined(MBEDTLS_ECP_HAVE_BP256R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02006152 { 26, MBEDTLS_ECP_DP_BP256R1, PSA_ECC_FAMILY_BRAINPOOL_P_R1, 256 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006153#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02006154#if defined(MBEDTLS_ECP_HAVE_SECP224R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02006155 { 21, MBEDTLS_ECP_DP_SECP224R1, PSA_ECC_FAMILY_SECP_R1, 224 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006156#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02006157#if defined(MBEDTLS_ECP_HAVE_SECP224K1)
Valerio Settiacd32c02023-06-29 18:06:29 +02006158 { 20, MBEDTLS_ECP_DP_SECP224K1, PSA_ECC_FAMILY_SECP_K1, 224 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006159#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02006160#if defined(MBEDTLS_ECP_HAVE_SECP192R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02006161 { 19, MBEDTLS_ECP_DP_SECP192R1, PSA_ECC_FAMILY_SECP_R1, 192 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006162#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02006163#if defined(MBEDTLS_ECP_HAVE_SECP192K1)
Valerio Settiacd32c02023-06-29 18:06:29 +02006164 { 18, MBEDTLS_ECP_DP_SECP192K1, PSA_ECC_FAMILY_SECP_K1, 192 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006165#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02006166#if defined(MBEDTLS_ECP_HAVE_CURVE25519)
Valerio Settiacd32c02023-06-29 18:06:29 +02006167 { 29, MBEDTLS_ECP_DP_CURVE25519, PSA_ECC_FAMILY_MONTGOMERY, 255 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006168#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02006169#if defined(MBEDTLS_ECP_HAVE_CURVE448)
Valerio Settiacd32c02023-06-29 18:06:29 +02006170 { 30, MBEDTLS_ECP_DP_CURVE448, PSA_ECC_FAMILY_MONTGOMERY, 448 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006171#endif
Valerio Settiacd32c02023-06-29 18:06:29 +02006172 { 0, MBEDTLS_ECP_DP_NONE, 0, 0 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006173};
6174
Gilles Peskine449bd832023-01-11 14:50:10 +01006175int mbedtls_ssl_get_psa_curve_info_from_tls_id(uint16_t tls_id,
Przemek Stekielda4fba62023-06-02 14:52:28 +02006176 psa_key_type_t *type,
Gilles Peskine449bd832023-01-11 14:50:10 +01006177 size_t *bits)
Valerio Setti18c9fed2022-12-30 17:44:24 +01006178{
Gilles Peskine449bd832023-01-11 14:50:10 +01006179 for (int i = 0; tls_id_match_table[i].tls_id != 0; i++) {
6180 if (tls_id_match_table[i].tls_id == tls_id) {
Przemek Stekielda4fba62023-06-02 14:52:28 +02006181 if (type != NULL) {
6182 *type = PSA_KEY_TYPE_ECC_KEY_PAIR(tls_id_match_table[i].psa_family);
Gilles Peskine449bd832023-01-11 14:50:10 +01006183 }
6184 if (bits != NULL) {
Valerio Setti18c9fed2022-12-30 17:44:24 +01006185 *bits = tls_id_match_table[i].bits;
Gilles Peskine449bd832023-01-11 14:50:10 +01006186 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01006187 return PSA_SUCCESS;
6188 }
6189 }
6190
6191 return PSA_ERROR_NOT_SUPPORTED;
6192}
6193
Gilles Peskine449bd832023-01-11 14:50:10 +01006194mbedtls_ecp_group_id mbedtls_ssl_get_ecp_group_id_from_tls_id(uint16_t tls_id)
Valerio Setti18c9fed2022-12-30 17:44:24 +01006195{
Gilles Peskine449bd832023-01-11 14:50:10 +01006196 for (int i = 0; tls_id_match_table[i].tls_id != 0; i++) {
6197 if (tls_id_match_table[i].tls_id == tls_id) {
Valerio Setti18c9fed2022-12-30 17:44:24 +01006198 return tls_id_match_table[i].ecp_group_id;
Gilles Peskine449bd832023-01-11 14:50:10 +01006199 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01006200 }
6201
6202 return MBEDTLS_ECP_DP_NONE;
6203}
6204
Gilles Peskine449bd832023-01-11 14:50:10 +01006205uint16_t mbedtls_ssl_get_tls_id_from_ecp_group_id(mbedtls_ecp_group_id grp_id)
Valerio Setti18c9fed2022-12-30 17:44:24 +01006206{
Gilles Peskine449bd832023-01-11 14:50:10 +01006207 for (int i = 0; tls_id_match_table[i].ecp_group_id != MBEDTLS_ECP_DP_NONE;
6208 i++) {
6209 if (tls_id_match_table[i].ecp_group_id == grp_id) {
Valerio Setti18c9fed2022-12-30 17:44:24 +01006210 return tls_id_match_table[i].tls_id;
Gilles Peskine449bd832023-01-11 14:50:10 +01006211 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01006212 }
6213
6214 return 0;
6215}
6216
Valerio Setti67419f02023-01-04 16:12:42 +01006217#if defined(MBEDTLS_DEBUG_C)
Valerio Settiacd32c02023-06-29 18:06:29 +02006218static const struct {
6219 uint16_t tls_id;
6220 const char *name;
6221} tls_id_curve_name_table[] =
6222{
Valerio Setti54e23792023-07-07 10:49:27 +02006223 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP521R1, "secp521r1" },
6224 { MBEDTLS_SSL_IANA_TLS_GROUP_BP512R1, "brainpoolP512r1" },
6225 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1, "secp384r1" },
6226 { MBEDTLS_SSL_IANA_TLS_GROUP_BP384R1, "brainpoolP384r1" },
6227 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1, "secp256r1" },
6228 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP256K1, "secp256k1" },
6229 { MBEDTLS_SSL_IANA_TLS_GROUP_BP256R1, "brainpoolP256r1" },
6230 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP224R1, "secp224r1" },
6231 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP224K1, "secp224k1" },
6232 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP192R1, "secp192r1" },
6233 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP192K1, "secp192k1" },
6234 { MBEDTLS_SSL_IANA_TLS_GROUP_X25519, "x25519" },
6235 { MBEDTLS_SSL_IANA_TLS_GROUP_X448, "x448" },
Valerio Settiacd32c02023-06-29 18:06:29 +02006236 { 0, NULL },
6237};
6238
Gilles Peskine449bd832023-01-11 14:50:10 +01006239const char *mbedtls_ssl_get_curve_name_from_tls_id(uint16_t tls_id)
Valerio Setti18c9fed2022-12-30 17:44:24 +01006240{
Valerio Settiacd32c02023-06-29 18:06:29 +02006241 for (int i = 0; tls_id_curve_name_table[i].tls_id != 0; i++) {
6242 if (tls_id_curve_name_table[i].tls_id == tls_id) {
6243 return tls_id_curve_name_table[i].name;
Gilles Peskine449bd832023-01-11 14:50:10 +01006244 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01006245 }
6246
6247 return NULL;
6248}
Valerio Setti67419f02023-01-04 16:12:42 +01006249#endif
Valerio Setti18c9fed2022-12-30 17:44:24 +01006250
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006251#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01006252int mbedtls_ssl_check_cert_usage(const mbedtls_x509_crt *cert,
6253 const mbedtls_ssl_ciphersuite_t *ciphersuite,
6254 int cert_endpoint,
6255 uint32_t *flags)
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02006256{
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01006257 int ret = 0;
Dave Rodgmanc37ad442023-11-03 23:36:06 +00006258 unsigned int usage = 0;
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02006259 const char *ext_oid;
6260 size_t ext_len;
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02006261
Gilles Peskine449bd832023-01-11 14:50:10 +01006262 if (cert_endpoint == MBEDTLS_SSL_IS_SERVER) {
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02006263 /* Server part of the key exchange */
Gilles Peskine449bd832023-01-11 14:50:10 +01006264 switch (ciphersuite->key_exchange) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006265 case MBEDTLS_KEY_EXCHANGE_RSA:
6266 case MBEDTLS_KEY_EXCHANGE_RSA_PSK:
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01006267 usage = MBEDTLS_X509_KU_KEY_ENCIPHERMENT;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02006268 break;
6269
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006270 case MBEDTLS_KEY_EXCHANGE_DHE_RSA:
6271 case MBEDTLS_KEY_EXCHANGE_ECDHE_RSA:
6272 case MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA:
6273 usage = MBEDTLS_X509_KU_DIGITAL_SIGNATURE;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02006274 break;
6275
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006276 case MBEDTLS_KEY_EXCHANGE_ECDH_RSA:
6277 case MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA:
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01006278 usage = MBEDTLS_X509_KU_KEY_AGREEMENT;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02006279 break;
6280
6281 /* Don't use default: we want warnings when adding new values */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006282 case MBEDTLS_KEY_EXCHANGE_NONE:
6283 case MBEDTLS_KEY_EXCHANGE_PSK:
6284 case MBEDTLS_KEY_EXCHANGE_DHE_PSK:
6285 case MBEDTLS_KEY_EXCHANGE_ECDHE_PSK:
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +02006286 case MBEDTLS_KEY_EXCHANGE_ECJPAKE:
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02006287 usage = 0;
6288 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006289 } else {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006290 /* Client auth: we only implement rsa_sign and mbedtls_ecdsa_sign for now */
6291 usage = MBEDTLS_X509_KU_DIGITAL_SIGNATURE;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02006292 }
6293
Gilles Peskine449bd832023-01-11 14:50:10 +01006294 if (mbedtls_x509_crt_check_key_usage(cert, usage) != 0) {
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01006295 *flags |= MBEDTLS_X509_BADCERT_KEY_USAGE;
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01006296 ret = -1;
6297 }
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02006298
Gilles Peskine449bd832023-01-11 14:50:10 +01006299 if (cert_endpoint == MBEDTLS_SSL_IS_SERVER) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006300 ext_oid = MBEDTLS_OID_SERVER_AUTH;
Gilles Peskine449bd832023-01-11 14:50:10 +01006301 ext_len = MBEDTLS_OID_SIZE(MBEDTLS_OID_SERVER_AUTH);
6302 } else {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006303 ext_oid = MBEDTLS_OID_CLIENT_AUTH;
Gilles Peskine449bd832023-01-11 14:50:10 +01006304 ext_len = MBEDTLS_OID_SIZE(MBEDTLS_OID_CLIENT_AUTH);
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02006305 }
6306
Gilles Peskine449bd832023-01-11 14:50:10 +01006307 if (mbedtls_x509_crt_check_extended_key_usage(cert, ext_oid, ext_len) != 0) {
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01006308 *flags |= MBEDTLS_X509_BADCERT_EXT_KEY_USAGE;
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01006309 ret = -1;
6310 }
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02006311
Gilles Peskine449bd832023-01-11 14:50:10 +01006312 return ret;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02006313}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006314#endif /* MBEDTLS_X509_CRT_PARSE_C */
Manuel Pégourié-Gonnard3a306b92014-04-29 15:11:17 +02006315
Jerry Yu148165c2021-09-24 23:20:59 +08006316#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01006317int mbedtls_ssl_get_handshake_transcript(mbedtls_ssl_context *ssl,
6318 const mbedtls_md_type_t md,
6319 unsigned char *dst,
6320 size_t dst_len,
6321 size_t *olen)
Jerry Yu148165c2021-09-24 23:20:59 +08006322{
Ronald Cronf6893e12022-01-07 22:09:01 +01006323 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
6324 psa_hash_operation_t *hash_operation_to_clone;
6325 psa_hash_operation_t hash_operation = psa_hash_operation_init();
6326
Jerry Yu148165c2021-09-24 23:20:59 +08006327 *olen = 0;
Ronald Cronf6893e12022-01-07 22:09:01 +01006328
Gilles Peskine449bd832023-01-11 14:50:10 +01006329 switch (md) {
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006330#if defined(MBEDTLS_MD_CAN_SHA384)
Gilles Peskine449bd832023-01-11 14:50:10 +01006331 case MBEDTLS_MD_SHA384:
6332 hash_operation_to_clone = &ssl->handshake->fin_sha384_psa;
6333 break;
Ronald Cronf6893e12022-01-07 22:09:01 +01006334#endif
6335
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006336#if defined(MBEDTLS_MD_CAN_SHA256)
Gilles Peskine449bd832023-01-11 14:50:10 +01006337 case MBEDTLS_MD_SHA256:
6338 hash_operation_to_clone = &ssl->handshake->fin_sha256_psa;
6339 break;
Ronald Cronf6893e12022-01-07 22:09:01 +01006340#endif
6341
Gilles Peskine449bd832023-01-11 14:50:10 +01006342 default:
6343 goto exit;
6344 }
6345
6346 status = psa_hash_clone(hash_operation_to_clone, &hash_operation);
6347 if (status != PSA_SUCCESS) {
Ronald Cronf6893e12022-01-07 22:09:01 +01006348 goto exit;
6349 }
6350
Gilles Peskine449bd832023-01-11 14:50:10 +01006351 status = psa_hash_finish(&hash_operation, dst, dst_len, olen);
6352 if (status != PSA_SUCCESS) {
Ronald Cronf6893e12022-01-07 22:09:01 +01006353 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006354 }
Ronald Cronf6893e12022-01-07 22:09:01 +01006355
6356exit:
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006357#if !defined(MBEDTLS_MD_CAN_SHA384) && \
6358 !defined(MBEDTLS_MD_CAN_SHA256)
Andrzej Kurekeabeb302022-10-17 07:52:51 -04006359 (void) ssl;
6360#endif
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05006361 return PSA_TO_MBEDTLS_ERR(status);
Jerry Yu148165c2021-09-24 23:20:59 +08006362}
6363#else /* MBEDTLS_USE_PSA_CRYPTO */
6364
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006365#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006366MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006367static int ssl_get_handshake_transcript_sha384(mbedtls_ssl_context *ssl,
6368 unsigned char *dst,
6369 size_t dst_len,
6370 size_t *olen)
Jerry Yu24c0ec32021-09-09 14:21:07 +08006371{
Jerry Yu24c0ec32021-09-09 14:21:07 +08006372 int ret;
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01006373 mbedtls_md_context_t sha384;
Jerry Yu24c0ec32021-09-09 14:21:07 +08006374
Gilles Peskine449bd832023-01-11 14:50:10 +01006375 if (dst_len < 48) {
6376 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
6377 }
Jerry Yu24c0ec32021-09-09 14:21:07 +08006378
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01006379 mbedtls_md_init(&sha384);
6380 ret = mbedtls_md_setup(&sha384, mbedtls_md_info_from_type(MBEDTLS_MD_SHA384), 0);
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01006381 if (ret != 0) {
6382 goto exit;
6383 }
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01006384 ret = mbedtls_md_clone(&sha384, &ssl->handshake->fin_sha384);
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01006385 if (ret != 0) {
6386 goto exit;
6387 }
Jerry Yu24c0ec32021-09-09 14:21:07 +08006388
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01006389 if ((ret = mbedtls_md_finish(&sha384, dst)) != 0) {
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01006390 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_finish", ret);
Jerry Yu24c0ec32021-09-09 14:21:07 +08006391 goto exit;
6392 }
6393
6394 *olen = 48;
6395
6396exit:
6397
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01006398 mbedtls_md_free(&sha384);
Gilles Peskine449bd832023-01-11 14:50:10 +01006399 return ret;
Jerry Yu24c0ec32021-09-09 14:21:07 +08006400}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006401#endif /* MBEDTLS_MD_CAN_SHA384 */
Jerry Yu24c0ec32021-09-09 14:21:07 +08006402
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006403#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006404MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006405static int ssl_get_handshake_transcript_sha256(mbedtls_ssl_context *ssl,
6406 unsigned char *dst,
6407 size_t dst_len,
6408 size_t *olen)
Jerry Yu24c0ec32021-09-09 14:21:07 +08006409{
Jerry Yu24c0ec32021-09-09 14:21:07 +08006410 int ret;
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01006411 mbedtls_md_context_t sha256;
Jerry Yu24c0ec32021-09-09 14:21:07 +08006412
Gilles Peskine449bd832023-01-11 14:50:10 +01006413 if (dst_len < 32) {
6414 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
6415 }
Jerry Yu24c0ec32021-09-09 14:21:07 +08006416
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01006417 mbedtls_md_init(&sha256);
6418 ret = mbedtls_md_setup(&sha256, mbedtls_md_info_from_type(MBEDTLS_MD_SHA256), 0);
6419 if (ret != 0) {
6420 goto exit;
6421 }
6422 ret = mbedtls_md_clone(&sha256, &ssl->handshake->fin_sha256);
6423 if (ret != 0) {
6424 goto exit;
6425 }
Jerry Yuc5aef882021-12-23 20:15:02 +08006426
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01006427 if ((ret = mbedtls_md_finish(&sha256, dst)) != 0) {
6428 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_finish", ret);
Jerry Yu24c0ec32021-09-09 14:21:07 +08006429 goto exit;
6430 }
6431
6432 *olen = 32;
6433
6434exit:
6435
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01006436 mbedtls_md_free(&sha256);
Gilles Peskine449bd832023-01-11 14:50:10 +01006437 return ret;
Jerry Yu24c0ec32021-09-09 14:21:07 +08006438}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006439#endif /* MBEDTLS_MD_CAN_SHA256 */
Jerry Yu24c0ec32021-09-09 14:21:07 +08006440
Gilles Peskine449bd832023-01-11 14:50:10 +01006441int mbedtls_ssl_get_handshake_transcript(mbedtls_ssl_context *ssl,
6442 const mbedtls_md_type_t md,
6443 unsigned char *dst,
6444 size_t dst_len,
6445 size_t *olen)
Jerry Yu24c0ec32021-09-09 14:21:07 +08006446{
Gilles Peskine449bd832023-01-11 14:50:10 +01006447 switch (md) {
Jerry Yuc1ddeef2021-10-08 15:14:45 +08006448
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006449#if defined(MBEDTLS_MD_CAN_SHA384)
Gilles Peskine449bd832023-01-11 14:50:10 +01006450 case MBEDTLS_MD_SHA384:
6451 return ssl_get_handshake_transcript_sha384(ssl, dst, dst_len, olen);
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006452#endif /* MBEDTLS_MD_CAN_SHA384*/
Jerry Yuc1ddeef2021-10-08 15:14:45 +08006453
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006454#if defined(MBEDTLS_MD_CAN_SHA256)
Gilles Peskine449bd832023-01-11 14:50:10 +01006455 case MBEDTLS_MD_SHA256:
6456 return ssl_get_handshake_transcript_sha256(ssl, dst, dst_len, olen);
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006457#endif /* MBEDTLS_MD_CAN_SHA256*/
Jerry Yuc1ddeef2021-10-08 15:14:45 +08006458
Gilles Peskine449bd832023-01-11 14:50:10 +01006459 default:
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006460#if !defined(MBEDTLS_MD_CAN_SHA384) && \
6461 !defined(MBEDTLS_MD_CAN_SHA256)
Gilles Peskine449bd832023-01-11 14:50:10 +01006462 (void) ssl;
6463 (void) dst;
6464 (void) dst_len;
6465 (void) olen;
Andrzej Kurek409248a2022-10-24 10:33:21 -04006466#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01006467 break;
Jerry Yuc1ddeef2021-10-08 15:14:45 +08006468 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006469 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yu24c0ec32021-09-09 14:21:07 +08006470}
XiaokangQian647719a2021-12-07 09:16:29 +00006471
Jerry Yu148165c2021-09-24 23:20:59 +08006472#endif /* !MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu24c0ec32021-09-09 14:21:07 +08006473
Ronald Crone68ab4f2022-10-05 12:46:29 +02006474#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Gabor Mezei078e8032022-04-27 21:17:56 +02006475/* mbedtls_ssl_parse_sig_alg_ext()
6476 *
6477 * The `extension_data` field of signature algorithm contains a `SignatureSchemeList`
6478 * value (TLS 1.3 RFC8446):
6479 * enum {
6480 * ....
6481 * ecdsa_secp256r1_sha256( 0x0403 ),
6482 * ecdsa_secp384r1_sha384( 0x0503 ),
6483 * ecdsa_secp521r1_sha512( 0x0603 ),
6484 * ....
6485 * } SignatureScheme;
6486 *
6487 * struct {
6488 * SignatureScheme supported_signature_algorithms<2..2^16-2>;
6489 * } SignatureSchemeList;
6490 *
6491 * The `extension_data` field of signature algorithm contains a `SignatureAndHashAlgorithm`
6492 * value (TLS 1.2 RFC5246):
6493 * enum {
6494 * none(0), md5(1), sha1(2), sha224(3), sha256(4), sha384(5),
6495 * sha512(6), (255)
6496 * } HashAlgorithm;
6497 *
6498 * enum { anonymous(0), rsa(1), dsa(2), ecdsa(3), (255) }
6499 * SignatureAlgorithm;
6500 *
6501 * struct {
6502 * HashAlgorithm hash;
6503 * SignatureAlgorithm signature;
6504 * } SignatureAndHashAlgorithm;
6505 *
6506 * SignatureAndHashAlgorithm
6507 * supported_signature_algorithms<2..2^16-2>;
6508 *
6509 * The TLS 1.3 signature algorithm extension was defined to be a compatible
6510 * generalization of the TLS 1.2 signature algorithm extension.
6511 * `SignatureAndHashAlgorithm` field of TLS 1.2 can be represented by
6512 * `SignatureScheme` field of TLS 1.3
6513 *
6514 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006515int mbedtls_ssl_parse_sig_alg_ext(mbedtls_ssl_context *ssl,
6516 const unsigned char *buf,
6517 const unsigned char *end)
Gabor Mezei078e8032022-04-27 21:17:56 +02006518{
6519 const unsigned char *p = buf;
6520 size_t supported_sig_algs_len = 0;
6521 const unsigned char *supported_sig_algs_end;
6522 uint16_t sig_alg;
6523 uint32_t common_idx = 0;
6524
Gilles Peskine449bd832023-01-11 14:50:10 +01006525 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
6526 supported_sig_algs_len = MBEDTLS_GET_UINT16_BE(p, 0);
Gabor Mezei078e8032022-04-27 21:17:56 +02006527 p += 2;
6528
Gilles Peskine449bd832023-01-11 14:50:10 +01006529 memset(ssl->handshake->received_sig_algs, 0,
6530 sizeof(ssl->handshake->received_sig_algs));
Gabor Mezei078e8032022-04-27 21:17:56 +02006531
Gilles Peskine449bd832023-01-11 14:50:10 +01006532 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, supported_sig_algs_len);
Gabor Mezei078e8032022-04-27 21:17:56 +02006533 supported_sig_algs_end = p + supported_sig_algs_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01006534 while (p < supported_sig_algs_end) {
6535 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, supported_sig_algs_end, 2);
6536 sig_alg = MBEDTLS_GET_UINT16_BE(p, 0);
Gabor Mezei078e8032022-04-27 21:17:56 +02006537 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01006538 MBEDTLS_SSL_DEBUG_MSG(4, ("received signature algorithm: 0x%x %s",
6539 sig_alg,
6540 mbedtls_ssl_sig_alg_to_str(sig_alg)));
Jerry Yu2fe6c632022-06-29 10:02:38 +08006541#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01006542 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_2 &&
6543 (!(mbedtls_ssl_sig_alg_is_supported(ssl, sig_alg) &&
6544 mbedtls_ssl_sig_alg_is_offered(ssl, sig_alg)))) {
Gabor Mezei078e8032022-04-27 21:17:56 +02006545 continue;
Jerry Yu2fe6c632022-06-29 10:02:38 +08006546 }
6547#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gabor Mezei078e8032022-04-27 21:17:56 +02006548
Gilles Peskine449bd832023-01-11 14:50:10 +01006549 MBEDTLS_SSL_DEBUG_MSG(4, ("valid signature algorithm: %s",
6550 mbedtls_ssl_sig_alg_to_str(sig_alg)));
Gabor Mezei078e8032022-04-27 21:17:56 +02006551
Gilles Peskine449bd832023-01-11 14:50:10 +01006552 if (common_idx + 1 < MBEDTLS_RECEIVED_SIG_ALGS_SIZE) {
Gabor Mezei078e8032022-04-27 21:17:56 +02006553 ssl->handshake->received_sig_algs[common_idx] = sig_alg;
6554 common_idx += 1;
6555 }
6556 }
6557 /* Check that we consumed all the message. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006558 if (p != end) {
6559 MBEDTLS_SSL_DEBUG_MSG(1,
6560 ("Signature algorithms extension length misaligned"));
6561 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR,
6562 MBEDTLS_ERR_SSL_DECODE_ERROR);
6563 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Gabor Mezei078e8032022-04-27 21:17:56 +02006564 }
6565
Gilles Peskine449bd832023-01-11 14:50:10 +01006566 if (common_idx == 0) {
6567 MBEDTLS_SSL_DEBUG_MSG(3, ("no signature algorithm in common"));
6568 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE,
6569 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE);
6570 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Gabor Mezei078e8032022-04-27 21:17:56 +02006571 }
6572
Gabor Mezei15b95a62022-05-09 16:37:58 +02006573 ssl->handshake->received_sig_algs[common_idx] = MBEDTLS_TLS_SIG_NONE;
Gilles Peskine449bd832023-01-11 14:50:10 +01006574 return 0;
Gabor Mezei078e8032022-04-27 21:17:56 +02006575}
6576
Ronald Crone68ab4f2022-10-05 12:46:29 +02006577#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Gabor Mezei078e8032022-04-27 21:17:56 +02006578
Jerry Yudc7bd172022-02-17 13:44:15 +08006579#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
6580
6581#if defined(MBEDTLS_USE_PSA_CRYPTO)
6582
Gilles Peskine449bd832023-01-11 14:50:10 +01006583static psa_status_t setup_psa_key_derivation(psa_key_derivation_operation_t *derivation,
6584 mbedtls_svc_key_id_t key,
6585 psa_algorithm_t alg,
6586 const unsigned char *raw_psk, size_t raw_psk_length,
6587 const unsigned char *seed, size_t seed_length,
6588 const unsigned char *label, size_t label_length,
6589 const unsigned char *other_secret,
6590 size_t other_secret_length,
6591 size_t capacity)
Jerry Yudc7bd172022-02-17 13:44:15 +08006592{
6593 psa_status_t status;
6594
Gilles Peskine449bd832023-01-11 14:50:10 +01006595 status = psa_key_derivation_setup(derivation, alg);
6596 if (status != PSA_SUCCESS) {
6597 return status;
6598 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006599
Gilles Peskine449bd832023-01-11 14:50:10 +01006600 if (PSA_ALG_IS_TLS12_PRF(alg) || PSA_ALG_IS_TLS12_PSK_TO_MS(alg)) {
6601 status = psa_key_derivation_input_bytes(derivation,
6602 PSA_KEY_DERIVATION_INPUT_SEED,
6603 seed, seed_length);
6604 if (status != PSA_SUCCESS) {
6605 return status;
Przemek Stekiel1f027032022-04-05 17:12:11 +02006606 }
6607
Gilles Peskine449bd832023-01-11 14:50:10 +01006608 if (other_secret != NULL) {
6609 status = psa_key_derivation_input_bytes(derivation,
6610 PSA_KEY_DERIVATION_INPUT_OTHER_SECRET,
6611 other_secret, other_secret_length);
6612 if (status != PSA_SUCCESS) {
6613 return status;
6614 }
6615 }
6616
6617 if (mbedtls_svc_key_id_is_null(key)) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006618 status = psa_key_derivation_input_bytes(
6619 derivation, PSA_KEY_DERIVATION_INPUT_SECRET,
Gilles Peskine449bd832023-01-11 14:50:10 +01006620 raw_psk, raw_psk_length);
6621 } else {
Jerry Yudc7bd172022-02-17 13:44:15 +08006622 status = psa_key_derivation_input_key(
Gilles Peskine449bd832023-01-11 14:50:10 +01006623 derivation, PSA_KEY_DERIVATION_INPUT_SECRET, key);
Jerry Yudc7bd172022-02-17 13:44:15 +08006624 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006625 if (status != PSA_SUCCESS) {
6626 return status;
6627 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006628
Gilles Peskine449bd832023-01-11 14:50:10 +01006629 status = psa_key_derivation_input_bytes(derivation,
6630 PSA_KEY_DERIVATION_INPUT_LABEL,
6631 label, label_length);
6632 if (status != PSA_SUCCESS) {
6633 return status;
6634 }
6635 } else {
6636 return PSA_ERROR_NOT_SUPPORTED;
Jerry Yudc7bd172022-02-17 13:44:15 +08006637 }
6638
Gilles Peskine449bd832023-01-11 14:50:10 +01006639 status = psa_key_derivation_set_capacity(derivation, capacity);
6640 if (status != PSA_SUCCESS) {
6641 return status;
6642 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006643
Gilles Peskine449bd832023-01-11 14:50:10 +01006644 return PSA_SUCCESS;
Jerry Yudc7bd172022-02-17 13:44:15 +08006645}
6646
Andrzej Kurek57d10632022-10-24 10:32:01 -04006647#if defined(PSA_WANT_ALG_SHA_384) || \
6648 defined(PSA_WANT_ALG_SHA_256)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006649MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006650static int tls_prf_generic(mbedtls_md_type_t md_type,
6651 const unsigned char *secret, size_t slen,
6652 const char *label,
6653 const unsigned char *random, size_t rlen,
6654 unsigned char *dstbuf, size_t dlen)
Jerry Yudc7bd172022-02-17 13:44:15 +08006655{
6656 psa_status_t status;
6657 psa_algorithm_t alg;
6658 mbedtls_svc_key_id_t master_key = MBEDTLS_SVC_KEY_ID_INIT;
6659 psa_key_derivation_operation_t derivation =
6660 PSA_KEY_DERIVATION_OPERATION_INIT;
6661
Gilles Peskine449bd832023-01-11 14:50:10 +01006662 if (md_type == MBEDTLS_MD_SHA384) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006663 alg = PSA_ALG_TLS12_PRF(PSA_ALG_SHA_384);
Gilles Peskine449bd832023-01-11 14:50:10 +01006664 } else {
Jerry Yudc7bd172022-02-17 13:44:15 +08006665 alg = PSA_ALG_TLS12_PRF(PSA_ALG_SHA_256);
Gilles Peskine449bd832023-01-11 14:50:10 +01006666 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006667
6668 /* Normally a "secret" should be long enough to be impossible to
6669 * find by brute force, and in particular should not be empty. But
6670 * this PRF is also used to derive an IV, in particular in EAP-TLS,
6671 * and for this use case it makes sense to have a 0-length "secret".
6672 * Since the key API doesn't allow importing a key of length 0,
6673 * keep master_key=0, which setup_psa_key_derivation() understands
6674 * to mean a 0-length "secret" input. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006675 if (slen != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006676 psa_key_attributes_t key_attributes = psa_key_attributes_init();
Gilles Peskine449bd832023-01-11 14:50:10 +01006677 psa_set_key_usage_flags(&key_attributes, PSA_KEY_USAGE_DERIVE);
6678 psa_set_key_algorithm(&key_attributes, alg);
6679 psa_set_key_type(&key_attributes, PSA_KEY_TYPE_DERIVE);
Jerry Yudc7bd172022-02-17 13:44:15 +08006680
Gilles Peskine449bd832023-01-11 14:50:10 +01006681 status = psa_import_key(&key_attributes, secret, slen, &master_key);
6682 if (status != PSA_SUCCESS) {
6683 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
6684 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006685 }
6686
Gilles Peskine449bd832023-01-11 14:50:10 +01006687 status = setup_psa_key_derivation(&derivation,
6688 master_key, alg,
6689 NULL, 0,
6690 random, rlen,
6691 (unsigned char const *) label,
6692 (size_t) strlen(label),
6693 NULL, 0,
6694 dlen);
6695 if (status != PSA_SUCCESS) {
6696 psa_key_derivation_abort(&derivation);
6697 psa_destroy_key(master_key);
6698 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yudc7bd172022-02-17 13:44:15 +08006699 }
6700
Gilles Peskine449bd832023-01-11 14:50:10 +01006701 status = psa_key_derivation_output_bytes(&derivation, dstbuf, dlen);
6702 if (status != PSA_SUCCESS) {
6703 psa_key_derivation_abort(&derivation);
6704 psa_destroy_key(master_key);
6705 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yudc7bd172022-02-17 13:44:15 +08006706 }
6707
Gilles Peskine449bd832023-01-11 14:50:10 +01006708 status = psa_key_derivation_abort(&derivation);
6709 if (status != PSA_SUCCESS) {
6710 psa_destroy_key(master_key);
6711 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yudc7bd172022-02-17 13:44:15 +08006712 }
6713
Gilles Peskine449bd832023-01-11 14:50:10 +01006714 if (!mbedtls_svc_key_id_is_null(master_key)) {
6715 status = psa_destroy_key(master_key);
6716 }
6717 if (status != PSA_SUCCESS) {
6718 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
6719 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006720
Gilles Peskine449bd832023-01-11 14:50:10 +01006721 return 0;
Jerry Yudc7bd172022-02-17 13:44:15 +08006722}
Andrzej Kurek57d10632022-10-24 10:32:01 -04006723#endif /* PSA_WANT_ALG_SHA_256 || PSA_WANT_ALG_SHA_384 */
Jerry Yudc7bd172022-02-17 13:44:15 +08006724#else /* MBEDTLS_USE_PSA_CRYPTO */
6725
Andrzej Kurek57d10632022-10-24 10:32:01 -04006726#if defined(MBEDTLS_MD_C) && \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006727 (defined(MBEDTLS_MD_CAN_SHA256) || \
6728 defined(MBEDTLS_MD_CAN_SHA384))
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 size_t nb;
6737 size_t i, j, k, md_len;
6738 unsigned char *tmp;
6739 size_t tmp_len = 0;
6740 unsigned char h_i[MBEDTLS_MD_MAX_SIZE];
6741 const mbedtls_md_info_t *md_info;
6742 mbedtls_md_context_t md_ctx;
6743 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6744
Gilles Peskine449bd832023-01-11 14:50:10 +01006745 mbedtls_md_init(&md_ctx);
Jerry Yudc7bd172022-02-17 13:44:15 +08006746
Gilles Peskine449bd832023-01-11 14:50:10 +01006747 if ((md_info = mbedtls_md_info_from_type(md_type)) == NULL) {
6748 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
6749 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006750
Gilles Peskine449bd832023-01-11 14:50:10 +01006751 md_len = mbedtls_md_get_size(md_info);
Jerry Yudc7bd172022-02-17 13:44:15 +08006752
Gilles Peskine449bd832023-01-11 14:50:10 +01006753 tmp_len = md_len + strlen(label) + rlen;
6754 tmp = mbedtls_calloc(1, tmp_len);
6755 if (tmp == NULL) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006756 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
6757 goto exit;
6758 }
6759
Gilles Peskine449bd832023-01-11 14:50:10 +01006760 nb = strlen(label);
6761 memcpy(tmp + md_len, label, nb);
6762 memcpy(tmp + md_len + nb, random, rlen);
Jerry Yudc7bd172022-02-17 13:44:15 +08006763 nb += rlen;
6764
6765 /*
6766 * Compute P_<hash>(secret, label + random)[0..dlen]
6767 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006768 if ((ret = mbedtls_md_setup(&md_ctx, md_info, 1)) != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006769 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006770 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006771
Gilles Peskine449bd832023-01-11 14:50:10 +01006772 ret = mbedtls_md_hmac_starts(&md_ctx, secret, slen);
6773 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006774 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006775 }
6776 ret = mbedtls_md_hmac_update(&md_ctx, tmp + md_len, nb);
6777 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006778 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006779 }
6780 ret = mbedtls_md_hmac_finish(&md_ctx, tmp);
6781 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006782 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006783 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006784
Gilles Peskine449bd832023-01-11 14:50:10 +01006785 for (i = 0; i < dlen; i += md_len) {
6786 ret = mbedtls_md_hmac_reset(&md_ctx);
6787 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006788 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006789 }
6790 ret = mbedtls_md_hmac_update(&md_ctx, tmp, md_len + nb);
6791 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006792 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006793 }
6794 ret = mbedtls_md_hmac_finish(&md_ctx, h_i);
6795 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006796 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006797 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006798
Gilles Peskine449bd832023-01-11 14:50:10 +01006799 ret = mbedtls_md_hmac_reset(&md_ctx);
6800 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006801 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006802 }
6803 ret = mbedtls_md_hmac_update(&md_ctx, tmp, md_len);
6804 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006805 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006806 }
6807 ret = mbedtls_md_hmac_finish(&md_ctx, tmp);
6808 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006809 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006810 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006811
Gilles Peskine449bd832023-01-11 14:50:10 +01006812 k = (i + md_len > dlen) ? dlen % md_len : md_len;
Jerry Yudc7bd172022-02-17 13:44:15 +08006813
Gilles Peskine449bd832023-01-11 14:50:10 +01006814 for (j = 0; j < k; j++) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006815 dstbuf[i + j] = h_i[j];
Gilles Peskine449bd832023-01-11 14:50:10 +01006816 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006817 }
6818
6819exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01006820 mbedtls_md_free(&md_ctx);
Jerry Yudc7bd172022-02-17 13:44:15 +08006821
Gilles Peskine449bd832023-01-11 14:50:10 +01006822 if (tmp != NULL) {
6823 mbedtls_platform_zeroize(tmp, tmp_len);
6824 }
Dave Rodgman29b9b2b2022-11-01 16:08:14 +00006825
Gilles Peskine449bd832023-01-11 14:50:10 +01006826 mbedtls_platform_zeroize(h_i, sizeof(h_i));
Jerry Yudc7bd172022-02-17 13:44:15 +08006827
Gilles Peskine449bd832023-01-11 14:50:10 +01006828 mbedtls_free(tmp);
Jerry Yudc7bd172022-02-17 13:44:15 +08006829
Gilles Peskine449bd832023-01-11 14:50:10 +01006830 return ret;
Jerry Yudc7bd172022-02-17 13:44:15 +08006831}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006832#endif /* MBEDTLS_MD_C && ( MBEDTLS_MD_CAN_SHA256 || MBEDTLS_MD_CAN_SHA384 ) */
Jerry Yudc7bd172022-02-17 13:44:15 +08006833#endif /* MBEDTLS_USE_PSA_CRYPTO */
6834
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006835#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006836MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006837static int tls_prf_sha256(const unsigned char *secret, size_t slen,
6838 const char *label,
6839 const unsigned char *random, size_t rlen,
6840 unsigned char *dstbuf, size_t dlen)
Jerry Yudc7bd172022-02-17 13:44:15 +08006841{
Gilles Peskine449bd832023-01-11 14:50:10 +01006842 return tls_prf_generic(MBEDTLS_MD_SHA256, secret, slen,
6843 label, random, rlen, dstbuf, dlen);
Jerry Yudc7bd172022-02-17 13:44:15 +08006844}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006845#endif /* MBEDTLS_MD_CAN_SHA256*/
Jerry Yudc7bd172022-02-17 13:44:15 +08006846
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006847#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006848MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006849static int tls_prf_sha384(const unsigned char *secret, size_t slen,
6850 const char *label,
6851 const unsigned char *random, size_t rlen,
6852 unsigned char *dstbuf, size_t dlen)
Jerry Yudc7bd172022-02-17 13:44:15 +08006853{
Gilles Peskine449bd832023-01-11 14:50:10 +01006854 return tls_prf_generic(MBEDTLS_MD_SHA384, secret, slen,
6855 label, random, rlen, dstbuf, dlen);
Jerry Yudc7bd172022-02-17 13:44:15 +08006856}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006857#endif /* MBEDTLS_MD_CAN_SHA384*/
Jerry Yudc7bd172022-02-17 13:44:15 +08006858
Jerry Yuf009d862022-02-17 14:01:37 +08006859/*
6860 * Set appropriate PRF function and other SSL / TLS1.2 functions
6861 *
6862 * Inputs:
Jerry Yuf009d862022-02-17 14:01:37 +08006863 * - hash associated with the ciphersuite (only used by TLS 1.2)
6864 *
6865 * Outputs:
6866 * - the tls_prf, calc_verify and calc_finished members of handshake structure
6867 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006868MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006869static int ssl_set_handshake_prfs(mbedtls_ssl_handshake_params *handshake,
6870 mbedtls_md_type_t hash)
Jerry Yuf009d862022-02-17 14:01:37 +08006871{
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006872#if defined(MBEDTLS_MD_CAN_SHA384)
Gilles Peskine449bd832023-01-11 14:50:10 +01006873 if (hash == MBEDTLS_MD_SHA384) {
Jerry Yuf009d862022-02-17 14:01:37 +08006874 handshake->tls_prf = tls_prf_sha384;
6875 handshake->calc_verify = ssl_calc_verify_tls_sha384;
6876 handshake->calc_finished = ssl_calc_finished_tls_sha384;
Gilles Peskine449bd832023-01-11 14:50:10 +01006877 } else
Jerry Yuf009d862022-02-17 14:01:37 +08006878#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006879#if defined(MBEDTLS_MD_CAN_SHA256)
Jerry Yuf009d862022-02-17 14:01:37 +08006880 {
Ronald Cron81591aa2022-03-07 09:05:51 +01006881 (void) hash;
Jerry Yuf009d862022-02-17 14:01:37 +08006882 handshake->tls_prf = tls_prf_sha256;
6883 handshake->calc_verify = ssl_calc_verify_tls_sha256;
6884 handshake->calc_finished = ssl_calc_finished_tls_sha256;
6885 }
Ronald Cron81591aa2022-03-07 09:05:51 +01006886#else
Jerry Yuf009d862022-02-17 14:01:37 +08006887 {
Jerry Yuf009d862022-02-17 14:01:37 +08006888 (void) handshake;
Ronald Cron81591aa2022-03-07 09:05:51 +01006889 (void) hash;
Gilles Peskine449bd832023-01-11 14:50:10 +01006890 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yuf009d862022-02-17 14:01:37 +08006891 }
Ronald Cron81591aa2022-03-07 09:05:51 +01006892#endif
Jerry Yuf009d862022-02-17 14:01:37 +08006893
Gilles Peskine449bd832023-01-11 14:50:10 +01006894 return 0;
Jerry Yuf009d862022-02-17 14:01:37 +08006895}
Jerry Yud6ab2352022-02-17 14:03:43 +08006896
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006897/*
6898 * Compute master secret if needed
6899 *
6900 * Parameters:
6901 * [in/out] handshake
6902 * [in] resume, premaster, extended_ms, calc_verify, tls_prf
6903 * (PSA-PSK) ciphersuite_info, psk_opaque
6904 * [out] premaster (cleared)
6905 * [out] master
6906 * [in] ssl: optionally used for debugging, EMS and PSA-PSK
6907 * debug: conf->f_dbg, conf->p_dbg
6908 * EMS: passed to calc_verify (debug + session_negotiate)
Ronald Crona25cf582022-03-07 11:10:36 +01006909 * PSA-PSA: conf
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006910 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006911MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006912static int ssl_compute_master(mbedtls_ssl_handshake_params *handshake,
6913 unsigned char *master,
6914 const mbedtls_ssl_context *ssl)
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006915{
6916 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6917
6918 /* cf. RFC 5246, Section 8.1:
6919 * "The master secret is always exactly 48 bytes in length." */
6920 size_t const master_secret_len = 48;
6921
6922#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
6923 unsigned char session_hash[48];
6924#endif /* MBEDTLS_SSL_EXTENDED_MASTER_SECRET */
6925
6926 /* The label for the KDF used for key expansion.
6927 * This is either "master secret" or "extended master secret"
6928 * depending on whether the Extended Master Secret extension
6929 * is used. */
6930 char const *lbl = "master secret";
6931
Przemek Stekielae4ed302022-04-05 17:15:55 +02006932 /* The seed for the KDF used for key expansion.
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006933 * - If the Extended Master Secret extension is not used,
6934 * this is ClientHello.Random + ServerHello.Random
6935 * (see Sect. 8.1 in RFC 5246).
6936 * - If the Extended Master Secret extension is used,
6937 * this is the transcript of the handshake so far.
6938 * (see Sect. 4 in RFC 7627). */
Przemek Stekielae4ed302022-04-05 17:15:55 +02006939 unsigned char const *seed = handshake->randbytes;
6940 size_t seed_len = 64;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006941
6942#if !defined(MBEDTLS_DEBUG_C) && \
6943 !defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET) && \
6944 !(defined(MBEDTLS_USE_PSA_CRYPTO) && \
Gilles Peskine449bd832023-01-11 14:50:10 +01006945 defined(MBEDTLS_KEY_EXCHANGE_PSK_ENABLED))
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006946 ssl = NULL; /* make sure we don't use it except for those cases */
6947 (void) ssl;
6948#endif
6949
Gilles Peskine449bd832023-01-11 14:50:10 +01006950 if (handshake->resume != 0) {
6951 MBEDTLS_SSL_DEBUG_MSG(3, ("no premaster (session resumed)"));
6952 return 0;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006953 }
6954
6955#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
Gilles Peskine449bd832023-01-11 14:50:10 +01006956 if (handshake->extended_ms == MBEDTLS_SSL_EXTENDED_MS_ENABLED) {
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006957 lbl = "extended master secret";
Przemek Stekielae4ed302022-04-05 17:15:55 +02006958 seed = session_hash;
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01006959 ret = handshake->calc_verify(ssl, session_hash, &seed_len);
6960 if (ret != 0) {
6961 MBEDTLS_SSL_DEBUG_RET(1, "calc_verify", ret);
6962 }
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006963
Gilles Peskine449bd832023-01-11 14:50:10 +01006964 MBEDTLS_SSL_DEBUG_BUF(3, "session hash for extended master secret",
6965 session_hash, seed_len);
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006966 }
Przemek Stekiel169bf0b2022-04-29 07:53:29 +02006967#endif /* MBEDTLS_SSL_EXTENDED_MASTER_SECRET */
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006968
Przemek Stekiel99114f32022-04-22 11:20:09 +02006969#if defined(MBEDTLS_USE_PSA_CRYPTO) && \
Przemek Stekiel8a4b7fd2022-04-28 09:22:22 +02006970 defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01006971 if (mbedtls_ssl_ciphersuite_uses_psk(handshake->ciphersuite_info) == 1) {
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006972 /* Perform PSK-to-MS expansion in a single step. */
6973 psa_status_t status;
6974 psa_algorithm_t alg;
6975 mbedtls_svc_key_id_t psk;
6976 psa_key_derivation_operation_t derivation =
6977 PSA_KEY_DERIVATION_OPERATION_INIT;
Dave Rodgman2eab4622023-10-05 13:30:37 +01006978 mbedtls_md_type_t hash_alg = (mbedtls_md_type_t) handshake->ciphersuite_info->mac;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006979
Gilles Peskine449bd832023-01-11 14:50:10 +01006980 MBEDTLS_SSL_DEBUG_MSG(2, ("perform PSA-based PSK-to-MS expansion"));
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006981
Gilles Peskine449bd832023-01-11 14:50:10 +01006982 psk = mbedtls_ssl_get_opaque_psk(ssl);
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006983
Gilles Peskine449bd832023-01-11 14:50:10 +01006984 if (hash_alg == MBEDTLS_MD_SHA384) {
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006985 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_384);
Gilles Peskine449bd832023-01-11 14:50:10 +01006986 } else {
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006987 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_256);
Gilles Peskine449bd832023-01-11 14:50:10 +01006988 }
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006989
Przemek Stekiel51a1f362022-04-13 08:57:06 +02006990 size_t other_secret_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01006991 unsigned char *other_secret = NULL;
Przemek Stekielc2033402022-04-05 17:19:41 +02006992
Gilles Peskine449bd832023-01-11 14:50:10 +01006993 switch (handshake->ciphersuite_info->key_exchange) {
Przemek Stekiel19b80f82022-04-14 08:29:31 +02006994 /* Provide other secret.
Przemek Stekiel51a1f362022-04-13 08:57:06 +02006995 * Other secret is stored in premaster, where first 2 bytes hold the
Przemek Stekiel19b80f82022-04-14 08:29:31 +02006996 * length of the other key.
Przemek Stekielc2033402022-04-05 17:19:41 +02006997 */
Przemek Stekiel19b80f82022-04-14 08:29:31 +02006998 case MBEDTLS_KEY_EXCHANGE_RSA_PSK:
Przemek Stekiel8abcee92022-04-28 09:16:28 +02006999 /* For RSA-PSK other key length is always 48 bytes. */
Przemek Stekiel19b80f82022-04-14 08:29:31 +02007000 other_secret_len = 48;
7001 other_secret = handshake->premaster + 2;
7002 break;
7003 case MBEDTLS_KEY_EXCHANGE_ECDHE_PSK:
Przemek Stekielb293aaa2022-04-19 12:22:38 +02007004 case MBEDTLS_KEY_EXCHANGE_DHE_PSK:
Przemek Stekiel19b80f82022-04-14 08:29:31 +02007005 other_secret_len = MBEDTLS_GET_UINT16_BE(handshake->premaster, 0);
7006 other_secret = handshake->premaster + 2;
7007 break;
7008 default:
7009 break;
Przemek Stekielc2033402022-04-05 17:19:41 +02007010 }
7011
Gilles Peskine449bd832023-01-11 14:50:10 +01007012 status = setup_psa_key_derivation(&derivation, psk, alg,
7013 ssl->conf->psk, ssl->conf->psk_len,
7014 seed, seed_len,
7015 (unsigned char const *) lbl,
7016 (size_t) strlen(lbl),
7017 other_secret, other_secret_len,
7018 master_secret_len);
7019 if (status != PSA_SUCCESS) {
7020 psa_key_derivation_abort(&derivation);
7021 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007022 }
7023
Gilles Peskine449bd832023-01-11 14:50:10 +01007024 status = psa_key_derivation_output_bytes(&derivation,
7025 master,
7026 master_secret_len);
7027 if (status != PSA_SUCCESS) {
7028 psa_key_derivation_abort(&derivation);
7029 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007030 }
7031
Gilles Peskine449bd832023-01-11 14:50:10 +01007032 status = psa_key_derivation_abort(&derivation);
7033 if (status != PSA_SUCCESS) {
7034 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
7035 }
7036 } else
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007037#endif
7038 {
Neil Armstrongca7d5062022-05-31 14:43:23 +02007039#if defined(MBEDTLS_USE_PSA_CRYPTO) && \
Gilles Peskine449bd832023-01-11 14:50:10 +01007040 defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
7041 if (handshake->ciphersuite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_ECJPAKE) {
Neil Armstrongca7d5062022-05-31 14:43:23 +02007042 psa_status_t status;
7043 psa_algorithm_t alg = PSA_ALG_TLS12_ECJPAKE_TO_PMS;
7044 psa_key_derivation_operation_t derivation =
7045 PSA_KEY_DERIVATION_OPERATION_INIT;
7046
Gilles Peskine449bd832023-01-11 14:50:10 +01007047 MBEDTLS_SSL_DEBUG_MSG(2, ("perform PSA-based PMS KDF for ECJPAKE"));
Neil Armstrongca7d5062022-05-31 14:43:23 +02007048
7049 handshake->pmslen = PSA_TLS12_ECJPAKE_TO_PMS_DATA_SIZE;
7050
Gilles Peskine449bd832023-01-11 14:50:10 +01007051 status = psa_key_derivation_setup(&derivation, alg);
7052 if (status != PSA_SUCCESS) {
7053 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Neil Armstrongca7d5062022-05-31 14:43:23 +02007054 }
7055
Gilles Peskine449bd832023-01-11 14:50:10 +01007056 status = psa_key_derivation_set_capacity(&derivation,
7057 PSA_TLS12_ECJPAKE_TO_PMS_DATA_SIZE);
7058 if (status != PSA_SUCCESS) {
7059 psa_key_derivation_abort(&derivation);
7060 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Neil Armstrongca7d5062022-05-31 14:43:23 +02007061 }
7062
Gilles Peskine449bd832023-01-11 14:50:10 +01007063 status = psa_pake_get_implicit_key(&handshake->psa_pake_ctx,
7064 &derivation);
7065 if (status != PSA_SUCCESS) {
7066 psa_key_derivation_abort(&derivation);
7067 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Neil Armstrongca7d5062022-05-31 14:43:23 +02007068 }
7069
Gilles Peskine449bd832023-01-11 14:50:10 +01007070 status = psa_key_derivation_output_bytes(&derivation,
7071 handshake->premaster,
7072 handshake->pmslen);
7073 if (status != PSA_SUCCESS) {
7074 psa_key_derivation_abort(&derivation);
7075 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
7076 }
7077
7078 status = psa_key_derivation_abort(&derivation);
7079 if (status != PSA_SUCCESS) {
7080 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Neil Armstrongca7d5062022-05-31 14:43:23 +02007081 }
7082 }
7083#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01007084 ret = handshake->tls_prf(handshake->premaster, handshake->pmslen,
7085 lbl, seed, seed_len,
7086 master,
7087 master_secret_len);
7088 if (ret != 0) {
7089 MBEDTLS_SSL_DEBUG_RET(1, "prf", ret);
7090 return ret;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007091 }
7092
Gilles Peskine449bd832023-01-11 14:50:10 +01007093 MBEDTLS_SSL_DEBUG_BUF(3, "premaster secret",
7094 handshake->premaster,
7095 handshake->pmslen);
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007096
Gilles Peskine449bd832023-01-11 14:50:10 +01007097 mbedtls_platform_zeroize(handshake->premaster,
7098 sizeof(handshake->premaster));
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007099 }
7100
Gilles Peskine449bd832023-01-11 14:50:10 +01007101 return 0;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007102}
7103
Gilles Peskine449bd832023-01-11 14:50:10 +01007104int mbedtls_ssl_derive_keys(mbedtls_ssl_context *ssl)
Jerry Yud62f87e2022-02-17 14:09:02 +08007105{
7106 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7107 const mbedtls_ssl_ciphersuite_t * const ciphersuite_info =
7108 ssl->handshake->ciphersuite_info;
7109
Gilles Peskine449bd832023-01-11 14:50:10 +01007110 MBEDTLS_SSL_DEBUG_MSG(2, ("=> derive keys"));
Jerry Yud62f87e2022-02-17 14:09:02 +08007111
7112 /* Set PRF, calc_verify and calc_finished function pointers */
Gilles Peskine449bd832023-01-11 14:50:10 +01007113 ret = ssl_set_handshake_prfs(ssl->handshake,
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01007114 (mbedtls_md_type_t) ciphersuite_info->mac);
Gilles Peskine449bd832023-01-11 14:50:10 +01007115 if (ret != 0) {
7116 MBEDTLS_SSL_DEBUG_RET(1, "ssl_set_handshake_prfs", ret);
7117 return ret;
Jerry Yud62f87e2022-02-17 14:09:02 +08007118 }
7119
7120 /* Compute master secret if needed */
Gilles Peskine449bd832023-01-11 14:50:10 +01007121 ret = ssl_compute_master(ssl->handshake,
7122 ssl->session_negotiate->master,
7123 ssl);
7124 if (ret != 0) {
7125 MBEDTLS_SSL_DEBUG_RET(1, "ssl_compute_master", ret);
7126 return ret;
Jerry Yud62f87e2022-02-17 14:09:02 +08007127 }
7128
7129 /* Swap the client and server random values:
7130 * - MS derivation wanted client+server (RFC 5246 8.1)
7131 * - key derivation wants server+client (RFC 5246 6.3) */
7132 {
7133 unsigned char tmp[64];
Gilles Peskine449bd832023-01-11 14:50:10 +01007134 memcpy(tmp, ssl->handshake->randbytes, 64);
7135 memcpy(ssl->handshake->randbytes, tmp + 32, 32);
7136 memcpy(ssl->handshake->randbytes + 32, tmp, 32);
7137 mbedtls_platform_zeroize(tmp, sizeof(tmp));
Jerry Yud62f87e2022-02-17 14:09:02 +08007138 }
7139
7140 /* Populate transform structure */
Gilles Peskine449bd832023-01-11 14:50:10 +01007141 ret = ssl_tls12_populate_transform(ssl->transform_negotiate,
7142 ssl->session_negotiate->ciphersuite,
7143 ssl->session_negotiate->master,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02007144#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01007145 ssl->session_negotiate->encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02007146#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01007147 ssl->handshake->tls_prf,
7148 ssl->handshake->randbytes,
7149 ssl->tls_version,
7150 ssl->conf->endpoint,
7151 ssl);
7152 if (ret != 0) {
7153 MBEDTLS_SSL_DEBUG_RET(1, "ssl_tls12_populate_transform", ret);
7154 return ret;
Jerry Yud62f87e2022-02-17 14:09:02 +08007155 }
7156
7157 /* We no longer need Server/ClientHello.random values */
Gilles Peskine449bd832023-01-11 14:50:10 +01007158 mbedtls_platform_zeroize(ssl->handshake->randbytes,
7159 sizeof(ssl->handshake->randbytes));
Jerry Yud62f87e2022-02-17 14:09:02 +08007160
Gilles Peskine449bd832023-01-11 14:50:10 +01007161 MBEDTLS_SSL_DEBUG_MSG(2, ("<= derive keys"));
Jerry Yud62f87e2022-02-17 14:09:02 +08007162
Gilles Peskine449bd832023-01-11 14:50:10 +01007163 return 0;
Jerry Yud62f87e2022-02-17 14:09:02 +08007164}
Jerry Yu8392e0d2022-02-17 14:10:24 +08007165
Gilles Peskine449bd832023-01-11 14:50:10 +01007166int mbedtls_ssl_set_calc_verify_md(mbedtls_ssl_context *ssl, int md)
Ronald Cron4dcbca92022-03-07 10:21:40 +01007167{
Gilles Peskine449bd832023-01-11 14:50:10 +01007168 switch (md) {
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01007169#if defined(MBEDTLS_MD_CAN_SHA384)
Ronald Cron4dcbca92022-03-07 10:21:40 +01007170 case MBEDTLS_SSL_HASH_SHA384:
7171 ssl->handshake->calc_verify = ssl_calc_verify_tls_sha384;
7172 break;
7173#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01007174#if defined(MBEDTLS_MD_CAN_SHA256)
Ronald Cron4dcbca92022-03-07 10:21:40 +01007175 case MBEDTLS_SSL_HASH_SHA256:
7176 ssl->handshake->calc_verify = ssl_calc_verify_tls_sha256;
7177 break;
7178#endif
7179 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01007180 return -1;
Ronald Cron4dcbca92022-03-07 10:21:40 +01007181 }
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01007182#if !defined(MBEDTLS_MD_CAN_SHA384) && \
7183 !defined(MBEDTLS_MD_CAN_SHA256)
Andrzej Kurekeabeb302022-10-17 07:52:51 -04007184 (void) ssl;
7185#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01007186 return 0;
Ronald Cron4dcbca92022-03-07 10:21:40 +01007187}
7188
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007189#if defined(MBEDTLS_USE_PSA_CRYPTO)
7190static int ssl_calc_verify_tls_psa(const mbedtls_ssl_context *ssl,
7191 const psa_hash_operation_t *hs_op,
7192 size_t buffer_size,
7193 unsigned char *hash,
7194 size_t *hlen)
7195{
7196 psa_status_t status;
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007197 psa_hash_operation_t cloned_op = psa_hash_operation_init();
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007198
7199#if !defined(MBEDTLS_DEBUG_C)
7200 (void) ssl;
7201#endif
7202 MBEDTLS_SSL_DEBUG_MSG(2, ("=> PSA calc verify"));
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007203 status = psa_hash_clone(hs_op, &cloned_op);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007204 if (status != PSA_SUCCESS) {
7205 goto exit;
7206 }
7207
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007208 status = psa_hash_finish(&cloned_op, hash, buffer_size, hlen);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007209 if (status != PSA_SUCCESS) {
7210 goto exit;
7211 }
7212
7213 MBEDTLS_SSL_DEBUG_BUF(3, "PSA calculated verify result", hash, *hlen);
7214 MBEDTLS_SSL_DEBUG_MSG(2, ("<= PSA calc verify"));
7215
7216exit:
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007217 psa_hash_abort(&cloned_op);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007218 return mbedtls_md_error_from_psa(status);
7219}
7220#else
7221static int ssl_calc_verify_tls_legacy(const mbedtls_ssl_context *ssl,
7222 const mbedtls_md_context_t *hs_ctx,
7223 unsigned char *hash,
7224 size_t *hlen)
7225{
7226 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007227 mbedtls_md_context_t cloned_ctx;
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007228
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007229 mbedtls_md_init(&cloned_ctx);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007230
7231#if !defined(MBEDTLS_DEBUG_C)
7232 (void) ssl;
7233#endif
7234 MBEDTLS_SSL_DEBUG_MSG(2, ("=> calc verify"));
7235
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007236 ret = mbedtls_md_setup(&cloned_ctx, mbedtls_md_info_from_ctx(hs_ctx), 0);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007237 if (ret != 0) {
7238 goto exit;
7239 }
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007240 ret = mbedtls_md_clone(&cloned_ctx, hs_ctx);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007241 if (ret != 0) {
7242 goto exit;
7243 }
7244
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007245 ret = mbedtls_md_finish(&cloned_ctx, hash);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007246 if (ret != 0) {
7247 goto exit;
7248 }
7249
7250 *hlen = mbedtls_md_get_size(mbedtls_md_info_from_ctx(hs_ctx));
7251
7252 MBEDTLS_SSL_DEBUG_BUF(3, "calculated verify result", hash, *hlen);
7253 MBEDTLS_SSL_DEBUG_MSG(2, ("<= calc verify"));
7254
7255exit:
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007256 mbedtls_md_free(&cloned_ctx);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007257 return ret;
7258}
7259#endif /* MBEDTLS_USE_PSA_CRYPTO */
7260
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01007261#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +01007262int ssl_calc_verify_tls_sha256(const mbedtls_ssl_context *ssl,
7263 unsigned char *hash,
7264 size_t *hlen)
Jerry Yu8392e0d2022-02-17 14:10:24 +08007265{
7266#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007267 return ssl_calc_verify_tls_psa(ssl, &ssl->handshake->fin_sha256_psa, 32,
7268 hash, hlen);
Jerry Yu8392e0d2022-02-17 14:10:24 +08007269#else
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007270 return ssl_calc_verify_tls_legacy(ssl, &ssl->handshake->fin_sha256,
7271 hash, hlen);
Jerry Yu8392e0d2022-02-17 14:10:24 +08007272#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu8392e0d2022-02-17 14:10:24 +08007273}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01007274#endif /* MBEDTLS_MD_CAN_SHA256 */
Jerry Yu8392e0d2022-02-17 14:10:24 +08007275
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01007276#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +01007277int ssl_calc_verify_tls_sha384(const mbedtls_ssl_context *ssl,
7278 unsigned char *hash,
7279 size_t *hlen)
Jerry Yuc1cb3842022-02-17 14:13:48 +08007280{
7281#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007282 return ssl_calc_verify_tls_psa(ssl, &ssl->handshake->fin_sha384_psa, 48,
7283 hash, hlen);
Jerry Yuc1cb3842022-02-17 14:13:48 +08007284#else
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007285 return ssl_calc_verify_tls_legacy(ssl, &ssl->handshake->fin_sha384,
7286 hash, hlen);
Jerry Yuc1cb3842022-02-17 14:13:48 +08007287#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yuc1cb3842022-02-17 14:13:48 +08007288}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01007289#endif /* MBEDTLS_MD_CAN_SHA384 */
Jerry Yuc1cb3842022-02-17 14:13:48 +08007290
Neil Armstrong80f6f322022-05-03 17:56:38 +02007291#if !defined(MBEDTLS_USE_PSA_CRYPTO) && \
7292 defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007293int mbedtls_ssl_psk_derive_premaster(mbedtls_ssl_context *ssl, mbedtls_key_exchange_type_t key_ex)
Jerry Yuce3dca42022-02-17 14:16:37 +08007294{
7295 unsigned char *p = ssl->handshake->premaster;
Gilles Peskine449bd832023-01-11 14:50:10 +01007296 unsigned char *end = p + sizeof(ssl->handshake->premaster);
Jerry Yuce3dca42022-02-17 14:16:37 +08007297 const unsigned char *psk = NULL;
7298 size_t psk_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01007299 int psk_ret = mbedtls_ssl_get_psk(ssl, &psk, &psk_len);
Jerry Yuce3dca42022-02-17 14:16:37 +08007300
Gilles Peskine449bd832023-01-11 14:50:10 +01007301 if (psk_ret == MBEDTLS_ERR_SSL_PRIVATE_KEY_REQUIRED) {
Jerry Yuce3dca42022-02-17 14:16:37 +08007302 /*
7303 * This should never happen because the existence of a PSK is always
Przemek Stekielb293aaa2022-04-19 12:22:38 +02007304 * checked before calling this function.
7305 *
7306 * The exception is opaque DHE-PSK. For DHE-PSK fill premaster with
Przemek Stekiel8abcee92022-04-28 09:16:28 +02007307 * the shared secret without PSK.
Jerry Yuce3dca42022-02-17 14:16:37 +08007308 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007309 if (key_ex != MBEDTLS_KEY_EXCHANGE_DHE_PSK) {
7310 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
7311 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Przemek Stekielb293aaa2022-04-19 12:22:38 +02007312 }
Jerry Yuce3dca42022-02-17 14:16:37 +08007313 }
7314
7315 /*
7316 * PMS = struct {
7317 * opaque other_secret<0..2^16-1>;
7318 * opaque psk<0..2^16-1>;
7319 * };
7320 * with "other_secret" depending on the particular key exchange
7321 */
7322#if defined(MBEDTLS_KEY_EXCHANGE_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007323 if (key_ex == MBEDTLS_KEY_EXCHANGE_PSK) {
7324 if (end - p < 2) {
7325 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
7326 }
Jerry Yuce3dca42022-02-17 14:16:37 +08007327
Gilles Peskine449bd832023-01-11 14:50:10 +01007328 MBEDTLS_PUT_UINT16_BE(psk_len, p, 0);
Jerry Yuce3dca42022-02-17 14:16:37 +08007329 p += 2;
7330
Gilles Peskine449bd832023-01-11 14:50:10 +01007331 if (end < p || (size_t) (end - p) < psk_len) {
7332 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
7333 }
Jerry Yuce3dca42022-02-17 14:16:37 +08007334
Gilles Peskine449bd832023-01-11 14:50:10 +01007335 memset(p, 0, psk_len);
Jerry Yuce3dca42022-02-17 14:16:37 +08007336 p += psk_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01007337 } else
Jerry Yuce3dca42022-02-17 14:16:37 +08007338#endif /* MBEDTLS_KEY_EXCHANGE_PSK_ENABLED */
7339#if defined(MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007340 if (key_ex == MBEDTLS_KEY_EXCHANGE_RSA_PSK) {
Jerry Yuce3dca42022-02-17 14:16:37 +08007341 /*
7342 * other_secret already set by the ClientKeyExchange message,
7343 * and is 48 bytes long
7344 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007345 if (end - p < 2) {
7346 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
7347 }
Jerry Yuce3dca42022-02-17 14:16:37 +08007348
7349 *p++ = 0;
7350 *p++ = 48;
7351 p += 48;
Gilles Peskine449bd832023-01-11 14:50:10 +01007352 } else
Jerry Yuce3dca42022-02-17 14:16:37 +08007353#endif /* MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED */
7354#if defined(MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007355 if (key_ex == MBEDTLS_KEY_EXCHANGE_DHE_PSK) {
Jerry Yuce3dca42022-02-17 14:16:37 +08007356 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7357 size_t len;
7358
7359 /* Write length only when we know the actual value */
Gilles Peskine449bd832023-01-11 14:50:10 +01007360 if ((ret = mbedtls_dhm_calc_secret(&ssl->handshake->dhm_ctx,
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00007361 p + 2, (size_t) (end - (p + 2)), &len,
Gilles Peskine449bd832023-01-11 14:50:10 +01007362 ssl->conf->f_rng, ssl->conf->p_rng)) != 0) {
7363 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_dhm_calc_secret", ret);
7364 return ret;
Jerry Yuce3dca42022-02-17 14:16:37 +08007365 }
Gilles Peskine449bd832023-01-11 14:50:10 +01007366 MBEDTLS_PUT_UINT16_BE(len, p, 0);
Jerry Yuce3dca42022-02-17 14:16:37 +08007367 p += 2 + len;
7368
Gilles Peskine449bd832023-01-11 14:50:10 +01007369 MBEDTLS_SSL_DEBUG_MPI(3, "DHM: K ", &ssl->handshake->dhm_ctx.K);
7370 } else
Jerry Yuce3dca42022-02-17 14:16:37 +08007371#endif /* MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED */
Neil Armstrong80f6f322022-05-03 17:56:38 +02007372#if defined(MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007373 if (key_ex == MBEDTLS_KEY_EXCHANGE_ECDHE_PSK) {
Jerry Yuce3dca42022-02-17 14:16:37 +08007374 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7375 size_t zlen;
7376
Gilles Peskine449bd832023-01-11 14:50:10 +01007377 if ((ret = mbedtls_ecdh_calc_secret(&ssl->handshake->ecdh_ctx, &zlen,
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00007378 p + 2, (size_t) (end - (p + 2)),
Gilles Peskine449bd832023-01-11 14:50:10 +01007379 ssl->conf->f_rng, ssl->conf->p_rng)) != 0) {
7380 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ecdh_calc_secret", ret);
7381 return ret;
Jerry Yuce3dca42022-02-17 14:16:37 +08007382 }
7383
Gilles Peskine449bd832023-01-11 14:50:10 +01007384 MBEDTLS_PUT_UINT16_BE(zlen, p, 0);
Jerry Yuce3dca42022-02-17 14:16:37 +08007385 p += 2 + zlen;
7386
Gilles Peskine449bd832023-01-11 14:50:10 +01007387 MBEDTLS_SSL_DEBUG_ECDH(3, &ssl->handshake->ecdh_ctx,
7388 MBEDTLS_DEBUG_ECDH_Z);
7389 } else
Neil Armstrong80f6f322022-05-03 17:56:38 +02007390#endif /* MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED */
Jerry Yuce3dca42022-02-17 14:16:37 +08007391 {
Gilles Peskine449bd832023-01-11 14:50:10 +01007392 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
7393 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yuce3dca42022-02-17 14:16:37 +08007394 }
7395
7396 /* opaque psk<0..2^16-1>; */
Gilles Peskine449bd832023-01-11 14:50:10 +01007397 if (end - p < 2) {
7398 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
7399 }
Jerry Yuce3dca42022-02-17 14:16:37 +08007400
Gilles Peskine449bd832023-01-11 14:50:10 +01007401 MBEDTLS_PUT_UINT16_BE(psk_len, p, 0);
Jerry Yuce3dca42022-02-17 14:16:37 +08007402 p += 2;
7403
Gilles Peskine449bd832023-01-11 14:50:10 +01007404 if (end < p || (size_t) (end - p) < psk_len) {
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 memcpy(p, psk, psk_len);
Jerry Yuce3dca42022-02-17 14:16:37 +08007409 p += psk_len;
7410
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00007411 ssl->handshake->pmslen = (size_t) (p - ssl->handshake->premaster);
Jerry Yuce3dca42022-02-17 14:16:37 +08007412
Gilles Peskine449bd832023-01-11 14:50:10 +01007413 return 0;
Jerry Yuce3dca42022-02-17 14:16:37 +08007414}
Neil Armstrong80f6f322022-05-03 17:56:38 +02007415#endif /* !MBEDTLS_USE_PSA_CRYPTO && MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
Jerry Yuc2c673d2022-02-17 14:20:39 +08007416
7417#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007418MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007419static int ssl_write_hello_request(mbedtls_ssl_context *ssl);
Jerry Yuc2c673d2022-02-17 14:20:39 +08007420
7421#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01007422int mbedtls_ssl_resend_hello_request(mbedtls_ssl_context *ssl)
Jerry Yuc2c673d2022-02-17 14:20:39 +08007423{
7424 /* If renegotiation is not enforced, retransmit until we would reach max
7425 * timeout if we were using the usual handshake doubling scheme */
Gilles Peskine449bd832023-01-11 14:50:10 +01007426 if (ssl->conf->renego_max_records < 0) {
Jerry Yuc2c673d2022-02-17 14:20:39 +08007427 uint32_t ratio = ssl->conf->hs_timeout_max / ssl->conf->hs_timeout_min + 1;
7428 unsigned char doublings = 1;
7429
Gilles Peskine449bd832023-01-11 14:50:10 +01007430 while (ratio != 0) {
Jerry Yuc2c673d2022-02-17 14:20:39 +08007431 ++doublings;
7432 ratio >>= 1;
7433 }
7434
Gilles Peskine449bd832023-01-11 14:50:10 +01007435 if (++ssl->renego_records_seen > doublings) {
7436 MBEDTLS_SSL_DEBUG_MSG(2, ("no longer retransmitting hello request"));
7437 return 0;
Jerry Yuc2c673d2022-02-17 14:20:39 +08007438 }
7439 }
7440
Gilles Peskine449bd832023-01-11 14:50:10 +01007441 return ssl_write_hello_request(ssl);
Jerry Yuc2c673d2022-02-17 14:20:39 +08007442}
7443#endif
7444#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_RENEGOTIATION */
Jerry Yud9526692022-02-17 14:23:47 +08007445
Jerry Yud9526692022-02-17 14:23:47 +08007446/*
7447 * Handshake functions
7448 */
7449#if !defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
7450/* No certificate support -> dummy functions */
Gilles Peskine449bd832023-01-11 14:50:10 +01007451int mbedtls_ssl_write_certificate(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08007452{
7453 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
7454 ssl->handshake->ciphersuite_info;
7455
Gilles Peskine449bd832023-01-11 14:50:10 +01007456 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007457
Gilles Peskine449bd832023-01-11 14:50:10 +01007458 if (!mbedtls_ssl_ciphersuite_uses_srv_cert(ciphersuite_info)) {
7459 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007460 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01007461 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007462 }
7463
Gilles Peskine449bd832023-01-11 14:50:10 +01007464 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
7465 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007466}
7467
Gilles Peskine449bd832023-01-11 14:50:10 +01007468int mbedtls_ssl_parse_certificate(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08007469{
7470 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
7471 ssl->handshake->ciphersuite_info;
7472
Gilles Peskine449bd832023-01-11 14:50:10 +01007473 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007474
Gilles Peskine449bd832023-01-11 14:50:10 +01007475 if (!mbedtls_ssl_ciphersuite_uses_srv_cert(ciphersuite_info)) {
7476 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007477 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01007478 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007479 }
7480
Gilles Peskine449bd832023-01-11 14:50:10 +01007481 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
7482 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007483}
7484
7485#else /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
7486/* Some certificate support -> implement write and parse */
7487
Gilles Peskine449bd832023-01-11 14:50:10 +01007488int mbedtls_ssl_write_certificate(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08007489{
7490 int ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
7491 size_t i, n;
7492 const mbedtls_x509_crt *crt;
7493 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
7494 ssl->handshake->ciphersuite_info;
7495
Gilles Peskine449bd832023-01-11 14:50:10 +01007496 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007497
Gilles Peskine449bd832023-01-11 14:50:10 +01007498 if (!mbedtls_ssl_ciphersuite_uses_srv_cert(ciphersuite_info)) {
7499 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007500 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01007501 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007502 }
7503
7504#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007505 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
7506 if (ssl->handshake->client_auth == 0) {
7507 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007508 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01007509 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007510 }
7511 }
7512#endif /* MBEDTLS_SSL_CLI_C */
7513#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007514 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
7515 if (mbedtls_ssl_own_cert(ssl) == NULL) {
Jerry Yud9526692022-02-17 14:23:47 +08007516 /* Should never happen because we shouldn't have picked the
7517 * ciphersuite if we don't have a certificate. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007518 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007519 }
7520 }
7521#endif
7522
Gilles Peskine449bd832023-01-11 14:50:10 +01007523 MBEDTLS_SSL_DEBUG_CRT(3, "own certificate", mbedtls_ssl_own_cert(ssl));
Jerry Yud9526692022-02-17 14:23:47 +08007524
7525 /*
7526 * 0 . 0 handshake type
7527 * 1 . 3 handshake length
7528 * 4 . 6 length of all certs
7529 * 7 . 9 length of cert. 1
7530 * 10 . n-1 peer certificate
7531 * n . n+2 length of cert. 2
7532 * n+3 . ... upper level cert, etc.
7533 */
7534 i = 7;
Gilles Peskine449bd832023-01-11 14:50:10 +01007535 crt = mbedtls_ssl_own_cert(ssl);
Jerry Yud9526692022-02-17 14:23:47 +08007536
Gilles Peskine449bd832023-01-11 14:50:10 +01007537 while (crt != NULL) {
Jerry Yud9526692022-02-17 14:23:47 +08007538 n = crt->raw.len;
Gilles Peskine449bd832023-01-11 14:50:10 +01007539 if (n > MBEDTLS_SSL_OUT_CONTENT_LEN - 3 - i) {
7540 MBEDTLS_SSL_DEBUG_MSG(1, ("certificate too large, %" MBEDTLS_PRINTF_SIZET
7541 " > %" MBEDTLS_PRINTF_SIZET,
7542 i + 3 + n, (size_t) MBEDTLS_SSL_OUT_CONTENT_LEN));
7543 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
Jerry Yud9526692022-02-17 14:23:47 +08007544 }
7545
Gilles Peskine449bd832023-01-11 14:50:10 +01007546 ssl->out_msg[i] = MBEDTLS_BYTE_2(n);
7547 ssl->out_msg[i + 1] = MBEDTLS_BYTE_1(n);
7548 ssl->out_msg[i + 2] = MBEDTLS_BYTE_0(n);
Jerry Yud9526692022-02-17 14:23:47 +08007549
Gilles Peskine449bd832023-01-11 14:50:10 +01007550 i += 3; memcpy(ssl->out_msg + i, crt->raw.p, n);
Jerry Yud9526692022-02-17 14:23:47 +08007551 i += n; crt = crt->next;
7552 }
7553
Gilles Peskine449bd832023-01-11 14:50:10 +01007554 ssl->out_msg[4] = MBEDTLS_BYTE_2(i - 7);
7555 ssl->out_msg[5] = MBEDTLS_BYTE_1(i - 7);
7556 ssl->out_msg[6] = MBEDTLS_BYTE_0(i - 7);
Jerry Yud9526692022-02-17 14:23:47 +08007557
7558 ssl->out_msglen = i;
7559 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
7560 ssl->out_msg[0] = MBEDTLS_SSL_HS_CERTIFICATE;
7561
7562 ssl->state++;
7563
Gilles Peskine449bd832023-01-11 14:50:10 +01007564 if ((ret = mbedtls_ssl_write_handshake_msg(ssl)) != 0) {
7565 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_handshake_msg", ret);
7566 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007567 }
7568
Gilles Peskine449bd832023-01-11 14:50:10 +01007569 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007570
Gilles Peskine449bd832023-01-11 14:50:10 +01007571 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007572}
7573
7574#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
7575
7576#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007577MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007578static int ssl_check_peer_crt_unchanged(mbedtls_ssl_context *ssl,
7579 unsigned char *crt_buf,
7580 size_t crt_buf_len)
Jerry Yud9526692022-02-17 14:23:47 +08007581{
7582 mbedtls_x509_crt const * const peer_crt = ssl->session->peer_cert;
7583
Gilles Peskine449bd832023-01-11 14:50:10 +01007584 if (peer_crt == NULL) {
7585 return -1;
7586 }
Jerry Yud9526692022-02-17 14:23:47 +08007587
Gilles Peskine449bd832023-01-11 14:50:10 +01007588 if (peer_crt->raw.len != crt_buf_len) {
7589 return -1;
7590 }
Jerry Yud9526692022-02-17 14:23:47 +08007591
Gilles Peskine449bd832023-01-11 14:50:10 +01007592 return memcmp(peer_crt->raw.p, crt_buf, peer_crt->raw.len);
Jerry Yud9526692022-02-17 14:23:47 +08007593}
7594#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007595MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007596static int ssl_check_peer_crt_unchanged(mbedtls_ssl_context *ssl,
7597 unsigned char *crt_buf,
7598 size_t crt_buf_len)
Jerry Yud9526692022-02-17 14:23:47 +08007599{
7600 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7601 unsigned char const * const peer_cert_digest =
7602 ssl->session->peer_cert_digest;
7603 mbedtls_md_type_t const peer_cert_digest_type =
7604 ssl->session->peer_cert_digest_type;
7605 mbedtls_md_info_t const * const digest_info =
Gilles Peskine449bd832023-01-11 14:50:10 +01007606 mbedtls_md_info_from_type(peer_cert_digest_type);
Jerry Yud9526692022-02-17 14:23:47 +08007607 unsigned char tmp_digest[MBEDTLS_SSL_PEER_CERT_DIGEST_MAX_LEN];
7608 size_t digest_len;
7609
Gilles Peskine449bd832023-01-11 14:50:10 +01007610 if (peer_cert_digest == NULL || digest_info == NULL) {
7611 return -1;
7612 }
Jerry Yud9526692022-02-17 14:23:47 +08007613
Gilles Peskine449bd832023-01-11 14:50:10 +01007614 digest_len = mbedtls_md_get_size(digest_info);
7615 if (digest_len > MBEDTLS_SSL_PEER_CERT_DIGEST_MAX_LEN) {
7616 return -1;
7617 }
Jerry Yud9526692022-02-17 14:23:47 +08007618
Gilles Peskine449bd832023-01-11 14:50:10 +01007619 ret = mbedtls_md(digest_info, crt_buf, crt_buf_len, tmp_digest);
7620 if (ret != 0) {
7621 return -1;
7622 }
Jerry Yud9526692022-02-17 14:23:47 +08007623
Gilles Peskine449bd832023-01-11 14:50:10 +01007624 return memcmp(tmp_digest, peer_cert_digest, digest_len);
Jerry Yud9526692022-02-17 14:23:47 +08007625}
7626#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7627#endif /* MBEDTLS_SSL_RENEGOTIATION && MBEDTLS_SSL_CLI_C */
7628
7629/*
7630 * Once the certificate message is read, parse it into a cert chain and
7631 * perform basic checks, but leave actual verification to the caller
7632 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007633MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007634static int ssl_parse_certificate_chain(mbedtls_ssl_context *ssl,
7635 mbedtls_x509_crt *chain)
Jerry Yud9526692022-02-17 14:23:47 +08007636{
7637 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7638#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007639 int crt_cnt = 0;
Jerry Yud9526692022-02-17 14:23:47 +08007640#endif
7641 size_t i, n;
7642 uint8_t alert;
7643
Gilles Peskine449bd832023-01-11 14:50:10 +01007644 if (ssl->in_msgtype != MBEDTLS_SSL_MSG_HANDSHAKE) {
7645 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7646 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7647 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
7648 return MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
Jerry Yud9526692022-02-17 14:23:47 +08007649 }
7650
Gilles Peskine449bd832023-01-11 14:50:10 +01007651 if (ssl->in_msg[0] != MBEDTLS_SSL_HS_CERTIFICATE) {
7652 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7653 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
7654 return MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
Jerry Yud9526692022-02-17 14:23:47 +08007655 }
7656
Gilles Peskine449bd832023-01-11 14:50:10 +01007657 if (ssl->in_hslen < mbedtls_ssl_hs_hdr_len(ssl) + 3 + 3) {
7658 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7659 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7660 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
7661 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007662 }
7663
Gilles Peskine449bd832023-01-11 14:50:10 +01007664 i = mbedtls_ssl_hs_hdr_len(ssl);
Jerry Yud9526692022-02-17 14:23:47 +08007665
7666 /*
7667 * Same message structure as in mbedtls_ssl_write_certificate()
7668 */
Dave Rodgmana3d0f612023-11-03 23:34:02 +00007669 n = MBEDTLS_GET_UINT16_BE(ssl->in_msg, i + 1);
Jerry Yud9526692022-02-17 14:23:47 +08007670
Gilles Peskine449bd832023-01-11 14:50:10 +01007671 if (ssl->in_msg[i] != 0 ||
7672 ssl->in_hslen != n + 3 + mbedtls_ssl_hs_hdr_len(ssl)) {
7673 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7674 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7675 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
7676 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007677 }
7678
7679 /* Make &ssl->in_msg[i] point to the beginning of the CRT chain. */
7680 i += 3;
7681
7682 /* Iterate through and parse the CRTs in the provided chain. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007683 while (i < ssl->in_hslen) {
Jerry Yud9526692022-02-17 14:23:47 +08007684 /* Check that there's room for the next CRT's length fields. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007685 if (i + 3 > ssl->in_hslen) {
7686 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7687 mbedtls_ssl_send_alert_message(ssl,
7688 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7689 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
7690 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007691 }
7692 /* In theory, the CRT can be up to 2**24 Bytes, but we don't support
7693 * anything beyond 2**16 ~ 64K. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007694 if (ssl->in_msg[i] != 0) {
7695 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7696 mbedtls_ssl_send_alert_message(ssl,
7697 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7698 MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT);
7699 return MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
Jerry Yud9526692022-02-17 14:23:47 +08007700 }
7701
7702 /* Read length of the next CRT in the chain. */
Dave Rodgmana3d0f612023-11-03 23:34:02 +00007703 n = MBEDTLS_GET_UINT16_BE(ssl->in_msg, i + 1);
Jerry Yud9526692022-02-17 14:23:47 +08007704 i += 3;
7705
Gilles Peskine449bd832023-01-11 14:50:10 +01007706 if (n < 128 || i + n > ssl->in_hslen) {
7707 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7708 mbedtls_ssl_send_alert_message(ssl,
7709 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7710 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
7711 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007712 }
7713
7714 /* Check if we're handling the first CRT in the chain. */
7715#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007716 if (crt_cnt++ == 0 &&
Jerry Yud9526692022-02-17 14:23:47 +08007717 ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
Gilles Peskine449bd832023-01-11 14:50:10 +01007718 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS) {
Jerry Yud9526692022-02-17 14:23:47 +08007719 /* During client-side renegotiation, check that the server's
7720 * end-CRTs hasn't changed compared to the initial handshake,
7721 * mitigating the triple handshake attack. On success, reuse
7722 * the original end-CRT instead of parsing it again. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007723 MBEDTLS_SSL_DEBUG_MSG(3, ("Check that peer CRT hasn't changed during renegotiation"));
7724 if (ssl_check_peer_crt_unchanged(ssl,
7725 &ssl->in_msg[i],
7726 n) != 0) {
7727 MBEDTLS_SSL_DEBUG_MSG(1, ("new server cert during renegotiation"));
7728 mbedtls_ssl_send_alert_message(ssl,
7729 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7730 MBEDTLS_SSL_ALERT_MSG_ACCESS_DENIED);
7731 return MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
Jerry Yud9526692022-02-17 14:23:47 +08007732 }
7733
7734 /* Now we can safely free the original chain. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007735 ssl_clear_peer_cert(ssl->session);
Jerry Yud9526692022-02-17 14:23:47 +08007736 }
7737#endif /* MBEDTLS_SSL_RENEGOTIATION && MBEDTLS_SSL_CLI_C */
7738
7739 /* Parse the next certificate in the chain. */
7740#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01007741 ret = mbedtls_x509_crt_parse_der(chain, ssl->in_msg + i, n);
Jerry Yud9526692022-02-17 14:23:47 +08007742#else
7743 /* If we don't need to store the CRT chain permanently, parse
7744 * it in-place from the input buffer instead of making a copy. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007745 ret = mbedtls_x509_crt_parse_der_nocopy(chain, ssl->in_msg + i, n);
Jerry Yud9526692022-02-17 14:23:47 +08007746#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Gilles Peskine449bd832023-01-11 14:50:10 +01007747 switch (ret) {
Jerry Yud9526692022-02-17 14:23:47 +08007748 case 0: /*ok*/
7749 case MBEDTLS_ERR_X509_UNKNOWN_SIG_ALG + MBEDTLS_ERR_OID_NOT_FOUND:
7750 /* Ignore certificate with an unknown algorithm: maybe a
7751 prior certificate was already trusted. */
7752 break;
7753
7754 case MBEDTLS_ERR_X509_ALLOC_FAILED:
7755 alert = MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR;
7756 goto crt_parse_der_failed;
7757
7758 case MBEDTLS_ERR_X509_UNKNOWN_VERSION:
7759 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
7760 goto crt_parse_der_failed;
7761
7762 default:
7763 alert = MBEDTLS_SSL_ALERT_MSG_BAD_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01007764crt_parse_der_failed:
7765 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL, alert);
7766 MBEDTLS_SSL_DEBUG_RET(1, " mbedtls_x509_crt_parse_der", ret);
7767 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007768 }
7769
7770 i += n;
7771 }
7772
Gilles Peskine449bd832023-01-11 14:50:10 +01007773 MBEDTLS_SSL_DEBUG_CRT(3, "peer certificate", chain);
7774 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007775}
7776
7777#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007778MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007779static int ssl_srv_check_client_no_crt_notification(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08007780{
Gilles Peskine449bd832023-01-11 14:50:10 +01007781 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
7782 return -1;
7783 }
Jerry Yud9526692022-02-17 14:23:47 +08007784
Gilles Peskine449bd832023-01-11 14:50:10 +01007785 if (ssl->in_hslen == 3 + mbedtls_ssl_hs_hdr_len(ssl) &&
Jerry Yud9526692022-02-17 14:23:47 +08007786 ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
7787 ssl->in_msg[0] == MBEDTLS_SSL_HS_CERTIFICATE &&
Gilles Peskine449bd832023-01-11 14:50:10 +01007788 memcmp(ssl->in_msg + mbedtls_ssl_hs_hdr_len(ssl), "\0\0\0", 3) == 0) {
7789 MBEDTLS_SSL_DEBUG_MSG(1, ("peer has no certificate"));
7790 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007791 }
Gilles Peskine449bd832023-01-11 14:50:10 +01007792 return -1;
Jerry Yud9526692022-02-17 14:23:47 +08007793}
7794#endif /* MBEDTLS_SSL_SRV_C */
7795
7796/* Check if a certificate message is expected.
7797 * Return either
7798 * - SSL_CERTIFICATE_EXPECTED, or
7799 * - SSL_CERTIFICATE_SKIP
7800 * indicating whether a Certificate message is expected or not.
7801 */
7802#define SSL_CERTIFICATE_EXPECTED 0
7803#define SSL_CERTIFICATE_SKIP 1
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007804MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007805static int ssl_parse_certificate_coordinate(mbedtls_ssl_context *ssl,
7806 int authmode)
Jerry Yud9526692022-02-17 14:23:47 +08007807{
7808 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
7809 ssl->handshake->ciphersuite_info;
7810
Gilles Peskine449bd832023-01-11 14:50:10 +01007811 if (!mbedtls_ssl_ciphersuite_uses_srv_cert(ciphersuite_info)) {
7812 return SSL_CERTIFICATE_SKIP;
7813 }
Jerry Yud9526692022-02-17 14:23:47 +08007814
7815#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007816 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
7817 if (ciphersuite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_RSA_PSK) {
7818 return SSL_CERTIFICATE_SKIP;
7819 }
Jerry Yud9526692022-02-17 14:23:47 +08007820
Gilles Peskine449bd832023-01-11 14:50:10 +01007821 if (authmode == MBEDTLS_SSL_VERIFY_NONE) {
Jerry Yud9526692022-02-17 14:23:47 +08007822 ssl->session_negotiate->verify_result =
7823 MBEDTLS_X509_BADCERT_SKIP_VERIFY;
Gilles Peskine449bd832023-01-11 14:50:10 +01007824 return SSL_CERTIFICATE_SKIP;
Jerry Yud9526692022-02-17 14:23:47 +08007825 }
7826 }
7827#else
7828 ((void) authmode);
7829#endif /* MBEDTLS_SSL_SRV_C */
7830
Gilles Peskine449bd832023-01-11 14:50:10 +01007831 return SSL_CERTIFICATE_EXPECTED;
Jerry Yud9526692022-02-17 14:23:47 +08007832}
7833
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007834MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007835static int ssl_parse_certificate_verify(mbedtls_ssl_context *ssl,
7836 int authmode,
7837 mbedtls_x509_crt *chain,
7838 void *rs_ctx)
Jerry Yud9526692022-02-17 14:23:47 +08007839{
7840 int ret = 0;
7841 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
7842 ssl->handshake->ciphersuite_info;
7843 int have_ca_chain = 0;
7844
7845 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *);
7846 void *p_vrfy;
7847
Gilles Peskine449bd832023-01-11 14:50:10 +01007848 if (authmode == MBEDTLS_SSL_VERIFY_NONE) {
7849 return 0;
7850 }
Jerry Yud9526692022-02-17 14:23:47 +08007851
Gilles Peskine449bd832023-01-11 14:50:10 +01007852 if (ssl->f_vrfy != NULL) {
7853 MBEDTLS_SSL_DEBUG_MSG(3, ("Use context-specific verification callback"));
Jerry Yud9526692022-02-17 14:23:47 +08007854 f_vrfy = ssl->f_vrfy;
7855 p_vrfy = ssl->p_vrfy;
Gilles Peskine449bd832023-01-11 14:50:10 +01007856 } else {
7857 MBEDTLS_SSL_DEBUG_MSG(3, ("Use configuration-specific verification callback"));
Jerry Yud9526692022-02-17 14:23:47 +08007858 f_vrfy = ssl->conf->f_vrfy;
7859 p_vrfy = ssl->conf->p_vrfy;
7860 }
7861
7862 /*
7863 * Main check: verify certificate
7864 */
7865#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
Gilles Peskine449bd832023-01-11 14:50:10 +01007866 if (ssl->conf->f_ca_cb != NULL) {
Jerry Yud9526692022-02-17 14:23:47 +08007867 ((void) rs_ctx);
7868 have_ca_chain = 1;
7869
Gilles Peskine449bd832023-01-11 14:50:10 +01007870 MBEDTLS_SSL_DEBUG_MSG(3, ("use CA callback for X.509 CRT verification"));
Jerry Yud9526692022-02-17 14:23:47 +08007871 ret = mbedtls_x509_crt_verify_with_ca_cb(
7872 chain,
7873 ssl->conf->f_ca_cb,
7874 ssl->conf->p_ca_cb,
7875 ssl->conf->cert_profile,
7876 ssl->hostname,
7877 &ssl->session_negotiate->verify_result,
Gilles Peskine449bd832023-01-11 14:50:10 +01007878 f_vrfy, p_vrfy);
7879 } else
Jerry Yud9526692022-02-17 14:23:47 +08007880#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
7881 {
7882 mbedtls_x509_crt *ca_chain;
7883 mbedtls_x509_crl *ca_crl;
7884
7885#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01007886 if (ssl->handshake->sni_ca_chain != NULL) {
Jerry Yud9526692022-02-17 14:23:47 +08007887 ca_chain = ssl->handshake->sni_ca_chain;
7888 ca_crl = ssl->handshake->sni_ca_crl;
Gilles Peskine449bd832023-01-11 14:50:10 +01007889 } else
Jerry Yud9526692022-02-17 14:23:47 +08007890#endif
7891 {
7892 ca_chain = ssl->conf->ca_chain;
7893 ca_crl = ssl->conf->ca_crl;
7894 }
7895
Gilles Peskine449bd832023-01-11 14:50:10 +01007896 if (ca_chain != NULL) {
Jerry Yud9526692022-02-17 14:23:47 +08007897 have_ca_chain = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01007898 }
Jerry Yud9526692022-02-17 14:23:47 +08007899
7900 ret = mbedtls_x509_crt_verify_restartable(
7901 chain,
7902 ca_chain, ca_crl,
7903 ssl->conf->cert_profile,
7904 ssl->hostname,
7905 &ssl->session_negotiate->verify_result,
Gilles Peskine449bd832023-01-11 14:50:10 +01007906 f_vrfy, p_vrfy, rs_ctx);
Jerry Yud9526692022-02-17 14:23:47 +08007907 }
7908
Gilles Peskine449bd832023-01-11 14:50:10 +01007909 if (ret != 0) {
7910 MBEDTLS_SSL_DEBUG_RET(1, "x509_verify_cert", ret);
Jerry Yud9526692022-02-17 14:23:47 +08007911 }
7912
7913#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007914 if (ret == MBEDTLS_ERR_ECP_IN_PROGRESS) {
7915 return MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS;
7916 }
Jerry Yud9526692022-02-17 14:23:47 +08007917#endif
7918
7919 /*
7920 * Secondary checks: always done, but change 'ret' only if it was 0
7921 */
7922
Valerio Settiacd32c02023-06-29 18:06:29 +02007923#if defined(MBEDTLS_PK_HAVE_ECC_KEYS)
Jerry Yud9526692022-02-17 14:23:47 +08007924 {
7925 const mbedtls_pk_context *pk = &chain->pk;
7926
Manuel Pégourié-Gonnard66b0d612022-06-17 10:49:29 +02007927 /* If certificate uses an EC key, make sure the curve is OK.
7928 * This is a public key, so it can't be opaque, so can_do() is a good
7929 * enough check to ensure pk_ec() is safe to use here. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007930 if (mbedtls_pk_can_do(pk, MBEDTLS_PK_ECKEY)) {
Leonid Rozenboim19e59732022-08-08 16:52:38 -07007931 /* and in the unlikely case the above assumption no longer holds
7932 * we are making sure that pk_ec() here does not return a NULL
7933 */
Valerio Settif9362b72023-11-29 08:42:27 +01007934 mbedtls_ecp_group_id grp_id = mbedtls_pk_get_ec_group_id(pk);
Valerio Settid0405092023-05-24 13:16:40 +02007935 if (grp_id == MBEDTLS_ECP_DP_NONE) {
7936 MBEDTLS_SSL_DEBUG_MSG(1, ("invalid group ID"));
Gilles Peskine449bd832023-01-11 14:50:10 +01007937 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Leonid Rozenboim19e59732022-08-08 16:52:38 -07007938 }
Valerio Setti97207782023-05-18 18:59:06 +02007939 if (mbedtls_ssl_check_curve(ssl, grp_id) != 0) {
Leonid Rozenboim19e59732022-08-08 16:52:38 -07007940 ssl->session_negotiate->verify_result |=
7941 MBEDTLS_X509_BADCERT_BAD_KEY;
7942
Gilles Peskine449bd832023-01-11 14:50:10 +01007943 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate (EC key curve)"));
7944 if (ret == 0) {
Leonid Rozenboim19e59732022-08-08 16:52:38 -07007945 ret = MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
Gilles Peskine449bd832023-01-11 14:50:10 +01007946 }
Leonid Rozenboim19e59732022-08-08 16:52:38 -07007947 }
Jerry Yud9526692022-02-17 14:23:47 +08007948 }
7949 }
Valerio Settiacd32c02023-06-29 18:06:29 +02007950#endif /* MBEDTLS_PK_HAVE_ECC_KEYS */
Jerry Yud9526692022-02-17 14:23:47 +08007951
Gilles Peskine449bd832023-01-11 14:50:10 +01007952 if (mbedtls_ssl_check_cert_usage(chain,
7953 ciphersuite_info,
7954 !ssl->conf->endpoint,
7955 &ssl->session_negotiate->verify_result) != 0) {
7956 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate (usage extensions)"));
7957 if (ret == 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007958 ret = MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
Gilles Peskine449bd832023-01-11 14:50:10 +01007959 }
Jerry Yud9526692022-02-17 14:23:47 +08007960 }
7961
7962 /* mbedtls_x509_crt_verify_with_profile is supposed to report a
7963 * verification failure through MBEDTLS_ERR_X509_CERT_VERIFY_FAILED,
7964 * with details encoded in the verification flags. All other kinds
7965 * of error codes, including those from the user provided f_vrfy
7966 * functions, are treated as fatal and lead to a failure of
7967 * ssl_parse_certificate even if verification was optional. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007968 if (authmode == MBEDTLS_SSL_VERIFY_OPTIONAL &&
7969 (ret == MBEDTLS_ERR_X509_CERT_VERIFY_FAILED ||
7970 ret == MBEDTLS_ERR_SSL_BAD_CERTIFICATE)) {
Jerry Yud9526692022-02-17 14:23:47 +08007971 ret = 0;
7972 }
7973
Gilles Peskine449bd832023-01-11 14:50:10 +01007974 if (have_ca_chain == 0 && authmode == MBEDTLS_SSL_VERIFY_REQUIRED) {
7975 MBEDTLS_SSL_DEBUG_MSG(1, ("got no CA chain"));
Jerry Yud9526692022-02-17 14:23:47 +08007976 ret = MBEDTLS_ERR_SSL_CA_CHAIN_REQUIRED;
7977 }
7978
Gilles Peskine449bd832023-01-11 14:50:10 +01007979 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007980 uint8_t alert;
7981
7982 /* The certificate may have been rejected for several reasons.
7983 Pick one and send the corresponding alert. Which alert to send
7984 may be a subject of debate in some cases. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007985 if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_OTHER) {
Jerry Yud9526692022-02-17 14:23:47 +08007986 alert = MBEDTLS_SSL_ALERT_MSG_ACCESS_DENIED;
Gilles Peskine449bd832023-01-11 14:50:10 +01007987 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_CN_MISMATCH) {
Jerry Yud9526692022-02-17 14:23:47 +08007988 alert = MBEDTLS_SSL_ALERT_MSG_BAD_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01007989 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_KEY_USAGE) {
Jerry Yud9526692022-02-17 14:23:47 +08007990 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01007991 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_EXT_KEY_USAGE) {
Jerry Yud9526692022-02-17 14:23:47 +08007992 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01007993 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_NS_CERT_TYPE) {
Jerry Yud9526692022-02-17 14:23:47 +08007994 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01007995 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_BAD_PK) {
Jerry Yud9526692022-02-17 14:23:47 +08007996 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01007997 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_BAD_KEY) {
Jerry Yud9526692022-02-17 14:23:47 +08007998 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01007999 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_EXPIRED) {
Jerry Yud9526692022-02-17 14:23:47 +08008000 alert = MBEDTLS_SSL_ALERT_MSG_CERT_EXPIRED;
Gilles Peskine449bd832023-01-11 14:50:10 +01008001 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_REVOKED) {
Jerry Yud9526692022-02-17 14:23:47 +08008002 alert = MBEDTLS_SSL_ALERT_MSG_CERT_REVOKED;
Gilles Peskine449bd832023-01-11 14:50:10 +01008003 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_NOT_TRUSTED) {
Jerry Yud9526692022-02-17 14:23:47 +08008004 alert = MBEDTLS_SSL_ALERT_MSG_UNKNOWN_CA;
Gilles Peskine449bd832023-01-11 14:50:10 +01008005 } else {
Jerry Yud9526692022-02-17 14:23:47 +08008006 alert = MBEDTLS_SSL_ALERT_MSG_CERT_UNKNOWN;
Gilles Peskine449bd832023-01-11 14:50:10 +01008007 }
8008 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8009 alert);
Jerry Yud9526692022-02-17 14:23:47 +08008010 }
8011
8012#if defined(MBEDTLS_DEBUG_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008013 if (ssl->session_negotiate->verify_result != 0) {
8014 MBEDTLS_SSL_DEBUG_MSG(3, ("! Certificate verification flags %08x",
8015 (unsigned int) ssl->session_negotiate->verify_result));
8016 } else {
8017 MBEDTLS_SSL_DEBUG_MSG(3, ("Certificate verification flags clear"));
Jerry Yud9526692022-02-17 14:23:47 +08008018 }
8019#endif /* MBEDTLS_DEBUG_C */
8020
Gilles Peskine449bd832023-01-11 14:50:10 +01008021 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08008022}
8023
8024#if !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02008025MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01008026static int ssl_remember_peer_crt_digest(mbedtls_ssl_context *ssl,
8027 unsigned char *start, size_t len)
Jerry Yud9526692022-02-17 14:23:47 +08008028{
8029 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
8030 /* Remember digest of the peer's end-CRT. */
8031 ssl->session_negotiate->peer_cert_digest =
Gilles Peskine449bd832023-01-11 14:50:10 +01008032 mbedtls_calloc(1, MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN);
8033 if (ssl->session_negotiate->peer_cert_digest == NULL) {
8034 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc(%d bytes) failed",
8035 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN));
8036 mbedtls_ssl_send_alert_message(ssl,
8037 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8038 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR);
Jerry Yud9526692022-02-17 14:23:47 +08008039
Gilles Peskine449bd832023-01-11 14:50:10 +01008040 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
Jerry Yud9526692022-02-17 14:23:47 +08008041 }
8042
Gilles Peskine449bd832023-01-11 14:50:10 +01008043 ret = mbedtls_md(mbedtls_md_info_from_type(
8044 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE),
8045 start, len,
8046 ssl->session_negotiate->peer_cert_digest);
Jerry Yud9526692022-02-17 14:23:47 +08008047
8048 ssl->session_negotiate->peer_cert_digest_type =
8049 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE;
8050 ssl->session_negotiate->peer_cert_digest_len =
8051 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN;
8052
Gilles Peskine449bd832023-01-11 14:50:10 +01008053 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08008054}
8055
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02008056MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01008057static int ssl_remember_peer_pubkey(mbedtls_ssl_context *ssl,
8058 unsigned char *start, size_t len)
Jerry Yud9526692022-02-17 14:23:47 +08008059{
8060 unsigned char *end = start + len;
8061 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
8062
8063 /* Make a copy of the peer's raw public key. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008064 mbedtls_pk_init(&ssl->handshake->peer_pubkey);
8065 ret = mbedtls_pk_parse_subpubkey(&start, end,
8066 &ssl->handshake->peer_pubkey);
8067 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08008068 /* We should have parsed the public key before. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008069 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08008070 }
8071
Gilles Peskine449bd832023-01-11 14:50:10 +01008072 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08008073}
8074#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
8075
Gilles Peskine449bd832023-01-11 14:50:10 +01008076int mbedtls_ssl_parse_certificate(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08008077{
8078 int ret = 0;
8079 int crt_expected;
8080#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
8081 const int authmode = ssl->handshake->sni_authmode != MBEDTLS_SSL_VERIFY_UNSET
8082 ? ssl->handshake->sni_authmode
8083 : ssl->conf->authmode;
8084#else
8085 const int authmode = ssl->conf->authmode;
8086#endif
8087 void *rs_ctx = NULL;
8088 mbedtls_x509_crt *chain = NULL;
8089
Gilles Peskine449bd832023-01-11 14:50:10 +01008090 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08008091
Gilles Peskine449bd832023-01-11 14:50:10 +01008092 crt_expected = ssl_parse_certificate_coordinate(ssl, authmode);
8093 if (crt_expected == SSL_CERTIFICATE_SKIP) {
8094 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08008095 goto exit;
8096 }
8097
8098#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01008099 if (ssl->handshake->ecrs_enabled &&
8100 ssl->handshake->ecrs_state == ssl_ecrs_crt_verify) {
Jerry Yud9526692022-02-17 14:23:47 +08008101 chain = ssl->handshake->ecrs_peer_cert;
8102 ssl->handshake->ecrs_peer_cert = NULL;
8103 goto crt_verify;
8104 }
8105#endif
8106
Gilles Peskine449bd832023-01-11 14:50:10 +01008107 if ((ret = mbedtls_ssl_read_record(ssl, 1)) != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08008108 /* mbedtls_ssl_read_record may have sent an alert already. We
8109 let it decide whether to alert. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008110 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_read_record", ret);
Jerry Yud9526692022-02-17 14:23:47 +08008111 goto exit;
8112 }
8113
8114#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008115 if (ssl_srv_check_client_no_crt_notification(ssl) == 0) {
Jerry Yud9526692022-02-17 14:23:47 +08008116 ssl->session_negotiate->verify_result = MBEDTLS_X509_BADCERT_MISSING;
8117
Gilles Peskine449bd832023-01-11 14:50:10 +01008118 if (authmode != MBEDTLS_SSL_VERIFY_OPTIONAL) {
Jerry Yud9526692022-02-17 14:23:47 +08008119 ret = MBEDTLS_ERR_SSL_NO_CLIENT_CERTIFICATE;
Gilles Peskine449bd832023-01-11 14:50:10 +01008120 }
Jerry Yud9526692022-02-17 14:23:47 +08008121
8122 goto exit;
8123 }
8124#endif /* MBEDTLS_SSL_SRV_C */
8125
8126 /* Clear existing peer CRT structure in case we tried to
8127 * reuse a session but it failed, and allocate a new one. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008128 ssl_clear_peer_cert(ssl->session_negotiate);
Jerry Yud9526692022-02-17 14:23:47 +08008129
Gilles Peskine449bd832023-01-11 14:50:10 +01008130 chain = mbedtls_calloc(1, sizeof(mbedtls_x509_crt));
8131 if (chain == NULL) {
8132 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc(%" MBEDTLS_PRINTF_SIZET " bytes) failed",
8133 sizeof(mbedtls_x509_crt)));
8134 mbedtls_ssl_send_alert_message(ssl,
8135 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8136 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR);
Jerry Yud9526692022-02-17 14:23:47 +08008137
8138 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
8139 goto exit;
8140 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008141 mbedtls_x509_crt_init(chain);
Jerry Yud9526692022-02-17 14:23:47 +08008142
Gilles Peskine449bd832023-01-11 14:50:10 +01008143 ret = ssl_parse_certificate_chain(ssl, chain);
8144 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08008145 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01008146 }
Jerry Yud9526692022-02-17 14:23:47 +08008147
8148#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01008149 if (ssl->handshake->ecrs_enabled) {
Jerry Yud9526692022-02-17 14:23:47 +08008150 ssl->handshake->ecrs_state = ssl_ecrs_crt_verify;
Gilles Peskine449bd832023-01-11 14:50:10 +01008151 }
Jerry Yud9526692022-02-17 14:23:47 +08008152
8153crt_verify:
Gilles Peskine449bd832023-01-11 14:50:10 +01008154 if (ssl->handshake->ecrs_enabled) {
Jerry Yud9526692022-02-17 14:23:47 +08008155 rs_ctx = &ssl->handshake->ecrs_ctx;
Gilles Peskine449bd832023-01-11 14:50:10 +01008156 }
Jerry Yud9526692022-02-17 14:23:47 +08008157#endif
8158
Gilles Peskine449bd832023-01-11 14:50:10 +01008159 ret = ssl_parse_certificate_verify(ssl, authmode,
8160 chain, rs_ctx);
8161 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08008162 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01008163 }
Jerry Yud9526692022-02-17 14:23:47 +08008164
8165#if !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
8166 {
8167 unsigned char *crt_start, *pk_start;
8168 size_t crt_len, pk_len;
8169
8170 /* We parse the CRT chain without copying, so
8171 * these pointers point into the input buffer,
8172 * and are hence still valid after freeing the
8173 * CRT chain. */
8174
8175 crt_start = chain->raw.p;
8176 crt_len = chain->raw.len;
8177
8178 pk_start = chain->pk_raw.p;
8179 pk_len = chain->pk_raw.len;
8180
8181 /* Free the CRT structures before computing
8182 * digest and copying the peer's public key. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008183 mbedtls_x509_crt_free(chain);
8184 mbedtls_free(chain);
Jerry Yud9526692022-02-17 14:23:47 +08008185 chain = NULL;
8186
Gilles Peskine449bd832023-01-11 14:50:10 +01008187 ret = ssl_remember_peer_crt_digest(ssl, crt_start, crt_len);
8188 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08008189 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01008190 }
Jerry Yud9526692022-02-17 14:23:47 +08008191
Gilles Peskine449bd832023-01-11 14:50:10 +01008192 ret = ssl_remember_peer_pubkey(ssl, pk_start, pk_len);
8193 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08008194 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01008195 }
Jerry Yud9526692022-02-17 14:23:47 +08008196 }
8197#else /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
8198 /* Pass ownership to session structure. */
8199 ssl->session_negotiate->peer_cert = chain;
8200 chain = NULL;
8201#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
8202
Gilles Peskine449bd832023-01-11 14:50:10 +01008203 MBEDTLS_SSL_DEBUG_MSG(2, ("<= parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08008204
8205exit:
8206
Gilles Peskine449bd832023-01-11 14:50:10 +01008207 if (ret == 0) {
Jerry Yud9526692022-02-17 14:23:47 +08008208 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01008209 }
Jerry Yud9526692022-02-17 14:23:47 +08008210
8211#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01008212 if (ret == MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS) {
Jerry Yud9526692022-02-17 14:23:47 +08008213 ssl->handshake->ecrs_peer_cert = chain;
8214 chain = NULL;
8215 }
8216#endif
8217
Gilles Peskine449bd832023-01-11 14:50:10 +01008218 if (chain != NULL) {
8219 mbedtls_x509_crt_free(chain);
8220 mbedtls_free(chain);
Jerry Yud9526692022-02-17 14:23:47 +08008221 }
8222
Gilles Peskine449bd832023-01-11 14:50:10 +01008223 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08008224}
8225#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
8226
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008227static int ssl_calc_finished_tls_generic(mbedtls_ssl_context *ssl, void *ctx,
8228 unsigned char *padbuf, size_t hlen,
8229 unsigned char *buf, int from)
Jerry Yu615bd6f2022-02-17 14:25:15 +08008230{
Dave Rodgmanc37ad442023-11-03 23:36:06 +00008231 unsigned int len = 12;
Jerry Yu615bd6f2022-02-17 14:25:15 +08008232 const char *sender;
Jerry Yu615bd6f2022-02-17 14:25:15 +08008233#if defined(MBEDTLS_USE_PSA_CRYPTO)
Jerry Yu615bd6f2022-02-17 14:25:15 +08008234 psa_status_t status;
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008235 psa_hash_operation_t *hs_op = ctx;
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02008236 psa_hash_operation_t cloned_op = PSA_HASH_OPERATION_INIT;
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008237 size_t hash_size;
Jerry Yu615bd6f2022-02-17 14:25:15 +08008238#else
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01008239 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008240 mbedtls_md_context_t *hs_ctx = ctx;
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02008241 mbedtls_md_context_t cloned_ctx;
8242 mbedtls_md_init(&cloned_ctx);
Jerry Yu615bd6f2022-02-17 14:25:15 +08008243#endif
8244
8245 mbedtls_ssl_session *session = ssl->session_negotiate;
Gilles Peskine449bd832023-01-11 14:50:10 +01008246 if (!session) {
Jerry Yu615bd6f2022-02-17 14:25:15 +08008247 session = ssl->session;
Gilles Peskine449bd832023-01-11 14:50:10 +01008248 }
Jerry Yu615bd6f2022-02-17 14:25:15 +08008249
Gilles Peskine449bd832023-01-11 14:50:10 +01008250 sender = (from == MBEDTLS_SSL_IS_CLIENT)
Jerry Yu615bd6f2022-02-17 14:25:15 +08008251 ? "client finished"
8252 : "server finished";
8253
8254#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008255 MBEDTLS_SSL_DEBUG_MSG(2, ("=> calc PSA finished tls"));
Jerry Yu615bd6f2022-02-17 14:25:15 +08008256
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02008257 status = psa_hash_clone(hs_op, &cloned_op);
Gilles Peskine449bd832023-01-11 14:50:10 +01008258 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01008259 goto exit;
Jerry Yu615bd6f2022-02-17 14:25:15 +08008260 }
8261
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02008262 status = psa_hash_finish(&cloned_op, padbuf, hlen, &hash_size);
Gilles Peskine449bd832023-01-11 14:50:10 +01008263 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01008264 goto exit;
Jerry Yu615bd6f2022-02-17 14:25:15 +08008265 }
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008266 MBEDTLS_SSL_DEBUG_BUF(3, "PSA calculated padbuf", padbuf, hlen);
Jerry Yu615bd6f2022-02-17 14:25:15 +08008267#else
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008268 MBEDTLS_SSL_DEBUG_MSG(2, ("=> calc finished tls"));
Jerry Yu615bd6f2022-02-17 14:25:15 +08008269
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02008270 ret = mbedtls_md_setup(&cloned_ctx, mbedtls_md_info_from_ctx(hs_ctx), 0);
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01008271 if (ret != 0) {
8272 goto exit;
8273 }
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02008274 ret = mbedtls_md_clone(&cloned_ctx, hs_ctx);
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01008275 if (ret != 0) {
8276 goto exit;
8277 }
Jerry Yu615bd6f2022-02-17 14:25:15 +08008278
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02008279 ret = mbedtls_md_finish(&cloned_ctx, padbuf);
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008280 if (ret != 0) {
8281 goto exit;
8282 }
8283#endif /* MBEDTLS_USE_PSA_CRYPTO */
8284
8285 MBEDTLS_SSL_DEBUG_BUF(4, "finished output", padbuf, hlen);
8286
Jerry Yu615bd6f2022-02-17 14:25:15 +08008287 /*
8288 * TLSv1.2:
8289 * hash = PRF( master, finished_label,
8290 * Hash( handshake ) )[0.11]
8291 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008292 ssl->handshake->tls_prf(session->master, 48, sender,
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008293 padbuf, hlen, buf, len);
Jerry Yu615bd6f2022-02-17 14:25:15 +08008294
Gilles Peskine449bd832023-01-11 14:50:10 +01008295 MBEDTLS_SSL_DEBUG_BUF(3, "calc finished result", buf, len);
Jerry Yu615bd6f2022-02-17 14:25:15 +08008296
Paul Elliottecb95be2023-08-11 16:41:04 +01008297 mbedtls_platform_zeroize(padbuf, hlen);
Jerry Yu615bd6f2022-02-17 14:25:15 +08008298
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008299 MBEDTLS_SSL_DEBUG_MSG(2, ("<= calc finished"));
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01008300
8301exit:
8302#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02008303 psa_hash_abort(&cloned_op);
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +02008304 return mbedtls_md_error_from_psa(status);
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01008305#else
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02008306 mbedtls_md_free(&cloned_ctx);
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01008307 return ret;
8308#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu615bd6f2022-02-17 14:25:15 +08008309}
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008310
8311#if defined(MBEDTLS_MD_CAN_SHA256)
8312static int ssl_calc_finished_tls_sha256(
8313 mbedtls_ssl_context *ssl, unsigned char *buf, int from)
8314{
8315 unsigned char padbuf[32];
8316 return ssl_calc_finished_tls_generic(ssl,
8317#if defined(MBEDTLS_USE_PSA_CRYPTO)
8318 &ssl->handshake->fin_sha256_psa,
8319#else
8320 &ssl->handshake->fin_sha256,
8321#endif
8322 padbuf, sizeof(padbuf),
8323 buf, from);
8324}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01008325#endif /* MBEDTLS_MD_CAN_SHA256*/
Jerry Yu615bd6f2022-02-17 14:25:15 +08008326
Jerry Yub7ba49e2022-02-17 14:25:53 +08008327
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01008328#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +01008329static int ssl_calc_finished_tls_sha384(
Gilles Peskine449bd832023-01-11 14:50:10 +01008330 mbedtls_ssl_context *ssl, unsigned char *buf, int from)
Jerry Yub7ba49e2022-02-17 14:25:53 +08008331{
Jerry Yub7ba49e2022-02-17 14:25:53 +08008332 unsigned char padbuf[48];
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008333 return ssl_calc_finished_tls_generic(ssl,
Jerry Yub7ba49e2022-02-17 14:25:53 +08008334#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008335 &ssl->handshake->fin_sha384_psa,
Jerry Yub7ba49e2022-02-17 14:25:53 +08008336#else
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008337 &ssl->handshake->fin_sha384,
Jerry Yub7ba49e2022-02-17 14:25:53 +08008338#endif
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008339 padbuf, sizeof(padbuf),
8340 buf, from);
Jerry Yub7ba49e2022-02-17 14:25:53 +08008341}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01008342#endif /* MBEDTLS_MD_CAN_SHA384*/
Jerry Yub7ba49e2022-02-17 14:25:53 +08008343
Gilles Peskine449bd832023-01-11 14:50:10 +01008344void mbedtls_ssl_handshake_wrapup_free_hs_transform(mbedtls_ssl_context *ssl)
Jerry Yuaef00152022-02-17 14:27:31 +08008345{
Gilles Peskine449bd832023-01-11 14:50:10 +01008346 MBEDTLS_SSL_DEBUG_MSG(3, ("=> handshake wrapup: final free"));
Jerry Yuaef00152022-02-17 14:27:31 +08008347
8348 /*
8349 * Free our handshake params
8350 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008351 mbedtls_ssl_handshake_free(ssl);
8352 mbedtls_free(ssl->handshake);
Jerry Yuaef00152022-02-17 14:27:31 +08008353 ssl->handshake = NULL;
8354
8355 /*
Shaun Case8b0ecbc2021-12-20 21:14:10 -08008356 * Free the previous transform and switch in the current one
Jerry Yuaef00152022-02-17 14:27:31 +08008357 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008358 if (ssl->transform) {
8359 mbedtls_ssl_transform_free(ssl->transform);
8360 mbedtls_free(ssl->transform);
Jerry Yuaef00152022-02-17 14:27:31 +08008361 }
8362 ssl->transform = ssl->transform_negotiate;
8363 ssl->transform_negotiate = NULL;
8364
Gilles Peskine449bd832023-01-11 14:50:10 +01008365 MBEDTLS_SSL_DEBUG_MSG(3, ("<= handshake wrapup: final free"));
Jerry Yuaef00152022-02-17 14:27:31 +08008366}
8367
Gilles Peskine449bd832023-01-11 14:50:10 +01008368void mbedtls_ssl_handshake_wrapup(mbedtls_ssl_context *ssl)
Jerry Yu2a9fff52022-02-17 14:28:51 +08008369{
8370 int resume = ssl->handshake->resume;
8371
Gilles Peskine449bd832023-01-11 14:50:10 +01008372 MBEDTLS_SSL_DEBUG_MSG(3, ("=> handshake wrapup"));
Jerry Yu2a9fff52022-02-17 14:28:51 +08008373
8374#if defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01008375 if (ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS) {
Jerry Yu2a9fff52022-02-17 14:28:51 +08008376 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_DONE;
8377 ssl->renego_records_seen = 0;
8378 }
8379#endif
8380
8381 /*
8382 * Free the previous session and switch in the current one
8383 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008384 if (ssl->session) {
Jerry Yu2a9fff52022-02-17 14:28:51 +08008385#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
8386 /* RFC 7366 3.1: keep the EtM state */
8387 ssl->session_negotiate->encrypt_then_mac =
Gilles Peskine449bd832023-01-11 14:50:10 +01008388 ssl->session->encrypt_then_mac;
Jerry Yu2a9fff52022-02-17 14:28:51 +08008389#endif
8390
Gilles Peskine449bd832023-01-11 14:50:10 +01008391 mbedtls_ssl_session_free(ssl->session);
8392 mbedtls_free(ssl->session);
Jerry Yu2a9fff52022-02-17 14:28:51 +08008393 }
8394 ssl->session = ssl->session_negotiate;
8395 ssl->session_negotiate = NULL;
8396
8397 /*
8398 * Add cache entry
8399 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008400 if (ssl->conf->f_set_cache != NULL &&
Jerry Yu2a9fff52022-02-17 14:28:51 +08008401 ssl->session->id_len != 0 &&
Gilles Peskine449bd832023-01-11 14:50:10 +01008402 resume == 0) {
8403 if (ssl->conf->f_set_cache(ssl->conf->p_cache,
8404 ssl->session->id,
8405 ssl->session->id_len,
8406 ssl->session) != 0) {
8407 MBEDTLS_SSL_DEBUG_MSG(1, ("cache did not store session"));
8408 }
Jerry Yu2a9fff52022-02-17 14:28:51 +08008409 }
8410
8411#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01008412 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
8413 ssl->handshake->flight != NULL) {
Jerry Yu2a9fff52022-02-17 14:28:51 +08008414 /* Cancel handshake timer */
Gilles Peskine449bd832023-01-11 14:50:10 +01008415 mbedtls_ssl_set_timer(ssl, 0);
Jerry Yu2a9fff52022-02-17 14:28:51 +08008416
8417 /* Keep last flight around in case we need to resend it:
8418 * we need the handshake and transform structures for that */
Gilles Peskine449bd832023-01-11 14:50:10 +01008419 MBEDTLS_SSL_DEBUG_MSG(3, ("skip freeing handshake and transform"));
8420 } else
Jerry Yu2a9fff52022-02-17 14:28:51 +08008421#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01008422 mbedtls_ssl_handshake_wrapup_free_hs_transform(ssl);
Jerry Yu2a9fff52022-02-17 14:28:51 +08008423
Jerry Yu5ed73ff2022-10-27 13:08:42 +08008424 ssl->state = MBEDTLS_SSL_HANDSHAKE_OVER;
Jerry Yu2a9fff52022-02-17 14:28:51 +08008425
Gilles Peskine449bd832023-01-11 14:50:10 +01008426 MBEDTLS_SSL_DEBUG_MSG(3, ("<= handshake wrapup"));
Jerry Yu2a9fff52022-02-17 14:28:51 +08008427}
8428
Gilles Peskine449bd832023-01-11 14:50:10 +01008429int mbedtls_ssl_write_finished(mbedtls_ssl_context *ssl)
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008430{
Dave Rodgmanc37ad442023-11-03 23:36:06 +00008431 int ret;
8432 unsigned int hash_len;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008433
Gilles Peskine449bd832023-01-11 14:50:10 +01008434 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write finished"));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008435
Gilles Peskine449bd832023-01-11 14:50:10 +01008436 mbedtls_ssl_update_out_pointers(ssl, ssl->transform_negotiate);
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008437
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01008438 ret = ssl->handshake->calc_finished(ssl, ssl->out_msg + 4, ssl->conf->endpoint);
8439 if (ret != 0) {
8440 MBEDTLS_SSL_DEBUG_RET(1, "calc_finished", ret);
8441 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008442
8443 /*
8444 * RFC 5246 7.4.9 (Page 63) says 12 is the default length and ciphersuites
8445 * may define some other value. Currently (early 2016), no defined
8446 * ciphersuite does this (and this is unlikely to change as activity has
8447 * moved to TLS 1.3 now) so we can keep the hardcoded 12 here.
8448 */
8449 hash_len = 12;
8450
8451#if defined(MBEDTLS_SSL_RENEGOTIATION)
8452 ssl->verify_data_len = hash_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01008453 memcpy(ssl->own_verify_data, ssl->out_msg + 4, hash_len);
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008454#endif
8455
8456 ssl->out_msglen = 4 + hash_len;
8457 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
8458 ssl->out_msg[0] = MBEDTLS_SSL_HS_FINISHED;
8459
8460 /*
8461 * In case of session resuming, invert the client and server
8462 * ChangeCipherSpec messages order.
8463 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008464 if (ssl->handshake->resume != 0) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008465#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008466 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008467 ssl->state = MBEDTLS_SSL_HANDSHAKE_WRAPUP;
Gilles Peskine449bd832023-01-11 14:50:10 +01008468 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008469#endif
8470#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008471 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008472 ssl->state = MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC;
Gilles Peskine449bd832023-01-11 14:50:10 +01008473 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008474#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01008475 } else {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008476 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01008477 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008478
8479 /*
8480 * Switch to our negotiated transform and session parameters for outbound
8481 * data.
8482 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008483 MBEDTLS_SSL_DEBUG_MSG(3, ("switching to new transform spec for outbound data"));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008484
8485#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01008486 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008487 unsigned char i;
8488
8489 /* Remember current epoch settings for resending */
8490 ssl->handshake->alt_transform_out = ssl->transform_out;
Gilles Peskine449bd832023-01-11 14:50:10 +01008491 memcpy(ssl->handshake->alt_out_ctr, ssl->cur_out_ctr,
8492 sizeof(ssl->handshake->alt_out_ctr));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008493
8494 /* Set sequence_number to zero */
Gilles Peskine449bd832023-01-11 14:50:10 +01008495 memset(&ssl->cur_out_ctr[2], 0, sizeof(ssl->cur_out_ctr) - 2);
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008496
8497
8498 /* Increment epoch */
Gilles Peskine449bd832023-01-11 14:50:10 +01008499 for (i = 2; i > 0; i--) {
8500 if (++ssl->cur_out_ctr[i - 1] != 0) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008501 break;
Gilles Peskine449bd832023-01-11 14:50:10 +01008502 }
8503 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008504
8505 /* The loop goes to its end iff the counter is wrapping */
Gilles Peskine449bd832023-01-11 14:50:10 +01008506 if (i == 0) {
8507 MBEDTLS_SSL_DEBUG_MSG(1, ("DTLS epoch would wrap"));
8508 return MBEDTLS_ERR_SSL_COUNTER_WRAPPING;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008509 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008510 } else
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008511#endif /* MBEDTLS_SSL_PROTO_DTLS */
Gilles Peskine449bd832023-01-11 14:50:10 +01008512 memset(ssl->cur_out_ctr, 0, sizeof(ssl->cur_out_ctr));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008513
8514 ssl->transform_out = ssl->transform_negotiate;
8515 ssl->session_out = ssl->session_negotiate;
8516
8517#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01008518 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
8519 mbedtls_ssl_send_flight_completed(ssl);
8520 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008521#endif
8522
Gilles Peskine449bd832023-01-11 14:50:10 +01008523 if ((ret = mbedtls_ssl_write_handshake_msg(ssl)) != 0) {
8524 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_handshake_msg", ret);
8525 return ret;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008526 }
8527
8528#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01008529 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
8530 (ret = mbedtls_ssl_flight_transmit(ssl)) != 0) {
8531 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_flight_transmit", ret);
8532 return ret;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008533 }
8534#endif
8535
Gilles Peskine449bd832023-01-11 14:50:10 +01008536 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write finished"));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008537
Gilles Peskine449bd832023-01-11 14:50:10 +01008538 return 0;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008539}
8540
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008541#define SSL_MAX_HASH_LEN 12
8542
Gilles Peskine449bd832023-01-11 14:50:10 +01008543int mbedtls_ssl_parse_finished(mbedtls_ssl_context *ssl)
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008544{
8545 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
8546 unsigned int hash_len = 12;
8547 unsigned char buf[SSL_MAX_HASH_LEN];
8548
Gilles Peskine449bd832023-01-11 14:50:10 +01008549 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse finished"));
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008550
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01008551 ret = ssl->handshake->calc_finished(ssl, buf, ssl->conf->endpoint ^ 1);
8552 if (ret != 0) {
8553 MBEDTLS_SSL_DEBUG_RET(1, "calc_finished", ret);
8554 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008555
Gilles Peskine449bd832023-01-11 14:50:10 +01008556 if ((ret = mbedtls_ssl_read_record(ssl, 1)) != 0) {
8557 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_read_record", ret);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008558 goto exit;
8559 }
8560
Gilles Peskine449bd832023-01-11 14:50:10 +01008561 if (ssl->in_msgtype != MBEDTLS_SSL_MSG_HANDSHAKE) {
8562 MBEDTLS_SSL_DEBUG_MSG(1, ("bad finished message"));
8563 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8564 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008565 ret = MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
8566 goto exit;
8567 }
8568
Gilles Peskine449bd832023-01-11 14:50:10 +01008569 if (ssl->in_msg[0] != MBEDTLS_SSL_HS_FINISHED) {
8570 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8571 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008572 ret = MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
8573 goto exit;
8574 }
8575
Gilles Peskine449bd832023-01-11 14:50:10 +01008576 if (ssl->in_hslen != mbedtls_ssl_hs_hdr_len(ssl) + hash_len) {
8577 MBEDTLS_SSL_DEBUG_MSG(1, ("bad finished message"));
8578 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8579 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008580 ret = MBEDTLS_ERR_SSL_DECODE_ERROR;
8581 goto exit;
8582 }
8583
Gilles Peskine449bd832023-01-11 14:50:10 +01008584 if (mbedtls_ct_memcmp(ssl->in_msg + mbedtls_ssl_hs_hdr_len(ssl),
8585 buf, hash_len) != 0) {
8586 MBEDTLS_SSL_DEBUG_MSG(1, ("bad finished message"));
8587 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8588 MBEDTLS_SSL_ALERT_MSG_DECRYPT_ERROR);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008589 ret = MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
8590 goto exit;
8591 }
8592
8593#if defined(MBEDTLS_SSL_RENEGOTIATION)
8594 ssl->verify_data_len = hash_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01008595 memcpy(ssl->peer_verify_data, buf, hash_len);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008596#endif
8597
Gilles Peskine449bd832023-01-11 14:50:10 +01008598 if (ssl->handshake->resume != 0) {
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008599#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008600 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008601 ssl->state = MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC;
Gilles Peskine449bd832023-01-11 14:50:10 +01008602 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008603#endif
8604#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008605 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008606 ssl->state = MBEDTLS_SSL_HANDSHAKE_WRAPUP;
Gilles Peskine449bd832023-01-11 14:50:10 +01008607 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008608#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01008609 } else {
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008610 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01008611 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008612
8613#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01008614 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
8615 mbedtls_ssl_recv_flight_completed(ssl);
8616 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008617#endif
8618
Gilles Peskine449bd832023-01-11 14:50:10 +01008619 MBEDTLS_SSL_DEBUG_MSG(2, ("<= parse finished"));
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008620
8621exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01008622 mbedtls_platform_zeroize(buf, hash_len);
8623 return ret;
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008624}
8625
Jerry Yu392112c2022-02-17 14:34:10 +08008626#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
8627/*
8628 * Helper to get TLS 1.2 PRF from ciphersuite
8629 * (Duplicates bits of logic from ssl_set_handshake_prfs().)
8630 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008631static tls_prf_fn ssl_tls12prf_from_cs(int ciphersuite_id)
Jerry Yu392112c2022-02-17 14:34:10 +08008632{
Jerry Yu392112c2022-02-17 14:34:10 +08008633 const mbedtls_ssl_ciphersuite_t * const ciphersuite_info =
Gilles Peskine449bd832023-01-11 14:50:10 +01008634 mbedtls_ssl_ciphersuite_from_id(ciphersuite_id);
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01008635#if defined(MBEDTLS_MD_CAN_SHA384)
Gilles Peskine449bd832023-01-11 14:50:10 +01008636 if (ciphersuite_info != NULL && ciphersuite_info->mac == MBEDTLS_MD_SHA384) {
8637 return tls_prf_sha384;
8638 } else
Jerry Yu392112c2022-02-17 14:34:10 +08008639#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01008640#if defined(MBEDTLS_MD_CAN_SHA256)
Andrzej Kurek894edde2022-09-29 06:31:14 -04008641 {
Gilles Peskine449bd832023-01-11 14:50:10 +01008642 if (ciphersuite_info != NULL && ciphersuite_info->mac == MBEDTLS_MD_SHA256) {
8643 return tls_prf_sha256;
8644 }
Andrzej Kurek894edde2022-09-29 06:31:14 -04008645 }
8646#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01008647#if !defined(MBEDTLS_MD_CAN_SHA384) && \
8648 !defined(MBEDTLS_MD_CAN_SHA256)
Andrzej Kurek894edde2022-09-29 06:31:14 -04008649 (void) ciphersuite_info;
8650#endif
Andrzej Kurekeabeb302022-10-17 07:52:51 -04008651
Gilles Peskine449bd832023-01-11 14:50:10 +01008652 return NULL;
Jerry Yu392112c2022-02-17 14:34:10 +08008653}
8654#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
Jerry Yue93ffcd2022-02-17 14:37:06 +08008655
Gilles Peskine449bd832023-01-11 14:50:10 +01008656static mbedtls_tls_prf_types tls_prf_get_type(mbedtls_ssl_tls_prf_cb *tls_prf)
Jerry Yue93ffcd2022-02-17 14:37:06 +08008657{
8658 ((void) tls_prf);
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01008659#if defined(MBEDTLS_MD_CAN_SHA384)
Gilles Peskine449bd832023-01-11 14:50:10 +01008660 if (tls_prf == tls_prf_sha384) {
8661 return MBEDTLS_SSL_TLS_PRF_SHA384;
8662 } else
Jerry Yue93ffcd2022-02-17 14:37:06 +08008663#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01008664#if defined(MBEDTLS_MD_CAN_SHA256)
Gilles Peskine449bd832023-01-11 14:50:10 +01008665 if (tls_prf == tls_prf_sha256) {
8666 return MBEDTLS_SSL_TLS_PRF_SHA256;
8667 } else
Jerry Yue93ffcd2022-02-17 14:37:06 +08008668#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01008669 return MBEDTLS_SSL_TLS_PRF_NONE;
Jerry Yue93ffcd2022-02-17 14:37:06 +08008670}
8671
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008672/*
8673 * Populate a transform structure with session keys and all the other
8674 * necessary information.
8675 *
8676 * Parameters:
8677 * - [in/out]: transform: structure to populate
8678 * [in] must be just initialised with mbedtls_ssl_transform_init()
8679 * [out] fully populated, ready for use by mbedtls_ssl_{en,de}crypt_buf()
8680 * - [in] ciphersuite
8681 * - [in] master
8682 * - [in] encrypt_then_mac
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008683 * - [in] tls_prf: pointer to PRF to use for key derivation
8684 * - [in] randbytes: buffer holding ServerHello.random + ClientHello.random
Glenn Strauss07c64162022-03-14 12:34:51 -04008685 * - [in] tls_version: TLS version
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008686 * - [in] endpoint: client or server
8687 * - [in] ssl: used for:
8688 * - ssl->conf->{f,p}_export_keys
8689 * [in] optionally used for:
8690 * - MBEDTLS_DEBUG_C: ssl->conf->{f,p}_dbg
8691 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02008692MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01008693static int ssl_tls12_populate_transform(mbedtls_ssl_transform *transform,
8694 int ciphersuite,
8695 const unsigned char master[48],
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008696#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01008697 int encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008698#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01008699 ssl_tls_prf_t tls_prf,
8700 const unsigned char randbytes[64],
8701 mbedtls_ssl_protocol_version tls_version,
8702 unsigned endpoint,
8703 const mbedtls_ssl_context *ssl)
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008704{
8705 int ret = 0;
8706 unsigned char keyblk[256];
8707 unsigned char *key1;
8708 unsigned char *key2;
8709 unsigned char *mac_enc;
8710 unsigned char *mac_dec;
8711 size_t mac_key_len = 0;
8712 size_t iv_copy_len;
8713 size_t keylen;
8714 const mbedtls_ssl_ciphersuite_t *ciphersuite_info;
Neil Armstrong7fea33e2022-04-01 15:40:25 +02008715 mbedtls_ssl_mode_t ssl_mode;
Neil Armstronge4512952022-03-08 09:08:22 +01008716#if !defined(MBEDTLS_USE_PSA_CRYPTO)
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008717 const mbedtls_cipher_info_t *cipher_info;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008718 const mbedtls_md_info_t *md_info;
Neil Armstronge4512952022-03-08 09:08:22 +01008719#endif /* !MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008720
8721#if defined(MBEDTLS_USE_PSA_CRYPTO)
8722 psa_key_type_t key_type;
8723 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
8724 psa_algorithm_t alg;
Neil Armstronge4512952022-03-08 09:08:22 +01008725 psa_algorithm_t mac_alg = 0;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008726 size_t key_bits;
8727 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
8728#endif
8729
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008730 /*
8731 * Some data just needs copying into the structure
8732 */
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008733#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008734 transform->encrypt_then_mac = encrypt_then_mac;
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008735#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Glenn Strauss07c64162022-03-14 12:34:51 -04008736 transform->tls_version = tls_version;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008737
8738#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01008739 memcpy(transform->randbytes, randbytes, sizeof(transform->randbytes));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008740#endif
8741
8742#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01008743 if (tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008744 /* At the moment, we keep TLS <= 1.2 and TLS 1.3 transform
8745 * generation separate. This should never happen. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008746 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008747 }
8748#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
8749
8750 /*
8751 * Get various info structures
8752 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008753 ciphersuite_info = mbedtls_ssl_ciphersuite_from_id(ciphersuite);
8754 if (ciphersuite_info == NULL) {
8755 MBEDTLS_SSL_DEBUG_MSG(1, ("ciphersuite info for %d not found",
8756 ciphersuite));
8757 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008758 }
8759
Neil Armstrongab555e02022-04-04 11:07:59 +02008760 ssl_mode = mbedtls_ssl_get_mode_from_ciphersuite(
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008761#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01008762 encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008763#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01008764 ciphersuite_info);
Neil Armstrong7fea33e2022-04-01 15:40:25 +02008765
Gilles Peskine449bd832023-01-11 14:50:10 +01008766 if (ssl_mode == MBEDTLS_SSL_MODE_AEAD) {
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008767 transform->taglen =
8768 ciphersuite_info->flags & MBEDTLS_CIPHERSUITE_SHORT_TAG ? 8 : 16;
Gilles Peskine449bd832023-01-11 14:50:10 +01008769 }
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008770
8771#if defined(MBEDTLS_USE_PSA_CRYPTO)
Dave Rodgman2eab4622023-10-05 13:30:37 +01008772 if ((status = mbedtls_ssl_cipher_to_psa((mbedtls_cipher_type_t) ciphersuite_info->cipher,
Gilles Peskine449bd832023-01-11 14:50:10 +01008773 transform->taglen,
8774 &alg,
8775 &key_type,
8776 &key_bits)) != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008777 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01008778 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_cipher_to_psa", ret);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008779 goto end;
8780 }
8781#else
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01008782 cipher_info = mbedtls_cipher_info_from_type((mbedtls_cipher_type_t) ciphersuite_info->cipher);
Gilles Peskine449bd832023-01-11 14:50:10 +01008783 if (cipher_info == NULL) {
8784 MBEDTLS_SSL_DEBUG_MSG(1, ("cipher info for %u not found",
8785 ciphersuite_info->cipher));
8786 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008787 }
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008788#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008789
Neil Armstronge4512952022-03-08 09:08:22 +01008790#if defined(MBEDTLS_USE_PSA_CRYPTO)
Dave Rodgman2eab4622023-10-05 13:30:37 +01008791 mac_alg = mbedtls_md_psa_alg_from_type((mbedtls_md_type_t) ciphersuite_info->mac);
Gilles Peskine449bd832023-01-11 14:50:10 +01008792 if (mac_alg == 0) {
Manuel Pégourié-Gonnard2d6d9932023-03-28 11:38:08 +02008793 MBEDTLS_SSL_DEBUG_MSG(1, ("mbedtls_md_psa_alg_from_type for %u not found",
Gilles Peskine449bd832023-01-11 14:50:10 +01008794 (unsigned) ciphersuite_info->mac));
8795 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Neil Armstronge4512952022-03-08 09:08:22 +01008796 }
8797#else
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01008798 md_info = mbedtls_md_info_from_type((mbedtls_md_type_t) ciphersuite_info->mac);
Gilles Peskine449bd832023-01-11 14:50:10 +01008799 if (md_info == NULL) {
8800 MBEDTLS_SSL_DEBUG_MSG(1, ("mbedtls_md info for %u not found",
8801 (unsigned) ciphersuite_info->mac));
8802 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008803 }
Neil Armstronge4512952022-03-08 09:08:22 +01008804#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008805
8806#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
8807 /* Copy own and peer's CID if the use of the CID
8808 * extension has been negotiated. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008809 if (ssl->handshake->cid_in_use == MBEDTLS_SSL_CID_ENABLED) {
8810 MBEDTLS_SSL_DEBUG_MSG(3, ("Copy CIDs into SSL transform"));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008811
8812 transform->in_cid_len = ssl->own_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01008813 memcpy(transform->in_cid, ssl->own_cid, ssl->own_cid_len);
8814 MBEDTLS_SSL_DEBUG_BUF(3, "Incoming CID", transform->in_cid,
8815 transform->in_cid_len);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008816
8817 transform->out_cid_len = ssl->handshake->peer_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01008818 memcpy(transform->out_cid, ssl->handshake->peer_cid,
8819 ssl->handshake->peer_cid_len);
8820 MBEDTLS_SSL_DEBUG_BUF(3, "Outgoing CID", transform->out_cid,
8821 transform->out_cid_len);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008822 }
8823#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
8824
8825 /*
8826 * Compute key block using the PRF
8827 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008828 ret = tls_prf(master, 48, "key expansion", randbytes, 64, keyblk, 256);
8829 if (ret != 0) {
8830 MBEDTLS_SSL_DEBUG_RET(1, "prf", ret);
8831 return ret;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008832 }
8833
Gilles Peskine449bd832023-01-11 14:50:10 +01008834 MBEDTLS_SSL_DEBUG_MSG(3, ("ciphersuite = %s",
8835 mbedtls_ssl_get_ciphersuite_name(ciphersuite)));
8836 MBEDTLS_SSL_DEBUG_BUF(3, "master secret", master, 48);
8837 MBEDTLS_SSL_DEBUG_BUF(4, "random bytes", randbytes, 64);
8838 MBEDTLS_SSL_DEBUG_BUF(4, "key block", keyblk, 256);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008839
8840 /*
8841 * Determine the appropriate key, IV and MAC length.
8842 */
8843
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008844#if defined(MBEDTLS_USE_PSA_CRYPTO)
8845 keylen = PSA_BITS_TO_BYTES(key_bits);
8846#else
Gilles Peskine449bd832023-01-11 14:50:10 +01008847 keylen = mbedtls_cipher_info_get_key_bitlen(cipher_info) / 8;
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008848#endif
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008849
Valerio Settie5707042023-10-11 11:54:42 +02008850#if defined(MBEDTLS_SSL_HAVE_AEAD)
Gilles Peskine449bd832023-01-11 14:50:10 +01008851 if (ssl_mode == MBEDTLS_SSL_MODE_AEAD) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008852 size_t explicit_ivlen;
8853
8854 transform->maclen = 0;
8855 mac_key_len = 0;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008856
8857 /* All modes haves 96-bit IVs, but the length of the static parts vary
8858 * with mode and version:
8859 * - For GCM and CCM in TLS 1.2, there's a static IV of 4 Bytes
8860 * (to be concatenated with a dynamically chosen IV of 8 Bytes)
8861 * - For ChaChaPoly in TLS 1.2, and all modes in TLS 1.3, there's
8862 * a static IV of 12 Bytes (to be XOR'ed with the 8 Byte record
8863 * sequence number).
8864 */
8865 transform->ivlen = 12;
David Horstmann3b2276a2022-10-06 14:49:08 +01008866
8867 int is_chachapoly = 0;
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008868#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01008869 is_chachapoly = (key_type == PSA_KEY_TYPE_CHACHA20);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008870#else
Gilles Peskine449bd832023-01-11 14:50:10 +01008871 is_chachapoly = (mbedtls_cipher_info_get_mode(cipher_info)
8872 == MBEDTLS_MODE_CHACHAPOLY);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008873#endif /* MBEDTLS_USE_PSA_CRYPTO */
David Horstmann3b2276a2022-10-06 14:49:08 +01008874
Gilles Peskine449bd832023-01-11 14:50:10 +01008875 if (is_chachapoly) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008876 transform->fixed_ivlen = 12;
Gilles Peskine449bd832023-01-11 14:50:10 +01008877 } else {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008878 transform->fixed_ivlen = 4;
Gilles Peskine449bd832023-01-11 14:50:10 +01008879 }
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008880
8881 /* Minimum length of encrypted record */
8882 explicit_ivlen = transform->ivlen - transform->fixed_ivlen;
8883 transform->minlen = explicit_ivlen + transform->taglen;
Gilles Peskine449bd832023-01-11 14:50:10 +01008884 } else
Valerio Settie5707042023-10-11 11:54:42 +02008885#endif /* MBEDTLS_SSL_HAVE_AEAD */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008886#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01008887 if (ssl_mode == MBEDTLS_SSL_MODE_STREAM ||
Neil Armstrong7fea33e2022-04-01 15:40:25 +02008888 ssl_mode == MBEDTLS_SSL_MODE_CBC ||
Gilles Peskine449bd832023-01-11 14:50:10 +01008889 ssl_mode == MBEDTLS_SSL_MODE_CBC_ETM) {
Neil Armstronge4512952022-03-08 09:08:22 +01008890#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01008891 size_t block_size = PSA_BLOCK_CIPHER_BLOCK_LENGTH(key_type);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008892#else
Dave Rodgman85a88132023-06-24 11:41:50 +01008893 size_t block_size = mbedtls_cipher_info_get_block_size(cipher_info);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008894#endif /* MBEDTLS_USE_PSA_CRYPTO */
8895
8896#if defined(MBEDTLS_USE_PSA_CRYPTO)
Neil Armstronge4512952022-03-08 09:08:22 +01008897 /* Get MAC length */
8898 mac_key_len = PSA_HASH_LENGTH(mac_alg);
8899#else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008900 /* Initialize HMAC contexts */
Gilles Peskine449bd832023-01-11 14:50:10 +01008901 if ((ret = mbedtls_md_setup(&transform->md_ctx_enc, md_info, 1)) != 0 ||
8902 (ret = mbedtls_md_setup(&transform->md_ctx_dec, md_info, 1)) != 0) {
8903 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_setup", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008904 goto end;
8905 }
8906
8907 /* Get MAC length */
Gilles Peskine449bd832023-01-11 14:50:10 +01008908 mac_key_len = mbedtls_md_get_size(md_info);
Neil Armstronge4512952022-03-08 09:08:22 +01008909#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008910 transform->maclen = mac_key_len;
8911
8912 /* IV length */
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008913#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01008914 transform->ivlen = PSA_CIPHER_IV_LENGTH(key_type, alg);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008915#else
Dave Rodgmanbb521fd2023-06-24 11:21:25 +01008916 transform->ivlen = mbedtls_cipher_info_get_iv_size(cipher_info);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008917#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008918
8919 /* Minimum length */
Gilles Peskine449bd832023-01-11 14:50:10 +01008920 if (ssl_mode == MBEDTLS_SSL_MODE_STREAM) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008921 transform->minlen = transform->maclen;
Gilles Peskine449bd832023-01-11 14:50:10 +01008922 } else {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008923 /*
8924 * GenericBlockCipher:
8925 * 1. if EtM is in use: one block plus MAC
8926 * otherwise: * first multiple of blocklen greater than maclen
8927 * 2. IV
8928 */
8929#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01008930 if (ssl_mode == MBEDTLS_SSL_MODE_CBC_ETM) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008931 transform->minlen = transform->maclen
Gilles Peskine449bd832023-01-11 14:50:10 +01008932 + block_size;
8933 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008934#endif
8935 {
8936 transform->minlen = transform->maclen
Gilles Peskine449bd832023-01-11 14:50:10 +01008937 + block_size
8938 - transform->maclen % block_size;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008939 }
8940
Gilles Peskine449bd832023-01-11 14:50:10 +01008941 if (tls_version == MBEDTLS_SSL_VERSION_TLS1_2) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008942 transform->minlen += transform->ivlen;
Gilles Peskine449bd832023-01-11 14:50:10 +01008943 } else {
8944 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008945 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
8946 goto end;
8947 }
8948 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008949 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008950#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
8951 {
Gilles Peskine449bd832023-01-11 14:50:10 +01008952 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
8953 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008954 }
8955
Gilles Peskine449bd832023-01-11 14:50:10 +01008956 MBEDTLS_SSL_DEBUG_MSG(3, ("keylen: %u, minlen: %u, ivlen: %u, maclen: %u",
8957 (unsigned) keylen,
8958 (unsigned) transform->minlen,
8959 (unsigned) transform->ivlen,
8960 (unsigned) transform->maclen));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008961
8962 /*
8963 * Finally setup the cipher contexts, IVs and MAC secrets.
8964 */
8965#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008966 if (endpoint == MBEDTLS_SSL_IS_CLIENT) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008967 key1 = keyblk + mac_key_len * 2;
8968 key2 = keyblk + mac_key_len * 2 + keylen;
8969
8970 mac_enc = keyblk;
8971 mac_dec = keyblk + mac_key_len;
8972
Gilles Peskine449bd832023-01-11 14:50:10 +01008973 iv_copy_len = (transform->fixed_ivlen) ?
8974 transform->fixed_ivlen : transform->ivlen;
8975 memcpy(transform->iv_enc, key2 + keylen, iv_copy_len);
8976 memcpy(transform->iv_dec, key2 + keylen + iv_copy_len,
8977 iv_copy_len);
8978 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008979#endif /* MBEDTLS_SSL_CLI_C */
8980#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008981 if (endpoint == MBEDTLS_SSL_IS_SERVER) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008982 key1 = keyblk + mac_key_len * 2 + keylen;
8983 key2 = keyblk + mac_key_len * 2;
8984
8985 mac_enc = keyblk + mac_key_len;
8986 mac_dec = keyblk;
8987
Gilles Peskine449bd832023-01-11 14:50:10 +01008988 iv_copy_len = (transform->fixed_ivlen) ?
8989 transform->fixed_ivlen : transform->ivlen;
8990 memcpy(transform->iv_dec, key1 + keylen, iv_copy_len);
8991 memcpy(transform->iv_enc, key1 + keylen + iv_copy_len,
8992 iv_copy_len);
8993 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008994#endif /* MBEDTLS_SSL_SRV_C */
8995 {
Gilles Peskine449bd832023-01-11 14:50:10 +01008996 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008997 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
8998 goto end;
8999 }
9000
Paul Elliott4fb19552023-10-18 12:15:30 +01009001 if (ssl->f_export_keys != NULL) {
Gilles Peskine449bd832023-01-11 14:50:10 +01009002 ssl->f_export_keys(ssl->p_export_keys,
9003 MBEDTLS_SSL_KEY_EXPORT_TLS12_MASTER_SECRET,
9004 master, 48,
9005 randbytes + 32,
9006 randbytes,
9007 tls_prf_get_type(tls_prf));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009008 }
9009
9010#if defined(MBEDTLS_USE_PSA_CRYPTO)
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009011 transform->psa_alg = alg;
9012
Gilles Peskine449bd832023-01-11 14:50:10 +01009013 if (alg != MBEDTLS_SSL_NULL_CIPHER) {
9014 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_ENCRYPT);
9015 psa_set_key_algorithm(&attributes, alg);
9016 psa_set_key_type(&attributes, key_type);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009017
Gilles Peskine449bd832023-01-11 14:50:10 +01009018 if ((status = psa_import_key(&attributes,
9019 key1,
9020 PSA_BITS_TO_BYTES(key_bits),
9021 &transform->psa_key_enc)) != PSA_SUCCESS) {
9022 MBEDTLS_SSL_DEBUG_RET(3, "psa_import_key", (int) status);
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05009023 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01009024 MBEDTLS_SSL_DEBUG_RET(1, "psa_import_key", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009025 goto end;
9026 }
9027
Gilles Peskine449bd832023-01-11 14:50:10 +01009028 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_DECRYPT);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009029
Gilles Peskine449bd832023-01-11 14:50:10 +01009030 if ((status = psa_import_key(&attributes,
9031 key2,
9032 PSA_BITS_TO_BYTES(key_bits),
9033 &transform->psa_key_dec)) != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05009034 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01009035 MBEDTLS_SSL_DEBUG_RET(1, "psa_import_key", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009036 goto end;
9037 }
9038 }
9039#else
Gilles Peskine449bd832023-01-11 14:50:10 +01009040 if ((ret = mbedtls_cipher_setup(&transform->cipher_ctx_enc,
9041 cipher_info)) != 0) {
9042 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_setup", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009043 goto end;
9044 }
9045
Gilles Peskine449bd832023-01-11 14:50:10 +01009046 if ((ret = mbedtls_cipher_setup(&transform->cipher_ctx_dec,
9047 cipher_info)) != 0) {
9048 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_setup", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009049 goto end;
9050 }
9051
Gilles Peskine449bd832023-01-11 14:50:10 +01009052 if ((ret = mbedtls_cipher_setkey(&transform->cipher_ctx_enc, key1,
9053 (int) mbedtls_cipher_info_get_key_bitlen(cipher_info),
9054 MBEDTLS_ENCRYPT)) != 0) {
9055 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_setkey", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009056 goto end;
9057 }
9058
Gilles Peskine449bd832023-01-11 14:50:10 +01009059 if ((ret = mbedtls_cipher_setkey(&transform->cipher_ctx_dec, key2,
9060 (int) mbedtls_cipher_info_get_key_bitlen(cipher_info),
9061 MBEDTLS_DECRYPT)) != 0) {
9062 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_setkey", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009063 goto end;
9064 }
9065
9066#if defined(MBEDTLS_CIPHER_MODE_CBC)
Gilles Peskine449bd832023-01-11 14:50:10 +01009067 if (mbedtls_cipher_info_get_mode(cipher_info) == MBEDTLS_MODE_CBC) {
9068 if ((ret = mbedtls_cipher_set_padding_mode(&transform->cipher_ctx_enc,
9069 MBEDTLS_PADDING_NONE)) != 0) {
9070 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_set_padding_mode", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009071 goto end;
9072 }
9073
Gilles Peskine449bd832023-01-11 14:50:10 +01009074 if ((ret = mbedtls_cipher_set_padding_mode(&transform->cipher_ctx_dec,
9075 MBEDTLS_PADDING_NONE)) != 0) {
9076 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_set_padding_mode", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009077 goto end;
9078 }
9079 }
9080#endif /* MBEDTLS_CIPHER_MODE_CBC */
9081#endif /* MBEDTLS_USE_PSA_CRYPTO */
9082
Neil Armstrong29c0c042022-03-17 17:47:28 +01009083#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
9084 /* For HMAC-based ciphersuites, initialize the HMAC transforms.
9085 For AEAD-based ciphersuites, there is nothing to do here. */
Gilles Peskine449bd832023-01-11 14:50:10 +01009086 if (mac_key_len != 0) {
Neil Armstrong29c0c042022-03-17 17:47:28 +01009087#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01009088 transform->psa_mac_alg = PSA_ALG_HMAC(mac_alg);
Neil Armstrong29c0c042022-03-17 17:47:28 +01009089
Gilles Peskine449bd832023-01-11 14:50:10 +01009090 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_SIGN_MESSAGE);
9091 psa_set_key_algorithm(&attributes, PSA_ALG_HMAC(mac_alg));
9092 psa_set_key_type(&attributes, PSA_KEY_TYPE_HMAC);
Neil Armstrong29c0c042022-03-17 17:47:28 +01009093
Gilles Peskine449bd832023-01-11 14:50:10 +01009094 if ((status = psa_import_key(&attributes,
9095 mac_enc, mac_key_len,
9096 &transform->psa_mac_enc)) != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05009097 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01009098 MBEDTLS_SSL_DEBUG_RET(1, "psa_import_mac_key", ret);
Neil Armstrong29c0c042022-03-17 17:47:28 +01009099 goto end;
9100 }
9101
Gilles Peskine449bd832023-01-11 14:50:10 +01009102 if ((transform->psa_alg == MBEDTLS_SSL_NULL_CIPHER) ||
9103 ((transform->psa_alg == PSA_ALG_CBC_NO_PADDING)
Andrzej Kurek8c95ac42022-08-17 16:17:00 -04009104#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01009105 && (transform->encrypt_then_mac == MBEDTLS_SSL_ETM_DISABLED)
Andrzej Kurek8c95ac42022-08-17 16:17:00 -04009106#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01009107 )) {
Neil Armstrong29c0c042022-03-17 17:47:28 +01009108 /* mbedtls_ct_hmac() requires the key to be exportable */
Gilles Peskine449bd832023-01-11 14:50:10 +01009109 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_EXPORT |
9110 PSA_KEY_USAGE_VERIFY_HASH);
9111 } else {
9112 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_VERIFY_HASH);
9113 }
Neil Armstrong29c0c042022-03-17 17:47:28 +01009114
Gilles Peskine449bd832023-01-11 14:50:10 +01009115 if ((status = psa_import_key(&attributes,
9116 mac_dec, mac_key_len,
9117 &transform->psa_mac_dec)) != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05009118 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01009119 MBEDTLS_SSL_DEBUG_RET(1, "psa_import_mac_key", ret);
Neil Armstrong29c0c042022-03-17 17:47:28 +01009120 goto end;
9121 }
9122#else
Gilles Peskine449bd832023-01-11 14:50:10 +01009123 ret = mbedtls_md_hmac_starts(&transform->md_ctx_enc, mac_enc, mac_key_len);
9124 if (ret != 0) {
Neil Armstrong29c0c042022-03-17 17:47:28 +01009125 goto end;
Gilles Peskine449bd832023-01-11 14:50:10 +01009126 }
9127 ret = mbedtls_md_hmac_starts(&transform->md_ctx_dec, mac_dec, mac_key_len);
9128 if (ret != 0) {
Neil Armstrong29c0c042022-03-17 17:47:28 +01009129 goto end;
Gilles Peskine449bd832023-01-11 14:50:10 +01009130 }
Neil Armstrong29c0c042022-03-17 17:47:28 +01009131#endif /* MBEDTLS_USE_PSA_CRYPTO */
9132 }
9133#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
9134
9135 ((void) mac_dec);
9136 ((void) mac_enc);
9137
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009138end:
Gilles Peskine449bd832023-01-11 14:50:10 +01009139 mbedtls_platform_zeroize(keyblk, sizeof(keyblk));
9140 return ret;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009141}
9142
Valerio Settia08b1a42022-11-17 15:10:02 +01009143#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED) && \
9144 defined(MBEDTLS_USE_PSA_CRYPTO)
Valerio Setti6b3dab02022-11-17 17:14:54 +01009145int mbedtls_psa_ecjpake_read_round(
Gilles Peskine449bd832023-01-11 14:50:10 +01009146 psa_pake_operation_t *pake_ctx,
9147 const unsigned char *buf,
9148 size_t len, mbedtls_ecjpake_rounds_t round)
Valerio Settia08b1a42022-11-17 15:10:02 +01009149{
9150 psa_status_t status;
9151 size_t input_offset = 0;
Valerio Setti819de862022-11-17 18:05:19 +01009152 /*
Valerio Setti6b3dab02022-11-17 17:14:54 +01009153 * At round one repeat the KEY_SHARE, ZK_PUBLIC & ZF_PROOF twice
9154 * At round two perform a single cycle
9155 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009156 unsigned int remaining_steps = (round == MBEDTLS_ECJPAKE_ROUND_ONE) ? 2 : 1;
Valerio Settia08b1a42022-11-17 15:10:02 +01009157
Gilles Peskine449bd832023-01-11 14:50:10 +01009158 for (; remaining_steps > 0; remaining_steps--) {
9159 for (psa_pake_step_t step = PSA_PAKE_STEP_KEY_SHARE;
Valerio Settia08b1a42022-11-17 15:10:02 +01009160 step <= PSA_PAKE_STEP_ZK_PROOF;
Gilles Peskine449bd832023-01-11 14:50:10 +01009161 ++step) {
Valerio Settia08b1a42022-11-17 15:10:02 +01009162 /* Length is stored at the first byte */
9163 size_t length = buf[input_offset];
9164 input_offset += 1;
9165
Gilles Peskine449bd832023-01-11 14:50:10 +01009166 if (input_offset + length > len) {
Valerio Settia08b1a42022-11-17 15:10:02 +01009167 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
9168 }
9169
Gilles Peskine449bd832023-01-11 14:50:10 +01009170 status = psa_pake_input(pake_ctx, step,
9171 buf + input_offset, length);
9172 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05009173 return PSA_TO_MBEDTLS_ERR(status);
Valerio Settia08b1a42022-11-17 15:10:02 +01009174 }
9175
9176 input_offset += length;
9177 }
9178 }
9179
Gilles Peskine449bd832023-01-11 14:50:10 +01009180 if (input_offset != len) {
Valerio Setti61ea17d2022-11-18 12:11:00 +01009181 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Gilles Peskine449bd832023-01-11 14:50:10 +01009182 }
Valerio Setti30ebe112022-11-17 16:23:34 +01009183
Gilles Peskine449bd832023-01-11 14:50:10 +01009184 return 0;
Valerio Settia08b1a42022-11-17 15:10:02 +01009185}
9186
Valerio Setti6b3dab02022-11-17 17:14:54 +01009187int mbedtls_psa_ecjpake_write_round(
Gilles Peskine449bd832023-01-11 14:50:10 +01009188 psa_pake_operation_t *pake_ctx,
9189 unsigned char *buf,
9190 size_t len, size_t *olen,
9191 mbedtls_ecjpake_rounds_t round)
Valerio Settia08b1a42022-11-17 15:10:02 +01009192{
9193 psa_status_t status;
9194 size_t output_offset = 0;
9195 size_t output_len;
Valerio Setti819de862022-11-17 18:05:19 +01009196 /*
Valerio Setti6b3dab02022-11-17 17:14:54 +01009197 * At round one repeat the KEY_SHARE, ZK_PUBLIC & ZF_PROOF twice
9198 * At round two perform a single cycle
9199 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009200 unsigned int remaining_steps = (round == MBEDTLS_ECJPAKE_ROUND_ONE) ? 2 : 1;
Valerio Settia08b1a42022-11-17 15:10:02 +01009201
Gilles Peskine449bd832023-01-11 14:50:10 +01009202 for (; remaining_steps > 0; remaining_steps--) {
9203 for (psa_pake_step_t step = PSA_PAKE_STEP_KEY_SHARE;
9204 step <= PSA_PAKE_STEP_ZK_PROOF;
9205 ++step) {
Valerio Setti79f6b6b2022-11-21 14:17:03 +01009206 /*
Valerio Settid4a9b1a2022-11-22 11:11:10 +01009207 * For each step, prepend 1 byte with the length of the data as
9208 * given by psa_pake_output().
Valerio Setti79f6b6b2022-11-21 14:17:03 +01009209 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009210 status = psa_pake_output(pake_ctx, step,
9211 buf + output_offset + 1,
9212 len - output_offset - 1,
9213 &output_len);
9214 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05009215 return PSA_TO_MBEDTLS_ERR(status);
Valerio Settia08b1a42022-11-17 15:10:02 +01009216 }
9217
Valerio Setti99d88c12022-11-22 16:03:43 +01009218 *(buf + output_offset) = (uint8_t) output_len;
Valerio Setti79f6b6b2022-11-21 14:17:03 +01009219
9220 output_offset += output_len + 1;
Valerio Settia08b1a42022-11-17 15:10:02 +01009221 }
9222 }
9223
9224 *olen = output_offset;
9225
Gilles Peskine449bd832023-01-11 14:50:10 +01009226 return 0;
Valerio Settia08b1a42022-11-17 15:10:02 +01009227}
Valerio Settia08b1a42022-11-17 15:10:02 +01009228#endif //MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED && MBEDTLS_USE_PSA_CRYPTO
9229
Jerry Yuee40f9d2022-02-17 14:55:16 +08009230#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01009231int mbedtls_ssl_get_key_exchange_md_tls1_2(mbedtls_ssl_context *ssl,
9232 unsigned char *hash, size_t *hashlen,
9233 unsigned char *data, size_t data_len,
9234 mbedtls_md_type_t md_alg)
Jerry Yuee40f9d2022-02-17 14:55:16 +08009235{
9236 psa_status_t status;
9237 psa_hash_operation_t hash_operation = PSA_HASH_OPERATION_INIT;
Manuel Pégourié-Gonnard2d6d9932023-03-28 11:38:08 +02009238 psa_algorithm_t hash_alg = mbedtls_md_psa_alg_from_type(md_alg);
Jerry Yuee40f9d2022-02-17 14:55:16 +08009239
Gilles Peskine449bd832023-01-11 14:50:10 +01009240 MBEDTLS_SSL_DEBUG_MSG(3, ("Perform PSA-based computation of digest of ServerKeyExchange"));
Jerry Yuee40f9d2022-02-17 14:55:16 +08009241
Gilles Peskine449bd832023-01-11 14:50:10 +01009242 if ((status = psa_hash_setup(&hash_operation,
9243 hash_alg)) != PSA_SUCCESS) {
9244 MBEDTLS_SSL_DEBUG_RET(1, "psa_hash_setup", status);
Jerry Yuee40f9d2022-02-17 14:55:16 +08009245 goto exit;
9246 }
9247
Gilles Peskine449bd832023-01-11 14:50:10 +01009248 if ((status = psa_hash_update(&hash_operation, ssl->handshake->randbytes,
9249 64)) != PSA_SUCCESS) {
9250 MBEDTLS_SSL_DEBUG_RET(1, "psa_hash_update", status);
Jerry Yuee40f9d2022-02-17 14:55:16 +08009251 goto exit;
9252 }
9253
Gilles Peskine449bd832023-01-11 14:50:10 +01009254 if ((status = psa_hash_update(&hash_operation,
9255 data, data_len)) != PSA_SUCCESS) {
9256 MBEDTLS_SSL_DEBUG_RET(1, "psa_hash_update", status);
Jerry Yuee40f9d2022-02-17 14:55:16 +08009257 goto exit;
9258 }
9259
Gilles Peskine449bd832023-01-11 14:50:10 +01009260 if ((status = psa_hash_finish(&hash_operation, hash, PSA_HASH_MAX_SIZE,
9261 hashlen)) != PSA_SUCCESS) {
9262 MBEDTLS_SSL_DEBUG_RET(1, "psa_hash_finish", status);
9263 goto exit;
Jerry Yuee40f9d2022-02-17 14:55:16 +08009264 }
9265
9266exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01009267 if (status != PSA_SUCCESS) {
9268 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
9269 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR);
9270 switch (status) {
Jerry Yuee40f9d2022-02-17 14:55:16 +08009271 case PSA_ERROR_NOT_SUPPORTED:
Gilles Peskine449bd832023-01-11 14:50:10 +01009272 return MBEDTLS_ERR_MD_FEATURE_UNAVAILABLE;
Jerry Yuee40f9d2022-02-17 14:55:16 +08009273 case PSA_ERROR_BAD_STATE: /* Intentional fallthrough */
9274 case PSA_ERROR_BUFFER_TOO_SMALL:
Gilles Peskine449bd832023-01-11 14:50:10 +01009275 return MBEDTLS_ERR_MD_BAD_INPUT_DATA;
Jerry Yuee40f9d2022-02-17 14:55:16 +08009276 case PSA_ERROR_INSUFFICIENT_MEMORY:
Gilles Peskine449bd832023-01-11 14:50:10 +01009277 return MBEDTLS_ERR_MD_ALLOC_FAILED;
Jerry Yuee40f9d2022-02-17 14:55:16 +08009278 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01009279 return MBEDTLS_ERR_PLATFORM_HW_ACCEL_FAILED;
Jerry Yuee40f9d2022-02-17 14:55:16 +08009280 }
9281 }
Gilles Peskine449bd832023-01-11 14:50:10 +01009282 return 0;
Jerry Yuee40f9d2022-02-17 14:55:16 +08009283}
9284
9285#else
9286
Gilles Peskine449bd832023-01-11 14:50:10 +01009287int mbedtls_ssl_get_key_exchange_md_tls1_2(mbedtls_ssl_context *ssl,
9288 unsigned char *hash, size_t *hashlen,
9289 unsigned char *data, size_t data_len,
9290 mbedtls_md_type_t md_alg)
Jerry Yuee40f9d2022-02-17 14:55:16 +08009291{
9292 int ret = 0;
9293 mbedtls_md_context_t ctx;
Gilles Peskine449bd832023-01-11 14:50:10 +01009294 const mbedtls_md_info_t *md_info = mbedtls_md_info_from_type(md_alg);
9295 *hashlen = mbedtls_md_get_size(md_info);
Jerry Yuee40f9d2022-02-17 14:55:16 +08009296
Gilles Peskine449bd832023-01-11 14:50:10 +01009297 MBEDTLS_SSL_DEBUG_MSG(3, ("Perform mbedtls-based computation of digest of ServerKeyExchange"));
Jerry Yuee40f9d2022-02-17 14:55:16 +08009298
Gilles Peskine449bd832023-01-11 14:50:10 +01009299 mbedtls_md_init(&ctx);
Jerry Yuee40f9d2022-02-17 14:55:16 +08009300
9301 /*
9302 * digitally-signed struct {
9303 * opaque client_random[32];
9304 * opaque server_random[32];
9305 * ServerDHParams params;
9306 * };
9307 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009308 if ((ret = mbedtls_md_setup(&ctx, md_info, 0)) != 0) {
9309 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_setup", ret);
Jerry Yuee40f9d2022-02-17 14:55:16 +08009310 goto exit;
9311 }
Gilles Peskine449bd832023-01-11 14:50:10 +01009312 if ((ret = mbedtls_md_starts(&ctx)) != 0) {
9313 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_starts", ret);
Jerry Yuee40f9d2022-02-17 14:55:16 +08009314 goto exit;
9315 }
Gilles Peskine449bd832023-01-11 14:50:10 +01009316 if ((ret = mbedtls_md_update(&ctx, ssl->handshake->randbytes, 64)) != 0) {
9317 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_update", ret);
Jerry Yuee40f9d2022-02-17 14:55:16 +08009318 goto exit;
9319 }
Gilles Peskine449bd832023-01-11 14:50:10 +01009320 if ((ret = mbedtls_md_update(&ctx, data, data_len)) != 0) {
9321 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_update", ret);
Jerry Yuee40f9d2022-02-17 14:55:16 +08009322 goto exit;
9323 }
Gilles Peskine449bd832023-01-11 14:50:10 +01009324 if ((ret = mbedtls_md_finish(&ctx, hash)) != 0) {
9325 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_finish", ret);
Jerry Yuee40f9d2022-02-17 14:55:16 +08009326 goto exit;
9327 }
9328
9329exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01009330 mbedtls_md_free(&ctx);
Jerry Yuee40f9d2022-02-17 14:55:16 +08009331
Gilles Peskine449bd832023-01-11 14:50:10 +01009332 if (ret != 0) {
9333 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
9334 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR);
9335 }
Jerry Yuee40f9d2022-02-17 14:55:16 +08009336
Gilles Peskine449bd832023-01-11 14:50:10 +01009337 return ret;
Jerry Yuee40f9d2022-02-17 14:55:16 +08009338}
9339#endif /* MBEDTLS_USE_PSA_CRYPTO */
9340
Jerry Yud9d91da2022-02-17 14:57:06 +08009341#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
9342
Gabor Mezeia3d016c2022-05-10 12:44:09 +02009343/* Find the preferred hash for a given signature algorithm. */
9344unsigned int mbedtls_ssl_tls12_get_preferred_hash_for_sig_alg(
Gilles Peskine449bd832023-01-11 14:50:10 +01009345 mbedtls_ssl_context *ssl,
9346 unsigned int sig_alg)
Jerry Yud9d91da2022-02-17 14:57:06 +08009347{
Gabor Mezei078e8032022-04-27 21:17:56 +02009348 unsigned int i;
Gabor Mezeia3d016c2022-05-10 12:44:09 +02009349 uint16_t *received_sig_algs = ssl->handshake->received_sig_algs;
Gabor Mezei078e8032022-04-27 21:17:56 +02009350
Gilles Peskine449bd832023-01-11 14:50:10 +01009351 if (sig_alg == MBEDTLS_SSL_SIG_ANON) {
9352 return MBEDTLS_SSL_HASH_NONE;
9353 }
Gabor Mezei078e8032022-04-27 21:17:56 +02009354
Gilles Peskine449bd832023-01-11 14:50:10 +01009355 for (i = 0; received_sig_algs[i] != MBEDTLS_TLS_SIG_NONE; i++) {
Neil Armstrong9f1176a2022-06-24 18:19:19 +02009356 unsigned int hash_alg_received =
Gilles Peskine449bd832023-01-11 14:50:10 +01009357 MBEDTLS_SSL_TLS12_HASH_ALG_FROM_SIG_AND_HASH_ALG(
9358 received_sig_algs[i]);
Neil Armstrong9f1176a2022-06-24 18:19:19 +02009359 unsigned int sig_alg_received =
Gilles Peskine449bd832023-01-11 14:50:10 +01009360 MBEDTLS_SSL_TLS12_SIG_ALG_FROM_SIG_AND_HASH_ALG(
9361 received_sig_algs[i]);
Neil Armstrong9f1176a2022-06-24 18:19:19 +02009362
Manuel Pégourié-Gonnard47bb3802023-06-05 12:40:32 +02009363 mbedtls_md_type_t md_alg =
9364 mbedtls_ssl_md_alg_from_hash((unsigned char) hash_alg_received);
9365 if (md_alg == MBEDTLS_MD_NONE) {
9366 continue;
9367 }
9368
Gilles Peskine449bd832023-01-11 14:50:10 +01009369 if (sig_alg == sig_alg_received) {
Neil Armstrong9f1176a2022-06-24 18:19:19 +02009370#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01009371 if (ssl->handshake->key_cert && ssl->handshake->key_cert->key) {
Neil Armstrong96eceb82022-06-30 18:05:05 +02009372 psa_algorithm_t psa_hash_alg =
Manuel Pégourié-Gonnard47bb3802023-06-05 12:40:32 +02009373 mbedtls_md_psa_alg_from_type(md_alg);
Neil Armstrong9f1176a2022-06-24 18:19:19 +02009374
Gilles Peskine449bd832023-01-11 14:50:10 +01009375 if (sig_alg_received == MBEDTLS_SSL_SIG_ECDSA &&
9376 !mbedtls_pk_can_do_ext(ssl->handshake->key_cert->key,
9377 PSA_ALG_ECDSA(psa_hash_alg),
9378 PSA_KEY_USAGE_SIGN_HASH)) {
Neil Armstrong9f1176a2022-06-24 18:19:19 +02009379 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01009380 }
Neil Armstrong9f1176a2022-06-24 18:19:19 +02009381
Gilles Peskine449bd832023-01-11 14:50:10 +01009382 if (sig_alg_received == MBEDTLS_SSL_SIG_RSA &&
9383 !mbedtls_pk_can_do_ext(ssl->handshake->key_cert->key,
9384 PSA_ALG_RSA_PKCS1V15_SIGN(
9385 psa_hash_alg),
9386 PSA_KEY_USAGE_SIGN_HASH)) {
Neil Armstrong9f1176a2022-06-24 18:19:19 +02009387 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01009388 }
Neil Armstrong9f1176a2022-06-24 18:19:19 +02009389 }
Neil Armstrong9f1176a2022-06-24 18:19:19 +02009390#endif /* MBEDTLS_USE_PSA_CRYPTO */
Neil Armstrong96eceb82022-06-30 18:05:05 +02009391
Gilles Peskine449bd832023-01-11 14:50:10 +01009392 return hash_alg_received;
Neil Armstrong9f1176a2022-06-24 18:19:19 +02009393 }
Jerry Yud9d91da2022-02-17 14:57:06 +08009394 }
Jerry Yud9d91da2022-02-17 14:57:06 +08009395
Gilles Peskine449bd832023-01-11 14:50:10 +01009396 return MBEDTLS_SSL_HASH_NONE;
Jerry Yud9d91da2022-02-17 14:57:06 +08009397}
9398
9399#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
9400
Jerry Yudc7bd172022-02-17 13:44:15 +08009401#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
9402
XiaokangQian75d40ef2022-04-20 11:05:24 +00009403int mbedtls_ssl_validate_ciphersuite(
9404 const mbedtls_ssl_context *ssl,
9405 const mbedtls_ssl_ciphersuite_t *suite_info,
9406 mbedtls_ssl_protocol_version min_tls_version,
Gilles Peskine449bd832023-01-11 14:50:10 +01009407 mbedtls_ssl_protocol_version max_tls_version)
XiaokangQian75d40ef2022-04-20 11:05:24 +00009408{
9409 (void) ssl;
9410
Gilles Peskine449bd832023-01-11 14:50:10 +01009411 if (suite_info == NULL) {
9412 return -1;
9413 }
XiaokangQian75d40ef2022-04-20 11:05:24 +00009414
Gilles Peskine449bd832023-01-11 14:50:10 +01009415 if ((suite_info->min_tls_version > max_tls_version) ||
9416 (suite_info->max_tls_version < min_tls_version)) {
9417 return -1;
XiaokangQian75d40ef2022-04-20 11:05:24 +00009418 }
9419
XiaokangQian060d8672022-04-21 09:24:56 +00009420#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_CLI_C)
XiaokangQian75d40ef2022-04-20 11:05:24 +00009421#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Neil Armstrongca7d5062022-05-31 14:43:23 +02009422#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01009423 if (suite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_ECJPAKE &&
9424 ssl->handshake->psa_pake_ctx_is_ok != 1)
Neil Armstrongca7d5062022-05-31 14:43:23 +02009425#else
Gilles Peskine449bd832023-01-11 14:50:10 +01009426 if (suite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_ECJPAKE &&
9427 mbedtls_ecjpake_check(&ssl->handshake->ecjpake_ctx) != 0)
Neil Armstrongca7d5062022-05-31 14:43:23 +02009428#endif /* MBEDTLS_USE_PSA_CRYPTO */
XiaokangQian75d40ef2022-04-20 11:05:24 +00009429 {
Gilles Peskine449bd832023-01-11 14:50:10 +01009430 return -1;
XiaokangQian75d40ef2022-04-20 11:05:24 +00009431 }
9432#endif
9433
9434 /* Don't suggest PSK-based ciphersuite if no PSK is available. */
9435#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01009436 if (mbedtls_ssl_ciphersuite_uses_psk(suite_info) &&
9437 mbedtls_ssl_conf_has_static_psk(ssl->conf) == 0) {
9438 return -1;
XiaokangQian75d40ef2022-04-20 11:05:24 +00009439 }
9440#endif /* MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
9441#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
9442
Gilles Peskine449bd832023-01-11 14:50:10 +01009443 return 0;
XiaokangQian75d40ef2022-04-20 11:05:24 +00009444}
9445
Ronald Crone68ab4f2022-10-05 12:46:29 +02009446#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
XiaokangQianeaf36512022-04-24 09:07:44 +00009447/*
9448 * Function for writing a signature algorithm extension.
9449 *
9450 * The `extension_data` field of signature algorithm contains a `SignatureSchemeList`
9451 * value (TLS 1.3 RFC8446):
9452 * enum {
9453 * ....
9454 * ecdsa_secp256r1_sha256( 0x0403 ),
9455 * ecdsa_secp384r1_sha384( 0x0503 ),
9456 * ecdsa_secp521r1_sha512( 0x0603 ),
9457 * ....
9458 * } SignatureScheme;
9459 *
9460 * struct {
9461 * SignatureScheme supported_signature_algorithms<2..2^16-2>;
9462 * } SignatureSchemeList;
9463 *
9464 * The `extension_data` field of signature algorithm contains a `SignatureAndHashAlgorithm`
9465 * value (TLS 1.2 RFC5246):
9466 * enum {
9467 * none(0), md5(1), sha1(2), sha224(3), sha256(4), sha384(5),
9468 * sha512(6), (255)
9469 * } HashAlgorithm;
9470 *
9471 * enum { anonymous(0), rsa(1), dsa(2), ecdsa(3), (255) }
9472 * SignatureAlgorithm;
9473 *
9474 * struct {
9475 * HashAlgorithm hash;
9476 * SignatureAlgorithm signature;
9477 * } SignatureAndHashAlgorithm;
9478 *
9479 * SignatureAndHashAlgorithm
9480 * supported_signature_algorithms<2..2^16-2>;
9481 *
9482 * The TLS 1.3 signature algorithm extension was defined to be a compatible
9483 * generalization of the TLS 1.2 signature algorithm extension.
9484 * `SignatureAndHashAlgorithm` field of TLS 1.2 can be represented by
9485 * `SignatureScheme` field of TLS 1.3
9486 *
9487 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009488int mbedtls_ssl_write_sig_alg_ext(mbedtls_ssl_context *ssl, unsigned char *buf,
9489 const unsigned char *end, size_t *out_len)
XiaokangQianeaf36512022-04-24 09:07:44 +00009490{
9491 unsigned char *p = buf;
9492 unsigned char *supported_sig_alg; /* Start of supported_signature_algorithms */
9493 size_t supported_sig_alg_len = 0; /* Length of supported_signature_algorithms */
9494
9495 *out_len = 0;
9496
Gilles Peskine449bd832023-01-11 14:50:10 +01009497 MBEDTLS_SSL_DEBUG_MSG(3, ("adding signature_algorithms extension"));
XiaokangQianeaf36512022-04-24 09:07:44 +00009498
9499 /* Check if we have space for header and length field:
9500 * - extension_type (2 bytes)
9501 * - extension_data_length (2 bytes)
9502 * - supported_signature_algorithms_length (2 bytes)
9503 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009504 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 6);
XiaokangQianeaf36512022-04-24 09:07:44 +00009505 p += 6;
9506
9507 /*
9508 * Write supported_signature_algorithms
9509 */
9510 supported_sig_alg = p;
Gilles Peskine449bd832023-01-11 14:50:10 +01009511 const uint16_t *sig_alg = mbedtls_ssl_get_sig_algs(ssl);
9512 if (sig_alg == NULL) {
9513 return MBEDTLS_ERR_SSL_BAD_CONFIG;
9514 }
XiaokangQianeaf36512022-04-24 09:07:44 +00009515
Gilles Peskine449bd832023-01-11 14:50:10 +01009516 for (; *sig_alg != MBEDTLS_TLS1_3_SIG_NONE; sig_alg++) {
9517 MBEDTLS_SSL_DEBUG_MSG(3, ("got signature scheme [%x] %s",
9518 *sig_alg,
9519 mbedtls_ssl_sig_alg_to_str(*sig_alg)));
9520 if (!mbedtls_ssl_sig_alg_is_supported(ssl, *sig_alg)) {
XiaokangQianeaf36512022-04-24 09:07:44 +00009521 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01009522 }
9523 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 2);
9524 MBEDTLS_PUT_UINT16_BE(*sig_alg, p, 0);
XiaokangQianeaf36512022-04-24 09:07:44 +00009525 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01009526 MBEDTLS_SSL_DEBUG_MSG(3, ("sent signature scheme [%x] %s",
9527 *sig_alg,
9528 mbedtls_ssl_sig_alg_to_str(*sig_alg)));
XiaokangQianeaf36512022-04-24 09:07:44 +00009529 }
9530
9531 /* Length of supported_signature_algorithms */
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00009532 supported_sig_alg_len = (size_t) (p - supported_sig_alg);
Gilles Peskine449bd832023-01-11 14:50:10 +01009533 if (supported_sig_alg_len == 0) {
9534 MBEDTLS_SSL_DEBUG_MSG(1, ("No signature algorithms defined."));
9535 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
XiaokangQianeaf36512022-04-24 09:07:44 +00009536 }
9537
Gilles Peskine449bd832023-01-11 14:50:10 +01009538 MBEDTLS_PUT_UINT16_BE(MBEDTLS_TLS_EXT_SIG_ALG, buf, 0);
9539 MBEDTLS_PUT_UINT16_BE(supported_sig_alg_len + 2, buf, 2);
9540 MBEDTLS_PUT_UINT16_BE(supported_sig_alg_len, buf, 4);
XiaokangQianeaf36512022-04-24 09:07:44 +00009541
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00009542 *out_len = (size_t) (p - buf);
XiaokangQianeaf36512022-04-24 09:07:44 +00009543
9544#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01009545 mbedtls_ssl_tls13_set_hs_sent_ext_mask(ssl, MBEDTLS_TLS_EXT_SIG_ALG);
XiaokangQianeaf36512022-04-24 09:07:44 +00009546#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yu0c354a22022-08-29 15:25:36 +08009547
Gilles Peskine449bd832023-01-11 14:50:10 +01009548 return 0;
XiaokangQianeaf36512022-04-24 09:07:44 +00009549}
Ronald Crone68ab4f2022-10-05 12:46:29 +02009550#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
XiaokangQianeaf36512022-04-24 09:07:44 +00009551
XiaokangQian40a35232022-05-07 09:02:40 +00009552#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
XiaokangQian9b2b7712022-05-17 02:57:00 +00009553/*
9554 * mbedtls_ssl_parse_server_name_ext
9555 *
9556 * Structure of server_name extension:
9557 *
9558 * enum {
9559 * host_name(0), (255)
9560 * } NameType;
9561 * opaque HostName<1..2^16-1>;
9562 *
9563 * struct {
9564 * NameType name_type;
9565 * select (name_type) {
9566 * case host_name: HostName;
9567 * } name;
9568 * } ServerName;
9569 * struct {
9570 * ServerName server_name_list<1..2^16-1>
9571 * } ServerNameList;
9572 */
Ronald Cronce7d76e2022-07-08 18:56:49 +02009573MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01009574int mbedtls_ssl_parse_server_name_ext(mbedtls_ssl_context *ssl,
9575 const unsigned char *buf,
9576 const unsigned char *end)
XiaokangQian40a35232022-05-07 09:02:40 +00009577{
9578 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
9579 const unsigned char *p = buf;
XiaokangQian9b2b7712022-05-17 02:57:00 +00009580 size_t server_name_list_len, hostname_len;
9581 const unsigned char *server_name_list_end;
XiaokangQian40a35232022-05-07 09:02:40 +00009582
Gilles Peskine449bd832023-01-11 14:50:10 +01009583 MBEDTLS_SSL_DEBUG_MSG(3, ("parse ServerName extension"));
XiaokangQian40a35232022-05-07 09:02:40 +00009584
Gilles Peskine449bd832023-01-11 14:50:10 +01009585 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
9586 server_name_list_len = MBEDTLS_GET_UINT16_BE(p, 0);
XiaokangQian40a35232022-05-07 09:02:40 +00009587 p += 2;
9588
Gilles Peskine449bd832023-01-11 14:50:10 +01009589 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, server_name_list_len);
XiaokangQian9b2b7712022-05-17 02:57:00 +00009590 server_name_list_end = p + server_name_list_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01009591 while (p < server_name_list_end) {
9592 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, server_name_list_end, 3);
9593 hostname_len = MBEDTLS_GET_UINT16_BE(p, 1);
9594 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, server_name_list_end,
9595 hostname_len + 3);
XiaokangQian40a35232022-05-07 09:02:40 +00009596
Gilles Peskine449bd832023-01-11 14:50:10 +01009597 if (p[0] == MBEDTLS_TLS_EXT_SERVERNAME_HOSTNAME) {
XiaokangQian75fe8c72022-06-15 09:42:45 +00009598 /* sni_name is intended to be used only during the parsing of the
9599 * ClientHello message (it is reset to NULL before the end of
9600 * the message parsing). Thus it is ok to just point to the
9601 * reception buffer and not make a copy of it.
9602 */
XiaokangQianf2a94202022-05-20 06:44:24 +00009603 ssl->handshake->sni_name = p + 3;
9604 ssl->handshake->sni_name_len = hostname_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01009605 if (ssl->conf->f_sni == NULL) {
9606 return 0;
XiaokangQian40a35232022-05-07 09:02:40 +00009607 }
Gilles Peskine449bd832023-01-11 14:50:10 +01009608 ret = ssl->conf->f_sni(ssl->conf->p_sni,
9609 ssl, p + 3, hostname_len);
9610 if (ret != 0) {
9611 MBEDTLS_SSL_DEBUG_RET(1, "ssl_sni_wrapper", ret);
9612 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_UNRECOGNIZED_NAME,
9613 MBEDTLS_ERR_SSL_UNRECOGNIZED_NAME);
9614 return MBEDTLS_ERR_SSL_UNRECOGNIZED_NAME;
9615 }
9616 return 0;
XiaokangQian40a35232022-05-07 09:02:40 +00009617 }
9618
9619 p += hostname_len + 3;
9620 }
9621
Gilles Peskine449bd832023-01-11 14:50:10 +01009622 return 0;
XiaokangQian40a35232022-05-07 09:02:40 +00009623}
9624#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
9625
XiaokangQianacb39922022-06-17 10:18:48 +00009626#if defined(MBEDTLS_SSL_ALPN)
Ronald Cronce7d76e2022-07-08 18:56:49 +02009627MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01009628int mbedtls_ssl_parse_alpn_ext(mbedtls_ssl_context *ssl,
9629 const unsigned char *buf,
9630 const unsigned char *end)
XiaokangQianacb39922022-06-17 10:18:48 +00009631{
9632 const unsigned char *p = buf;
XiaokangQianc7403452022-06-23 03:24:12 +00009633 size_t protocol_name_list_len;
XiaokangQian95d5f542022-06-24 02:29:26 +00009634 const unsigned char *protocol_name_list;
9635 const unsigned char *protocol_name_list_end;
XiaokangQianc7403452022-06-23 03:24:12 +00009636 size_t protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00009637
9638 /* If ALPN not configured, just ignore the extension */
Gilles Peskine449bd832023-01-11 14:50:10 +01009639 if (ssl->conf->alpn_list == NULL) {
9640 return 0;
9641 }
XiaokangQianacb39922022-06-17 10:18:48 +00009642
9643 /*
XiaokangQianc7403452022-06-23 03:24:12 +00009644 * RFC7301, section 3.1
9645 * opaque ProtocolName<1..2^8-1>;
XiaokangQianacb39922022-06-17 10:18:48 +00009646 *
XiaokangQianc7403452022-06-23 03:24:12 +00009647 * struct {
9648 * ProtocolName protocol_name_list<2..2^16-1>
9649 * } ProtocolNameList;
XiaokangQianacb39922022-06-17 10:18:48 +00009650 */
9651
XiaokangQianc7403452022-06-23 03:24:12 +00009652 /*
XiaokangQian0b776e22022-06-24 09:04:59 +00009653 * protocol_name_list_len 2 bytes
9654 * protocol_name_len 1 bytes
9655 * protocol_name >=1 byte
XiaokangQianc7403452022-06-23 03:24:12 +00009656 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009657 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 4);
XiaokangQianacb39922022-06-17 10:18:48 +00009658
Gilles Peskine449bd832023-01-11 14:50:10 +01009659 protocol_name_list_len = MBEDTLS_GET_UINT16_BE(p, 0);
XiaokangQianacb39922022-06-17 10:18:48 +00009660 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01009661 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, protocol_name_list_len);
XiaokangQian95d5f542022-06-24 02:29:26 +00009662 protocol_name_list = p;
9663 protocol_name_list_end = p + protocol_name_list_len;
XiaokangQianacb39922022-06-17 10:18:48 +00009664
9665 /* Validate peer's list (lengths) */
Gilles Peskine449bd832023-01-11 14:50:10 +01009666 while (p < protocol_name_list_end) {
XiaokangQian95d5f542022-06-24 02:29:26 +00009667 protocol_name_len = *p++;
Gilles Peskine449bd832023-01-11 14:50:10 +01009668 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, protocol_name_list_end,
9669 protocol_name_len);
9670 if (protocol_name_len == 0) {
XiaokangQian95d5f542022-06-24 02:29:26 +00009671 MBEDTLS_SSL_PEND_FATAL_ALERT(
9672 MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
Gilles Peskine449bd832023-01-11 14:50:10 +01009673 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
9674 return MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
XiaokangQian95d5f542022-06-24 02:29:26 +00009675 }
9676
9677 p += protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00009678 }
9679
9680 /* Use our order of preference */
Gilles Peskine449bd832023-01-11 14:50:10 +01009681 for (const char **alpn = ssl->conf->alpn_list; *alpn != NULL; alpn++) {
9682 size_t const alpn_len = strlen(*alpn);
XiaokangQian95d5f542022-06-24 02:29:26 +00009683 p = protocol_name_list;
Gilles Peskine449bd832023-01-11 14:50:10 +01009684 while (p < protocol_name_list_end) {
XiaokangQian95d5f542022-06-24 02:29:26 +00009685 protocol_name_len = *p++;
Gilles Peskine449bd832023-01-11 14:50:10 +01009686 if (protocol_name_len == alpn_len &&
9687 memcmp(p, *alpn, alpn_len) == 0) {
XiaokangQianacb39922022-06-17 10:18:48 +00009688 ssl->alpn_chosen = *alpn;
Gilles Peskine449bd832023-01-11 14:50:10 +01009689 return 0;
XiaokangQianacb39922022-06-17 10:18:48 +00009690 }
XiaokangQian95d5f542022-06-24 02:29:26 +00009691
9692 p += protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00009693 }
9694 }
9695
XiaokangQian95d5f542022-06-24 02:29:26 +00009696 /* If we get here, no match was found */
XiaokangQianacb39922022-06-17 10:18:48 +00009697 MBEDTLS_SSL_PEND_FATAL_ALERT(
Gilles Peskine449bd832023-01-11 14:50:10 +01009698 MBEDTLS_SSL_ALERT_MSG_NO_APPLICATION_PROTOCOL,
9699 MBEDTLS_ERR_SSL_NO_APPLICATION_PROTOCOL);
9700 return MBEDTLS_ERR_SSL_NO_APPLICATION_PROTOCOL;
XiaokangQianacb39922022-06-17 10:18:48 +00009701}
9702
Gilles Peskine449bd832023-01-11 14:50:10 +01009703int mbedtls_ssl_write_alpn_ext(mbedtls_ssl_context *ssl,
9704 unsigned char *buf,
9705 unsigned char *end,
9706 size_t *out_len)
XiaokangQianacb39922022-06-17 10:18:48 +00009707{
9708 unsigned char *p = buf;
XiaokangQian95d5f542022-06-24 02:29:26 +00009709 size_t protocol_name_len;
XiaokangQianc7403452022-06-23 03:24:12 +00009710 *out_len = 0;
XiaokangQianacb39922022-06-17 10:18:48 +00009711
Gilles Peskine449bd832023-01-11 14:50:10 +01009712 if (ssl->alpn_chosen == NULL) {
9713 return 0;
XiaokangQianacb39922022-06-17 10:18:48 +00009714 }
9715
Gilles Peskine449bd832023-01-11 14:50:10 +01009716 protocol_name_len = strlen(ssl->alpn_chosen);
9717 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 7 + protocol_name_len);
XiaokangQianacb39922022-06-17 10:18:48 +00009718
Gilles Peskine449bd832023-01-11 14:50:10 +01009719 MBEDTLS_SSL_DEBUG_MSG(3, ("server side, adding alpn extension"));
XiaokangQianacb39922022-06-17 10:18:48 +00009720 /*
9721 * 0 . 1 ext identifier
9722 * 2 . 3 ext length
9723 * 4 . 5 protocol list length
9724 * 6 . 6 protocol name length
9725 * 7 . 7+n protocol name
9726 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009727 MBEDTLS_PUT_UINT16_BE(MBEDTLS_TLS_EXT_ALPN, p, 0);
XiaokangQianacb39922022-06-17 10:18:48 +00009728
XiaokangQian95d5f542022-06-24 02:29:26 +00009729 *out_len = 7 + protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00009730
Gilles Peskine449bd832023-01-11 14:50:10 +01009731 MBEDTLS_PUT_UINT16_BE(protocol_name_len + 3, p, 2);
9732 MBEDTLS_PUT_UINT16_BE(protocol_name_len + 1, p, 4);
XiaokangQian0b776e22022-06-24 09:04:59 +00009733 /* Note: the length of the chosen protocol has been checked to be less
9734 * than 255 bytes in `mbedtls_ssl_conf_alpn_protocols`.
9735 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009736 p[6] = MBEDTLS_BYTE_0(protocol_name_len);
XiaokangQianacb39922022-06-17 10:18:48 +00009737
Gilles Peskine449bd832023-01-11 14:50:10 +01009738 memcpy(p + 7, ssl->alpn_chosen, protocol_name_len);
Jerry Yub95dd362022-11-08 21:19:34 +08009739
9740#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01009741 mbedtls_ssl_tls13_set_hs_sent_ext_mask(ssl, MBEDTLS_TLS_EXT_ALPN);
Jerry Yub95dd362022-11-08 21:19:34 +08009742#endif
9743
Gilles Peskine449bd832023-01-11 14:50:10 +01009744 return 0;
XiaokangQianacb39922022-06-17 10:18:48 +00009745}
9746#endif /* MBEDTLS_SSL_ALPN */
9747
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009748#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && \
Xiaokang Qian03409292022-10-12 02:49:52 +00009749 defined(MBEDTLS_SSL_SESSION_TICKETS) && \
Xiaokang Qianed0620c2022-10-12 06:58:13 +00009750 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION) && \
Xiaokang Qianed3afcd2022-10-12 08:31:11 +00009751 defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01009752int mbedtls_ssl_session_set_hostname(mbedtls_ssl_session *session,
9753 const char *hostname)
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009754{
9755 /* Initialize to suppress unnecessary compiler warning */
9756 size_t hostname_len = 0;
9757
9758 /* Check if new hostname is valid before
9759 * making any change to current one */
Gilles Peskine449bd832023-01-11 14:50:10 +01009760 if (hostname != NULL) {
9761 hostname_len = strlen(hostname);
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009762
Gilles Peskine449bd832023-01-11 14:50:10 +01009763 if (hostname_len > MBEDTLS_SSL_MAX_HOST_NAME_LEN) {
9764 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9765 }
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009766 }
9767
9768 /* Now it's clear that we will overwrite the old hostname,
9769 * so we can free it safely */
Gilles Peskine449bd832023-01-11 14:50:10 +01009770 if (session->hostname != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01009771 mbedtls_zeroize_and_free(session->hostname,
Gilles Peskine449bd832023-01-11 14:50:10 +01009772 strlen(session->hostname));
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009773 }
9774
9775 /* Passing NULL as hostname shall clear the old one */
Gilles Peskine449bd832023-01-11 14:50:10 +01009776 if (hostname == NULL) {
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009777 session->hostname = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01009778 } else {
9779 session->hostname = mbedtls_calloc(1, hostname_len + 1);
9780 if (session->hostname == NULL) {
9781 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
9782 }
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009783
Gilles Peskine449bd832023-01-11 14:50:10 +01009784 memcpy(session->hostname, hostname, hostname_len);
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009785 }
9786
Gilles Peskine449bd832023-01-11 14:50:10 +01009787 return 0;
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009788}
Xiaokang Qian03409292022-10-12 02:49:52 +00009789#endif /* MBEDTLS_SSL_PROTO_TLS1_3 &&
9790 MBEDTLS_SSL_SESSION_TICKETS &&
Xiaokang Qianed0620c2022-10-12 06:58:13 +00009791 MBEDTLS_SSL_SERVER_NAME_INDICATION &&
Xiaokang Qianed3afcd2022-10-12 08:31:11 +00009792 MBEDTLS_SSL_CLI_C */
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009793
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02009794#endif /* MBEDTLS_SSL_TLS_C */