blob: ae42cf350c3ab91e38f898796cd970544d428d79 [file] [log] [blame]
Paul Bakker5121ce52009-01-03 21:22:43 +00001/*
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01002 * TLS shared functions
Paul Bakker5121ce52009-01-03 21:22:43 +00003 *
Bence Szépkúti1e148272020-08-07 13:07:28 +02004 * Copyright The Mbed TLS Contributors
Dave Rodgman16799db2023-11-02 19:47:20 +00005 * SPDX-License-Identifier: Apache-2.0 OR GPL-2.0-or-later
Paul Bakker5121ce52009-01-03 21:22:43 +00006 */
7/*
Paul Bakker5121ce52009-01-03 21:22:43 +00008 * http://www.ietf.org/rfc/rfc2246.txt
9 * http://www.ietf.org/rfc/rfc4346.txt
10 */
11
Gilles Peskinedb09ef62020-06-03 01:43:33 +020012#include "common.h"
Paul Bakker5121ce52009-01-03 21:22:43 +000013
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020014#if defined(MBEDTLS_SSL_TLS_C)
Paul Bakker5121ce52009-01-03 21:22:43 +000015
SimonBd5800b72016-04-26 07:43:27 +010016#include "mbedtls/platform.h"
SimonBd5800b72016-04-26 07:43:27 +010017
Manuel Pégourié-Gonnard7f809972015-03-09 17:05:11 +000018#include "mbedtls/ssl.h"
Ronald Cron9f0fba32022-02-10 16:45:15 +010019#include "ssl_client.h"
Ronald Cron27c85e72022-03-08 11:37:55 +010020#include "ssl_debug_helpers.h"
Chris Jones84a773f2021-03-05 18:38:47 +000021#include "ssl_misc.h"
Andrzej Kurek25f27152022-08-17 16:09:31 -040022
Valerio Settib4f50762024-01-17 10:24:52 +010023#include "debug_internal.h"
Janos Follath73c616b2019-12-18 15:07:04 +000024#include "mbedtls/error.h"
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -050025#include "mbedtls/platform_util.h"
Hanno Beckera835da52019-05-16 12:39:07 +010026#include "mbedtls/version.h"
Gabor Mezei765862c2021-10-19 12:22:25 +020027#include "mbedtls/constant_time.h"
Paul Bakker0be444a2013-08-27 21:55:01 +020028
Rich Evans00ab4702015-02-06 13:43:58 +000029#include <string.h>
30
Andrzej Kurekd6db9be2019-01-10 05:27:10 -050031#if defined(MBEDTLS_USE_PSA_CRYPTO)
Valerio Setti384fbde2024-01-02 13:26:40 +010032#include "mbedtls/psa_util.h"
Manuel Pégourié-Gonnard02b10d82023-03-28 12:33:20 +020033#include "md_psa.h"
Manuel Pégourié-Gonnard2be8c632023-06-07 13:07:21 +020034#include "psa_util_internal.h"
Andrzej Kurekd6db9be2019-01-10 05:27:10 -050035#include "psa/crypto.h"
36#endif
37
Janos Follath23bdca02016-10-07 14:47:14 +010038#if defined(MBEDTLS_X509_CRT_PARSE_C)
Manuel Pégourié-Gonnard7f809972015-03-09 17:05:11 +000039#include "mbedtls/oid.h"
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +020040#endif
41
Andrzej Kurek8a045ce2022-12-23 11:00:06 -050042#if defined(MBEDTLS_USE_PSA_CRYPTO)
Andrzej Kurek00644842023-05-30 05:45:00 -040043/* Define local translating functions to save code size by not using too many
44 * arguments in each translating place. */
45static int local_err_translation(psa_status_t status)
46{
47 return psa_status_to_mbedtls(status, psa_to_ssl_errors,
Andrzej Kurek1e4a0302023-05-30 09:45:17 -040048 ARRAY_LENGTH(psa_to_ssl_errors),
Andrzej Kurek00644842023-05-30 05:45:00 -040049 psa_generic_status_to_mbedtls);
50}
51#define PSA_TO_MBEDTLS_ERR(status) local_err_translation(status)
Andrzej Kurek8a045ce2022-12-23 11:00:06 -050052#endif
53
Ronald Cronad8c17b2022-06-10 17:18:09 +020054#if defined(MBEDTLS_TEST_HOOKS)
55static mbedtls_ssl_chk_buf_ptr_args chk_buf_ptr_fail_args;
56
57void mbedtls_ssl_set_chk_buf_ptr_fail_args(
Gilles Peskine449bd832023-01-11 14:50:10 +010058 const uint8_t *cur, const uint8_t *end, size_t need)
Ronald Cronad8c17b2022-06-10 17:18:09 +020059{
60 chk_buf_ptr_fail_args.cur = cur;
61 chk_buf_ptr_fail_args.end = end;
62 chk_buf_ptr_fail_args.need = need;
63}
64
Gilles Peskine449bd832023-01-11 14:50:10 +010065void mbedtls_ssl_reset_chk_buf_ptr_fail_args(void)
Ronald Cronad8c17b2022-06-10 17:18:09 +020066{
Gilles Peskine449bd832023-01-11 14:50:10 +010067 memset(&chk_buf_ptr_fail_args, 0, sizeof(chk_buf_ptr_fail_args));
Ronald Cronad8c17b2022-06-10 17:18:09 +020068}
69
Gilles Peskine449bd832023-01-11 14:50:10 +010070int mbedtls_ssl_cmp_chk_buf_ptr_fail_args(mbedtls_ssl_chk_buf_ptr_args *args)
Ronald Cronad8c17b2022-06-10 17:18:09 +020071{
Gilles Peskine449bd832023-01-11 14:50:10 +010072 return (chk_buf_ptr_fail_args.cur != args->cur) ||
73 (chk_buf_ptr_fail_args.end != args->end) ||
74 (chk_buf_ptr_fail_args.need != args->need);
Ronald Cronad8c17b2022-06-10 17:18:09 +020075}
76#endif /* MBEDTLS_TEST_HOOKS */
77
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +020078#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker2b1e3542018-08-06 11:19:13 +010079
Hanno Beckera0e20d02019-05-15 14:03:01 +010080#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckerf8542cf2019-04-09 15:22:03 +010081/* Top-level Connection ID API */
82
Gilles Peskine449bd832023-01-11 14:50:10 +010083int mbedtls_ssl_conf_cid(mbedtls_ssl_config *conf,
84 size_t len,
85 int ignore_other_cid)
Hanno Beckerad4a1372019-05-03 13:06:44 +010086{
Gilles Peskine449bd832023-01-11 14:50:10 +010087 if (len > MBEDTLS_SSL_CID_IN_LEN_MAX) {
88 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
89 }
Hanno Beckerad4a1372019-05-03 13:06:44 +010090
Gilles Peskine449bd832023-01-11 14:50:10 +010091 if (ignore_other_cid != MBEDTLS_SSL_UNEXPECTED_CID_FAIL &&
92 ignore_other_cid != MBEDTLS_SSL_UNEXPECTED_CID_IGNORE) {
93 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Becker611ac772019-05-14 11:45:26 +010094 }
95
96 conf->ignore_unexpected_cid = ignore_other_cid;
Hanno Beckerad4a1372019-05-03 13:06:44 +010097 conf->cid_len = len;
Gilles Peskine449bd832023-01-11 14:50:10 +010098 return 0;
Hanno Beckerad4a1372019-05-03 13:06:44 +010099}
100
Gilles Peskine449bd832023-01-11 14:50:10 +0100101int mbedtls_ssl_set_cid(mbedtls_ssl_context *ssl,
102 int enable,
103 unsigned char const *own_cid,
104 size_t own_cid_len)
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100105{
Gilles Peskine449bd832023-01-11 14:50:10 +0100106 if (ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
107 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
108 }
Hanno Becker76a79ab2019-05-03 14:38:32 +0100109
Hanno Beckerca092242019-04-25 16:01:49 +0100110 ssl->negotiate_cid = enable;
Gilles Peskine449bd832023-01-11 14:50:10 +0100111 if (enable == MBEDTLS_SSL_CID_DISABLED) {
112 MBEDTLS_SSL_DEBUG_MSG(3, ("Disable use of CID extension."));
113 return 0;
Hanno Beckerca092242019-04-25 16:01:49 +0100114 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100115 MBEDTLS_SSL_DEBUG_MSG(3, ("Enable use of CID extension."));
116 MBEDTLS_SSL_DEBUG_BUF(3, "Own CID", own_cid, own_cid_len);
Hanno Beckerca092242019-04-25 16:01:49 +0100117
Gilles Peskine449bd832023-01-11 14:50:10 +0100118 if (own_cid_len != ssl->conf->cid_len) {
119 MBEDTLS_SSL_DEBUG_MSG(3, ("CID length %u does not match CID length %u in config",
120 (unsigned) own_cid_len,
121 (unsigned) ssl->conf->cid_len));
122 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Beckerca092242019-04-25 16:01:49 +0100123 }
124
Gilles Peskine449bd832023-01-11 14:50:10 +0100125 memcpy(ssl->own_cid, own_cid, own_cid_len);
Hanno Beckerb7ee0cf2019-04-30 14:07:31 +0100126 /* Truncation is not an issue here because
127 * MBEDTLS_SSL_CID_IN_LEN_MAX at most 255. */
128 ssl->own_cid_len = (uint8_t) own_cid_len;
Hanno Beckerca092242019-04-25 16:01:49 +0100129
Gilles Peskine449bd832023-01-11 14:50:10 +0100130 return 0;
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100131}
132
Gilles Peskine449bd832023-01-11 14:50:10 +0100133int mbedtls_ssl_get_own_cid(mbedtls_ssl_context *ssl,
134 int *enabled,
135 unsigned char own_cid[MBEDTLS_SSL_CID_OUT_LEN_MAX],
136 size_t *own_cid_len)
Paul Elliott0113cf12022-03-11 20:26:47 +0000137{
138 *enabled = MBEDTLS_SSL_CID_DISABLED;
139
Gilles Peskine449bd832023-01-11 14:50:10 +0100140 if (ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
141 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
142 }
Paul Elliott0113cf12022-03-11 20:26:47 +0000143
144 /* We report MBEDTLS_SSL_CID_DISABLED in case the CID length is
145 * zero as this is indistinguishable from not requesting to use
146 * the CID extension. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100147 if (ssl->own_cid_len == 0 || ssl->negotiate_cid == MBEDTLS_SSL_CID_DISABLED) {
148 return 0;
149 }
Paul Elliott0113cf12022-03-11 20:26:47 +0000150
Gilles Peskine449bd832023-01-11 14:50:10 +0100151 if (own_cid_len != NULL) {
Paul Elliott0113cf12022-03-11 20:26:47 +0000152 *own_cid_len = ssl->own_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +0100153 if (own_cid != NULL) {
154 memcpy(own_cid, ssl->own_cid, ssl->own_cid_len);
155 }
Paul Elliott0113cf12022-03-11 20:26:47 +0000156 }
157
158 *enabled = MBEDTLS_SSL_CID_ENABLED;
159
Gilles Peskine449bd832023-01-11 14:50:10 +0100160 return 0;
Paul Elliott0113cf12022-03-11 20:26:47 +0000161}
162
Gilles Peskine449bd832023-01-11 14:50:10 +0100163int mbedtls_ssl_get_peer_cid(mbedtls_ssl_context *ssl,
164 int *enabled,
165 unsigned char peer_cid[MBEDTLS_SSL_CID_OUT_LEN_MAX],
166 size_t *peer_cid_len)
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100167{
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100168 *enabled = MBEDTLS_SSL_CID_DISABLED;
Hanno Beckerb1f89cd2019-04-26 17:08:02 +0100169
Gilles Peskine449bd832023-01-11 14:50:10 +0100170 if (ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM ||
171 mbedtls_ssl_is_handshake_over(ssl) == 0) {
172 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Becker76a79ab2019-05-03 14:38:32 +0100173 }
Hanno Beckerb1f89cd2019-04-26 17:08:02 +0100174
Hanno Beckerc5f24222019-05-03 12:54:52 +0100175 /* We report MBEDTLS_SSL_CID_DISABLED in case the CID extensions
176 * were used, but client and server requested the empty CID.
177 * This is indistinguishable from not using the CID extension
178 * in the first place. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100179 if (ssl->transform_in->in_cid_len == 0 &&
180 ssl->transform_in->out_cid_len == 0) {
181 return 0;
Hanno Beckerb1f89cd2019-04-26 17:08:02 +0100182 }
183
Gilles Peskine449bd832023-01-11 14:50:10 +0100184 if (peer_cid_len != NULL) {
Hanno Becker615ef172019-05-22 16:50:35 +0100185 *peer_cid_len = ssl->transform_in->out_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +0100186 if (peer_cid != NULL) {
187 memcpy(peer_cid, ssl->transform_in->out_cid,
188 ssl->transform_in->out_cid_len);
Hanno Becker615ef172019-05-22 16:50:35 +0100189 }
190 }
Hanno Beckerb1f89cd2019-04-26 17:08:02 +0100191
192 *enabled = MBEDTLS_SSL_CID_ENABLED;
193
Gilles Peskine449bd832023-01-11 14:50:10 +0100194 return 0;
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100195}
Hanno Beckera0e20d02019-05-15 14:03:01 +0100196#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100197
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200198#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200199
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200200#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Manuel Pégourié-Gonnard581e6b62013-07-18 12:32:27 +0200201/*
202 * Convert max_fragment_length codes to length.
203 * RFC 6066 says:
204 * enum{
205 * 2^9(1), 2^10(2), 2^11(3), 2^12(4), (255)
206 * } MaxFragmentLength;
207 * and we add 0 -> extension unused
208 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100209static unsigned int ssl_mfl_code_to_length(int mfl)
Manuel Pégourié-Gonnard581e6b62013-07-18 12:32:27 +0200210{
Gilles Peskine449bd832023-01-11 14:50:10 +0100211 switch (mfl) {
212 case MBEDTLS_SSL_MAX_FRAG_LEN_NONE:
213 return MBEDTLS_TLS_EXT_ADV_CONTENT_LEN;
214 case MBEDTLS_SSL_MAX_FRAG_LEN_512:
215 return 512;
216 case MBEDTLS_SSL_MAX_FRAG_LEN_1024:
217 return 1024;
218 case MBEDTLS_SSL_MAX_FRAG_LEN_2048:
219 return 2048;
220 case MBEDTLS_SSL_MAX_FRAG_LEN_4096:
221 return 4096;
222 default:
223 return MBEDTLS_TLS_EXT_ADV_CONTENT_LEN;
Angus Grattond8213d02016-05-25 20:56:48 +1000224 }
225}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200226#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
Manuel Pégourié-Gonnard581e6b62013-07-18 12:32:27 +0200227
Gilles Peskine449bd832023-01-11 14:50:10 +0100228int mbedtls_ssl_session_copy(mbedtls_ssl_session *dst,
229 const mbedtls_ssl_session *src)
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200230{
Gilles Peskine449bd832023-01-11 14:50:10 +0100231 mbedtls_ssl_session_free(dst);
232 memcpy(dst, src, sizeof(mbedtls_ssl_session));
吴敬辉0b716112021-11-29 10:46:35 +0800233#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
234 dst->ticket = NULL;
Xiaokang Qian87306442022-10-12 09:47:38 +0000235#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && \
236 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Xiaokang Qian126bf8e2022-10-13 02:22:40 +0000237 dst->hostname = NULL;
吴敬辉0b716112021-11-29 10:46:35 +0800238#endif
Xiaokang Qian87306442022-10-12 09:47:38 +0000239#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
吴敬辉0b716112021-11-29 10:46:35 +0800240
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200241#if defined(MBEDTLS_X509_CRT_PARSE_C)
Hanno Becker6d1986e2019-02-07 12:27:42 +0000242
243#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +0100244 if (src->peer_cert != NULL) {
Janos Follath865b3eb2019-12-16 11:46:15 +0000245 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker2292d1f2013-09-15 17:06:49 +0200246
Gilles Peskine449bd832023-01-11 14:50:10 +0100247 dst->peer_cert = mbedtls_calloc(1, sizeof(mbedtls_x509_crt));
248 if (dst->peer_cert == NULL) {
249 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
250 }
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200251
Gilles Peskine449bd832023-01-11 14:50:10 +0100252 mbedtls_x509_crt_init(dst->peer_cert);
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200253
Gilles Peskine449bd832023-01-11 14:50:10 +0100254 if ((ret = mbedtls_x509_crt_parse_der(dst->peer_cert, src->peer_cert->raw.p,
255 src->peer_cert->raw.len)) != 0) {
256 mbedtls_free(dst->peer_cert);
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200257 dst->peer_cert = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +0100258 return ret;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200259 }
260 }
Hanno Becker6d1986e2019-02-07 12:27:42 +0000261#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Gilles Peskine449bd832023-01-11 14:50:10 +0100262 if (src->peer_cert_digest != NULL) {
Hanno Becker9198ad12019-02-05 17:00:50 +0000263 dst->peer_cert_digest =
Gilles Peskine449bd832023-01-11 14:50:10 +0100264 mbedtls_calloc(1, src->peer_cert_digest_len);
265 if (dst->peer_cert_digest == NULL) {
266 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
267 }
Hanno Becker9198ad12019-02-05 17:00:50 +0000268
Gilles Peskine449bd832023-01-11 14:50:10 +0100269 memcpy(dst->peer_cert_digest, src->peer_cert_digest,
270 src->peer_cert_digest_len);
Hanno Becker9198ad12019-02-05 17:00:50 +0000271 dst->peer_cert_digest_type = src->peer_cert_digest_type;
Hanno Beckeraccc5992019-02-25 10:06:59 +0000272 dst->peer_cert_digest_len = src->peer_cert_digest_len;
Hanno Becker9198ad12019-02-05 17:00:50 +0000273 }
274#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
275
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200276#endif /* MBEDTLS_X509_CRT_PARSE_C */
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200277
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +0200278#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +0100279 if (src->ticket != NULL) {
280 dst->ticket = mbedtls_calloc(1, src->ticket_len);
281 if (dst->ticket == NULL) {
282 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
283 }
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200284
Gilles Peskine449bd832023-01-11 14:50:10 +0100285 memcpy(dst->ticket, src->ticket, src->ticket_len);
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200286 }
Xiaokang Qian126bf8e2022-10-13 02:22:40 +0000287
288#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && \
289 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +0100290 if (src->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Xiaokang Qian126bf8e2022-10-13 02:22:40 +0000291 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine449bd832023-01-11 14:50:10 +0100292 ret = mbedtls_ssl_session_set_hostname(dst, src->hostname);
293 if (ret != 0) {
294 return ret;
295 }
Xiaokang Qian126bf8e2022-10-13 02:22:40 +0000296 }
297#endif /* MBEDTLS_SSL_PROTO_TLS1_3 &&
298 MBEDTLS_SSL_SERVER_NAME_INDICATION */
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +0200299#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200300
Gilles Peskine449bd832023-01-11 14:50:10 +0100301 return 0;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200302}
303
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500304#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200305MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100306static int resize_buffer(unsigned char **buffer, size_t len_new, size_t *len_old)
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500307{
Gilles Peskine449bd832023-01-11 14:50:10 +0100308 unsigned char *resized_buffer = mbedtls_calloc(1, len_new);
309 if (resized_buffer == NULL) {
Yanray Wang365ee3e2023-11-22 10:28:28 +0800310 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
Gilles Peskine449bd832023-01-11 14:50:10 +0100311 }
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500312
313 /* We want to copy len_new bytes when downsizing the buffer, and
314 * len_old bytes when upsizing, so we choose the smaller of two sizes,
315 * to fit one buffer into another. Size checks, ensuring that no data is
316 * lost, are done outside of this function. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100317 memcpy(resized_buffer, *buffer,
318 (len_new < *len_old) ? len_new : *len_old);
Tom Cosgroveca8c61b2023-07-17 15:17:40 +0100319 mbedtls_zeroize_and_free(*buffer, *len_old);
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500320
321 *buffer = resized_buffer;
322 *len_old = len_new;
323
324 return 0;
325}
Andrzej Kurek4a063792020-10-21 15:08:44 +0200326
Gilles Peskine449bd832023-01-11 14:50:10 +0100327static void handle_buffer_resizing(mbedtls_ssl_context *ssl, int downsizing,
328 size_t in_buf_new_len,
329 size_t out_buf_new_len)
Andrzej Kurek4a063792020-10-21 15:08:44 +0200330{
331 int modified = 0;
332 size_t written_in = 0, iv_offset_in = 0, len_offset_in = 0;
333 size_t written_out = 0, iv_offset_out = 0, len_offset_out = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +0100334 if (ssl->in_buf != NULL) {
Andrzej Kurek4a063792020-10-21 15:08:44 +0200335 written_in = ssl->in_msg - ssl->in_buf;
336 iv_offset_in = ssl->in_iv - ssl->in_buf;
337 len_offset_in = ssl->in_len - ssl->in_buf;
Gilles Peskine449bd832023-01-11 14:50:10 +0100338 if (downsizing ?
Andrzej Kurek4a063792020-10-21 15:08:44 +0200339 ssl->in_buf_len > in_buf_new_len && ssl->in_left < in_buf_new_len :
Gilles Peskine449bd832023-01-11 14:50:10 +0100340 ssl->in_buf_len < in_buf_new_len) {
341 if (resize_buffer(&ssl->in_buf, in_buf_new_len, &ssl->in_buf_len) != 0) {
342 MBEDTLS_SSL_DEBUG_MSG(1, ("input buffer resizing failed - out of memory"));
343 } else {
344 MBEDTLS_SSL_DEBUG_MSG(2, ("Reallocating in_buf to %" MBEDTLS_PRINTF_SIZET,
345 in_buf_new_len));
Andrzej Kurek4a063792020-10-21 15:08:44 +0200346 modified = 1;
347 }
348 }
349 }
350
Gilles Peskine449bd832023-01-11 14:50:10 +0100351 if (ssl->out_buf != NULL) {
Andrzej Kurek4a063792020-10-21 15:08:44 +0200352 written_out = ssl->out_msg - ssl->out_buf;
353 iv_offset_out = ssl->out_iv - ssl->out_buf;
354 len_offset_out = ssl->out_len - ssl->out_buf;
Gilles Peskine449bd832023-01-11 14:50:10 +0100355 if (downsizing ?
Andrzej Kurek4a063792020-10-21 15:08:44 +0200356 ssl->out_buf_len > out_buf_new_len && ssl->out_left < out_buf_new_len :
Gilles Peskine449bd832023-01-11 14:50:10 +0100357 ssl->out_buf_len < out_buf_new_len) {
358 if (resize_buffer(&ssl->out_buf, out_buf_new_len, &ssl->out_buf_len) != 0) {
359 MBEDTLS_SSL_DEBUG_MSG(1, ("output buffer resizing failed - out of memory"));
360 } else {
361 MBEDTLS_SSL_DEBUG_MSG(2, ("Reallocating out_buf to %" MBEDTLS_PRINTF_SIZET,
362 out_buf_new_len));
Andrzej Kurek4a063792020-10-21 15:08:44 +0200363 modified = 1;
364 }
365 }
366 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100367 if (modified) {
Andrzej Kurek4a063792020-10-21 15:08:44 +0200368 /* Update pointers here to avoid doing it twice. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100369 mbedtls_ssl_reset_in_out_pointers(ssl);
Andrzej Kurek4a063792020-10-21 15:08:44 +0200370 /* Fields below might not be properly updated with record
371 * splitting or with CID, so they are manually updated here. */
372 ssl->out_msg = ssl->out_buf + written_out;
373 ssl->out_len = ssl->out_buf + len_offset_out;
374 ssl->out_iv = ssl->out_buf + iv_offset_out;
375
376 ssl->in_msg = ssl->in_buf + written_in;
377 ssl->in_len = ssl->in_buf + len_offset_in;
378 ssl->in_iv = ssl->in_buf + iv_offset_in;
379 }
380}
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500381#endif /* MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH */
382
Jerry Yudb8c48a2022-01-27 14:54:54 +0800383#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Jerry Yued14c932022-02-17 13:40:45 +0800384
385#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
Gilles Peskine449bd832023-01-11 14:50:10 +0100386typedef int (*tls_prf_fn)(const unsigned char *secret, size_t slen,
387 const char *label,
388 const unsigned char *random, size_t rlen,
389 unsigned char *dstbuf, size_t dlen);
Jerry Yued14c932022-02-17 13:40:45 +0800390
Gilles Peskine449bd832023-01-11 14:50:10 +0100391static tls_prf_fn ssl_tls12prf_from_cs(int ciphersuite_id);
Jerry Yued14c932022-02-17 13:40:45 +0800392
393#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
394
395/* Type for the TLS PRF */
396typedef int ssl_tls_prf_t(const unsigned char *, size_t, const char *,
397 const unsigned char *, size_t,
398 unsigned char *, size_t);
399
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200400MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100401static int ssl_tls12_populate_transform(mbedtls_ssl_transform *transform,
402 int ciphersuite,
403 const unsigned char master[48],
Neil Armstrongf2c82f02022-04-05 11:16:53 +0200404#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +0100405 int encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +0200406#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +0100407 ssl_tls_prf_t tls_prf,
408 const unsigned char randbytes[64],
409 mbedtls_ssl_protocol_version tls_version,
410 unsigned endpoint,
411 const mbedtls_ssl_context *ssl);
Jerry Yued14c932022-02-17 13:40:45 +0800412
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100413#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200414MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100415static int tls_prf_sha256(const unsigned char *secret, size_t slen,
Ron Eldor51d3ab52019-05-12 14:54:30 +0300416 const char *label,
417 const unsigned char *random, size_t rlen,
Gilles Peskine449bd832023-01-11 14:50:10 +0100418 unsigned char *dstbuf, size_t dlen);
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100419static int ssl_calc_verify_tls_sha256(const mbedtls_ssl_context *, unsigned char *, size_t *);
420static int ssl_calc_finished_tls_sha256(mbedtls_ssl_context *, unsigned char *, int);
Gilles Peskine449bd832023-01-11 14:50:10 +0100421
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100422#endif /* MBEDTLS_MD_CAN_SHA256*/
Gilles Peskine449bd832023-01-11 14:50:10 +0100423
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100424#if defined(MBEDTLS_MD_CAN_SHA384)
Gilles Peskine449bd832023-01-11 14:50:10 +0100425MBEDTLS_CHECK_RETURN_CRITICAL
426static int tls_prf_sha384(const unsigned char *secret, size_t slen,
427 const char *label,
428 const unsigned char *random, size_t rlen,
429 unsigned char *dstbuf, size_t dlen);
430
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100431static int ssl_calc_verify_tls_sha384(const mbedtls_ssl_context *, unsigned char *, size_t *);
432static int ssl_calc_finished_tls_sha384(mbedtls_ssl_context *, unsigned char *, int);
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100433#endif /* MBEDTLS_MD_CAN_SHA384*/
Gilles Peskine449bd832023-01-11 14:50:10 +0100434
Gilles Peskine449bd832023-01-11 14:50:10 +0100435MBEDTLS_CHECK_RETURN_CRITICAL
436static int ssl_tls12_session_load(mbedtls_ssl_session *session,
437 const unsigned char *buf,
438 size_t len);
439#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
440
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100441static int ssl_update_checksum_start(mbedtls_ssl_context *, const unsigned char *, size_t);
Gilles Peskine449bd832023-01-11 14:50:10 +0100442
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100443#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100444static int ssl_update_checksum_sha256(mbedtls_ssl_context *, const unsigned char *, size_t);
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100445#endif /* MBEDTLS_MD_CAN_SHA256*/
Gilles Peskine449bd832023-01-11 14:50:10 +0100446
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100447#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100448static int ssl_update_checksum_sha384(mbedtls_ssl_context *, const unsigned char *, size_t);
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100449#endif /* MBEDTLS_MD_CAN_SHA384*/
Gilles Peskine449bd832023-01-11 14:50:10 +0100450
451int mbedtls_ssl_tls_prf(const mbedtls_tls_prf_types prf,
452 const unsigned char *secret, size_t slen,
453 const char *label,
454 const unsigned char *random, size_t rlen,
455 unsigned char *dstbuf, size_t dlen)
Ron Eldor51d3ab52019-05-12 14:54:30 +0300456{
457 mbedtls_ssl_tls_prf_cb *tls_prf = NULL;
458
Gilles Peskine449bd832023-01-11 14:50:10 +0100459 switch (prf) {
Ron Eldord2f25f72019-05-15 14:54:22 +0300460#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100461#if defined(MBEDTLS_MD_CAN_SHA384)
Ron Eldor51d3ab52019-05-12 14:54:30 +0300462 case MBEDTLS_SSL_TLS_PRF_SHA384:
463 tls_prf = tls_prf_sha384;
Gilles Peskine449bd832023-01-11 14:50:10 +0100464 break;
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100465#endif /* MBEDTLS_MD_CAN_SHA384*/
466#if defined(MBEDTLS_MD_CAN_SHA256)
Ron Eldor51d3ab52019-05-12 14:54:30 +0300467 case MBEDTLS_SSL_TLS_PRF_SHA256:
468 tls_prf = tls_prf_sha256;
Gilles Peskine449bd832023-01-11 14:50:10 +0100469 break;
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100470#endif /* MBEDTLS_MD_CAN_SHA256*/
Ron Eldord2f25f72019-05-15 14:54:22 +0300471#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100472 default:
473 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Ron Eldor51d3ab52019-05-12 14:54:30 +0300474 }
475
Gilles Peskine449bd832023-01-11 14:50:10 +0100476 return tls_prf(secret, slen, label, random, rlen, dstbuf, dlen);
Ron Eldor51d3ab52019-05-12 14:54:30 +0300477}
478
Jerry Yuc73c6182022-02-08 20:29:25 +0800479#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +0100480static void ssl_clear_peer_cert(mbedtls_ssl_session *session)
Jerry Yuc73c6182022-02-08 20:29:25 +0800481{
482#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +0100483 if (session->peer_cert != NULL) {
484 mbedtls_x509_crt_free(session->peer_cert);
485 mbedtls_free(session->peer_cert);
Jerry Yuc73c6182022-02-08 20:29:25 +0800486 session->peer_cert = NULL;
487 }
488#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Gilles Peskine449bd832023-01-11 14:50:10 +0100489 if (session->peer_cert_digest != NULL) {
Jerry Yuc73c6182022-02-08 20:29:25 +0800490 /* Zeroization is not necessary. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100491 mbedtls_free(session->peer_cert_digest);
Jerry Yuc73c6182022-02-08 20:29:25 +0800492 session->peer_cert_digest = NULL;
493 session->peer_cert_digest_type = MBEDTLS_MD_NONE;
494 session->peer_cert_digest_len = 0;
495 }
496#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
497}
498#endif /* MBEDTLS_X509_CRT_PARSE_C */
499
Gilles Peskine449bd832023-01-11 14:50:10 +0100500uint32_t mbedtls_ssl_get_extension_id(unsigned int extension_type)
Jerry Yu7a485c12022-10-31 13:08:18 +0800501{
Gilles Peskine449bd832023-01-11 14:50:10 +0100502 switch (extension_type) {
Jerry Yu7a485c12022-10-31 13:08:18 +0800503 case MBEDTLS_TLS_EXT_SERVERNAME:
Gilles Peskine449bd832023-01-11 14:50:10 +0100504 return MBEDTLS_SSL_EXT_ID_SERVERNAME;
Jerry Yu7a485c12022-10-31 13:08:18 +0800505
506 case MBEDTLS_TLS_EXT_MAX_FRAGMENT_LENGTH:
Gilles Peskine449bd832023-01-11 14:50:10 +0100507 return MBEDTLS_SSL_EXT_ID_MAX_FRAGMENT_LENGTH;
Jerry Yu7a485c12022-10-31 13:08:18 +0800508
509 case MBEDTLS_TLS_EXT_STATUS_REQUEST:
Gilles Peskine449bd832023-01-11 14:50:10 +0100510 return MBEDTLS_SSL_EXT_ID_STATUS_REQUEST;
Jerry Yu7a485c12022-10-31 13:08:18 +0800511
512 case MBEDTLS_TLS_EXT_SUPPORTED_GROUPS:
Gilles Peskine449bd832023-01-11 14:50:10 +0100513 return MBEDTLS_SSL_EXT_ID_SUPPORTED_GROUPS;
Jerry Yu7a485c12022-10-31 13:08:18 +0800514
515 case MBEDTLS_TLS_EXT_SIG_ALG:
Gilles Peskine449bd832023-01-11 14:50:10 +0100516 return MBEDTLS_SSL_EXT_ID_SIG_ALG;
Jerry Yu7a485c12022-10-31 13:08:18 +0800517
518 case MBEDTLS_TLS_EXT_USE_SRTP:
Gilles Peskine449bd832023-01-11 14:50:10 +0100519 return MBEDTLS_SSL_EXT_ID_USE_SRTP;
Jerry Yu7a485c12022-10-31 13:08:18 +0800520
521 case MBEDTLS_TLS_EXT_HEARTBEAT:
Gilles Peskine449bd832023-01-11 14:50:10 +0100522 return MBEDTLS_SSL_EXT_ID_HEARTBEAT;
Jerry Yu7a485c12022-10-31 13:08:18 +0800523
524 case MBEDTLS_TLS_EXT_ALPN:
Gilles Peskine449bd832023-01-11 14:50:10 +0100525 return MBEDTLS_SSL_EXT_ID_ALPN;
Jerry Yu7a485c12022-10-31 13:08:18 +0800526
527 case MBEDTLS_TLS_EXT_SCT:
Gilles Peskine449bd832023-01-11 14:50:10 +0100528 return MBEDTLS_SSL_EXT_ID_SCT;
Jerry Yu7a485c12022-10-31 13:08:18 +0800529
530 case MBEDTLS_TLS_EXT_CLI_CERT_TYPE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100531 return MBEDTLS_SSL_EXT_ID_CLI_CERT_TYPE;
Jerry Yu7a485c12022-10-31 13:08:18 +0800532
533 case MBEDTLS_TLS_EXT_SERV_CERT_TYPE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100534 return MBEDTLS_SSL_EXT_ID_SERV_CERT_TYPE;
Jerry Yu7a485c12022-10-31 13:08:18 +0800535
536 case MBEDTLS_TLS_EXT_PADDING:
Gilles Peskine449bd832023-01-11 14:50:10 +0100537 return MBEDTLS_SSL_EXT_ID_PADDING;
Jerry Yu7a485c12022-10-31 13:08:18 +0800538
539 case MBEDTLS_TLS_EXT_PRE_SHARED_KEY:
Gilles Peskine449bd832023-01-11 14:50:10 +0100540 return MBEDTLS_SSL_EXT_ID_PRE_SHARED_KEY;
Jerry Yu7a485c12022-10-31 13:08:18 +0800541
542 case MBEDTLS_TLS_EXT_EARLY_DATA:
Gilles Peskine449bd832023-01-11 14:50:10 +0100543 return MBEDTLS_SSL_EXT_ID_EARLY_DATA;
Jerry Yu7a485c12022-10-31 13:08:18 +0800544
545 case MBEDTLS_TLS_EXT_SUPPORTED_VERSIONS:
Gilles Peskine449bd832023-01-11 14:50:10 +0100546 return MBEDTLS_SSL_EXT_ID_SUPPORTED_VERSIONS;
Jerry Yu7a485c12022-10-31 13:08:18 +0800547
548 case MBEDTLS_TLS_EXT_COOKIE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100549 return MBEDTLS_SSL_EXT_ID_COOKIE;
Jerry Yu7a485c12022-10-31 13:08:18 +0800550
551 case MBEDTLS_TLS_EXT_PSK_KEY_EXCHANGE_MODES:
Gilles Peskine449bd832023-01-11 14:50:10 +0100552 return MBEDTLS_SSL_EXT_ID_PSK_KEY_EXCHANGE_MODES;
Jerry Yu7a485c12022-10-31 13:08:18 +0800553
554 case MBEDTLS_TLS_EXT_CERT_AUTH:
Gilles Peskine449bd832023-01-11 14:50:10 +0100555 return MBEDTLS_SSL_EXT_ID_CERT_AUTH;
Jerry Yu7a485c12022-10-31 13:08:18 +0800556
557 case MBEDTLS_TLS_EXT_OID_FILTERS:
Gilles Peskine449bd832023-01-11 14:50:10 +0100558 return MBEDTLS_SSL_EXT_ID_OID_FILTERS;
Jerry Yu7a485c12022-10-31 13:08:18 +0800559
560 case MBEDTLS_TLS_EXT_POST_HANDSHAKE_AUTH:
Gilles Peskine449bd832023-01-11 14:50:10 +0100561 return MBEDTLS_SSL_EXT_ID_POST_HANDSHAKE_AUTH;
Jerry Yu7a485c12022-10-31 13:08:18 +0800562
563 case MBEDTLS_TLS_EXT_SIG_ALG_CERT:
Gilles Peskine449bd832023-01-11 14:50:10 +0100564 return MBEDTLS_SSL_EXT_ID_SIG_ALG_CERT;
Jerry Yu7a485c12022-10-31 13:08:18 +0800565
566 case MBEDTLS_TLS_EXT_KEY_SHARE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100567 return MBEDTLS_SSL_EXT_ID_KEY_SHARE;
Jerry Yu7a485c12022-10-31 13:08:18 +0800568
569 case MBEDTLS_TLS_EXT_TRUNCATED_HMAC:
Gilles Peskine449bd832023-01-11 14:50:10 +0100570 return MBEDTLS_SSL_EXT_ID_TRUNCATED_HMAC;
Jerry Yu7a485c12022-10-31 13:08:18 +0800571
572 case MBEDTLS_TLS_EXT_SUPPORTED_POINT_FORMATS:
Gilles Peskine449bd832023-01-11 14:50:10 +0100573 return MBEDTLS_SSL_EXT_ID_SUPPORTED_POINT_FORMATS;
Jerry Yu7a485c12022-10-31 13:08:18 +0800574
575 case MBEDTLS_TLS_EXT_ENCRYPT_THEN_MAC:
Gilles Peskine449bd832023-01-11 14:50:10 +0100576 return MBEDTLS_SSL_EXT_ID_ENCRYPT_THEN_MAC;
Jerry Yu7a485c12022-10-31 13:08:18 +0800577
578 case MBEDTLS_TLS_EXT_EXTENDED_MASTER_SECRET:
Gilles Peskine449bd832023-01-11 14:50:10 +0100579 return MBEDTLS_SSL_EXT_ID_EXTENDED_MASTER_SECRET;
Jerry Yu7a485c12022-10-31 13:08:18 +0800580
Jan Bruckner151f6422023-02-10 12:45:19 +0100581 case MBEDTLS_TLS_EXT_RECORD_SIZE_LIMIT:
582 return MBEDTLS_SSL_EXT_ID_RECORD_SIZE_LIMIT;
583
Jerry Yu7a485c12022-10-31 13:08:18 +0800584 case MBEDTLS_TLS_EXT_SESSION_TICKET:
Gilles Peskine449bd832023-01-11 14:50:10 +0100585 return MBEDTLS_SSL_EXT_ID_SESSION_TICKET;
Jerry Yu7a485c12022-10-31 13:08:18 +0800586
587 }
588
Gilles Peskine449bd832023-01-11 14:50:10 +0100589 return MBEDTLS_SSL_EXT_ID_UNRECOGNIZED;
Jerry Yu7a485c12022-10-31 13:08:18 +0800590}
591
Gilles Peskine449bd832023-01-11 14:50:10 +0100592uint32_t mbedtls_ssl_get_extension_mask(unsigned int extension_type)
Jerry Yu7a485c12022-10-31 13:08:18 +0800593{
Gilles Peskine449bd832023-01-11 14:50:10 +0100594 return 1 << mbedtls_ssl_get_extension_id(extension_type);
Jerry Yu7a485c12022-10-31 13:08:18 +0800595}
596
Jerry Yud25cab02022-10-31 12:48:30 +0800597#if defined(MBEDTLS_DEBUG_C)
598static const char *extension_name_table[] = {
Jerry Yuea52ed92022-11-08 21:01:17 +0800599 [MBEDTLS_SSL_EXT_ID_UNRECOGNIZED] = "unrecognized",
Jerry Yud25cab02022-10-31 12:48:30 +0800600 [MBEDTLS_SSL_EXT_ID_SERVERNAME] = "server_name",
601 [MBEDTLS_SSL_EXT_ID_MAX_FRAGMENT_LENGTH] = "max_fragment_length",
602 [MBEDTLS_SSL_EXT_ID_STATUS_REQUEST] = "status_request",
603 [MBEDTLS_SSL_EXT_ID_SUPPORTED_GROUPS] = "supported_groups",
604 [MBEDTLS_SSL_EXT_ID_SIG_ALG] = "signature_algorithms",
605 [MBEDTLS_SSL_EXT_ID_USE_SRTP] = "use_srtp",
606 [MBEDTLS_SSL_EXT_ID_HEARTBEAT] = "heartbeat",
607 [MBEDTLS_SSL_EXT_ID_ALPN] = "application_layer_protocol_negotiation",
608 [MBEDTLS_SSL_EXT_ID_SCT] = "signed_certificate_timestamp",
609 [MBEDTLS_SSL_EXT_ID_CLI_CERT_TYPE] = "client_certificate_type",
610 [MBEDTLS_SSL_EXT_ID_SERV_CERT_TYPE] = "server_certificate_type",
611 [MBEDTLS_SSL_EXT_ID_PADDING] = "padding",
612 [MBEDTLS_SSL_EXT_ID_PRE_SHARED_KEY] = "pre_shared_key",
613 [MBEDTLS_SSL_EXT_ID_EARLY_DATA] = "early_data",
614 [MBEDTLS_SSL_EXT_ID_SUPPORTED_VERSIONS] = "supported_versions",
615 [MBEDTLS_SSL_EXT_ID_COOKIE] = "cookie",
616 [MBEDTLS_SSL_EXT_ID_PSK_KEY_EXCHANGE_MODES] = "psk_key_exchange_modes",
617 [MBEDTLS_SSL_EXT_ID_CERT_AUTH] = "certificate_authorities",
618 [MBEDTLS_SSL_EXT_ID_OID_FILTERS] = "oid_filters",
619 [MBEDTLS_SSL_EXT_ID_POST_HANDSHAKE_AUTH] = "post_handshake_auth",
620 [MBEDTLS_SSL_EXT_ID_SIG_ALG_CERT] = "signature_algorithms_cert",
621 [MBEDTLS_SSL_EXT_ID_KEY_SHARE] = "key_share",
622 [MBEDTLS_SSL_EXT_ID_TRUNCATED_HMAC] = "truncated_hmac",
623 [MBEDTLS_SSL_EXT_ID_SUPPORTED_POINT_FORMATS] = "supported_point_formats",
624 [MBEDTLS_SSL_EXT_ID_ENCRYPT_THEN_MAC] = "encrypt_then_mac",
625 [MBEDTLS_SSL_EXT_ID_EXTENDED_MASTER_SECRET] = "extended_master_secret",
Jan Bruckner151f6422023-02-10 12:45:19 +0100626 [MBEDTLS_SSL_EXT_ID_SESSION_TICKET] = "session_ticket",
627 [MBEDTLS_SSL_EXT_ID_RECORD_SIZE_LIMIT] = "record_size_limit"
Jerry Yud25cab02022-10-31 12:48:30 +0800628};
629
Chien Wong4e9683e2023-12-28 17:07:43 +0800630static const unsigned int extension_type_table[] = {
Jerry Yud25cab02022-10-31 12:48:30 +0800631 [MBEDTLS_SSL_EXT_ID_UNRECOGNIZED] = 0xff,
632 [MBEDTLS_SSL_EXT_ID_SERVERNAME] = MBEDTLS_TLS_EXT_SERVERNAME,
633 [MBEDTLS_SSL_EXT_ID_MAX_FRAGMENT_LENGTH] = MBEDTLS_TLS_EXT_MAX_FRAGMENT_LENGTH,
634 [MBEDTLS_SSL_EXT_ID_STATUS_REQUEST] = MBEDTLS_TLS_EXT_STATUS_REQUEST,
635 [MBEDTLS_SSL_EXT_ID_SUPPORTED_GROUPS] = MBEDTLS_TLS_EXT_SUPPORTED_GROUPS,
636 [MBEDTLS_SSL_EXT_ID_SIG_ALG] = MBEDTLS_TLS_EXT_SIG_ALG,
637 [MBEDTLS_SSL_EXT_ID_USE_SRTP] = MBEDTLS_TLS_EXT_USE_SRTP,
638 [MBEDTLS_SSL_EXT_ID_HEARTBEAT] = MBEDTLS_TLS_EXT_HEARTBEAT,
639 [MBEDTLS_SSL_EXT_ID_ALPN] = MBEDTLS_TLS_EXT_ALPN,
640 [MBEDTLS_SSL_EXT_ID_SCT] = MBEDTLS_TLS_EXT_SCT,
641 [MBEDTLS_SSL_EXT_ID_CLI_CERT_TYPE] = MBEDTLS_TLS_EXT_CLI_CERT_TYPE,
642 [MBEDTLS_SSL_EXT_ID_SERV_CERT_TYPE] = MBEDTLS_TLS_EXT_SERV_CERT_TYPE,
643 [MBEDTLS_SSL_EXT_ID_PADDING] = MBEDTLS_TLS_EXT_PADDING,
644 [MBEDTLS_SSL_EXT_ID_PRE_SHARED_KEY] = MBEDTLS_TLS_EXT_PRE_SHARED_KEY,
645 [MBEDTLS_SSL_EXT_ID_EARLY_DATA] = MBEDTLS_TLS_EXT_EARLY_DATA,
646 [MBEDTLS_SSL_EXT_ID_SUPPORTED_VERSIONS] = MBEDTLS_TLS_EXT_SUPPORTED_VERSIONS,
647 [MBEDTLS_SSL_EXT_ID_COOKIE] = MBEDTLS_TLS_EXT_COOKIE,
648 [MBEDTLS_SSL_EXT_ID_PSK_KEY_EXCHANGE_MODES] = MBEDTLS_TLS_EXT_PSK_KEY_EXCHANGE_MODES,
649 [MBEDTLS_SSL_EXT_ID_CERT_AUTH] = MBEDTLS_TLS_EXT_CERT_AUTH,
650 [MBEDTLS_SSL_EXT_ID_OID_FILTERS] = MBEDTLS_TLS_EXT_OID_FILTERS,
651 [MBEDTLS_SSL_EXT_ID_POST_HANDSHAKE_AUTH] = MBEDTLS_TLS_EXT_POST_HANDSHAKE_AUTH,
652 [MBEDTLS_SSL_EXT_ID_SIG_ALG_CERT] = MBEDTLS_TLS_EXT_SIG_ALG_CERT,
653 [MBEDTLS_SSL_EXT_ID_KEY_SHARE] = MBEDTLS_TLS_EXT_KEY_SHARE,
654 [MBEDTLS_SSL_EXT_ID_TRUNCATED_HMAC] = MBEDTLS_TLS_EXT_TRUNCATED_HMAC,
655 [MBEDTLS_SSL_EXT_ID_SUPPORTED_POINT_FORMATS] = MBEDTLS_TLS_EXT_SUPPORTED_POINT_FORMATS,
656 [MBEDTLS_SSL_EXT_ID_ENCRYPT_THEN_MAC] = MBEDTLS_TLS_EXT_ENCRYPT_THEN_MAC,
657 [MBEDTLS_SSL_EXT_ID_EXTENDED_MASTER_SECRET] = MBEDTLS_TLS_EXT_EXTENDED_MASTER_SECRET,
Jan Bruckner151f6422023-02-10 12:45:19 +0100658 [MBEDTLS_SSL_EXT_ID_SESSION_TICKET] = MBEDTLS_TLS_EXT_SESSION_TICKET,
659 [MBEDTLS_SSL_EXT_ID_RECORD_SIZE_LIMIT] = MBEDTLS_TLS_EXT_RECORD_SIZE_LIMIT
Jerry Yud25cab02022-10-31 12:48:30 +0800660};
661
Gilles Peskine449bd832023-01-11 14:50:10 +0100662const char *mbedtls_ssl_get_extension_name(unsigned int extension_type)
Jerry Yud25cab02022-10-31 12:48:30 +0800663{
Gilles Peskine449bd832023-01-11 14:50:10 +0100664 return extension_name_table[
665 mbedtls_ssl_get_extension_id(extension_type)];
Jerry Yud25cab02022-10-31 12:48:30 +0800666}
667
Gilles Peskine449bd832023-01-11 14:50:10 +0100668static const char *ssl_tls13_get_hs_msg_name(int hs_msg_type)
Jerry Yud25cab02022-10-31 12:48:30 +0800669{
Gilles Peskine449bd832023-01-11 14:50:10 +0100670 switch (hs_msg_type) {
Jerry Yud25cab02022-10-31 12:48:30 +0800671 case MBEDTLS_SSL_HS_CLIENT_HELLO:
Gilles Peskine449bd832023-01-11 14:50:10 +0100672 return "ClientHello";
Jerry Yud25cab02022-10-31 12:48:30 +0800673 case MBEDTLS_SSL_HS_SERVER_HELLO:
Gilles Peskine449bd832023-01-11 14:50:10 +0100674 return "ServerHello";
Jerry Yud25cab02022-10-31 12:48:30 +0800675 case MBEDTLS_SSL_TLS1_3_HS_HELLO_RETRY_REQUEST:
Gilles Peskine449bd832023-01-11 14:50:10 +0100676 return "HelloRetryRequest";
Jerry Yud25cab02022-10-31 12:48:30 +0800677 case MBEDTLS_SSL_HS_NEW_SESSION_TICKET:
Gilles Peskine449bd832023-01-11 14:50:10 +0100678 return "NewSessionTicket";
Jerry Yud25cab02022-10-31 12:48:30 +0800679 case MBEDTLS_SSL_HS_ENCRYPTED_EXTENSIONS:
Gilles Peskine449bd832023-01-11 14:50:10 +0100680 return "EncryptedExtensions";
Jerry Yud25cab02022-10-31 12:48:30 +0800681 case MBEDTLS_SSL_HS_CERTIFICATE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100682 return "Certificate";
Jerry Yud25cab02022-10-31 12:48:30 +0800683 case MBEDTLS_SSL_HS_CERTIFICATE_REQUEST:
Gilles Peskine449bd832023-01-11 14:50:10 +0100684 return "CertificateRequest";
Jerry Yud25cab02022-10-31 12:48:30 +0800685 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100686 return "Unknown";
Jerry Yud25cab02022-10-31 12:48:30 +0800687}
688
Gilles Peskine449bd832023-01-11 14:50:10 +0100689void mbedtls_ssl_print_extension(const mbedtls_ssl_context *ssl,
690 int level, const char *file, int line,
691 int hs_msg_type, unsigned int extension_type,
692 const char *extra_msg0, const char *extra_msg1)
Jerry Yud25cab02022-10-31 12:48:30 +0800693{
694 const char *extra_msg;
Gilles Peskine449bd832023-01-11 14:50:10 +0100695 if (extra_msg0 && extra_msg1) {
Jerry Yud25cab02022-10-31 12:48:30 +0800696 mbedtls_debug_print_msg(
697 ssl, level, file, line,
698 "%s: %s(%u) extension %s %s.",
Gilles Peskine449bd832023-01-11 14:50:10 +0100699 ssl_tls13_get_hs_msg_name(hs_msg_type),
700 mbedtls_ssl_get_extension_name(extension_type),
Jerry Yud25cab02022-10-31 12:48:30 +0800701 extension_type,
Gilles Peskine449bd832023-01-11 14:50:10 +0100702 extra_msg0, extra_msg1);
Jerry Yud25cab02022-10-31 12:48:30 +0800703 return;
704 }
705
706 extra_msg = extra_msg0 ? extra_msg0 : extra_msg1;
Gilles Peskine449bd832023-01-11 14:50:10 +0100707 if (extra_msg) {
Jerry Yud25cab02022-10-31 12:48:30 +0800708 mbedtls_debug_print_msg(
709 ssl, level, file, line,
Gilles Peskine449bd832023-01-11 14:50:10 +0100710 "%s: %s(%u) extension %s.", ssl_tls13_get_hs_msg_name(hs_msg_type),
711 mbedtls_ssl_get_extension_name(extension_type), extension_type,
712 extra_msg);
Jerry Yud25cab02022-10-31 12:48:30 +0800713 return;
714 }
715
716 mbedtls_debug_print_msg(
717 ssl, level, file, line,
Gilles Peskine449bd832023-01-11 14:50:10 +0100718 "%s: %s(%u) extension.", ssl_tls13_get_hs_msg_name(hs_msg_type),
719 mbedtls_ssl_get_extension_name(extension_type), extension_type);
Jerry Yud25cab02022-10-31 12:48:30 +0800720}
721
Gilles Peskine449bd832023-01-11 14:50:10 +0100722void mbedtls_ssl_print_extensions(const mbedtls_ssl_context *ssl,
723 int level, const char *file, int line,
724 int hs_msg_type, uint32_t extensions_mask,
725 const char *extra)
Jerry Yud25cab02022-10-31 12:48:30 +0800726{
727
Gilles Peskine449bd832023-01-11 14:50:10 +0100728 for (unsigned i = 0;
729 i < sizeof(extension_name_table) / sizeof(extension_name_table[0]);
730 i++) {
Jerry Yu79aa7212022-11-08 21:30:21 +0800731 mbedtls_ssl_print_extension(
Jerry Yuea52ed92022-11-08 21:01:17 +0800732 ssl, level, file, line, hs_msg_type, extension_type_table[i],
Gilles Peskine449bd832023-01-11 14:50:10 +0100733 extensions_mask & (1 << i) ? "exists" : "does not exist", extra);
Jerry Yud25cab02022-10-31 12:48:30 +0800734 }
735}
736
Pengyu Lvee455c02023-01-12 14:37:24 +0800737#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Pengyu Lvee455c02023-01-12 14:37:24 +0800738static const char *ticket_flag_name_table[] =
739{
740 [0] = "ALLOW_PSK_RESUMPTION",
741 [2] = "ALLOW_PSK_EPHEMERAL_RESUMPTION",
742 [3] = "ALLOW_EARLY_DATA",
743};
744
Pengyu Lv4938a562023-01-16 11:28:49 +0800745void mbedtls_ssl_print_ticket_flags(const mbedtls_ssl_context *ssl,
746 int level, const char *file, int line,
747 unsigned int flags)
Pengyu Lvee455c02023-01-12 14:37:24 +0800748{
749 size_t i;
750
751 mbedtls_debug_print_msg(ssl, level, file, line,
Pengyu Lv4938a562023-01-16 11:28:49 +0800752 "print ticket_flags (0x%02x)", flags);
753
754 flags = flags & MBEDTLS_SSL_TLS1_3_TICKET_FLAGS_MASK;
Pengyu Lvee455c02023-01-12 14:37:24 +0800755
756 for (i = 0; i < ARRAY_LENGTH(ticket_flag_name_table); i++) {
Pengyu Lv4938a562023-01-16 11:28:49 +0800757 if ((flags & (1 << i))) {
Pengyu Lvee455c02023-01-12 14:37:24 +0800758 mbedtls_debug_print_msg(ssl, level, file, line, "- %s is set.",
759 ticket_flag_name_table[i]);
760 }
761 }
762}
763#endif /* MBEDTLS_SSL_PROTO_TLS1_3 && MBEDTLS_SSL_SESSION_TICKETS */
764
Jerry Yud25cab02022-10-31 12:48:30 +0800765#endif /* MBEDTLS_DEBUG_C */
766
Gilles Peskine449bd832023-01-11 14:50:10 +0100767void mbedtls_ssl_optimize_checksum(mbedtls_ssl_context *ssl,
768 const mbedtls_ssl_ciphersuite_t *ciphersuite_info)
Jerry Yuc73c6182022-02-08 20:29:25 +0800769{
770 ((void) ciphersuite_info);
771
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100772#if defined(MBEDTLS_MD_CAN_SHA384)
Gilles Peskine449bd832023-01-11 14:50:10 +0100773 if (ciphersuite_info->mac == MBEDTLS_MD_SHA384) {
Jerry Yuc73c6182022-02-08 20:29:25 +0800774 ssl->handshake->update_checksum = ssl_update_checksum_sha384;
Gilles Peskine449bd832023-01-11 14:50:10 +0100775 } else
Jerry Yuc73c6182022-02-08 20:29:25 +0800776#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100777#if defined(MBEDTLS_MD_CAN_SHA256)
Gilles Peskine449bd832023-01-11 14:50:10 +0100778 if (ciphersuite_info->mac != MBEDTLS_MD_SHA384) {
Jerry Yuc73c6182022-02-08 20:29:25 +0800779 ssl->handshake->update_checksum = ssl_update_checksum_sha256;
Gilles Peskine449bd832023-01-11 14:50:10 +0100780 } else
Jerry Yuc73c6182022-02-08 20:29:25 +0800781#endif
782 {
Gilles Peskine449bd832023-01-11 14:50:10 +0100783 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
Jerry Yuc73c6182022-02-08 20:29:25 +0800784 return;
785 }
786}
787
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100788int mbedtls_ssl_add_hs_hdr_to_checksum(mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100789 unsigned hs_type,
790 size_t total_hs_len)
Ronald Cron8f6d39a2022-03-10 18:56:50 +0100791{
792 unsigned char hs_hdr[4];
793
794 /* Build HS header for checksum update. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100795 hs_hdr[0] = MBEDTLS_BYTE_0(hs_type);
796 hs_hdr[1] = MBEDTLS_BYTE_2(total_hs_len);
797 hs_hdr[2] = MBEDTLS_BYTE_1(total_hs_len);
798 hs_hdr[3] = MBEDTLS_BYTE_0(total_hs_len);
Ronald Cron8f6d39a2022-03-10 18:56:50 +0100799
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100800 return ssl->handshake->update_checksum(ssl, hs_hdr, sizeof(hs_hdr));
Ronald Cron8f6d39a2022-03-10 18:56:50 +0100801}
802
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100803int mbedtls_ssl_add_hs_msg_to_checksum(mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100804 unsigned hs_type,
805 unsigned char const *msg,
806 size_t msg_len)
Ronald Cron8f6d39a2022-03-10 18:56:50 +0100807{
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100808 int ret;
809 ret = mbedtls_ssl_add_hs_hdr_to_checksum(ssl, hs_type, msg_len);
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100810 if (ret != 0) {
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100811 return ret;
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100812 }
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100813 return ssl->handshake->update_checksum(ssl, msg, msg_len);
Ronald Cron8f6d39a2022-03-10 18:56:50 +0100814}
815
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100816int mbedtls_ssl_reset_checksum(mbedtls_ssl_context *ssl)
Jerry Yuc73c6182022-02-08 20:29:25 +0800817{
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100818#if defined(MBEDTLS_MD_CAN_SHA256) || \
819 defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100820#if defined(MBEDTLS_USE_PSA_CRYPTO)
821 psa_status_t status;
822#else
823 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
824#endif
Manuel Pégourié-Gonnard626aaed2023-02-06 22:03:06 +0100825#else /* SHA-256 or SHA-384 */
Jerry Yuc73c6182022-02-08 20:29:25 +0800826 ((void) ssl);
Manuel Pégourié-Gonnard626aaed2023-02-06 22:03:06 +0100827#endif /* SHA-256 or SHA-384 */
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100828#if defined(MBEDTLS_MD_CAN_SHA256)
Jerry Yuc73c6182022-02-08 20:29:25 +0800829#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100830 status = psa_hash_abort(&ssl->handshake->fin_sha256_psa);
831 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200832 return mbedtls_md_error_from_psa(status);
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100833 }
834 status = psa_hash_setup(&ssl->handshake->fin_sha256_psa, PSA_ALG_SHA_256);
835 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200836 return mbedtls_md_error_from_psa(status);
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100837 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800838#else
Manuel Pégourié-Gonnard947cee12023-03-06 11:59:59 +0100839 mbedtls_md_free(&ssl->handshake->fin_sha256);
840 mbedtls_md_init(&ssl->handshake->fin_sha256);
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +0100841 ret = mbedtls_md_setup(&ssl->handshake->fin_sha256,
842 mbedtls_md_info_from_type(MBEDTLS_MD_SHA256),
843 0);
844 if (ret != 0) {
845 return ret;
846 }
847 ret = mbedtls_md_starts(&ssl->handshake->fin_sha256);
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100848 if (ret != 0) {
849 return ret;
850 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800851#endif
852#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100853#if defined(MBEDTLS_MD_CAN_SHA384)
Jerry Yuc73c6182022-02-08 20:29:25 +0800854#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100855 status = psa_hash_abort(&ssl->handshake->fin_sha384_psa);
856 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200857 return mbedtls_md_error_from_psa(status);
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100858 }
859 status = psa_hash_setup(&ssl->handshake->fin_sha384_psa, PSA_ALG_SHA_384);
860 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200861 return mbedtls_md_error_from_psa(status);
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100862 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800863#else
Manuel Pégourié-Gonnard947cee12023-03-06 11:59:59 +0100864 mbedtls_md_free(&ssl->handshake->fin_sha384);
865 mbedtls_md_init(&ssl->handshake->fin_sha384);
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +0100866 ret = mbedtls_md_setup(&ssl->handshake->fin_sha384,
867 mbedtls_md_info_from_type(MBEDTLS_MD_SHA384), 0);
868 if (ret != 0) {
869 return ret;
870 }
871 ret = mbedtls_md_starts(&ssl->handshake->fin_sha384);
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100872 if (ret != 0) {
873 return ret;
874 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800875#endif
876#endif
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100877 return 0;
Jerry Yuc73c6182022-02-08 20:29:25 +0800878}
879
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100880static int ssl_update_checksum_start(mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100881 const unsigned char *buf, size_t len)
Jerry Yuc73c6182022-02-08 20:29:25 +0800882{
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100883#if defined(MBEDTLS_MD_CAN_SHA256) || \
884 defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnarddf949012023-02-06 10:00:52 +0100885#if defined(MBEDTLS_USE_PSA_CRYPTO)
886 psa_status_t status;
887#else
888 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
889#endif
Manuel Pégourié-Gonnard626aaed2023-02-06 22:03:06 +0100890#else /* SHA-256 or SHA-384 */
891 ((void) ssl);
892 (void) buf;
893 (void) len;
894#endif /* SHA-256 or SHA-384 */
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100895#if defined(MBEDTLS_MD_CAN_SHA256)
Jerry Yuc73c6182022-02-08 20:29:25 +0800896#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnarddf949012023-02-06 10:00:52 +0100897 status = psa_hash_update(&ssl->handshake->fin_sha256_psa, buf, len);
898 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200899 return mbedtls_md_error_from_psa(status);
Manuel Pégourié-Gonnarddf949012023-02-06 10:00:52 +0100900 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800901#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +0100902 ret = mbedtls_md_update(&ssl->handshake->fin_sha256, buf, len);
Manuel Pégourié-Gonnarddf949012023-02-06 10:00:52 +0100903 if (ret != 0) {
904 return ret;
905 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800906#endif
907#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100908#if defined(MBEDTLS_MD_CAN_SHA384)
Jerry Yuc73c6182022-02-08 20:29:25 +0800909#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnarddf949012023-02-06 10:00:52 +0100910 status = psa_hash_update(&ssl->handshake->fin_sha384_psa, buf, len);
911 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200912 return mbedtls_md_error_from_psa(status);
Manuel Pégourié-Gonnarddf949012023-02-06 10:00:52 +0100913 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800914#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +0100915 ret = mbedtls_md_update(&ssl->handshake->fin_sha384, buf, len);
Manuel Pégourié-Gonnarddf949012023-02-06 10:00:52 +0100916 if (ret != 0) {
917 return ret;
918 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800919#endif
920#endif
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100921 return 0;
Jerry Yuc73c6182022-02-08 20:29:25 +0800922}
923
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100924#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100925static int ssl_update_checksum_sha256(mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100926 const unsigned char *buf, size_t len)
Jerry Yuc73c6182022-02-08 20:29:25 +0800927{
928#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200929 return mbedtls_md_error_from_psa(psa_hash_update(
930 &ssl->handshake->fin_sha256_psa, buf, len));
Jerry Yuc73c6182022-02-08 20:29:25 +0800931#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +0100932 return mbedtls_md_update(&ssl->handshake->fin_sha256, buf, len);
Jerry Yuc73c6182022-02-08 20:29:25 +0800933#endif
934}
935#endif
936
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100937#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100938static int ssl_update_checksum_sha384(mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100939 const unsigned char *buf, size_t len)
Jerry Yuc73c6182022-02-08 20:29:25 +0800940{
941#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200942 return mbedtls_md_error_from_psa(psa_hash_update(
943 &ssl->handshake->fin_sha384_psa, buf, len));
Jerry Yuc73c6182022-02-08 20:29:25 +0800944#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +0100945 return mbedtls_md_update(&ssl->handshake->fin_sha384, buf, len);
Jerry Yuc73c6182022-02-08 20:29:25 +0800946#endif
947}
948#endif
949
Gilles Peskine449bd832023-01-11 14:50:10 +0100950static void ssl_handshake_params_init(mbedtls_ssl_handshake_params *handshake)
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200951{
Gilles Peskine449bd832023-01-11 14:50:10 +0100952 memset(handshake, 0, sizeof(mbedtls_ssl_handshake_params));
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200953
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100954#if defined(MBEDTLS_MD_CAN_SHA256)
Andrzej Kurekeb342242019-01-29 09:14:33 -0500955#if defined(MBEDTLS_USE_PSA_CRYPTO)
956 handshake->fin_sha256_psa = psa_hash_operation_init();
Andrzej Kurekeb342242019-01-29 09:14:33 -0500957#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +0100958 mbedtls_md_init(&handshake->fin_sha256);
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200959#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -0500960#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100961#if defined(MBEDTLS_MD_CAN_SHA384)
Andrzej Kurekeb342242019-01-29 09:14:33 -0500962#if defined(MBEDTLS_USE_PSA_CRYPTO)
Andrzej Kurek972fba52019-01-30 03:29:12 -0500963 handshake->fin_sha384_psa = psa_hash_operation_init();
Andrzej Kurekeb342242019-01-29 09:14:33 -0500964#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +0100965 mbedtls_md_init(&handshake->fin_sha384);
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200966#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -0500967#endif
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200968
969 handshake->update_checksum = ssl_update_checksum_start;
Hanno Becker7e5437a2017-04-28 17:15:26 +0100970
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200971#if defined(MBEDTLS_DHM_C)
Gilles Peskine449bd832023-01-11 14:50:10 +0100972 mbedtls_dhm_init(&handshake->dhm_ctx);
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200973#endif
Valerio Setti7aeec542023-07-05 18:57:21 +0200974#if !defined(MBEDTLS_USE_PSA_CRYPTO) && \
Valerio Setti6eb00542023-07-07 17:04:24 +0200975 defined(MBEDTLS_KEY_EXCHANGE_SOME_ECDH_OR_ECDHE_1_2_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +0100976 mbedtls_ecdh_init(&handshake->ecdh_ctx);
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200977#endif
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +0200978#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Neil Armstrongca7d5062022-05-31 14:43:23 +0200979#if defined(MBEDTLS_USE_PSA_CRYPTO)
980 handshake->psa_pake_ctx = psa_pake_operation_init();
981 handshake->psa_pake_password = MBEDTLS_SVC_KEY_ID_INIT;
982#else
Gilles Peskine449bd832023-01-11 14:50:10 +0100983 mbedtls_ecjpake_init(&handshake->ecjpake_ctx);
Neil Armstrongca7d5062022-05-31 14:43:23 +0200984#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard77c06462015-09-17 13:59:49 +0200985#if defined(MBEDTLS_SSL_CLI_C)
986 handshake->ecjpake_cache = NULL;
987 handshake->ecjpake_cache_len = 0;
988#endif
Manuel Pégourié-Gonnard76cfd3f2015-09-15 12:10:54 +0200989#endif
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +0200990
Gilles Peskineeccd8882020-03-10 12:19:08 +0100991#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +0100992 mbedtls_x509_crt_restart_init(&handshake->ecrs_ctx);
Manuel Pégourié-Gonnard862cde52017-05-17 11:56:15 +0200993#endif
994
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +0200995#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
996 handshake->sni_authmode = MBEDTLS_SSL_VERIFY_UNSET;
997#endif
Hanno Becker75173122019-02-06 16:18:31 +0000998
999#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
1000 !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01001001 mbedtls_pk_init(&handshake->peer_pubkey);
Hanno Becker75173122019-02-06 16:18:31 +00001002#endif
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001003}
1004
Gilles Peskine449bd832023-01-11 14:50:10 +01001005void mbedtls_ssl_transform_init(mbedtls_ssl_transform *transform)
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001006{
Gilles Peskine449bd832023-01-11 14:50:10 +01001007 memset(transform, 0, sizeof(mbedtls_ssl_transform));
Paul Bakker84bbeb52014-07-01 14:53:22 +02001008
Przemyslaw Stekiel8f80fb92022-01-11 08:28:13 +01001009#if defined(MBEDTLS_USE_PSA_CRYPTO)
1010 transform->psa_key_enc = MBEDTLS_SVC_KEY_ID_INIT;
1011 transform->psa_key_dec = MBEDTLS_SVC_KEY_ID_INIT;
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01001012#else
Gilles Peskine449bd832023-01-11 14:50:10 +01001013 mbedtls_cipher_init(&transform->cipher_ctx_enc);
1014 mbedtls_cipher_init(&transform->cipher_ctx_dec);
Przemyslaw Stekiel8f80fb92022-01-11 08:28:13 +01001015#endif
1016
Hanno Beckerfd86ca82020-11-30 08:54:23 +00001017#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Neil Armstrong39b8e7d2022-02-23 09:24:45 +01001018#if defined(MBEDTLS_USE_PSA_CRYPTO)
1019 transform->psa_mac_enc = MBEDTLS_SVC_KEY_ID_INIT;
1020 transform->psa_mac_dec = MBEDTLS_SVC_KEY_ID_INIT;
Neil Armstrongcf8841a2022-02-24 11:17:45 +01001021#else
Gilles Peskine449bd832023-01-11 14:50:10 +01001022 mbedtls_md_init(&transform->md_ctx_enc);
1023 mbedtls_md_init(&transform->md_ctx_dec);
Hanno Beckerd56ed242018-01-03 15:32:51 +00001024#endif
Neil Armstrongcf8841a2022-02-24 11:17:45 +01001025#endif
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001026}
1027
Gilles Peskine449bd832023-01-11 14:50:10 +01001028void mbedtls_ssl_session_init(mbedtls_ssl_session *session)
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001029{
Gilles Peskine449bd832023-01-11 14:50:10 +01001030 memset(session, 0, sizeof(mbedtls_ssl_session));
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001031}
1032
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001033MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001034static int ssl_handshake_init(mbedtls_ssl_context *ssl)
Paul Bakker48916f92012-09-16 19:57:18 +00001035{
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01001036 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1037
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001038 /* Clear old handshake information if present */
Jerry Yu2e199812022-12-01 18:57:19 +08001039#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01001040 if (ssl->transform_negotiate) {
1041 mbedtls_ssl_transform_free(ssl->transform_negotiate);
1042 }
Jerry Yu2e199812022-12-01 18:57:19 +08001043#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001044 if (ssl->session_negotiate) {
1045 mbedtls_ssl_session_free(ssl->session_negotiate);
1046 }
1047 if (ssl->handshake) {
1048 mbedtls_ssl_handshake_free(ssl);
1049 }
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001050
Jerry Yu2e199812022-12-01 18:57:19 +08001051#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001052 /*
1053 * Either the pointers are now NULL or cleared properly and can be freed.
1054 * Now allocate missing structures.
1055 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001056 if (ssl->transform_negotiate == NULL) {
1057 ssl->transform_negotiate = mbedtls_calloc(1, sizeof(mbedtls_ssl_transform));
Paul Bakkerb9cfaa02013-10-11 18:58:55 +02001058 }
Jerry Yu2e199812022-12-01 18:57:19 +08001059#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Paul Bakker48916f92012-09-16 19:57:18 +00001060
Gilles Peskine449bd832023-01-11 14:50:10 +01001061 if (ssl->session_negotiate == NULL) {
1062 ssl->session_negotiate = mbedtls_calloc(1, sizeof(mbedtls_ssl_session));
Paul Bakkerb9cfaa02013-10-11 18:58:55 +02001063 }
Paul Bakker48916f92012-09-16 19:57:18 +00001064
Gilles Peskine449bd832023-01-11 14:50:10 +01001065 if (ssl->handshake == NULL) {
1066 ssl->handshake = mbedtls_calloc(1, sizeof(mbedtls_ssl_handshake_params));
Paul Bakkerb9cfaa02013-10-11 18:58:55 +02001067 }
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05001068#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1069 /* If the buffers are too small - reallocate */
Andrzej Kurek8ea68722020-04-03 06:40:47 -04001070
Gilles Peskine449bd832023-01-11 14:50:10 +01001071 handle_buffer_resizing(ssl, 0, MBEDTLS_SSL_IN_BUFFER_LEN,
1072 MBEDTLS_SSL_OUT_BUFFER_LEN);
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05001073#endif
Paul Bakker48916f92012-09-16 19:57:18 +00001074
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001075 /* All pointers should exist and can be directly freed without issue */
Gilles Peskine449bd832023-01-11 14:50:10 +01001076 if (ssl->handshake == NULL ||
Jerry Yu2e199812022-12-01 18:57:19 +08001077#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Paul Bakker48916f92012-09-16 19:57:18 +00001078 ssl->transform_negotiate == NULL ||
Jerry Yu2e199812022-12-01 18:57:19 +08001079#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001080 ssl->session_negotiate == NULL) {
1081 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc() of ssl sub-contexts failed"));
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001082
Gilles Peskine449bd832023-01-11 14:50:10 +01001083 mbedtls_free(ssl->handshake);
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001084 ssl->handshake = NULL;
Jerry Yu2e199812022-12-01 18:57:19 +08001085
1086#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01001087 mbedtls_free(ssl->transform_negotiate);
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001088 ssl->transform_negotiate = NULL;
Jerry Yu2e199812022-12-01 18:57:19 +08001089#endif
1090
Gilles Peskine449bd832023-01-11 14:50:10 +01001091 mbedtls_free(ssl->session_negotiate);
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001092 ssl->session_negotiate = NULL;
1093
Gilles Peskine449bd832023-01-11 14:50:10 +01001094 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
Paul Bakker48916f92012-09-16 19:57:18 +00001095 }
1096
Jerry Yu4caf3ca2023-11-15 16:13:47 +08001097#if defined(MBEDTLS_SSL_EARLY_DATA)
1098#if defined(MBEDTLS_SSL_CLI_C)
Ronald Cron05d7cfb2024-03-03 15:39:30 +01001099 ssl->early_data_state = MBEDTLS_SSL_EARLY_DATA_STATE_IDLE;
Ronald Cron5d0ae902024-01-05 14:20:35 +01001100#endif
Jerry Yu4caf3ca2023-11-15 16:13:47 +08001101#if defined(MBEDTLS_SSL_SRV_C)
1102 ssl->discard_early_data_record = MBEDTLS_SSL_EARLY_DATA_NO_DISCARD;
1103#endif
Ronald Cron19bfe0a2024-02-26 16:43:01 +01001104 ssl->total_early_data_size = 0;
Jerry Yu4caf3ca2023-11-15 16:13:47 +08001105#endif /* MBEDTLS_SSL_EARLY_DATA */
Ronald Cron5d0ae902024-01-05 14:20:35 +01001106
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001107 /* Initialize structures */
Gilles Peskine449bd832023-01-11 14:50:10 +01001108 mbedtls_ssl_session_init(ssl->session_negotiate);
1109 ssl_handshake_params_init(ssl->handshake);
Paul Bakker968afaa2014-07-09 11:09:24 +02001110
Jerry Yu2e199812022-12-01 18:57:19 +08001111#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01001112 mbedtls_ssl_transform_init(ssl->transform_negotiate);
Jerry Yu2e199812022-12-01 18:57:19 +08001113#endif
1114
Manuel Pégourié-Gonnard537f2312023-02-05 10:17:45 +01001115 /* Setup handshake checksums */
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01001116 ret = mbedtls_ssl_reset_checksum(ssl);
1117 if (ret != 0) {
1118 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_reset_checksum", ret);
1119 return ret;
1120 }
Manuel Pégourié-Gonnard537f2312023-02-05 10:17:45 +01001121
Jerry Yud0766ec2022-09-22 10:46:57 +08001122#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && \
1123 defined(MBEDTLS_SSL_SRV_C) && \
1124 defined(MBEDTLS_SSL_SESSION_TICKETS)
1125 ssl->handshake->new_session_tickets_count =
Gilles Peskine449bd832023-01-11 14:50:10 +01001126 ssl->conf->new_session_tickets_count;
Jerry Yud0766ec2022-09-22 10:46:57 +08001127#endif
1128
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001129#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01001130 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +02001131 ssl->handshake->alt_transform_out = ssl->transform_out;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02001132
Gilles Peskine449bd832023-01-11 14:50:10 +01001133 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +02001134 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_PREPARING;
Gilles Peskine449bd832023-01-11 14:50:10 +01001135 } else {
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +02001136 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_WAITING;
Gilles Peskine449bd832023-01-11 14:50:10 +01001137 }
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001138
Gilles Peskine449bd832023-01-11 14:50:10 +01001139 mbedtls_ssl_set_timer(ssl, 0);
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +02001140 }
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02001141#endif
1142
Brett Warrene0edc842021-08-17 09:53:13 +01001143/*
1144 * curve_list is translated to IANA TLS group identifiers here because
1145 * mbedtls_ssl_conf_curves returns void and so can't return
1146 * any error codes.
1147 */
Manuel Pégourié-Gonnardf07ce3b2023-09-22 11:53:41 +02001148#if defined(MBEDTLS_ECP_C)
Brett Warrene0edc842021-08-17 09:53:13 +01001149#if !defined(MBEDTLS_DEPRECATED_REMOVED)
1150 /* Heap allocate and translate curve_list from internal to IANA group ids */
Gilles Peskine449bd832023-01-11 14:50:10 +01001151 if (ssl->conf->curve_list != NULL) {
Brett Warrene0edc842021-08-17 09:53:13 +01001152 size_t length;
1153 const mbedtls_ecp_group_id *curve_list = ssl->conf->curve_list;
1154
Thomas Daubney850a0792023-05-22 12:05:03 +01001155 for (length = 0; (curve_list[length] != MBEDTLS_ECP_DP_NONE); length++) {
Gilles Peskine449bd832023-01-11 14:50:10 +01001156 }
Brett Warrene0edc842021-08-17 09:53:13 +01001157
1158 /* Leave room for zero termination */
Gilles Peskine449bd832023-01-11 14:50:10 +01001159 uint16_t *group_list = mbedtls_calloc(length + 1, sizeof(uint16_t));
1160 if (group_list == NULL) {
1161 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
1162 }
Brett Warrene0edc842021-08-17 09:53:13 +01001163
Gilles Peskine449bd832023-01-11 14:50:10 +01001164 for (size_t i = 0; i < length; i++) {
Valerio Setti18c9fed2022-12-30 17:44:24 +01001165 uint16_t tls_id = mbedtls_ssl_get_tls_id_from_ecp_group_id(
Gilles Peskine449bd832023-01-11 14:50:10 +01001166 curve_list[i]);
1167 if (tls_id == 0) {
1168 mbedtls_free(group_list);
1169 return MBEDTLS_ERR_SSL_BAD_CONFIG;
Brett Warrene0edc842021-08-17 09:53:13 +01001170 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01001171 group_list[i] = tls_id;
Brett Warrene0edc842021-08-17 09:53:13 +01001172 }
1173
1174 group_list[length] = 0;
1175
1176 ssl->handshake->group_list = group_list;
1177 ssl->handshake->group_list_heap_allocated = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01001178 } else {
Brett Warrene0edc842021-08-17 09:53:13 +01001179 ssl->handshake->group_list = ssl->conf->group_list;
1180 ssl->handshake->group_list_heap_allocated = 0;
1181 }
1182#endif /* MBEDTLS_DEPRECATED_REMOVED */
Manuel Pégourié-Gonnardf07ce3b2023-09-22 11:53:41 +02001183#endif /* MBEDTLS_ECP_C */
Brett Warrene0edc842021-08-17 09:53:13 +01001184
Ronald Crone68ab4f2022-10-05 12:46:29 +02001185#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yuf017ee42022-01-12 15:49:48 +08001186#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Jerry Yua69269a2022-01-17 21:06:01 +08001187#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Jerry Yu713013f2022-01-17 18:16:35 +08001188 /* Heap allocate and translate sig_hashes from internal hash identifiers to
1189 signature algorithms IANA identifiers. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001190 if (mbedtls_ssl_conf_is_tls12_only(ssl->conf) &&
1191 ssl->conf->sig_hashes != NULL) {
Jerry Yuf017ee42022-01-12 15:49:48 +08001192 const int *md;
1193 const int *sig_hashes = ssl->conf->sig_hashes;
Jerry Yub476a442022-01-21 18:14:45 +08001194 size_t sig_algs_len = 0;
Jerry Yuf017ee42022-01-12 15:49:48 +08001195 uint16_t *p;
1196
Tom Cosgrove6ef9bb32023-03-08 14:19:51 +00001197 MBEDTLS_STATIC_ASSERT(MBEDTLS_SSL_MAX_SIG_ALG_LIST_LEN
1198 <= (SIZE_MAX - (2 * sizeof(uint16_t))),
1199 "MBEDTLS_SSL_MAX_SIG_ALG_LIST_LEN too big");
Jerry Yua68dca22022-01-20 16:28:27 +08001200
Gilles Peskine449bd832023-01-11 14:50:10 +01001201 for (md = sig_hashes; *md != MBEDTLS_MD_NONE; md++) {
1202 if (mbedtls_ssl_hash_from_md_alg(*md) == MBEDTLS_SSL_HASH_NONE) {
Jerry Yuf017ee42022-01-12 15:49:48 +08001203 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01001204 }
Valerio Settie9646ec2023-08-02 20:02:28 +02001205#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01001206 sig_algs_len += sizeof(uint16_t);
Jerry Yub476a442022-01-21 18:14:45 +08001207#endif
Jerry Yua68dca22022-01-20 16:28:27 +08001208
Jerry Yub476a442022-01-21 18:14:45 +08001209#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001210 sig_algs_len += sizeof(uint16_t);
Jerry Yub476a442022-01-21 18:14:45 +08001211#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001212 if (sig_algs_len > MBEDTLS_SSL_MAX_SIG_ALG_LIST_LEN) {
1213 return MBEDTLS_ERR_SSL_BAD_CONFIG;
1214 }
Jerry Yuf017ee42022-01-12 15:49:48 +08001215 }
1216
Gilles Peskine449bd832023-01-11 14:50:10 +01001217 if (sig_algs_len < MBEDTLS_SSL_MIN_SIG_ALG_LIST_LEN) {
1218 return MBEDTLS_ERR_SSL_BAD_CONFIG;
1219 }
Jerry Yuf017ee42022-01-12 15:49:48 +08001220
Gilles Peskine449bd832023-01-11 14:50:10 +01001221 ssl->handshake->sig_algs = mbedtls_calloc(1, sig_algs_len +
1222 sizeof(uint16_t));
1223 if (ssl->handshake->sig_algs == NULL) {
1224 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
1225 }
Jerry Yuf017ee42022-01-12 15:49:48 +08001226
Gilles Peskine449bd832023-01-11 14:50:10 +01001227 p = (uint16_t *) ssl->handshake->sig_algs;
1228 for (md = sig_hashes; *md != MBEDTLS_MD_NONE; md++) {
1229 unsigned char hash = mbedtls_ssl_hash_from_md_alg(*md);
1230 if (hash == MBEDTLS_SSL_HASH_NONE) {
Jerry Yuf017ee42022-01-12 15:49:48 +08001231 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01001232 }
Valerio Settie9646ec2023-08-02 20:02:28 +02001233#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01001234 *p = ((hash << 8) | MBEDTLS_SSL_SIG_ECDSA);
Jerry Yuf017ee42022-01-12 15:49:48 +08001235 p++;
Jerry Yu6106fdc2022-01-12 16:36:14 +08001236#endif
1237#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001238 *p = ((hash << 8) | MBEDTLS_SSL_SIG_RSA);
Jerry Yuf017ee42022-01-12 15:49:48 +08001239 p++;
Jerry Yu6106fdc2022-01-12 16:36:14 +08001240#endif
Jerry Yuf017ee42022-01-12 15:49:48 +08001241 }
Gabor Mezei15b95a62022-05-09 16:37:58 +02001242 *p = MBEDTLS_TLS_SIG_NONE;
Jerry Yuf017ee42022-01-12 15:49:48 +08001243 ssl->handshake->sig_algs_heap_allocated = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01001244 } else
Jerry Yua69269a2022-01-17 21:06:01 +08001245#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Jerry Yuf017ee42022-01-12 15:49:48 +08001246 {
Jerry Yuf017ee42022-01-12 15:49:48 +08001247 ssl->handshake->sig_algs_heap_allocated = 0;
1248 }
Jerry Yucc539102022-06-27 16:27:35 +08001249#endif /* !MBEDTLS_DEPRECATED_REMOVED */
Ronald Crone68ab4f2022-10-05 12:46:29 +02001250#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Gilles Peskine449bd832023-01-11 14:50:10 +01001251 return 0;
Paul Bakker48916f92012-09-16 19:57:18 +00001252}
1253
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001254#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001255/* Dummy cookie callbacks for defaults */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001256MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001257static int ssl_cookie_write_dummy(void *ctx,
1258 unsigned char **p, unsigned char *end,
1259 const unsigned char *cli_id, size_t cli_id_len)
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001260{
1261 ((void) ctx);
1262 ((void) p);
1263 ((void) end);
1264 ((void) cli_id);
1265 ((void) cli_id_len);
1266
Gilles Peskine449bd832023-01-11 14:50:10 +01001267 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001268}
1269
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001270MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001271static int ssl_cookie_check_dummy(void *ctx,
1272 const unsigned char *cookie, size_t cookie_len,
1273 const unsigned char *cli_id, size_t cli_id_len)
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001274{
1275 ((void) ctx);
1276 ((void) cookie);
1277 ((void) cookie_len);
1278 ((void) cli_id);
1279 ((void) cli_id_len);
1280
Gilles Peskine449bd832023-01-11 14:50:10 +01001281 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001282}
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001283#endif /* MBEDTLS_SSL_DTLS_HELLO_VERIFY && MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001284
Paul Bakker5121ce52009-01-03 21:22:43 +00001285/*
1286 * Initialize an SSL context
1287 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001288void mbedtls_ssl_init(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +02001289{
Gilles Peskine449bd832023-01-11 14:50:10 +01001290 memset(ssl, 0, sizeof(mbedtls_ssl_context));
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +02001291}
1292
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001293MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001294static int ssl_conf_version_check(const mbedtls_ssl_context *ssl)
Jerry Yu60835a82021-08-04 10:13:52 +08001295{
Ronald Cron086ee0b2022-03-15 15:18:51 +01001296 const mbedtls_ssl_config *conf = ssl->conf;
1297
Ronald Cron6f135e12021-12-08 16:57:54 +01001298#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01001299 if (mbedtls_ssl_conf_is_tls13_only(conf)) {
1300 if (conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
1301 MBEDTLS_SSL_DEBUG_MSG(1, ("DTLS 1.3 is not yet supported."));
1302 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
XiaokangQianed582dd2022-04-13 08:21:05 +00001303 }
1304
Gilles Peskine449bd832023-01-11 14:50:10 +01001305 MBEDTLS_SSL_DEBUG_MSG(4, ("The SSL configuration is tls13 only."));
1306 return 0;
Jerry Yu60835a82021-08-04 10:13:52 +08001307 }
1308#endif
1309
1310#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01001311 if (mbedtls_ssl_conf_is_tls12_only(conf)) {
1312 MBEDTLS_SSL_DEBUG_MSG(4, ("The SSL configuration is tls12 only."));
1313 return 0;
Jerry Yu60835a82021-08-04 10:13:52 +08001314 }
1315#endif
1316
Ronald Cron6f135e12021-12-08 16:57:54 +01001317#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01001318 if (mbedtls_ssl_conf_is_hybrid_tls12_tls13(conf)) {
1319 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
1320 MBEDTLS_SSL_DEBUG_MSG(1, ("DTLS not yet supported in Hybrid TLS 1.3 + TLS 1.2"));
1321 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
XiaokangQianed582dd2022-04-13 08:21:05 +00001322 }
1323
Gilles Peskine449bd832023-01-11 14:50:10 +01001324 MBEDTLS_SSL_DEBUG_MSG(4, ("The SSL configuration is TLS 1.3 or TLS 1.2."));
1325 return 0;
Jerry Yu60835a82021-08-04 10:13:52 +08001326 }
1327#endif
1328
Gilles Peskine449bd832023-01-11 14:50:10 +01001329 MBEDTLS_SSL_DEBUG_MSG(1, ("The SSL configuration is invalid."));
1330 return MBEDTLS_ERR_SSL_BAD_CONFIG;
Jerry Yu60835a82021-08-04 10:13:52 +08001331}
1332
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001333MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu60835a82021-08-04 10:13:52 +08001334static int ssl_conf_check(const mbedtls_ssl_context *ssl)
1335{
1336 int ret;
Gilles Peskine449bd832023-01-11 14:50:10 +01001337 ret = ssl_conf_version_check(ssl);
1338 if (ret != 0) {
1339 return ret;
1340 }
Jerry Yu60835a82021-08-04 10:13:52 +08001341
Jerry Yudef7ae42022-10-30 14:13:19 +08001342#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
1343 /* RFC 8446 section 4.4.3
1344 *
1345 * If the verification fails, the receiver MUST terminate the handshake with
1346 * a "decrypt_error" alert.
1347 *
1348 * If the client is configured as TLS 1.3 only with optional verify, return
1349 * bad config.
1350 *
1351 */
Pengyu Lv0a1ff2b2023-11-14 11:03:32 +08001352 if (mbedtls_ssl_conf_tls13_is_ephemeral_enabled(
Gilles Peskine449bd832023-01-11 14:50:10 +01001353 (mbedtls_ssl_context *) ssl) &&
Jerry Yudef7ae42022-10-30 14:13:19 +08001354 ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
1355 ssl->conf->max_tls_version == MBEDTLS_SSL_VERSION_TLS1_3 &&
1356 ssl->conf->min_tls_version == MBEDTLS_SSL_VERSION_TLS1_3 &&
Gilles Peskine449bd832023-01-11 14:50:10 +01001357 ssl->conf->authmode == MBEDTLS_SSL_VERIFY_OPTIONAL) {
Jerry Yudef7ae42022-10-30 14:13:19 +08001358 MBEDTLS_SSL_DEBUG_MSG(
Gilles Peskine449bd832023-01-11 14:50:10 +01001359 1, ("Optional verify auth mode "
1360 "is not available for TLS 1.3 client"));
1361 return MBEDTLS_ERR_SSL_BAD_CONFIG;
Jerry Yudef7ae42022-10-30 14:13:19 +08001362 }
1363#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
1364
Yanray Wangb422cab2023-12-01 16:18:10 +08001365 if (ssl->conf->f_rng == NULL) {
1366 MBEDTLS_SSL_DEBUG_MSG(1, ("no RNG provided"));
1367 return MBEDTLS_ERR_SSL_NO_RNG;
1368 }
1369
Jerry Yu60835a82021-08-04 10:13:52 +08001370 /* Space for further checks */
1371
Gilles Peskine449bd832023-01-11 14:50:10 +01001372 return 0;
Jerry Yu60835a82021-08-04 10:13:52 +08001373}
1374
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +02001375/*
1376 * Setup an SSL context
1377 */
Hanno Becker2a43f6f2018-08-10 11:12:52 +01001378
Gilles Peskine449bd832023-01-11 14:50:10 +01001379int mbedtls_ssl_setup(mbedtls_ssl_context *ssl,
1380 const mbedtls_ssl_config *conf)
Paul Bakker5121ce52009-01-03 21:22:43 +00001381{
Janos Follath865b3eb2019-12-16 11:46:15 +00001382 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Darryl Greenb33cc762019-11-28 14:29:44 +00001383 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
1384 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
Paul Bakker5121ce52009-01-03 21:22:43 +00001385
Manuel Pégourié-Gonnarddef0bbe2015-05-04 14:56:36 +02001386 ssl->conf = conf;
Paul Bakker62f2dee2012-09-28 07:31:51 +00001387
Gilles Peskine449bd832023-01-11 14:50:10 +01001388 if ((ret = ssl_conf_check(ssl)) != 0) {
1389 return ret;
1390 }
Ronald Cron8a12aee2023-03-08 15:30:43 +01001391 ssl->tls_version = ssl->conf->max_tls_version;
Jerry Yu60835a82021-08-04 10:13:52 +08001392
Paul Bakker62f2dee2012-09-28 07:31:51 +00001393 /*
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01001394 * Prepare base structures
Paul Bakker62f2dee2012-09-28 07:31:51 +00001395 */
k-stachowiakc9a5f022018-07-24 13:53:31 +02001396
1397 /* Set to NULL in case of an error condition */
1398 ssl->out_buf = NULL;
k-stachowiaka47911c2018-07-04 17:41:58 +02001399
Darryl Greenb33cc762019-11-28 14:29:44 +00001400#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1401 ssl->in_buf_len = in_buf_len;
1402#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001403 ssl->in_buf = mbedtls_calloc(1, in_buf_len);
1404 if (ssl->in_buf == NULL) {
1405 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc(%" MBEDTLS_PRINTF_SIZET " bytes) failed", in_buf_len));
k-stachowiak9f7798e2018-07-31 16:52:32 +02001406 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
k-stachowiaka47911c2018-07-04 17:41:58 +02001407 goto error;
Angus Grattond8213d02016-05-25 20:56:48 +10001408 }
1409
Darryl Greenb33cc762019-11-28 14:29:44 +00001410#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1411 ssl->out_buf_len = out_buf_len;
1412#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001413 ssl->out_buf = mbedtls_calloc(1, out_buf_len);
1414 if (ssl->out_buf == NULL) {
1415 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc(%" MBEDTLS_PRINTF_SIZET " bytes) failed", out_buf_len));
k-stachowiak9f7798e2018-07-31 16:52:32 +02001416 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
k-stachowiaka47911c2018-07-04 17:41:58 +02001417 goto error;
Paul Bakker5121ce52009-01-03 21:22:43 +00001418 }
1419
Gilles Peskine449bd832023-01-11 14:50:10 +01001420 mbedtls_ssl_reset_in_out_pointers(ssl);
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02001421
Johan Pascalb62bb512015-12-03 21:56:45 +01001422#if defined(MBEDTLS_SSL_DTLS_SRTP)
Gilles Peskine449bd832023-01-11 14:50:10 +01001423 memset(&ssl->dtls_srtp_info, 0, sizeof(ssl->dtls_srtp_info));
Johan Pascalb62bb512015-12-03 21:56:45 +01001424#endif
1425
Gilles Peskine449bd832023-01-11 14:50:10 +01001426 if ((ret = ssl_handshake_init(ssl)) != 0) {
k-stachowiaka47911c2018-07-04 17:41:58 +02001427 goto error;
Gilles Peskine449bd832023-01-11 14:50:10 +01001428 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001429
Gilles Peskine449bd832023-01-11 14:50:10 +01001430 return 0;
k-stachowiaka47911c2018-07-04 17:41:58 +02001431
1432error:
Gilles Peskine449bd832023-01-11 14:50:10 +01001433 mbedtls_free(ssl->in_buf);
1434 mbedtls_free(ssl->out_buf);
k-stachowiaka47911c2018-07-04 17:41:58 +02001435
1436 ssl->conf = NULL;
1437
Darryl Greenb33cc762019-11-28 14:29:44 +00001438#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1439 ssl->in_buf_len = 0;
1440 ssl->out_buf_len = 0;
1441#endif
k-stachowiaka47911c2018-07-04 17:41:58 +02001442 ssl->in_buf = NULL;
1443 ssl->out_buf = NULL;
1444
1445 ssl->in_hdr = NULL;
1446 ssl->in_ctr = NULL;
1447 ssl->in_len = NULL;
1448 ssl->in_iv = NULL;
1449 ssl->in_msg = NULL;
1450
1451 ssl->out_hdr = NULL;
1452 ssl->out_ctr = NULL;
1453 ssl->out_len = NULL;
1454 ssl->out_iv = NULL;
1455 ssl->out_msg = NULL;
1456
Gilles Peskine449bd832023-01-11 14:50:10 +01001457 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00001458}
1459
1460/*
Paul Bakker7eb013f2011-10-06 12:37:39 +00001461 * Reset an initialized and used SSL context for re-use while retaining
1462 * all application-set variables, function pointers and data.
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001463 *
1464 * If partial is non-zero, keep data in the input buffer and client ID.
1465 * (Use when a DTLS client reconnects from the same port.)
Paul Bakker7eb013f2011-10-06 12:37:39 +00001466 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001467void mbedtls_ssl_session_reset_msg_layer(mbedtls_ssl_context *ssl,
1468 int partial)
Paul Bakker7eb013f2011-10-06 12:37:39 +00001469{
Darryl Greenb33cc762019-11-28 14:29:44 +00001470#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1471 size_t in_buf_len = ssl->in_buf_len;
1472 size_t out_buf_len = ssl->out_buf_len;
1473#else
1474 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
1475 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
1476#endif
Paul Bakker48916f92012-09-16 19:57:18 +00001477
Hanno Beckerb0302c42021-08-03 09:39:42 +01001478#if !defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE) || !defined(MBEDTLS_SSL_SRV_C)
1479 partial = 0;
Hanno Becker7e772132018-08-10 12:38:21 +01001480#endif
1481
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001482 /* Cancel any possibly running timer */
Gilles Peskine449bd832023-01-11 14:50:10 +01001483 mbedtls_ssl_set_timer(ssl, 0);
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001484
Gilles Peskine449bd832023-01-11 14:50:10 +01001485 mbedtls_ssl_reset_in_out_pointers(ssl);
Hanno Beckerb0302c42021-08-03 09:39:42 +01001486
1487 /* Reset incoming message parsing */
1488 ssl->in_offt = NULL;
1489 ssl->nb_zero = 0;
1490 ssl->in_msgtype = 0;
1491 ssl->in_msglen = 0;
1492 ssl->in_hslen = 0;
1493 ssl->keep_current_message = 0;
1494 ssl->transform_in = NULL;
1495
1496#if defined(MBEDTLS_SSL_PROTO_DTLS)
1497 ssl->next_record_offset = 0;
1498 ssl->in_epoch = 0;
1499#endif
1500
1501 /* Keep current datagram if partial == 1 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001502 if (partial == 0) {
Hanno Beckerb0302c42021-08-03 09:39:42 +01001503 ssl->in_left = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01001504 memset(ssl->in_buf, 0, in_buf_len);
Hanno Beckerb0302c42021-08-03 09:39:42 +01001505 }
1506
Ronald Cronad8c17b2022-06-10 17:18:09 +02001507 ssl->send_alert = 0;
1508
Hanno Beckerb0302c42021-08-03 09:39:42 +01001509 /* Reset outgoing message writing */
1510 ssl->out_msgtype = 0;
1511 ssl->out_msglen = 0;
1512 ssl->out_left = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01001513 memset(ssl->out_buf, 0, out_buf_len);
1514 memset(ssl->cur_out_ctr, 0, sizeof(ssl->cur_out_ctr));
Hanno Beckerb0302c42021-08-03 09:39:42 +01001515 ssl->transform_out = NULL;
1516
1517#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Gilles Peskine449bd832023-01-11 14:50:10 +01001518 mbedtls_ssl_dtls_replay_reset(ssl);
Hanno Beckerb0302c42021-08-03 09:39:42 +01001519#endif
1520
XiaokangQian2b01dc32022-01-21 02:53:13 +00001521#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01001522 if (ssl->transform) {
1523 mbedtls_ssl_transform_free(ssl->transform);
1524 mbedtls_free(ssl->transform);
Hanno Beckerb0302c42021-08-03 09:39:42 +01001525 ssl->transform = NULL;
1526 }
XiaokangQian2b01dc32022-01-21 02:53:13 +00001527#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
1528
XiaokangQian2b01dc32022-01-21 02:53:13 +00001529#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01001530 mbedtls_ssl_transform_free(ssl->transform_application);
1531 mbedtls_free(ssl->transform_application);
XiaokangQian2b01dc32022-01-21 02:53:13 +00001532 ssl->transform_application = NULL;
1533
Gilles Peskine449bd832023-01-11 14:50:10 +01001534 if (ssl->handshake != NULL) {
Jerry Yu3d9b5902022-11-04 14:07:25 +08001535#if defined(MBEDTLS_SSL_EARLY_DATA)
Gilles Peskine449bd832023-01-11 14:50:10 +01001536 mbedtls_ssl_transform_free(ssl->handshake->transform_earlydata);
1537 mbedtls_free(ssl->handshake->transform_earlydata);
XiaokangQian2b01dc32022-01-21 02:53:13 +00001538 ssl->handshake->transform_earlydata = NULL;
Jerry Yu3d9b5902022-11-04 14:07:25 +08001539#endif
XiaokangQian2b01dc32022-01-21 02:53:13 +00001540
Gilles Peskine449bd832023-01-11 14:50:10 +01001541 mbedtls_ssl_transform_free(ssl->handshake->transform_handshake);
1542 mbedtls_free(ssl->handshake->transform_handshake);
XiaokangQian2b01dc32022-01-21 02:53:13 +00001543 ssl->handshake->transform_handshake = NULL;
1544 }
1545
XiaokangQian2b01dc32022-01-21 02:53:13 +00001546#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Beckerb0302c42021-08-03 09:39:42 +01001547}
1548
Gilles Peskine449bd832023-01-11 14:50:10 +01001549int mbedtls_ssl_session_reset_int(mbedtls_ssl_context *ssl, int partial)
Hanno Beckerb0302c42021-08-03 09:39:42 +01001550{
1551 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1552
1553 ssl->state = MBEDTLS_SSL_HELLO_REQUEST;
1554
Gilles Peskine449bd832023-01-11 14:50:10 +01001555 mbedtls_ssl_session_reset_msg_layer(ssl, partial);
Hanno Beckerb0302c42021-08-03 09:39:42 +01001556
1557 /* Reset renegotiation state */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001558#if defined(MBEDTLS_SSL_RENEGOTIATION)
1559 ssl->renego_status = MBEDTLS_SSL_INITIAL_HANDSHAKE;
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001560 ssl->renego_records_seen = 0;
Paul Bakker48916f92012-09-16 19:57:18 +00001561
1562 ssl->verify_data_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01001563 memset(ssl->own_verify_data, 0, MBEDTLS_SSL_VERIFY_DATA_MAX_LEN);
1564 memset(ssl->peer_verify_data, 0, MBEDTLS_SSL_VERIFY_DATA_MAX_LEN);
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001565#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001566 ssl->secure_renegotiation = MBEDTLS_SSL_LEGACY_RENEGOTIATION;
Paul Bakker48916f92012-09-16 19:57:18 +00001567
Hanno Beckerb0302c42021-08-03 09:39:42 +01001568 ssl->session_in = NULL;
Hanno Becker78640902018-08-13 16:35:15 +01001569 ssl->session_out = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01001570 if (ssl->session) {
1571 mbedtls_ssl_session_free(ssl->session);
1572 mbedtls_free(ssl->session);
Paul Bakkerc0463502013-02-14 11:19:38 +01001573 ssl->session = NULL;
1574 }
1575
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001576#if defined(MBEDTLS_SSL_ALPN)
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001577 ssl->alpn_chosen = NULL;
1578#endif
1579
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001580#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
David Horstmann3b2276a2022-10-06 14:49:08 +01001581 int free_cli_id = 1;
Hanno Becker4ccbf062018-08-10 11:20:38 +01001582#if defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE)
Gilles Peskine449bd832023-01-11 14:50:10 +01001583 free_cli_id = (partial == 0);
Hanno Becker4ccbf062018-08-10 11:20:38 +01001584#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001585 if (free_cli_id) {
1586 mbedtls_free(ssl->cli_id);
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001587 ssl->cli_id = NULL;
1588 ssl->cli_id_len = 0;
1589 }
Manuel Pégourié-Gonnard43c02182014-07-22 17:32:01 +02001590#endif
1591
Gilles Peskine449bd832023-01-11 14:50:10 +01001592 if ((ret = ssl_handshake_init(ssl)) != 0) {
1593 return ret;
1594 }
Paul Bakker2770fbd2012-07-03 13:30:23 +00001595
Gilles Peskine449bd832023-01-11 14:50:10 +01001596 return 0;
Paul Bakker7eb013f2011-10-06 12:37:39 +00001597}
1598
Manuel Pégourié-Gonnard779e4292013-08-03 13:50:48 +02001599/*
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001600 * Reset an initialized and used SSL context for re-use while retaining
1601 * all application-set variables, function pointers and data.
1602 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001603int mbedtls_ssl_session_reset(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001604{
Gilles Peskine449bd832023-01-11 14:50:10 +01001605 return mbedtls_ssl_session_reset_int(ssl, 0);
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001606}
1607
1608/*
Paul Bakker5121ce52009-01-03 21:22:43 +00001609 * SSL set accessors
1610 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001611void mbedtls_ssl_conf_endpoint(mbedtls_ssl_config *conf, int endpoint)
Paul Bakker5121ce52009-01-03 21:22:43 +00001612{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001613 conf->endpoint = endpoint;
Paul Bakker5121ce52009-01-03 21:22:43 +00001614}
1615
Gilles Peskine449bd832023-01-11 14:50:10 +01001616void mbedtls_ssl_conf_transport(mbedtls_ssl_config *conf, int transport)
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001617{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001618 conf->transport = transport;
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001619}
1620
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001621#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Gilles Peskine449bd832023-01-11 14:50:10 +01001622void mbedtls_ssl_conf_dtls_anti_replay(mbedtls_ssl_config *conf, char mode)
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02001623{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001624 conf->anti_replay = mode;
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02001625}
1626#endif
1627
Gilles Peskine449bd832023-01-11 14:50:10 +01001628void mbedtls_ssl_conf_dtls_badmac_limit(mbedtls_ssl_config *conf, unsigned limit)
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001629{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001630 conf->badmac_limit = limit;
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001631}
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001632
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001633#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker04da1892018-08-14 13:22:10 +01001634
Gilles Peskine449bd832023-01-11 14:50:10 +01001635void mbedtls_ssl_set_datagram_packing(mbedtls_ssl_context *ssl,
1636 unsigned allow_packing)
Hanno Becker04da1892018-08-14 13:22:10 +01001637{
1638 ssl->disable_datagram_packing = !allow_packing;
1639}
1640
Gilles Peskine449bd832023-01-11 14:50:10 +01001641void mbedtls_ssl_conf_handshake_timeout(mbedtls_ssl_config *conf,
1642 uint32_t min, uint32_t max)
Manuel Pégourié-Gonnard905dd242014-10-01 12:03:55 +02001643{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001644 conf->hs_timeout_min = min;
1645 conf->hs_timeout_max = max;
Manuel Pégourié-Gonnard905dd242014-10-01 12:03:55 +02001646}
1647#endif
1648
Gilles Peskine449bd832023-01-11 14:50:10 +01001649void mbedtls_ssl_conf_authmode(mbedtls_ssl_config *conf, int authmode)
Paul Bakker5121ce52009-01-03 21:22:43 +00001650{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001651 conf->authmode = authmode;
Paul Bakker5121ce52009-01-03 21:22:43 +00001652}
1653
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001654#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001655void mbedtls_ssl_conf_verify(mbedtls_ssl_config *conf,
1656 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *),
1657 void *p_vrfy)
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001658{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001659 conf->f_vrfy = f_vrfy;
1660 conf->p_vrfy = p_vrfy;
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001661}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001662#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001663
Gilles Peskine449bd832023-01-11 14:50:10 +01001664void mbedtls_ssl_conf_rng(mbedtls_ssl_config *conf,
1665 int (*f_rng)(void *, unsigned char *, size_t),
1666 void *p_rng)
Paul Bakker5121ce52009-01-03 21:22:43 +00001667{
Manuel Pégourié-Gonnard750e4d72015-05-07 12:35:38 +01001668 conf->f_rng = f_rng;
1669 conf->p_rng = p_rng;
Paul Bakker5121ce52009-01-03 21:22:43 +00001670}
1671
Gilles Peskine449bd832023-01-11 14:50:10 +01001672void mbedtls_ssl_conf_dbg(mbedtls_ssl_config *conf,
1673 void (*f_dbg)(void *, int, const char *, int, const char *),
1674 void *p_dbg)
Paul Bakker5121ce52009-01-03 21:22:43 +00001675{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001676 conf->f_dbg = f_dbg;
1677 conf->p_dbg = p_dbg;
Paul Bakker5121ce52009-01-03 21:22:43 +00001678}
1679
Gilles Peskine449bd832023-01-11 14:50:10 +01001680void mbedtls_ssl_set_bio(mbedtls_ssl_context *ssl,
1681 void *p_bio,
1682 mbedtls_ssl_send_t *f_send,
1683 mbedtls_ssl_recv_t *f_recv,
1684 mbedtls_ssl_recv_timeout_t *f_recv_timeout)
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02001685{
1686 ssl->p_bio = p_bio;
1687 ssl->f_send = f_send;
1688 ssl->f_recv = f_recv;
1689 ssl->f_recv_timeout = f_recv_timeout;
Manuel Pégourié-Gonnard97fd52c2015-05-06 15:38:52 +01001690}
1691
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02001692#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01001693void mbedtls_ssl_set_mtu(mbedtls_ssl_context *ssl, uint16_t mtu)
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02001694{
1695 ssl->mtu = mtu;
1696}
1697#endif
1698
Gilles Peskine449bd832023-01-11 14:50:10 +01001699void mbedtls_ssl_conf_read_timeout(mbedtls_ssl_config *conf, uint32_t timeout)
Manuel Pégourié-Gonnard97fd52c2015-05-06 15:38:52 +01001700{
1701 conf->read_timeout = timeout;
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02001702}
1703
Gilles Peskine449bd832023-01-11 14:50:10 +01001704void mbedtls_ssl_set_timer_cb(mbedtls_ssl_context *ssl,
1705 void *p_timer,
1706 mbedtls_ssl_set_timer_t *f_set_timer,
1707 mbedtls_ssl_get_timer_t *f_get_timer)
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02001708{
1709 ssl->p_timer = p_timer;
1710 ssl->f_set_timer = f_set_timer;
1711 ssl->f_get_timer = f_get_timer;
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001712
1713 /* Make sure we start with no timer running */
Gilles Peskine449bd832023-01-11 14:50:10 +01001714 mbedtls_ssl_set_timer(ssl, 0);
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02001715}
1716
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001717#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001718void mbedtls_ssl_conf_session_cache(mbedtls_ssl_config *conf,
1719 void *p_cache,
1720 mbedtls_ssl_cache_get_t *f_get_cache,
1721 mbedtls_ssl_cache_set_t *f_set_cache)
Paul Bakker5121ce52009-01-03 21:22:43 +00001722{
Manuel Pégourié-Gonnard5cb33082015-05-06 18:06:26 +01001723 conf->p_cache = p_cache;
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001724 conf->f_get_cache = f_get_cache;
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001725 conf->f_set_cache = f_set_cache;
Paul Bakker5121ce52009-01-03 21:22:43 +00001726}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001727#endif /* MBEDTLS_SSL_SRV_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00001728
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001729#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001730int mbedtls_ssl_set_session(mbedtls_ssl_context *ssl, const mbedtls_ssl_session *session)
Paul Bakker5121ce52009-01-03 21:22:43 +00001731{
Janos Follath865b3eb2019-12-16 11:46:15 +00001732 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001733
Gilles Peskine449bd832023-01-11 14:50:10 +01001734 if (ssl == NULL ||
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001735 session == NULL ||
1736 ssl->session_negotiate == NULL ||
Gilles Peskine449bd832023-01-11 14:50:10 +01001737 ssl->conf->endpoint != MBEDTLS_SSL_IS_CLIENT) {
1738 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001739 }
1740
Gilles Peskine449bd832023-01-11 14:50:10 +01001741 if (ssl->handshake->resume == 1) {
1742 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
1743 }
Hanno Beckere810bbc2021-05-14 16:01:05 +01001744
Jerry Yu21092062022-10-10 21:21:31 +08001745#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01001746 if (session->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Jerry Yu21092062022-10-10 21:21:31 +08001747 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
Gilles Peskine449bd832023-01-11 14:50:10 +01001748 mbedtls_ssl_ciphersuite_from_id(session->ciphersuite);
Jerry Yu21092062022-10-10 21:21:31 +08001749
Gilles Peskine449bd832023-01-11 14:50:10 +01001750 if (mbedtls_ssl_validate_ciphersuite(
Jerry Yu21092062022-10-10 21:21:31 +08001751 ssl, ciphersuite_info, MBEDTLS_SSL_VERSION_TLS1_3,
Gilles Peskine449bd832023-01-11 14:50:10 +01001752 MBEDTLS_SSL_VERSION_TLS1_3) != 0) {
1753 MBEDTLS_SSL_DEBUG_MSG(4, ("%d is not a valid TLS 1.3 ciphersuite.",
1754 session->ciphersuite));
1755 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jerry Yu21092062022-10-10 21:21:31 +08001756 }
Jerry Yu40afab62022-10-08 10:42:13 +08001757 }
Jerry Yu21092062022-10-10 21:21:31 +08001758#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yu40afab62022-10-08 10:42:13 +08001759
Gilles Peskine449bd832023-01-11 14:50:10 +01001760 if ((ret = mbedtls_ssl_session_copy(ssl->session_negotiate,
1761 session)) != 0) {
1762 return ret;
1763 }
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001764
Paul Bakker0a597072012-09-25 21:55:46 +00001765 ssl->handshake->resume = 1;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001766
Gilles Peskine449bd832023-01-11 14:50:10 +01001767 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00001768}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001769#endif /* MBEDTLS_SSL_CLI_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00001770
Gilles Peskine449bd832023-01-11 14:50:10 +01001771void mbedtls_ssl_conf_ciphersuites(mbedtls_ssl_config *conf,
1772 const int *ciphersuites)
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001773{
Hanno Beckerd60b6c62021-04-29 12:04:11 +01001774 conf->ciphersuite_list = ciphersuites;
Paul Bakker5121ce52009-01-03 21:22:43 +00001775}
1776
Ronald Cron6f135e12021-12-08 16:57:54 +01001777#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01001778void mbedtls_ssl_conf_tls13_key_exchange_modes(mbedtls_ssl_config *conf,
1779 const int kex_modes)
Hanno Becker71f1ed62021-07-24 06:01:47 +01001780{
Xiaofei Bai746f9482021-11-12 08:53:56 +00001781 conf->tls13_kex_modes = kex_modes & MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_ALL;
Hanno Becker71f1ed62021-07-24 06:01:47 +01001782}
Xiaokang Qian72de95d2022-10-25 02:54:33 +00001783
1784#if defined(MBEDTLS_SSL_EARLY_DATA)
Yanray Wangd5ed36f2023-11-07 11:40:43 +08001785void mbedtls_ssl_conf_early_data(mbedtls_ssl_config *conf,
1786 int early_data_enabled)
Xiaokang Qian72de95d2022-10-25 02:54:33 +00001787{
1788 conf->early_data_enabled = early_data_enabled;
1789}
Jerry Yucc4e0072022-11-22 17:22:22 +08001790
1791#if defined(MBEDTLS_SSL_SRV_C)
Yanray Wang07517612023-11-07 11:47:36 +08001792void mbedtls_ssl_conf_max_early_data_size(
Gilles Peskine449bd832023-01-11 14:50:10 +01001793 mbedtls_ssl_config *conf, uint32_t max_early_data_size)
Jerry Yucc4e0072022-11-22 17:22:22 +08001794{
Jerry Yu39da9852022-12-06 16:58:36 +08001795 conf->max_early_data_size = max_early_data_size;
Jerry Yucc4e0072022-11-22 17:22:22 +08001796}
1797#endif /* MBEDTLS_SSL_SRV_C */
1798
Xiaokang Qian72de95d2022-10-25 02:54:33 +00001799#endif /* MBEDTLS_SSL_EARLY_DATA */
Ronald Cron6f135e12021-12-08 16:57:54 +01001800#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker71f1ed62021-07-24 06:01:47 +01001801
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001802#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001803void mbedtls_ssl_conf_cert_profile(mbedtls_ssl_config *conf,
1804 const mbedtls_x509_crt_profile *profile)
Manuel Pégourié-Gonnard6e3ee3a2015-06-17 10:58:20 +02001805{
1806 conf->cert_profile = profile;
1807}
1808
Gilles Peskine449bd832023-01-11 14:50:10 +01001809static void ssl_key_cert_free(mbedtls_ssl_key_cert *key_cert)
Glenn Strauss36872db2022-01-22 05:06:31 -05001810{
1811 mbedtls_ssl_key_cert *cur = key_cert, *next;
1812
Gilles Peskine449bd832023-01-11 14:50:10 +01001813 while (cur != NULL) {
Glenn Strauss36872db2022-01-22 05:06:31 -05001814 next = cur->next;
Gilles Peskine449bd832023-01-11 14:50:10 +01001815 mbedtls_free(cur);
Glenn Strauss36872db2022-01-22 05:06:31 -05001816 cur = next;
1817 }
1818}
1819
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001820/* Append a new keycert entry to a (possibly empty) list */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001821MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001822static int ssl_append_key_cert(mbedtls_ssl_key_cert **head,
1823 mbedtls_x509_crt *cert,
1824 mbedtls_pk_context *key)
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001825{
niisato8ee24222018-06-25 19:05:48 +09001826 mbedtls_ssl_key_cert *new_cert;
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001827
Gilles Peskine449bd832023-01-11 14:50:10 +01001828 if (cert == NULL) {
Glenn Strauss36872db2022-01-22 05:06:31 -05001829 /* Free list if cert is null */
Gilles Peskine449bd832023-01-11 14:50:10 +01001830 ssl_key_cert_free(*head);
Glenn Strauss36872db2022-01-22 05:06:31 -05001831 *head = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01001832 return 0;
Glenn Strauss36872db2022-01-22 05:06:31 -05001833 }
1834
Gilles Peskine449bd832023-01-11 14:50:10 +01001835 new_cert = mbedtls_calloc(1, sizeof(mbedtls_ssl_key_cert));
1836 if (new_cert == NULL) {
1837 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
1838 }
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001839
niisato8ee24222018-06-25 19:05:48 +09001840 new_cert->cert = cert;
1841 new_cert->key = key;
1842 new_cert->next = NULL;
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001843
Glenn Strauss36872db2022-01-22 05:06:31 -05001844 /* Update head if the list was null, else add to the end */
Gilles Peskine449bd832023-01-11 14:50:10 +01001845 if (*head == NULL) {
niisato8ee24222018-06-25 19:05:48 +09001846 *head = new_cert;
Gilles Peskine449bd832023-01-11 14:50:10 +01001847 } else {
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001848 mbedtls_ssl_key_cert *cur = *head;
Gilles Peskine449bd832023-01-11 14:50:10 +01001849 while (cur->next != NULL) {
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001850 cur = cur->next;
Gilles Peskine449bd832023-01-11 14:50:10 +01001851 }
niisato8ee24222018-06-25 19:05:48 +09001852 cur->next = new_cert;
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001853 }
1854
Gilles Peskine449bd832023-01-11 14:50:10 +01001855 return 0;
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001856}
1857
Gilles Peskine449bd832023-01-11 14:50:10 +01001858int mbedtls_ssl_conf_own_cert(mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001859 mbedtls_x509_crt *own_cert,
Gilles Peskine449bd832023-01-11 14:50:10 +01001860 mbedtls_pk_context *pk_key)
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001861{
Gilles Peskine449bd832023-01-11 14:50:10 +01001862 return ssl_append_key_cert(&conf->key_cert, own_cert, pk_key);
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001863}
1864
Gilles Peskine449bd832023-01-11 14:50:10 +01001865void mbedtls_ssl_conf_ca_chain(mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01001866 mbedtls_x509_crt *ca_chain,
Gilles Peskine449bd832023-01-11 14:50:10 +01001867 mbedtls_x509_crl *ca_crl)
Paul Bakker5121ce52009-01-03 21:22:43 +00001868{
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01001869 conf->ca_chain = ca_chain;
1870 conf->ca_crl = ca_crl;
Hanno Becker5adaad92019-03-27 16:54:37 +00001871
1872#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
1873 /* mbedtls_ssl_conf_ca_chain() and mbedtls_ssl_conf_ca_cb()
1874 * cannot be used together. */
1875 conf->f_ca_cb = NULL;
1876 conf->p_ca_cb = NULL;
1877#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
Paul Bakker5121ce52009-01-03 21:22:43 +00001878}
Hanno Becker5adaad92019-03-27 16:54:37 +00001879
1880#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
Gilles Peskine449bd832023-01-11 14:50:10 +01001881void mbedtls_ssl_conf_ca_cb(mbedtls_ssl_config *conf,
1882 mbedtls_x509_crt_ca_cb_t f_ca_cb,
1883 void *p_ca_cb)
Hanno Becker5adaad92019-03-27 16:54:37 +00001884{
1885 conf->f_ca_cb = f_ca_cb;
1886 conf->p_ca_cb = p_ca_cb;
1887
1888 /* mbedtls_ssl_conf_ca_chain() and mbedtls_ssl_conf_ca_cb()
1889 * cannot be used together. */
1890 conf->ca_chain = NULL;
1891 conf->ca_crl = NULL;
1892}
1893#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001894#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkereb2c6582012-09-27 19:15:01 +00001895
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001896#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01001897const unsigned char *mbedtls_ssl_get_hs_sni(mbedtls_ssl_context *ssl,
1898 size_t *name_len)
Glenn Strauss69894072022-01-24 12:58:00 -05001899{
1900 *name_len = ssl->handshake->sni_name_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01001901 return ssl->handshake->sni_name;
Glenn Strauss69894072022-01-24 12:58:00 -05001902}
1903
Gilles Peskine449bd832023-01-11 14:50:10 +01001904int mbedtls_ssl_set_hs_own_cert(mbedtls_ssl_context *ssl,
1905 mbedtls_x509_crt *own_cert,
1906 mbedtls_pk_context *pk_key)
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001907{
Gilles Peskine449bd832023-01-11 14:50:10 +01001908 return ssl_append_key_cert(&ssl->handshake->sni_key_cert,
1909 own_cert, pk_key);
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001910}
Manuel Pégourié-Gonnard22bfa4b2015-05-11 08:46:37 +02001911
Gilles Peskine449bd832023-01-11 14:50:10 +01001912void mbedtls_ssl_set_hs_ca_chain(mbedtls_ssl_context *ssl,
1913 mbedtls_x509_crt *ca_chain,
1914 mbedtls_x509_crl *ca_crl)
Manuel Pégourié-Gonnard22bfa4b2015-05-11 08:46:37 +02001915{
1916 ssl->handshake->sni_ca_chain = ca_chain;
1917 ssl->handshake->sni_ca_crl = ca_crl;
1918}
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +02001919
Glenn Strauss999ef702022-03-11 01:37:23 -05001920#if defined(MBEDTLS_KEY_EXCHANGE_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01001921void mbedtls_ssl_set_hs_dn_hints(mbedtls_ssl_context *ssl,
1922 const mbedtls_x509_crt *crt)
Glenn Strauss999ef702022-03-11 01:37:23 -05001923{
1924 ssl->handshake->dn_hints = crt;
1925}
1926#endif /* MBEDTLS_KEY_EXCHANGE_CERT_REQ_ALLOWED_ENABLED */
1927
Gilles Peskine449bd832023-01-11 14:50:10 +01001928void mbedtls_ssl_set_hs_authmode(mbedtls_ssl_context *ssl,
1929 int authmode)
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +02001930{
1931 ssl->handshake->sni_authmode = authmode;
1932}
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001933#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
1934
Hanno Becker8927c832019-04-03 12:52:50 +01001935#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001936void mbedtls_ssl_set_verify(mbedtls_ssl_context *ssl,
1937 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *),
1938 void *p_vrfy)
Hanno Becker8927c832019-04-03 12:52:50 +01001939{
1940 ssl->f_vrfy = f_vrfy;
1941 ssl->p_vrfy = p_vrfy;
1942}
1943#endif
1944
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02001945#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02001946
Valerio Setti016f6822022-12-09 14:17:50 +01001947#if defined(MBEDTLS_USE_PSA_CRYPTO)
Przemek Stekielfde11282023-03-13 16:06:09 +01001948static const uint8_t jpake_server_id[] = { 's', 'e', 'r', 'v', 'e', 'r' };
1949static const uint8_t jpake_client_id[] = { 'c', 'l', 'i', 'e', 'n', 't' };
1950
Valerio Setti016f6822022-12-09 14:17:50 +01001951static psa_status_t mbedtls_ssl_set_hs_ecjpake_password_common(
Gilles Peskine449bd832023-01-11 14:50:10 +01001952 mbedtls_ssl_context *ssl,
1953 mbedtls_svc_key_id_t pwd)
Valerio Setti016f6822022-12-09 14:17:50 +01001954{
1955 psa_status_t status;
Valerio Setti016f6822022-12-09 14:17:50 +01001956 psa_pake_cipher_suite_t cipher_suite = psa_pake_cipher_suite_init();
Przemek Stekielfde11282023-03-13 16:06:09 +01001957 const uint8_t *user = NULL;
Przemek Stekiel4cd20312023-03-01 11:11:28 +01001958 size_t user_len = 0;
Przemek Stekielfde11282023-03-13 16:06:09 +01001959 const uint8_t *peer = NULL;
Przemek Stekiel4cd20312023-03-01 11:11:28 +01001960 size_t peer_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01001961 psa_pake_cs_set_algorithm(&cipher_suite, PSA_ALG_JPAKE);
1962 psa_pake_cs_set_primitive(&cipher_suite,
1963 PSA_PAKE_PRIMITIVE(PSA_PAKE_PRIMITIVE_TYPE_ECC,
1964 PSA_ECC_FAMILY_SECP_R1,
1965 256));
1966 psa_pake_cs_set_hash(&cipher_suite, PSA_ALG_SHA_256);
Valerio Setti016f6822022-12-09 14:17:50 +01001967
Gilles Peskine449bd832023-01-11 14:50:10 +01001968 status = psa_pake_setup(&ssl->handshake->psa_pake_ctx, &cipher_suite);
1969 if (status != PSA_SUCCESS) {
Valerio Setti016f6822022-12-09 14:17:50 +01001970 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001971 }
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02001972
Gilles Peskine449bd832023-01-11 14:50:10 +01001973 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Przemek Stekielfde11282023-03-13 16:06:09 +01001974 user = jpake_server_id;
1975 user_len = sizeof(jpake_server_id);
1976 peer = jpake_client_id;
1977 peer_len = sizeof(jpake_client_id);
Gilles Peskine449bd832023-01-11 14:50:10 +01001978 } else {
Przemek Stekielfde11282023-03-13 16:06:09 +01001979 user = jpake_client_id;
1980 user_len = sizeof(jpake_client_id);
1981 peer = jpake_server_id;
1982 peer_len = sizeof(jpake_server_id);
Gilles Peskine449bd832023-01-11 14:50:10 +01001983 }
Neil Armstrongca7d5062022-05-31 14:43:23 +02001984
Przemek Stekiel4cd20312023-03-01 11:11:28 +01001985 status = psa_pake_set_user(&ssl->handshake->psa_pake_ctx, user, user_len);
1986 if (status != PSA_SUCCESS) {
1987 return status;
1988 }
1989
1990 status = psa_pake_set_peer(&ssl->handshake->psa_pake_ctx, peer, peer_len);
Gilles Peskine449bd832023-01-11 14:50:10 +01001991 if (status != PSA_SUCCESS) {
Valerio Setti016f6822022-12-09 14:17:50 +01001992 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001993 }
Valerio Setti016f6822022-12-09 14:17:50 +01001994
Gilles Peskine449bd832023-01-11 14:50:10 +01001995 status = psa_pake_set_password_key(&ssl->handshake->psa_pake_ctx, pwd);
1996 if (status != PSA_SUCCESS) {
Valerio Setti016f6822022-12-09 14:17:50 +01001997 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001998 }
Valerio Setti016f6822022-12-09 14:17:50 +01001999
2000 ssl->handshake->psa_pake_ctx_is_ok = 1;
2001
Gilles Peskine449bd832023-01-11 14:50:10 +01002002 return PSA_SUCCESS;
Valerio Setti016f6822022-12-09 14:17:50 +01002003}
2004
Gilles Peskine449bd832023-01-11 14:50:10 +01002005int mbedtls_ssl_set_hs_ecjpake_password(mbedtls_ssl_context *ssl,
2006 const unsigned char *pw,
2007 size_t pw_len)
Valerio Setti016f6822022-12-09 14:17:50 +01002008{
2009 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
2010 psa_status_t status;
2011
Gilles Peskine449bd832023-01-11 14:50:10 +01002012 if (ssl->handshake == NULL || ssl->conf == NULL) {
2013 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Neil Armstrongca7d5062022-05-31 14:43:23 +02002014 }
2015
Gilles Peskine449bd832023-01-11 14:50:10 +01002016 /* Empty password is not valid */
2017 if ((pw == NULL) || (pw_len == 0)) {
2018 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2019 }
2020
2021 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_DERIVE);
2022 psa_set_key_algorithm(&attributes, PSA_ALG_JPAKE);
2023 psa_set_key_type(&attributes, PSA_KEY_TYPE_PASSWORD);
2024
2025 status = psa_import_key(&attributes, pw, pw_len,
2026 &ssl->handshake->psa_pake_password);
2027 if (status != PSA_SUCCESS) {
2028 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
2029 }
2030
2031 status = mbedtls_ssl_set_hs_ecjpake_password_common(ssl,
2032 ssl->handshake->psa_pake_password);
2033 if (status != PSA_SUCCESS) {
2034 psa_destroy_key(ssl->handshake->psa_pake_password);
2035 psa_pake_abort(&ssl->handshake->psa_pake_ctx);
2036 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
2037 }
2038
2039 return 0;
Valerio Setti02c25b52022-11-15 14:08:42 +01002040}
Valerio Settia9a97dc2022-11-28 18:26:16 +01002041
Gilles Peskine449bd832023-01-11 14:50:10 +01002042int mbedtls_ssl_set_hs_ecjpake_password_opaque(mbedtls_ssl_context *ssl,
2043 mbedtls_svc_key_id_t pwd)
Valerio Settia9a97dc2022-11-28 18:26:16 +01002044{
Valerio Settia9a97dc2022-11-28 18:26:16 +01002045 psa_status_t status;
2046
Gilles Peskine449bd832023-01-11 14:50:10 +01002047 if (ssl->handshake == NULL || ssl->conf == NULL) {
2048 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Neil Armstrongca7d5062022-05-31 14:43:23 +02002049 }
2050
Gilles Peskine449bd832023-01-11 14:50:10 +01002051 if (mbedtls_svc_key_id_is_null(pwd)) {
2052 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2053 }
2054
2055 status = mbedtls_ssl_set_hs_ecjpake_password_common(ssl, pwd);
2056 if (status != PSA_SUCCESS) {
2057 psa_pake_abort(&ssl->handshake->psa_pake_ctx);
2058 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
2059 }
2060
2061 return 0;
Valerio Setti02c25b52022-11-15 14:08:42 +01002062}
2063#else /* MBEDTLS_USE_PSA_CRYPTO */
Gilles Peskine449bd832023-01-11 14:50:10 +01002064int mbedtls_ssl_set_hs_ecjpake_password(mbedtls_ssl_context *ssl,
2065 const unsigned char *pw,
2066 size_t pw_len)
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002067{
2068 mbedtls_ecjpake_role role;
2069
Gilles Peskine449bd832023-01-11 14:50:10 +01002070 if (ssl->handshake == NULL || ssl->conf == NULL) {
2071 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2072 }
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002073
Valerio Settic689ed82022-12-07 14:40:38 +01002074 /* Empty password is not valid */
Gilles Peskine449bd832023-01-11 14:50:10 +01002075 if ((pw == NULL) || (pw_len == 0)) {
2076 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2077 }
Valerio Settic689ed82022-12-07 14:40:38 +01002078
Gilles Peskine449bd832023-01-11 14:50:10 +01002079 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002080 role = MBEDTLS_ECJPAKE_SERVER;
Gilles Peskine449bd832023-01-11 14:50:10 +01002081 } else {
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002082 role = MBEDTLS_ECJPAKE_CLIENT;
Gilles Peskine449bd832023-01-11 14:50:10 +01002083 }
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002084
Gilles Peskine449bd832023-01-11 14:50:10 +01002085 return mbedtls_ecjpake_setup(&ssl->handshake->ecjpake_ctx,
2086 role,
2087 MBEDTLS_MD_SHA256,
2088 MBEDTLS_ECP_DP_SECP256R1,
2089 pw, pw_len);
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002090}
Valerio Setti02c25b52022-11-15 14:08:42 +01002091#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02002092#endif /* MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED */
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002093
Ronald Cron73fe8df2022-10-05 14:31:43 +02002094#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01002095int mbedtls_ssl_conf_has_static_psk(mbedtls_ssl_config const *conf)
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002096{
Gilles Peskine449bd832023-01-11 14:50:10 +01002097 if (conf->psk_identity == NULL ||
2098 conf->psk_identity_len == 0) {
2099 return 0;
Ronald Crond29e13e2022-10-19 10:33:48 +02002100 }
2101
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002102#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01002103 if (!mbedtls_svc_key_id_is_null(conf->psk_opaque)) {
2104 return 1;
2105 }
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002106#endif /* MBEDTLS_USE_PSA_CRYPTO */
Ronald Crond29e13e2022-10-19 10:33:48 +02002107
Gilles Peskine449bd832023-01-11 14:50:10 +01002108 if (conf->psk != NULL && conf->psk_len != 0) {
2109 return 1;
2110 }
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002111
Gilles Peskine449bd832023-01-11 14:50:10 +01002112 return 0;
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002113}
2114
Gilles Peskine449bd832023-01-11 14:50:10 +01002115static void ssl_conf_remove_psk(mbedtls_ssl_config *conf)
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002116{
2117 /* Remove reference to existing PSK, if any. */
2118#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01002119 if (!mbedtls_svc_key_id_is_null(conf->psk_opaque)) {
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002120 /* The maintenance of the PSK key slot is the
2121 * user's responsibility. */
Ronald Croncf56a0a2020-08-04 09:51:30 +02002122 conf->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002123 }
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002124#endif /* MBEDTLS_USE_PSA_CRYPTO */
Gilles Peskine449bd832023-01-11 14:50:10 +01002125 if (conf->psk != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01002126 mbedtls_zeroize_and_free(conf->psk, conf->psk_len);
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002127 conf->psk = NULL;
2128 conf->psk_len = 0;
2129 }
2130
2131 /* Remove reference to PSK identity, if any. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002132 if (conf->psk_identity != NULL) {
2133 mbedtls_free(conf->psk_identity);
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002134 conf->psk_identity = NULL;
2135 conf->psk_identity_len = 0;
2136 }
2137}
2138
Hanno Becker7390c712018-11-15 13:33:04 +00002139/* This function assumes that PSK identity in the SSL config is unset.
2140 * It checks that the provided identity is well-formed and attempts
2141 * to make a copy of it in the SSL config.
2142 * On failure, the PSK identity in the config remains unset. */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002143MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002144static int ssl_conf_set_psk_identity(mbedtls_ssl_config *conf,
2145 unsigned char const *psk_identity,
2146 size_t psk_identity_len)
Paul Bakkerd4a56ec2013-04-16 18:05:29 +02002147{
Manuel Pégourié-Gonnardc6b5d832015-08-27 16:37:35 +02002148 /* Identity len will be encoded on two bytes */
Gilles Peskine449bd832023-01-11 14:50:10 +01002149 if (psk_identity == NULL ||
Ronald Cron2a87e9b2022-10-19 10:55:26 +02002150 psk_identity_len == 0 ||
Gilles Peskine449bd832023-01-11 14:50:10 +01002151 (psk_identity_len >> 16) != 0 ||
2152 psk_identity_len > MBEDTLS_SSL_OUT_CONTENT_LEN) {
2153 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnardc6b5d832015-08-27 16:37:35 +02002154 }
2155
Gilles Peskine449bd832023-01-11 14:50:10 +01002156 conf->psk_identity = mbedtls_calloc(1, psk_identity_len);
2157 if (conf->psk_identity == NULL) {
2158 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
2159 }
Paul Bakker6db455e2013-09-18 17:29:31 +02002160
Manuel Pégourié-Gonnard120fdbd2015-05-07 17:07:50 +01002161 conf->psk_identity_len = psk_identity_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01002162 memcpy(conf->psk_identity, psk_identity, conf->psk_identity_len);
Paul Bakker5ad403f2013-09-18 21:21:30 +02002163
Gilles Peskine449bd832023-01-11 14:50:10 +01002164 return 0;
Paul Bakker6db455e2013-09-18 17:29:31 +02002165}
2166
Gilles Peskine449bd832023-01-11 14:50:10 +01002167int mbedtls_ssl_conf_psk(mbedtls_ssl_config *conf,
2168 const unsigned char *psk, size_t psk_len,
2169 const unsigned char *psk_identity, size_t psk_identity_len)
Hanno Becker7390c712018-11-15 13:33:04 +00002170{
Janos Follath865b3eb2019-12-16 11:46:15 +00002171 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002172
2173 /* We currently only support one PSK, raw or opaque. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002174 if (mbedtls_ssl_conf_has_static_psk(conf)) {
2175 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
2176 }
Hanno Becker7390c712018-11-15 13:33:04 +00002177
2178 /* Check and set raw PSK */
Gilles Peskine449bd832023-01-11 14:50:10 +01002179 if (psk == NULL) {
2180 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2181 }
2182 if (psk_len == 0) {
2183 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2184 }
2185 if (psk_len > MBEDTLS_PSK_MAX_LEN) {
2186 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2187 }
Piotr Nowicki9926eaf2019-11-20 14:54:36 +01002188
Gilles Peskine449bd832023-01-11 14:50:10 +01002189 if ((conf->psk = mbedtls_calloc(1, psk_len)) == NULL) {
2190 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
2191 }
Hanno Becker7390c712018-11-15 13:33:04 +00002192 conf->psk_len = psk_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01002193 memcpy(conf->psk, psk, conf->psk_len);
Hanno Becker7390c712018-11-15 13:33:04 +00002194
2195 /* Check and set PSK Identity */
Gilles Peskine449bd832023-01-11 14:50:10 +01002196 ret = ssl_conf_set_psk_identity(conf, psk_identity, psk_identity_len);
2197 if (ret != 0) {
2198 ssl_conf_remove_psk(conf);
2199 }
Hanno Becker7390c712018-11-15 13:33:04 +00002200
Gilles Peskine449bd832023-01-11 14:50:10 +01002201 return ret;
Hanno Becker7390c712018-11-15 13:33:04 +00002202}
2203
Gilles Peskine449bd832023-01-11 14:50:10 +01002204static void ssl_remove_psk(mbedtls_ssl_context *ssl)
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002205{
2206#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01002207 if (!mbedtls_svc_key_id_is_null(ssl->handshake->psk_opaque)) {
Neil Armstrong501c9322022-05-03 09:35:09 +02002208 /* The maintenance of the external PSK key slot is the
2209 * user's responsibility. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002210 if (ssl->handshake->psk_opaque_is_internal) {
2211 psa_destroy_key(ssl->handshake->psk_opaque);
Neil Armstrong501c9322022-05-03 09:35:09 +02002212 ssl->handshake->psk_opaque_is_internal = 0;
2213 }
Ronald Croncf56a0a2020-08-04 09:51:30 +02002214 ssl->handshake->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002215 }
Neil Armstronge952a302022-05-03 10:22:14 +02002216#else
Gilles Peskine449bd832023-01-11 14:50:10 +01002217 if (ssl->handshake->psk != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01002218 mbedtls_zeroize_and_free(ssl->handshake->psk,
Gilles Peskine449bd832023-01-11 14:50:10 +01002219 ssl->handshake->psk_len);
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002220 ssl->handshake->psk_len = 0;
2221 }
Neil Armstronge952a302022-05-03 10:22:14 +02002222#endif /* MBEDTLS_USE_PSA_CRYPTO */
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002223}
2224
Gilles Peskine449bd832023-01-11 14:50:10 +01002225int mbedtls_ssl_set_hs_psk(mbedtls_ssl_context *ssl,
2226 const unsigned char *psk, size_t psk_len)
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002227{
Neil Armstrong501c9322022-05-03 09:35:09 +02002228#if defined(MBEDTLS_USE_PSA_CRYPTO)
2229 psa_key_attributes_t key_attributes = psa_key_attributes_init();
Jerry Yu5d01c052022-08-17 10:18:10 +08002230 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Jerry Yu24b8c812022-08-20 19:06:56 +08002231 psa_algorithm_t alg = PSA_ALG_NONE;
Jerry Yu5d01c052022-08-17 10:18:10 +08002232 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Neil Armstrong501c9322022-05-03 09:35:09 +02002233#endif /* MBEDTLS_USE_PSA_CRYPTO */
2234
Gilles Peskine449bd832023-01-11 14:50:10 +01002235 if (psk == NULL || ssl->handshake == NULL) {
2236 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2237 }
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002238
Gilles Peskine449bd832023-01-11 14:50:10 +01002239 if (psk_len > MBEDTLS_PSK_MAX_LEN) {
2240 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2241 }
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002242
Gilles Peskine449bd832023-01-11 14:50:10 +01002243 ssl_remove_psk(ssl);
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002244
Neil Armstrong501c9322022-05-03 09:35:09 +02002245#if defined(MBEDTLS_USE_PSA_CRYPTO)
Jerry Yuccc68a42022-07-26 16:39:20 +08002246#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01002247 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_2) {
2248 if (ssl->handshake->ciphersuite_info->mac == MBEDTLS_MD_SHA384) {
2249 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_384);
2250 } else {
2251 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_256);
2252 }
2253 psa_set_key_usage_flags(&key_attributes, PSA_KEY_USAGE_DERIVE);
Jerry Yuccc68a42022-07-26 16:39:20 +08002254 }
2255#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Neil Armstrong501c9322022-05-03 09:35:09 +02002256
Jerry Yu568ec252022-07-22 21:27:34 +08002257#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01002258 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
2259 alg = PSA_ALG_HKDF_EXTRACT(PSA_ALG_ANY_HASH);
2260 psa_set_key_usage_flags(&key_attributes,
2261 PSA_KEY_USAGE_DERIVE | PSA_KEY_USAGE_EXPORT);
Jerry Yuccc68a42022-07-26 16:39:20 +08002262 }
2263#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
2264
Gilles Peskine449bd832023-01-11 14:50:10 +01002265 psa_set_key_algorithm(&key_attributes, alg);
2266 psa_set_key_type(&key_attributes, PSA_KEY_TYPE_DERIVE);
Neil Armstrong501c9322022-05-03 09:35:09 +02002267
Gilles Peskine449bd832023-01-11 14:50:10 +01002268 status = psa_import_key(&key_attributes, psk, psk_len, &key);
2269 if (status != PSA_SUCCESS) {
2270 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
2271 }
Neil Armstrong501c9322022-05-03 09:35:09 +02002272
2273 /* Allow calling psa_destroy_key() on psk remove */
2274 ssl->handshake->psk_opaque_is_internal = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01002275 return mbedtls_ssl_set_hs_psk_opaque(ssl, key);
Neil Armstrong501c9322022-05-03 09:35:09 +02002276#else
Gilles Peskine449bd832023-01-11 14:50:10 +01002277 if ((ssl->handshake->psk = mbedtls_calloc(1, psk_len)) == NULL) {
2278 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
2279 }
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002280
2281 ssl->handshake->psk_len = psk_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01002282 memcpy(ssl->handshake->psk, psk, ssl->handshake->psk_len);
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002283
Gilles Peskine449bd832023-01-11 14:50:10 +01002284 return 0;
Neil Armstrong501c9322022-05-03 09:35:09 +02002285#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002286}
2287
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002288#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01002289int mbedtls_ssl_conf_psk_opaque(mbedtls_ssl_config *conf,
2290 mbedtls_svc_key_id_t psk,
2291 const unsigned char *psk_identity,
2292 size_t psk_identity_len)
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002293{
Janos Follath865b3eb2019-12-16 11:46:15 +00002294 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002295
2296 /* We currently only support one PSK, raw or opaque. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002297 if (mbedtls_ssl_conf_has_static_psk(conf)) {
2298 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
2299 }
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002300
Hanno Becker7390c712018-11-15 13:33:04 +00002301 /* Check and set opaque PSK */
Gilles Peskine449bd832023-01-11 14:50:10 +01002302 if (mbedtls_svc_key_id_is_null(psk)) {
2303 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2304 }
Ronald Croncf56a0a2020-08-04 09:51:30 +02002305 conf->psk_opaque = psk;
Hanno Becker7390c712018-11-15 13:33:04 +00002306
2307 /* Check and set PSK Identity */
Gilles Peskine449bd832023-01-11 14:50:10 +01002308 ret = ssl_conf_set_psk_identity(conf, psk_identity,
2309 psk_identity_len);
2310 if (ret != 0) {
2311 ssl_conf_remove_psk(conf);
2312 }
Hanno Becker7390c712018-11-15 13:33:04 +00002313
Gilles Peskine449bd832023-01-11 14:50:10 +01002314 return ret;
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002315}
2316
Gilles Peskine449bd832023-01-11 14:50:10 +01002317int mbedtls_ssl_set_hs_psk_opaque(mbedtls_ssl_context *ssl,
2318 mbedtls_svc_key_id_t psk)
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002319{
Gilles Peskine449bd832023-01-11 14:50:10 +01002320 if ((mbedtls_svc_key_id_is_null(psk)) ||
2321 (ssl->handshake == NULL)) {
2322 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2323 }
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002324
Gilles Peskine449bd832023-01-11 14:50:10 +01002325 ssl_remove_psk(ssl);
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002326 ssl->handshake->psk_opaque = psk;
Gilles Peskine449bd832023-01-11 14:50:10 +01002327 return 0;
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002328}
2329#endif /* MBEDTLS_USE_PSA_CRYPTO */
2330
Jerry Yu8897c072022-08-12 13:56:53 +08002331#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002332void mbedtls_ssl_conf_psk_cb(mbedtls_ssl_config *conf,
2333 int (*f_psk)(void *, mbedtls_ssl_context *, const unsigned char *,
2334 size_t),
2335 void *p_psk)
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002336{
2337 conf->f_psk = f_psk;
2338 conf->p_psk = p_psk;
2339}
Jerry Yu8897c072022-08-12 13:56:53 +08002340#endif /* MBEDTLS_SSL_SRV_C */
2341
Ronald Cron73fe8df2022-10-05 14:31:43 +02002342#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED */
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002343
2344#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine301711e2022-04-26 16:57:05 +02002345static mbedtls_ssl_mode_t mbedtls_ssl_get_base_mode(
Gilles Peskine449bd832023-01-11 14:50:10 +01002346 psa_algorithm_t alg)
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002347{
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002348#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01002349 if (alg == PSA_ALG_CBC_NO_PADDING) {
2350 return MBEDTLS_SSL_MODE_CBC;
2351 }
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002352#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
Gilles Peskine449bd832023-01-11 14:50:10 +01002353 if (PSA_ALG_IS_AEAD(alg)) {
2354 return MBEDTLS_SSL_MODE_AEAD;
2355 }
2356 return MBEDTLS_SSL_MODE_STREAM;
Gilles Peskine301711e2022-04-26 16:57:05 +02002357}
2358
2359#else /* MBEDTLS_USE_PSA_CRYPTO */
2360
2361static mbedtls_ssl_mode_t mbedtls_ssl_get_base_mode(
Gilles Peskine449bd832023-01-11 14:50:10 +01002362 mbedtls_cipher_mode_t mode)
Gilles Peskine301711e2022-04-26 16:57:05 +02002363{
2364#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01002365 if (mode == MBEDTLS_MODE_CBC) {
2366 return MBEDTLS_SSL_MODE_CBC;
2367 }
Gilles Peskine301711e2022-04-26 16:57:05 +02002368#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
2369
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002370#if defined(MBEDTLS_GCM_C) || \
2371 defined(MBEDTLS_CCM_C) || \
2372 defined(MBEDTLS_CHACHAPOLY_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002373 if (mode == MBEDTLS_MODE_GCM ||
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002374 mode == MBEDTLS_MODE_CCM ||
Gilles Peskine449bd832023-01-11 14:50:10 +01002375 mode == MBEDTLS_MODE_CHACHAPOLY) {
2376 return MBEDTLS_SSL_MODE_AEAD;
2377 }
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002378#endif /* MBEDTLS_GCM_C || MBEDTLS_CCM_C || MBEDTLS_CHACHAPOLY_C */
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002379
Gilles Peskine449bd832023-01-11 14:50:10 +01002380 return MBEDTLS_SSL_MODE_STREAM;
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002381}
Gilles Peskine301711e2022-04-26 16:57:05 +02002382#endif /* MBEDTLS_USE_PSA_CRYPTO */
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002383
Gilles Peskinee108d982022-04-26 16:50:40 +02002384static mbedtls_ssl_mode_t mbedtls_ssl_get_actual_mode(
2385 mbedtls_ssl_mode_t base_mode,
Gilles Peskine449bd832023-01-11 14:50:10 +01002386 int encrypt_then_mac)
Gilles Peskinee108d982022-04-26 16:50:40 +02002387{
2388#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01002389 if (encrypt_then_mac == MBEDTLS_SSL_ETM_ENABLED &&
2390 base_mode == MBEDTLS_SSL_MODE_CBC) {
2391 return MBEDTLS_SSL_MODE_CBC_ETM;
Gilles Peskinee108d982022-04-26 16:50:40 +02002392 }
2393#else
2394 (void) encrypt_then_mac;
2395#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002396 return base_mode;
Gilles Peskinee108d982022-04-26 16:50:40 +02002397}
2398
Neil Armstrongab555e02022-04-04 11:07:59 +02002399mbedtls_ssl_mode_t mbedtls_ssl_get_mode_from_transform(
Gilles Peskine449bd832023-01-11 14:50:10 +01002400 const mbedtls_ssl_transform *transform)
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002401{
Gilles Peskinee108d982022-04-26 16:50:40 +02002402 mbedtls_ssl_mode_t base_mode = mbedtls_ssl_get_base_mode(
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002403#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01002404 transform->psa_alg
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002405#else
Gilles Peskine449bd832023-01-11 14:50:10 +01002406 mbedtls_cipher_get_cipher_mode(&transform->cipher_ctx_enc)
Gilles Peskinee108d982022-04-26 16:50:40 +02002407#endif
2408 );
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002409
Gilles Peskinee108d982022-04-26 16:50:40 +02002410 int encrypt_then_mac = 0;
Neil Armstrongf2c82f02022-04-05 11:16:53 +02002411#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskinee108d982022-04-26 16:50:40 +02002412 encrypt_then_mac = transform->encrypt_then_mac;
2413#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002414 return mbedtls_ssl_get_actual_mode(base_mode, encrypt_then_mac);
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002415}
2416
Neil Armstrongab555e02022-04-04 11:07:59 +02002417mbedtls_ssl_mode_t mbedtls_ssl_get_mode_from_ciphersuite(
Neil Armstrongf2c82f02022-04-05 11:16:53 +02002418#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01002419 int encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02002420#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01002421 const mbedtls_ssl_ciphersuite_t *suite)
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002422{
Gilles Peskinee108d982022-04-26 16:50:40 +02002423 mbedtls_ssl_mode_t base_mode = MBEDTLS_SSL_MODE_STREAM;
2424
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002425#if defined(MBEDTLS_USE_PSA_CRYPTO)
2426 psa_status_t status;
2427 psa_algorithm_t alg;
2428 psa_key_type_t type;
2429 size_t size;
Dave Rodgman2eab4622023-10-05 13:30:37 +01002430 status = mbedtls_ssl_cipher_to_psa((mbedtls_cipher_type_t) suite->cipher,
2431 0, &alg, &type, &size);
Gilles Peskine449bd832023-01-11 14:50:10 +01002432 if (status == PSA_SUCCESS) {
2433 base_mode = mbedtls_ssl_get_base_mode(alg);
2434 }
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002435#else
2436 const mbedtls_cipher_info_t *cipher =
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01002437 mbedtls_cipher_info_from_type((mbedtls_cipher_type_t) suite->cipher);
Gilles Peskine449bd832023-01-11 14:50:10 +01002438 if (cipher != NULL) {
Gilles Peskinee108d982022-04-26 16:50:40 +02002439 base_mode =
2440 mbedtls_ssl_get_base_mode(
Gilles Peskine449bd832023-01-11 14:50:10 +01002441 mbedtls_cipher_info_get_mode(cipher));
Gilles Peskinee108d982022-04-26 16:50:40 +02002442 }
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002443#endif /* MBEDTLS_USE_PSA_CRYPTO */
2444
Gilles Peskinee108d982022-04-26 16:50:40 +02002445#if !defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
2446 int encrypt_then_mac = 0;
2447#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002448 return mbedtls_ssl_get_actual_mode(base_mode, encrypt_then_mac);
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002449}
2450
Neil Armstrong8395d7a2022-05-18 11:44:56 +02002451#if defined(MBEDTLS_USE_PSA_CRYPTO) || defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yu251a12e2022-07-13 15:15:48 +08002452
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00002453
Gilles Peskine449bd832023-01-11 14:50:10 +01002454psa_status_t mbedtls_ssl_cipher_to_psa(mbedtls_cipher_type_t mbedtls_cipher_type,
2455 size_t taglen,
2456 psa_algorithm_t *alg,
2457 psa_key_type_t *key_type,
2458 size_t *key_size)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002459{
Yanray Wang19e4dc82023-11-16 18:02:05 +08002460#if !defined(MBEDTLS_SSL_HAVE_CCM)
2461 (void) taglen;
2462#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002463 switch (mbedtls_cipher_type) {
Yanray Wang1a369d62023-11-16 15:17:31 +08002464#if defined(MBEDTLS_SSL_HAVE_AES) && defined(MBEDTLS_SSL_HAVE_CBC)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002465 case MBEDTLS_CIPHER_AES_128_CBC:
2466 *alg = PSA_ALG_CBC_NO_PADDING;
2467 *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_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002472 case MBEDTLS_CIPHER_AES_128_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002473 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002474 *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_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002479 case MBEDTLS_CIPHER_AES_128_GCM:
2480 *alg = PSA_ALG_GCM;
2481 *key_type = PSA_KEY_TYPE_AES;
2482 *key_size = 128;
2483 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002484#endif
2485#if defined(MBEDTLS_SSL_HAVE_AES) && defined(MBEDTLS_SSL_HAVE_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002486 case MBEDTLS_CIPHER_AES_192_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002487 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002488 *key_type = PSA_KEY_TYPE_AES;
2489 *key_size = 192;
2490 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002491#endif
2492#if defined(MBEDTLS_SSL_HAVE_AES) && defined(MBEDTLS_SSL_HAVE_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002493 case MBEDTLS_CIPHER_AES_192_GCM:
2494 *alg = PSA_ALG_GCM;
2495 *key_type = PSA_KEY_TYPE_AES;
2496 *key_size = 192;
2497 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002498#endif
2499#if defined(MBEDTLS_SSL_HAVE_AES) && defined(MBEDTLS_SSL_HAVE_CBC)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002500 case MBEDTLS_CIPHER_AES_256_CBC:
2501 *alg = PSA_ALG_CBC_NO_PADDING;
2502 *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_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002507 case MBEDTLS_CIPHER_AES_256_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002508 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002509 *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_AES) && defined(MBEDTLS_SSL_HAVE_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002514 case MBEDTLS_CIPHER_AES_256_GCM:
2515 *alg = PSA_ALG_GCM;
2516 *key_type = PSA_KEY_TYPE_AES;
2517 *key_size = 256;
2518 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002519#endif
2520#if defined(MBEDTLS_SSL_HAVE_ARIA) && defined(MBEDTLS_SSL_HAVE_CBC)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002521 case MBEDTLS_CIPHER_ARIA_128_CBC:
2522 *alg = PSA_ALG_CBC_NO_PADDING;
2523 *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_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002528 case MBEDTLS_CIPHER_ARIA_128_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002529 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002530 *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_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002535 case MBEDTLS_CIPHER_ARIA_128_GCM:
2536 *alg = PSA_ALG_GCM;
2537 *key_type = PSA_KEY_TYPE_ARIA;
2538 *key_size = 128;
2539 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002540#endif
2541#if defined(MBEDTLS_SSL_HAVE_ARIA) && defined(MBEDTLS_SSL_HAVE_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002542 case MBEDTLS_CIPHER_ARIA_192_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002543 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002544 *key_type = PSA_KEY_TYPE_ARIA;
2545 *key_size = 192;
2546 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002547#endif
2548#if defined(MBEDTLS_SSL_HAVE_ARIA) && defined(MBEDTLS_SSL_HAVE_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002549 case MBEDTLS_CIPHER_ARIA_192_GCM:
2550 *alg = PSA_ALG_GCM;
2551 *key_type = PSA_KEY_TYPE_ARIA;
2552 *key_size = 192;
2553 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002554#endif
2555#if defined(MBEDTLS_SSL_HAVE_ARIA) && defined(MBEDTLS_SSL_HAVE_CBC)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002556 case MBEDTLS_CIPHER_ARIA_256_CBC:
2557 *alg = PSA_ALG_CBC_NO_PADDING;
2558 *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_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002563 case MBEDTLS_CIPHER_ARIA_256_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002564 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002565 *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_ARIA) && defined(MBEDTLS_SSL_HAVE_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002570 case MBEDTLS_CIPHER_ARIA_256_GCM:
2571 *alg = PSA_ALG_GCM;
2572 *key_type = PSA_KEY_TYPE_ARIA;
2573 *key_size = 256;
2574 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002575#endif
2576#if defined(MBEDTLS_SSL_HAVE_CAMELLIA) && defined(MBEDTLS_SSL_HAVE_CBC)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002577 case MBEDTLS_CIPHER_CAMELLIA_128_CBC:
2578 *alg = PSA_ALG_CBC_NO_PADDING;
2579 *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_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002584 case MBEDTLS_CIPHER_CAMELLIA_128_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002585 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002586 *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_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002591 case MBEDTLS_CIPHER_CAMELLIA_128_GCM:
2592 *alg = PSA_ALG_GCM;
2593 *key_type = PSA_KEY_TYPE_CAMELLIA;
2594 *key_size = 128;
2595 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002596#endif
2597#if defined(MBEDTLS_SSL_HAVE_CAMELLIA) && defined(MBEDTLS_SSL_HAVE_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002598 case MBEDTLS_CIPHER_CAMELLIA_192_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002599 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002600 *key_type = PSA_KEY_TYPE_CAMELLIA;
2601 *key_size = 192;
2602 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002603#endif
2604#if defined(MBEDTLS_SSL_HAVE_CAMELLIA) && defined(MBEDTLS_SSL_HAVE_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002605 case MBEDTLS_CIPHER_CAMELLIA_192_GCM:
2606 *alg = PSA_ALG_GCM;
2607 *key_type = PSA_KEY_TYPE_CAMELLIA;
2608 *key_size = 192;
2609 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002610#endif
2611#if defined(MBEDTLS_SSL_HAVE_CAMELLIA) && defined(MBEDTLS_SSL_HAVE_CBC)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002612 case MBEDTLS_CIPHER_CAMELLIA_256_CBC:
2613 *alg = PSA_ALG_CBC_NO_PADDING;
2614 *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_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002619 case MBEDTLS_CIPHER_CAMELLIA_256_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002620 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002621 *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_CAMELLIA) && defined(MBEDTLS_SSL_HAVE_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002626 case MBEDTLS_CIPHER_CAMELLIA_256_GCM:
2627 *alg = PSA_ALG_GCM;
2628 *key_type = PSA_KEY_TYPE_CAMELLIA;
2629 *key_size = 256;
2630 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002631#endif
2632#if defined(MBEDTLS_SSL_HAVE_CHACHAPOLY)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002633 case MBEDTLS_CIPHER_CHACHA20_POLY1305:
2634 *alg = PSA_ALG_CHACHA20_POLY1305;
2635 *key_type = PSA_KEY_TYPE_CHACHA20;
2636 *key_size = 256;
2637 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002638#endif
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002639 case MBEDTLS_CIPHER_NULL:
2640 *alg = MBEDTLS_SSL_NULL_CIPHER;
2641 *key_type = 0;
2642 *key_size = 0;
2643 break;
2644 default:
2645 return PSA_ERROR_NOT_SUPPORTED;
2646 }
2647
2648 return PSA_SUCCESS;
2649}
Neil Armstrong8395d7a2022-05-18 11:44:56 +02002650#endif /* MBEDTLS_USE_PSA_CRYPTO || MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002651
Manuel Pégourié-Gonnardcf141ca2015-05-20 10:35:51 +02002652#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002653int mbedtls_ssl_conf_dh_param_bin(mbedtls_ssl_config *conf,
2654 const unsigned char *dhm_P, size_t P_len,
2655 const unsigned char *dhm_G, size_t G_len)
Hanno Beckera90658f2017-10-04 15:29:08 +01002656{
Janos Follath865b3eb2019-12-16 11:46:15 +00002657 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Beckera90658f2017-10-04 15:29:08 +01002658
Gilles Peskine449bd832023-01-11 14:50:10 +01002659 mbedtls_mpi_free(&conf->dhm_P);
2660 mbedtls_mpi_free(&conf->dhm_G);
Glenn Strausscee11292021-12-20 01:43:17 -05002661
Gilles Peskine449bd832023-01-11 14:50:10 +01002662 if ((ret = mbedtls_mpi_read_binary(&conf->dhm_P, dhm_P, P_len)) != 0 ||
2663 (ret = mbedtls_mpi_read_binary(&conf->dhm_G, dhm_G, G_len)) != 0) {
2664 mbedtls_mpi_free(&conf->dhm_P);
2665 mbedtls_mpi_free(&conf->dhm_G);
2666 return ret;
Hanno Beckera90658f2017-10-04 15:29:08 +01002667 }
2668
Gilles Peskine449bd832023-01-11 14:50:10 +01002669 return 0;
Hanno Beckera90658f2017-10-04 15:29:08 +01002670}
Paul Bakker5121ce52009-01-03 21:22:43 +00002671
Gilles Peskine449bd832023-01-11 14:50:10 +01002672int mbedtls_ssl_conf_dh_param_ctx(mbedtls_ssl_config *conf, mbedtls_dhm_context *dhm_ctx)
Paul Bakker1b57b062011-01-06 15:48:19 +00002673{
Janos Follath865b3eb2019-12-16 11:46:15 +00002674 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker1b57b062011-01-06 15:48:19 +00002675
Gilles Peskine449bd832023-01-11 14:50:10 +01002676 mbedtls_mpi_free(&conf->dhm_P);
2677 mbedtls_mpi_free(&conf->dhm_G);
Glenn Strausscee11292021-12-20 01:43:17 -05002678
Gilles Peskine449bd832023-01-11 14:50:10 +01002679 if ((ret = mbedtls_dhm_get_value(dhm_ctx, MBEDTLS_DHM_PARAM_P,
2680 &conf->dhm_P)) != 0 ||
2681 (ret = mbedtls_dhm_get_value(dhm_ctx, MBEDTLS_DHM_PARAM_G,
2682 &conf->dhm_G)) != 0) {
2683 mbedtls_mpi_free(&conf->dhm_P);
2684 mbedtls_mpi_free(&conf->dhm_G);
2685 return ret;
Manuel Pégourié-Gonnard1028b742015-05-06 17:33:07 +01002686 }
Paul Bakker1b57b062011-01-06 15:48:19 +00002687
Gilles Peskine449bd832023-01-11 14:50:10 +01002688 return 0;
Paul Bakker1b57b062011-01-06 15:48:19 +00002689}
Manuel Pégourié-Gonnardcf141ca2015-05-20 10:35:51 +02002690#endif /* MBEDTLS_DHM_C && MBEDTLS_SSL_SRV_C */
Paul Bakker1b57b062011-01-06 15:48:19 +00002691
Manuel Pégourié-Gonnardbd990d62015-06-11 14:49:42 +02002692#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_CLI_C)
2693/*
2694 * Set the minimum length for Diffie-Hellman parameters
2695 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002696void mbedtls_ssl_conf_dhm_min_bitlen(mbedtls_ssl_config *conf,
2697 unsigned int bitlen)
Manuel Pégourié-Gonnardbd990d62015-06-11 14:49:42 +02002698{
2699 conf->dhm_min_bitlen = bitlen;
2700}
2701#endif /* MBEDTLS_DHM_C && MBEDTLS_SSL_CLI_C */
2702
Ronald Crone68ab4f2022-10-05 12:46:29 +02002703#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu7ddc38c2022-01-19 11:08:05 +08002704#if !defined(MBEDTLS_DEPRECATED_REMOVED) && defined(MBEDTLS_SSL_PROTO_TLS1_2)
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02002705/*
2706 * Set allowed/preferred hashes for handshake signatures
2707 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002708void mbedtls_ssl_conf_sig_hashes(mbedtls_ssl_config *conf,
2709 const int *hashes)
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02002710{
2711 conf->sig_hashes = hashes;
2712}
Jerry Yu7ddc38c2022-01-19 11:08:05 +08002713#endif /* !MBEDTLS_DEPRECATED_REMOVED && MBEDTLS_SSL_PROTO_TLS1_2 */
Hanno Becker1cd6e002021-08-10 13:27:10 +01002714
Jerry Yuf017ee42022-01-12 15:49:48 +08002715/* Configure allowed signature algorithms for handshake */
Gilles Peskine449bd832023-01-11 14:50:10 +01002716void mbedtls_ssl_conf_sig_algs(mbedtls_ssl_config *conf,
2717 const uint16_t *sig_algs)
Hanno Becker1cd6e002021-08-10 13:27:10 +01002718{
Jerry Yuf017ee42022-01-12 15:49:48 +08002719#if !defined(MBEDTLS_DEPRECATED_REMOVED)
2720 conf->sig_hashes = NULL;
2721#endif /* !MBEDTLS_DEPRECATED_REMOVED */
2722 conf->sig_algs = sig_algs;
Hanno Becker1cd6e002021-08-10 13:27:10 +01002723}
Ronald Crone68ab4f2022-10-05 12:46:29 +02002724#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02002725
Manuel Pégourié-Gonnardf07ce3b2023-09-22 11:53:41 +02002726#if defined(MBEDTLS_ECP_C)
Brett Warrene0edc842021-08-17 09:53:13 +01002727#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002728/*
2729 * Set the allowed elliptic curves
Brett Warrene0edc842021-08-17 09:53:13 +01002730 *
2731 * mbedtls_ssl_setup() takes the provided list
2732 * and translates it to a list of IANA TLS group identifiers,
2733 * stored in ssl->handshake->group_list.
2734 *
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002735 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002736void mbedtls_ssl_conf_curves(mbedtls_ssl_config *conf,
2737 const mbedtls_ecp_group_id *curve_list)
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002738{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002739 conf->curve_list = curve_list;
Brett Warrene0edc842021-08-17 09:53:13 +01002740 conf->group_list = NULL;
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002741}
Brett Warrene0edc842021-08-17 09:53:13 +01002742#endif /* MBEDTLS_DEPRECATED_REMOVED */
Manuel Pégourié-Gonnardf07ce3b2023-09-22 11:53:41 +02002743#endif /* MBEDTLS_ECP_C */
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002744
Brett Warrene0edc842021-08-17 09:53:13 +01002745/*
2746 * Set the allowed groups
2747 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002748void mbedtls_ssl_conf_groups(mbedtls_ssl_config *conf,
2749 const uint16_t *group_list)
Brett Warrene0edc842021-08-17 09:53:13 +01002750{
Manuel Pégourié-Gonnardf07ce3b2023-09-22 11:53:41 +02002751#if defined(MBEDTLS_ECP_C) && !defined(MBEDTLS_DEPRECATED_REMOVED)
Brett Warrene0edc842021-08-17 09:53:13 +01002752 conf->curve_list = NULL;
2753#endif
2754 conf->group_list = group_list;
2755}
2756
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01002757#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002758int mbedtls_ssl_set_hostname(mbedtls_ssl_context *ssl, const char *hostname)
Paul Bakker5121ce52009-01-03 21:22:43 +00002759{
Hanno Becker947194e2017-04-07 13:25:49 +01002760 /* Initialize to suppress unnecessary compiler warning */
2761 size_t hostname_len = 0;
2762
2763 /* Check if new hostname is valid before
2764 * making any change to current one */
Gilles Peskine449bd832023-01-11 14:50:10 +01002765 if (hostname != NULL) {
2766 hostname_len = strlen(hostname);
Hanno Becker947194e2017-04-07 13:25:49 +01002767
Gilles Peskine449bd832023-01-11 14:50:10 +01002768 if (hostname_len > MBEDTLS_SSL_MAX_HOST_NAME_LEN) {
2769 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2770 }
Hanno Becker947194e2017-04-07 13:25:49 +01002771 }
2772
2773 /* Now it's clear that we will overwrite the old hostname,
2774 * so we can free it safely */
2775
Gilles Peskine449bd832023-01-11 14:50:10 +01002776 if (ssl->hostname != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01002777 mbedtls_zeroize_and_free(ssl->hostname, strlen(ssl->hostname));
Hanno Becker947194e2017-04-07 13:25:49 +01002778 }
2779
2780 /* Passing NULL as hostname shall clear the old one */
Manuel Pégourié-Gonnardba26c242015-05-06 10:47:06 +01002781
Gilles Peskine449bd832023-01-11 14:50:10 +01002782 if (hostname == NULL) {
Hanno Becker947194e2017-04-07 13:25:49 +01002783 ssl->hostname = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01002784 } else {
2785 ssl->hostname = mbedtls_calloc(1, hostname_len + 1);
2786 if (ssl->hostname == NULL) {
2787 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
2788 }
Paul Bakker75c1a6f2013-08-19 14:25:29 +02002789
Gilles Peskine449bd832023-01-11 14:50:10 +01002790 memcpy(ssl->hostname, hostname, hostname_len);
Paul Bakker75c1a6f2013-08-19 14:25:29 +02002791
Hanno Becker947194e2017-04-07 13:25:49 +01002792 ssl->hostname[hostname_len] = '\0';
2793 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002794
Gilles Peskine449bd832023-01-11 14:50:10 +01002795 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00002796}
Hanno Becker1a9a51c2017-04-07 13:02:16 +01002797#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00002798
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01002799#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01002800void mbedtls_ssl_conf_sni(mbedtls_ssl_config *conf,
2801 int (*f_sni)(void *, mbedtls_ssl_context *,
2802 const unsigned char *, size_t),
2803 void *p_sni)
Paul Bakker5701cdc2012-09-27 21:49:42 +00002804{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002805 conf->f_sni = f_sni;
2806 conf->p_sni = p_sni;
Paul Bakker5701cdc2012-09-27 21:49:42 +00002807}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002808#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
Paul Bakker5701cdc2012-09-27 21:49:42 +00002809
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002810#if defined(MBEDTLS_SSL_ALPN)
Gilles Peskine449bd832023-01-11 14:50:10 +01002811int mbedtls_ssl_conf_alpn_protocols(mbedtls_ssl_config *conf, const char **protos)
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002812{
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002813 size_t cur_len, tot_len;
2814 const char **p;
2815
2816 /*
Brian J Murray1903fb32016-11-06 04:45:15 -08002817 * RFC 7301 3.1: "Empty strings MUST NOT be included and byte strings
2818 * MUST NOT be truncated."
2819 * We check lengths now rather than later.
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002820 */
2821 tot_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01002822 for (p = protos; *p != NULL; p++) {
2823 cur_len = strlen(*p);
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002824 tot_len += cur_len;
2825
Gilles Peskine449bd832023-01-11 14:50:10 +01002826 if ((cur_len == 0) ||
2827 (cur_len > MBEDTLS_SSL_MAX_ALPN_NAME_LEN) ||
2828 (tot_len > MBEDTLS_SSL_MAX_ALPN_LIST_LEN)) {
2829 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2830 }
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002831 }
2832
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002833 conf->alpn_list = protos;
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002834
Gilles Peskine449bd832023-01-11 14:50:10 +01002835 return 0;
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002836}
2837
Gilles Peskine449bd832023-01-11 14:50:10 +01002838const char *mbedtls_ssl_get_alpn_protocol(const mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002839{
Gilles Peskine449bd832023-01-11 14:50:10 +01002840 return ssl->alpn_chosen;
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002841}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002842#endif /* MBEDTLS_SSL_ALPN */
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002843
Johan Pascalb62bb512015-12-03 21:56:45 +01002844#if defined(MBEDTLS_SSL_DTLS_SRTP)
Gilles Peskine449bd832023-01-11 14:50:10 +01002845void mbedtls_ssl_conf_srtp_mki_value_supported(mbedtls_ssl_config *conf,
2846 int support_mki_value)
Ron Eldor591f1622018-01-22 12:30:04 +02002847{
2848 conf->dtls_srtp_mki_support = support_mki_value;
2849}
2850
Gilles Peskine449bd832023-01-11 14:50:10 +01002851int mbedtls_ssl_dtls_srtp_set_mki_value(mbedtls_ssl_context *ssl,
2852 unsigned char *mki_value,
2853 uint16_t mki_len)
Ron Eldor591f1622018-01-22 12:30:04 +02002854{
Gilles Peskine449bd832023-01-11 14:50:10 +01002855 if (mki_len > MBEDTLS_TLS_SRTP_MAX_MKI_LENGTH) {
2856 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Ron Eldora9788042018-12-05 11:04:31 +02002857 }
Ron Eldor591f1622018-01-22 12:30:04 +02002858
Gilles Peskine449bd832023-01-11 14:50:10 +01002859 if (ssl->conf->dtls_srtp_mki_support == MBEDTLS_SSL_DTLS_SRTP_MKI_UNSUPPORTED) {
2860 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Ron Eldora9788042018-12-05 11:04:31 +02002861 }
Ron Eldor591f1622018-01-22 12:30:04 +02002862
Gilles Peskine449bd832023-01-11 14:50:10 +01002863 memcpy(ssl->dtls_srtp_info.mki_value, mki_value, mki_len);
Ron Eldor591f1622018-01-22 12:30:04 +02002864 ssl->dtls_srtp_info.mki_len = mki_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01002865 return 0;
Ron Eldor591f1622018-01-22 12:30:04 +02002866}
2867
Gilles Peskine449bd832023-01-11 14:50:10 +01002868int mbedtls_ssl_conf_dtls_srtp_protection_profiles(mbedtls_ssl_config *conf,
2869 const mbedtls_ssl_srtp_profile *profiles)
Johan Pascalb62bb512015-12-03 21:56:45 +01002870{
Johan Pascal253d0262020-09-22 13:04:45 +02002871 const mbedtls_ssl_srtp_profile *p;
2872 size_t list_size = 0;
Johan Pascalb62bb512015-12-03 21:56:45 +01002873
Johan Pascal253d0262020-09-22 13:04:45 +02002874 /* check the profiles list: all entry must be valid,
2875 * its size cannot be more than the total number of supported profiles, currently 4 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002876 for (p = profiles; *p != MBEDTLS_TLS_SRTP_UNSET &&
2877 list_size <= MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH;
2878 p++) {
2879 if (mbedtls_ssl_check_srtp_profile_value(*p) != MBEDTLS_TLS_SRTP_UNSET) {
Johan Pascal76fdf1d2020-10-22 23:31:00 +02002880 list_size++;
Gilles Peskine449bd832023-01-11 14:50:10 +01002881 } else {
Johan Pascal76fdf1d2020-10-22 23:31:00 +02002882 /* unsupported value, stop parsing and set the size to an error value */
2883 list_size = MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH + 1;
Johan Pascalb62bb512015-12-03 21:56:45 +01002884 }
2885 }
2886
Gilles Peskine449bd832023-01-11 14:50:10 +01002887 if (list_size > MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH) {
2888 conf->dtls_srtp_profile_list = NULL;
2889 conf->dtls_srtp_profile_list_len = 0;
2890 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Johan Pascal253d0262020-09-22 13:04:45 +02002891 }
2892
Johan Pascal9bc97ca2020-09-21 23:44:45 +02002893 conf->dtls_srtp_profile_list = profiles;
Johan Pascal253d0262020-09-22 13:04:45 +02002894 conf->dtls_srtp_profile_list_len = list_size;
Johan Pascalb62bb512015-12-03 21:56:45 +01002895
Gilles Peskine449bd832023-01-11 14:50:10 +01002896 return 0;
Johan Pascalb62bb512015-12-03 21:56:45 +01002897}
2898
Gilles Peskine449bd832023-01-11 14:50:10 +01002899void mbedtls_ssl_get_dtls_srtp_negotiation_result(const mbedtls_ssl_context *ssl,
2900 mbedtls_dtls_srtp_info *dtls_srtp_info)
Johan Pascalb62bb512015-12-03 21:56:45 +01002901{
Johan Pascal2258a4f2020-10-28 13:53:09 +01002902 dtls_srtp_info->chosen_dtls_srtp_profile = ssl->dtls_srtp_info.chosen_dtls_srtp_profile;
2903 /* do not copy the mki value if there is no chosen profile */
Gilles Peskine449bd832023-01-11 14:50:10 +01002904 if (dtls_srtp_info->chosen_dtls_srtp_profile == MBEDTLS_TLS_SRTP_UNSET) {
Johan Pascal2258a4f2020-10-28 13:53:09 +01002905 dtls_srtp_info->mki_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01002906 } else {
Johan Pascal2258a4f2020-10-28 13:53:09 +01002907 dtls_srtp_info->mki_len = ssl->dtls_srtp_info.mki_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01002908 memcpy(dtls_srtp_info->mki_value, ssl->dtls_srtp_info.mki_value,
2909 ssl->dtls_srtp_info.mki_len);
Johan Pascal2258a4f2020-10-28 13:53:09 +01002910 }
Johan Pascalb62bb512015-12-03 21:56:45 +01002911}
Johan Pascalb62bb512015-12-03 21:56:45 +01002912#endif /* MBEDTLS_SSL_DTLS_SRTP */
2913
Aditya Patwardhan3096f332022-07-26 14:31:46 +05302914#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Gilles Peskine449bd832023-01-11 14:50:10 +01002915void mbedtls_ssl_conf_max_version(mbedtls_ssl_config *conf, int major, int minor)
Paul Bakker490ecc82011-10-06 13:04:09 +00002916{
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01002917 conf->max_tls_version = (mbedtls_ssl_protocol_version) ((major << 8) | minor);
Paul Bakker490ecc82011-10-06 13:04:09 +00002918}
2919
Gilles Peskine449bd832023-01-11 14:50:10 +01002920void mbedtls_ssl_conf_min_version(mbedtls_ssl_config *conf, int major, int minor)
Paul Bakker1d29fb52012-09-28 13:28:45 +00002921{
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01002922 conf->min_tls_version = (mbedtls_ssl_protocol_version) ((major << 8) | minor);
Paul Bakker1d29fb52012-09-28 13:28:45 +00002923}
Aditya Patwardhan3096f332022-07-26 14:31:46 +05302924#endif /* MBEDTLS_DEPRECATED_REMOVED */
Paul Bakker1d29fb52012-09-28 13:28:45 +00002925
Janos Follath088ce432017-04-10 12:42:31 +01002926#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002927void mbedtls_ssl_conf_cert_req_ca_list(mbedtls_ssl_config *conf,
2928 char cert_req_ca_list)
Janos Follath088ce432017-04-10 12:42:31 +01002929{
2930 conf->cert_req_ca_list = cert_req_ca_list;
2931}
2932#endif
2933
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002934#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01002935void mbedtls_ssl_conf_encrypt_then_mac(mbedtls_ssl_config *conf, char etm)
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01002936{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002937 conf->encrypt_then_mac = etm;
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01002938}
2939#endif
2940
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002941#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
Gilles Peskine449bd832023-01-11 14:50:10 +01002942void mbedtls_ssl_conf_extended_master_secret(mbedtls_ssl_config *conf, char ems)
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02002943{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002944 conf->extended_ms = ems;
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02002945}
2946#endif
2947
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002948#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01002949int mbedtls_ssl_conf_max_frag_len(mbedtls_ssl_config *conf, unsigned char mfl_code)
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002950{
Gilles Peskine449bd832023-01-11 14:50:10 +01002951 if (mfl_code >= MBEDTLS_SSL_MAX_FRAG_LEN_INVALID ||
2952 ssl_mfl_code_to_length(mfl_code) > MBEDTLS_TLS_EXT_ADV_CONTENT_LEN) {
2953 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002954 }
2955
Manuel Pégourié-Gonnard6bf89d62015-05-05 17:01:57 +01002956 conf->mfl_code = mfl_code;
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002957
Gilles Peskine449bd832023-01-11 14:50:10 +01002958 return 0;
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002959}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002960#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002961
Gilles Peskine449bd832023-01-11 14:50:10 +01002962void mbedtls_ssl_conf_legacy_renegotiation(mbedtls_ssl_config *conf, int allow_legacy)
Paul Bakker48916f92012-09-16 19:57:18 +00002963{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002964 conf->allow_legacy_renegotiation = allow_legacy;
Paul Bakker48916f92012-09-16 19:57:18 +00002965}
2966
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002967#if defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01002968void mbedtls_ssl_conf_renegotiation(mbedtls_ssl_config *conf, int renegotiation)
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01002969{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002970 conf->disable_renegotiation = renegotiation;
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01002971}
2972
Gilles Peskine449bd832023-01-11 14:50:10 +01002973void mbedtls_ssl_conf_renegotiation_enforced(mbedtls_ssl_config *conf, int max_records)
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02002974{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002975 conf->renego_max_records = max_records;
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02002976}
2977
Gilles Peskine449bd832023-01-11 14:50:10 +01002978void mbedtls_ssl_conf_renegotiation_period(mbedtls_ssl_config *conf,
2979 const unsigned char period[8])
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01002980{
Gilles Peskine449bd832023-01-11 14:50:10 +01002981 memcpy(conf->renego_period, period, 8);
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01002982}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002983#endif /* MBEDTLS_SSL_RENEGOTIATION */
Paul Bakker5121ce52009-01-03 21:22:43 +00002984
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002985#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02002986#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002987void mbedtls_ssl_conf_session_tickets(mbedtls_ssl_config *conf, int use_tickets)
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02002988{
Manuel Pégourié-Gonnard2b494452015-05-06 10:05:11 +01002989 conf->session_tickets = use_tickets;
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02002990}
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02002991#endif
Paul Bakker606b4ba2013-08-14 16:52:14 +02002992
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02002993#if defined(MBEDTLS_SSL_SRV_C)
Jerry Yu1ad7ace2022-08-09 13:28:39 +08002994
Jerry Yud0766ec2022-09-22 10:46:57 +08002995#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Gilles Peskine449bd832023-01-11 14:50:10 +01002996void mbedtls_ssl_conf_new_session_tickets(mbedtls_ssl_config *conf,
2997 uint16_t num_tickets)
Jerry Yu1ad7ace2022-08-09 13:28:39 +08002998{
Jerry Yud0766ec2022-09-22 10:46:57 +08002999 conf->new_session_tickets_count = num_tickets;
Jerry Yu1ad7ace2022-08-09 13:28:39 +08003000}
3001#endif
3002
Gilles Peskine449bd832023-01-11 14:50:10 +01003003void mbedtls_ssl_conf_session_tickets_cb(mbedtls_ssl_config *conf,
3004 mbedtls_ssl_ticket_write_t *f_ticket_write,
3005 mbedtls_ssl_ticket_parse_t *f_ticket_parse,
3006 void *p_ticket)
Paul Bakker606b4ba2013-08-14 16:52:14 +02003007{
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02003008 conf->f_ticket_write = f_ticket_write;
3009 conf->f_ticket_parse = f_ticket_parse;
3010 conf->p_ticket = p_ticket;
Paul Bakker606b4ba2013-08-14 16:52:14 +02003011}
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02003012#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003013#endif /* MBEDTLS_SSL_SESSION_TICKETS */
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02003014
Gilles Peskine449bd832023-01-11 14:50:10 +01003015void mbedtls_ssl_set_export_keys_cb(mbedtls_ssl_context *ssl,
3016 mbedtls_ssl_export_keys_t *f_export_keys,
3017 void *p_export_keys)
Robert Cragie4feb7ae2015-10-02 13:33:37 +01003018{
Hanno Becker7e6c1782021-06-08 09:24:55 +01003019 ssl->f_export_keys = f_export_keys;
3020 ssl->p_export_keys = p_export_keys;
Ron Eldorf5cc10d2019-05-07 18:33:40 +03003021}
Robert Cragie4feb7ae2015-10-02 13:33:37 +01003022
Gilles Peskineb74a1c72018-04-24 13:09:22 +02003023#if defined(MBEDTLS_SSL_ASYNC_PRIVATE)
Gilles Peskine8bf79f62018-01-05 21:11:53 +01003024void mbedtls_ssl_conf_async_private_cb(
3025 mbedtls_ssl_config *conf,
3026 mbedtls_ssl_async_sign_t *f_async_sign,
3027 mbedtls_ssl_async_decrypt_t *f_async_decrypt,
3028 mbedtls_ssl_async_resume_t *f_async_resume,
3029 mbedtls_ssl_async_cancel_t *f_async_cancel,
Gilles Peskine449bd832023-01-11 14:50:10 +01003030 void *async_config_data)
Gilles Peskine8bf79f62018-01-05 21:11:53 +01003031{
3032 conf->f_async_sign_start = f_async_sign;
3033 conf->f_async_decrypt_start = f_async_decrypt;
3034 conf->f_async_resume = f_async_resume;
3035 conf->f_async_cancel = f_async_cancel;
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003036 conf->p_async_config_data = async_config_data;
3037}
3038
Gilles Peskine449bd832023-01-11 14:50:10 +01003039void *mbedtls_ssl_conf_get_async_config_data(const mbedtls_ssl_config *conf)
Gilles Peskine8f97af72018-04-26 11:46:10 +02003040{
Gilles Peskine449bd832023-01-11 14:50:10 +01003041 return conf->p_async_config_data;
Gilles Peskine8f97af72018-04-26 11:46:10 +02003042}
3043
Gilles Peskine449bd832023-01-11 14:50:10 +01003044void *mbedtls_ssl_get_async_operation_data(const mbedtls_ssl_context *ssl)
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003045{
Gilles Peskine449bd832023-01-11 14:50:10 +01003046 if (ssl->handshake == NULL) {
3047 return NULL;
3048 } else {
3049 return ssl->handshake->user_async_ctx;
3050 }
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003051}
3052
Gilles Peskine449bd832023-01-11 14:50:10 +01003053void mbedtls_ssl_set_async_operation_data(mbedtls_ssl_context *ssl,
3054 void *ctx)
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003055{
Gilles Peskine449bd832023-01-11 14:50:10 +01003056 if (ssl->handshake != NULL) {
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003057 ssl->handshake->user_async_ctx = ctx;
Gilles Peskine449bd832023-01-11 14:50:10 +01003058 }
Gilles Peskine8bf79f62018-01-05 21:11:53 +01003059}
Gilles Peskineb74a1c72018-04-24 13:09:22 +02003060#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
Gilles Peskine8bf79f62018-01-05 21:11:53 +01003061
Paul Bakker5121ce52009-01-03 21:22:43 +00003062/*
3063 * SSL get accessors
3064 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003065uint32_t mbedtls_ssl_get_verify_result(const mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00003066{
Gilles Peskine449bd832023-01-11 14:50:10 +01003067 if (ssl->session != NULL) {
3068 return ssl->session->verify_result;
3069 }
Manuel Pégourié-Gonnarde89163c2015-01-23 14:30:57 +00003070
Gilles Peskine449bd832023-01-11 14:50:10 +01003071 if (ssl->session_negotiate != NULL) {
3072 return ssl->session_negotiate->verify_result;
3073 }
Manuel Pégourié-Gonnarde89163c2015-01-23 14:30:57 +00003074
Gilles Peskine449bd832023-01-11 14:50:10 +01003075 return 0xFFFFFFFF;
Paul Bakker5121ce52009-01-03 21:22:43 +00003076}
3077
Gilles Peskine449bd832023-01-11 14:50:10 +01003078int mbedtls_ssl_get_ciphersuite_id_from_ssl(const mbedtls_ssl_context *ssl)
Glenn Strauss8f526902022-01-13 00:04:49 -05003079{
Gilles Peskine449bd832023-01-11 14:50:10 +01003080 if (ssl == NULL || ssl->session == NULL) {
3081 return 0;
3082 }
Glenn Strauss8f526902022-01-13 00:04:49 -05003083
Gilles Peskine449bd832023-01-11 14:50:10 +01003084 return ssl->session->ciphersuite;
Glenn Strauss8f526902022-01-13 00:04:49 -05003085}
3086
Gilles Peskine449bd832023-01-11 14:50:10 +01003087const char *mbedtls_ssl_get_ciphersuite(const mbedtls_ssl_context *ssl)
Paul Bakker72f62662011-01-16 21:27:44 +00003088{
Gilles Peskine449bd832023-01-11 14:50:10 +01003089 if (ssl == NULL || ssl->session == NULL) {
3090 return NULL;
3091 }
Paul Bakker926c8e42013-03-06 10:23:34 +01003092
Gilles Peskine449bd832023-01-11 14:50:10 +01003093 return mbedtls_ssl_get_ciphersuite_name(ssl->session->ciphersuite);
Paul Bakker72f62662011-01-16 21:27:44 +00003094}
3095
Gilles Peskine449bd832023-01-11 14:50:10 +01003096const char *mbedtls_ssl_get_version(const mbedtls_ssl_context *ssl)
Paul Bakker43ca69c2011-01-15 17:35:19 +00003097{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003098#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003099 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
3100 switch (ssl->tls_version) {
Glenn Strauss60bfe602022-03-14 19:04:24 -04003101 case MBEDTLS_SSL_VERSION_TLS1_2:
Gilles Peskine449bd832023-01-11 14:50:10 +01003102 return "DTLSv1.2";
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01003103 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01003104 return "unknown (DTLS)";
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01003105 }
3106 }
3107#endif
3108
Gilles Peskine449bd832023-01-11 14:50:10 +01003109 switch (ssl->tls_version) {
Glenn Strauss60bfe602022-03-14 19:04:24 -04003110 case MBEDTLS_SSL_VERSION_TLS1_2:
Gilles Peskine449bd832023-01-11 14:50:10 +01003111 return "TLSv1.2";
Glenn Strauss60bfe602022-03-14 19:04:24 -04003112 case MBEDTLS_SSL_VERSION_TLS1_3:
Gilles Peskine449bd832023-01-11 14:50:10 +01003113 return "TLSv1.3";
Paul Bakker43ca69c2011-01-15 17:35:19 +00003114 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01003115 return "unknown";
Paul Bakker43ca69c2011-01-15 17:35:19 +00003116 }
Paul Bakker43ca69c2011-01-15 17:35:19 +00003117}
3118
Waleed Elmelegy6a971fd2023-12-28 17:48:16 +00003119#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
3120
3121size_t mbedtls_ssl_get_output_record_size_limit(const mbedtls_ssl_context *ssl)
3122{
3123 const size_t max_len = MBEDTLS_SSL_OUT_CONTENT_LEN;
3124 size_t record_size_limit = max_len;
3125
3126 if (ssl->session != NULL &&
3127 ssl->session->record_size_limit >= MBEDTLS_SSL_RECORD_SIZE_LIMIT_MIN &&
3128 ssl->session->record_size_limit < max_len) {
3129 record_size_limit = ssl->session->record_size_limit;
3130 }
3131
3132 // TODO: this is currently untested
3133 /* During a handshake, use the value being negotiated */
3134 if (ssl->session_negotiate != NULL &&
3135 ssl->session_negotiate->record_size_limit >= MBEDTLS_SSL_RECORD_SIZE_LIMIT_MIN &&
3136 ssl->session_negotiate->record_size_limit < max_len) {
3137 record_size_limit = ssl->session_negotiate->record_size_limit;
3138 }
3139
3140 return record_size_limit;
3141}
3142#endif /* MBEDTLS_SSL_RECORD_SIZE_LIMIT */
3143
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02003144#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01003145size_t mbedtls_ssl_get_input_max_frag_len(const mbedtls_ssl_context *ssl)
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003146{
David Horstmann95d516f2021-05-04 18:36:56 +01003147 size_t max_len = MBEDTLS_SSL_IN_CONTENT_LEN;
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003148 size_t read_mfl;
3149
Jerry Yuddda0502022-12-01 19:43:12 +08003150#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003151 /* Use the configured MFL for the client if we're past SERVER_HELLO_DONE */
Gilles Peskine449bd832023-01-11 14:50:10 +01003152 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
3153 ssl->state >= MBEDTLS_SSL_SERVER_HELLO_DONE) {
3154 return ssl_mfl_code_to_length(ssl->conf->mfl_code);
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003155 }
Jerry Yuddda0502022-12-01 19:43:12 +08003156#endif
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003157
3158 /* Check if a smaller max length was negotiated */
Gilles Peskine449bd832023-01-11 14:50:10 +01003159 if (ssl->session_out != NULL) {
3160 read_mfl = ssl_mfl_code_to_length(ssl->session_out->mfl_code);
3161 if (read_mfl < max_len) {
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003162 max_len = read_mfl;
3163 }
3164 }
3165
Jerry Yuddda0502022-12-01 19:43:12 +08003166 /* During a handshake, use the value being negotiated */
Gilles Peskine449bd832023-01-11 14:50:10 +01003167 if (ssl->session_negotiate != NULL) {
3168 read_mfl = ssl_mfl_code_to_length(ssl->session_negotiate->mfl_code);
3169 if (read_mfl < max_len) {
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003170 max_len = read_mfl;
3171 }
3172 }
3173
Gilles Peskine449bd832023-01-11 14:50:10 +01003174 return max_len;
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003175}
3176
Gilles Peskine449bd832023-01-11 14:50:10 +01003177size_t mbedtls_ssl_get_output_max_frag_len(const mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02003178{
3179 size_t max_len;
3180
3181 /*
3182 * Assume mfl_code is correct since it was checked when set
3183 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003184 max_len = ssl_mfl_code_to_length(ssl->conf->mfl_code);
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02003185
Manuel Pégourié-Gonnard2cb17e22017-09-19 13:00:47 +02003186 /* Check if a smaller max length was negotiated */
Gilles Peskine449bd832023-01-11 14:50:10 +01003187 if (ssl->session_out != NULL &&
3188 ssl_mfl_code_to_length(ssl->session_out->mfl_code) < max_len) {
3189 max_len = ssl_mfl_code_to_length(ssl->session_out->mfl_code);
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02003190 }
3191
Manuel Pégourié-Gonnard2cb17e22017-09-19 13:00:47 +02003192 /* During a handshake, use the value being negotiated */
Gilles Peskine449bd832023-01-11 14:50:10 +01003193 if (ssl->session_negotiate != NULL &&
3194 ssl_mfl_code_to_length(ssl->session_negotiate->mfl_code) < max_len) {
3195 max_len = ssl_mfl_code_to_length(ssl->session_negotiate->mfl_code);
Manuel Pégourié-Gonnard2cb17e22017-09-19 13:00:47 +02003196 }
3197
Gilles Peskine449bd832023-01-11 14:50:10 +01003198 return max_len;
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02003199}
3200#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
3201
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003202#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003203size_t mbedtls_ssl_get_current_mtu(const mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003204{
Andrzej Kurekef43ce62018-10-09 08:24:12 -04003205 /* Return unlimited mtu for client hello messages to avoid fragmentation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01003206 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
3207 (ssl->state == MBEDTLS_SSL_CLIENT_HELLO ||
3208 ssl->state == MBEDTLS_SSL_SERVER_HELLO)) {
3209 return 0;
3210 }
Andrzej Kurekef43ce62018-10-09 08:24:12 -04003211
Gilles Peskine449bd832023-01-11 14:50:10 +01003212 if (ssl->handshake == NULL || ssl->handshake->mtu == 0) {
3213 return ssl->mtu;
3214 }
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003215
Gilles Peskine449bd832023-01-11 14:50:10 +01003216 if (ssl->mtu == 0) {
3217 return ssl->handshake->mtu;
3218 }
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003219
Gilles Peskine449bd832023-01-11 14:50:10 +01003220 return ssl->mtu < ssl->handshake->mtu ?
3221 ssl->mtu : ssl->handshake->mtu;
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003222}
3223#endif /* MBEDTLS_SSL_PROTO_DTLS */
3224
Gilles Peskine449bd832023-01-11 14:50:10 +01003225int mbedtls_ssl_get_max_out_record_payload(const mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003226{
3227 size_t max_len = MBEDTLS_SSL_OUT_CONTENT_LEN;
3228
Manuel Pégourié-Gonnard000281e2018-08-21 11:20:58 +02003229#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH) && \
Jan Brucknerf482dcc2023-03-15 09:09:06 +01003230 !defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT) && \
Manuel Pégourié-Gonnard000281e2018-08-21 11:20:58 +02003231 !defined(MBEDTLS_SSL_PROTO_DTLS)
3232 (void) ssl;
3233#endif
3234
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003235#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01003236 const size_t mfl = mbedtls_ssl_get_output_max_frag_len(ssl);
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003237
Gilles Peskine449bd832023-01-11 14:50:10 +01003238 if (max_len > mfl) {
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003239 max_len = mfl;
Gilles Peskine449bd832023-01-11 14:50:10 +01003240 }
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003241#endif
3242
Jan Brucknerf482dcc2023-03-15 09:09:06 +01003243#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
3244 const size_t record_size_limit = mbedtls_ssl_get_output_record_size_limit(ssl);
3245
3246 if (max_len > record_size_limit) {
3247 max_len = record_size_limit;
3248 }
3249#endif
3250
Waleed Elmelegy6a971fd2023-12-28 17:48:16 +00003251 if (ssl->transform_out != NULL &&
3252 ssl->transform_out->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Waleed Elmelegyf5017902024-01-09 14:18:34 +00003253 /*
3254 * In TLS 1.3 case, when records are protected, `max_len` as computed
3255 * above is the maximum length of the TLSInnerPlaintext structure that
3256 * along the plaintext payload contains the inner content type (one byte)
3257 * and some zero padding. Given the algorithm used for padding
3258 * in mbedtls_ssl_encrypt_buf(), compute the maximum length for
3259 * the plaintext payload. Round down to a multiple of
3260 * MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY and
3261 * subtract 1.
Waleed Elmelegy6a971fd2023-12-28 17:48:16 +00003262 */
3263 max_len = ((max_len / MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY) *
3264 MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY) - 1;
3265 }
3266
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003267#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003268 if (mbedtls_ssl_get_current_mtu(ssl) != 0) {
3269 const size_t mtu = mbedtls_ssl_get_current_mtu(ssl);
3270 const int ret = mbedtls_ssl_get_record_expansion(ssl);
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003271 const size_t overhead = (size_t) ret;
3272
Gilles Peskine449bd832023-01-11 14:50:10 +01003273 if (ret < 0) {
3274 return ret;
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003275 }
3276
Gilles Peskine449bd832023-01-11 14:50:10 +01003277 if (mtu <= overhead) {
3278 MBEDTLS_SSL_DEBUG_MSG(1, ("MTU too low for record expansion"));
3279 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
3280 }
3281
3282 if (max_len > mtu - overhead) {
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003283 max_len = mtu - overhead;
Gilles Peskine449bd832023-01-11 14:50:10 +01003284 }
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003285 }
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003286#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003287
Hanno Becker0defedb2018-08-10 12:35:02 +01003288#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH) && \
Waleed Elmelegy049cd302023-12-20 17:28:31 +00003289 !defined(MBEDTLS_SSL_PROTO_DTLS) && \
3290 !defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
Hanno Becker0defedb2018-08-10 12:35:02 +01003291 ((void) ssl);
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003292#endif
3293
Gilles Peskine449bd832023-01-11 14:50:10 +01003294 return (int) max_len;
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003295}
3296
Gilles Peskine449bd832023-01-11 14:50:10 +01003297int mbedtls_ssl_get_max_in_record_payload(const mbedtls_ssl_context *ssl)
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003298{
3299 size_t max_len = MBEDTLS_SSL_IN_CONTENT_LEN;
3300
3301#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
3302 (void) ssl;
3303#endif
3304
3305#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01003306 const size_t mfl = mbedtls_ssl_get_input_max_frag_len(ssl);
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003307
Gilles Peskine449bd832023-01-11 14:50:10 +01003308 if (max_len > mfl) {
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003309 max_len = mfl;
Gilles Peskine449bd832023-01-11 14:50:10 +01003310 }
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003311#endif
3312
Gilles Peskine449bd832023-01-11 14:50:10 +01003313 return (int) max_len;
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003314}
3315
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003316#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01003317const mbedtls_x509_crt *mbedtls_ssl_get_peer_cert(const mbedtls_ssl_context *ssl)
Paul Bakkerb0550d92012-10-30 07:51:03 +00003318{
Gilles Peskine449bd832023-01-11 14:50:10 +01003319 if (ssl == NULL || ssl->session == NULL) {
3320 return NULL;
3321 }
Paul Bakkerb0550d92012-10-30 07:51:03 +00003322
Hanno Beckere6824572019-02-07 13:18:46 +00003323#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01003324 return ssl->session->peer_cert;
Hanno Beckere6824572019-02-07 13:18:46 +00003325#else
Gilles Peskine449bd832023-01-11 14:50:10 +01003326 return NULL;
Hanno Beckere6824572019-02-07 13:18:46 +00003327#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Paul Bakkerb0550d92012-10-30 07:51:03 +00003328}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003329#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkerb0550d92012-10-30 07:51:03 +00003330
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003331#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01003332int mbedtls_ssl_get_session(const mbedtls_ssl_context *ssl,
3333 mbedtls_ssl_session *dst)
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003334{
Hanno Beckere810bbc2021-05-14 16:01:05 +01003335 int ret;
3336
Gilles Peskine449bd832023-01-11 14:50:10 +01003337 if (ssl == NULL ||
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003338 dst == NULL ||
3339 ssl->session == NULL ||
Gilles Peskine449bd832023-01-11 14:50:10 +01003340 ssl->conf->endpoint != MBEDTLS_SSL_IS_CLIENT) {
3341 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003342 }
3343
Hanno Beckere810bbc2021-05-14 16:01:05 +01003344 /* Since Mbed TLS 3.0, mbedtls_ssl_get_session() is no longer
3345 * idempotent: Each session can only be exported once.
3346 *
3347 * (This is in preparation for TLS 1.3 support where we will
3348 * need the ability to export multiple sessions (aka tickets),
3349 * which will be achieved by calling mbedtls_ssl_get_session()
3350 * multiple times until it fails.)
3351 *
3352 * Check whether we have already exported the current session,
3353 * and fail if so.
3354 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003355 if (ssl->session->exported == 1) {
3356 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
3357 }
Hanno Beckere810bbc2021-05-14 16:01:05 +01003358
Gilles Peskine449bd832023-01-11 14:50:10 +01003359 ret = mbedtls_ssl_session_copy(dst, ssl->session);
3360 if (ret != 0) {
3361 return ret;
3362 }
Hanno Beckere810bbc2021-05-14 16:01:05 +01003363
3364 /* Remember that we've exported the session. */
3365 ssl->session->exported = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01003366 return 0;
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003367}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003368#endif /* MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003369
David Horstmanncb01b362024-02-29 17:31:46 +00003370#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
3371
3372/* Serialization of TLS 1.2 sessions
David Horstmanne59f9702024-02-29 16:08:57 +00003373 *
David Horstmanncb01b362024-02-29 17:31:46 +00003374 * For more detail, see the description of ssl_session_save().
David Horstmanne59f9702024-02-29 16:08:57 +00003375 */
3376static size_t ssl_tls12_session_save(const mbedtls_ssl_session *session,
3377 unsigned char *buf,
3378 size_t buf_len)
3379{
3380 unsigned char *p = buf;
3381 size_t used = 0;
3382
3383#if defined(MBEDTLS_HAVE_TIME)
3384 uint64_t start;
3385#endif
3386#if defined(MBEDTLS_X509_CRT_PARSE_C)
3387#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
3388 size_t cert_len;
3389#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3390#endif /* MBEDTLS_X509_CRT_PARSE_C */
3391
3392 /*
3393 * Time
3394 */
3395#if defined(MBEDTLS_HAVE_TIME)
3396 used += 8;
3397
3398 if (used <= buf_len) {
3399 start = (uint64_t) session->start;
3400
3401 MBEDTLS_PUT_UINT64_BE(start, p, 0);
3402 p += 8;
3403 }
3404#endif /* MBEDTLS_HAVE_TIME */
3405
3406 /*
3407 * Basic mandatory fields
3408 */
3409 used += 1 /* id_len */
3410 + sizeof(session->id)
3411 + sizeof(session->master)
3412 + 4; /* verify_result */
3413
3414 if (used <= buf_len) {
3415 *p++ = MBEDTLS_BYTE_0(session->id_len);
3416 memcpy(p, session->id, 32);
3417 p += 32;
3418
3419 memcpy(p, session->master, 48);
3420 p += 48;
3421
3422 MBEDTLS_PUT_UINT32_BE(session->verify_result, p, 0);
3423 p += 4;
3424 }
3425
3426 /*
3427 * Peer's end-entity certificate
3428 */
3429#if defined(MBEDTLS_X509_CRT_PARSE_C)
3430#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
3431 if (session->peer_cert == NULL) {
3432 cert_len = 0;
3433 } else {
3434 cert_len = session->peer_cert->raw.len;
3435 }
3436
3437 used += 3 + cert_len;
3438
3439 if (used <= buf_len) {
3440 *p++ = MBEDTLS_BYTE_2(cert_len);
3441 *p++ = MBEDTLS_BYTE_1(cert_len);
3442 *p++ = MBEDTLS_BYTE_0(cert_len);
3443
3444 if (session->peer_cert != NULL) {
3445 memcpy(p, session->peer_cert->raw.p, cert_len);
3446 p += cert_len;
3447 }
3448 }
3449#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3450 if (session->peer_cert_digest != NULL) {
3451 used += 1 /* type */ + 1 /* length */ + session->peer_cert_digest_len;
3452 if (used <= buf_len) {
3453 *p++ = (unsigned char) session->peer_cert_digest_type;
3454 *p++ = (unsigned char) session->peer_cert_digest_len;
3455 memcpy(p, session->peer_cert_digest,
3456 session->peer_cert_digest_len);
3457 p += session->peer_cert_digest_len;
3458 }
3459 } else {
3460 used += 2;
3461 if (used <= buf_len) {
3462 *p++ = (unsigned char) MBEDTLS_MD_NONE;
3463 *p++ = 0;
3464 }
3465 }
3466#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3467#endif /* MBEDTLS_X509_CRT_PARSE_C */
3468
3469 /*
3470 * Session ticket if any, plus associated data
3471 */
3472#if defined(MBEDTLS_SSL_SESSION_TICKETS)
3473#if defined(MBEDTLS_SSL_CLI_C)
3474 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
3475 used += 3 + session->ticket_len + 4; /* len + ticket + lifetime */
3476
3477 if (used <= buf_len) {
3478 *p++ = MBEDTLS_BYTE_2(session->ticket_len);
3479 *p++ = MBEDTLS_BYTE_1(session->ticket_len);
3480 *p++ = MBEDTLS_BYTE_0(session->ticket_len);
3481
3482 if (session->ticket != NULL) {
3483 memcpy(p, session->ticket, session->ticket_len);
3484 p += session->ticket_len;
3485 }
3486
3487 MBEDTLS_PUT_UINT32_BE(session->ticket_lifetime, p, 0);
3488 p += 4;
3489 }
3490 }
3491#endif /* MBEDTLS_SSL_CLI_C */
3492#if defined(MBEDTLS_HAVE_TIME) && defined(MBEDTLS_SSL_SRV_C)
3493 if (session->endpoint == MBEDTLS_SSL_IS_SERVER) {
3494 used += 8;
3495
3496 if (used <= buf_len) {
3497 MBEDTLS_PUT_UINT64_BE((uint64_t) session->ticket_creation_time, p, 0);
3498 p += 8;
3499 }
3500 }
3501#endif /* MBEDTLS_HAVE_TIME && MBEDTLS_SSL_SRV_C */
3502#endif /* MBEDTLS_SSL_SESSION_TICKETS */
3503
3504 /*
3505 * Misc extension-related info
3506 */
3507#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
3508 used += 1;
3509
3510 if (used <= buf_len) {
3511 *p++ = session->mfl_code;
3512 }
3513#endif
3514
3515#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
3516 used += 1;
3517
3518 if (used <= buf_len) {
3519 *p++ = MBEDTLS_BYTE_0(session->encrypt_then_mac);
3520 }
3521#endif
3522
3523 return used;
3524}
3525
3526MBEDTLS_CHECK_RETURN_CRITICAL
3527static int ssl_tls12_session_load(mbedtls_ssl_session *session,
3528 const unsigned char *buf,
3529 size_t len)
3530{
3531#if defined(MBEDTLS_HAVE_TIME)
3532 uint64_t start;
3533#endif
3534#if defined(MBEDTLS_X509_CRT_PARSE_C)
3535#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
3536 size_t cert_len;
3537#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3538#endif /* MBEDTLS_X509_CRT_PARSE_C */
3539
3540 const unsigned char *p = buf;
3541 const unsigned char * const end = buf + len;
3542
3543 /*
3544 * Time
3545 */
3546#if defined(MBEDTLS_HAVE_TIME)
3547 if (8 > (size_t) (end - p)) {
3548 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3549 }
3550
3551 start = MBEDTLS_GET_UINT64_BE(p, 0);
3552 p += 8;
3553
3554 session->start = (time_t) start;
3555#endif /* MBEDTLS_HAVE_TIME */
3556
3557 /*
3558 * Basic mandatory fields
3559 */
3560 if (1 + 32 + 48 + 4 > (size_t) (end - p)) {
3561 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3562 }
3563
3564 session->id_len = *p++;
3565 memcpy(session->id, p, 32);
3566 p += 32;
3567
3568 memcpy(session->master, p, 48);
3569 p += 48;
3570
3571 session->verify_result = MBEDTLS_GET_UINT32_BE(p, 0);
3572 p += 4;
3573
3574 /* Immediately clear invalid pointer values that have been read, in case
3575 * we exit early before we replaced them with valid ones. */
3576#if defined(MBEDTLS_X509_CRT_PARSE_C)
3577#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
3578 session->peer_cert = NULL;
3579#else
3580 session->peer_cert_digest = NULL;
3581#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3582#endif /* MBEDTLS_X509_CRT_PARSE_C */
3583#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
3584 session->ticket = NULL;
3585#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
3586
3587 /*
3588 * Peer certificate
3589 */
3590#if defined(MBEDTLS_X509_CRT_PARSE_C)
3591#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
3592 /* Deserialize CRT from the end of the ticket. */
3593 if (3 > (size_t) (end - p)) {
3594 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3595 }
3596
3597 cert_len = MBEDTLS_GET_UINT24_BE(p, 0);
3598 p += 3;
3599
3600 if (cert_len != 0) {
3601 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
3602
3603 if (cert_len > (size_t) (end - p)) {
3604 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3605 }
3606
3607 session->peer_cert = mbedtls_calloc(1, sizeof(mbedtls_x509_crt));
3608
3609 if (session->peer_cert == NULL) {
3610 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
3611 }
3612
3613 mbedtls_x509_crt_init(session->peer_cert);
3614
3615 if ((ret = mbedtls_x509_crt_parse_der(session->peer_cert,
3616 p, cert_len)) != 0) {
3617 mbedtls_x509_crt_free(session->peer_cert);
3618 mbedtls_free(session->peer_cert);
3619 session->peer_cert = NULL;
3620 return ret;
3621 }
3622
3623 p += cert_len;
3624 }
3625#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3626 /* Deserialize CRT digest from the end of the ticket. */
3627 if (2 > (size_t) (end - p)) {
3628 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3629 }
3630
3631 session->peer_cert_digest_type = (mbedtls_md_type_t) *p++;
3632 session->peer_cert_digest_len = (size_t) *p++;
3633
3634 if (session->peer_cert_digest_len != 0) {
3635 const mbedtls_md_info_t *md_info =
3636 mbedtls_md_info_from_type(session->peer_cert_digest_type);
3637 if (md_info == NULL) {
3638 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3639 }
3640 if (session->peer_cert_digest_len != mbedtls_md_get_size(md_info)) {
3641 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3642 }
3643
3644 if (session->peer_cert_digest_len > (size_t) (end - p)) {
3645 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3646 }
3647
3648 session->peer_cert_digest =
3649 mbedtls_calloc(1, session->peer_cert_digest_len);
3650 if (session->peer_cert_digest == NULL) {
3651 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
3652 }
3653
3654 memcpy(session->peer_cert_digest, p,
3655 session->peer_cert_digest_len);
3656 p += session->peer_cert_digest_len;
3657 }
3658#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3659#endif /* MBEDTLS_X509_CRT_PARSE_C */
3660
3661 /*
3662 * Session ticket and associated data
3663 */
3664#if defined(MBEDTLS_SSL_SESSION_TICKETS)
3665#if defined(MBEDTLS_SSL_CLI_C)
3666 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
3667 if (3 > (size_t) (end - p)) {
3668 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3669 }
3670
3671 session->ticket_len = MBEDTLS_GET_UINT24_BE(p, 0);
3672 p += 3;
3673
3674 if (session->ticket_len != 0) {
3675 if (session->ticket_len > (size_t) (end - p)) {
3676 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3677 }
3678
3679 session->ticket = mbedtls_calloc(1, session->ticket_len);
3680 if (session->ticket == NULL) {
3681 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
3682 }
3683
3684 memcpy(session->ticket, p, session->ticket_len);
3685 p += session->ticket_len;
3686 }
3687
3688 if (4 > (size_t) (end - p)) {
3689 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3690 }
3691
3692 session->ticket_lifetime = MBEDTLS_GET_UINT32_BE(p, 0);
3693 p += 4;
3694 }
3695#endif /* MBEDTLS_SSL_CLI_C */
3696#if defined(MBEDTLS_HAVE_TIME) && defined(MBEDTLS_SSL_SRV_C)
3697 if (session->endpoint == MBEDTLS_SSL_IS_SERVER) {
3698 if (8 > (size_t) (end - p)) {
3699 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3700 }
3701 session->ticket_creation_time = MBEDTLS_GET_UINT64_BE(p, 0);
3702 p += 8;
3703 }
3704#endif /* MBEDTLS_HAVE_TIME && MBEDTLS_SSL_SRV_C */
3705#endif /* MBEDTLS_SSL_SESSION_TICKETS */
3706
3707 /*
3708 * Misc extension-related info
3709 */
3710#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
3711 if (1 > (size_t) (end - p)) {
3712 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3713 }
3714
3715 session->mfl_code = *p++;
3716#endif
3717
3718#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
3719 if (1 > (size_t) (end - p)) {
3720 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3721 }
3722
3723 session->encrypt_then_mac = *p++;
3724#endif
3725
3726 /* Done, should have consumed entire buffer */
3727 if (p != end) {
3728 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3729 }
3730
3731 return 0;
3732}
3733
3734#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
3735
3736#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
3737/* Serialization of TLS 1.3 sessions:
3738 *
Waleed Elmelegy11025632024-03-07 15:25:52 +00003739 * For more detail, see the description of ssl_session_save().
David Horstmanne59f9702024-02-29 16:08:57 +00003740 */
3741#if defined(MBEDTLS_SSL_SESSION_TICKETS)
3742MBEDTLS_CHECK_RETURN_CRITICAL
3743static int ssl_tls13_session_save(const mbedtls_ssl_session *session,
3744 unsigned char *buf,
3745 size_t buf_len,
3746 size_t *olen)
3747{
3748 unsigned char *p = buf;
3749#if defined(MBEDTLS_SSL_CLI_C) && \
3750 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
3751 size_t hostname_len = (session->hostname == NULL) ?
3752 0 : strlen(session->hostname) + 1;
3753#endif
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003754
3755#if defined(MBEDTLS_SSL_SRV_C) && \
3756 defined(MBEDTLS_SSL_EARLY_DATA) && defined(MBEDTLS_SSL_ALPN)
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00003757 const uint8_t alpn_len = (session->ticket_alpn == NULL) ?
3758 0 : (uint8_t) strlen(session->ticket_alpn) + 1;
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003759#endif
David Horstmanne59f9702024-02-29 16:08:57 +00003760 size_t needed = 4 /* ticket_age_add */
3761 + 1 /* ticket_flags */
3762 + 1; /* resumption_key length */
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003763
David Horstmanne59f9702024-02-29 16:08:57 +00003764 *olen = 0;
3765
3766 if (session->resumption_key_len > MBEDTLS_SSL_TLS1_3_TICKET_RESUMPTION_KEY_LEN) {
3767 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3768 }
3769 needed += session->resumption_key_len; /* resumption_key */
3770
3771#if defined(MBEDTLS_SSL_EARLY_DATA)
3772 needed += 4; /* max_early_data_size */
3773#endif
3774#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
3775 needed += 2; /* record_size_limit */
3776#endif /* MBEDTLS_SSL_RECORD_SIZE_LIMIT */
3777
3778#if defined(MBEDTLS_HAVE_TIME)
3779 needed += 8; /* ticket_creation_time or ticket_reception_time */
3780#endif
3781
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003782#if defined(MBEDTLS_SSL_SRV_C)
3783 if (session->endpoint == MBEDTLS_SSL_IS_SERVER) {
3784#if defined(MBEDTLS_SSL_EARLY_DATA) && defined(MBEDTLS_SSL_ALPN)
3785 needed += 1 /* alpn_len */
3786 + alpn_len; /* alpn */
3787#endif
3788 }
3789#endif /* MBEDTLS_SSL_SRV_C */
3790
David Horstmanne59f9702024-02-29 16:08:57 +00003791#if defined(MBEDTLS_SSL_CLI_C)
3792 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
3793#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
3794 needed += 2 /* hostname_len */
3795 + hostname_len; /* hostname */
3796#endif
3797
3798 needed += 4 /* ticket_lifetime */
3799 + 2; /* ticket_len */
3800
3801 /* Check size_t overflow */
3802 if (session->ticket_len > SIZE_MAX - needed) {
3803 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3804 }
3805
3806 needed += session->ticket_len; /* ticket */
3807 }
3808#endif /* MBEDTLS_SSL_CLI_C */
3809
3810 *olen = needed;
3811 if (needed > buf_len) {
3812 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
3813 }
3814
3815 MBEDTLS_PUT_UINT32_BE(session->ticket_age_add, p, 0);
3816 p[4] = session->ticket_flags;
3817
3818 /* save resumption_key */
3819 p[5] = session->resumption_key_len;
3820 p += 6;
3821 memcpy(p, session->resumption_key, session->resumption_key_len);
3822 p += session->resumption_key_len;
3823
3824#if defined(MBEDTLS_SSL_EARLY_DATA)
3825 MBEDTLS_PUT_UINT32_BE(session->max_early_data_size, p, 0);
3826 p += 4;
3827#endif
3828#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
3829 MBEDTLS_PUT_UINT16_BE(session->record_size_limit, p, 0);
3830 p += 2;
3831#endif /* MBEDTLS_SSL_RECORD_SIZE_LIMIT */
3832
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003833#if defined(MBEDTLS_SSL_SRV_C)
David Horstmanne59f9702024-02-29 16:08:57 +00003834 if (session->endpoint == MBEDTLS_SSL_IS_SERVER) {
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003835#if defined(MBEDTLS_HAVE_TIME)
David Horstmanne59f9702024-02-29 16:08:57 +00003836 MBEDTLS_PUT_UINT64_BE((uint64_t) session->ticket_creation_time, p, 0);
3837 p += 8;
David Horstmanne59f9702024-02-29 16:08:57 +00003838#endif /* MBEDTLS_HAVE_TIME */
3839
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003840#if defined(MBEDTLS_SSL_EARLY_DATA) && defined(MBEDTLS_SSL_ALPN)
3841 *p++ = alpn_len;
3842 if (alpn_len > 0) {
3843 /* save chosen alpn */
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00003844 memcpy(p, session->ticket_alpn, alpn_len);
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003845 p += alpn_len;
3846 }
3847#endif /* MBEDTLS_SSL_EARLY_DATA && MBEDTLS_SSL_ALPN */
3848 }
3849#endif /* MBEDTLS_SSL_SRV_C */
3850
David Horstmanne59f9702024-02-29 16:08:57 +00003851#if defined(MBEDTLS_SSL_CLI_C)
3852 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
3853#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
3854 MBEDTLS_PUT_UINT16_BE(hostname_len, p, 0);
3855 p += 2;
3856 if (hostname_len > 0) {
3857 /* save host name */
3858 memcpy(p, session->hostname, hostname_len);
3859 p += hostname_len;
3860 }
3861#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
3862
3863#if defined(MBEDTLS_HAVE_TIME)
3864 MBEDTLS_PUT_UINT64_BE((uint64_t) session->ticket_reception_time, p, 0);
3865 p += 8;
3866#endif
3867 MBEDTLS_PUT_UINT32_BE(session->ticket_lifetime, p, 0);
3868 p += 4;
3869
3870 MBEDTLS_PUT_UINT16_BE(session->ticket_len, p, 0);
3871 p += 2;
3872
3873 if (session->ticket != NULL && session->ticket_len > 0) {
3874 memcpy(p, session->ticket, session->ticket_len);
3875 p += session->ticket_len;
3876 }
3877 }
3878#endif /* MBEDTLS_SSL_CLI_C */
3879 return 0;
3880}
3881
3882MBEDTLS_CHECK_RETURN_CRITICAL
3883static int ssl_tls13_session_load(mbedtls_ssl_session *session,
3884 const unsigned char *buf,
3885 size_t len)
3886{
3887 const unsigned char *p = buf;
3888 const unsigned char *end = buf + len;
3889
3890 if (end - p < 6) {
3891 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3892 }
3893 session->ticket_age_add = MBEDTLS_GET_UINT32_BE(p, 0);
3894 session->ticket_flags = p[4];
3895
3896 /* load resumption_key */
3897 session->resumption_key_len = p[5];
3898 p += 6;
3899
3900 if (end - p < session->resumption_key_len) {
3901 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3902 }
3903
3904 if (sizeof(session->resumption_key) < session->resumption_key_len) {
3905 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3906 }
3907 memcpy(session->resumption_key, p, session->resumption_key_len);
3908 p += session->resumption_key_len;
3909
3910#if defined(MBEDTLS_SSL_EARLY_DATA)
3911 if (end - p < 4) {
3912 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3913 }
3914 session->max_early_data_size = MBEDTLS_GET_UINT32_BE(p, 0);
3915 p += 4;
3916#endif
3917#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
3918 if (end - p < 2) {
3919 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3920 }
3921 session->record_size_limit = MBEDTLS_GET_UINT16_BE(p, 0);
3922 p += 2;
3923#endif /* MBEDTLS_SSL_RECORD_SIZE_LIMIT */
3924
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003925#if defined(MBEDTLS_SSL_SRV_C)
David Horstmanne59f9702024-02-29 16:08:57 +00003926 if (session->endpoint == MBEDTLS_SSL_IS_SERVER) {
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003927#if defined(MBEDTLS_HAVE_TIME)
David Horstmanne59f9702024-02-29 16:08:57 +00003928 if (end - p < 8) {
3929 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3930 }
3931 session->ticket_creation_time = MBEDTLS_GET_UINT64_BE(p, 0);
3932 p += 8;
David Horstmanne59f9702024-02-29 16:08:57 +00003933#endif /* MBEDTLS_HAVE_TIME */
3934
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003935#if defined(MBEDTLS_SSL_EARLY_DATA) && defined(MBEDTLS_SSL_ALPN)
3936 uint8_t alpn_len;
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00003937 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003938
3939 if (end - p < 1) {
3940 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3941 }
3942 alpn_len = *p++;
3943
3944 if (end - p < alpn_len) {
3945 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3946 }
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00003947
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003948 if (alpn_len > 0) {
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00003949 ret = mbedtls_ssl_session_set_alpn(session, (const char *) p);
3950 if (ret != 0) {
3951 return ret;
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003952 }
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003953 p += alpn_len;
3954 }
3955#endif /* MBEDTLS_SSL_EARLY_DATA && MBEDTLS_SSL_ALPN */
3956 }
3957#endif /* MBEDTLS_SSL_SRV_C */
3958
David Horstmanne59f9702024-02-29 16:08:57 +00003959#if defined(MBEDTLS_SSL_CLI_C)
3960 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
3961#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
3962 size_t hostname_len;
3963 /* load host name */
3964 if (end - p < 2) {
3965 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3966 }
3967 hostname_len = MBEDTLS_GET_UINT16_BE(p, 0);
3968 p += 2;
3969
3970 if (end - p < (long int) hostname_len) {
3971 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3972 }
3973 if (hostname_len > 0) {
3974 session->hostname = mbedtls_calloc(1, hostname_len);
3975 if (session->hostname == NULL) {
3976 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
3977 }
3978 memcpy(session->hostname, p, hostname_len);
3979 p += hostname_len;
3980 }
3981#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
3982
3983#if defined(MBEDTLS_HAVE_TIME)
3984 if (end - p < 8) {
3985 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3986 }
3987 session->ticket_reception_time = MBEDTLS_GET_UINT64_BE(p, 0);
3988 p += 8;
3989#endif
3990 if (end - p < 4) {
3991 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3992 }
3993 session->ticket_lifetime = MBEDTLS_GET_UINT32_BE(p, 0);
3994 p += 4;
3995
3996 if (end - p < 2) {
3997 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3998 }
3999 session->ticket_len = MBEDTLS_GET_UINT16_BE(p, 0);
4000 p += 2;
4001
4002 if (end - p < (long int) session->ticket_len) {
4003 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4004 }
4005 if (session->ticket_len > 0) {
4006 session->ticket = mbedtls_calloc(1, session->ticket_len);
4007 if (session->ticket == NULL) {
4008 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
4009 }
4010 memcpy(session->ticket, p, session->ticket_len);
4011 p += session->ticket_len;
4012 }
4013 }
4014#endif /* MBEDTLS_SSL_CLI_C */
4015
4016 return 0;
4017
4018}
4019#else /* MBEDTLS_SSL_SESSION_TICKETS */
4020MBEDTLS_CHECK_RETURN_CRITICAL
4021static int ssl_tls13_session_save(const mbedtls_ssl_session *session,
4022 unsigned char *buf,
4023 size_t buf_len,
4024 size_t *olen)
4025{
4026 ((void) session);
4027 ((void) buf);
4028 ((void) buf_len);
4029 *olen = 0;
4030 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
4031}
4032
4033static int ssl_tls13_session_load(const mbedtls_ssl_session *session,
4034 unsigned char *buf,
4035 size_t buf_len)
4036{
4037 ((void) session);
4038 ((void) buf);
4039 ((void) buf_len);
4040 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
4041}
4042#endif /* !MBEDTLS_SSL_SESSION_TICKETS */
4043#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
4044
Paul Bakker5121ce52009-01-03 21:22:43 +00004045/*
Hanno Beckera835da52019-05-16 12:39:07 +01004046 * Define ticket header determining Mbed TLS version
4047 * and structure of the ticket.
4048 */
4049
Hanno Becker94ef3b32019-05-16 12:50:45 +01004050/*
Hanno Becker50b59662019-05-28 14:30:45 +01004051 * Define bitflag determining compile-time settings influencing
4052 * structure of serialized SSL sessions.
Hanno Becker94ef3b32019-05-16 12:50:45 +01004053 */
4054
Hanno Becker50b59662019-05-28 14:30:45 +01004055#if defined(MBEDTLS_HAVE_TIME)
Hanno Becker3e088662019-05-29 11:10:18 +01004056#define SSL_SERIALIZED_SESSION_CONFIG_TIME 1
Hanno Becker50b59662019-05-28 14:30:45 +01004057#else
Hanno Becker3e088662019-05-29 11:10:18 +01004058#define SSL_SERIALIZED_SESSION_CONFIG_TIME 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01004059#endif /* MBEDTLS_HAVE_TIME */
4060
4061#if defined(MBEDTLS_X509_CRT_PARSE_C)
Hanno Becker3e088662019-05-29 11:10:18 +01004062#define SSL_SERIALIZED_SESSION_CONFIG_CRT 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01004063#else
Hanno Becker3e088662019-05-29 11:10:18 +01004064#define SSL_SERIALIZED_SESSION_CONFIG_CRT 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01004065#endif /* MBEDTLS_X509_CRT_PARSE_C */
4066
David Horstmann5c5a32f2024-02-13 17:53:35 +00004067#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
David Horstmannf686f1d2024-03-01 11:20:32 +00004068#define SSL_SERIALIZED_SESSION_CONFIG_KEEP_PEER_CRT 1
David Horstmann5c5a32f2024-02-13 17:53:35 +00004069#else
David Horstmannf686f1d2024-03-01 11:20:32 +00004070#define SSL_SERIALIZED_SESSION_CONFIG_KEEP_PEER_CRT 0
David Horstmann5c5a32f2024-02-13 17:53:35 +00004071#endif /* MBEDTLS_SSL_SESSION_TICKETS */
4072
Hanno Becker94ef3b32019-05-16 12:50:45 +01004073#if defined(MBEDTLS_SSL_CLI_C) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Hanno Becker3e088662019-05-29 11:10:18 +01004074#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01004075#else
Hanno Becker3e088662019-05-29 11:10:18 +01004076#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01004077#endif /* MBEDTLS_SSL_CLI_C && MBEDTLS_SSL_SESSION_TICKETS */
4078
4079#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Hanno Becker3e088662019-05-29 11:10:18 +01004080#define SSL_SERIALIZED_SESSION_CONFIG_MFL 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01004081#else
Hanno Becker3e088662019-05-29 11:10:18 +01004082#define SSL_SERIALIZED_SESSION_CONFIG_MFL 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01004083#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
4084
Hanno Becker94ef3b32019-05-16 12:50:45 +01004085#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Hanno Becker3e088662019-05-29 11:10:18 +01004086#define SSL_SERIALIZED_SESSION_CONFIG_ETM 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01004087#else
Hanno Becker3e088662019-05-29 11:10:18 +01004088#define SSL_SERIALIZED_SESSION_CONFIG_ETM 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01004089#endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC */
4090
Hanno Becker94ef3b32019-05-16 12:50:45 +01004091#if defined(MBEDTLS_SSL_SESSION_TICKETS)
4092#define SSL_SERIALIZED_SESSION_CONFIG_TICKET 1
4093#else
4094#define SSL_SERIALIZED_SESSION_CONFIG_TICKET 0
4095#endif /* MBEDTLS_SSL_SESSION_TICKETS */
4096
David Horstmann92b258b2024-02-13 17:23:34 +00004097#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
4098#define SSL_SERIALIZED_SESSION_CONFIG_SNI 1
4099#else
4100#define SSL_SERIALIZED_SESSION_CONFIG_SNI 0
4101#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
4102
4103#if defined(MBEDTLS_SSL_EARLY_DATA)
4104#define SSL_SERIALIZED_SESSION_CONFIG_EARLY_DATA 1
4105#else
4106#define SSL_SERIALIZED_SESSION_CONFIG_EARLY_DATA 0
4107#endif /* MBEDTLS_SSL_EARLY_DATA */
4108
4109#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
4110#define SSL_SERIALIZED_SESSION_CONFIG_RECORD_SIZE 1
4111#else
4112#define SSL_SERIALIZED_SESSION_CONFIG_RECORD_SIZE 0
4113#endif /* MBEDTLS_SSL_RECORD_SIZE_LIMIT */
4114
Waleed Elmelegy11025632024-03-07 15:25:52 +00004115#if defined(MBEDTLS_SSL_ALPN)
4116#define SSL_SERIALIZED_SESSION_CONFIG_ALPN 1
4117#else
4118#define SSL_SERIALIZED_SESSION_CONFIG_ALPN 0
4119#endif /* MBEDTLS_SSL_ALPN */
4120
Hanno Becker3e088662019-05-29 11:10:18 +01004121#define SSL_SERIALIZED_SESSION_CONFIG_TIME_BIT 0
4122#define SSL_SERIALIZED_SESSION_CONFIG_CRT_BIT 1
4123#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET_BIT 2
4124#define SSL_SERIALIZED_SESSION_CONFIG_MFL_BIT 3
Hanno Becker37bdbe62021-08-01 05:38:58 +01004125#define SSL_SERIALIZED_SESSION_CONFIG_ETM_BIT 4
4126#define SSL_SERIALIZED_SESSION_CONFIG_TICKET_BIT 5
David Horstmannf686f1d2024-03-01 11:20:32 +00004127#define SSL_SERIALIZED_SESSION_CONFIG_KEEP_PEER_CRT_BIT 6
David Horstmann92b258b2024-02-13 17:23:34 +00004128#define SSL_SERIALIZED_SESSION_CONFIG_SNI_BIT 7
4129#define SSL_SERIALIZED_SESSION_CONFIG_EARLY_DATA_BIT 8
4130#define SSL_SERIALIZED_SESSION_CONFIG_RECORD_SIZE_BIT 9
Waleed Elmelegy11025632024-03-07 15:25:52 +00004131#define SSL_SERIALIZED_SESSION_CONFIG_ALPN_BIT 10
Hanno Becker3e088662019-05-29 11:10:18 +01004132
Hanno Becker50b59662019-05-28 14:30:45 +01004133#define SSL_SERIALIZED_SESSION_CONFIG_BITFLAG \
Gilles Peskine449bd832023-01-11 14:50:10 +01004134 ((uint16_t) ( \
4135 (SSL_SERIALIZED_SESSION_CONFIG_TIME << SSL_SERIALIZED_SESSION_CONFIG_TIME_BIT) | \
4136 (SSL_SERIALIZED_SESSION_CONFIG_CRT << SSL_SERIALIZED_SESSION_CONFIG_CRT_BIT) | \
4137 (SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET << \
4138 SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET_BIT) | \
4139 (SSL_SERIALIZED_SESSION_CONFIG_MFL << SSL_SERIALIZED_SESSION_CONFIG_MFL_BIT) | \
4140 (SSL_SERIALIZED_SESSION_CONFIG_ETM << SSL_SERIALIZED_SESSION_CONFIG_ETM_BIT) | \
David Horstmann5c5a32f2024-02-13 17:53:35 +00004141 (SSL_SERIALIZED_SESSION_CONFIG_TICKET << SSL_SERIALIZED_SESSION_CONFIG_TICKET_BIT) | \
David Horstmann71fa1a92024-03-01 12:32:18 +00004142 (SSL_SERIALIZED_SESSION_CONFIG_KEEP_PEER_CRT << \
4143 SSL_SERIALIZED_SESSION_CONFIG_KEEP_PEER_CRT_BIT) | \
David Horstmann92b258b2024-02-13 17:23:34 +00004144 (SSL_SERIALIZED_SESSION_CONFIG_SNI << SSL_SERIALIZED_SESSION_CONFIG_SNI_BIT) | \
4145 (SSL_SERIALIZED_SESSION_CONFIG_EARLY_DATA << \
4146 SSL_SERIALIZED_SESSION_CONFIG_EARLY_DATA_BIT) | \
4147 (SSL_SERIALIZED_SESSION_CONFIG_RECORD_SIZE << \
Waleed Elmelegy11025632024-03-07 15:25:52 +00004148 SSL_SERIALIZED_SESSION_CONFIG_RECORD_SIZE_BIT) | \
4149 (SSL_SERIALIZED_SESSION_CONFIG_ALPN << \
4150 SSL_SERIALIZED_SESSION_CONFIG_ALPN_BIT)))
Hanno Becker94ef3b32019-05-16 12:50:45 +01004151
Chien Wong4e9683e2023-12-28 17:07:43 +08004152static const unsigned char ssl_serialized_session_header[] = {
Hanno Becker94ef3b32019-05-16 12:50:45 +01004153 MBEDTLS_VERSION_MAJOR,
4154 MBEDTLS_VERSION_MINOR,
4155 MBEDTLS_VERSION_PATCH,
Gilles Peskine449bd832023-01-11 14:50:10 +01004156 MBEDTLS_BYTE_1(SSL_SERIALIZED_SESSION_CONFIG_BITFLAG),
4157 MBEDTLS_BYTE_0(SSL_SERIALIZED_SESSION_CONFIG_BITFLAG),
Hanno Beckerf8787072019-05-16 12:41:07 +01004158};
Hanno Beckera835da52019-05-16 12:39:07 +01004159
4160/*
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004161 * Serialize a session in the following format:
Manuel Pégourié-Gonnard35eb8022019-05-16 11:11:08 +02004162 * (in the presentation language of TLS, RFC 8446 section 3)
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004163 *
David Horstmanncb01b362024-02-29 17:31:46 +00004164 * TLS 1.2 session:
4165 *
4166 * struct {
4167 * #if defined(MBEDTLS_SSL_SESSION_TICKETS)
4168 * opaque ticket<0..2^24-1>; // length 0 means no ticket
4169 * uint32 ticket_lifetime;
4170 * #endif
4171 * } ClientOnlyData;
4172 *
4173 * struct {
4174 * #if defined(MBEDTLS_HAVE_TIME)
4175 * uint64 start_time;
4176 * #endif
4177 * uint8 session_id_len; // at most 32
4178 * opaque session_id[32];
4179 * opaque master[48]; // fixed length in the standard
4180 * uint32 verify_result;
4181 * #if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
4182 * opaque peer_cert<0..2^24-1>; // length 0 means no peer cert
4183 * #else
David Horstmann76ba26a2024-03-01 12:03:35 +00004184 * uint8 peer_cert_digest_type;
David Horstmanncb01b362024-02-29 17:31:46 +00004185 * opaque peer_cert_digest<0..2^8-1>
4186 * #endif
4187 * select (endpoint) {
4188 * case client: ClientOnlyData;
4189 * case server: uint64 ticket_creation_time;
4190 * };
4191 * #if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
4192 * uint8 mfl_code; // up to 255 according to standard
4193 * #endif
4194 * #if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
4195 * uint8 encrypt_then_mac; // 0 or 1
4196 * #endif
4197 * } serialized_session_tls12;
4198 *
4199 *
4200 * TLS 1.3 Session:
4201 *
4202 * struct {
4203 * #if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
4204 * opaque hostname<0..2^16-1>;
4205 * #endif
4206 * #if defined(MBEDTLS_HAVE_TIME)
4207 * uint64 ticket_reception_time;
4208 * #endif
4209 * uint32 ticket_lifetime;
4210 * opaque ticket<1..2^16-1>;
4211 * } ClientOnlyData;
4212 *
4213 * struct {
4214 * uint32 ticket_age_add;
4215 * uint8 ticket_flags;
4216 * opaque resumption_key<0..255>;
4217 * #if defined(MBEDTLS_SSL_EARLY_DATA)
4218 * uint32 max_early_data_size;
4219 * #endif
4220 * #if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
4221 * uint16 record_size_limit;
4222 * #endif
4223 * select ( endpoint ) {
4224 * case client: ClientOnlyData;
4225 * #if defined(MBEDTLS_HAVE_TIME)
4226 * case server: uint64 ticket_creation_time;
4227 * #endif
Waleed Elmelegyfe9ae082024-03-07 15:47:31 +00004228 * #if defined(MBEDTLS_SSL_EARLY_DATA) && defined(MBEDTLS_SSL_ALPN)
4229 * uint8 alpn_len;
4230 * opaque ticket_alpn<0..255>;
4231 * #endif
David Horstmanncb01b362024-02-29 17:31:46 +00004232 * };
4233 * } serialized_session_tls13;
4234 *
4235 *
4236 * SSL session:
4237 *
4238 * struct {
Hanno Beckerdc28b6c2019-05-29 11:08:00 +01004239 *
Hanno Beckerdce50972021-08-01 05:39:23 +01004240 * opaque mbedtls_version[3]; // library version: major, minor, patch
4241 * opaque session_format[2]; // library-version specific 16-bit field
4242 * // determining the format of the remaining
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004243 * // serialized data.
Hanno Beckerdc28b6c2019-05-29 11:08:00 +01004244 *
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004245 * Note: When updating the format, remember to keep
4246 * these version+format bytes.
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004247 *
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004248 * // In this version, `session_format` determines
4249 * // the setting of those compile-time
4250 * // configuration options which influence
4251 * // the structure of mbedtls_ssl_session.
4252 *
Glenn Straussda7851c2022-03-14 13:29:48 -04004253 * uint8_t minor_ver; // Protocol minor version. Possible values:
Jerry Yu0c2a7382022-12-06 13:27:25 +08004254 * // - TLS 1.2 (0x0303)
4255 * // - TLS 1.3 (0x0304)
David Horstmann531aca22024-02-29 18:14:28 +00004256 * uint8_t endpoint;
4257 * uint16_t ciphersuite;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004258 *
Glenn Straussda7851c2022-03-14 13:29:48 -04004259 * select (serialized_session.tls_version) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004260 *
Glenn Straussda7851c2022-03-14 13:29:48 -04004261 * case MBEDTLS_SSL_VERSION_TLS1_2:
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004262 * serialized_session_tls12 data;
Jerry Yu0c2a7382022-12-06 13:27:25 +08004263 * case MBEDTLS_SSL_VERSION_TLS1_3:
Jerry Yuddda0502022-12-01 19:43:12 +08004264 * serialized_session_tls13 data;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004265 *
4266 * };
4267 *
4268 * } serialized_session;
4269 *
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004270 */
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004271
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004272MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004273static int ssl_session_save(const mbedtls_ssl_session *session,
4274 unsigned char omit_header,
4275 unsigned char *buf,
4276 size_t buf_len,
4277 size_t *olen)
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004278{
4279 unsigned char *p = buf;
4280 size_t used = 0;
Jerry Yu251a12e2022-07-13 15:15:48 +08004281 size_t remaining_len;
Jerry Yue36fdd62022-08-17 21:31:36 +08004282#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
4283 size_t out_len;
4284 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
4285#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01004286 if (session == NULL) {
4287 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
4288 }
Jerry Yu438ddd82022-07-07 06:55:50 +00004289
Gilles Peskine449bd832023-01-11 14:50:10 +01004290 if (!omit_header) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004291 /*
4292 * Add Mbed TLS version identifier
4293 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004294 used += sizeof(ssl_serialized_session_header);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004295
Gilles Peskine449bd832023-01-11 14:50:10 +01004296 if (used <= buf_len) {
4297 memcpy(p, ssl_serialized_session_header,
4298 sizeof(ssl_serialized_session_header));
4299 p += sizeof(ssl_serialized_session_header);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004300 }
4301 }
4302
4303 /*
Ronald Cron40a4ab02024-01-15 10:21:30 +01004304 * TLS version identifier, endpoint, ciphersuite
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004305 */
Ronald Cron40a4ab02024-01-15 10:21:30 +01004306 used += 1 /* TLS version */
4307 + 1 /* endpoint */
4308 + 2; /* ciphersuite */
Gilles Peskine449bd832023-01-11 14:50:10 +01004309 if (used <= buf_len) {
4310 *p++ = MBEDTLS_BYTE_0(session->tls_version);
Ronald Cron40a4ab02024-01-15 10:21:30 +01004311 *p++ = session->endpoint;
4312 MBEDTLS_PUT_UINT16_BE(session->ciphersuite, p, 0);
4313 p += 2;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004314 }
4315
4316 /* Forward to version-specific serialization routine. */
Jerry Yufca4d572022-07-21 10:37:48 +08004317 remaining_len = (buf_len >= used) ? buf_len - used : 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01004318 switch (session->tls_version) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004319#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01004320 case MBEDTLS_SSL_VERSION_TLS1_2:
4321 used += ssl_tls12_session_save(session, p, remaining_len);
4322 break;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004323#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
4324
Jerry Yu251a12e2022-07-13 15:15:48 +08004325#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004326 case MBEDTLS_SSL_VERSION_TLS1_3:
4327 ret = ssl_tls13_session_save(session, p, remaining_len, &out_len);
4328 if (ret != 0 && ret != MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL) {
4329 return ret;
4330 }
4331 used += out_len;
4332 break;
Jerry Yu251a12e2022-07-13 15:15:48 +08004333#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
4334
Gilles Peskine449bd832023-01-11 14:50:10 +01004335 default:
4336 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004337 }
4338
4339 *olen = used;
Gilles Peskine449bd832023-01-11 14:50:10 +01004340 if (used > buf_len) {
4341 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
4342 }
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004343
Gilles Peskine449bd832023-01-11 14:50:10 +01004344 return 0;
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004345}
4346
4347/*
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02004348 * Public wrapper for ssl_session_save()
4349 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004350int mbedtls_ssl_session_save(const mbedtls_ssl_session *session,
4351 unsigned char *buf,
4352 size_t buf_len,
4353 size_t *olen)
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02004354{
Gilles Peskine449bd832023-01-11 14:50:10 +01004355 return ssl_session_save(session, 0, buf, buf_len, olen);
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02004356}
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004357
Jerry Yuf1b23ca2022-02-18 11:48:47 +08004358/*
4359 * Deserialize session, see mbedtls_ssl_session_save() for format.
4360 *
4361 * This internal version is wrapped by a public function that cleans up in
4362 * case of error, and has an extra option omit_header.
4363 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004364MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004365static int ssl_session_load(mbedtls_ssl_session *session,
4366 unsigned char omit_header,
4367 const unsigned char *buf,
4368 size_t len)
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004369{
4370 const unsigned char *p = buf;
4371 const unsigned char * const end = buf + len;
Jerry Yu438ddd82022-07-07 06:55:50 +00004372 size_t remaining_len;
4373
4374
Gilles Peskine449bd832023-01-11 14:50:10 +01004375 if (session == NULL) {
4376 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
4377 }
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004378
Gilles Peskine449bd832023-01-11 14:50:10 +01004379 if (!omit_header) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004380 /*
4381 * Check Mbed TLS version identifier
4382 */
4383
Gilles Peskine449bd832023-01-11 14:50:10 +01004384 if ((size_t) (end - p) < sizeof(ssl_serialized_session_header)) {
4385 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004386 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004387
4388 if (memcmp(p, ssl_serialized_session_header,
4389 sizeof(ssl_serialized_session_header)) != 0) {
4390 return MBEDTLS_ERR_SSL_VERSION_MISMATCH;
4391 }
4392 p += sizeof(ssl_serialized_session_header);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004393 }
4394
4395 /*
Ronald Cron40a4ab02024-01-15 10:21:30 +01004396 * TLS version identifier, endpoint, ciphersuite
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004397 */
Ronald Cron40a4ab02024-01-15 10:21:30 +01004398 if (4 > (size_t) (end - p)) {
Gilles Peskine449bd832023-01-11 14:50:10 +01004399 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4400 }
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01004401 session->tls_version = (mbedtls_ssl_protocol_version) (0x0300 | *p++);
Ronald Cron40a4ab02024-01-15 10:21:30 +01004402 session->endpoint = *p++;
4403 session->ciphersuite = MBEDTLS_GET_UINT16_BE(p, 0);
4404 p += 2;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004405
4406 /* Dispatch according to TLS version. */
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00004407 remaining_len = (size_t) (end - p);
Gilles Peskine449bd832023-01-11 14:50:10 +01004408 switch (session->tls_version) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004409#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01004410 case MBEDTLS_SSL_VERSION_TLS1_2:
4411 return ssl_tls12_session_load(session, p, remaining_len);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004412#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
4413
Jerry Yu438ddd82022-07-07 06:55:50 +00004414#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004415 case MBEDTLS_SSL_VERSION_TLS1_3:
4416 return ssl_tls13_session_load(session, p, remaining_len);
Jerry Yu438ddd82022-07-07 06:55:50 +00004417#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
4418
Gilles Peskine449bd832023-01-11 14:50:10 +01004419 default:
4420 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004421 }
4422}
4423
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004424/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02004425 * Deserialize session: public wrapper for error cleaning
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02004426 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004427int mbedtls_ssl_session_load(mbedtls_ssl_session *session,
4428 const unsigned char *buf,
4429 size_t len)
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02004430{
Gilles Peskine449bd832023-01-11 14:50:10 +01004431 int ret = ssl_session_load(session, 0, buf, len);
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02004432
Gilles Peskine449bd832023-01-11 14:50:10 +01004433 if (ret != 0) {
4434 mbedtls_ssl_session_free(session);
4435 }
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02004436
Gilles Peskine449bd832023-01-11 14:50:10 +01004437 return ret;
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02004438}
4439
4440/*
Paul Bakker1961b702013-01-25 14:49:24 +01004441 * Perform a single step of the SSL handshake
Paul Bakker5121ce52009-01-03 21:22:43 +00004442 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004443MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004444static int ssl_prepare_handshake_step(mbedtls_ssl_context *ssl)
Hanno Becker41934dd2021-08-07 19:13:43 +01004445{
4446 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
4447
Ronald Cron66dbf912022-02-02 15:33:46 +01004448 /*
4449 * We may have not been able to send to the peer all the handshake data
Ronald Cron3f20b772022-03-08 16:00:02 +01004450 * that were written into the output buffer by the previous handshake step,
4451 * if the write to the network callback returned with the
Ronald Cron66dbf912022-02-02 15:33:46 +01004452 * #MBEDTLS_ERR_SSL_WANT_WRITE error code.
4453 * We proceed to the next handshake step only when all data from the
4454 * previous one have been sent to the peer, thus we make sure that this is
4455 * the case here by calling `mbedtls_ssl_flush_output()`. The function may
4456 * return with the #MBEDTLS_ERR_SSL_WANT_WRITE error code in which case
4457 * we have to wait before to go ahead.
4458 * In the case of TLS 1.3, handshake step handlers do not send data to the
4459 * peer. Data are only sent here and through
4460 * `mbedtls_ssl_handle_pending_alert` in case an error that triggered an
Andrzej Kurek5c65c572022-04-13 14:28:52 -04004461 * alert occurred.
Ronald Cron66dbf912022-02-02 15:33:46 +01004462 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004463 if ((ret = mbedtls_ssl_flush_output(ssl)) != 0) {
4464 return ret;
4465 }
Hanno Becker41934dd2021-08-07 19:13:43 +01004466
4467#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004468 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
4469 ssl->handshake->retransmit_state == MBEDTLS_SSL_RETRANS_SENDING) {
4470 if ((ret = mbedtls_ssl_flight_transmit(ssl)) != 0) {
4471 return ret;
4472 }
Hanno Becker41934dd2021-08-07 19:13:43 +01004473 }
4474#endif /* MBEDTLS_SSL_PROTO_DTLS */
4475
Gilles Peskine449bd832023-01-11 14:50:10 +01004476 return ret;
Hanno Becker41934dd2021-08-07 19:13:43 +01004477}
4478
Gilles Peskine449bd832023-01-11 14:50:10 +01004479int mbedtls_ssl_handshake_step(mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00004480{
Hanno Becker41934dd2021-08-07 19:13:43 +01004481 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00004482
Gilles Peskine449bd832023-01-11 14:50:10 +01004483 if (ssl == NULL ||
Hanno Becker41934dd2021-08-07 19:13:43 +01004484 ssl->conf == NULL ||
4485 ssl->handshake == NULL ||
Gilles Peskine449bd832023-01-11 14:50:10 +01004486 ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER) {
4487 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Becker41934dd2021-08-07 19:13:43 +01004488 }
4489
Gilles Peskine449bd832023-01-11 14:50:10 +01004490 ret = ssl_prepare_handshake_step(ssl);
4491 if (ret != 0) {
4492 return ret;
4493 }
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02004494
Gilles Peskine449bd832023-01-11 14:50:10 +01004495 ret = mbedtls_ssl_handle_pending_alert(ssl);
4496 if (ret != 0) {
Jerry Yue7047812021-09-13 19:26:39 +08004497 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01004498 }
Jerry Yue7047812021-09-13 19:26:39 +08004499
Tom Cosgrove2fdc7b32022-09-21 12:33:17 +01004500 /* If ssl->conf->endpoint is not one of MBEDTLS_SSL_IS_CLIENT or
4501 * MBEDTLS_SSL_IS_SERVER, this is the return code we give */
4502 ret = MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4503
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004504#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004505 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
4506 MBEDTLS_SSL_DEBUG_MSG(2, ("client state: %s",
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01004507 mbedtls_ssl_states_str((mbedtls_ssl_states) ssl->state)));
Jerry Yub9930e72021-08-06 17:11:51 +08004508
Gilles Peskine449bd832023-01-11 14:50:10 +01004509 switch (ssl->state) {
Ronald Cron9f0fba32022-02-10 16:45:15 +01004510 case MBEDTLS_SSL_HELLO_REQUEST:
4511 ssl->state = MBEDTLS_SSL_CLIENT_HELLO;
Tom Cosgrove87d9c6c2022-09-22 09:27:56 +01004512 ret = 0;
Ronald Cron9f0fba32022-02-10 16:45:15 +01004513 break;
Jerry Yub9930e72021-08-06 17:11:51 +08004514
Ronald Cron9f0fba32022-02-10 16:45:15 +01004515 case MBEDTLS_SSL_CLIENT_HELLO:
Gilles Peskine449bd832023-01-11 14:50:10 +01004516 ret = mbedtls_ssl_write_client_hello(ssl);
Ronald Cron9f0fba32022-02-10 16:45:15 +01004517 break;
4518
4519 default:
4520#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004521 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
4522 ret = mbedtls_ssl_tls13_handshake_client_step(ssl);
4523 } else {
4524 ret = mbedtls_ssl_handshake_client_step(ssl);
4525 }
Ronald Cron9f0fba32022-02-10 16:45:15 +01004526#elif defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01004527 ret = mbedtls_ssl_handshake_client_step(ssl);
Ronald Cron9f0fba32022-02-10 16:45:15 +01004528#else
Gilles Peskine449bd832023-01-11 14:50:10 +01004529 ret = mbedtls_ssl_tls13_handshake_client_step(ssl);
Ronald Cron9f0fba32022-02-10 16:45:15 +01004530#endif
4531 }
Jerry Yub9930e72021-08-06 17:11:51 +08004532 }
Ronald Cron6291b232023-03-08 15:51:25 +01004533#endif /* MBEDTLS_SSL_CLI_C */
4534
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004535#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004536 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Ronald Cron6291b232023-03-08 15:51:25 +01004537#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
4538 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Gilles Peskine449bd832023-01-11 14:50:10 +01004539 ret = mbedtls_ssl_tls13_handshake_server_step(ssl);
Ronald Cron6291b232023-03-08 15:51:25 +01004540 } else {
Gilles Peskine449bd832023-01-11 14:50:10 +01004541 ret = mbedtls_ssl_handshake_server_step(ssl);
4542 }
Ronald Cron6291b232023-03-08 15:51:25 +01004543#elif defined(MBEDTLS_SSL_PROTO_TLS1_2)
4544 ret = mbedtls_ssl_handshake_server_step(ssl);
4545#else
4546 ret = mbedtls_ssl_tls13_handshake_server_step(ssl);
Paul Bakker5121ce52009-01-03 21:22:43 +00004547#endif
Ronald Cron6291b232023-03-08 15:51:25 +01004548 }
4549#endif /* MBEDTLS_SSL_SRV_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00004550
Gilles Peskine449bd832023-01-11 14:50:10 +01004551 if (ret != 0) {
Jerry Yubbd5a3f2021-09-18 20:50:22 +08004552 /* handshake_step return error. And it is same
4553 * with alert_reason.
4554 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004555 if (ssl->send_alert) {
4556 ret = mbedtls_ssl_handle_pending_alert(ssl);
Jerry Yue7047812021-09-13 19:26:39 +08004557 goto cleanup;
4558 }
4559 }
4560
4561cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +01004562 return ret;
Paul Bakker1961b702013-01-25 14:49:24 +01004563}
4564
4565/*
4566 * Perform the SSL handshake
4567 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004568int mbedtls_ssl_handshake(mbedtls_ssl_context *ssl)
Paul Bakker1961b702013-01-25 14:49:24 +01004569{
4570 int ret = 0;
4571
Hanno Beckera817ea42020-10-20 15:20:23 +01004572 /* Sanity checks */
4573
Gilles Peskine449bd832023-01-11 14:50:10 +01004574 if (ssl == NULL || ssl->conf == NULL) {
4575 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4576 }
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02004577
Hanno Beckera817ea42020-10-20 15:20:23 +01004578#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004579 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
4580 (ssl->f_set_timer == NULL || ssl->f_get_timer == NULL)) {
4581 MBEDTLS_SSL_DEBUG_MSG(1, ("You must use "
4582 "mbedtls_ssl_set_timer_cb() for DTLS"));
4583 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Beckera817ea42020-10-20 15:20:23 +01004584 }
4585#endif /* MBEDTLS_SSL_PROTO_DTLS */
4586
Gilles Peskine449bd832023-01-11 14:50:10 +01004587 MBEDTLS_SSL_DEBUG_MSG(2, ("=> handshake"));
Paul Bakker1961b702013-01-25 14:49:24 +01004588
Hanno Beckera817ea42020-10-20 15:20:23 +01004589 /* Main handshake loop */
Gilles Peskine449bd832023-01-11 14:50:10 +01004590 while (ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER) {
4591 ret = mbedtls_ssl_handshake_step(ssl);
Paul Bakker1961b702013-01-25 14:49:24 +01004592
Gilles Peskine449bd832023-01-11 14:50:10 +01004593 if (ret != 0) {
Paul Bakker1961b702013-01-25 14:49:24 +01004594 break;
Gilles Peskine449bd832023-01-11 14:50:10 +01004595 }
Paul Bakker1961b702013-01-25 14:49:24 +01004596 }
4597
Gilles Peskine449bd832023-01-11 14:50:10 +01004598 MBEDTLS_SSL_DEBUG_MSG(2, ("<= handshake"));
Paul Bakker5121ce52009-01-03 21:22:43 +00004599
Gilles Peskine449bd832023-01-11 14:50:10 +01004600 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00004601}
4602
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004603#if defined(MBEDTLS_SSL_RENEGOTIATION)
4604#if defined(MBEDTLS_SSL_SRV_C)
Paul Bakker5121ce52009-01-03 21:22:43 +00004605/*
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004606 * Write HelloRequest to request renegotiation on server
Paul Bakker48916f92012-09-16 19:57:18 +00004607 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004608MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004609static int ssl_write_hello_request(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004610{
Janos Follath865b3eb2019-12-16 11:46:15 +00004611 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004612
Gilles Peskine449bd832023-01-11 14:50:10 +01004613 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write hello request"));
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004614
4615 ssl->out_msglen = 4;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004616 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
4617 ssl->out_msg[0] = MBEDTLS_SSL_HS_HELLO_REQUEST;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004618
Gilles Peskine449bd832023-01-11 14:50:10 +01004619 if ((ret = mbedtls_ssl_write_handshake_msg(ssl)) != 0) {
4620 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_handshake_msg", ret);
4621 return ret;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004622 }
4623
Gilles Peskine449bd832023-01-11 14:50:10 +01004624 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write hello request"));
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004625
Gilles Peskine449bd832023-01-11 14:50:10 +01004626 return 0;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004627}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004628#endif /* MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004629
4630/*
4631 * Actually renegotiate current connection, triggered by either:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004632 * - any side: calling mbedtls_ssl_renegotiate(),
4633 * - client: receiving a HelloRequest during mbedtls_ssl_read(),
4634 * - server: receiving any handshake message on server during mbedtls_ssl_read() after
Manuel Pégourié-Gonnard55e4ff22014-08-19 11:16:35 +02004635 * the initial handshake is completed.
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004636 * If the handshake doesn't complete due to waiting for I/O, it will continue
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004637 * during the next calls to mbedtls_ssl_renegotiate() or mbedtls_ssl_read() respectively.
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004638 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004639int mbedtls_ssl_start_renegotiation(mbedtls_ssl_context *ssl)
Paul Bakker48916f92012-09-16 19:57:18 +00004640{
Janos Follath865b3eb2019-12-16 11:46:15 +00004641 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker48916f92012-09-16 19:57:18 +00004642
Gilles Peskine449bd832023-01-11 14:50:10 +01004643 MBEDTLS_SSL_DEBUG_MSG(2, ("=> renegotiate"));
Paul Bakker48916f92012-09-16 19:57:18 +00004644
Gilles Peskine449bd832023-01-11 14:50:10 +01004645 if ((ret = ssl_handshake_init(ssl)) != 0) {
4646 return ret;
4647 }
Paul Bakker48916f92012-09-16 19:57:18 +00004648
Manuel Pégourié-Gonnard0557bd52014-08-19 19:18:39 +02004649 /* RFC 6347 4.2.2: "[...] the HelloRequest will have message_seq = 0 and
4650 * the ServerHello will have message_seq = 1" */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004651#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004652 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
4653 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING) {
4654 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02004655 ssl->handshake->out_msg_seq = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004656 } else {
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02004657 ssl->handshake->in_msg_seq = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004658 }
Manuel Pégourié-Gonnard0557bd52014-08-19 19:18:39 +02004659 }
4660#endif
4661
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004662 ssl->state = MBEDTLS_SSL_HELLO_REQUEST;
4663 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS;
Paul Bakker48916f92012-09-16 19:57:18 +00004664
Gilles Peskine449bd832023-01-11 14:50:10 +01004665 if ((ret = mbedtls_ssl_handshake(ssl)) != 0) {
4666 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_handshake", ret);
4667 return ret;
Paul Bakker48916f92012-09-16 19:57:18 +00004668 }
4669
Gilles Peskine449bd832023-01-11 14:50:10 +01004670 MBEDTLS_SSL_DEBUG_MSG(2, ("<= renegotiate"));
Paul Bakker48916f92012-09-16 19:57:18 +00004671
Gilles Peskine449bd832023-01-11 14:50:10 +01004672 return 0;
Paul Bakker48916f92012-09-16 19:57:18 +00004673}
4674
4675/*
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004676 * Renegotiate current connection on client,
4677 * or request renegotiation on server
4678 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004679int mbedtls_ssl_renegotiate(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004680{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004681 int ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004682
Gilles Peskine449bd832023-01-11 14:50:10 +01004683 if (ssl == NULL || ssl->conf == NULL) {
4684 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4685 }
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02004686
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004687#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004688 /* On server, just send the request */
Gilles Peskine449bd832023-01-11 14:50:10 +01004689 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
4690 if (mbedtls_ssl_is_handshake_over(ssl) == 0) {
4691 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4692 }
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004693
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004694 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_PENDING;
Manuel Pégourié-Gonnardf07f4212014-08-15 19:04:47 +02004695
4696 /* Did we already try/start sending HelloRequest? */
Gilles Peskine449bd832023-01-11 14:50:10 +01004697 if (ssl->out_left != 0) {
4698 return mbedtls_ssl_flush_output(ssl);
4699 }
Manuel Pégourié-Gonnardf07f4212014-08-15 19:04:47 +02004700
Gilles Peskine449bd832023-01-11 14:50:10 +01004701 return ssl_write_hello_request(ssl);
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004702 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004703#endif /* MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004704
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004705#if defined(MBEDTLS_SSL_CLI_C)
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004706 /*
4707 * On client, either start the renegotiation process or,
4708 * if already in progress, continue the handshake
4709 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004710 if (ssl->renego_status != MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS) {
4711 if (mbedtls_ssl_is_handshake_over(ssl) == 0) {
4712 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004713 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004714
4715 if ((ret = mbedtls_ssl_start_renegotiation(ssl)) != 0) {
4716 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_start_renegotiation", ret);
4717 return ret;
4718 }
4719 } else {
4720 if ((ret = mbedtls_ssl_handshake(ssl)) != 0) {
4721 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_handshake", ret);
4722 return ret;
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004723 }
4724 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004725#endif /* MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004726
Gilles Peskine449bd832023-01-11 14:50:10 +01004727 return ret;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004728}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004729#endif /* MBEDTLS_SSL_RENEGOTIATION */
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004730
Gilles Peskine449bd832023-01-11 14:50:10 +01004731void mbedtls_ssl_handshake_free(mbedtls_ssl_context *ssl)
Paul Bakker48916f92012-09-16 19:57:18 +00004732{
Gilles Peskine9b562d52018-04-25 20:32:43 +02004733 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
4734
Gilles Peskine449bd832023-01-11 14:50:10 +01004735 if (handshake == NULL) {
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004736 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01004737 }
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004738
Valerio Setti6f0441d2023-07-03 12:11:36 +02004739#if defined(MBEDTLS_PK_HAVE_ECC_KEYS)
Brett Warrene0edc842021-08-17 09:53:13 +01004740#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004741 if (ssl->handshake->group_list_heap_allocated) {
4742 mbedtls_free((void *) handshake->group_list);
4743 }
Brett Warrene0edc842021-08-17 09:53:13 +01004744 handshake->group_list = NULL;
4745#endif /* MBEDTLS_DEPRECATED_REMOVED */
Valerio Setti6f0441d2023-07-03 12:11:36 +02004746#endif /* MBEDTLS_PK_HAVE_ECC_KEYS */
Brett Warrene0edc842021-08-17 09:53:13 +01004747
Ronald Crone68ab4f2022-10-05 12:46:29 +02004748#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yuf017ee42022-01-12 15:49:48 +08004749#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004750 if (ssl->handshake->sig_algs_heap_allocated) {
4751 mbedtls_free((void *) handshake->sig_algs);
4752 }
Jerry Yuf017ee42022-01-12 15:49:48 +08004753 handshake->sig_algs = NULL;
4754#endif /* MBEDTLS_DEPRECATED_REMOVED */
Xiaofei Baic234ecf2022-02-08 09:59:23 +00004755#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004756 if (ssl->handshake->certificate_request_context) {
4757 mbedtls_free((void *) handshake->certificate_request_context);
Xiaofei Baic234ecf2022-02-08 09:59:23 +00004758 }
4759#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Ronald Crone68ab4f2022-10-05 12:46:29 +02004760#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Jerry Yuf017ee42022-01-12 15:49:48 +08004761
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02004762#if defined(MBEDTLS_SSL_ASYNC_PRIVATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01004763 if (ssl->conf->f_async_cancel != NULL && handshake->async_in_progress != 0) {
4764 ssl->conf->f_async_cancel(ssl);
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02004765 handshake->async_in_progress = 0;
4766 }
4767#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
4768
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01004769#if defined(MBEDTLS_MD_CAN_SHA256)
Andrzej Kurekeb342242019-01-29 09:14:33 -05004770#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01004771 psa_hash_abort(&handshake->fin_sha256_psa);
Andrzej Kurekeb342242019-01-29 09:14:33 -05004772#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01004773 mbedtls_md_free(&handshake->fin_sha256);
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02004774#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -05004775#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01004776#if defined(MBEDTLS_MD_CAN_SHA384)
Andrzej Kurekeb342242019-01-29 09:14:33 -05004777#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01004778 psa_hash_abort(&handshake->fin_sha384_psa);
Andrzej Kurekeb342242019-01-29 09:14:33 -05004779#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01004780 mbedtls_md_free(&handshake->fin_sha384);
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02004781#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -05004782#endif
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02004783
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004784#if defined(MBEDTLS_DHM_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004785 mbedtls_dhm_free(&handshake->dhm_ctx);
Paul Bakker48916f92012-09-16 19:57:18 +00004786#endif
Valerio Setti7aeec542023-07-05 18:57:21 +02004787#if !defined(MBEDTLS_USE_PSA_CRYPTO) && \
Valerio Setti6eb00542023-07-07 17:04:24 +02004788 defined(MBEDTLS_KEY_EXCHANGE_SOME_ECDH_OR_ECDHE_1_2_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004789 mbedtls_ecdh_free(&handshake->ecdh_ctx);
Paul Bakker61d113b2013-07-04 11:51:43 +02004790#endif
Valerio Setti02c25b52022-11-15 14:08:42 +01004791
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02004792#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Neil Armstrongca7d5062022-05-31 14:43:23 +02004793#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01004794 psa_pake_abort(&handshake->psa_pake_ctx);
Valerio Settieb3f7882022-12-08 18:42:58 +01004795 /*
4796 * Opaque keys are not stored in the handshake's data and it's the user
4797 * responsibility to destroy them. Clear ones, instead, are created by
4798 * the TLS library and should be destroyed at the same level
4799 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004800 if (!mbedtls_svc_key_id_is_null(handshake->psa_pake_password)) {
4801 psa_destroy_key(handshake->psa_pake_password);
Valerio Settieb3f7882022-12-08 18:42:58 +01004802 }
Neil Armstrongca7d5062022-05-31 14:43:23 +02004803 handshake->psa_pake_password = MBEDTLS_SVC_KEY_ID_INIT;
4804#else
Gilles Peskine449bd832023-01-11 14:50:10 +01004805 mbedtls_ecjpake_free(&handshake->ecjpake_ctx);
Neil Armstrongca7d5062022-05-31 14:43:23 +02004806#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard77c06462015-09-17 13:59:49 +02004807#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004808 mbedtls_free(handshake->ecjpake_cache);
Manuel Pégourié-Gonnard77c06462015-09-17 13:59:49 +02004809 handshake->ecjpake_cache = NULL;
4810 handshake->ecjpake_cache_len = 0;
4811#endif
Manuel Pégourié-Gonnard76cfd3f2015-09-15 12:10:54 +02004812#endif
Paul Bakker61d113b2013-07-04 11:51:43 +02004813
Valerio Setti7aeec542023-07-05 18:57:21 +02004814#if defined(MBEDTLS_KEY_EXCHANGE_SOME_ECDH_OR_ECDHE_ANY_ENABLED) || \
Valerio Setti45d56f32023-07-13 17:23:20 +02004815 defined(MBEDTLS_KEY_EXCHANGE_WITH_ECDSA_ANY_ENABLED) || \
Janos Follath4ae5c292016-02-10 11:27:43 +00004816 defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Paul Bakker9af723c2014-05-01 13:03:14 +02004817 /* explicit void pointer cast for buggy MS compiler */
Gilles Peskine449bd832023-01-11 14:50:10 +01004818 mbedtls_free((void *) handshake->curves_tls_id);
Manuel Pégourié-Gonnardd09453c2013-09-23 19:11:32 +02004819#endif
4820
Ronald Cron73fe8df2022-10-05 14:31:43 +02004821#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED)
Neil Armstrong501c9322022-05-03 09:35:09 +02004822#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01004823 if (!mbedtls_svc_key_id_is_null(ssl->handshake->psk_opaque)) {
Neil Armstrong501c9322022-05-03 09:35:09 +02004824 /* The maintenance of the external PSK key slot is the
4825 * user's responsibility. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004826 if (ssl->handshake->psk_opaque_is_internal) {
4827 psa_destroy_key(ssl->handshake->psk_opaque);
Neil Armstrong501c9322022-05-03 09:35:09 +02004828 ssl->handshake->psk_opaque_is_internal = 0;
4829 }
4830 ssl->handshake->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
4831 }
Neil Armstronge952a302022-05-03 10:22:14 +02004832#else
Gilles Peskine449bd832023-01-11 14:50:10 +01004833 if (handshake->psk != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01004834 mbedtls_zeroize_and_free(handshake->psk, handshake->psk_len);
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01004835 }
Neil Armstronge952a302022-05-03 10:22:14 +02004836#endif /* MBEDTLS_USE_PSA_CRYPTO */
Ronald Cron73fe8df2022-10-05 14:31:43 +02004837#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED */
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01004838
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004839#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
4840 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Manuel Pégourié-Gonnard83724542013-09-24 22:30:56 +02004841 /*
4842 * Free only the linked list wrapper, not the keys themselves
4843 * since the belong to the SNI callback
4844 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004845 ssl_key_cert_free(handshake->sni_key_cert);
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004846#endif /* MBEDTLS_X509_CRT_PARSE_C && MBEDTLS_SSL_SERVER_NAME_INDICATION */
Manuel Pégourié-Gonnard705fcca2013-09-23 20:04:20 +02004847
Gilles Peskineeccd8882020-03-10 12:19:08 +01004848#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004849 mbedtls_x509_crt_restart_free(&handshake->ecrs_ctx);
4850 if (handshake->ecrs_peer_cert != NULL) {
4851 mbedtls_x509_crt_free(handshake->ecrs_peer_cert);
4852 mbedtls_free(handshake->ecrs_peer_cert);
Hanno Becker3dad3112019-02-05 17:19:52 +00004853 }
Manuel Pégourié-Gonnard862cde52017-05-17 11:56:15 +02004854#endif
4855
Hanno Becker75173122019-02-06 16:18:31 +00004856#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
4857 !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01004858 mbedtls_pk_free(&handshake->peer_pubkey);
Hanno Becker75173122019-02-06 16:18:31 +00004859#endif /* MBEDTLS_X509_CRT_PARSE_C && !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
4860
XiaokangQian9b93c0d2022-02-09 06:02:25 +00004861#if defined(MBEDTLS_SSL_CLI_C) && \
Gilles Peskine449bd832023-01-11 14:50:10 +01004862 (defined(MBEDTLS_SSL_PROTO_DTLS) || defined(MBEDTLS_SSL_PROTO_TLS1_3))
4863 mbedtls_free(handshake->cookie);
XiaokangQian9b93c0d2022-02-09 06:02:25 +00004864#endif /* MBEDTLS_SSL_CLI_C &&
4865 ( MBEDTLS_SSL_PROTO_DTLS || MBEDTLS_SSL_PROTO_TLS1_3 ) */
XiaokangQian8499b6c2022-01-27 09:00:11 +00004866
4867#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004868 mbedtls_ssl_flight_free(handshake->flight);
4869 mbedtls_ssl_buffering_free(ssl);
XiaokangQian8499b6c2022-01-27 09:00:11 +00004870#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard74848812014-07-11 02:43:49 +02004871
Valerio Settiea59c432023-07-25 11:14:03 +02004872#if defined(MBEDTLS_KEY_EXCHANGE_SOME_XXDH_PSA_ANY_ENABLED)
Przemek Stekiel7ac93be2023-07-04 10:02:38 +02004873 if (handshake->xxdh_psa_privkey_is_external == 0) {
4874 psa_destroy_key(handshake->xxdh_psa_privkey);
Gilles Peskine449bd832023-01-11 14:50:10 +01004875 }
Valerio Settiea59c432023-07-25 11:14:03 +02004876#endif /* MBEDTLS_KEY_EXCHANGE_SOME_XXDH_PSA_ANY_ENABLED */
Hanno Becker4a63ed42019-01-08 11:39:35 +00004877
Ronald Cron6f135e12021-12-08 16:57:54 +01004878#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004879 mbedtls_ssl_transform_free(handshake->transform_handshake);
4880 mbedtls_free(handshake->transform_handshake);
Jerry Yu3d9b5902022-11-04 14:07:25 +08004881#if defined(MBEDTLS_SSL_EARLY_DATA)
Gilles Peskine449bd832023-01-11 14:50:10 +01004882 mbedtls_ssl_transform_free(handshake->transform_earlydata);
4883 mbedtls_free(handshake->transform_earlydata);
Jerry Yu3d9b5902022-11-04 14:07:25 +08004884#endif
Ronald Cron6f135e12021-12-08 16:57:54 +01004885#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yuba9c7272021-10-30 11:54:10 +08004886
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05004887
4888#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
4889 /* If the buffers are too big - reallocate. Because of the way Mbed TLS
4890 * processes datagrams and the fact that a datagram is allowed to have
4891 * several records in it, it is possible that the I/O buffers are not
4892 * empty at this stage */
Gilles Peskine449bd832023-01-11 14:50:10 +01004893 handle_buffer_resizing(ssl, 1, mbedtls_ssl_get_input_buflen(ssl),
4894 mbedtls_ssl_get_output_buflen(ssl));
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05004895#endif
Hanno Becker3aa186f2021-08-10 09:24:19 +01004896
Jerry Yuba9c7272021-10-30 11:54:10 +08004897 /* mbedtls_platform_zeroize MUST be last one in this function */
Gilles Peskine449bd832023-01-11 14:50:10 +01004898 mbedtls_platform_zeroize(handshake,
4899 sizeof(mbedtls_ssl_handshake_params));
Paul Bakker48916f92012-09-16 19:57:18 +00004900}
4901
Gilles Peskine449bd832023-01-11 14:50:10 +01004902void mbedtls_ssl_session_free(mbedtls_ssl_session *session)
Paul Bakker48916f92012-09-16 19:57:18 +00004903{
Gilles Peskine449bd832023-01-11 14:50:10 +01004904 if (session == NULL) {
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004905 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01004906 }
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004907
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004908#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004909 ssl_clear_peer_cert(session);
Paul Bakkered27a042013-04-18 22:46:23 +02004910#endif
Paul Bakker0a597072012-09-25 21:55:46 +00004911
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02004912#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
Xiaokang Qianbc663a02022-10-09 11:14:39 +00004913#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && \
4914 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01004915 mbedtls_free(session->hostname);
Xiaokang Qian281fd1b2022-09-20 11:35:41 +00004916#endif
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00004917 mbedtls_free(session->ticket);
4918#endif
4919
Waleed Elmelegy2824a202024-02-23 17:51:47 +00004920#if defined(MBEDTLS_SSL_EARLY_DATA) && defined(MBEDTLS_SSL_ALPN) && \
4921 defined(MBEDTLS_SSL_SRV_C)
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00004922 mbedtls_free(session->ticket_alpn);
Paul Bakkera503a632013-08-14 13:48:06 +02004923#endif
Manuel Pégourié-Gonnard75d44012013-08-02 14:44:04 +02004924
Gilles Peskine449bd832023-01-11 14:50:10 +01004925 mbedtls_platform_zeroize(session, sizeof(mbedtls_ssl_session));
Paul Bakker48916f92012-09-16 19:57:18 +00004926}
4927
Manuel Pégourié-Gonnard5c0e3772019-07-23 16:13:17 +02004928#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004929
4930#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
4931#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID 1u
4932#else
4933#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID 0u
4934#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
4935
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004936#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT 1u
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004937
4938#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
4939#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY 1u
4940#else
4941#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY 0u
4942#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
4943
4944#if defined(MBEDTLS_SSL_ALPN)
4945#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN 1u
4946#else
4947#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN 0u
4948#endif /* MBEDTLS_SSL_ALPN */
4949
4950#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID_BIT 0
4951#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT_BIT 1
4952#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY_BIT 2
4953#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN_BIT 3
4954
4955#define SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG \
Gilles Peskine449bd832023-01-11 14:50:10 +01004956 ((uint32_t) ( \
4957 (SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID << \
4958 SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID_BIT) | \
4959 (SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT << \
4960 SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT_BIT) | \
4961 (SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY << \
4962 SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY_BIT) | \
4963 (SSL_SERIALIZED_CONTEXT_CONFIG_ALPN << SSL_SERIALIZED_CONTEXT_CONFIG_ALPN_BIT) | \
4964 0u))
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004965
Chien Wong4e9683e2023-12-28 17:07:43 +08004966static const unsigned char ssl_serialized_context_header[] = {
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004967 MBEDTLS_VERSION_MAJOR,
4968 MBEDTLS_VERSION_MINOR,
4969 MBEDTLS_VERSION_PATCH,
Gilles Peskine449bd832023-01-11 14:50:10 +01004970 MBEDTLS_BYTE_1(SSL_SERIALIZED_SESSION_CONFIG_BITFLAG),
4971 MBEDTLS_BYTE_0(SSL_SERIALIZED_SESSION_CONFIG_BITFLAG),
4972 MBEDTLS_BYTE_2(SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG),
4973 MBEDTLS_BYTE_1(SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG),
4974 MBEDTLS_BYTE_0(SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG),
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004975};
4976
Paul Bakker5121ce52009-01-03 21:22:43 +00004977/*
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004978 * Serialize a full SSL context
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02004979 *
4980 * The format of the serialized data is:
4981 * (in the presentation language of TLS, RFC 8446 section 3)
4982 *
4983 * // header
4984 * opaque mbedtls_version[3]; // major, minor, patch
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004985 * opaque context_format[5]; // version-specific field determining
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02004986 * // the format of the remaining
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004987 * // serialized data.
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004988 * Note: When updating the format, remember to keep these
4989 * version+format bytes. (We may make their size part of the API.)
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02004990 *
4991 * // session sub-structure
4992 * opaque session<1..2^32-1>; // see mbedtls_ssl_session_save()
4993 * // transform sub-structure
4994 * uint8 random[64]; // ServerHello.random+ClientHello.random
4995 * uint8 in_cid<0..2^8-1> // Connection ID: expected incoming value
4996 * uint8 out_cid<0..2^8-1> // Connection ID: outgoing value to use
4997 * // fields from ssl_context
4998 * uint32 badmac_seen; // DTLS: number of records with failing MAC
4999 * uint64 in_window_top; // DTLS: last validated record seq_num
5000 * uint64 in_window; // DTLS: bitmask for replay protection
5001 * uint8 disable_datagram_packing; // DTLS: only one record per datagram
5002 * uint64 cur_out_ctr; // Record layer: outgoing sequence number
5003 * uint16 mtu; // DTLS: path mtu (max outgoing fragment size)
5004 * uint8 alpn_chosen<0..2^8-1> // ALPN: negotiated application protocol
5005 *
5006 * Note that many fields of the ssl_context or sub-structures are not
5007 * serialized, as they fall in one of the following categories:
5008 *
5009 * 1. forced value (eg in_left must be 0)
5010 * 2. pointer to dynamically-allocated memory (eg session, transform)
5011 * 3. value can be re-derived from other data (eg session keys from MS)
5012 * 4. value was temporary (eg content of input buffer)
5013 * 5. value will be provided by the user again (eg I/O callbacks and context)
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005014 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005015int mbedtls_ssl_context_save(mbedtls_ssl_context *ssl,
5016 unsigned char *buf,
5017 size_t buf_len,
5018 size_t *olen)
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005019{
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005020 unsigned char *p = buf;
5021 size_t used = 0;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005022 size_t session_len;
5023 int ret = 0;
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005024
Manuel Pégourié-Gonnard1aaf6692019-07-10 14:14:05 +02005025 /*
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02005026 * Enforce usage restrictions, see "return BAD_INPUT_DATA" in
5027 * this function's documentation.
5028 *
5029 * These are due to assumptions/limitations in the implementation. Some of
5030 * them are likely to stay (no handshake in progress) some might go away
5031 * (only DTLS) but are currently used to simplify the implementation.
Manuel Pégourié-Gonnard1aaf6692019-07-10 14:14:05 +02005032 */
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02005033 /* The initial handshake must be over */
Gilles Peskine449bd832023-01-11 14:50:10 +01005034 if (mbedtls_ssl_is_handshake_over(ssl) == 0) {
5035 MBEDTLS_SSL_DEBUG_MSG(1, ("Initial handshake isn't over"));
5036 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03005037 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005038 if (ssl->handshake != NULL) {
5039 MBEDTLS_SSL_DEBUG_MSG(1, ("Handshake isn't completed"));
5040 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03005041 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02005042 /* Double-check that sub-structures are indeed ready */
Gilles Peskine449bd832023-01-11 14:50:10 +01005043 if (ssl->transform == NULL || ssl->session == NULL) {
5044 MBEDTLS_SSL_DEBUG_MSG(1, ("Serialised structures aren't ready"));
5045 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03005046 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02005047 /* There must be no pending incoming or outgoing data */
Gilles Peskine449bd832023-01-11 14:50:10 +01005048 if (mbedtls_ssl_check_pending(ssl) != 0) {
5049 MBEDTLS_SSL_DEBUG_MSG(1, ("There is pending incoming data"));
5050 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03005051 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005052 if (ssl->out_left != 0) {
5053 MBEDTLS_SSL_DEBUG_MSG(1, ("There is pending outgoing data"));
5054 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03005055 }
Dave Rodgman556e8a32022-12-06 16:31:25 +00005056 /* Protocol must be DTLS, not TLS */
Gilles Peskine449bd832023-01-11 14:50:10 +01005057 if (ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
5058 MBEDTLS_SSL_DEBUG_MSG(1, ("Only DTLS is supported"));
5059 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03005060 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02005061 /* Version must be 1.2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005062 if (ssl->tls_version != MBEDTLS_SSL_VERSION_TLS1_2) {
5063 MBEDTLS_SSL_DEBUG_MSG(1, ("Only version 1.2 supported"));
5064 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03005065 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02005066 /* We must be using an AEAD ciphersuite */
Gilles Peskine449bd832023-01-11 14:50:10 +01005067 if (mbedtls_ssl_transform_uses_aead(ssl->transform) != 1) {
5068 MBEDTLS_SSL_DEBUG_MSG(1, ("Only AEAD ciphersuites supported"));
5069 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03005070 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02005071 /* Renegotiation must not be enabled */
5072#if defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01005073 if (ssl->conf->disable_renegotiation != MBEDTLS_SSL_RENEGOTIATION_DISABLED) {
5074 MBEDTLS_SSL_DEBUG_MSG(1, ("Renegotiation must not be enabled"));
5075 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03005076 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02005077#endif
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005078
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005079 /*
5080 * Version and format identifier
5081 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005082 used += sizeof(ssl_serialized_context_header);
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005083
Gilles Peskine449bd832023-01-11 14:50:10 +01005084 if (used <= buf_len) {
5085 memcpy(p, ssl_serialized_context_header,
5086 sizeof(ssl_serialized_context_header));
5087 p += sizeof(ssl_serialized_context_header);
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005088 }
5089
5090 /*
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005091 * Session (length + data)
5092 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005093 ret = ssl_session_save(ssl->session, 1, NULL, 0, &session_len);
5094 if (ret != MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL) {
5095 return ret;
5096 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005097
5098 used += 4 + session_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01005099 if (used <= buf_len) {
5100 MBEDTLS_PUT_UINT32_BE(session_len, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01005101 p += 4;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005102
Gilles Peskine449bd832023-01-11 14:50:10 +01005103 ret = ssl_session_save(ssl->session, 1,
5104 p, session_len, &session_len);
5105 if (ret != 0) {
5106 return ret;
5107 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005108
5109 p += session_len;
5110 }
5111
5112 /*
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005113 * Transform
5114 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005115 used += sizeof(ssl->transform->randbytes);
5116 if (used <= buf_len) {
5117 memcpy(p, ssl->transform->randbytes,
5118 sizeof(ssl->transform->randbytes));
5119 p += sizeof(ssl->transform->randbytes);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005120 }
5121
5122#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Dave Rodgmanc37ad442023-11-03 23:36:06 +00005123 used += 2U + ssl->transform->in_cid_len + ssl->transform->out_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01005124 if (used <= buf_len) {
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005125 *p++ = ssl->transform->in_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01005126 memcpy(p, ssl->transform->in_cid, ssl->transform->in_cid_len);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005127 p += ssl->transform->in_cid_len;
5128
5129 *p++ = ssl->transform->out_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01005130 memcpy(p, ssl->transform->out_cid, ssl->transform->out_cid_len);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005131 p += ssl->transform->out_cid_len;
5132 }
5133#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
5134
5135 /*
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005136 * Saved fields from top-level ssl_context structure
5137 */
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005138 used += 4;
Gilles Peskine449bd832023-01-11 14:50:10 +01005139 if (used <= buf_len) {
5140 MBEDTLS_PUT_UINT32_BE(ssl->badmac_seen, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01005141 p += 4;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005142 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005143
5144#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
5145 used += 16;
Gilles Peskine449bd832023-01-11 14:50:10 +01005146 if (used <= buf_len) {
5147 MBEDTLS_PUT_UINT64_BE(ssl->in_window_top, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01005148 p += 8;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005149
Gilles Peskine449bd832023-01-11 14:50:10 +01005150 MBEDTLS_PUT_UINT64_BE(ssl->in_window, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01005151 p += 8;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005152 }
5153#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
5154
5155#if defined(MBEDTLS_SSL_PROTO_DTLS)
5156 used += 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01005157 if (used <= buf_len) {
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005158 *p++ = ssl->disable_datagram_packing;
5159 }
5160#endif /* MBEDTLS_SSL_PROTO_DTLS */
5161
Jerry Yuae0b2e22021-10-08 15:21:19 +08005162 used += MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Gilles Peskine449bd832023-01-11 14:50:10 +01005163 if (used <= buf_len) {
5164 memcpy(p, ssl->cur_out_ctr, MBEDTLS_SSL_SEQUENCE_NUMBER_LEN);
Jerry Yuae0b2e22021-10-08 15:21:19 +08005165 p += MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005166 }
5167
5168#if defined(MBEDTLS_SSL_PROTO_DTLS)
5169 used += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01005170 if (used <= buf_len) {
5171 MBEDTLS_PUT_UINT16_BE(ssl->mtu, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01005172 p += 2;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005173 }
5174#endif /* MBEDTLS_SSL_PROTO_DTLS */
5175
5176#if defined(MBEDTLS_SSL_ALPN)
5177 {
5178 const uint8_t alpn_len = ssl->alpn_chosen
Gilles Peskine449bd832023-01-11 14:50:10 +01005179 ? (uint8_t) strlen(ssl->alpn_chosen)
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005180 : 0;
5181
5182 used += 1 + alpn_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01005183 if (used <= buf_len) {
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005184 *p++ = alpn_len;
5185
Gilles Peskine449bd832023-01-11 14:50:10 +01005186 if (ssl->alpn_chosen != NULL) {
5187 memcpy(p, ssl->alpn_chosen, alpn_len);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005188 p += alpn_len;
5189 }
5190 }
5191 }
5192#endif /* MBEDTLS_SSL_ALPN */
5193
5194 /*
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005195 * Done
5196 */
5197 *olen = used;
5198
Gilles Peskine449bd832023-01-11 14:50:10 +01005199 if (used > buf_len) {
5200 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
5201 }
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005202
Gilles Peskine449bd832023-01-11 14:50:10 +01005203 MBEDTLS_SSL_DEBUG_BUF(4, "saved context", buf, used);
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005204
Gilles Peskine449bd832023-01-11 14:50:10 +01005205 return mbedtls_ssl_session_reset_int(ssl, 0);
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005206}
5207
5208/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02005209 * Deserialize context, see mbedtls_ssl_context_save() for format.
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005210 *
5211 * This internal version is wrapped by a public function that cleans up in
5212 * case of error.
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005213 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005214MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01005215static int ssl_context_load(mbedtls_ssl_context *ssl,
5216 const unsigned char *buf,
5217 size_t len)
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005218{
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005219 const unsigned char *p = buf;
5220 const unsigned char * const end = buf + len;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005221 size_t session_len;
Janos Follath865b3eb2019-12-16 11:46:15 +00005222 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04005223#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Andrzej Kurek894edde2022-09-29 06:31:14 -04005224 tls_prf_fn prf_func = NULL;
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04005225#endif
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005226
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02005227 /*
5228 * The context should have been freshly setup or reset.
5229 * Give the user an error in case of obvious misuse.
Manuel Pégourié-Gonnard4ca930f2019-07-26 16:31:53 +02005230 * (Checking session is useful because it won't be NULL if we're
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02005231 * renegotiating, or if the user mistakenly loaded a session first.)
5232 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005233 if (ssl->state != MBEDTLS_SSL_HELLO_REQUEST ||
5234 ssl->session != NULL) {
5235 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02005236 }
5237
5238 /*
5239 * We can't check that the config matches the initial one, but we can at
5240 * least check it matches the requirements for serializing.
5241 */
Dave Rodgmane99b24d2023-09-14 15:45:03 +01005242 if (
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02005243#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard9a96fd72019-07-23 17:11:24 +02005244 ssl->conf->disable_renegotiation != MBEDTLS_SSL_RENEGOTIATION_DISABLED ||
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02005245#endif
Dave Rodgmane99b24d2023-09-14 15:45:03 +01005246 ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM ||
5247 ssl->conf->max_tls_version < MBEDTLS_SSL_VERSION_TLS1_2 ||
5248 ssl->conf->min_tls_version > MBEDTLS_SSL_VERSION_TLS1_2
5249 ) {
Gilles Peskine449bd832023-01-11 14:50:10 +01005250 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02005251 }
5252
Gilles Peskine449bd832023-01-11 14:50:10 +01005253 MBEDTLS_SSL_DEBUG_BUF(4, "context to load", buf, len);
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005254
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005255 /*
5256 * Check version identifier
5257 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005258 if ((size_t) (end - p) < sizeof(ssl_serialized_context_header)) {
5259 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005260 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005261
5262 if (memcmp(p, ssl_serialized_context_header,
5263 sizeof(ssl_serialized_context_header)) != 0) {
5264 return MBEDTLS_ERR_SSL_VERSION_MISMATCH;
5265 }
5266 p += sizeof(ssl_serialized_context_header);
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005267
5268 /*
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005269 * Session
5270 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005271 if ((size_t) (end - p) < 4) {
5272 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5273 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005274
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01005275 session_len = MBEDTLS_GET_UINT32_BE(p, 0);
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005276 p += 4;
5277
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02005278 /* This has been allocated by ssl_handshake_init(), called by
Hanno Becker43aefe22020-02-05 10:44:56 +00005279 * by either mbedtls_ssl_session_reset_int() or mbedtls_ssl_setup(). */
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02005280 ssl->session = ssl->session_negotiate;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005281 ssl->session_in = ssl->session;
5282 ssl->session_out = ssl->session;
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02005283 ssl->session_negotiate = NULL;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005284
Gilles Peskine449bd832023-01-11 14:50:10 +01005285 if ((size_t) (end - p) < session_len) {
5286 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5287 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005288
Gilles Peskine449bd832023-01-11 14:50:10 +01005289 ret = ssl_session_load(ssl->session, 1, p, session_len);
5290 if (ret != 0) {
5291 mbedtls_ssl_session_free(ssl->session);
5292 return ret;
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02005293 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005294
5295 p += session_len;
5296
5297 /*
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005298 * Transform
5299 */
5300
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02005301 /* This has been allocated by ssl_handshake_init(), called by
Hanno Becker43aefe22020-02-05 10:44:56 +00005302 * by either mbedtls_ssl_session_reset_int() or mbedtls_ssl_setup(). */
Jerry Yu2e199812022-12-01 18:57:19 +08005303#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02005304 ssl->transform = ssl->transform_negotiate;
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005305 ssl->transform_in = ssl->transform;
5306 ssl->transform_out = ssl->transform;
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02005307 ssl->transform_negotiate = NULL;
Jerry Yu2e199812022-12-01 18:57:19 +08005308#endif
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005309
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04005310#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005311 prf_func = ssl_tls12prf_from_cs(ssl->session->ciphersuite);
5312 if (prf_func == NULL) {
5313 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5314 }
Andrzej Kurek894edde2022-09-29 06:31:14 -04005315
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005316 /* Read random bytes and populate structure */
Gilles Peskine449bd832023-01-11 14:50:10 +01005317 if ((size_t) (end - p) < sizeof(ssl->transform->randbytes)) {
5318 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5319 }
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04005320
Gilles Peskine449bd832023-01-11 14:50:10 +01005321 ret = ssl_tls12_populate_transform(ssl->transform,
5322 ssl->session->ciphersuite,
5323 ssl->session->master,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02005324#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01005325 ssl->session->encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02005326#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01005327 prf_func,
5328 p, /* currently pointing to randbytes */
5329 MBEDTLS_SSL_VERSION_TLS1_2, /* (D)TLS 1.2 is forced */
5330 ssl->conf->endpoint,
5331 ssl);
5332 if (ret != 0) {
5333 return ret;
5334 }
Jerry Yu840fbb22022-02-17 14:59:29 +08005335#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005336 p += sizeof(ssl->transform->randbytes);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005337
5338#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
5339 /* Read connection IDs and store them */
Gilles Peskine449bd832023-01-11 14:50:10 +01005340 if ((size_t) (end - p) < 1) {
5341 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5342 }
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005343
5344 ssl->transform->in_cid_len = *p++;
5345
Gilles Peskine449bd832023-01-11 14:50:10 +01005346 if ((size_t) (end - p) < ssl->transform->in_cid_len + 1u) {
5347 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5348 }
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005349
Gilles Peskine449bd832023-01-11 14:50:10 +01005350 memcpy(ssl->transform->in_cid, p, ssl->transform->in_cid_len);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005351 p += ssl->transform->in_cid_len;
5352
5353 ssl->transform->out_cid_len = *p++;
5354
Gilles Peskine449bd832023-01-11 14:50:10 +01005355 if ((size_t) (end - p) < ssl->transform->out_cid_len) {
5356 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5357 }
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005358
Gilles Peskine449bd832023-01-11 14:50:10 +01005359 memcpy(ssl->transform->out_cid, p, ssl->transform->out_cid_len);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005360 p += ssl->transform->out_cid_len;
5361#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
5362
5363 /*
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005364 * Saved fields from top-level ssl_context structure
5365 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005366 if ((size_t) (end - p) < 4) {
5367 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5368 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005369
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01005370 ssl->badmac_seen = MBEDTLS_GET_UINT32_BE(p, 0);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005371 p += 4;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005372
5373#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Gilles Peskine449bd832023-01-11 14:50:10 +01005374 if ((size_t) (end - p) < 16) {
5375 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5376 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005377
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01005378 ssl->in_window_top = MBEDTLS_GET_UINT64_BE(p, 0);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005379 p += 8;
5380
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01005381 ssl->in_window = MBEDTLS_GET_UINT64_BE(p, 0);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005382 p += 8;
5383#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
5384
5385#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005386 if ((size_t) (end - p) < 1) {
5387 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5388 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005389
5390 ssl->disable_datagram_packing = *p++;
5391#endif /* MBEDTLS_SSL_PROTO_DTLS */
5392
Gilles Peskine449bd832023-01-11 14:50:10 +01005393 if ((size_t) (end - p) < sizeof(ssl->cur_out_ctr)) {
5394 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5395 }
5396 memcpy(ssl->cur_out_ctr, p, sizeof(ssl->cur_out_ctr));
5397 p += sizeof(ssl->cur_out_ctr);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005398
5399#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005400 if ((size_t) (end - p) < 2) {
5401 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5402 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005403
Dave Rodgmana3d0f612023-11-03 23:34:02 +00005404 ssl->mtu = MBEDTLS_GET_UINT16_BE(p, 0);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005405 p += 2;
5406#endif /* MBEDTLS_SSL_PROTO_DTLS */
5407
5408#if defined(MBEDTLS_SSL_ALPN)
5409 {
5410 uint8_t alpn_len;
5411 const char **cur;
5412
Gilles Peskine449bd832023-01-11 14:50:10 +01005413 if ((size_t) (end - p) < 1) {
5414 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5415 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005416
5417 alpn_len = *p++;
5418
Gilles Peskine449bd832023-01-11 14:50:10 +01005419 if (alpn_len != 0 && ssl->conf->alpn_list != NULL) {
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005420 /* alpn_chosen should point to an item in the configured list */
Gilles Peskine449bd832023-01-11 14:50:10 +01005421 for (cur = ssl->conf->alpn_list; *cur != NULL; cur++) {
5422 if (strlen(*cur) == alpn_len &&
5423 memcmp(p, cur, alpn_len) == 0) {
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005424 ssl->alpn_chosen = *cur;
5425 break;
5426 }
5427 }
5428 }
5429
5430 /* can only happen on conf mismatch */
Gilles Peskine449bd832023-01-11 14:50:10 +01005431 if (alpn_len != 0 && ssl->alpn_chosen == NULL) {
5432 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5433 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005434
5435 p += alpn_len;
5436 }
5437#endif /* MBEDTLS_SSL_ALPN */
5438
5439 /*
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02005440 * Forced fields from top-level ssl_context structure
5441 *
5442 * Most of them already set to the correct value by mbedtls_ssl_init() and
5443 * mbedtls_ssl_reset(), so we only need to set the remaining ones.
5444 */
5445 ssl->state = MBEDTLS_SSL_HANDSHAKE_OVER;
Glenn Strauss60bfe602022-03-14 19:04:24 -04005446 ssl->tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02005447
Hanno Becker361b10d2019-08-30 10:42:49 +01005448 /* Adjust pointers for header fields of outgoing records to
5449 * the given transform, accounting for explicit IV and CID. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005450 mbedtls_ssl_update_out_pointers(ssl, ssl->transform);
Hanno Becker361b10d2019-08-30 10:42:49 +01005451
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02005452#if defined(MBEDTLS_SSL_PROTO_DTLS)
5453 ssl->in_epoch = 1;
5454#endif
5455
5456 /* mbedtls_ssl_reset() leaves the handshake sub-structure allocated,
5457 * which we don't want - otherwise we'd end up freeing the wrong transform
Hanno Beckerce5f5fd2020-02-05 10:47:44 +00005458 * by calling mbedtls_ssl_handshake_wrapup_free_hs_transform()
5459 * inappropriately. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005460 if (ssl->handshake != NULL) {
5461 mbedtls_ssl_handshake_free(ssl);
5462 mbedtls_free(ssl->handshake);
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02005463 ssl->handshake = NULL;
5464 }
5465
5466 /*
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005467 * Done - should have consumed entire buffer
5468 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005469 if (p != end) {
5470 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5471 }
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005472
Gilles Peskine449bd832023-01-11 14:50:10 +01005473 return 0;
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005474}
5475
5476/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02005477 * Deserialize context: public wrapper for error cleaning
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005478 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005479int mbedtls_ssl_context_load(mbedtls_ssl_context *context,
5480 const unsigned char *buf,
5481 size_t len)
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005482{
Gilles Peskine449bd832023-01-11 14:50:10 +01005483 int ret = ssl_context_load(context, buf, len);
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005484
Gilles Peskine449bd832023-01-11 14:50:10 +01005485 if (ret != 0) {
5486 mbedtls_ssl_free(context);
5487 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005488
Gilles Peskine449bd832023-01-11 14:50:10 +01005489 return ret;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005490}
Manuel Pégourié-Gonnard5c0e3772019-07-23 16:13:17 +02005491#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005492
5493/*
Paul Bakker5121ce52009-01-03 21:22:43 +00005494 * Free an SSL context
5495 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005496void mbedtls_ssl_free(mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00005497{
Gilles Peskine449bd832023-01-11 14:50:10 +01005498 if (ssl == NULL) {
Paul Bakkeraccaffe2014-06-26 13:37:14 +02005499 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01005500 }
Paul Bakkeraccaffe2014-06-26 13:37:14 +02005501
Gilles Peskine449bd832023-01-11 14:50:10 +01005502 MBEDTLS_SSL_DEBUG_MSG(2, ("=> free"));
Paul Bakker5121ce52009-01-03 21:22:43 +00005503
Gilles Peskine449bd832023-01-11 14:50:10 +01005504 if (ssl->out_buf != NULL) {
sander-visserb8aa2072020-05-06 22:05:13 +02005505#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
5506 size_t out_buf_len = ssl->out_buf_len;
5507#else
5508 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
5509#endif
5510
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005511 mbedtls_zeroize_and_free(ssl->out_buf, out_buf_len);
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05005512 ssl->out_buf = NULL;
Paul Bakker5121ce52009-01-03 21:22:43 +00005513 }
5514
Gilles Peskine449bd832023-01-11 14:50:10 +01005515 if (ssl->in_buf != NULL) {
sander-visserb8aa2072020-05-06 22:05:13 +02005516#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
5517 size_t in_buf_len = ssl->in_buf_len;
5518#else
5519 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
5520#endif
5521
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005522 mbedtls_zeroize_and_free(ssl->in_buf, in_buf_len);
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05005523 ssl->in_buf = NULL;
Paul Bakker5121ce52009-01-03 21:22:43 +00005524 }
5525
Gilles Peskine449bd832023-01-11 14:50:10 +01005526 if (ssl->transform) {
5527 mbedtls_ssl_transform_free(ssl->transform);
5528 mbedtls_free(ssl->transform);
Paul Bakker48916f92012-09-16 19:57:18 +00005529 }
5530
Gilles Peskine449bd832023-01-11 14:50:10 +01005531 if (ssl->handshake) {
5532 mbedtls_ssl_handshake_free(ssl);
5533 mbedtls_free(ssl->handshake);
Jerry Yu2e199812022-12-01 18:57:19 +08005534
5535#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005536 mbedtls_ssl_transform_free(ssl->transform_negotiate);
5537 mbedtls_free(ssl->transform_negotiate);
Jerry Yu2e199812022-12-01 18:57:19 +08005538#endif
5539
Gilles Peskine449bd832023-01-11 14:50:10 +01005540 mbedtls_ssl_session_free(ssl->session_negotiate);
5541 mbedtls_free(ssl->session_negotiate);
Paul Bakker48916f92012-09-16 19:57:18 +00005542 }
5543
Ronald Cron6f135e12021-12-08 16:57:54 +01005544#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01005545 mbedtls_ssl_transform_free(ssl->transform_application);
5546 mbedtls_free(ssl->transform_application);
Ronald Cron6f135e12021-12-08 16:57:54 +01005547#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker3aa186f2021-08-10 09:24:19 +01005548
Gilles Peskine449bd832023-01-11 14:50:10 +01005549 if (ssl->session) {
5550 mbedtls_ssl_session_free(ssl->session);
5551 mbedtls_free(ssl->session);
Paul Bakkerc0463502013-02-14 11:19:38 +01005552 }
5553
Manuel Pégourié-Gonnard55fab2d2015-05-11 16:15:19 +02005554#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005555 if (ssl->hostname != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005556 mbedtls_zeroize_and_free(ssl->hostname, strlen(ssl->hostname));
Paul Bakker5121ce52009-01-03 21:22:43 +00005557 }
Paul Bakker0be444a2013-08-27 21:55:01 +02005558#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00005559
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02005560#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005561 mbedtls_free(ssl->cli_id);
Manuel Pégourié-Gonnard43c02182014-07-22 17:32:01 +02005562#endif
5563
Gilles Peskine449bd832023-01-11 14:50:10 +01005564 MBEDTLS_SSL_DEBUG_MSG(2, ("<= free"));
Paul Bakker2da561c2009-02-05 18:00:28 +00005565
Paul Bakker86f04f42013-02-14 11:20:09 +01005566 /* Actually clear after last debug message */
Gilles Peskine449bd832023-01-11 14:50:10 +01005567 mbedtls_platform_zeroize(ssl, sizeof(mbedtls_ssl_context));
Paul Bakker5121ce52009-01-03 21:22:43 +00005568}
5569
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005570/*
Shaun Case8b0ecbc2021-12-20 21:14:10 -08005571 * Initialize mbedtls_ssl_config
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005572 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005573void mbedtls_ssl_config_init(mbedtls_ssl_config *conf)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005574{
Gilles Peskine449bd832023-01-11 14:50:10 +01005575 memset(conf, 0, sizeof(mbedtls_ssl_config));
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005576}
5577
Gilles Peskineae270bf2021-06-02 00:05:29 +02005578/* The selection should be the same as mbedtls_x509_crt_profile_default in
5579 * x509_crt.c, plus Montgomery curves for ECDHE. Here, the order matters:
Gilles Peskineb1940a72021-06-02 15:18:12 +02005580 * curves with a lower resource usage come first.
Gilles Peskineae270bf2021-06-02 00:05:29 +02005581 * See the documentation of mbedtls_ssl_conf_curves() for what we promise
Gilles Peskineb1940a72021-06-02 15:18:12 +02005582 * about this list.
5583 */
Chien Wong4e9683e2023-12-28 17:07:43 +08005584static const uint16_t ssl_preset_default_groups[] = {
Valerio Settidb6b4db2023-09-01 09:20:51 +02005585#if defined(MBEDTLS_ECP_HAVE_CURVE25519)
Brett Warrene0edc842021-08-17 09:53:13 +01005586 MBEDTLS_SSL_IANA_TLS_GROUP_X25519,
Gilles Peskineae270bf2021-06-02 00:05:29 +02005587#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005588#if defined(MBEDTLS_ECP_HAVE_SECP256R1)
Brett Warrene0edc842021-08-17 09:53:13 +01005589 MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1,
Gilles Peskineae270bf2021-06-02 00:05:29 +02005590#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005591#if defined(MBEDTLS_ECP_HAVE_SECP384R1)
Brett Warrene0edc842021-08-17 09:53:13 +01005592 MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02005593#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005594#if defined(MBEDTLS_ECP_HAVE_CURVE448)
Brett Warrene0edc842021-08-17 09:53:13 +01005595 MBEDTLS_SSL_IANA_TLS_GROUP_X448,
Gilles Peskineb1940a72021-06-02 15:18:12 +02005596#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005597#if defined(MBEDTLS_ECP_HAVE_SECP521R1)
Brett Warrene0edc842021-08-17 09:53:13 +01005598 MBEDTLS_SSL_IANA_TLS_GROUP_SECP521R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02005599#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005600#if defined(MBEDTLS_ECP_HAVE_BP256R1)
Brett Warrene0edc842021-08-17 09:53:13 +01005601 MBEDTLS_SSL_IANA_TLS_GROUP_BP256R1,
Gilles Peskineae270bf2021-06-02 00:05:29 +02005602#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005603#if defined(MBEDTLS_ECP_HAVE_BP384R1)
Brett Warrene0edc842021-08-17 09:53:13 +01005604 MBEDTLS_SSL_IANA_TLS_GROUP_BP384R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02005605#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005606#if defined(MBEDTLS_ECP_HAVE_BP512R1)
Brett Warrene0edc842021-08-17 09:53:13 +01005607 MBEDTLS_SSL_IANA_TLS_GROUP_BP512R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02005608#endif
Przemek Stekiel316c19e2023-05-31 15:25:11 +02005609#if defined(PSA_WANT_ALG_FFDH)
Przemek Stekiel383f4712022-12-12 14:48:57 +01005610 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE2048,
5611 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE3072,
5612 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE4096,
5613 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE6144,
5614 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE8192,
5615#endif
Brett Warrene0edc842021-08-17 09:53:13 +01005616 MBEDTLS_SSL_IANA_TLS_GROUP_NONE
Gilles Peskineae270bf2021-06-02 00:05:29 +02005617};
Gilles Peskineae270bf2021-06-02 00:05:29 +02005618
Alexey Tsvetkov2ca34372022-06-07 10:21:05 +03005619static const int ssl_preset_suiteb_ciphersuites[] = {
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005620 MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256,
5621 MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384,
5622 0
5623};
5624
Ronald Crone68ab4f2022-10-05 12:46:29 +02005625#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Hanno Becker9c6aa7b2021-08-10 13:50:43 +01005626
Jerry Yu909df7b2022-01-22 11:56:27 +08005627/* NOTICE:
Jerry Yu0b994b82022-01-25 17:22:12 +08005628 * For ssl_preset_*_sig_algs and ssl_tls12_preset_*_sig_algs, the following
Jerry Yu370e1462022-01-25 10:36:53 +08005629 * rules SHOULD be upheld.
5630 * - No duplicate entries.
5631 * - But if there is a good reason, do not change the order of the algorithms.
Jerry Yu09a99fc2022-07-28 14:22:17 +08005632 * - ssl_tls12_preset* is for TLS 1.2 use only.
Jerry Yu370e1462022-01-25 10:36:53 +08005633 * - ssl_preset_* is for TLS 1.3 only or hybrid TLS 1.3/1.2 handshakes.
Jerry Yu1a8b4812022-01-20 17:56:50 +08005634 */
Chien Wong4e9683e2023-12-28 17:07:43 +08005635static const uint16_t ssl_preset_default_sig_algs[] = {
Jerry Yu1a8b4812022-01-20 17:56:50 +08005636
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005637#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005638 defined(MBEDTLS_MD_CAN_SHA256) && \
Valerio Setticf29c5d2023-09-01 09:03:41 +02005639 defined(PSA_WANT_ECC_SECP_R1_256)
Jerry Yued5e9f42022-01-26 11:21:34 +08005640 MBEDTLS_TLS1_3_SIG_ECDSA_SECP256R1_SHA256,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005641 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256)
5642#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08005643
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005644#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005645 defined(MBEDTLS_MD_CAN_SHA384) && \
Valerio Setticf29c5d2023-09-01 09:03:41 +02005646 defined(PSA_WANT_ECC_SECP_R1_384)
Jerry Yu909df7b2022-01-22 11:56:27 +08005647 MBEDTLS_TLS1_3_SIG_ECDSA_SECP384R1_SHA384,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005648 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384)
5649#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08005650
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005651#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005652 defined(MBEDTLS_MD_CAN_SHA512) && \
Valerio Setticf29c5d2023-09-01 09:03:41 +02005653 defined(PSA_WANT_ECC_SECP_R1_521)
Jerry Yued5e9f42022-01-26 11:21:34 +08005654 MBEDTLS_TLS1_3_SIG_ECDSA_SECP521R1_SHA512,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005655 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA512)
5656#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08005657
Yanray Wang1136fad2023-11-22 16:54:31 +08005658#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && defined(MBEDTLS_MD_CAN_SHA512)
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005659 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA512,
Yanray Wang1136fad2023-11-22 16:54:31 +08005660#endif
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005661
Yanray Wang1136fad2023-11-22 16:54:31 +08005662#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && defined(MBEDTLS_MD_CAN_SHA384)
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005663 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA384,
Yanray Wang1136fad2023-11-22 16:54:31 +08005664#endif
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005665
Yanray Wang1136fad2023-11-22 16:54:31 +08005666#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && defined(MBEDTLS_MD_CAN_SHA256)
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005667 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256,
Yanray Wang1136fad2023-11-22 16:54:31 +08005668#endif
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005669
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005670#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_MD_CAN_SHA512)
Jerry Yu693a47a2022-06-23 14:02:28 +08005671 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA512,
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005672#endif /* MBEDTLS_RSA_C && MBEDTLS_MD_CAN_SHA512 */
Jerry Yu693a47a2022-06-23 14:02:28 +08005673
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005674#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_MD_CAN_SHA384)
Jerry Yu693a47a2022-06-23 14:02:28 +08005675 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA384,
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005676#endif /* MBEDTLS_RSA_C && MBEDTLS_MD_CAN_SHA384 */
Jerry Yu693a47a2022-06-23 14:02:28 +08005677
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005678#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_MD_CAN_SHA256)
Jerry Yu693a47a2022-06-23 14:02:28 +08005679 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA256,
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005680#endif /* MBEDTLS_RSA_C && MBEDTLS_MD_CAN_SHA256 */
Jerry Yu693a47a2022-06-23 14:02:28 +08005681
Gabor Mezei15b95a62022-05-09 16:37:58 +02005682 MBEDTLS_TLS_SIG_NONE
Jerry Yu909df7b2022-01-22 11:56:27 +08005683};
5684
5685/* NOTICE: see above */
5686#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
5687static uint16_t ssl_tls12_preset_default_sig_algs[] = {
Yanray Wang1136fad2023-11-22 16:54:31 +08005688
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005689#if defined(MBEDTLS_MD_CAN_SHA512)
Valerio Settie9646ec2023-08-02 20:02:28 +02005690#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005691 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA512),
Jerry Yu713013f2022-01-17 18:16:35 +08005692#endif
Jerry Yu09a99fc2022-07-28 14:22:17 +08005693#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT)
5694 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA512,
Yanray Wang1136fad2023-11-22 16:54:31 +08005695#endif
Gabor Mezeic1051b62022-05-10 13:13:58 +02005696#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005697 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA512),
Gabor Mezeic1051b62022-05-10 13:13:58 +02005698#endif
Yanray Wang1136fad2023-11-22 16:54:31 +08005699#endif /* MBEDTLS_MD_CAN_SHA512 */
5700
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005701#if defined(MBEDTLS_MD_CAN_SHA384)
Valerio Settie9646ec2023-08-02 20:02:28 +02005702#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005703 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384),
Jerry Yu11f0a9c2022-01-12 18:43:08 +08005704#endif
Jerry Yu09a99fc2022-07-28 14:22:17 +08005705#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT)
5706 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA384,
Yanray Wang1136fad2023-11-22 16:54:31 +08005707#endif
Gabor Mezeic1051b62022-05-10 13:13:58 +02005708#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005709 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA384),
Gabor Mezeic1051b62022-05-10 13:13:58 +02005710#endif
Yanray Wang1136fad2023-11-22 16:54:31 +08005711#endif /* MBEDTLS_MD_CAN_SHA384 */
5712
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005713#if defined(MBEDTLS_MD_CAN_SHA256)
Valerio Settie9646ec2023-08-02 20:02:28 +02005714#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005715 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256),
Jerry Yu11f0a9c2022-01-12 18:43:08 +08005716#endif
Jerry Yu09a99fc2022-07-28 14:22:17 +08005717#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT)
5718 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256,
Yanray Wang1136fad2023-11-22 16:54:31 +08005719#endif
Gabor Mezeic1051b62022-05-10 13:13:58 +02005720#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005721 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA256),
Gabor Mezeic1051b62022-05-10 13:13:58 +02005722#endif
Yanray Wang1136fad2023-11-22 16:54:31 +08005723#endif /* MBEDTLS_MD_CAN_SHA256 */
5724
Gabor Mezei15b95a62022-05-09 16:37:58 +02005725 MBEDTLS_TLS_SIG_NONE
Jerry Yu909df7b2022-01-22 11:56:27 +08005726};
5727#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Yanray Wang1136fad2023-11-22 16:54:31 +08005728
Jerry Yu909df7b2022-01-22 11:56:27 +08005729/* NOTICE: see above */
Chien Wong4e9683e2023-12-28 17:07:43 +08005730static const uint16_t ssl_preset_suiteb_sig_algs[] = {
Jerry Yu909df7b2022-01-22 11:56:27 +08005731
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005732#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Valerio Setti45d56f32023-07-13 17:23:20 +02005733 defined(MBEDTLS_MD_CAN_SHA256) && \
Valerio Settidb6b4db2023-09-01 09:20:51 +02005734 defined(MBEDTLS_ECP_HAVE_SECP256R1)
Jerry Yu909df7b2022-01-22 11:56:27 +08005735 MBEDTLS_TLS1_3_SIG_ECDSA_SECP256R1_SHA256,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005736 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256)
5737#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08005738
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005739#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Valerio Setti45d56f32023-07-13 17:23:20 +02005740 defined(MBEDTLS_MD_CAN_SHA384) && \
Valerio Settidb6b4db2023-09-01 09:20:51 +02005741 defined(MBEDTLS_ECP_HAVE_SECP384R1)
Jerry Yu53037892022-01-25 11:02:06 +08005742 MBEDTLS_TLS1_3_SIG_ECDSA_SECP384R1_SHA384,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005743 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384)
5744#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08005745
Gabor Mezei15b95a62022-05-09 16:37:58 +02005746 MBEDTLS_TLS_SIG_NONE
Jerry Yu713013f2022-01-17 18:16:35 +08005747};
Jerry Yu6106fdc2022-01-12 16:36:14 +08005748
Jerry Yu909df7b2022-01-22 11:56:27 +08005749/* NOTICE: see above */
5750#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
5751static uint16_t ssl_tls12_preset_suiteb_sig_algs[] = {
Yanray Wang1136fad2023-11-22 16:54:31 +08005752
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005753#if defined(MBEDTLS_MD_CAN_SHA256)
Valerio Settie9646ec2023-08-02 20:02:28 +02005754#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005755 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256),
Jerry Yu713013f2022-01-17 18:16:35 +08005756#endif
Yanray Wang1136fad2023-11-22 16:54:31 +08005757#endif /* MBEDTLS_MD_CAN_SHA256 */
Yanray Wang69ceb392023-11-22 16:32:39 +08005758
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005759#if defined(MBEDTLS_MD_CAN_SHA384)
Valerio Settie9646ec2023-08-02 20:02:28 +02005760#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005761 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384),
Jerry Yu18c833e2022-01-25 10:55:47 +08005762#endif
Yanray Wang1136fad2023-11-22 16:54:31 +08005763#endif /* MBEDTLS_MD_CAN_SHA384 */
5764
Gabor Mezei15b95a62022-05-09 16:37:58 +02005765 MBEDTLS_TLS_SIG_NONE
Hanno Becker9c6aa7b2021-08-10 13:50:43 +01005766};
Jerry Yu909df7b2022-01-22 11:56:27 +08005767#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
5768
Ronald Crone68ab4f2022-10-05 12:46:29 +02005769#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005770
Chien Wong4e9683e2023-12-28 17:07:43 +08005771static const uint16_t ssl_preset_suiteb_groups[] = {
Valerio Settidb6b4db2023-09-01 09:20:51 +02005772#if defined(MBEDTLS_ECP_HAVE_SECP256R1)
Brett Warrene0edc842021-08-17 09:53:13 +01005773 MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1,
Jaeden Amerod4311042019-06-03 08:27:16 +01005774#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005775#if defined(MBEDTLS_ECP_HAVE_SECP384R1)
Brett Warrene0edc842021-08-17 09:53:13 +01005776 MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1,
Jaeden Amerod4311042019-06-03 08:27:16 +01005777#endif
Brett Warrene0edc842021-08-17 09:53:13 +01005778 MBEDTLS_SSL_IANA_TLS_GROUP_NONE
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005779};
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005780
Ronald Crone68ab4f2022-10-05 12:46:29 +02005781#if defined(MBEDTLS_DEBUG_C) && defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu909df7b2022-01-22 11:56:27 +08005782/* Function for checking `ssl_preset_*_sig_algs` and `ssl_tls12_preset_*_sig_algs`
Jerry Yu370e1462022-01-25 10:36:53 +08005783 * to make sure there are no duplicated signature algorithm entries. */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005784MBEDTLS_CHECK_RETURN_CRITICAL
Chien Wong4e9683e2023-12-28 17:07:43 +08005785static int ssl_check_no_sig_alg_duplication(const uint16_t *sig_algs)
Jerry Yu1a8b4812022-01-20 17:56:50 +08005786{
5787 size_t i, j;
5788 int ret = 0;
Jerry Yu909df7b2022-01-22 11:56:27 +08005789
Gilles Peskine449bd832023-01-11 14:50:10 +01005790 for (i = 0; sig_algs[i] != MBEDTLS_TLS_SIG_NONE; i++) {
5791 for (j = 0; j < i; j++) {
5792 if (sig_algs[i] != sig_algs[j]) {
Jerry Yuf377d642022-01-25 10:43:59 +08005793 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01005794 }
5795 mbedtls_printf(" entry(%04x,%" MBEDTLS_PRINTF_SIZET
5796 ") is duplicated at %" MBEDTLS_PRINTF_SIZET "\n",
5797 sig_algs[i], j, i);
Jerry Yuf377d642022-01-25 10:43:59 +08005798 ret = -1;
Jerry Yu1a8b4812022-01-20 17:56:50 +08005799 }
5800 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005801 return ret;
Jerry Yu1a8b4812022-01-20 17:56:50 +08005802}
5803
Ronald Crone68ab4f2022-10-05 12:46:29 +02005804#endif /* MBEDTLS_DEBUG_C && MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Jerry Yu1a8b4812022-01-20 17:56:50 +08005805
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005806/*
Tillmann Karras588ad502015-09-25 04:27:22 +02005807 * Load default in mbedtls_ssl_config
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005808 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005809int mbedtls_ssl_config_defaults(mbedtls_ssl_config *conf,
5810 int endpoint, int transport, int preset)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005811{
Manuel Pégourié-Gonnard8b431fb2015-05-11 12:54:52 +02005812#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Janos Follath865b3eb2019-12-16 11:46:15 +00005813 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard8b431fb2015-05-11 12:54:52 +02005814#endif
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005815
Ronald Crone68ab4f2022-10-05 12:46:29 +02005816#if defined(MBEDTLS_DEBUG_C) && defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005817 if (ssl_check_no_sig_alg_duplication(ssl_preset_suiteb_sig_algs)) {
5818 mbedtls_printf("ssl_preset_suiteb_sig_algs has duplicated entries\n");
5819 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu1a8b4812022-01-20 17:56:50 +08005820 }
5821
Gilles Peskine449bd832023-01-11 14:50:10 +01005822 if (ssl_check_no_sig_alg_duplication(ssl_preset_default_sig_algs)) {
5823 mbedtls_printf("ssl_preset_default_sig_algs has duplicated entries\n");
5824 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu1a8b4812022-01-20 17:56:50 +08005825 }
Jerry Yu909df7b2022-01-22 11:56:27 +08005826
5827#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005828 if (ssl_check_no_sig_alg_duplication(ssl_tls12_preset_suiteb_sig_algs)) {
5829 mbedtls_printf("ssl_tls12_preset_suiteb_sig_algs has duplicated entries\n");
5830 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu909df7b2022-01-22 11:56:27 +08005831 }
5832
Gilles Peskine449bd832023-01-11 14:50:10 +01005833 if (ssl_check_no_sig_alg_duplication(ssl_tls12_preset_default_sig_algs)) {
5834 mbedtls_printf("ssl_tls12_preset_default_sig_algs has duplicated entries\n");
5835 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu909df7b2022-01-22 11:56:27 +08005836 }
5837#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Ronald Crone68ab4f2022-10-05 12:46:29 +02005838#endif /* MBEDTLS_DEBUG_C && MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Jerry Yu1a8b4812022-01-20 17:56:50 +08005839
Manuel Pégourié-Gonnard0de074f2015-05-14 12:58:01 +02005840 /* Use the functions here so that they are covered in tests,
5841 * but otherwise access member directly for efficiency */
Gilles Peskine449bd832023-01-11 14:50:10 +01005842 mbedtls_ssl_conf_endpoint(conf, endpoint);
5843 mbedtls_ssl_conf_transport(conf, transport);
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005844
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005845 /*
5846 * Things that are common to all presets
5847 */
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02005848#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005849 if (endpoint == MBEDTLS_SSL_IS_CLIENT) {
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02005850 conf->authmode = MBEDTLS_SSL_VERIFY_REQUIRED;
5851#if defined(MBEDTLS_SSL_SESSION_TICKETS)
5852 conf->session_tickets = MBEDTLS_SSL_SESSION_TICKETS_ENABLED;
5853#endif
5854 }
5855#endif
5856
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005857#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
5858 conf->encrypt_then_mac = MBEDTLS_SSL_ETM_ENABLED;
5859#endif
5860
5861#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
5862 conf->extended_ms = MBEDTLS_SSL_EXTENDED_MS_ENABLED;
5863#endif
5864
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02005865#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005866 conf->f_cookie_write = ssl_cookie_write_dummy;
5867 conf->f_cookie_check = ssl_cookie_check_dummy;
5868#endif
5869
5870#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
5871 conf->anti_replay = MBEDTLS_SSL_ANTI_REPLAY_ENABLED;
5872#endif
5873
Janos Follath088ce432017-04-10 12:42:31 +01005874#if defined(MBEDTLS_SSL_SRV_C)
5875 conf->cert_req_ca_list = MBEDTLS_SSL_CERT_REQ_CA_LIST_ENABLED;
TRodziewicz3946f792021-06-14 12:11:18 +02005876 conf->respect_cli_pref = MBEDTLS_SSL_SRV_CIPHERSUITE_ORDER_SERVER;
Janos Follath088ce432017-04-10 12:42:31 +01005877#endif
5878
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005879#if defined(MBEDTLS_SSL_PROTO_DTLS)
5880 conf->hs_timeout_min = MBEDTLS_SSL_DTLS_TIMEOUT_DFL_MIN;
5881 conf->hs_timeout_max = MBEDTLS_SSL_DTLS_TIMEOUT_DFL_MAX;
5882#endif
5883
5884#if defined(MBEDTLS_SSL_RENEGOTIATION)
5885 conf->renego_max_records = MBEDTLS_SSL_RENEGO_MAX_RECORDS_DEFAULT;
Gilles Peskine449bd832023-01-11 14:50:10 +01005886 memset(conf->renego_period, 0x00, 2);
5887 memset(conf->renego_period + 2, 0xFF, 6);
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005888#endif
5889
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005890#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005891 if (endpoint == MBEDTLS_SSL_IS_SERVER) {
Hanno Beckere2defad2021-07-24 05:59:17 +01005892 const unsigned char dhm_p[] =
5893 MBEDTLS_DHM_RFC3526_MODP_2048_P_BIN;
5894 const unsigned char dhm_g[] =
5895 MBEDTLS_DHM_RFC3526_MODP_2048_G_BIN;
Hanno Becker00d0a682017-10-04 13:14:29 +01005896
Gilles Peskine449bd832023-01-11 14:50:10 +01005897 if ((ret = mbedtls_ssl_conf_dh_param_bin(conf,
5898 dhm_p, sizeof(dhm_p),
5899 dhm_g, sizeof(dhm_g))) != 0) {
5900 return ret;
Hanno Beckere2defad2021-07-24 05:59:17 +01005901 }
5902 }
Manuel Pégourié-Gonnardbd990d62015-06-11 14:49:42 +02005903#endif
5904
Ronald Cron6f135e12021-12-08 16:57:54 +01005905#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yu6ee56aa2022-12-06 17:47:22 +08005906
5907#if defined(MBEDTLS_SSL_EARLY_DATA)
Yanray Wangd5ed36f2023-11-07 11:40:43 +08005908 mbedtls_ssl_conf_early_data(conf, MBEDTLS_SSL_EARLY_DATA_DISABLED);
Jerry Yu6ee56aa2022-12-06 17:47:22 +08005909#if defined(MBEDTLS_SSL_SRV_C)
Yanray Wang07517612023-11-07 11:47:36 +08005910 mbedtls_ssl_conf_max_early_data_size(conf, MBEDTLS_SSL_MAX_EARLY_DATA_SIZE);
Jerry Yu6ee56aa2022-12-06 17:47:22 +08005911#endif
5912#endif /* MBEDTLS_SSL_EARLY_DATA */
5913
Jerry Yud0766ec2022-09-22 10:46:57 +08005914#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Jerry Yu1ad7ace2022-08-09 13:28:39 +08005915 mbedtls_ssl_conf_new_session_tickets(
Gilles Peskine449bd832023-01-11 14:50:10 +01005916 conf, MBEDTLS_SSL_TLS1_3_DEFAULT_NEW_SESSION_TICKETS);
Jerry Yu1ad7ace2022-08-09 13:28:39 +08005917#endif
Hanno Becker71f1ed62021-07-24 06:01:47 +01005918 /*
5919 * Allow all TLS 1.3 key exchange modes by default.
5920 */
Xiaofei Bai746f9482021-11-12 08:53:56 +00005921 conf->tls13_kex_modes = MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_ALL;
Ronald Cron6f135e12021-12-08 16:57:54 +01005922#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker71f1ed62021-07-24 06:01:47 +01005923
Gilles Peskine449bd832023-01-11 14:50:10 +01005924 if (transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Glenn Strauss2dfcea22022-03-14 17:26:42 -04005925#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
XiaokangQian4d3a6042022-04-21 13:46:17 +00005926 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
XiaokangQian060d8672022-04-21 09:24:56 +00005927 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
XiaokangQian4d3a6042022-04-21 13:46:17 +00005928#else
Gilles Peskine449bd832023-01-11 14:50:10 +01005929 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
XiaokangQian060d8672022-04-21 09:24:56 +00005930#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01005931 } else {
XiaokangQian4d3a6042022-04-21 13:46:17 +00005932#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
Ronald Cron097ba142023-03-08 16:18:00 +01005933 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
5934 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
XiaokangQian4d3a6042022-04-21 13:46:17 +00005935#elif defined(MBEDTLS_SSL_PROTO_TLS1_3)
5936 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
5937 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
5938#elif defined(MBEDTLS_SSL_PROTO_TLS1_2)
5939 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
5940 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
5941#else
Gilles Peskine449bd832023-01-11 14:50:10 +01005942 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
XiaokangQian4d3a6042022-04-21 13:46:17 +00005943#endif
5944 }
Glenn Strauss2dfcea22022-03-14 17:26:42 -04005945
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005946 /*
5947 * Preset-specific defaults
5948 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005949 switch (preset) {
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005950 /*
5951 * NSA Suite B
5952 */
5953 case MBEDTLS_SSL_PRESET_SUITEB:
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005954
Hanno Beckerd60b6c62021-04-29 12:04:11 +01005955 conf->ciphersuite_list = ssl_preset_suiteb_ciphersuites;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005956
5957#if defined(MBEDTLS_X509_CRT_PARSE_C)
5958 conf->cert_profile = &mbedtls_x509_crt_profile_suiteb;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005959#endif
5960
Ronald Crone68ab4f2022-10-05 12:46:29 +02005961#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu909df7b2022-01-22 11:56:27 +08005962#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005963 if (mbedtls_ssl_conf_is_tls12_only(conf)) {
Jerry Yu909df7b2022-01-22 11:56:27 +08005964 conf->sig_algs = ssl_tls12_preset_suiteb_sig_algs;
Gilles Peskine449bd832023-01-11 14:50:10 +01005965 } else
Jerry Yu909df7b2022-01-22 11:56:27 +08005966#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005967 conf->sig_algs = ssl_preset_suiteb_sig_algs;
Ronald Crone68ab4f2022-10-05 12:46:29 +02005968#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005969
Manuel Pégourié-Gonnardf07ce3b2023-09-22 11:53:41 +02005970#if defined(MBEDTLS_ECP_C) && !defined(MBEDTLS_DEPRECATED_REMOVED)
Brett Warrene0edc842021-08-17 09:53:13 +01005971 conf->curve_list = NULL;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005972#endif
Brett Warrene0edc842021-08-17 09:53:13 +01005973 conf->group_list = ssl_preset_suiteb_groups;
Manuel Pégourié-Gonnardc98204e2015-08-11 04:21:01 +02005974 break;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005975
5976 /*
5977 * Default
5978 */
5979 default:
Ronald Cronf6606552022-03-15 11:23:25 +01005980
Hanno Beckerd60b6c62021-04-29 12:04:11 +01005981 conf->ciphersuite_list = mbedtls_ssl_list_ciphersuites();
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005982
5983#if defined(MBEDTLS_X509_CRT_PARSE_C)
5984 conf->cert_profile = &mbedtls_x509_crt_profile_default;
5985#endif
5986
Ronald Crone68ab4f2022-10-05 12:46:29 +02005987#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu909df7b2022-01-22 11:56:27 +08005988#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005989 if (mbedtls_ssl_conf_is_tls12_only(conf)) {
Jerry Yu909df7b2022-01-22 11:56:27 +08005990 conf->sig_algs = ssl_tls12_preset_default_sig_algs;
Gilles Peskine449bd832023-01-11 14:50:10 +01005991 } else
Jerry Yu909df7b2022-01-22 11:56:27 +08005992#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005993 conf->sig_algs = ssl_preset_default_sig_algs;
Ronald Crone68ab4f2022-10-05 12:46:29 +02005994#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005995
Manuel Pégourié-Gonnardf07ce3b2023-09-22 11:53:41 +02005996#if defined(MBEDTLS_ECP_C) && !defined(MBEDTLS_DEPRECATED_REMOVED)
Brett Warrene0edc842021-08-17 09:53:13 +01005997 conf->curve_list = NULL;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005998#endif
Brett Warrene0edc842021-08-17 09:53:13 +01005999 conf->group_list = ssl_preset_default_groups;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02006000
6001#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_CLI_C)
6002 conf->dhm_min_bitlen = 1024;
6003#endif
6004 }
6005
Gilles Peskine449bd832023-01-11 14:50:10 +01006006 return 0;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02006007}
6008
6009/*
6010 * Free mbedtls_ssl_config
6011 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006012void mbedtls_ssl_config_free(mbedtls_ssl_config *conf)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02006013{
6014#if defined(MBEDTLS_DHM_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01006015 mbedtls_mpi_free(&conf->dhm_P);
6016 mbedtls_mpi_free(&conf->dhm_G);
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02006017#endif
6018
Ronald Cron73fe8df2022-10-05 14:31:43 +02006019#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED)
Neil Armstrong501c9322022-05-03 09:35:09 +02006020#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01006021 if (!mbedtls_svc_key_id_is_null(conf->psk_opaque)) {
Neil Armstrong501c9322022-05-03 09:35:09 +02006022 conf->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
6023 }
Neil Armstrong8ecd6682022-05-05 11:40:35 +02006024#endif /* MBEDTLS_USE_PSA_CRYPTO */
Gilles Peskine449bd832023-01-11 14:50:10 +01006025 if (conf->psk != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01006026 mbedtls_zeroize_and_free(conf->psk, conf->psk_len);
Azim Khan27e8a122018-03-21 14:24:11 +00006027 conf->psk = NULL;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02006028 conf->psk_len = 0;
junyeonLEE316b1622017-12-20 16:29:30 +09006029 }
6030
Gilles Peskine449bd832023-01-11 14:50:10 +01006031 if (conf->psk_identity != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01006032 mbedtls_zeroize_and_free(conf->psk_identity, conf->psk_identity_len);
Azim Khan27e8a122018-03-21 14:24:11 +00006033 conf->psk_identity = NULL;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02006034 conf->psk_identity_len = 0;
6035 }
Ronald Cron73fe8df2022-10-05 14:31:43 +02006036#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED */
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02006037
6038#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01006039 ssl_key_cert_free(conf->key_cert);
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02006040#endif
6041
Gilles Peskine449bd832023-01-11 14:50:10 +01006042 mbedtls_platform_zeroize(conf, sizeof(mbedtls_ssl_config));
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02006043}
6044
Manuel Pégourié-Gonnard5674a972015-10-19 15:14:03 +02006045#if defined(MBEDTLS_PK_C) && \
Valerio Settie9646ec2023-08-02 20:02:28 +02006046 (defined(MBEDTLS_RSA_C) || defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED))
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02006047/*
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006048 * Convert between MBEDTLS_PK_XXX and SSL_SIG_XXX
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02006049 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006050unsigned char mbedtls_ssl_sig_from_pk(mbedtls_pk_context *pk)
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02006051{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006052#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01006053 if (mbedtls_pk_can_do(pk, MBEDTLS_PK_RSA)) {
6054 return MBEDTLS_SSL_SIG_RSA;
6055 }
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02006056#endif
Valerio Settie9646ec2023-08-02 20:02:28 +02006057#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01006058 if (mbedtls_pk_can_do(pk, MBEDTLS_PK_ECDSA)) {
6059 return MBEDTLS_SSL_SIG_ECDSA;
6060 }
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02006061#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01006062 return MBEDTLS_SSL_SIG_ANON;
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02006063}
6064
Gilles Peskine449bd832023-01-11 14:50:10 +01006065unsigned char mbedtls_ssl_sig_from_pk_alg(mbedtls_pk_type_t type)
Hanno Becker7e5437a2017-04-28 17:15:26 +01006066{
Gilles Peskine449bd832023-01-11 14:50:10 +01006067 switch (type) {
Hanno Becker7e5437a2017-04-28 17:15:26 +01006068 case MBEDTLS_PK_RSA:
Gilles Peskine449bd832023-01-11 14:50:10 +01006069 return MBEDTLS_SSL_SIG_RSA;
Hanno Becker7e5437a2017-04-28 17:15:26 +01006070 case MBEDTLS_PK_ECDSA:
6071 case MBEDTLS_PK_ECKEY:
Gilles Peskine449bd832023-01-11 14:50:10 +01006072 return MBEDTLS_SSL_SIG_ECDSA;
Hanno Becker7e5437a2017-04-28 17:15:26 +01006073 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006074 return MBEDTLS_SSL_SIG_ANON;
Hanno Becker7e5437a2017-04-28 17:15:26 +01006075 }
6076}
6077
Gilles Peskine449bd832023-01-11 14:50:10 +01006078mbedtls_pk_type_t mbedtls_ssl_pk_alg_from_sig(unsigned char sig)
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02006079{
Gilles Peskine449bd832023-01-11 14:50:10 +01006080 switch (sig) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006081#if defined(MBEDTLS_RSA_C)
6082 case MBEDTLS_SSL_SIG_RSA:
Gilles Peskine449bd832023-01-11 14:50:10 +01006083 return MBEDTLS_PK_RSA;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02006084#endif
Valerio Settie9646ec2023-08-02 20:02:28 +02006085#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006086 case MBEDTLS_SSL_SIG_ECDSA:
Gilles Peskine449bd832023-01-11 14:50:10 +01006087 return MBEDTLS_PK_ECDSA;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02006088#endif
6089 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006090 return MBEDTLS_PK_NONE;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02006091 }
6092}
Valerio Settie9646ec2023-08-02 20:02:28 +02006093#endif /* MBEDTLS_PK_C &&
6094 ( MBEDTLS_RSA_C || MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED ) */
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02006095
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02006096/*
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006097 * Convert from MBEDTLS_SSL_HASH_XXX to MBEDTLS_MD_XXX
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02006098 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006099mbedtls_md_type_t mbedtls_ssl_md_alg_from_hash(unsigned char hash)
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02006100{
Gilles Peskine449bd832023-01-11 14:50:10 +01006101 switch (hash) {
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006102#if defined(MBEDTLS_MD_CAN_MD5)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006103 case MBEDTLS_SSL_HASH_MD5:
Gilles Peskine449bd832023-01-11 14:50:10 +01006104 return MBEDTLS_MD_MD5;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02006105#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006106#if defined(MBEDTLS_MD_CAN_SHA1)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006107 case MBEDTLS_SSL_HASH_SHA1:
Gilles Peskine449bd832023-01-11 14:50:10 +01006108 return MBEDTLS_MD_SHA1;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02006109#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006110#if defined(MBEDTLS_MD_CAN_SHA224)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006111 case MBEDTLS_SSL_HASH_SHA224:
Gilles Peskine449bd832023-01-11 14:50:10 +01006112 return MBEDTLS_MD_SHA224;
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02006113#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006114#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006115 case MBEDTLS_SSL_HASH_SHA256:
Gilles Peskine449bd832023-01-11 14:50:10 +01006116 return MBEDTLS_MD_SHA256;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02006117#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006118#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006119 case MBEDTLS_SSL_HASH_SHA384:
Gilles Peskine449bd832023-01-11 14:50:10 +01006120 return MBEDTLS_MD_SHA384;
Mateusz Starzyk3352a532021-04-06 14:28:22 +02006121#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006122#if defined(MBEDTLS_MD_CAN_SHA512)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006123 case MBEDTLS_SSL_HASH_SHA512:
Gilles Peskine449bd832023-01-11 14:50:10 +01006124 return MBEDTLS_MD_SHA512;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02006125#endif
6126 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006127 return MBEDTLS_MD_NONE;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02006128 }
6129}
6130
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006131/*
6132 * Convert from MBEDTLS_MD_XXX to MBEDTLS_SSL_HASH_XXX
6133 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006134unsigned char mbedtls_ssl_hash_from_md_alg(int md)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006135{
Gilles Peskine449bd832023-01-11 14:50:10 +01006136 switch (md) {
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006137#if defined(MBEDTLS_MD_CAN_MD5)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006138 case MBEDTLS_MD_MD5:
Gilles Peskine449bd832023-01-11 14:50:10 +01006139 return MBEDTLS_SSL_HASH_MD5;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006140#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006141#if defined(MBEDTLS_MD_CAN_SHA1)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006142 case MBEDTLS_MD_SHA1:
Gilles Peskine449bd832023-01-11 14:50:10 +01006143 return MBEDTLS_SSL_HASH_SHA1;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006144#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006145#if defined(MBEDTLS_MD_CAN_SHA224)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006146 case MBEDTLS_MD_SHA224:
Gilles Peskine449bd832023-01-11 14:50:10 +01006147 return MBEDTLS_SSL_HASH_SHA224;
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02006148#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006149#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006150 case MBEDTLS_MD_SHA256:
Gilles Peskine449bd832023-01-11 14:50:10 +01006151 return MBEDTLS_SSL_HASH_SHA256;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006152#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006153#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006154 case MBEDTLS_MD_SHA384:
Gilles Peskine449bd832023-01-11 14:50:10 +01006155 return MBEDTLS_SSL_HASH_SHA384;
Mateusz Starzyk3352a532021-04-06 14:28:22 +02006156#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006157#if defined(MBEDTLS_MD_CAN_SHA512)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006158 case MBEDTLS_MD_SHA512:
Gilles Peskine449bd832023-01-11 14:50:10 +01006159 return MBEDTLS_SSL_HASH_SHA512;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006160#endif
6161 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006162 return MBEDTLS_SSL_HASH_NONE;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006163 }
6164}
6165
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01006166/*
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006167 * Check if a curve proposed by the peer is in our list.
Manuel Pégourié-Gonnard9d412d82015-06-17 12:10:46 +02006168 * Return 0 if we're willing to use it, -1 otherwise.
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01006169 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006170int mbedtls_ssl_check_curve_tls_id(const mbedtls_ssl_context *ssl, uint16_t tls_id)
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01006171{
Gilles Peskine449bd832023-01-11 14:50:10 +01006172 const uint16_t *group_list = mbedtls_ssl_get_groups(ssl);
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01006173
Gilles Peskine449bd832023-01-11 14:50:10 +01006174 if (group_list == NULL) {
6175 return -1;
Brett Warrene0edc842021-08-17 09:53:13 +01006176 }
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01006177
Gilles Peskine449bd832023-01-11 14:50:10 +01006178 for (; *group_list != 0; group_list++) {
6179 if (*group_list == tls_id) {
6180 return 0;
6181 }
6182 }
6183
6184 return -1;
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01006185}
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01006186
Valerio Setti49e69072023-06-27 17:27:51 +02006187#if defined(MBEDTLS_PK_HAVE_ECC_KEYS)
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01006188/*
6189 * Same as mbedtls_ssl_check_curve_tls_id() but with a mbedtls_ecp_group_id.
6190 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006191int mbedtls_ssl_check_curve(const mbedtls_ssl_context *ssl, mbedtls_ecp_group_id grp_id)
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01006192{
Gilles Peskine449bd832023-01-11 14:50:10 +01006193 uint16_t tls_id = mbedtls_ssl_get_tls_id_from_ecp_group_id(grp_id);
Leonid Rozenboim19e59732022-08-08 16:52:38 -07006194
Gilles Peskine449bd832023-01-11 14:50:10 +01006195 if (tls_id == 0) {
Leonid Rozenboim19e59732022-08-08 16:52:38 -07006196 return -1;
Gilles Peskine449bd832023-01-11 14:50:10 +01006197 }
Leonid Rozenboim19e59732022-08-08 16:52:38 -07006198
Gilles Peskine449bd832023-01-11 14:50:10 +01006199 return mbedtls_ssl_check_curve_tls_id(ssl, tls_id);
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01006200}
Valerio Setti49e69072023-06-27 17:27:51 +02006201#endif /* MBEDTLS_PK_HAVE_ECC_KEYS */
Valerio Setti67419f02023-01-04 16:12:42 +01006202
Valerio Setti18c9fed2022-12-30 17:44:24 +01006203static const struct {
6204 uint16_t tls_id;
6205 mbedtls_ecp_group_id ecp_group_id;
6206 psa_ecc_family_t psa_family;
6207 uint16_t bits;
Valerio Setti18c9fed2022-12-30 17:44:24 +01006208} tls_id_match_table[] =
6209{
Valerio Settidb6b4db2023-09-01 09:20:51 +02006210#if defined(MBEDTLS_ECP_HAVE_SECP521R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02006211 { 25, MBEDTLS_ECP_DP_SECP521R1, PSA_ECC_FAMILY_SECP_R1, 521 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006212#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02006213#if defined(MBEDTLS_ECP_HAVE_BP512R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02006214 { 28, MBEDTLS_ECP_DP_BP512R1, PSA_ECC_FAMILY_BRAINPOOL_P_R1, 512 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006215#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02006216#if defined(MBEDTLS_ECP_HAVE_SECP384R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02006217 { 24, MBEDTLS_ECP_DP_SECP384R1, PSA_ECC_FAMILY_SECP_R1, 384 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006218#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02006219#if defined(MBEDTLS_ECP_HAVE_BP384R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02006220 { 27, MBEDTLS_ECP_DP_BP384R1, PSA_ECC_FAMILY_BRAINPOOL_P_R1, 384 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006221#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02006222#if defined(MBEDTLS_ECP_HAVE_SECP256R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02006223 { 23, MBEDTLS_ECP_DP_SECP256R1, PSA_ECC_FAMILY_SECP_R1, 256 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006224#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02006225#if defined(MBEDTLS_ECP_HAVE_SECP256K1)
Valerio Settiacd32c02023-06-29 18:06:29 +02006226 { 22, MBEDTLS_ECP_DP_SECP256K1, PSA_ECC_FAMILY_SECP_K1, 256 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006227#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02006228#if defined(MBEDTLS_ECP_HAVE_BP256R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02006229 { 26, MBEDTLS_ECP_DP_BP256R1, PSA_ECC_FAMILY_BRAINPOOL_P_R1, 256 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006230#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02006231#if defined(MBEDTLS_ECP_HAVE_SECP224R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02006232 { 21, MBEDTLS_ECP_DP_SECP224R1, PSA_ECC_FAMILY_SECP_R1, 224 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006233#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02006234#if defined(MBEDTLS_ECP_HAVE_SECP224K1)
Valerio Settiacd32c02023-06-29 18:06:29 +02006235 { 20, MBEDTLS_ECP_DP_SECP224K1, PSA_ECC_FAMILY_SECP_K1, 224 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006236#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02006237#if defined(MBEDTLS_ECP_HAVE_SECP192R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02006238 { 19, MBEDTLS_ECP_DP_SECP192R1, PSA_ECC_FAMILY_SECP_R1, 192 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006239#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02006240#if defined(MBEDTLS_ECP_HAVE_SECP192K1)
Valerio Settiacd32c02023-06-29 18:06:29 +02006241 { 18, MBEDTLS_ECP_DP_SECP192K1, PSA_ECC_FAMILY_SECP_K1, 192 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006242#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02006243#if defined(MBEDTLS_ECP_HAVE_CURVE25519)
Valerio Settiacd32c02023-06-29 18:06:29 +02006244 { 29, MBEDTLS_ECP_DP_CURVE25519, PSA_ECC_FAMILY_MONTGOMERY, 255 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006245#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02006246#if defined(MBEDTLS_ECP_HAVE_CURVE448)
Valerio Settiacd32c02023-06-29 18:06:29 +02006247 { 30, MBEDTLS_ECP_DP_CURVE448, PSA_ECC_FAMILY_MONTGOMERY, 448 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006248#endif
Valerio Settiacd32c02023-06-29 18:06:29 +02006249 { 0, MBEDTLS_ECP_DP_NONE, 0, 0 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006250};
6251
Gilles Peskine449bd832023-01-11 14:50:10 +01006252int mbedtls_ssl_get_psa_curve_info_from_tls_id(uint16_t tls_id,
Przemek Stekielda4fba62023-06-02 14:52:28 +02006253 psa_key_type_t *type,
Gilles Peskine449bd832023-01-11 14:50:10 +01006254 size_t *bits)
Valerio Setti18c9fed2022-12-30 17:44:24 +01006255{
Gilles Peskine449bd832023-01-11 14:50:10 +01006256 for (int i = 0; tls_id_match_table[i].tls_id != 0; i++) {
6257 if (tls_id_match_table[i].tls_id == tls_id) {
Przemek Stekielda4fba62023-06-02 14:52:28 +02006258 if (type != NULL) {
6259 *type = PSA_KEY_TYPE_ECC_KEY_PAIR(tls_id_match_table[i].psa_family);
Gilles Peskine449bd832023-01-11 14:50:10 +01006260 }
6261 if (bits != NULL) {
Valerio Setti18c9fed2022-12-30 17:44:24 +01006262 *bits = tls_id_match_table[i].bits;
Gilles Peskine449bd832023-01-11 14:50:10 +01006263 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01006264 return PSA_SUCCESS;
6265 }
6266 }
6267
6268 return PSA_ERROR_NOT_SUPPORTED;
6269}
6270
Gilles Peskine449bd832023-01-11 14:50:10 +01006271mbedtls_ecp_group_id mbedtls_ssl_get_ecp_group_id_from_tls_id(uint16_t tls_id)
Valerio Setti18c9fed2022-12-30 17:44:24 +01006272{
Gilles Peskine449bd832023-01-11 14:50:10 +01006273 for (int i = 0; tls_id_match_table[i].tls_id != 0; i++) {
6274 if (tls_id_match_table[i].tls_id == tls_id) {
Valerio Setti18c9fed2022-12-30 17:44:24 +01006275 return tls_id_match_table[i].ecp_group_id;
Gilles Peskine449bd832023-01-11 14:50:10 +01006276 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01006277 }
6278
6279 return MBEDTLS_ECP_DP_NONE;
6280}
6281
Gilles Peskine449bd832023-01-11 14:50:10 +01006282uint16_t mbedtls_ssl_get_tls_id_from_ecp_group_id(mbedtls_ecp_group_id grp_id)
Valerio Setti18c9fed2022-12-30 17:44:24 +01006283{
Gilles Peskine449bd832023-01-11 14:50:10 +01006284 for (int i = 0; tls_id_match_table[i].ecp_group_id != MBEDTLS_ECP_DP_NONE;
6285 i++) {
6286 if (tls_id_match_table[i].ecp_group_id == grp_id) {
Valerio Setti18c9fed2022-12-30 17:44:24 +01006287 return tls_id_match_table[i].tls_id;
Gilles Peskine449bd832023-01-11 14:50:10 +01006288 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01006289 }
6290
6291 return 0;
6292}
6293
Valerio Setti67419f02023-01-04 16:12:42 +01006294#if defined(MBEDTLS_DEBUG_C)
Valerio Settiacd32c02023-06-29 18:06:29 +02006295static const struct {
6296 uint16_t tls_id;
6297 const char *name;
6298} tls_id_curve_name_table[] =
6299{
Valerio Setti54e23792023-07-07 10:49:27 +02006300 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP521R1, "secp521r1" },
6301 { MBEDTLS_SSL_IANA_TLS_GROUP_BP512R1, "brainpoolP512r1" },
6302 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1, "secp384r1" },
6303 { MBEDTLS_SSL_IANA_TLS_GROUP_BP384R1, "brainpoolP384r1" },
6304 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1, "secp256r1" },
6305 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP256K1, "secp256k1" },
6306 { MBEDTLS_SSL_IANA_TLS_GROUP_BP256R1, "brainpoolP256r1" },
6307 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP224R1, "secp224r1" },
6308 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP224K1, "secp224k1" },
6309 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP192R1, "secp192r1" },
6310 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP192K1, "secp192k1" },
6311 { MBEDTLS_SSL_IANA_TLS_GROUP_X25519, "x25519" },
6312 { MBEDTLS_SSL_IANA_TLS_GROUP_X448, "x448" },
Valerio Settiacd32c02023-06-29 18:06:29 +02006313 { 0, NULL },
6314};
6315
Gilles Peskine449bd832023-01-11 14:50:10 +01006316const char *mbedtls_ssl_get_curve_name_from_tls_id(uint16_t tls_id)
Valerio Setti18c9fed2022-12-30 17:44:24 +01006317{
Valerio Settiacd32c02023-06-29 18:06:29 +02006318 for (int i = 0; tls_id_curve_name_table[i].tls_id != 0; i++) {
6319 if (tls_id_curve_name_table[i].tls_id == tls_id) {
6320 return tls_id_curve_name_table[i].name;
Gilles Peskine449bd832023-01-11 14:50:10 +01006321 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01006322 }
6323
6324 return NULL;
6325}
Valerio Setti67419f02023-01-04 16:12:42 +01006326#endif
Valerio Setti18c9fed2022-12-30 17:44:24 +01006327
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006328#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01006329int mbedtls_ssl_check_cert_usage(const mbedtls_x509_crt *cert,
6330 const mbedtls_ssl_ciphersuite_t *ciphersuite,
6331 int cert_endpoint,
6332 uint32_t *flags)
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02006333{
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01006334 int ret = 0;
Dave Rodgmanc37ad442023-11-03 23:36:06 +00006335 unsigned int usage = 0;
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02006336 const char *ext_oid;
6337 size_t ext_len;
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02006338
Gilles Peskine449bd832023-01-11 14:50:10 +01006339 if (cert_endpoint == MBEDTLS_SSL_IS_SERVER) {
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02006340 /* Server part of the key exchange */
Gilles Peskine449bd832023-01-11 14:50:10 +01006341 switch (ciphersuite->key_exchange) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006342 case MBEDTLS_KEY_EXCHANGE_RSA:
6343 case MBEDTLS_KEY_EXCHANGE_RSA_PSK:
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01006344 usage = MBEDTLS_X509_KU_KEY_ENCIPHERMENT;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02006345 break;
6346
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006347 case MBEDTLS_KEY_EXCHANGE_DHE_RSA:
6348 case MBEDTLS_KEY_EXCHANGE_ECDHE_RSA:
6349 case MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA:
6350 usage = MBEDTLS_X509_KU_DIGITAL_SIGNATURE;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02006351 break;
6352
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006353 case MBEDTLS_KEY_EXCHANGE_ECDH_RSA:
6354 case MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA:
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01006355 usage = MBEDTLS_X509_KU_KEY_AGREEMENT;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02006356 break;
6357
6358 /* Don't use default: we want warnings when adding new values */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006359 case MBEDTLS_KEY_EXCHANGE_NONE:
6360 case MBEDTLS_KEY_EXCHANGE_PSK:
6361 case MBEDTLS_KEY_EXCHANGE_DHE_PSK:
6362 case MBEDTLS_KEY_EXCHANGE_ECDHE_PSK:
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +02006363 case MBEDTLS_KEY_EXCHANGE_ECJPAKE:
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02006364 usage = 0;
6365 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006366 } else {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006367 /* Client auth: we only implement rsa_sign and mbedtls_ecdsa_sign for now */
6368 usage = MBEDTLS_X509_KU_DIGITAL_SIGNATURE;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02006369 }
6370
Gilles Peskine449bd832023-01-11 14:50:10 +01006371 if (mbedtls_x509_crt_check_key_usage(cert, usage) != 0) {
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01006372 *flags |= MBEDTLS_X509_BADCERT_KEY_USAGE;
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01006373 ret = -1;
6374 }
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02006375
Gilles Peskine449bd832023-01-11 14:50:10 +01006376 if (cert_endpoint == MBEDTLS_SSL_IS_SERVER) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006377 ext_oid = MBEDTLS_OID_SERVER_AUTH;
Gilles Peskine449bd832023-01-11 14:50:10 +01006378 ext_len = MBEDTLS_OID_SIZE(MBEDTLS_OID_SERVER_AUTH);
6379 } else {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006380 ext_oid = MBEDTLS_OID_CLIENT_AUTH;
Gilles Peskine449bd832023-01-11 14:50:10 +01006381 ext_len = MBEDTLS_OID_SIZE(MBEDTLS_OID_CLIENT_AUTH);
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02006382 }
6383
Gilles Peskine449bd832023-01-11 14:50:10 +01006384 if (mbedtls_x509_crt_check_extended_key_usage(cert, ext_oid, ext_len) != 0) {
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01006385 *flags |= MBEDTLS_X509_BADCERT_EXT_KEY_USAGE;
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01006386 ret = -1;
6387 }
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02006388
Gilles Peskine449bd832023-01-11 14:50:10 +01006389 return ret;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02006390}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006391#endif /* MBEDTLS_X509_CRT_PARSE_C */
Manuel Pégourié-Gonnard3a306b92014-04-29 15:11:17 +02006392
Jerry Yu148165c2021-09-24 23:20:59 +08006393#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01006394int mbedtls_ssl_get_handshake_transcript(mbedtls_ssl_context *ssl,
6395 const mbedtls_md_type_t md,
6396 unsigned char *dst,
6397 size_t dst_len,
6398 size_t *olen)
Jerry Yu148165c2021-09-24 23:20:59 +08006399{
Ronald Cronf6893e12022-01-07 22:09:01 +01006400 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
6401 psa_hash_operation_t *hash_operation_to_clone;
6402 psa_hash_operation_t hash_operation = psa_hash_operation_init();
6403
Jerry Yu148165c2021-09-24 23:20:59 +08006404 *olen = 0;
Ronald Cronf6893e12022-01-07 22:09:01 +01006405
Gilles Peskine449bd832023-01-11 14:50:10 +01006406 switch (md) {
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006407#if defined(MBEDTLS_MD_CAN_SHA384)
Gilles Peskine449bd832023-01-11 14:50:10 +01006408 case MBEDTLS_MD_SHA384:
6409 hash_operation_to_clone = &ssl->handshake->fin_sha384_psa;
6410 break;
Ronald Cronf6893e12022-01-07 22:09:01 +01006411#endif
6412
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006413#if defined(MBEDTLS_MD_CAN_SHA256)
Gilles Peskine449bd832023-01-11 14:50:10 +01006414 case MBEDTLS_MD_SHA256:
6415 hash_operation_to_clone = &ssl->handshake->fin_sha256_psa;
6416 break;
Ronald Cronf6893e12022-01-07 22:09:01 +01006417#endif
6418
Gilles Peskine449bd832023-01-11 14:50:10 +01006419 default:
6420 goto exit;
6421 }
6422
6423 status = psa_hash_clone(hash_operation_to_clone, &hash_operation);
6424 if (status != PSA_SUCCESS) {
Ronald Cronf6893e12022-01-07 22:09:01 +01006425 goto exit;
6426 }
6427
Gilles Peskine449bd832023-01-11 14:50:10 +01006428 status = psa_hash_finish(&hash_operation, dst, dst_len, olen);
6429 if (status != PSA_SUCCESS) {
Ronald Cronf6893e12022-01-07 22:09:01 +01006430 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006431 }
Ronald Cronf6893e12022-01-07 22:09:01 +01006432
6433exit:
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006434#if !defined(MBEDTLS_MD_CAN_SHA384) && \
6435 !defined(MBEDTLS_MD_CAN_SHA256)
Andrzej Kurekeabeb302022-10-17 07:52:51 -04006436 (void) ssl;
6437#endif
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05006438 return PSA_TO_MBEDTLS_ERR(status);
Jerry Yu148165c2021-09-24 23:20:59 +08006439}
6440#else /* MBEDTLS_USE_PSA_CRYPTO */
6441
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006442#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006443MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006444static int ssl_get_handshake_transcript_sha384(mbedtls_ssl_context *ssl,
6445 unsigned char *dst,
6446 size_t dst_len,
6447 size_t *olen)
Jerry Yu24c0ec32021-09-09 14:21:07 +08006448{
Jerry Yu24c0ec32021-09-09 14:21:07 +08006449 int ret;
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01006450 mbedtls_md_context_t sha384;
Jerry Yu24c0ec32021-09-09 14:21:07 +08006451
Gilles Peskine449bd832023-01-11 14:50:10 +01006452 if (dst_len < 48) {
6453 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
6454 }
Jerry Yu24c0ec32021-09-09 14:21:07 +08006455
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01006456 mbedtls_md_init(&sha384);
6457 ret = mbedtls_md_setup(&sha384, mbedtls_md_info_from_type(MBEDTLS_MD_SHA384), 0);
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01006458 if (ret != 0) {
6459 goto exit;
6460 }
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01006461 ret = mbedtls_md_clone(&sha384, &ssl->handshake->fin_sha384);
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01006462 if (ret != 0) {
6463 goto exit;
6464 }
Jerry Yu24c0ec32021-09-09 14:21:07 +08006465
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01006466 if ((ret = mbedtls_md_finish(&sha384, dst)) != 0) {
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01006467 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_finish", ret);
Jerry Yu24c0ec32021-09-09 14:21:07 +08006468 goto exit;
6469 }
6470
6471 *olen = 48;
6472
6473exit:
6474
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01006475 mbedtls_md_free(&sha384);
Gilles Peskine449bd832023-01-11 14:50:10 +01006476 return ret;
Jerry Yu24c0ec32021-09-09 14:21:07 +08006477}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006478#endif /* MBEDTLS_MD_CAN_SHA384 */
Jerry Yu24c0ec32021-09-09 14:21:07 +08006479
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006480#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006481MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006482static int ssl_get_handshake_transcript_sha256(mbedtls_ssl_context *ssl,
6483 unsigned char *dst,
6484 size_t dst_len,
6485 size_t *olen)
Jerry Yu24c0ec32021-09-09 14:21:07 +08006486{
Jerry Yu24c0ec32021-09-09 14:21:07 +08006487 int ret;
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01006488 mbedtls_md_context_t sha256;
Jerry Yu24c0ec32021-09-09 14:21:07 +08006489
Gilles Peskine449bd832023-01-11 14:50:10 +01006490 if (dst_len < 32) {
6491 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
6492 }
Jerry Yu24c0ec32021-09-09 14:21:07 +08006493
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01006494 mbedtls_md_init(&sha256);
6495 ret = mbedtls_md_setup(&sha256, mbedtls_md_info_from_type(MBEDTLS_MD_SHA256), 0);
6496 if (ret != 0) {
6497 goto exit;
6498 }
6499 ret = mbedtls_md_clone(&sha256, &ssl->handshake->fin_sha256);
6500 if (ret != 0) {
6501 goto exit;
6502 }
Jerry Yuc5aef882021-12-23 20:15:02 +08006503
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01006504 if ((ret = mbedtls_md_finish(&sha256, dst)) != 0) {
6505 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_finish", ret);
Jerry Yu24c0ec32021-09-09 14:21:07 +08006506 goto exit;
6507 }
6508
6509 *olen = 32;
6510
6511exit:
6512
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01006513 mbedtls_md_free(&sha256);
Gilles Peskine449bd832023-01-11 14:50:10 +01006514 return ret;
Jerry Yu24c0ec32021-09-09 14:21:07 +08006515}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006516#endif /* MBEDTLS_MD_CAN_SHA256 */
Jerry Yu24c0ec32021-09-09 14:21:07 +08006517
Gilles Peskine449bd832023-01-11 14:50:10 +01006518int mbedtls_ssl_get_handshake_transcript(mbedtls_ssl_context *ssl,
6519 const mbedtls_md_type_t md,
6520 unsigned char *dst,
6521 size_t dst_len,
6522 size_t *olen)
Jerry Yu24c0ec32021-09-09 14:21:07 +08006523{
Gilles Peskine449bd832023-01-11 14:50:10 +01006524 switch (md) {
Jerry Yuc1ddeef2021-10-08 15:14:45 +08006525
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006526#if defined(MBEDTLS_MD_CAN_SHA384)
Gilles Peskine449bd832023-01-11 14:50:10 +01006527 case MBEDTLS_MD_SHA384:
6528 return ssl_get_handshake_transcript_sha384(ssl, dst, dst_len, olen);
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006529#endif /* MBEDTLS_MD_CAN_SHA384*/
Jerry Yuc1ddeef2021-10-08 15:14:45 +08006530
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006531#if defined(MBEDTLS_MD_CAN_SHA256)
Gilles Peskine449bd832023-01-11 14:50:10 +01006532 case MBEDTLS_MD_SHA256:
6533 return ssl_get_handshake_transcript_sha256(ssl, dst, dst_len, olen);
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006534#endif /* MBEDTLS_MD_CAN_SHA256*/
Jerry Yuc1ddeef2021-10-08 15:14:45 +08006535
Gilles Peskine449bd832023-01-11 14:50:10 +01006536 default:
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006537#if !defined(MBEDTLS_MD_CAN_SHA384) && \
6538 !defined(MBEDTLS_MD_CAN_SHA256)
Gilles Peskine449bd832023-01-11 14:50:10 +01006539 (void) ssl;
6540 (void) dst;
6541 (void) dst_len;
6542 (void) olen;
Andrzej Kurek409248a2022-10-24 10:33:21 -04006543#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01006544 break;
Jerry Yuc1ddeef2021-10-08 15:14:45 +08006545 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006546 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yu24c0ec32021-09-09 14:21:07 +08006547}
XiaokangQian647719a2021-12-07 09:16:29 +00006548
Jerry Yu148165c2021-09-24 23:20:59 +08006549#endif /* !MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu24c0ec32021-09-09 14:21:07 +08006550
Ronald Crone68ab4f2022-10-05 12:46:29 +02006551#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Gabor Mezei078e8032022-04-27 21:17:56 +02006552/* mbedtls_ssl_parse_sig_alg_ext()
6553 *
6554 * The `extension_data` field of signature algorithm contains a `SignatureSchemeList`
6555 * value (TLS 1.3 RFC8446):
6556 * enum {
6557 * ....
6558 * ecdsa_secp256r1_sha256( 0x0403 ),
6559 * ecdsa_secp384r1_sha384( 0x0503 ),
6560 * ecdsa_secp521r1_sha512( 0x0603 ),
6561 * ....
6562 * } SignatureScheme;
6563 *
6564 * struct {
6565 * SignatureScheme supported_signature_algorithms<2..2^16-2>;
6566 * } SignatureSchemeList;
6567 *
6568 * The `extension_data` field of signature algorithm contains a `SignatureAndHashAlgorithm`
6569 * value (TLS 1.2 RFC5246):
6570 * enum {
6571 * none(0), md5(1), sha1(2), sha224(3), sha256(4), sha384(5),
6572 * sha512(6), (255)
6573 * } HashAlgorithm;
6574 *
6575 * enum { anonymous(0), rsa(1), dsa(2), ecdsa(3), (255) }
6576 * SignatureAlgorithm;
6577 *
6578 * struct {
6579 * HashAlgorithm hash;
6580 * SignatureAlgorithm signature;
6581 * } SignatureAndHashAlgorithm;
6582 *
6583 * SignatureAndHashAlgorithm
6584 * supported_signature_algorithms<2..2^16-2>;
6585 *
6586 * The TLS 1.3 signature algorithm extension was defined to be a compatible
6587 * generalization of the TLS 1.2 signature algorithm extension.
6588 * `SignatureAndHashAlgorithm` field of TLS 1.2 can be represented by
6589 * `SignatureScheme` field of TLS 1.3
6590 *
6591 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006592int mbedtls_ssl_parse_sig_alg_ext(mbedtls_ssl_context *ssl,
6593 const unsigned char *buf,
6594 const unsigned char *end)
Gabor Mezei078e8032022-04-27 21:17:56 +02006595{
6596 const unsigned char *p = buf;
6597 size_t supported_sig_algs_len = 0;
6598 const unsigned char *supported_sig_algs_end;
6599 uint16_t sig_alg;
6600 uint32_t common_idx = 0;
6601
Gilles Peskine449bd832023-01-11 14:50:10 +01006602 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
6603 supported_sig_algs_len = MBEDTLS_GET_UINT16_BE(p, 0);
Gabor Mezei078e8032022-04-27 21:17:56 +02006604 p += 2;
6605
Gilles Peskine449bd832023-01-11 14:50:10 +01006606 memset(ssl->handshake->received_sig_algs, 0,
6607 sizeof(ssl->handshake->received_sig_algs));
Gabor Mezei078e8032022-04-27 21:17:56 +02006608
Gilles Peskine449bd832023-01-11 14:50:10 +01006609 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, supported_sig_algs_len);
Gabor Mezei078e8032022-04-27 21:17:56 +02006610 supported_sig_algs_end = p + supported_sig_algs_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01006611 while (p < supported_sig_algs_end) {
6612 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, supported_sig_algs_end, 2);
6613 sig_alg = MBEDTLS_GET_UINT16_BE(p, 0);
Gabor Mezei078e8032022-04-27 21:17:56 +02006614 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01006615 MBEDTLS_SSL_DEBUG_MSG(4, ("received signature algorithm: 0x%x %s",
6616 sig_alg,
6617 mbedtls_ssl_sig_alg_to_str(sig_alg)));
Jerry Yu2fe6c632022-06-29 10:02:38 +08006618#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01006619 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_2 &&
6620 (!(mbedtls_ssl_sig_alg_is_supported(ssl, sig_alg) &&
6621 mbedtls_ssl_sig_alg_is_offered(ssl, sig_alg)))) {
Gabor Mezei078e8032022-04-27 21:17:56 +02006622 continue;
Jerry Yu2fe6c632022-06-29 10:02:38 +08006623 }
6624#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gabor Mezei078e8032022-04-27 21:17:56 +02006625
Gilles Peskine449bd832023-01-11 14:50:10 +01006626 MBEDTLS_SSL_DEBUG_MSG(4, ("valid signature algorithm: %s",
6627 mbedtls_ssl_sig_alg_to_str(sig_alg)));
Gabor Mezei078e8032022-04-27 21:17:56 +02006628
Gilles Peskine449bd832023-01-11 14:50:10 +01006629 if (common_idx + 1 < MBEDTLS_RECEIVED_SIG_ALGS_SIZE) {
Gabor Mezei078e8032022-04-27 21:17:56 +02006630 ssl->handshake->received_sig_algs[common_idx] = sig_alg;
6631 common_idx += 1;
6632 }
6633 }
6634 /* Check that we consumed all the message. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006635 if (p != end) {
6636 MBEDTLS_SSL_DEBUG_MSG(1,
6637 ("Signature algorithms extension length misaligned"));
6638 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR,
6639 MBEDTLS_ERR_SSL_DECODE_ERROR);
6640 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Gabor Mezei078e8032022-04-27 21:17:56 +02006641 }
6642
Gilles Peskine449bd832023-01-11 14:50:10 +01006643 if (common_idx == 0) {
6644 MBEDTLS_SSL_DEBUG_MSG(3, ("no signature algorithm in common"));
6645 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE,
6646 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE);
6647 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Gabor Mezei078e8032022-04-27 21:17:56 +02006648 }
6649
Gabor Mezei15b95a62022-05-09 16:37:58 +02006650 ssl->handshake->received_sig_algs[common_idx] = MBEDTLS_TLS_SIG_NONE;
Gilles Peskine449bd832023-01-11 14:50:10 +01006651 return 0;
Gabor Mezei078e8032022-04-27 21:17:56 +02006652}
6653
Ronald Crone68ab4f2022-10-05 12:46:29 +02006654#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Gabor Mezei078e8032022-04-27 21:17:56 +02006655
Jerry Yudc7bd172022-02-17 13:44:15 +08006656#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
6657
6658#if defined(MBEDTLS_USE_PSA_CRYPTO)
6659
Gilles Peskine449bd832023-01-11 14:50:10 +01006660static psa_status_t setup_psa_key_derivation(psa_key_derivation_operation_t *derivation,
6661 mbedtls_svc_key_id_t key,
6662 psa_algorithm_t alg,
6663 const unsigned char *raw_psk, size_t raw_psk_length,
6664 const unsigned char *seed, size_t seed_length,
6665 const unsigned char *label, size_t label_length,
6666 const unsigned char *other_secret,
6667 size_t other_secret_length,
6668 size_t capacity)
Jerry Yudc7bd172022-02-17 13:44:15 +08006669{
6670 psa_status_t status;
6671
Gilles Peskine449bd832023-01-11 14:50:10 +01006672 status = psa_key_derivation_setup(derivation, alg);
6673 if (status != PSA_SUCCESS) {
6674 return status;
6675 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006676
Gilles Peskine449bd832023-01-11 14:50:10 +01006677 if (PSA_ALG_IS_TLS12_PRF(alg) || PSA_ALG_IS_TLS12_PSK_TO_MS(alg)) {
6678 status = psa_key_derivation_input_bytes(derivation,
6679 PSA_KEY_DERIVATION_INPUT_SEED,
6680 seed, seed_length);
6681 if (status != PSA_SUCCESS) {
6682 return status;
Przemek Stekiel1f027032022-04-05 17:12:11 +02006683 }
6684
Gilles Peskine449bd832023-01-11 14:50:10 +01006685 if (other_secret != NULL) {
6686 status = psa_key_derivation_input_bytes(derivation,
6687 PSA_KEY_DERIVATION_INPUT_OTHER_SECRET,
6688 other_secret, other_secret_length);
6689 if (status != PSA_SUCCESS) {
6690 return status;
6691 }
6692 }
6693
6694 if (mbedtls_svc_key_id_is_null(key)) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006695 status = psa_key_derivation_input_bytes(
6696 derivation, PSA_KEY_DERIVATION_INPUT_SECRET,
Gilles Peskine449bd832023-01-11 14:50:10 +01006697 raw_psk, raw_psk_length);
6698 } else {
Jerry Yudc7bd172022-02-17 13:44:15 +08006699 status = psa_key_derivation_input_key(
Gilles Peskine449bd832023-01-11 14:50:10 +01006700 derivation, PSA_KEY_DERIVATION_INPUT_SECRET, key);
Jerry Yudc7bd172022-02-17 13:44:15 +08006701 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006702 if (status != PSA_SUCCESS) {
6703 return status;
6704 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006705
Gilles Peskine449bd832023-01-11 14:50:10 +01006706 status = psa_key_derivation_input_bytes(derivation,
6707 PSA_KEY_DERIVATION_INPUT_LABEL,
6708 label, label_length);
6709 if (status != PSA_SUCCESS) {
6710 return status;
6711 }
6712 } else {
6713 return PSA_ERROR_NOT_SUPPORTED;
Jerry Yudc7bd172022-02-17 13:44:15 +08006714 }
6715
Gilles Peskine449bd832023-01-11 14:50:10 +01006716 status = psa_key_derivation_set_capacity(derivation, capacity);
6717 if (status != PSA_SUCCESS) {
6718 return status;
6719 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006720
Gilles Peskine449bd832023-01-11 14:50:10 +01006721 return PSA_SUCCESS;
Jerry Yudc7bd172022-02-17 13:44:15 +08006722}
6723
Andrzej Kurek57d10632022-10-24 10:32:01 -04006724#if defined(PSA_WANT_ALG_SHA_384) || \
6725 defined(PSA_WANT_ALG_SHA_256)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006726MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006727static int tls_prf_generic(mbedtls_md_type_t md_type,
6728 const unsigned char *secret, size_t slen,
6729 const char *label,
6730 const unsigned char *random, size_t rlen,
6731 unsigned char *dstbuf, size_t dlen)
Jerry Yudc7bd172022-02-17 13:44:15 +08006732{
6733 psa_status_t status;
6734 psa_algorithm_t alg;
6735 mbedtls_svc_key_id_t master_key = MBEDTLS_SVC_KEY_ID_INIT;
6736 psa_key_derivation_operation_t derivation =
6737 PSA_KEY_DERIVATION_OPERATION_INIT;
6738
Gilles Peskine449bd832023-01-11 14:50:10 +01006739 if (md_type == MBEDTLS_MD_SHA384) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006740 alg = PSA_ALG_TLS12_PRF(PSA_ALG_SHA_384);
Gilles Peskine449bd832023-01-11 14:50:10 +01006741 } else {
Jerry Yudc7bd172022-02-17 13:44:15 +08006742 alg = PSA_ALG_TLS12_PRF(PSA_ALG_SHA_256);
Gilles Peskine449bd832023-01-11 14:50:10 +01006743 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006744
6745 /* Normally a "secret" should be long enough to be impossible to
6746 * find by brute force, and in particular should not be empty. But
6747 * this PRF is also used to derive an IV, in particular in EAP-TLS,
6748 * and for this use case it makes sense to have a 0-length "secret".
6749 * Since the key API doesn't allow importing a key of length 0,
6750 * keep master_key=0, which setup_psa_key_derivation() understands
6751 * to mean a 0-length "secret" input. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006752 if (slen != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006753 psa_key_attributes_t key_attributes = psa_key_attributes_init();
Gilles Peskine449bd832023-01-11 14:50:10 +01006754 psa_set_key_usage_flags(&key_attributes, PSA_KEY_USAGE_DERIVE);
6755 psa_set_key_algorithm(&key_attributes, alg);
6756 psa_set_key_type(&key_attributes, PSA_KEY_TYPE_DERIVE);
Jerry Yudc7bd172022-02-17 13:44:15 +08006757
Gilles Peskine449bd832023-01-11 14:50:10 +01006758 status = psa_import_key(&key_attributes, secret, slen, &master_key);
6759 if (status != PSA_SUCCESS) {
6760 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
6761 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006762 }
6763
Gilles Peskine449bd832023-01-11 14:50:10 +01006764 status = setup_psa_key_derivation(&derivation,
6765 master_key, alg,
6766 NULL, 0,
6767 random, rlen,
6768 (unsigned char const *) label,
6769 (size_t) strlen(label),
6770 NULL, 0,
6771 dlen);
6772 if (status != PSA_SUCCESS) {
6773 psa_key_derivation_abort(&derivation);
6774 psa_destroy_key(master_key);
6775 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yudc7bd172022-02-17 13:44:15 +08006776 }
6777
Gilles Peskine449bd832023-01-11 14:50:10 +01006778 status = psa_key_derivation_output_bytes(&derivation, dstbuf, dlen);
6779 if (status != PSA_SUCCESS) {
6780 psa_key_derivation_abort(&derivation);
6781 psa_destroy_key(master_key);
6782 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yudc7bd172022-02-17 13:44:15 +08006783 }
6784
Gilles Peskine449bd832023-01-11 14:50:10 +01006785 status = psa_key_derivation_abort(&derivation);
6786 if (status != PSA_SUCCESS) {
6787 psa_destroy_key(master_key);
6788 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yudc7bd172022-02-17 13:44:15 +08006789 }
6790
Gilles Peskine449bd832023-01-11 14:50:10 +01006791 if (!mbedtls_svc_key_id_is_null(master_key)) {
6792 status = psa_destroy_key(master_key);
6793 }
6794 if (status != PSA_SUCCESS) {
6795 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
6796 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006797
Gilles Peskine449bd832023-01-11 14:50:10 +01006798 return 0;
Jerry Yudc7bd172022-02-17 13:44:15 +08006799}
Andrzej Kurek57d10632022-10-24 10:32:01 -04006800#endif /* PSA_WANT_ALG_SHA_256 || PSA_WANT_ALG_SHA_384 */
Jerry Yudc7bd172022-02-17 13:44:15 +08006801#else /* MBEDTLS_USE_PSA_CRYPTO */
6802
Andrzej Kurek57d10632022-10-24 10:32:01 -04006803#if defined(MBEDTLS_MD_C) && \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006804 (defined(MBEDTLS_MD_CAN_SHA256) || \
6805 defined(MBEDTLS_MD_CAN_SHA384))
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006806MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006807static int tls_prf_generic(mbedtls_md_type_t md_type,
6808 const unsigned char *secret, size_t slen,
6809 const char *label,
6810 const unsigned char *random, size_t rlen,
6811 unsigned char *dstbuf, size_t dlen)
Jerry Yudc7bd172022-02-17 13:44:15 +08006812{
6813 size_t nb;
6814 size_t i, j, k, md_len;
6815 unsigned char *tmp;
6816 size_t tmp_len = 0;
6817 unsigned char h_i[MBEDTLS_MD_MAX_SIZE];
6818 const mbedtls_md_info_t *md_info;
6819 mbedtls_md_context_t md_ctx;
6820 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6821
Gilles Peskine449bd832023-01-11 14:50:10 +01006822 mbedtls_md_init(&md_ctx);
Jerry Yudc7bd172022-02-17 13:44:15 +08006823
Gilles Peskine449bd832023-01-11 14:50:10 +01006824 if ((md_info = mbedtls_md_info_from_type(md_type)) == NULL) {
6825 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
6826 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006827
Gilles Peskine449bd832023-01-11 14:50:10 +01006828 md_len = mbedtls_md_get_size(md_info);
Jerry Yudc7bd172022-02-17 13:44:15 +08006829
Gilles Peskine449bd832023-01-11 14:50:10 +01006830 tmp_len = md_len + strlen(label) + rlen;
6831 tmp = mbedtls_calloc(1, tmp_len);
6832 if (tmp == NULL) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006833 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
6834 goto exit;
6835 }
6836
Gilles Peskine449bd832023-01-11 14:50:10 +01006837 nb = strlen(label);
6838 memcpy(tmp + md_len, label, nb);
6839 memcpy(tmp + md_len + nb, random, rlen);
Jerry Yudc7bd172022-02-17 13:44:15 +08006840 nb += rlen;
6841
6842 /*
6843 * Compute P_<hash>(secret, label + random)[0..dlen]
6844 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006845 if ((ret = mbedtls_md_setup(&md_ctx, md_info, 1)) != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006846 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006847 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006848
Gilles Peskine449bd832023-01-11 14:50:10 +01006849 ret = mbedtls_md_hmac_starts(&md_ctx, secret, slen);
6850 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006851 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006852 }
6853 ret = mbedtls_md_hmac_update(&md_ctx, tmp + md_len, nb);
6854 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006855 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006856 }
6857 ret = mbedtls_md_hmac_finish(&md_ctx, tmp);
6858 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006859 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006860 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006861
Gilles Peskine449bd832023-01-11 14:50:10 +01006862 for (i = 0; i < dlen; i += md_len) {
6863 ret = mbedtls_md_hmac_reset(&md_ctx);
6864 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006865 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006866 }
6867 ret = mbedtls_md_hmac_update(&md_ctx, tmp, md_len + nb);
6868 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006869 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006870 }
6871 ret = mbedtls_md_hmac_finish(&md_ctx, h_i);
6872 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006873 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006874 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006875
Gilles Peskine449bd832023-01-11 14:50:10 +01006876 ret = mbedtls_md_hmac_reset(&md_ctx);
6877 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006878 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006879 }
6880 ret = mbedtls_md_hmac_update(&md_ctx, tmp, md_len);
6881 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006882 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006883 }
6884 ret = mbedtls_md_hmac_finish(&md_ctx, tmp);
6885 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006886 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006887 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006888
Gilles Peskine449bd832023-01-11 14:50:10 +01006889 k = (i + md_len > dlen) ? dlen % md_len : md_len;
Jerry Yudc7bd172022-02-17 13:44:15 +08006890
Gilles Peskine449bd832023-01-11 14:50:10 +01006891 for (j = 0; j < k; j++) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006892 dstbuf[i + j] = h_i[j];
Gilles Peskine449bd832023-01-11 14:50:10 +01006893 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006894 }
6895
6896exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01006897 mbedtls_md_free(&md_ctx);
Jerry Yudc7bd172022-02-17 13:44:15 +08006898
Gilles Peskine449bd832023-01-11 14:50:10 +01006899 if (tmp != NULL) {
6900 mbedtls_platform_zeroize(tmp, tmp_len);
6901 }
Dave Rodgman29b9b2b2022-11-01 16:08:14 +00006902
Gilles Peskine449bd832023-01-11 14:50:10 +01006903 mbedtls_platform_zeroize(h_i, sizeof(h_i));
Jerry Yudc7bd172022-02-17 13:44:15 +08006904
Gilles Peskine449bd832023-01-11 14:50:10 +01006905 mbedtls_free(tmp);
Jerry Yudc7bd172022-02-17 13:44:15 +08006906
Gilles Peskine449bd832023-01-11 14:50:10 +01006907 return ret;
Jerry Yudc7bd172022-02-17 13:44:15 +08006908}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006909#endif /* MBEDTLS_MD_C && ( MBEDTLS_MD_CAN_SHA256 || MBEDTLS_MD_CAN_SHA384 ) */
Jerry Yudc7bd172022-02-17 13:44:15 +08006910#endif /* MBEDTLS_USE_PSA_CRYPTO */
6911
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006912#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006913MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006914static int tls_prf_sha256(const unsigned char *secret, size_t slen,
6915 const char *label,
6916 const unsigned char *random, size_t rlen,
6917 unsigned char *dstbuf, size_t dlen)
Jerry Yudc7bd172022-02-17 13:44:15 +08006918{
Gilles Peskine449bd832023-01-11 14:50:10 +01006919 return tls_prf_generic(MBEDTLS_MD_SHA256, secret, slen,
6920 label, random, rlen, dstbuf, dlen);
Jerry Yudc7bd172022-02-17 13:44:15 +08006921}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006922#endif /* MBEDTLS_MD_CAN_SHA256*/
Jerry Yudc7bd172022-02-17 13:44:15 +08006923
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006924#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006925MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006926static int tls_prf_sha384(const unsigned char *secret, size_t slen,
6927 const char *label,
6928 const unsigned char *random, size_t rlen,
6929 unsigned char *dstbuf, size_t dlen)
Jerry Yudc7bd172022-02-17 13:44:15 +08006930{
Gilles Peskine449bd832023-01-11 14:50:10 +01006931 return tls_prf_generic(MBEDTLS_MD_SHA384, secret, slen,
6932 label, random, rlen, dstbuf, dlen);
Jerry Yudc7bd172022-02-17 13:44:15 +08006933}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006934#endif /* MBEDTLS_MD_CAN_SHA384*/
Jerry Yudc7bd172022-02-17 13:44:15 +08006935
Jerry Yuf009d862022-02-17 14:01:37 +08006936/*
6937 * Set appropriate PRF function and other SSL / TLS1.2 functions
6938 *
6939 * Inputs:
Jerry Yuf009d862022-02-17 14:01:37 +08006940 * - hash associated with the ciphersuite (only used by TLS 1.2)
6941 *
6942 * Outputs:
6943 * - the tls_prf, calc_verify and calc_finished members of handshake structure
6944 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006945MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006946static int ssl_set_handshake_prfs(mbedtls_ssl_handshake_params *handshake,
6947 mbedtls_md_type_t hash)
Jerry Yuf009d862022-02-17 14:01:37 +08006948{
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006949#if defined(MBEDTLS_MD_CAN_SHA384)
Gilles Peskine449bd832023-01-11 14:50:10 +01006950 if (hash == MBEDTLS_MD_SHA384) {
Jerry Yuf009d862022-02-17 14:01:37 +08006951 handshake->tls_prf = tls_prf_sha384;
6952 handshake->calc_verify = ssl_calc_verify_tls_sha384;
6953 handshake->calc_finished = ssl_calc_finished_tls_sha384;
Gilles Peskine449bd832023-01-11 14:50:10 +01006954 } else
Jerry Yuf009d862022-02-17 14:01:37 +08006955#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006956#if defined(MBEDTLS_MD_CAN_SHA256)
Jerry Yuf009d862022-02-17 14:01:37 +08006957 {
Ronald Cron81591aa2022-03-07 09:05:51 +01006958 (void) hash;
Jerry Yuf009d862022-02-17 14:01:37 +08006959 handshake->tls_prf = tls_prf_sha256;
6960 handshake->calc_verify = ssl_calc_verify_tls_sha256;
6961 handshake->calc_finished = ssl_calc_finished_tls_sha256;
6962 }
Ronald Cron81591aa2022-03-07 09:05:51 +01006963#else
Jerry Yuf009d862022-02-17 14:01:37 +08006964 {
Jerry Yuf009d862022-02-17 14:01:37 +08006965 (void) handshake;
Ronald Cron81591aa2022-03-07 09:05:51 +01006966 (void) hash;
Gilles Peskine449bd832023-01-11 14:50:10 +01006967 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yuf009d862022-02-17 14:01:37 +08006968 }
Ronald Cron81591aa2022-03-07 09:05:51 +01006969#endif
Jerry Yuf009d862022-02-17 14:01:37 +08006970
Gilles Peskine449bd832023-01-11 14:50:10 +01006971 return 0;
Jerry Yuf009d862022-02-17 14:01:37 +08006972}
Jerry Yud6ab2352022-02-17 14:03:43 +08006973
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006974/*
6975 * Compute master secret if needed
6976 *
6977 * Parameters:
6978 * [in/out] handshake
6979 * [in] resume, premaster, extended_ms, calc_verify, tls_prf
6980 * (PSA-PSK) ciphersuite_info, psk_opaque
6981 * [out] premaster (cleared)
6982 * [out] master
6983 * [in] ssl: optionally used for debugging, EMS and PSA-PSK
6984 * debug: conf->f_dbg, conf->p_dbg
6985 * EMS: passed to calc_verify (debug + session_negotiate)
Ronald Crona25cf582022-03-07 11:10:36 +01006986 * PSA-PSA: conf
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006987 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006988MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006989static int ssl_compute_master(mbedtls_ssl_handshake_params *handshake,
6990 unsigned char *master,
6991 const mbedtls_ssl_context *ssl)
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006992{
6993 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6994
6995 /* cf. RFC 5246, Section 8.1:
6996 * "The master secret is always exactly 48 bytes in length." */
6997 size_t const master_secret_len = 48;
6998
6999#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
7000 unsigned char session_hash[48];
7001#endif /* MBEDTLS_SSL_EXTENDED_MASTER_SECRET */
7002
7003 /* The label for the KDF used for key expansion.
7004 * This is either "master secret" or "extended master secret"
7005 * depending on whether the Extended Master Secret extension
7006 * is used. */
7007 char const *lbl = "master secret";
7008
Przemek Stekielae4ed302022-04-05 17:15:55 +02007009 /* The seed for the KDF used for key expansion.
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007010 * - If the Extended Master Secret extension is not used,
7011 * this is ClientHello.Random + ServerHello.Random
7012 * (see Sect. 8.1 in RFC 5246).
7013 * - If the Extended Master Secret extension is used,
7014 * this is the transcript of the handshake so far.
7015 * (see Sect. 4 in RFC 7627). */
Przemek Stekielae4ed302022-04-05 17:15:55 +02007016 unsigned char const *seed = handshake->randbytes;
7017 size_t seed_len = 64;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007018
7019#if !defined(MBEDTLS_DEBUG_C) && \
7020 !defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET) && \
7021 !(defined(MBEDTLS_USE_PSA_CRYPTO) && \
Gilles Peskine449bd832023-01-11 14:50:10 +01007022 defined(MBEDTLS_KEY_EXCHANGE_PSK_ENABLED))
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007023 ssl = NULL; /* make sure we don't use it except for those cases */
7024 (void) ssl;
7025#endif
7026
Gilles Peskine449bd832023-01-11 14:50:10 +01007027 if (handshake->resume != 0) {
7028 MBEDTLS_SSL_DEBUG_MSG(3, ("no premaster (session resumed)"));
7029 return 0;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007030 }
7031
7032#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
Gilles Peskine449bd832023-01-11 14:50:10 +01007033 if (handshake->extended_ms == MBEDTLS_SSL_EXTENDED_MS_ENABLED) {
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007034 lbl = "extended master secret";
Przemek Stekielae4ed302022-04-05 17:15:55 +02007035 seed = session_hash;
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01007036 ret = handshake->calc_verify(ssl, session_hash, &seed_len);
7037 if (ret != 0) {
7038 MBEDTLS_SSL_DEBUG_RET(1, "calc_verify", ret);
7039 }
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007040
Gilles Peskine449bd832023-01-11 14:50:10 +01007041 MBEDTLS_SSL_DEBUG_BUF(3, "session hash for extended master secret",
7042 session_hash, seed_len);
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007043 }
Przemek Stekiel169bf0b2022-04-29 07:53:29 +02007044#endif /* MBEDTLS_SSL_EXTENDED_MASTER_SECRET */
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007045
Przemek Stekiel99114f32022-04-22 11:20:09 +02007046#if defined(MBEDTLS_USE_PSA_CRYPTO) && \
Przemek Stekiel8a4b7fd2022-04-28 09:22:22 +02007047 defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007048 if (mbedtls_ssl_ciphersuite_uses_psk(handshake->ciphersuite_info) == 1) {
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007049 /* Perform PSK-to-MS expansion in a single step. */
7050 psa_status_t status;
7051 psa_algorithm_t alg;
7052 mbedtls_svc_key_id_t psk;
7053 psa_key_derivation_operation_t derivation =
7054 PSA_KEY_DERIVATION_OPERATION_INIT;
Dave Rodgman2eab4622023-10-05 13:30:37 +01007055 mbedtls_md_type_t hash_alg = (mbedtls_md_type_t) handshake->ciphersuite_info->mac;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007056
Gilles Peskine449bd832023-01-11 14:50:10 +01007057 MBEDTLS_SSL_DEBUG_MSG(2, ("perform PSA-based PSK-to-MS expansion"));
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007058
Gilles Peskine449bd832023-01-11 14:50:10 +01007059 psk = mbedtls_ssl_get_opaque_psk(ssl);
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007060
Gilles Peskine449bd832023-01-11 14:50:10 +01007061 if (hash_alg == MBEDTLS_MD_SHA384) {
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007062 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_384);
Gilles Peskine449bd832023-01-11 14:50:10 +01007063 } else {
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007064 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_256);
Gilles Peskine449bd832023-01-11 14:50:10 +01007065 }
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007066
Przemek Stekiel51a1f362022-04-13 08:57:06 +02007067 size_t other_secret_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01007068 unsigned char *other_secret = NULL;
Przemek Stekielc2033402022-04-05 17:19:41 +02007069
Gilles Peskine449bd832023-01-11 14:50:10 +01007070 switch (handshake->ciphersuite_info->key_exchange) {
Przemek Stekiel19b80f82022-04-14 08:29:31 +02007071 /* Provide other secret.
Przemek Stekiel51a1f362022-04-13 08:57:06 +02007072 * Other secret is stored in premaster, where first 2 bytes hold the
Przemek Stekiel19b80f82022-04-14 08:29:31 +02007073 * length of the other key.
Przemek Stekielc2033402022-04-05 17:19:41 +02007074 */
Przemek Stekiel19b80f82022-04-14 08:29:31 +02007075 case MBEDTLS_KEY_EXCHANGE_RSA_PSK:
Przemek Stekiel8abcee92022-04-28 09:16:28 +02007076 /* For RSA-PSK other key length is always 48 bytes. */
Przemek Stekiel19b80f82022-04-14 08:29:31 +02007077 other_secret_len = 48;
7078 other_secret = handshake->premaster + 2;
7079 break;
7080 case MBEDTLS_KEY_EXCHANGE_ECDHE_PSK:
Przemek Stekielb293aaa2022-04-19 12:22:38 +02007081 case MBEDTLS_KEY_EXCHANGE_DHE_PSK:
Przemek Stekiel19b80f82022-04-14 08:29:31 +02007082 other_secret_len = MBEDTLS_GET_UINT16_BE(handshake->premaster, 0);
7083 other_secret = handshake->premaster + 2;
7084 break;
7085 default:
7086 break;
Przemek Stekielc2033402022-04-05 17:19:41 +02007087 }
7088
Gilles Peskine449bd832023-01-11 14:50:10 +01007089 status = setup_psa_key_derivation(&derivation, psk, alg,
7090 ssl->conf->psk, ssl->conf->psk_len,
7091 seed, seed_len,
7092 (unsigned char const *) lbl,
7093 (size_t) strlen(lbl),
7094 other_secret, other_secret_len,
7095 master_secret_len);
7096 if (status != PSA_SUCCESS) {
7097 psa_key_derivation_abort(&derivation);
7098 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007099 }
7100
Gilles Peskine449bd832023-01-11 14:50:10 +01007101 status = psa_key_derivation_output_bytes(&derivation,
7102 master,
7103 master_secret_len);
7104 if (status != PSA_SUCCESS) {
7105 psa_key_derivation_abort(&derivation);
7106 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007107 }
7108
Gilles Peskine449bd832023-01-11 14:50:10 +01007109 status = psa_key_derivation_abort(&derivation);
7110 if (status != PSA_SUCCESS) {
7111 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
7112 }
7113 } else
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007114#endif
7115 {
Neil Armstrongca7d5062022-05-31 14:43:23 +02007116#if defined(MBEDTLS_USE_PSA_CRYPTO) && \
Gilles Peskine449bd832023-01-11 14:50:10 +01007117 defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
7118 if (handshake->ciphersuite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_ECJPAKE) {
Neil Armstrongca7d5062022-05-31 14:43:23 +02007119 psa_status_t status;
7120 psa_algorithm_t alg = PSA_ALG_TLS12_ECJPAKE_TO_PMS;
7121 psa_key_derivation_operation_t derivation =
7122 PSA_KEY_DERIVATION_OPERATION_INIT;
7123
Gilles Peskine449bd832023-01-11 14:50:10 +01007124 MBEDTLS_SSL_DEBUG_MSG(2, ("perform PSA-based PMS KDF for ECJPAKE"));
Neil Armstrongca7d5062022-05-31 14:43:23 +02007125
7126 handshake->pmslen = PSA_TLS12_ECJPAKE_TO_PMS_DATA_SIZE;
7127
Gilles Peskine449bd832023-01-11 14:50:10 +01007128 status = psa_key_derivation_setup(&derivation, alg);
7129 if (status != PSA_SUCCESS) {
7130 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Neil Armstrongca7d5062022-05-31 14:43:23 +02007131 }
7132
Gilles Peskine449bd832023-01-11 14:50:10 +01007133 status = psa_key_derivation_set_capacity(&derivation,
7134 PSA_TLS12_ECJPAKE_TO_PMS_DATA_SIZE);
7135 if (status != PSA_SUCCESS) {
7136 psa_key_derivation_abort(&derivation);
7137 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Neil Armstrongca7d5062022-05-31 14:43:23 +02007138 }
7139
Gilles Peskine449bd832023-01-11 14:50:10 +01007140 status = psa_pake_get_implicit_key(&handshake->psa_pake_ctx,
7141 &derivation);
7142 if (status != PSA_SUCCESS) {
7143 psa_key_derivation_abort(&derivation);
7144 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Neil Armstrongca7d5062022-05-31 14:43:23 +02007145 }
7146
Gilles Peskine449bd832023-01-11 14:50:10 +01007147 status = psa_key_derivation_output_bytes(&derivation,
7148 handshake->premaster,
7149 handshake->pmslen);
7150 if (status != PSA_SUCCESS) {
7151 psa_key_derivation_abort(&derivation);
7152 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
7153 }
7154
7155 status = psa_key_derivation_abort(&derivation);
7156 if (status != PSA_SUCCESS) {
7157 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Neil Armstrongca7d5062022-05-31 14:43:23 +02007158 }
7159 }
7160#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01007161 ret = handshake->tls_prf(handshake->premaster, handshake->pmslen,
7162 lbl, seed, seed_len,
7163 master,
7164 master_secret_len);
7165 if (ret != 0) {
7166 MBEDTLS_SSL_DEBUG_RET(1, "prf", ret);
7167 return ret;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007168 }
7169
Gilles Peskine449bd832023-01-11 14:50:10 +01007170 MBEDTLS_SSL_DEBUG_BUF(3, "premaster secret",
7171 handshake->premaster,
7172 handshake->pmslen);
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007173
Gilles Peskine449bd832023-01-11 14:50:10 +01007174 mbedtls_platform_zeroize(handshake->premaster,
7175 sizeof(handshake->premaster));
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007176 }
7177
Gilles Peskine449bd832023-01-11 14:50:10 +01007178 return 0;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007179}
7180
Gilles Peskine449bd832023-01-11 14:50:10 +01007181int mbedtls_ssl_derive_keys(mbedtls_ssl_context *ssl)
Jerry Yud62f87e2022-02-17 14:09:02 +08007182{
7183 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7184 const mbedtls_ssl_ciphersuite_t * const ciphersuite_info =
7185 ssl->handshake->ciphersuite_info;
7186
Gilles Peskine449bd832023-01-11 14:50:10 +01007187 MBEDTLS_SSL_DEBUG_MSG(2, ("=> derive keys"));
Jerry Yud62f87e2022-02-17 14:09:02 +08007188
7189 /* Set PRF, calc_verify and calc_finished function pointers */
Gilles Peskine449bd832023-01-11 14:50:10 +01007190 ret = ssl_set_handshake_prfs(ssl->handshake,
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01007191 (mbedtls_md_type_t) ciphersuite_info->mac);
Gilles Peskine449bd832023-01-11 14:50:10 +01007192 if (ret != 0) {
7193 MBEDTLS_SSL_DEBUG_RET(1, "ssl_set_handshake_prfs", ret);
7194 return ret;
Jerry Yud62f87e2022-02-17 14:09:02 +08007195 }
7196
7197 /* Compute master secret if needed */
Gilles Peskine449bd832023-01-11 14:50:10 +01007198 ret = ssl_compute_master(ssl->handshake,
7199 ssl->session_negotiate->master,
7200 ssl);
7201 if (ret != 0) {
7202 MBEDTLS_SSL_DEBUG_RET(1, "ssl_compute_master", ret);
7203 return ret;
Jerry Yud62f87e2022-02-17 14:09:02 +08007204 }
7205
7206 /* Swap the client and server random values:
7207 * - MS derivation wanted client+server (RFC 5246 8.1)
7208 * - key derivation wants server+client (RFC 5246 6.3) */
7209 {
7210 unsigned char tmp[64];
Gilles Peskine449bd832023-01-11 14:50:10 +01007211 memcpy(tmp, ssl->handshake->randbytes, 64);
7212 memcpy(ssl->handshake->randbytes, tmp + 32, 32);
7213 memcpy(ssl->handshake->randbytes + 32, tmp, 32);
7214 mbedtls_platform_zeroize(tmp, sizeof(tmp));
Jerry Yud62f87e2022-02-17 14:09:02 +08007215 }
7216
7217 /* Populate transform structure */
Gilles Peskine449bd832023-01-11 14:50:10 +01007218 ret = ssl_tls12_populate_transform(ssl->transform_negotiate,
7219 ssl->session_negotiate->ciphersuite,
7220 ssl->session_negotiate->master,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02007221#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01007222 ssl->session_negotiate->encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02007223#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01007224 ssl->handshake->tls_prf,
7225 ssl->handshake->randbytes,
7226 ssl->tls_version,
7227 ssl->conf->endpoint,
7228 ssl);
7229 if (ret != 0) {
7230 MBEDTLS_SSL_DEBUG_RET(1, "ssl_tls12_populate_transform", ret);
7231 return ret;
Jerry Yud62f87e2022-02-17 14:09:02 +08007232 }
7233
7234 /* We no longer need Server/ClientHello.random values */
Gilles Peskine449bd832023-01-11 14:50:10 +01007235 mbedtls_platform_zeroize(ssl->handshake->randbytes,
7236 sizeof(ssl->handshake->randbytes));
Jerry Yud62f87e2022-02-17 14:09:02 +08007237
Gilles Peskine449bd832023-01-11 14:50:10 +01007238 MBEDTLS_SSL_DEBUG_MSG(2, ("<= derive keys"));
Jerry Yud62f87e2022-02-17 14:09:02 +08007239
Gilles Peskine449bd832023-01-11 14:50:10 +01007240 return 0;
Jerry Yud62f87e2022-02-17 14:09:02 +08007241}
Jerry Yu8392e0d2022-02-17 14:10:24 +08007242
Gilles Peskine449bd832023-01-11 14:50:10 +01007243int mbedtls_ssl_set_calc_verify_md(mbedtls_ssl_context *ssl, int md)
Ronald Cron4dcbca92022-03-07 10:21:40 +01007244{
Gilles Peskine449bd832023-01-11 14:50:10 +01007245 switch (md) {
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01007246#if defined(MBEDTLS_MD_CAN_SHA384)
Ronald Cron4dcbca92022-03-07 10:21:40 +01007247 case MBEDTLS_SSL_HASH_SHA384:
7248 ssl->handshake->calc_verify = ssl_calc_verify_tls_sha384;
7249 break;
7250#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01007251#if defined(MBEDTLS_MD_CAN_SHA256)
Ronald Cron4dcbca92022-03-07 10:21:40 +01007252 case MBEDTLS_SSL_HASH_SHA256:
7253 ssl->handshake->calc_verify = ssl_calc_verify_tls_sha256;
7254 break;
7255#endif
7256 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01007257 return -1;
Ronald Cron4dcbca92022-03-07 10:21:40 +01007258 }
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01007259#if !defined(MBEDTLS_MD_CAN_SHA384) && \
7260 !defined(MBEDTLS_MD_CAN_SHA256)
Andrzej Kurekeabeb302022-10-17 07:52:51 -04007261 (void) ssl;
7262#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01007263 return 0;
Ronald Cron4dcbca92022-03-07 10:21:40 +01007264}
7265
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007266#if defined(MBEDTLS_USE_PSA_CRYPTO)
7267static int ssl_calc_verify_tls_psa(const mbedtls_ssl_context *ssl,
7268 const psa_hash_operation_t *hs_op,
7269 size_t buffer_size,
7270 unsigned char *hash,
7271 size_t *hlen)
7272{
7273 psa_status_t status;
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007274 psa_hash_operation_t cloned_op = psa_hash_operation_init();
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007275
7276#if !defined(MBEDTLS_DEBUG_C)
7277 (void) ssl;
7278#endif
7279 MBEDTLS_SSL_DEBUG_MSG(2, ("=> PSA calc verify"));
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007280 status = psa_hash_clone(hs_op, &cloned_op);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007281 if (status != PSA_SUCCESS) {
7282 goto exit;
7283 }
7284
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007285 status = psa_hash_finish(&cloned_op, hash, buffer_size, hlen);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007286 if (status != PSA_SUCCESS) {
7287 goto exit;
7288 }
7289
7290 MBEDTLS_SSL_DEBUG_BUF(3, "PSA calculated verify result", hash, *hlen);
7291 MBEDTLS_SSL_DEBUG_MSG(2, ("<= PSA calc verify"));
7292
7293exit:
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007294 psa_hash_abort(&cloned_op);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007295 return mbedtls_md_error_from_psa(status);
7296}
7297#else
7298static int ssl_calc_verify_tls_legacy(const mbedtls_ssl_context *ssl,
7299 const mbedtls_md_context_t *hs_ctx,
7300 unsigned char *hash,
7301 size_t *hlen)
7302{
7303 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007304 mbedtls_md_context_t cloned_ctx;
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007305
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007306 mbedtls_md_init(&cloned_ctx);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007307
7308#if !defined(MBEDTLS_DEBUG_C)
7309 (void) ssl;
7310#endif
7311 MBEDTLS_SSL_DEBUG_MSG(2, ("=> calc verify"));
7312
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007313 ret = mbedtls_md_setup(&cloned_ctx, mbedtls_md_info_from_ctx(hs_ctx), 0);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007314 if (ret != 0) {
7315 goto exit;
7316 }
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007317 ret = mbedtls_md_clone(&cloned_ctx, hs_ctx);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007318 if (ret != 0) {
7319 goto exit;
7320 }
7321
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007322 ret = mbedtls_md_finish(&cloned_ctx, hash);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007323 if (ret != 0) {
7324 goto exit;
7325 }
7326
7327 *hlen = mbedtls_md_get_size(mbedtls_md_info_from_ctx(hs_ctx));
7328
7329 MBEDTLS_SSL_DEBUG_BUF(3, "calculated verify result", hash, *hlen);
7330 MBEDTLS_SSL_DEBUG_MSG(2, ("<= calc verify"));
7331
7332exit:
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007333 mbedtls_md_free(&cloned_ctx);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007334 return ret;
7335}
7336#endif /* MBEDTLS_USE_PSA_CRYPTO */
7337
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01007338#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +01007339int ssl_calc_verify_tls_sha256(const mbedtls_ssl_context *ssl,
7340 unsigned char *hash,
7341 size_t *hlen)
Jerry Yu8392e0d2022-02-17 14:10:24 +08007342{
7343#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007344 return ssl_calc_verify_tls_psa(ssl, &ssl->handshake->fin_sha256_psa, 32,
7345 hash, hlen);
Jerry Yu8392e0d2022-02-17 14:10:24 +08007346#else
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007347 return ssl_calc_verify_tls_legacy(ssl, &ssl->handshake->fin_sha256,
7348 hash, hlen);
Jerry Yu8392e0d2022-02-17 14:10:24 +08007349#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu8392e0d2022-02-17 14:10:24 +08007350}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01007351#endif /* MBEDTLS_MD_CAN_SHA256 */
Jerry Yu8392e0d2022-02-17 14:10:24 +08007352
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01007353#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +01007354int ssl_calc_verify_tls_sha384(const mbedtls_ssl_context *ssl,
7355 unsigned char *hash,
7356 size_t *hlen)
Jerry Yuc1cb3842022-02-17 14:13:48 +08007357{
7358#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007359 return ssl_calc_verify_tls_psa(ssl, &ssl->handshake->fin_sha384_psa, 48,
7360 hash, hlen);
Jerry Yuc1cb3842022-02-17 14:13:48 +08007361#else
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007362 return ssl_calc_verify_tls_legacy(ssl, &ssl->handshake->fin_sha384,
7363 hash, hlen);
Jerry Yuc1cb3842022-02-17 14:13:48 +08007364#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yuc1cb3842022-02-17 14:13:48 +08007365}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01007366#endif /* MBEDTLS_MD_CAN_SHA384 */
Jerry Yuc1cb3842022-02-17 14:13:48 +08007367
Neil Armstrong80f6f322022-05-03 17:56:38 +02007368#if !defined(MBEDTLS_USE_PSA_CRYPTO) && \
7369 defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007370int mbedtls_ssl_psk_derive_premaster(mbedtls_ssl_context *ssl, mbedtls_key_exchange_type_t key_ex)
Jerry Yuce3dca42022-02-17 14:16:37 +08007371{
7372 unsigned char *p = ssl->handshake->premaster;
Gilles Peskine449bd832023-01-11 14:50:10 +01007373 unsigned char *end = p + sizeof(ssl->handshake->premaster);
Jerry Yuce3dca42022-02-17 14:16:37 +08007374 const unsigned char *psk = NULL;
7375 size_t psk_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01007376 int psk_ret = mbedtls_ssl_get_psk(ssl, &psk, &psk_len);
Jerry Yuce3dca42022-02-17 14:16:37 +08007377
Gilles Peskine449bd832023-01-11 14:50:10 +01007378 if (psk_ret == MBEDTLS_ERR_SSL_PRIVATE_KEY_REQUIRED) {
Jerry Yuce3dca42022-02-17 14:16:37 +08007379 /*
7380 * This should never happen because the existence of a PSK is always
Przemek Stekielb293aaa2022-04-19 12:22:38 +02007381 * checked before calling this function.
7382 *
7383 * The exception is opaque DHE-PSK. For DHE-PSK fill premaster with
Przemek Stekiel8abcee92022-04-28 09:16:28 +02007384 * the shared secret without PSK.
Jerry Yuce3dca42022-02-17 14:16:37 +08007385 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007386 if (key_ex != MBEDTLS_KEY_EXCHANGE_DHE_PSK) {
7387 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
7388 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Przemek Stekielb293aaa2022-04-19 12:22:38 +02007389 }
Jerry Yuce3dca42022-02-17 14:16:37 +08007390 }
7391
7392 /*
7393 * PMS = struct {
7394 * opaque other_secret<0..2^16-1>;
7395 * opaque psk<0..2^16-1>;
7396 * };
7397 * with "other_secret" depending on the particular key exchange
7398 */
7399#if defined(MBEDTLS_KEY_EXCHANGE_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007400 if (key_ex == MBEDTLS_KEY_EXCHANGE_PSK) {
7401 if (end - p < 2) {
7402 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
7403 }
Jerry Yuce3dca42022-02-17 14:16:37 +08007404
Gilles Peskine449bd832023-01-11 14:50:10 +01007405 MBEDTLS_PUT_UINT16_BE(psk_len, p, 0);
Jerry Yuce3dca42022-02-17 14:16:37 +08007406 p += 2;
7407
Gilles Peskine449bd832023-01-11 14:50:10 +01007408 if (end < p || (size_t) (end - p) < psk_len) {
7409 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
7410 }
Jerry Yuce3dca42022-02-17 14:16:37 +08007411
Gilles Peskine449bd832023-01-11 14:50:10 +01007412 memset(p, 0, psk_len);
Jerry Yuce3dca42022-02-17 14:16:37 +08007413 p += psk_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01007414 } else
Jerry Yuce3dca42022-02-17 14:16:37 +08007415#endif /* MBEDTLS_KEY_EXCHANGE_PSK_ENABLED */
7416#if defined(MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007417 if (key_ex == MBEDTLS_KEY_EXCHANGE_RSA_PSK) {
Jerry Yuce3dca42022-02-17 14:16:37 +08007418 /*
7419 * other_secret already set by the ClientKeyExchange message,
7420 * and is 48 bytes long
7421 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007422 if (end - p < 2) {
7423 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
7424 }
Jerry Yuce3dca42022-02-17 14:16:37 +08007425
7426 *p++ = 0;
7427 *p++ = 48;
7428 p += 48;
Gilles Peskine449bd832023-01-11 14:50:10 +01007429 } else
Jerry Yuce3dca42022-02-17 14:16:37 +08007430#endif /* MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED */
7431#if defined(MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007432 if (key_ex == MBEDTLS_KEY_EXCHANGE_DHE_PSK) {
Jerry Yuce3dca42022-02-17 14:16:37 +08007433 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7434 size_t len;
7435
7436 /* Write length only when we know the actual value */
Gilles Peskine449bd832023-01-11 14:50:10 +01007437 if ((ret = mbedtls_dhm_calc_secret(&ssl->handshake->dhm_ctx,
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00007438 p + 2, (size_t) (end - (p + 2)), &len,
Gilles Peskine449bd832023-01-11 14:50:10 +01007439 ssl->conf->f_rng, ssl->conf->p_rng)) != 0) {
7440 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_dhm_calc_secret", ret);
7441 return ret;
Jerry Yuce3dca42022-02-17 14:16:37 +08007442 }
Gilles Peskine449bd832023-01-11 14:50:10 +01007443 MBEDTLS_PUT_UINT16_BE(len, p, 0);
Jerry Yuce3dca42022-02-17 14:16:37 +08007444 p += 2 + len;
7445
Gilles Peskine449bd832023-01-11 14:50:10 +01007446 MBEDTLS_SSL_DEBUG_MPI(3, "DHM: K ", &ssl->handshake->dhm_ctx.K);
7447 } else
Jerry Yuce3dca42022-02-17 14:16:37 +08007448#endif /* MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED */
Neil Armstrong80f6f322022-05-03 17:56:38 +02007449#if defined(MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007450 if (key_ex == MBEDTLS_KEY_EXCHANGE_ECDHE_PSK) {
Jerry Yuce3dca42022-02-17 14:16:37 +08007451 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7452 size_t zlen;
7453
Gilles Peskine449bd832023-01-11 14:50:10 +01007454 if ((ret = mbedtls_ecdh_calc_secret(&ssl->handshake->ecdh_ctx, &zlen,
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00007455 p + 2, (size_t) (end - (p + 2)),
Gilles Peskine449bd832023-01-11 14:50:10 +01007456 ssl->conf->f_rng, ssl->conf->p_rng)) != 0) {
7457 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ecdh_calc_secret", ret);
7458 return ret;
Jerry Yuce3dca42022-02-17 14:16:37 +08007459 }
7460
Gilles Peskine449bd832023-01-11 14:50:10 +01007461 MBEDTLS_PUT_UINT16_BE(zlen, p, 0);
Jerry Yuce3dca42022-02-17 14:16:37 +08007462 p += 2 + zlen;
7463
Gilles Peskine449bd832023-01-11 14:50:10 +01007464 MBEDTLS_SSL_DEBUG_ECDH(3, &ssl->handshake->ecdh_ctx,
7465 MBEDTLS_DEBUG_ECDH_Z);
7466 } else
Neil Armstrong80f6f322022-05-03 17:56:38 +02007467#endif /* MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED */
Jerry Yuce3dca42022-02-17 14:16:37 +08007468 {
Gilles Peskine449bd832023-01-11 14:50:10 +01007469 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
7470 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yuce3dca42022-02-17 14:16:37 +08007471 }
7472
7473 /* opaque psk<0..2^16-1>; */
Gilles Peskine449bd832023-01-11 14:50:10 +01007474 if (end - p < 2) {
7475 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
7476 }
Jerry Yuce3dca42022-02-17 14:16:37 +08007477
Gilles Peskine449bd832023-01-11 14:50:10 +01007478 MBEDTLS_PUT_UINT16_BE(psk_len, p, 0);
Jerry Yuce3dca42022-02-17 14:16:37 +08007479 p += 2;
7480
Gilles Peskine449bd832023-01-11 14:50:10 +01007481 if (end < p || (size_t) (end - p) < psk_len) {
7482 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
7483 }
Jerry Yuce3dca42022-02-17 14:16:37 +08007484
Gilles Peskine449bd832023-01-11 14:50:10 +01007485 memcpy(p, psk, psk_len);
Jerry Yuce3dca42022-02-17 14:16:37 +08007486 p += psk_len;
7487
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00007488 ssl->handshake->pmslen = (size_t) (p - ssl->handshake->premaster);
Jerry Yuce3dca42022-02-17 14:16:37 +08007489
Gilles Peskine449bd832023-01-11 14:50:10 +01007490 return 0;
Jerry Yuce3dca42022-02-17 14:16:37 +08007491}
Neil Armstrong80f6f322022-05-03 17:56:38 +02007492#endif /* !MBEDTLS_USE_PSA_CRYPTO && MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
Jerry Yuc2c673d2022-02-17 14:20:39 +08007493
7494#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007495MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007496static int ssl_write_hello_request(mbedtls_ssl_context *ssl);
Jerry Yuc2c673d2022-02-17 14:20:39 +08007497
7498#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01007499int mbedtls_ssl_resend_hello_request(mbedtls_ssl_context *ssl)
Jerry Yuc2c673d2022-02-17 14:20:39 +08007500{
7501 /* If renegotiation is not enforced, retransmit until we would reach max
7502 * timeout if we were using the usual handshake doubling scheme */
Gilles Peskine449bd832023-01-11 14:50:10 +01007503 if (ssl->conf->renego_max_records < 0) {
Jerry Yuc2c673d2022-02-17 14:20:39 +08007504 uint32_t ratio = ssl->conf->hs_timeout_max / ssl->conf->hs_timeout_min + 1;
7505 unsigned char doublings = 1;
7506
Gilles Peskine449bd832023-01-11 14:50:10 +01007507 while (ratio != 0) {
Jerry Yuc2c673d2022-02-17 14:20:39 +08007508 ++doublings;
7509 ratio >>= 1;
7510 }
7511
Gilles Peskine449bd832023-01-11 14:50:10 +01007512 if (++ssl->renego_records_seen > doublings) {
7513 MBEDTLS_SSL_DEBUG_MSG(2, ("no longer retransmitting hello request"));
7514 return 0;
Jerry Yuc2c673d2022-02-17 14:20:39 +08007515 }
7516 }
7517
Gilles Peskine449bd832023-01-11 14:50:10 +01007518 return ssl_write_hello_request(ssl);
Jerry Yuc2c673d2022-02-17 14:20:39 +08007519}
7520#endif
7521#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_RENEGOTIATION */
Jerry Yud9526692022-02-17 14:23:47 +08007522
Jerry Yud9526692022-02-17 14:23:47 +08007523/*
7524 * Handshake functions
7525 */
7526#if !defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
7527/* No certificate support -> dummy functions */
Gilles Peskine449bd832023-01-11 14:50:10 +01007528int mbedtls_ssl_write_certificate(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08007529{
7530 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
7531 ssl->handshake->ciphersuite_info;
7532
Gilles Peskine449bd832023-01-11 14:50:10 +01007533 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007534
Gilles Peskine449bd832023-01-11 14:50:10 +01007535 if (!mbedtls_ssl_ciphersuite_uses_srv_cert(ciphersuite_info)) {
7536 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007537 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01007538 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007539 }
7540
Gilles Peskine449bd832023-01-11 14:50:10 +01007541 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
7542 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007543}
7544
Gilles Peskine449bd832023-01-11 14:50:10 +01007545int mbedtls_ssl_parse_certificate(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08007546{
7547 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
7548 ssl->handshake->ciphersuite_info;
7549
Gilles Peskine449bd832023-01-11 14:50:10 +01007550 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007551
Gilles Peskine449bd832023-01-11 14:50:10 +01007552 if (!mbedtls_ssl_ciphersuite_uses_srv_cert(ciphersuite_info)) {
7553 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007554 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01007555 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007556 }
7557
Gilles Peskine449bd832023-01-11 14:50:10 +01007558 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
7559 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007560}
7561
7562#else /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
7563/* Some certificate support -> implement write and parse */
7564
Gilles Peskine449bd832023-01-11 14:50:10 +01007565int mbedtls_ssl_write_certificate(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08007566{
7567 int ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
7568 size_t i, n;
7569 const mbedtls_x509_crt *crt;
7570 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
7571 ssl->handshake->ciphersuite_info;
7572
Gilles Peskine449bd832023-01-11 14:50:10 +01007573 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007574
Gilles Peskine449bd832023-01-11 14:50:10 +01007575 if (!mbedtls_ssl_ciphersuite_uses_srv_cert(ciphersuite_info)) {
7576 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007577 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01007578 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007579 }
7580
7581#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007582 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
7583 if (ssl->handshake->client_auth == 0) {
7584 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007585 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01007586 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007587 }
7588 }
7589#endif /* MBEDTLS_SSL_CLI_C */
7590#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007591 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
7592 if (mbedtls_ssl_own_cert(ssl) == NULL) {
Jerry Yud9526692022-02-17 14:23:47 +08007593 /* Should never happen because we shouldn't have picked the
7594 * ciphersuite if we don't have a certificate. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007595 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007596 }
7597 }
7598#endif
7599
Gilles Peskine449bd832023-01-11 14:50:10 +01007600 MBEDTLS_SSL_DEBUG_CRT(3, "own certificate", mbedtls_ssl_own_cert(ssl));
Jerry Yud9526692022-02-17 14:23:47 +08007601
7602 /*
7603 * 0 . 0 handshake type
7604 * 1 . 3 handshake length
7605 * 4 . 6 length of all certs
7606 * 7 . 9 length of cert. 1
7607 * 10 . n-1 peer certificate
7608 * n . n+2 length of cert. 2
7609 * n+3 . ... upper level cert, etc.
7610 */
7611 i = 7;
Gilles Peskine449bd832023-01-11 14:50:10 +01007612 crt = mbedtls_ssl_own_cert(ssl);
Jerry Yud9526692022-02-17 14:23:47 +08007613
Gilles Peskine449bd832023-01-11 14:50:10 +01007614 while (crt != NULL) {
Jerry Yud9526692022-02-17 14:23:47 +08007615 n = crt->raw.len;
Gilles Peskine449bd832023-01-11 14:50:10 +01007616 if (n > MBEDTLS_SSL_OUT_CONTENT_LEN - 3 - i) {
7617 MBEDTLS_SSL_DEBUG_MSG(1, ("certificate too large, %" MBEDTLS_PRINTF_SIZET
7618 " > %" MBEDTLS_PRINTF_SIZET,
7619 i + 3 + n, (size_t) MBEDTLS_SSL_OUT_CONTENT_LEN));
7620 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
Jerry Yud9526692022-02-17 14:23:47 +08007621 }
7622
Gilles Peskine449bd832023-01-11 14:50:10 +01007623 ssl->out_msg[i] = MBEDTLS_BYTE_2(n);
7624 ssl->out_msg[i + 1] = MBEDTLS_BYTE_1(n);
7625 ssl->out_msg[i + 2] = MBEDTLS_BYTE_0(n);
Jerry Yud9526692022-02-17 14:23:47 +08007626
Gilles Peskine449bd832023-01-11 14:50:10 +01007627 i += 3; memcpy(ssl->out_msg + i, crt->raw.p, n);
Jerry Yud9526692022-02-17 14:23:47 +08007628 i += n; crt = crt->next;
7629 }
7630
Gilles Peskine449bd832023-01-11 14:50:10 +01007631 ssl->out_msg[4] = MBEDTLS_BYTE_2(i - 7);
7632 ssl->out_msg[5] = MBEDTLS_BYTE_1(i - 7);
7633 ssl->out_msg[6] = MBEDTLS_BYTE_0(i - 7);
Jerry Yud9526692022-02-17 14:23:47 +08007634
7635 ssl->out_msglen = i;
7636 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
7637 ssl->out_msg[0] = MBEDTLS_SSL_HS_CERTIFICATE;
7638
7639 ssl->state++;
7640
Gilles Peskine449bd832023-01-11 14:50:10 +01007641 if ((ret = mbedtls_ssl_write_handshake_msg(ssl)) != 0) {
7642 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_handshake_msg", ret);
7643 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007644 }
7645
Gilles Peskine449bd832023-01-11 14:50:10 +01007646 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007647
Gilles Peskine449bd832023-01-11 14:50:10 +01007648 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007649}
7650
7651#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
7652
7653#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007654MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007655static int ssl_check_peer_crt_unchanged(mbedtls_ssl_context *ssl,
7656 unsigned char *crt_buf,
7657 size_t crt_buf_len)
Jerry Yud9526692022-02-17 14:23:47 +08007658{
7659 mbedtls_x509_crt const * const peer_crt = ssl->session->peer_cert;
7660
Gilles Peskine449bd832023-01-11 14:50:10 +01007661 if (peer_crt == NULL) {
7662 return -1;
7663 }
Jerry Yud9526692022-02-17 14:23:47 +08007664
Gilles Peskine449bd832023-01-11 14:50:10 +01007665 if (peer_crt->raw.len != crt_buf_len) {
7666 return -1;
7667 }
Jerry Yud9526692022-02-17 14:23:47 +08007668
Gilles Peskine449bd832023-01-11 14:50:10 +01007669 return memcmp(peer_crt->raw.p, crt_buf, peer_crt->raw.len);
Jerry Yud9526692022-02-17 14:23:47 +08007670}
7671#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007672MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007673static int ssl_check_peer_crt_unchanged(mbedtls_ssl_context *ssl,
7674 unsigned char *crt_buf,
7675 size_t crt_buf_len)
Jerry Yud9526692022-02-17 14:23:47 +08007676{
7677 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7678 unsigned char const * const peer_cert_digest =
7679 ssl->session->peer_cert_digest;
7680 mbedtls_md_type_t const peer_cert_digest_type =
7681 ssl->session->peer_cert_digest_type;
7682 mbedtls_md_info_t const * const digest_info =
Gilles Peskine449bd832023-01-11 14:50:10 +01007683 mbedtls_md_info_from_type(peer_cert_digest_type);
Jerry Yud9526692022-02-17 14:23:47 +08007684 unsigned char tmp_digest[MBEDTLS_SSL_PEER_CERT_DIGEST_MAX_LEN];
7685 size_t digest_len;
7686
Gilles Peskine449bd832023-01-11 14:50:10 +01007687 if (peer_cert_digest == NULL || digest_info == NULL) {
7688 return -1;
7689 }
Jerry Yud9526692022-02-17 14:23:47 +08007690
Gilles Peskine449bd832023-01-11 14:50:10 +01007691 digest_len = mbedtls_md_get_size(digest_info);
7692 if (digest_len > MBEDTLS_SSL_PEER_CERT_DIGEST_MAX_LEN) {
7693 return -1;
7694 }
Jerry Yud9526692022-02-17 14:23:47 +08007695
Gilles Peskine449bd832023-01-11 14:50:10 +01007696 ret = mbedtls_md(digest_info, crt_buf, crt_buf_len, tmp_digest);
7697 if (ret != 0) {
7698 return -1;
7699 }
Jerry Yud9526692022-02-17 14:23:47 +08007700
Gilles Peskine449bd832023-01-11 14:50:10 +01007701 return memcmp(tmp_digest, peer_cert_digest, digest_len);
Jerry Yud9526692022-02-17 14:23:47 +08007702}
7703#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7704#endif /* MBEDTLS_SSL_RENEGOTIATION && MBEDTLS_SSL_CLI_C */
7705
7706/*
7707 * Once the certificate message is read, parse it into a cert chain and
7708 * perform basic checks, but leave actual verification to the caller
7709 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007710MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007711static int ssl_parse_certificate_chain(mbedtls_ssl_context *ssl,
7712 mbedtls_x509_crt *chain)
Jerry Yud9526692022-02-17 14:23:47 +08007713{
7714 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7715#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007716 int crt_cnt = 0;
Jerry Yud9526692022-02-17 14:23:47 +08007717#endif
7718 size_t i, n;
7719 uint8_t alert;
7720
Gilles Peskine449bd832023-01-11 14:50:10 +01007721 if (ssl->in_msgtype != MBEDTLS_SSL_MSG_HANDSHAKE) {
7722 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7723 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7724 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
7725 return MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
Jerry Yud9526692022-02-17 14:23:47 +08007726 }
7727
Gilles Peskine449bd832023-01-11 14:50:10 +01007728 if (ssl->in_msg[0] != MBEDTLS_SSL_HS_CERTIFICATE) {
7729 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7730 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
7731 return MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
Jerry Yud9526692022-02-17 14:23:47 +08007732 }
7733
Gilles Peskine449bd832023-01-11 14:50:10 +01007734 if (ssl->in_hslen < mbedtls_ssl_hs_hdr_len(ssl) + 3 + 3) {
7735 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7736 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7737 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
7738 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007739 }
7740
Gilles Peskine449bd832023-01-11 14:50:10 +01007741 i = mbedtls_ssl_hs_hdr_len(ssl);
Jerry Yud9526692022-02-17 14:23:47 +08007742
7743 /*
7744 * Same message structure as in mbedtls_ssl_write_certificate()
7745 */
Dave Rodgmana3d0f612023-11-03 23:34:02 +00007746 n = MBEDTLS_GET_UINT16_BE(ssl->in_msg, i + 1);
Jerry Yud9526692022-02-17 14:23:47 +08007747
Gilles Peskine449bd832023-01-11 14:50:10 +01007748 if (ssl->in_msg[i] != 0 ||
7749 ssl->in_hslen != n + 3 + mbedtls_ssl_hs_hdr_len(ssl)) {
7750 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7751 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7752 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
7753 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007754 }
7755
7756 /* Make &ssl->in_msg[i] point to the beginning of the CRT chain. */
7757 i += 3;
7758
7759 /* Iterate through and parse the CRTs in the provided chain. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007760 while (i < ssl->in_hslen) {
Jerry Yud9526692022-02-17 14:23:47 +08007761 /* Check that there's room for the next CRT's length fields. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007762 if (i + 3 > ssl->in_hslen) {
7763 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7764 mbedtls_ssl_send_alert_message(ssl,
7765 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7766 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
7767 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007768 }
7769 /* In theory, the CRT can be up to 2**24 Bytes, but we don't support
7770 * anything beyond 2**16 ~ 64K. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007771 if (ssl->in_msg[i] != 0) {
7772 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7773 mbedtls_ssl_send_alert_message(ssl,
7774 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7775 MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT);
7776 return MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
Jerry Yud9526692022-02-17 14:23:47 +08007777 }
7778
7779 /* Read length of the next CRT in the chain. */
Dave Rodgmana3d0f612023-11-03 23:34:02 +00007780 n = MBEDTLS_GET_UINT16_BE(ssl->in_msg, i + 1);
Jerry Yud9526692022-02-17 14:23:47 +08007781 i += 3;
7782
Gilles Peskine449bd832023-01-11 14:50:10 +01007783 if (n < 128 || i + n > ssl->in_hslen) {
7784 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7785 mbedtls_ssl_send_alert_message(ssl,
7786 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7787 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
7788 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007789 }
7790
7791 /* Check if we're handling the first CRT in the chain. */
7792#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007793 if (crt_cnt++ == 0 &&
Jerry Yud9526692022-02-17 14:23:47 +08007794 ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
Gilles Peskine449bd832023-01-11 14:50:10 +01007795 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS) {
Jerry Yud9526692022-02-17 14:23:47 +08007796 /* During client-side renegotiation, check that the server's
7797 * end-CRTs hasn't changed compared to the initial handshake,
7798 * mitigating the triple handshake attack. On success, reuse
7799 * the original end-CRT instead of parsing it again. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007800 MBEDTLS_SSL_DEBUG_MSG(3, ("Check that peer CRT hasn't changed during renegotiation"));
7801 if (ssl_check_peer_crt_unchanged(ssl,
7802 &ssl->in_msg[i],
7803 n) != 0) {
7804 MBEDTLS_SSL_DEBUG_MSG(1, ("new server cert during renegotiation"));
7805 mbedtls_ssl_send_alert_message(ssl,
7806 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7807 MBEDTLS_SSL_ALERT_MSG_ACCESS_DENIED);
7808 return MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
Jerry Yud9526692022-02-17 14:23:47 +08007809 }
7810
7811 /* Now we can safely free the original chain. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007812 ssl_clear_peer_cert(ssl->session);
Jerry Yud9526692022-02-17 14:23:47 +08007813 }
7814#endif /* MBEDTLS_SSL_RENEGOTIATION && MBEDTLS_SSL_CLI_C */
7815
7816 /* Parse the next certificate in the chain. */
7817#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01007818 ret = mbedtls_x509_crt_parse_der(chain, ssl->in_msg + i, n);
Jerry Yud9526692022-02-17 14:23:47 +08007819#else
7820 /* If we don't need to store the CRT chain permanently, parse
7821 * it in-place from the input buffer instead of making a copy. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007822 ret = mbedtls_x509_crt_parse_der_nocopy(chain, ssl->in_msg + i, n);
Jerry Yud9526692022-02-17 14:23:47 +08007823#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Gilles Peskine449bd832023-01-11 14:50:10 +01007824 switch (ret) {
Jerry Yud9526692022-02-17 14:23:47 +08007825 case 0: /*ok*/
7826 case MBEDTLS_ERR_X509_UNKNOWN_SIG_ALG + MBEDTLS_ERR_OID_NOT_FOUND:
7827 /* Ignore certificate with an unknown algorithm: maybe a
7828 prior certificate was already trusted. */
7829 break;
7830
7831 case MBEDTLS_ERR_X509_ALLOC_FAILED:
7832 alert = MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR;
7833 goto crt_parse_der_failed;
7834
7835 case MBEDTLS_ERR_X509_UNKNOWN_VERSION:
7836 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
7837 goto crt_parse_der_failed;
7838
7839 default:
7840 alert = MBEDTLS_SSL_ALERT_MSG_BAD_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01007841crt_parse_der_failed:
7842 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL, alert);
7843 MBEDTLS_SSL_DEBUG_RET(1, " mbedtls_x509_crt_parse_der", ret);
7844 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007845 }
7846
7847 i += n;
7848 }
7849
Gilles Peskine449bd832023-01-11 14:50:10 +01007850 MBEDTLS_SSL_DEBUG_CRT(3, "peer certificate", chain);
7851 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007852}
7853
7854#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007855MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007856static int ssl_srv_check_client_no_crt_notification(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08007857{
Gilles Peskine449bd832023-01-11 14:50:10 +01007858 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
7859 return -1;
7860 }
Jerry Yud9526692022-02-17 14:23:47 +08007861
Gilles Peskine449bd832023-01-11 14:50:10 +01007862 if (ssl->in_hslen == 3 + mbedtls_ssl_hs_hdr_len(ssl) &&
Jerry Yud9526692022-02-17 14:23:47 +08007863 ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
7864 ssl->in_msg[0] == MBEDTLS_SSL_HS_CERTIFICATE &&
Gilles Peskine449bd832023-01-11 14:50:10 +01007865 memcmp(ssl->in_msg + mbedtls_ssl_hs_hdr_len(ssl), "\0\0\0", 3) == 0) {
7866 MBEDTLS_SSL_DEBUG_MSG(1, ("peer has no certificate"));
7867 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007868 }
Gilles Peskine449bd832023-01-11 14:50:10 +01007869 return -1;
Jerry Yud9526692022-02-17 14:23:47 +08007870}
7871#endif /* MBEDTLS_SSL_SRV_C */
7872
7873/* Check if a certificate message is expected.
7874 * Return either
7875 * - SSL_CERTIFICATE_EXPECTED, or
7876 * - SSL_CERTIFICATE_SKIP
7877 * indicating whether a Certificate message is expected or not.
7878 */
7879#define SSL_CERTIFICATE_EXPECTED 0
7880#define SSL_CERTIFICATE_SKIP 1
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007881MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007882static int ssl_parse_certificate_coordinate(mbedtls_ssl_context *ssl,
7883 int authmode)
Jerry Yud9526692022-02-17 14:23:47 +08007884{
7885 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
7886 ssl->handshake->ciphersuite_info;
7887
Gilles Peskine449bd832023-01-11 14:50:10 +01007888 if (!mbedtls_ssl_ciphersuite_uses_srv_cert(ciphersuite_info)) {
7889 return SSL_CERTIFICATE_SKIP;
7890 }
Jerry Yud9526692022-02-17 14:23:47 +08007891
7892#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007893 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
7894 if (ciphersuite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_RSA_PSK) {
7895 return SSL_CERTIFICATE_SKIP;
7896 }
Jerry Yud9526692022-02-17 14:23:47 +08007897
Gilles Peskine449bd832023-01-11 14:50:10 +01007898 if (authmode == MBEDTLS_SSL_VERIFY_NONE) {
Jerry Yud9526692022-02-17 14:23:47 +08007899 ssl->session_negotiate->verify_result =
7900 MBEDTLS_X509_BADCERT_SKIP_VERIFY;
Gilles Peskine449bd832023-01-11 14:50:10 +01007901 return SSL_CERTIFICATE_SKIP;
Jerry Yud9526692022-02-17 14:23:47 +08007902 }
7903 }
7904#else
7905 ((void) authmode);
7906#endif /* MBEDTLS_SSL_SRV_C */
7907
Gilles Peskine449bd832023-01-11 14:50:10 +01007908 return SSL_CERTIFICATE_EXPECTED;
Jerry Yud9526692022-02-17 14:23:47 +08007909}
7910
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007911MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007912static int ssl_parse_certificate_verify(mbedtls_ssl_context *ssl,
7913 int authmode,
7914 mbedtls_x509_crt *chain,
7915 void *rs_ctx)
Jerry Yud9526692022-02-17 14:23:47 +08007916{
7917 int ret = 0;
7918 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
7919 ssl->handshake->ciphersuite_info;
7920 int have_ca_chain = 0;
7921
7922 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *);
7923 void *p_vrfy;
7924
Gilles Peskine449bd832023-01-11 14:50:10 +01007925 if (authmode == MBEDTLS_SSL_VERIFY_NONE) {
7926 return 0;
7927 }
Jerry Yud9526692022-02-17 14:23:47 +08007928
Gilles Peskine449bd832023-01-11 14:50:10 +01007929 if (ssl->f_vrfy != NULL) {
7930 MBEDTLS_SSL_DEBUG_MSG(3, ("Use context-specific verification callback"));
Jerry Yud9526692022-02-17 14:23:47 +08007931 f_vrfy = ssl->f_vrfy;
7932 p_vrfy = ssl->p_vrfy;
Gilles Peskine449bd832023-01-11 14:50:10 +01007933 } else {
7934 MBEDTLS_SSL_DEBUG_MSG(3, ("Use configuration-specific verification callback"));
Jerry Yud9526692022-02-17 14:23:47 +08007935 f_vrfy = ssl->conf->f_vrfy;
7936 p_vrfy = ssl->conf->p_vrfy;
7937 }
7938
7939 /*
7940 * Main check: verify certificate
7941 */
7942#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
Gilles Peskine449bd832023-01-11 14:50:10 +01007943 if (ssl->conf->f_ca_cb != NULL) {
Jerry Yud9526692022-02-17 14:23:47 +08007944 ((void) rs_ctx);
7945 have_ca_chain = 1;
7946
Gilles Peskine449bd832023-01-11 14:50:10 +01007947 MBEDTLS_SSL_DEBUG_MSG(3, ("use CA callback for X.509 CRT verification"));
Jerry Yud9526692022-02-17 14:23:47 +08007948 ret = mbedtls_x509_crt_verify_with_ca_cb(
7949 chain,
7950 ssl->conf->f_ca_cb,
7951 ssl->conf->p_ca_cb,
7952 ssl->conf->cert_profile,
7953 ssl->hostname,
7954 &ssl->session_negotiate->verify_result,
Gilles Peskine449bd832023-01-11 14:50:10 +01007955 f_vrfy, p_vrfy);
7956 } else
Jerry Yud9526692022-02-17 14:23:47 +08007957#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
7958 {
7959 mbedtls_x509_crt *ca_chain;
7960 mbedtls_x509_crl *ca_crl;
7961
7962#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01007963 if (ssl->handshake->sni_ca_chain != NULL) {
Jerry Yud9526692022-02-17 14:23:47 +08007964 ca_chain = ssl->handshake->sni_ca_chain;
7965 ca_crl = ssl->handshake->sni_ca_crl;
Gilles Peskine449bd832023-01-11 14:50:10 +01007966 } else
Jerry Yud9526692022-02-17 14:23:47 +08007967#endif
7968 {
7969 ca_chain = ssl->conf->ca_chain;
7970 ca_crl = ssl->conf->ca_crl;
7971 }
7972
Gilles Peskine449bd832023-01-11 14:50:10 +01007973 if (ca_chain != NULL) {
Jerry Yud9526692022-02-17 14:23:47 +08007974 have_ca_chain = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01007975 }
Jerry Yud9526692022-02-17 14:23:47 +08007976
7977 ret = mbedtls_x509_crt_verify_restartable(
7978 chain,
7979 ca_chain, ca_crl,
7980 ssl->conf->cert_profile,
7981 ssl->hostname,
7982 &ssl->session_negotiate->verify_result,
Gilles Peskine449bd832023-01-11 14:50:10 +01007983 f_vrfy, p_vrfy, rs_ctx);
Jerry Yud9526692022-02-17 14:23:47 +08007984 }
7985
Gilles Peskine449bd832023-01-11 14:50:10 +01007986 if (ret != 0) {
7987 MBEDTLS_SSL_DEBUG_RET(1, "x509_verify_cert", ret);
Jerry Yud9526692022-02-17 14:23:47 +08007988 }
7989
7990#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007991 if (ret == MBEDTLS_ERR_ECP_IN_PROGRESS) {
7992 return MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS;
7993 }
Jerry Yud9526692022-02-17 14:23:47 +08007994#endif
7995
7996 /*
7997 * Secondary checks: always done, but change 'ret' only if it was 0
7998 */
7999
Valerio Settiacd32c02023-06-29 18:06:29 +02008000#if defined(MBEDTLS_PK_HAVE_ECC_KEYS)
Jerry Yud9526692022-02-17 14:23:47 +08008001 {
8002 const mbedtls_pk_context *pk = &chain->pk;
8003
Manuel Pégourié-Gonnard66b0d612022-06-17 10:49:29 +02008004 /* If certificate uses an EC key, make sure the curve is OK.
8005 * This is a public key, so it can't be opaque, so can_do() is a good
8006 * enough check to ensure pk_ec() is safe to use here. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008007 if (mbedtls_pk_can_do(pk, MBEDTLS_PK_ECKEY)) {
Leonid Rozenboim19e59732022-08-08 16:52:38 -07008008 /* and in the unlikely case the above assumption no longer holds
8009 * we are making sure that pk_ec() here does not return a NULL
8010 */
Valerio Settif9362b72023-11-29 08:42:27 +01008011 mbedtls_ecp_group_id grp_id = mbedtls_pk_get_ec_group_id(pk);
Valerio Settid0405092023-05-24 13:16:40 +02008012 if (grp_id == MBEDTLS_ECP_DP_NONE) {
8013 MBEDTLS_SSL_DEBUG_MSG(1, ("invalid group ID"));
Gilles Peskine449bd832023-01-11 14:50:10 +01008014 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Leonid Rozenboim19e59732022-08-08 16:52:38 -07008015 }
Valerio Setti97207782023-05-18 18:59:06 +02008016 if (mbedtls_ssl_check_curve(ssl, grp_id) != 0) {
Leonid Rozenboim19e59732022-08-08 16:52:38 -07008017 ssl->session_negotiate->verify_result |=
8018 MBEDTLS_X509_BADCERT_BAD_KEY;
8019
Gilles Peskine449bd832023-01-11 14:50:10 +01008020 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate (EC key curve)"));
8021 if (ret == 0) {
Leonid Rozenboim19e59732022-08-08 16:52:38 -07008022 ret = MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
Gilles Peskine449bd832023-01-11 14:50:10 +01008023 }
Leonid Rozenboim19e59732022-08-08 16:52:38 -07008024 }
Jerry Yud9526692022-02-17 14:23:47 +08008025 }
8026 }
Valerio Settiacd32c02023-06-29 18:06:29 +02008027#endif /* MBEDTLS_PK_HAVE_ECC_KEYS */
Jerry Yud9526692022-02-17 14:23:47 +08008028
Gilles Peskine449bd832023-01-11 14:50:10 +01008029 if (mbedtls_ssl_check_cert_usage(chain,
8030 ciphersuite_info,
8031 !ssl->conf->endpoint,
8032 &ssl->session_negotiate->verify_result) != 0) {
8033 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate (usage extensions)"));
8034 if (ret == 0) {
Jerry Yud9526692022-02-17 14:23:47 +08008035 ret = MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
Gilles Peskine449bd832023-01-11 14:50:10 +01008036 }
Jerry Yud9526692022-02-17 14:23:47 +08008037 }
8038
8039 /* mbedtls_x509_crt_verify_with_profile is supposed to report a
8040 * verification failure through MBEDTLS_ERR_X509_CERT_VERIFY_FAILED,
8041 * with details encoded in the verification flags. All other kinds
8042 * of error codes, including those from the user provided f_vrfy
8043 * functions, are treated as fatal and lead to a failure of
8044 * ssl_parse_certificate even if verification was optional. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008045 if (authmode == MBEDTLS_SSL_VERIFY_OPTIONAL &&
8046 (ret == MBEDTLS_ERR_X509_CERT_VERIFY_FAILED ||
8047 ret == MBEDTLS_ERR_SSL_BAD_CERTIFICATE)) {
Jerry Yud9526692022-02-17 14:23:47 +08008048 ret = 0;
8049 }
8050
Gilles Peskine449bd832023-01-11 14:50:10 +01008051 if (have_ca_chain == 0 && authmode == MBEDTLS_SSL_VERIFY_REQUIRED) {
8052 MBEDTLS_SSL_DEBUG_MSG(1, ("got no CA chain"));
Jerry Yud9526692022-02-17 14:23:47 +08008053 ret = MBEDTLS_ERR_SSL_CA_CHAIN_REQUIRED;
8054 }
8055
Gilles Peskine449bd832023-01-11 14:50:10 +01008056 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08008057 uint8_t alert;
8058
8059 /* The certificate may have been rejected for several reasons.
8060 Pick one and send the corresponding alert. Which alert to send
8061 may be a subject of debate in some cases. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008062 if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_OTHER) {
Jerry Yud9526692022-02-17 14:23:47 +08008063 alert = MBEDTLS_SSL_ALERT_MSG_ACCESS_DENIED;
Gilles Peskine449bd832023-01-11 14:50:10 +01008064 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_CN_MISMATCH) {
Jerry Yud9526692022-02-17 14:23:47 +08008065 alert = MBEDTLS_SSL_ALERT_MSG_BAD_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01008066 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_KEY_USAGE) {
Jerry Yud9526692022-02-17 14:23:47 +08008067 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01008068 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_EXT_KEY_USAGE) {
Jerry Yud9526692022-02-17 14:23:47 +08008069 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01008070 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_NS_CERT_TYPE) {
Jerry Yud9526692022-02-17 14:23:47 +08008071 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01008072 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_BAD_PK) {
Jerry Yud9526692022-02-17 14:23:47 +08008073 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01008074 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_BAD_KEY) {
Jerry Yud9526692022-02-17 14:23:47 +08008075 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01008076 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_EXPIRED) {
Jerry Yud9526692022-02-17 14:23:47 +08008077 alert = MBEDTLS_SSL_ALERT_MSG_CERT_EXPIRED;
Gilles Peskine449bd832023-01-11 14:50:10 +01008078 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_REVOKED) {
Jerry Yud9526692022-02-17 14:23:47 +08008079 alert = MBEDTLS_SSL_ALERT_MSG_CERT_REVOKED;
Gilles Peskine449bd832023-01-11 14:50:10 +01008080 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_NOT_TRUSTED) {
Jerry Yud9526692022-02-17 14:23:47 +08008081 alert = MBEDTLS_SSL_ALERT_MSG_UNKNOWN_CA;
Gilles Peskine449bd832023-01-11 14:50:10 +01008082 } else {
Jerry Yud9526692022-02-17 14:23:47 +08008083 alert = MBEDTLS_SSL_ALERT_MSG_CERT_UNKNOWN;
Gilles Peskine449bd832023-01-11 14:50:10 +01008084 }
8085 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8086 alert);
Jerry Yud9526692022-02-17 14:23:47 +08008087 }
8088
8089#if defined(MBEDTLS_DEBUG_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008090 if (ssl->session_negotiate->verify_result != 0) {
8091 MBEDTLS_SSL_DEBUG_MSG(3, ("! Certificate verification flags %08x",
8092 (unsigned int) ssl->session_negotiate->verify_result));
8093 } else {
8094 MBEDTLS_SSL_DEBUG_MSG(3, ("Certificate verification flags clear"));
Jerry Yud9526692022-02-17 14:23:47 +08008095 }
8096#endif /* MBEDTLS_DEBUG_C */
8097
Gilles Peskine449bd832023-01-11 14:50:10 +01008098 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08008099}
8100
8101#if !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02008102MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01008103static int ssl_remember_peer_crt_digest(mbedtls_ssl_context *ssl,
8104 unsigned char *start, size_t len)
Jerry Yud9526692022-02-17 14:23:47 +08008105{
8106 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
8107 /* Remember digest of the peer's end-CRT. */
8108 ssl->session_negotiate->peer_cert_digest =
Gilles Peskine449bd832023-01-11 14:50:10 +01008109 mbedtls_calloc(1, MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN);
8110 if (ssl->session_negotiate->peer_cert_digest == NULL) {
8111 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc(%d bytes) failed",
8112 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN));
8113 mbedtls_ssl_send_alert_message(ssl,
8114 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8115 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR);
Jerry Yud9526692022-02-17 14:23:47 +08008116
Gilles Peskine449bd832023-01-11 14:50:10 +01008117 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
Jerry Yud9526692022-02-17 14:23:47 +08008118 }
8119
Gilles Peskine449bd832023-01-11 14:50:10 +01008120 ret = mbedtls_md(mbedtls_md_info_from_type(
8121 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE),
8122 start, len,
8123 ssl->session_negotiate->peer_cert_digest);
Jerry Yud9526692022-02-17 14:23:47 +08008124
8125 ssl->session_negotiate->peer_cert_digest_type =
8126 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE;
8127 ssl->session_negotiate->peer_cert_digest_len =
8128 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN;
8129
Gilles Peskine449bd832023-01-11 14:50:10 +01008130 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08008131}
8132
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02008133MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01008134static int ssl_remember_peer_pubkey(mbedtls_ssl_context *ssl,
8135 unsigned char *start, size_t len)
Jerry Yud9526692022-02-17 14:23:47 +08008136{
8137 unsigned char *end = start + len;
8138 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
8139
8140 /* Make a copy of the peer's raw public key. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008141 mbedtls_pk_init(&ssl->handshake->peer_pubkey);
8142 ret = mbedtls_pk_parse_subpubkey(&start, end,
8143 &ssl->handshake->peer_pubkey);
8144 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08008145 /* We should have parsed the public key before. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008146 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08008147 }
8148
Gilles Peskine449bd832023-01-11 14:50:10 +01008149 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08008150}
8151#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
8152
Gilles Peskine449bd832023-01-11 14:50:10 +01008153int mbedtls_ssl_parse_certificate(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08008154{
8155 int ret = 0;
8156 int crt_expected;
8157#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
8158 const int authmode = ssl->handshake->sni_authmode != MBEDTLS_SSL_VERIFY_UNSET
8159 ? ssl->handshake->sni_authmode
8160 : ssl->conf->authmode;
8161#else
8162 const int authmode = ssl->conf->authmode;
8163#endif
8164 void *rs_ctx = NULL;
8165 mbedtls_x509_crt *chain = NULL;
8166
Gilles Peskine449bd832023-01-11 14:50:10 +01008167 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08008168
Gilles Peskine449bd832023-01-11 14:50:10 +01008169 crt_expected = ssl_parse_certificate_coordinate(ssl, authmode);
8170 if (crt_expected == SSL_CERTIFICATE_SKIP) {
8171 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08008172 goto exit;
8173 }
8174
8175#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01008176 if (ssl->handshake->ecrs_enabled &&
8177 ssl->handshake->ecrs_state == ssl_ecrs_crt_verify) {
Jerry Yud9526692022-02-17 14:23:47 +08008178 chain = ssl->handshake->ecrs_peer_cert;
8179 ssl->handshake->ecrs_peer_cert = NULL;
8180 goto crt_verify;
8181 }
8182#endif
8183
Gilles Peskine449bd832023-01-11 14:50:10 +01008184 if ((ret = mbedtls_ssl_read_record(ssl, 1)) != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08008185 /* mbedtls_ssl_read_record may have sent an alert already. We
8186 let it decide whether to alert. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008187 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_read_record", ret);
Jerry Yud9526692022-02-17 14:23:47 +08008188 goto exit;
8189 }
8190
8191#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008192 if (ssl_srv_check_client_no_crt_notification(ssl) == 0) {
Jerry Yud9526692022-02-17 14:23:47 +08008193 ssl->session_negotiate->verify_result = MBEDTLS_X509_BADCERT_MISSING;
8194
Gilles Peskine449bd832023-01-11 14:50:10 +01008195 if (authmode != MBEDTLS_SSL_VERIFY_OPTIONAL) {
Jerry Yud9526692022-02-17 14:23:47 +08008196 ret = MBEDTLS_ERR_SSL_NO_CLIENT_CERTIFICATE;
Gilles Peskine449bd832023-01-11 14:50:10 +01008197 }
Jerry Yud9526692022-02-17 14:23:47 +08008198
8199 goto exit;
8200 }
8201#endif /* MBEDTLS_SSL_SRV_C */
8202
8203 /* Clear existing peer CRT structure in case we tried to
8204 * reuse a session but it failed, and allocate a new one. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008205 ssl_clear_peer_cert(ssl->session_negotiate);
Jerry Yud9526692022-02-17 14:23:47 +08008206
Gilles Peskine449bd832023-01-11 14:50:10 +01008207 chain = mbedtls_calloc(1, sizeof(mbedtls_x509_crt));
8208 if (chain == NULL) {
8209 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc(%" MBEDTLS_PRINTF_SIZET " bytes) failed",
8210 sizeof(mbedtls_x509_crt)));
8211 mbedtls_ssl_send_alert_message(ssl,
8212 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8213 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR);
Jerry Yud9526692022-02-17 14:23:47 +08008214
8215 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
8216 goto exit;
8217 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008218 mbedtls_x509_crt_init(chain);
Jerry Yud9526692022-02-17 14:23:47 +08008219
Gilles Peskine449bd832023-01-11 14:50:10 +01008220 ret = ssl_parse_certificate_chain(ssl, chain);
8221 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08008222 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01008223 }
Jerry Yud9526692022-02-17 14:23:47 +08008224
8225#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01008226 if (ssl->handshake->ecrs_enabled) {
Jerry Yud9526692022-02-17 14:23:47 +08008227 ssl->handshake->ecrs_state = ssl_ecrs_crt_verify;
Gilles Peskine449bd832023-01-11 14:50:10 +01008228 }
Jerry Yud9526692022-02-17 14:23:47 +08008229
8230crt_verify:
Gilles Peskine449bd832023-01-11 14:50:10 +01008231 if (ssl->handshake->ecrs_enabled) {
Jerry Yud9526692022-02-17 14:23:47 +08008232 rs_ctx = &ssl->handshake->ecrs_ctx;
Gilles Peskine449bd832023-01-11 14:50:10 +01008233 }
Jerry Yud9526692022-02-17 14:23:47 +08008234#endif
8235
Gilles Peskine449bd832023-01-11 14:50:10 +01008236 ret = ssl_parse_certificate_verify(ssl, authmode,
8237 chain, rs_ctx);
8238 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08008239 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01008240 }
Jerry Yud9526692022-02-17 14:23:47 +08008241
8242#if !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
8243 {
8244 unsigned char *crt_start, *pk_start;
8245 size_t crt_len, pk_len;
8246
8247 /* We parse the CRT chain without copying, so
8248 * these pointers point into the input buffer,
8249 * and are hence still valid after freeing the
8250 * CRT chain. */
8251
8252 crt_start = chain->raw.p;
8253 crt_len = chain->raw.len;
8254
8255 pk_start = chain->pk_raw.p;
8256 pk_len = chain->pk_raw.len;
8257
8258 /* Free the CRT structures before computing
8259 * digest and copying the peer's public key. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008260 mbedtls_x509_crt_free(chain);
8261 mbedtls_free(chain);
Jerry Yud9526692022-02-17 14:23:47 +08008262 chain = NULL;
8263
Gilles Peskine449bd832023-01-11 14:50:10 +01008264 ret = ssl_remember_peer_crt_digest(ssl, crt_start, crt_len);
8265 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08008266 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01008267 }
Jerry Yud9526692022-02-17 14:23:47 +08008268
Gilles Peskine449bd832023-01-11 14:50:10 +01008269 ret = ssl_remember_peer_pubkey(ssl, pk_start, pk_len);
8270 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08008271 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01008272 }
Jerry Yud9526692022-02-17 14:23:47 +08008273 }
8274#else /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
8275 /* Pass ownership to session structure. */
8276 ssl->session_negotiate->peer_cert = chain;
8277 chain = NULL;
8278#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
8279
Gilles Peskine449bd832023-01-11 14:50:10 +01008280 MBEDTLS_SSL_DEBUG_MSG(2, ("<= parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08008281
8282exit:
8283
Gilles Peskine449bd832023-01-11 14:50:10 +01008284 if (ret == 0) {
Jerry Yud9526692022-02-17 14:23:47 +08008285 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01008286 }
Jerry Yud9526692022-02-17 14:23:47 +08008287
8288#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01008289 if (ret == MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS) {
Jerry Yud9526692022-02-17 14:23:47 +08008290 ssl->handshake->ecrs_peer_cert = chain;
8291 chain = NULL;
8292 }
8293#endif
8294
Gilles Peskine449bd832023-01-11 14:50:10 +01008295 if (chain != NULL) {
8296 mbedtls_x509_crt_free(chain);
8297 mbedtls_free(chain);
Jerry Yud9526692022-02-17 14:23:47 +08008298 }
8299
Gilles Peskine449bd832023-01-11 14:50:10 +01008300 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08008301}
8302#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
8303
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008304static int ssl_calc_finished_tls_generic(mbedtls_ssl_context *ssl, void *ctx,
8305 unsigned char *padbuf, size_t hlen,
8306 unsigned char *buf, int from)
Jerry Yu615bd6f2022-02-17 14:25:15 +08008307{
Dave Rodgmanc37ad442023-11-03 23:36:06 +00008308 unsigned int len = 12;
Jerry Yu615bd6f2022-02-17 14:25:15 +08008309 const char *sender;
Jerry Yu615bd6f2022-02-17 14:25:15 +08008310#if defined(MBEDTLS_USE_PSA_CRYPTO)
Jerry Yu615bd6f2022-02-17 14:25:15 +08008311 psa_status_t status;
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008312 psa_hash_operation_t *hs_op = ctx;
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02008313 psa_hash_operation_t cloned_op = PSA_HASH_OPERATION_INIT;
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008314 size_t hash_size;
Jerry Yu615bd6f2022-02-17 14:25:15 +08008315#else
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01008316 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008317 mbedtls_md_context_t *hs_ctx = ctx;
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02008318 mbedtls_md_context_t cloned_ctx;
8319 mbedtls_md_init(&cloned_ctx);
Jerry Yu615bd6f2022-02-17 14:25:15 +08008320#endif
8321
8322 mbedtls_ssl_session *session = ssl->session_negotiate;
Gilles Peskine449bd832023-01-11 14:50:10 +01008323 if (!session) {
Jerry Yu615bd6f2022-02-17 14:25:15 +08008324 session = ssl->session;
Gilles Peskine449bd832023-01-11 14:50:10 +01008325 }
Jerry Yu615bd6f2022-02-17 14:25:15 +08008326
Gilles Peskine449bd832023-01-11 14:50:10 +01008327 sender = (from == MBEDTLS_SSL_IS_CLIENT)
Jerry Yu615bd6f2022-02-17 14:25:15 +08008328 ? "client finished"
8329 : "server finished";
8330
8331#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008332 MBEDTLS_SSL_DEBUG_MSG(2, ("=> calc PSA finished tls"));
Jerry Yu615bd6f2022-02-17 14:25:15 +08008333
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02008334 status = psa_hash_clone(hs_op, &cloned_op);
Gilles Peskine449bd832023-01-11 14:50:10 +01008335 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01008336 goto exit;
Jerry Yu615bd6f2022-02-17 14:25:15 +08008337 }
8338
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02008339 status = psa_hash_finish(&cloned_op, padbuf, hlen, &hash_size);
Gilles Peskine449bd832023-01-11 14:50:10 +01008340 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01008341 goto exit;
Jerry Yu615bd6f2022-02-17 14:25:15 +08008342 }
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008343 MBEDTLS_SSL_DEBUG_BUF(3, "PSA calculated padbuf", padbuf, hlen);
Jerry Yu615bd6f2022-02-17 14:25:15 +08008344#else
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008345 MBEDTLS_SSL_DEBUG_MSG(2, ("=> calc finished tls"));
Jerry Yu615bd6f2022-02-17 14:25:15 +08008346
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02008347 ret = mbedtls_md_setup(&cloned_ctx, mbedtls_md_info_from_ctx(hs_ctx), 0);
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01008348 if (ret != 0) {
8349 goto exit;
8350 }
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02008351 ret = mbedtls_md_clone(&cloned_ctx, hs_ctx);
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01008352 if (ret != 0) {
8353 goto exit;
8354 }
Jerry Yu615bd6f2022-02-17 14:25:15 +08008355
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02008356 ret = mbedtls_md_finish(&cloned_ctx, padbuf);
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008357 if (ret != 0) {
8358 goto exit;
8359 }
8360#endif /* MBEDTLS_USE_PSA_CRYPTO */
8361
8362 MBEDTLS_SSL_DEBUG_BUF(4, "finished output", padbuf, hlen);
8363
Jerry Yu615bd6f2022-02-17 14:25:15 +08008364 /*
8365 * TLSv1.2:
8366 * hash = PRF( master, finished_label,
8367 * Hash( handshake ) )[0.11]
8368 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008369 ssl->handshake->tls_prf(session->master, 48, sender,
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008370 padbuf, hlen, buf, len);
Jerry Yu615bd6f2022-02-17 14:25:15 +08008371
Gilles Peskine449bd832023-01-11 14:50:10 +01008372 MBEDTLS_SSL_DEBUG_BUF(3, "calc finished result", buf, len);
Jerry Yu615bd6f2022-02-17 14:25:15 +08008373
Paul Elliottecb95be2023-08-11 16:41:04 +01008374 mbedtls_platform_zeroize(padbuf, hlen);
Jerry Yu615bd6f2022-02-17 14:25:15 +08008375
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008376 MBEDTLS_SSL_DEBUG_MSG(2, ("<= calc finished"));
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01008377
8378exit:
8379#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02008380 psa_hash_abort(&cloned_op);
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +02008381 return mbedtls_md_error_from_psa(status);
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01008382#else
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02008383 mbedtls_md_free(&cloned_ctx);
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01008384 return ret;
8385#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu615bd6f2022-02-17 14:25:15 +08008386}
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008387
8388#if defined(MBEDTLS_MD_CAN_SHA256)
8389static int ssl_calc_finished_tls_sha256(
8390 mbedtls_ssl_context *ssl, unsigned char *buf, int from)
8391{
8392 unsigned char padbuf[32];
8393 return ssl_calc_finished_tls_generic(ssl,
8394#if defined(MBEDTLS_USE_PSA_CRYPTO)
8395 &ssl->handshake->fin_sha256_psa,
8396#else
8397 &ssl->handshake->fin_sha256,
8398#endif
8399 padbuf, sizeof(padbuf),
8400 buf, from);
8401}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01008402#endif /* MBEDTLS_MD_CAN_SHA256*/
Jerry Yu615bd6f2022-02-17 14:25:15 +08008403
Jerry Yub7ba49e2022-02-17 14:25:53 +08008404
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01008405#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +01008406static int ssl_calc_finished_tls_sha384(
Gilles Peskine449bd832023-01-11 14:50:10 +01008407 mbedtls_ssl_context *ssl, unsigned char *buf, int from)
Jerry Yub7ba49e2022-02-17 14:25:53 +08008408{
Jerry Yub7ba49e2022-02-17 14:25:53 +08008409 unsigned char padbuf[48];
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008410 return ssl_calc_finished_tls_generic(ssl,
Jerry Yub7ba49e2022-02-17 14:25:53 +08008411#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008412 &ssl->handshake->fin_sha384_psa,
Jerry Yub7ba49e2022-02-17 14:25:53 +08008413#else
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008414 &ssl->handshake->fin_sha384,
Jerry Yub7ba49e2022-02-17 14:25:53 +08008415#endif
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008416 padbuf, sizeof(padbuf),
8417 buf, from);
Jerry Yub7ba49e2022-02-17 14:25:53 +08008418}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01008419#endif /* MBEDTLS_MD_CAN_SHA384*/
Jerry Yub7ba49e2022-02-17 14:25:53 +08008420
Gilles Peskine449bd832023-01-11 14:50:10 +01008421void mbedtls_ssl_handshake_wrapup_free_hs_transform(mbedtls_ssl_context *ssl)
Jerry Yuaef00152022-02-17 14:27:31 +08008422{
Gilles Peskine449bd832023-01-11 14:50:10 +01008423 MBEDTLS_SSL_DEBUG_MSG(3, ("=> handshake wrapup: final free"));
Jerry Yuaef00152022-02-17 14:27:31 +08008424
8425 /*
8426 * Free our handshake params
8427 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008428 mbedtls_ssl_handshake_free(ssl);
8429 mbedtls_free(ssl->handshake);
Jerry Yuaef00152022-02-17 14:27:31 +08008430 ssl->handshake = NULL;
8431
8432 /*
Shaun Case8b0ecbc2021-12-20 21:14:10 -08008433 * Free the previous transform and switch in the current one
Jerry Yuaef00152022-02-17 14:27:31 +08008434 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008435 if (ssl->transform) {
8436 mbedtls_ssl_transform_free(ssl->transform);
8437 mbedtls_free(ssl->transform);
Jerry Yuaef00152022-02-17 14:27:31 +08008438 }
8439 ssl->transform = ssl->transform_negotiate;
8440 ssl->transform_negotiate = NULL;
8441
Gilles Peskine449bd832023-01-11 14:50:10 +01008442 MBEDTLS_SSL_DEBUG_MSG(3, ("<= handshake wrapup: final free"));
Jerry Yuaef00152022-02-17 14:27:31 +08008443}
8444
Gilles Peskine449bd832023-01-11 14:50:10 +01008445void mbedtls_ssl_handshake_wrapup(mbedtls_ssl_context *ssl)
Jerry Yu2a9fff52022-02-17 14:28:51 +08008446{
8447 int resume = ssl->handshake->resume;
8448
Gilles Peskine449bd832023-01-11 14:50:10 +01008449 MBEDTLS_SSL_DEBUG_MSG(3, ("=> handshake wrapup"));
Jerry Yu2a9fff52022-02-17 14:28:51 +08008450
8451#if defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01008452 if (ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS) {
Jerry Yu2a9fff52022-02-17 14:28:51 +08008453 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_DONE;
8454 ssl->renego_records_seen = 0;
8455 }
8456#endif
8457
8458 /*
8459 * Free the previous session and switch in the current one
8460 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008461 if (ssl->session) {
Jerry Yu2a9fff52022-02-17 14:28:51 +08008462#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
8463 /* RFC 7366 3.1: keep the EtM state */
8464 ssl->session_negotiate->encrypt_then_mac =
Gilles Peskine449bd832023-01-11 14:50:10 +01008465 ssl->session->encrypt_then_mac;
Jerry Yu2a9fff52022-02-17 14:28:51 +08008466#endif
8467
Gilles Peskine449bd832023-01-11 14:50:10 +01008468 mbedtls_ssl_session_free(ssl->session);
8469 mbedtls_free(ssl->session);
Jerry Yu2a9fff52022-02-17 14:28:51 +08008470 }
8471 ssl->session = ssl->session_negotiate;
8472 ssl->session_negotiate = NULL;
8473
8474 /*
8475 * Add cache entry
8476 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008477 if (ssl->conf->f_set_cache != NULL &&
Jerry Yu2a9fff52022-02-17 14:28:51 +08008478 ssl->session->id_len != 0 &&
Gilles Peskine449bd832023-01-11 14:50:10 +01008479 resume == 0) {
8480 if (ssl->conf->f_set_cache(ssl->conf->p_cache,
8481 ssl->session->id,
8482 ssl->session->id_len,
8483 ssl->session) != 0) {
8484 MBEDTLS_SSL_DEBUG_MSG(1, ("cache did not store session"));
8485 }
Jerry Yu2a9fff52022-02-17 14:28:51 +08008486 }
8487
8488#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01008489 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
8490 ssl->handshake->flight != NULL) {
Jerry Yu2a9fff52022-02-17 14:28:51 +08008491 /* Cancel handshake timer */
Gilles Peskine449bd832023-01-11 14:50:10 +01008492 mbedtls_ssl_set_timer(ssl, 0);
Jerry Yu2a9fff52022-02-17 14:28:51 +08008493
8494 /* Keep last flight around in case we need to resend it:
8495 * we need the handshake and transform structures for that */
Gilles Peskine449bd832023-01-11 14:50:10 +01008496 MBEDTLS_SSL_DEBUG_MSG(3, ("skip freeing handshake and transform"));
8497 } else
Jerry Yu2a9fff52022-02-17 14:28:51 +08008498#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01008499 mbedtls_ssl_handshake_wrapup_free_hs_transform(ssl);
Jerry Yu2a9fff52022-02-17 14:28:51 +08008500
Jerry Yu5ed73ff2022-10-27 13:08:42 +08008501 ssl->state = MBEDTLS_SSL_HANDSHAKE_OVER;
Jerry Yu2a9fff52022-02-17 14:28:51 +08008502
Gilles Peskine449bd832023-01-11 14:50:10 +01008503 MBEDTLS_SSL_DEBUG_MSG(3, ("<= handshake wrapup"));
Jerry Yu2a9fff52022-02-17 14:28:51 +08008504}
8505
Gilles Peskine449bd832023-01-11 14:50:10 +01008506int mbedtls_ssl_write_finished(mbedtls_ssl_context *ssl)
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008507{
Dave Rodgmanc37ad442023-11-03 23:36:06 +00008508 int ret;
8509 unsigned int hash_len;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008510
Gilles Peskine449bd832023-01-11 14:50:10 +01008511 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write finished"));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008512
Gilles Peskine449bd832023-01-11 14:50:10 +01008513 mbedtls_ssl_update_out_pointers(ssl, ssl->transform_negotiate);
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008514
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01008515 ret = ssl->handshake->calc_finished(ssl, ssl->out_msg + 4, ssl->conf->endpoint);
8516 if (ret != 0) {
8517 MBEDTLS_SSL_DEBUG_RET(1, "calc_finished", ret);
8518 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008519
8520 /*
8521 * RFC 5246 7.4.9 (Page 63) says 12 is the default length and ciphersuites
8522 * may define some other value. Currently (early 2016), no defined
8523 * ciphersuite does this (and this is unlikely to change as activity has
8524 * moved to TLS 1.3 now) so we can keep the hardcoded 12 here.
8525 */
8526 hash_len = 12;
8527
8528#if defined(MBEDTLS_SSL_RENEGOTIATION)
8529 ssl->verify_data_len = hash_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01008530 memcpy(ssl->own_verify_data, ssl->out_msg + 4, hash_len);
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008531#endif
8532
8533 ssl->out_msglen = 4 + hash_len;
8534 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
8535 ssl->out_msg[0] = MBEDTLS_SSL_HS_FINISHED;
8536
8537 /*
8538 * In case of session resuming, invert the client and server
8539 * ChangeCipherSpec messages order.
8540 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008541 if (ssl->handshake->resume != 0) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008542#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008543 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008544 ssl->state = MBEDTLS_SSL_HANDSHAKE_WRAPUP;
Gilles Peskine449bd832023-01-11 14:50:10 +01008545 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008546#endif
8547#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008548 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008549 ssl->state = MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC;
Gilles Peskine449bd832023-01-11 14:50:10 +01008550 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008551#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01008552 } else {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008553 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01008554 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008555
8556 /*
8557 * Switch to our negotiated transform and session parameters for outbound
8558 * data.
8559 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008560 MBEDTLS_SSL_DEBUG_MSG(3, ("switching to new transform spec for outbound data"));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008561
8562#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01008563 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008564 unsigned char i;
8565
8566 /* Remember current epoch settings for resending */
8567 ssl->handshake->alt_transform_out = ssl->transform_out;
Gilles Peskine449bd832023-01-11 14:50:10 +01008568 memcpy(ssl->handshake->alt_out_ctr, ssl->cur_out_ctr,
8569 sizeof(ssl->handshake->alt_out_ctr));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008570
8571 /* Set sequence_number to zero */
Gilles Peskine449bd832023-01-11 14:50:10 +01008572 memset(&ssl->cur_out_ctr[2], 0, sizeof(ssl->cur_out_ctr) - 2);
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008573
8574
8575 /* Increment epoch */
Gilles Peskine449bd832023-01-11 14:50:10 +01008576 for (i = 2; i > 0; i--) {
8577 if (++ssl->cur_out_ctr[i - 1] != 0) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008578 break;
Gilles Peskine449bd832023-01-11 14:50:10 +01008579 }
8580 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008581
8582 /* The loop goes to its end iff the counter is wrapping */
Gilles Peskine449bd832023-01-11 14:50:10 +01008583 if (i == 0) {
8584 MBEDTLS_SSL_DEBUG_MSG(1, ("DTLS epoch would wrap"));
8585 return MBEDTLS_ERR_SSL_COUNTER_WRAPPING;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008586 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008587 } else
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008588#endif /* MBEDTLS_SSL_PROTO_DTLS */
Gilles Peskine449bd832023-01-11 14:50:10 +01008589 memset(ssl->cur_out_ctr, 0, sizeof(ssl->cur_out_ctr));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008590
8591 ssl->transform_out = ssl->transform_negotiate;
8592 ssl->session_out = ssl->session_negotiate;
8593
8594#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01008595 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
8596 mbedtls_ssl_send_flight_completed(ssl);
8597 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008598#endif
8599
Gilles Peskine449bd832023-01-11 14:50:10 +01008600 if ((ret = mbedtls_ssl_write_handshake_msg(ssl)) != 0) {
8601 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_handshake_msg", ret);
8602 return ret;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008603 }
8604
8605#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01008606 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
8607 (ret = mbedtls_ssl_flight_transmit(ssl)) != 0) {
8608 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_flight_transmit", ret);
8609 return ret;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008610 }
8611#endif
8612
Gilles Peskine449bd832023-01-11 14:50:10 +01008613 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write finished"));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008614
Gilles Peskine449bd832023-01-11 14:50:10 +01008615 return 0;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008616}
8617
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008618#define SSL_MAX_HASH_LEN 12
8619
Gilles Peskine449bd832023-01-11 14:50:10 +01008620int mbedtls_ssl_parse_finished(mbedtls_ssl_context *ssl)
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008621{
8622 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
8623 unsigned int hash_len = 12;
8624 unsigned char buf[SSL_MAX_HASH_LEN];
8625
Gilles Peskine449bd832023-01-11 14:50:10 +01008626 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse finished"));
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008627
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01008628 ret = ssl->handshake->calc_finished(ssl, buf, ssl->conf->endpoint ^ 1);
8629 if (ret != 0) {
8630 MBEDTLS_SSL_DEBUG_RET(1, "calc_finished", ret);
8631 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008632
Gilles Peskine449bd832023-01-11 14:50:10 +01008633 if ((ret = mbedtls_ssl_read_record(ssl, 1)) != 0) {
8634 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_read_record", ret);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008635 goto exit;
8636 }
8637
Gilles Peskine449bd832023-01-11 14:50:10 +01008638 if (ssl->in_msgtype != MBEDTLS_SSL_MSG_HANDSHAKE) {
8639 MBEDTLS_SSL_DEBUG_MSG(1, ("bad finished message"));
8640 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8641 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008642 ret = MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
8643 goto exit;
8644 }
8645
Gilles Peskine449bd832023-01-11 14:50:10 +01008646 if (ssl->in_msg[0] != MBEDTLS_SSL_HS_FINISHED) {
8647 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8648 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008649 ret = MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
8650 goto exit;
8651 }
8652
Gilles Peskine449bd832023-01-11 14:50:10 +01008653 if (ssl->in_hslen != mbedtls_ssl_hs_hdr_len(ssl) + hash_len) {
8654 MBEDTLS_SSL_DEBUG_MSG(1, ("bad finished message"));
8655 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8656 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008657 ret = MBEDTLS_ERR_SSL_DECODE_ERROR;
8658 goto exit;
8659 }
8660
Gilles Peskine449bd832023-01-11 14:50:10 +01008661 if (mbedtls_ct_memcmp(ssl->in_msg + mbedtls_ssl_hs_hdr_len(ssl),
8662 buf, hash_len) != 0) {
8663 MBEDTLS_SSL_DEBUG_MSG(1, ("bad finished message"));
8664 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8665 MBEDTLS_SSL_ALERT_MSG_DECRYPT_ERROR);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008666 ret = MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
8667 goto exit;
8668 }
8669
8670#if defined(MBEDTLS_SSL_RENEGOTIATION)
8671 ssl->verify_data_len = hash_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01008672 memcpy(ssl->peer_verify_data, buf, hash_len);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008673#endif
8674
Gilles Peskine449bd832023-01-11 14:50:10 +01008675 if (ssl->handshake->resume != 0) {
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008676#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008677 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008678 ssl->state = MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC;
Gilles Peskine449bd832023-01-11 14:50:10 +01008679 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008680#endif
8681#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008682 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008683 ssl->state = MBEDTLS_SSL_HANDSHAKE_WRAPUP;
Gilles Peskine449bd832023-01-11 14:50:10 +01008684 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008685#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01008686 } else {
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008687 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01008688 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008689
8690#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01008691 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
8692 mbedtls_ssl_recv_flight_completed(ssl);
8693 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008694#endif
8695
Gilles Peskine449bd832023-01-11 14:50:10 +01008696 MBEDTLS_SSL_DEBUG_MSG(2, ("<= parse finished"));
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008697
8698exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01008699 mbedtls_platform_zeroize(buf, hash_len);
8700 return ret;
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008701}
8702
Jerry Yu392112c2022-02-17 14:34:10 +08008703#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
8704/*
8705 * Helper to get TLS 1.2 PRF from ciphersuite
8706 * (Duplicates bits of logic from ssl_set_handshake_prfs().)
8707 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008708static tls_prf_fn ssl_tls12prf_from_cs(int ciphersuite_id)
Jerry Yu392112c2022-02-17 14:34:10 +08008709{
Jerry Yu392112c2022-02-17 14:34:10 +08008710 const mbedtls_ssl_ciphersuite_t * const ciphersuite_info =
Gilles Peskine449bd832023-01-11 14:50:10 +01008711 mbedtls_ssl_ciphersuite_from_id(ciphersuite_id);
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01008712#if defined(MBEDTLS_MD_CAN_SHA384)
Gilles Peskine449bd832023-01-11 14:50:10 +01008713 if (ciphersuite_info != NULL && ciphersuite_info->mac == MBEDTLS_MD_SHA384) {
8714 return tls_prf_sha384;
8715 } else
Jerry Yu392112c2022-02-17 14:34:10 +08008716#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01008717#if defined(MBEDTLS_MD_CAN_SHA256)
Andrzej Kurek894edde2022-09-29 06:31:14 -04008718 {
Gilles Peskine449bd832023-01-11 14:50:10 +01008719 if (ciphersuite_info != NULL && ciphersuite_info->mac == MBEDTLS_MD_SHA256) {
8720 return tls_prf_sha256;
8721 }
Andrzej Kurek894edde2022-09-29 06:31:14 -04008722 }
8723#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01008724#if !defined(MBEDTLS_MD_CAN_SHA384) && \
8725 !defined(MBEDTLS_MD_CAN_SHA256)
Andrzej Kurek894edde2022-09-29 06:31:14 -04008726 (void) ciphersuite_info;
8727#endif
Andrzej Kurekeabeb302022-10-17 07:52:51 -04008728
Gilles Peskine449bd832023-01-11 14:50:10 +01008729 return NULL;
Jerry Yu392112c2022-02-17 14:34:10 +08008730}
8731#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
Jerry Yue93ffcd2022-02-17 14:37:06 +08008732
Gilles Peskine449bd832023-01-11 14:50:10 +01008733static mbedtls_tls_prf_types tls_prf_get_type(mbedtls_ssl_tls_prf_cb *tls_prf)
Jerry Yue93ffcd2022-02-17 14:37:06 +08008734{
8735 ((void) tls_prf);
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01008736#if defined(MBEDTLS_MD_CAN_SHA384)
Gilles Peskine449bd832023-01-11 14:50:10 +01008737 if (tls_prf == tls_prf_sha384) {
8738 return MBEDTLS_SSL_TLS_PRF_SHA384;
8739 } else
Jerry Yue93ffcd2022-02-17 14:37:06 +08008740#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01008741#if defined(MBEDTLS_MD_CAN_SHA256)
Gilles Peskine449bd832023-01-11 14:50:10 +01008742 if (tls_prf == tls_prf_sha256) {
8743 return MBEDTLS_SSL_TLS_PRF_SHA256;
8744 } else
Jerry Yue93ffcd2022-02-17 14:37:06 +08008745#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01008746 return MBEDTLS_SSL_TLS_PRF_NONE;
Jerry Yue93ffcd2022-02-17 14:37:06 +08008747}
8748
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008749/*
8750 * Populate a transform structure with session keys and all the other
8751 * necessary information.
8752 *
8753 * Parameters:
8754 * - [in/out]: transform: structure to populate
8755 * [in] must be just initialised with mbedtls_ssl_transform_init()
8756 * [out] fully populated, ready for use by mbedtls_ssl_{en,de}crypt_buf()
8757 * - [in] ciphersuite
8758 * - [in] master
8759 * - [in] encrypt_then_mac
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008760 * - [in] tls_prf: pointer to PRF to use for key derivation
8761 * - [in] randbytes: buffer holding ServerHello.random + ClientHello.random
Glenn Strauss07c64162022-03-14 12:34:51 -04008762 * - [in] tls_version: TLS version
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008763 * - [in] endpoint: client or server
8764 * - [in] ssl: used for:
8765 * - ssl->conf->{f,p}_export_keys
8766 * [in] optionally used for:
8767 * - MBEDTLS_DEBUG_C: ssl->conf->{f,p}_dbg
8768 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02008769MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01008770static int ssl_tls12_populate_transform(mbedtls_ssl_transform *transform,
8771 int ciphersuite,
8772 const unsigned char master[48],
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008773#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01008774 int encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008775#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01008776 ssl_tls_prf_t tls_prf,
8777 const unsigned char randbytes[64],
8778 mbedtls_ssl_protocol_version tls_version,
8779 unsigned endpoint,
8780 const mbedtls_ssl_context *ssl)
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008781{
8782 int ret = 0;
8783 unsigned char keyblk[256];
8784 unsigned char *key1;
8785 unsigned char *key2;
8786 unsigned char *mac_enc;
8787 unsigned char *mac_dec;
8788 size_t mac_key_len = 0;
8789 size_t iv_copy_len;
8790 size_t keylen;
8791 const mbedtls_ssl_ciphersuite_t *ciphersuite_info;
Neil Armstrong7fea33e2022-04-01 15:40:25 +02008792 mbedtls_ssl_mode_t ssl_mode;
Neil Armstronge4512952022-03-08 09:08:22 +01008793#if !defined(MBEDTLS_USE_PSA_CRYPTO)
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008794 const mbedtls_cipher_info_t *cipher_info;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008795 const mbedtls_md_info_t *md_info;
Neil Armstronge4512952022-03-08 09:08:22 +01008796#endif /* !MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008797
8798#if defined(MBEDTLS_USE_PSA_CRYPTO)
8799 psa_key_type_t key_type;
8800 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
8801 psa_algorithm_t alg;
Neil Armstronge4512952022-03-08 09:08:22 +01008802 psa_algorithm_t mac_alg = 0;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008803 size_t key_bits;
8804 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
8805#endif
8806
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008807 /*
8808 * Some data just needs copying into the structure
8809 */
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008810#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008811 transform->encrypt_then_mac = encrypt_then_mac;
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008812#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Glenn Strauss07c64162022-03-14 12:34:51 -04008813 transform->tls_version = tls_version;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008814
8815#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01008816 memcpy(transform->randbytes, randbytes, sizeof(transform->randbytes));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008817#endif
8818
8819#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01008820 if (tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008821 /* At the moment, we keep TLS <= 1.2 and TLS 1.3 transform
8822 * generation separate. This should never happen. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008823 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008824 }
8825#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
8826
8827 /*
8828 * Get various info structures
8829 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008830 ciphersuite_info = mbedtls_ssl_ciphersuite_from_id(ciphersuite);
8831 if (ciphersuite_info == NULL) {
8832 MBEDTLS_SSL_DEBUG_MSG(1, ("ciphersuite info for %d not found",
8833 ciphersuite));
8834 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008835 }
8836
Neil Armstrongab555e02022-04-04 11:07:59 +02008837 ssl_mode = mbedtls_ssl_get_mode_from_ciphersuite(
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008838#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01008839 encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008840#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01008841 ciphersuite_info);
Neil Armstrong7fea33e2022-04-01 15:40:25 +02008842
Gilles Peskine449bd832023-01-11 14:50:10 +01008843 if (ssl_mode == MBEDTLS_SSL_MODE_AEAD) {
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008844 transform->taglen =
8845 ciphersuite_info->flags & MBEDTLS_CIPHERSUITE_SHORT_TAG ? 8 : 16;
Gilles Peskine449bd832023-01-11 14:50:10 +01008846 }
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008847
8848#if defined(MBEDTLS_USE_PSA_CRYPTO)
Dave Rodgman2eab4622023-10-05 13:30:37 +01008849 if ((status = mbedtls_ssl_cipher_to_psa((mbedtls_cipher_type_t) ciphersuite_info->cipher,
Gilles Peskine449bd832023-01-11 14:50:10 +01008850 transform->taglen,
8851 &alg,
8852 &key_type,
8853 &key_bits)) != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008854 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01008855 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_cipher_to_psa", ret);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008856 goto end;
8857 }
8858#else
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01008859 cipher_info = mbedtls_cipher_info_from_type((mbedtls_cipher_type_t) ciphersuite_info->cipher);
Gilles Peskine449bd832023-01-11 14:50:10 +01008860 if (cipher_info == NULL) {
8861 MBEDTLS_SSL_DEBUG_MSG(1, ("cipher info for %u not found",
8862 ciphersuite_info->cipher));
8863 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008864 }
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008865#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008866
Neil Armstronge4512952022-03-08 09:08:22 +01008867#if defined(MBEDTLS_USE_PSA_CRYPTO)
Dave Rodgman2eab4622023-10-05 13:30:37 +01008868 mac_alg = mbedtls_md_psa_alg_from_type((mbedtls_md_type_t) ciphersuite_info->mac);
Gilles Peskine449bd832023-01-11 14:50:10 +01008869 if (mac_alg == 0) {
Manuel Pégourié-Gonnard2d6d9932023-03-28 11:38:08 +02008870 MBEDTLS_SSL_DEBUG_MSG(1, ("mbedtls_md_psa_alg_from_type for %u not found",
Gilles Peskine449bd832023-01-11 14:50:10 +01008871 (unsigned) ciphersuite_info->mac));
8872 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Neil Armstronge4512952022-03-08 09:08:22 +01008873 }
8874#else
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01008875 md_info = mbedtls_md_info_from_type((mbedtls_md_type_t) ciphersuite_info->mac);
Gilles Peskine449bd832023-01-11 14:50:10 +01008876 if (md_info == NULL) {
8877 MBEDTLS_SSL_DEBUG_MSG(1, ("mbedtls_md info for %u not found",
8878 (unsigned) ciphersuite_info->mac));
8879 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008880 }
Neil Armstronge4512952022-03-08 09:08:22 +01008881#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008882
8883#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
8884 /* Copy own and peer's CID if the use of the CID
8885 * extension has been negotiated. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008886 if (ssl->handshake->cid_in_use == MBEDTLS_SSL_CID_ENABLED) {
8887 MBEDTLS_SSL_DEBUG_MSG(3, ("Copy CIDs into SSL transform"));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008888
8889 transform->in_cid_len = ssl->own_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01008890 memcpy(transform->in_cid, ssl->own_cid, ssl->own_cid_len);
8891 MBEDTLS_SSL_DEBUG_BUF(3, "Incoming CID", transform->in_cid,
8892 transform->in_cid_len);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008893
8894 transform->out_cid_len = ssl->handshake->peer_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01008895 memcpy(transform->out_cid, ssl->handshake->peer_cid,
8896 ssl->handshake->peer_cid_len);
8897 MBEDTLS_SSL_DEBUG_BUF(3, "Outgoing CID", transform->out_cid,
8898 transform->out_cid_len);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008899 }
8900#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
8901
8902 /*
8903 * Compute key block using the PRF
8904 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008905 ret = tls_prf(master, 48, "key expansion", randbytes, 64, keyblk, 256);
8906 if (ret != 0) {
8907 MBEDTLS_SSL_DEBUG_RET(1, "prf", ret);
8908 return ret;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008909 }
8910
Gilles Peskine449bd832023-01-11 14:50:10 +01008911 MBEDTLS_SSL_DEBUG_MSG(3, ("ciphersuite = %s",
8912 mbedtls_ssl_get_ciphersuite_name(ciphersuite)));
8913 MBEDTLS_SSL_DEBUG_BUF(3, "master secret", master, 48);
8914 MBEDTLS_SSL_DEBUG_BUF(4, "random bytes", randbytes, 64);
8915 MBEDTLS_SSL_DEBUG_BUF(4, "key block", keyblk, 256);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008916
8917 /*
8918 * Determine the appropriate key, IV and MAC length.
8919 */
8920
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008921#if defined(MBEDTLS_USE_PSA_CRYPTO)
8922 keylen = PSA_BITS_TO_BYTES(key_bits);
8923#else
Gilles Peskine449bd832023-01-11 14:50:10 +01008924 keylen = mbedtls_cipher_info_get_key_bitlen(cipher_info) / 8;
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008925#endif
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008926
Valerio Settie5707042023-10-11 11:54:42 +02008927#if defined(MBEDTLS_SSL_HAVE_AEAD)
Gilles Peskine449bd832023-01-11 14:50:10 +01008928 if (ssl_mode == MBEDTLS_SSL_MODE_AEAD) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008929 size_t explicit_ivlen;
8930
8931 transform->maclen = 0;
8932 mac_key_len = 0;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008933
8934 /* All modes haves 96-bit IVs, but the length of the static parts vary
8935 * with mode and version:
8936 * - For GCM and CCM in TLS 1.2, there's a static IV of 4 Bytes
8937 * (to be concatenated with a dynamically chosen IV of 8 Bytes)
8938 * - For ChaChaPoly in TLS 1.2, and all modes in TLS 1.3, there's
8939 * a static IV of 12 Bytes (to be XOR'ed with the 8 Byte record
8940 * sequence number).
8941 */
8942 transform->ivlen = 12;
David Horstmann3b2276a2022-10-06 14:49:08 +01008943
8944 int is_chachapoly = 0;
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008945#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01008946 is_chachapoly = (key_type == PSA_KEY_TYPE_CHACHA20);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008947#else
Gilles Peskine449bd832023-01-11 14:50:10 +01008948 is_chachapoly = (mbedtls_cipher_info_get_mode(cipher_info)
8949 == MBEDTLS_MODE_CHACHAPOLY);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008950#endif /* MBEDTLS_USE_PSA_CRYPTO */
David Horstmann3b2276a2022-10-06 14:49:08 +01008951
Gilles Peskine449bd832023-01-11 14:50:10 +01008952 if (is_chachapoly) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008953 transform->fixed_ivlen = 12;
Gilles Peskine449bd832023-01-11 14:50:10 +01008954 } else {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008955 transform->fixed_ivlen = 4;
Gilles Peskine449bd832023-01-11 14:50:10 +01008956 }
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008957
8958 /* Minimum length of encrypted record */
8959 explicit_ivlen = transform->ivlen - transform->fixed_ivlen;
8960 transform->minlen = explicit_ivlen + transform->taglen;
Gilles Peskine449bd832023-01-11 14:50:10 +01008961 } else
Valerio Settie5707042023-10-11 11:54:42 +02008962#endif /* MBEDTLS_SSL_HAVE_AEAD */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008963#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01008964 if (ssl_mode == MBEDTLS_SSL_MODE_STREAM ||
Neil Armstrong7fea33e2022-04-01 15:40:25 +02008965 ssl_mode == MBEDTLS_SSL_MODE_CBC ||
Gilles Peskine449bd832023-01-11 14:50:10 +01008966 ssl_mode == MBEDTLS_SSL_MODE_CBC_ETM) {
Neil Armstronge4512952022-03-08 09:08:22 +01008967#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01008968 size_t block_size = PSA_BLOCK_CIPHER_BLOCK_LENGTH(key_type);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008969#else
Dave Rodgman85a88132023-06-24 11:41:50 +01008970 size_t block_size = mbedtls_cipher_info_get_block_size(cipher_info);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008971#endif /* MBEDTLS_USE_PSA_CRYPTO */
8972
8973#if defined(MBEDTLS_USE_PSA_CRYPTO)
Neil Armstronge4512952022-03-08 09:08:22 +01008974 /* Get MAC length */
8975 mac_key_len = PSA_HASH_LENGTH(mac_alg);
8976#else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008977 /* Initialize HMAC contexts */
Gilles Peskine449bd832023-01-11 14:50:10 +01008978 if ((ret = mbedtls_md_setup(&transform->md_ctx_enc, md_info, 1)) != 0 ||
8979 (ret = mbedtls_md_setup(&transform->md_ctx_dec, md_info, 1)) != 0) {
8980 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_setup", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008981 goto end;
8982 }
8983
8984 /* Get MAC length */
Gilles Peskine449bd832023-01-11 14:50:10 +01008985 mac_key_len = mbedtls_md_get_size(md_info);
Neil Armstronge4512952022-03-08 09:08:22 +01008986#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008987 transform->maclen = mac_key_len;
8988
8989 /* IV length */
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008990#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01008991 transform->ivlen = PSA_CIPHER_IV_LENGTH(key_type, alg);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008992#else
Dave Rodgmanbb521fd2023-06-24 11:21:25 +01008993 transform->ivlen = mbedtls_cipher_info_get_iv_size(cipher_info);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008994#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008995
8996 /* Minimum length */
Gilles Peskine449bd832023-01-11 14:50:10 +01008997 if (ssl_mode == MBEDTLS_SSL_MODE_STREAM) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008998 transform->minlen = transform->maclen;
Gilles Peskine449bd832023-01-11 14:50:10 +01008999 } else {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009000 /*
9001 * GenericBlockCipher:
9002 * 1. if EtM is in use: one block plus MAC
9003 * otherwise: * first multiple of blocklen greater than maclen
9004 * 2. IV
9005 */
9006#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01009007 if (ssl_mode == MBEDTLS_SSL_MODE_CBC_ETM) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009008 transform->minlen = transform->maclen
Gilles Peskine449bd832023-01-11 14:50:10 +01009009 + block_size;
9010 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009011#endif
9012 {
9013 transform->minlen = transform->maclen
Gilles Peskine449bd832023-01-11 14:50:10 +01009014 + block_size
9015 - transform->maclen % block_size;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009016 }
9017
Gilles Peskine449bd832023-01-11 14:50:10 +01009018 if (tls_version == MBEDTLS_SSL_VERSION_TLS1_2) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009019 transform->minlen += transform->ivlen;
Gilles Peskine449bd832023-01-11 14:50:10 +01009020 } else {
9021 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009022 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
9023 goto end;
9024 }
9025 }
Gilles Peskine449bd832023-01-11 14:50:10 +01009026 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009027#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
9028 {
Gilles Peskine449bd832023-01-11 14:50:10 +01009029 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
9030 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009031 }
9032
Gilles Peskine449bd832023-01-11 14:50:10 +01009033 MBEDTLS_SSL_DEBUG_MSG(3, ("keylen: %u, minlen: %u, ivlen: %u, maclen: %u",
9034 (unsigned) keylen,
9035 (unsigned) transform->minlen,
9036 (unsigned) transform->ivlen,
9037 (unsigned) transform->maclen));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009038
9039 /*
9040 * Finally setup the cipher contexts, IVs and MAC secrets.
9041 */
9042#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01009043 if (endpoint == MBEDTLS_SSL_IS_CLIENT) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009044 key1 = keyblk + mac_key_len * 2;
9045 key2 = keyblk + mac_key_len * 2 + keylen;
9046
9047 mac_enc = keyblk;
9048 mac_dec = keyblk + mac_key_len;
9049
Gilles Peskine449bd832023-01-11 14:50:10 +01009050 iv_copy_len = (transform->fixed_ivlen) ?
9051 transform->fixed_ivlen : transform->ivlen;
9052 memcpy(transform->iv_enc, key2 + keylen, iv_copy_len);
9053 memcpy(transform->iv_dec, key2 + keylen + iv_copy_len,
9054 iv_copy_len);
9055 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009056#endif /* MBEDTLS_SSL_CLI_C */
9057#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01009058 if (endpoint == MBEDTLS_SSL_IS_SERVER) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009059 key1 = keyblk + mac_key_len * 2 + keylen;
9060 key2 = keyblk + mac_key_len * 2;
9061
9062 mac_enc = keyblk + mac_key_len;
9063 mac_dec = keyblk;
9064
Gilles Peskine449bd832023-01-11 14:50:10 +01009065 iv_copy_len = (transform->fixed_ivlen) ?
9066 transform->fixed_ivlen : transform->ivlen;
9067 memcpy(transform->iv_dec, key1 + keylen, iv_copy_len);
9068 memcpy(transform->iv_enc, key1 + keylen + iv_copy_len,
9069 iv_copy_len);
9070 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009071#endif /* MBEDTLS_SSL_SRV_C */
9072 {
Gilles Peskine449bd832023-01-11 14:50:10 +01009073 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009074 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
9075 goto end;
9076 }
9077
Paul Elliott4fb19552023-10-18 12:15:30 +01009078 if (ssl->f_export_keys != NULL) {
Gilles Peskine449bd832023-01-11 14:50:10 +01009079 ssl->f_export_keys(ssl->p_export_keys,
9080 MBEDTLS_SSL_KEY_EXPORT_TLS12_MASTER_SECRET,
9081 master, 48,
9082 randbytes + 32,
9083 randbytes,
9084 tls_prf_get_type(tls_prf));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009085 }
9086
9087#if defined(MBEDTLS_USE_PSA_CRYPTO)
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009088 transform->psa_alg = alg;
9089
Gilles Peskine449bd832023-01-11 14:50:10 +01009090 if (alg != MBEDTLS_SSL_NULL_CIPHER) {
9091 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_ENCRYPT);
9092 psa_set_key_algorithm(&attributes, alg);
9093 psa_set_key_type(&attributes, key_type);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009094
Gilles Peskine449bd832023-01-11 14:50:10 +01009095 if ((status = psa_import_key(&attributes,
9096 key1,
9097 PSA_BITS_TO_BYTES(key_bits),
9098 &transform->psa_key_enc)) != PSA_SUCCESS) {
9099 MBEDTLS_SSL_DEBUG_RET(3, "psa_import_key", (int) status);
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05009100 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01009101 MBEDTLS_SSL_DEBUG_RET(1, "psa_import_key", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009102 goto end;
9103 }
9104
Gilles Peskine449bd832023-01-11 14:50:10 +01009105 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_DECRYPT);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009106
Gilles Peskine449bd832023-01-11 14:50:10 +01009107 if ((status = psa_import_key(&attributes,
9108 key2,
9109 PSA_BITS_TO_BYTES(key_bits),
9110 &transform->psa_key_dec)) != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05009111 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01009112 MBEDTLS_SSL_DEBUG_RET(1, "psa_import_key", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009113 goto end;
9114 }
9115 }
9116#else
Gilles Peskine449bd832023-01-11 14:50:10 +01009117 if ((ret = mbedtls_cipher_setup(&transform->cipher_ctx_enc,
9118 cipher_info)) != 0) {
9119 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_setup", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009120 goto end;
9121 }
9122
Gilles Peskine449bd832023-01-11 14:50:10 +01009123 if ((ret = mbedtls_cipher_setup(&transform->cipher_ctx_dec,
9124 cipher_info)) != 0) {
9125 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_setup", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009126 goto end;
9127 }
9128
Gilles Peskine449bd832023-01-11 14:50:10 +01009129 if ((ret = mbedtls_cipher_setkey(&transform->cipher_ctx_enc, key1,
9130 (int) mbedtls_cipher_info_get_key_bitlen(cipher_info),
9131 MBEDTLS_ENCRYPT)) != 0) {
9132 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_setkey", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009133 goto end;
9134 }
9135
Gilles Peskine449bd832023-01-11 14:50:10 +01009136 if ((ret = mbedtls_cipher_setkey(&transform->cipher_ctx_dec, key2,
9137 (int) mbedtls_cipher_info_get_key_bitlen(cipher_info),
9138 MBEDTLS_DECRYPT)) != 0) {
9139 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_setkey", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009140 goto end;
9141 }
9142
9143#if defined(MBEDTLS_CIPHER_MODE_CBC)
Gilles Peskine449bd832023-01-11 14:50:10 +01009144 if (mbedtls_cipher_info_get_mode(cipher_info) == MBEDTLS_MODE_CBC) {
9145 if ((ret = mbedtls_cipher_set_padding_mode(&transform->cipher_ctx_enc,
9146 MBEDTLS_PADDING_NONE)) != 0) {
9147 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_set_padding_mode", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009148 goto end;
9149 }
9150
Gilles Peskine449bd832023-01-11 14:50:10 +01009151 if ((ret = mbedtls_cipher_set_padding_mode(&transform->cipher_ctx_dec,
9152 MBEDTLS_PADDING_NONE)) != 0) {
9153 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_set_padding_mode", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009154 goto end;
9155 }
9156 }
9157#endif /* MBEDTLS_CIPHER_MODE_CBC */
9158#endif /* MBEDTLS_USE_PSA_CRYPTO */
9159
Neil Armstrong29c0c042022-03-17 17:47:28 +01009160#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
9161 /* For HMAC-based ciphersuites, initialize the HMAC transforms.
9162 For AEAD-based ciphersuites, there is nothing to do here. */
Gilles Peskine449bd832023-01-11 14:50:10 +01009163 if (mac_key_len != 0) {
Neil Armstrong29c0c042022-03-17 17:47:28 +01009164#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01009165 transform->psa_mac_alg = PSA_ALG_HMAC(mac_alg);
Neil Armstrong29c0c042022-03-17 17:47:28 +01009166
Gilles Peskine449bd832023-01-11 14:50:10 +01009167 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_SIGN_MESSAGE);
9168 psa_set_key_algorithm(&attributes, PSA_ALG_HMAC(mac_alg));
9169 psa_set_key_type(&attributes, PSA_KEY_TYPE_HMAC);
Neil Armstrong29c0c042022-03-17 17:47:28 +01009170
Gilles Peskine449bd832023-01-11 14:50:10 +01009171 if ((status = psa_import_key(&attributes,
9172 mac_enc, mac_key_len,
9173 &transform->psa_mac_enc)) != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05009174 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01009175 MBEDTLS_SSL_DEBUG_RET(1, "psa_import_mac_key", ret);
Neil Armstrong29c0c042022-03-17 17:47:28 +01009176 goto end;
9177 }
9178
Gilles Peskine449bd832023-01-11 14:50:10 +01009179 if ((transform->psa_alg == MBEDTLS_SSL_NULL_CIPHER) ||
9180 ((transform->psa_alg == PSA_ALG_CBC_NO_PADDING)
Andrzej Kurek8c95ac42022-08-17 16:17:00 -04009181#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01009182 && (transform->encrypt_then_mac == MBEDTLS_SSL_ETM_DISABLED)
Andrzej Kurek8c95ac42022-08-17 16:17:00 -04009183#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01009184 )) {
Neil Armstrong29c0c042022-03-17 17:47:28 +01009185 /* mbedtls_ct_hmac() requires the key to be exportable */
Gilles Peskine449bd832023-01-11 14:50:10 +01009186 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_EXPORT |
9187 PSA_KEY_USAGE_VERIFY_HASH);
9188 } else {
9189 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_VERIFY_HASH);
9190 }
Neil Armstrong29c0c042022-03-17 17:47:28 +01009191
Gilles Peskine449bd832023-01-11 14:50:10 +01009192 if ((status = psa_import_key(&attributes,
9193 mac_dec, mac_key_len,
9194 &transform->psa_mac_dec)) != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05009195 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01009196 MBEDTLS_SSL_DEBUG_RET(1, "psa_import_mac_key", ret);
Neil Armstrong29c0c042022-03-17 17:47:28 +01009197 goto end;
9198 }
9199#else
Gilles Peskine449bd832023-01-11 14:50:10 +01009200 ret = mbedtls_md_hmac_starts(&transform->md_ctx_enc, mac_enc, mac_key_len);
9201 if (ret != 0) {
Neil Armstrong29c0c042022-03-17 17:47:28 +01009202 goto end;
Gilles Peskine449bd832023-01-11 14:50:10 +01009203 }
9204 ret = mbedtls_md_hmac_starts(&transform->md_ctx_dec, mac_dec, mac_key_len);
9205 if (ret != 0) {
Neil Armstrong29c0c042022-03-17 17:47:28 +01009206 goto end;
Gilles Peskine449bd832023-01-11 14:50:10 +01009207 }
Neil Armstrong29c0c042022-03-17 17:47:28 +01009208#endif /* MBEDTLS_USE_PSA_CRYPTO */
9209 }
9210#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
9211
9212 ((void) mac_dec);
9213 ((void) mac_enc);
9214
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009215end:
Gilles Peskine449bd832023-01-11 14:50:10 +01009216 mbedtls_platform_zeroize(keyblk, sizeof(keyblk));
9217 return ret;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009218}
9219
Valerio Settia08b1a42022-11-17 15:10:02 +01009220#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED) && \
9221 defined(MBEDTLS_USE_PSA_CRYPTO)
Valerio Setti6b3dab02022-11-17 17:14:54 +01009222int mbedtls_psa_ecjpake_read_round(
Gilles Peskine449bd832023-01-11 14:50:10 +01009223 psa_pake_operation_t *pake_ctx,
9224 const unsigned char *buf,
9225 size_t len, mbedtls_ecjpake_rounds_t round)
Valerio Settia08b1a42022-11-17 15:10:02 +01009226{
9227 psa_status_t status;
9228 size_t input_offset = 0;
Valerio Setti819de862022-11-17 18:05:19 +01009229 /*
Valerio Setti6b3dab02022-11-17 17:14:54 +01009230 * At round one repeat the KEY_SHARE, ZK_PUBLIC & ZF_PROOF twice
9231 * At round two perform a single cycle
9232 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009233 unsigned int remaining_steps = (round == MBEDTLS_ECJPAKE_ROUND_ONE) ? 2 : 1;
Valerio Settia08b1a42022-11-17 15:10:02 +01009234
Gilles Peskine449bd832023-01-11 14:50:10 +01009235 for (; remaining_steps > 0; remaining_steps--) {
9236 for (psa_pake_step_t step = PSA_PAKE_STEP_KEY_SHARE;
Valerio Settia08b1a42022-11-17 15:10:02 +01009237 step <= PSA_PAKE_STEP_ZK_PROOF;
Gilles Peskine449bd832023-01-11 14:50:10 +01009238 ++step) {
Valerio Settia08b1a42022-11-17 15:10:02 +01009239 /* Length is stored at the first byte */
9240 size_t length = buf[input_offset];
9241 input_offset += 1;
9242
Gilles Peskine449bd832023-01-11 14:50:10 +01009243 if (input_offset + length > len) {
Valerio Settia08b1a42022-11-17 15:10:02 +01009244 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
9245 }
9246
Gilles Peskine449bd832023-01-11 14:50:10 +01009247 status = psa_pake_input(pake_ctx, step,
9248 buf + input_offset, length);
9249 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05009250 return PSA_TO_MBEDTLS_ERR(status);
Valerio Settia08b1a42022-11-17 15:10:02 +01009251 }
9252
9253 input_offset += length;
9254 }
9255 }
9256
Gilles Peskine449bd832023-01-11 14:50:10 +01009257 if (input_offset != len) {
Valerio Setti61ea17d2022-11-18 12:11:00 +01009258 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Gilles Peskine449bd832023-01-11 14:50:10 +01009259 }
Valerio Setti30ebe112022-11-17 16:23:34 +01009260
Gilles Peskine449bd832023-01-11 14:50:10 +01009261 return 0;
Valerio Settia08b1a42022-11-17 15:10:02 +01009262}
9263
Valerio Setti6b3dab02022-11-17 17:14:54 +01009264int mbedtls_psa_ecjpake_write_round(
Gilles Peskine449bd832023-01-11 14:50:10 +01009265 psa_pake_operation_t *pake_ctx,
9266 unsigned char *buf,
9267 size_t len, size_t *olen,
9268 mbedtls_ecjpake_rounds_t round)
Valerio Settia08b1a42022-11-17 15:10:02 +01009269{
9270 psa_status_t status;
9271 size_t output_offset = 0;
9272 size_t output_len;
Valerio Setti819de862022-11-17 18:05:19 +01009273 /*
Valerio Setti6b3dab02022-11-17 17:14:54 +01009274 * At round one repeat the KEY_SHARE, ZK_PUBLIC & ZF_PROOF twice
9275 * At round two perform a single cycle
9276 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009277 unsigned int remaining_steps = (round == MBEDTLS_ECJPAKE_ROUND_ONE) ? 2 : 1;
Valerio Settia08b1a42022-11-17 15:10:02 +01009278
Gilles Peskine449bd832023-01-11 14:50:10 +01009279 for (; remaining_steps > 0; remaining_steps--) {
9280 for (psa_pake_step_t step = PSA_PAKE_STEP_KEY_SHARE;
9281 step <= PSA_PAKE_STEP_ZK_PROOF;
9282 ++step) {
Valerio Setti79f6b6b2022-11-21 14:17:03 +01009283 /*
Valerio Settid4a9b1a2022-11-22 11:11:10 +01009284 * For each step, prepend 1 byte with the length of the data as
9285 * given by psa_pake_output().
Valerio Setti79f6b6b2022-11-21 14:17:03 +01009286 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009287 status = psa_pake_output(pake_ctx, step,
9288 buf + output_offset + 1,
9289 len - output_offset - 1,
9290 &output_len);
9291 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05009292 return PSA_TO_MBEDTLS_ERR(status);
Valerio Settia08b1a42022-11-17 15:10:02 +01009293 }
9294
Valerio Setti99d88c12022-11-22 16:03:43 +01009295 *(buf + output_offset) = (uint8_t) output_len;
Valerio Setti79f6b6b2022-11-21 14:17:03 +01009296
9297 output_offset += output_len + 1;
Valerio Settia08b1a42022-11-17 15:10:02 +01009298 }
9299 }
9300
9301 *olen = output_offset;
9302
Gilles Peskine449bd832023-01-11 14:50:10 +01009303 return 0;
Valerio Settia08b1a42022-11-17 15:10:02 +01009304}
Valerio Settia08b1a42022-11-17 15:10:02 +01009305#endif //MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED && MBEDTLS_USE_PSA_CRYPTO
9306
Jerry Yuee40f9d2022-02-17 14:55:16 +08009307#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01009308int mbedtls_ssl_get_key_exchange_md_tls1_2(mbedtls_ssl_context *ssl,
9309 unsigned char *hash, size_t *hashlen,
9310 unsigned char *data, size_t data_len,
9311 mbedtls_md_type_t md_alg)
Jerry Yuee40f9d2022-02-17 14:55:16 +08009312{
9313 psa_status_t status;
9314 psa_hash_operation_t hash_operation = PSA_HASH_OPERATION_INIT;
Manuel Pégourié-Gonnard2d6d9932023-03-28 11:38:08 +02009315 psa_algorithm_t hash_alg = mbedtls_md_psa_alg_from_type(md_alg);
Jerry Yuee40f9d2022-02-17 14:55:16 +08009316
Gilles Peskine449bd832023-01-11 14:50:10 +01009317 MBEDTLS_SSL_DEBUG_MSG(3, ("Perform PSA-based computation of digest of ServerKeyExchange"));
Jerry Yuee40f9d2022-02-17 14:55:16 +08009318
Gilles Peskine449bd832023-01-11 14:50:10 +01009319 if ((status = psa_hash_setup(&hash_operation,
9320 hash_alg)) != PSA_SUCCESS) {
9321 MBEDTLS_SSL_DEBUG_RET(1, "psa_hash_setup", status);
Jerry Yuee40f9d2022-02-17 14:55:16 +08009322 goto exit;
9323 }
9324
Gilles Peskine449bd832023-01-11 14:50:10 +01009325 if ((status = psa_hash_update(&hash_operation, ssl->handshake->randbytes,
9326 64)) != PSA_SUCCESS) {
9327 MBEDTLS_SSL_DEBUG_RET(1, "psa_hash_update", status);
Jerry Yuee40f9d2022-02-17 14:55:16 +08009328 goto exit;
9329 }
9330
Gilles Peskine449bd832023-01-11 14:50:10 +01009331 if ((status = psa_hash_update(&hash_operation,
9332 data, data_len)) != PSA_SUCCESS) {
9333 MBEDTLS_SSL_DEBUG_RET(1, "psa_hash_update", status);
Jerry Yuee40f9d2022-02-17 14:55:16 +08009334 goto exit;
9335 }
9336
Gilles Peskine449bd832023-01-11 14:50:10 +01009337 if ((status = psa_hash_finish(&hash_operation, hash, PSA_HASH_MAX_SIZE,
9338 hashlen)) != PSA_SUCCESS) {
9339 MBEDTLS_SSL_DEBUG_RET(1, "psa_hash_finish", status);
9340 goto exit;
Jerry Yuee40f9d2022-02-17 14:55:16 +08009341 }
9342
9343exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01009344 if (status != PSA_SUCCESS) {
9345 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
9346 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR);
9347 switch (status) {
Jerry Yuee40f9d2022-02-17 14:55:16 +08009348 case PSA_ERROR_NOT_SUPPORTED:
Gilles Peskine449bd832023-01-11 14:50:10 +01009349 return MBEDTLS_ERR_MD_FEATURE_UNAVAILABLE;
Jerry Yuee40f9d2022-02-17 14:55:16 +08009350 case PSA_ERROR_BAD_STATE: /* Intentional fallthrough */
9351 case PSA_ERROR_BUFFER_TOO_SMALL:
Gilles Peskine449bd832023-01-11 14:50:10 +01009352 return MBEDTLS_ERR_MD_BAD_INPUT_DATA;
Jerry Yuee40f9d2022-02-17 14:55:16 +08009353 case PSA_ERROR_INSUFFICIENT_MEMORY:
Gilles Peskine449bd832023-01-11 14:50:10 +01009354 return MBEDTLS_ERR_MD_ALLOC_FAILED;
Jerry Yuee40f9d2022-02-17 14:55:16 +08009355 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01009356 return MBEDTLS_ERR_PLATFORM_HW_ACCEL_FAILED;
Jerry Yuee40f9d2022-02-17 14:55:16 +08009357 }
9358 }
Gilles Peskine449bd832023-01-11 14:50:10 +01009359 return 0;
Jerry Yuee40f9d2022-02-17 14:55:16 +08009360}
9361
9362#else
9363
Gilles Peskine449bd832023-01-11 14:50:10 +01009364int mbedtls_ssl_get_key_exchange_md_tls1_2(mbedtls_ssl_context *ssl,
9365 unsigned char *hash, size_t *hashlen,
9366 unsigned char *data, size_t data_len,
9367 mbedtls_md_type_t md_alg)
Jerry Yuee40f9d2022-02-17 14:55:16 +08009368{
9369 int ret = 0;
9370 mbedtls_md_context_t ctx;
Gilles Peskine449bd832023-01-11 14:50:10 +01009371 const mbedtls_md_info_t *md_info = mbedtls_md_info_from_type(md_alg);
9372 *hashlen = mbedtls_md_get_size(md_info);
Jerry Yuee40f9d2022-02-17 14:55:16 +08009373
Gilles Peskine449bd832023-01-11 14:50:10 +01009374 MBEDTLS_SSL_DEBUG_MSG(3, ("Perform mbedtls-based computation of digest of ServerKeyExchange"));
Jerry Yuee40f9d2022-02-17 14:55:16 +08009375
Gilles Peskine449bd832023-01-11 14:50:10 +01009376 mbedtls_md_init(&ctx);
Jerry Yuee40f9d2022-02-17 14:55:16 +08009377
9378 /*
9379 * digitally-signed struct {
9380 * opaque client_random[32];
9381 * opaque server_random[32];
9382 * ServerDHParams params;
9383 * };
9384 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009385 if ((ret = mbedtls_md_setup(&ctx, md_info, 0)) != 0) {
9386 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_setup", ret);
Jerry Yuee40f9d2022-02-17 14:55:16 +08009387 goto exit;
9388 }
Gilles Peskine449bd832023-01-11 14:50:10 +01009389 if ((ret = mbedtls_md_starts(&ctx)) != 0) {
9390 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_starts", ret);
Jerry Yuee40f9d2022-02-17 14:55:16 +08009391 goto exit;
9392 }
Gilles Peskine449bd832023-01-11 14:50:10 +01009393 if ((ret = mbedtls_md_update(&ctx, ssl->handshake->randbytes, 64)) != 0) {
9394 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_update", ret);
Jerry Yuee40f9d2022-02-17 14:55:16 +08009395 goto exit;
9396 }
Gilles Peskine449bd832023-01-11 14:50:10 +01009397 if ((ret = mbedtls_md_update(&ctx, data, data_len)) != 0) {
9398 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_update", ret);
Jerry Yuee40f9d2022-02-17 14:55:16 +08009399 goto exit;
9400 }
Gilles Peskine449bd832023-01-11 14:50:10 +01009401 if ((ret = mbedtls_md_finish(&ctx, hash)) != 0) {
9402 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_finish", ret);
Jerry Yuee40f9d2022-02-17 14:55:16 +08009403 goto exit;
9404 }
9405
9406exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01009407 mbedtls_md_free(&ctx);
Jerry Yuee40f9d2022-02-17 14:55:16 +08009408
Gilles Peskine449bd832023-01-11 14:50:10 +01009409 if (ret != 0) {
9410 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
9411 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR);
9412 }
Jerry Yuee40f9d2022-02-17 14:55:16 +08009413
Gilles Peskine449bd832023-01-11 14:50:10 +01009414 return ret;
Jerry Yuee40f9d2022-02-17 14:55:16 +08009415}
9416#endif /* MBEDTLS_USE_PSA_CRYPTO */
9417
Jerry Yud9d91da2022-02-17 14:57:06 +08009418#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
9419
Gabor Mezeia3d016c2022-05-10 12:44:09 +02009420/* Find the preferred hash for a given signature algorithm. */
9421unsigned int mbedtls_ssl_tls12_get_preferred_hash_for_sig_alg(
Gilles Peskine449bd832023-01-11 14:50:10 +01009422 mbedtls_ssl_context *ssl,
9423 unsigned int sig_alg)
Jerry Yud9d91da2022-02-17 14:57:06 +08009424{
Gabor Mezei078e8032022-04-27 21:17:56 +02009425 unsigned int i;
Gabor Mezeia3d016c2022-05-10 12:44:09 +02009426 uint16_t *received_sig_algs = ssl->handshake->received_sig_algs;
Gabor Mezei078e8032022-04-27 21:17:56 +02009427
Gilles Peskine449bd832023-01-11 14:50:10 +01009428 if (sig_alg == MBEDTLS_SSL_SIG_ANON) {
9429 return MBEDTLS_SSL_HASH_NONE;
9430 }
Gabor Mezei078e8032022-04-27 21:17:56 +02009431
Gilles Peskine449bd832023-01-11 14:50:10 +01009432 for (i = 0; received_sig_algs[i] != MBEDTLS_TLS_SIG_NONE; i++) {
Neil Armstrong9f1176a2022-06-24 18:19:19 +02009433 unsigned int hash_alg_received =
Gilles Peskine449bd832023-01-11 14:50:10 +01009434 MBEDTLS_SSL_TLS12_HASH_ALG_FROM_SIG_AND_HASH_ALG(
9435 received_sig_algs[i]);
Neil Armstrong9f1176a2022-06-24 18:19:19 +02009436 unsigned int sig_alg_received =
Gilles Peskine449bd832023-01-11 14:50:10 +01009437 MBEDTLS_SSL_TLS12_SIG_ALG_FROM_SIG_AND_HASH_ALG(
9438 received_sig_algs[i]);
Neil Armstrong9f1176a2022-06-24 18:19:19 +02009439
Manuel Pégourié-Gonnard47bb3802023-06-05 12:40:32 +02009440 mbedtls_md_type_t md_alg =
9441 mbedtls_ssl_md_alg_from_hash((unsigned char) hash_alg_received);
9442 if (md_alg == MBEDTLS_MD_NONE) {
9443 continue;
9444 }
9445
Gilles Peskine449bd832023-01-11 14:50:10 +01009446 if (sig_alg == sig_alg_received) {
Neil Armstrong9f1176a2022-06-24 18:19:19 +02009447#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01009448 if (ssl->handshake->key_cert && ssl->handshake->key_cert->key) {
Neil Armstrong96eceb82022-06-30 18:05:05 +02009449 psa_algorithm_t psa_hash_alg =
Manuel Pégourié-Gonnard47bb3802023-06-05 12:40:32 +02009450 mbedtls_md_psa_alg_from_type(md_alg);
Neil Armstrong9f1176a2022-06-24 18:19:19 +02009451
Gilles Peskine449bd832023-01-11 14:50:10 +01009452 if (sig_alg_received == MBEDTLS_SSL_SIG_ECDSA &&
9453 !mbedtls_pk_can_do_ext(ssl->handshake->key_cert->key,
9454 PSA_ALG_ECDSA(psa_hash_alg),
9455 PSA_KEY_USAGE_SIGN_HASH)) {
Neil Armstrong9f1176a2022-06-24 18:19:19 +02009456 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01009457 }
Neil Armstrong9f1176a2022-06-24 18:19:19 +02009458
Gilles Peskine449bd832023-01-11 14:50:10 +01009459 if (sig_alg_received == MBEDTLS_SSL_SIG_RSA &&
9460 !mbedtls_pk_can_do_ext(ssl->handshake->key_cert->key,
9461 PSA_ALG_RSA_PKCS1V15_SIGN(
9462 psa_hash_alg),
9463 PSA_KEY_USAGE_SIGN_HASH)) {
Neil Armstrong9f1176a2022-06-24 18:19:19 +02009464 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01009465 }
Neil Armstrong9f1176a2022-06-24 18:19:19 +02009466 }
Neil Armstrong9f1176a2022-06-24 18:19:19 +02009467#endif /* MBEDTLS_USE_PSA_CRYPTO */
Neil Armstrong96eceb82022-06-30 18:05:05 +02009468
Gilles Peskine449bd832023-01-11 14:50:10 +01009469 return hash_alg_received;
Neil Armstrong9f1176a2022-06-24 18:19:19 +02009470 }
Jerry Yud9d91da2022-02-17 14:57:06 +08009471 }
Jerry Yud9d91da2022-02-17 14:57:06 +08009472
Gilles Peskine449bd832023-01-11 14:50:10 +01009473 return MBEDTLS_SSL_HASH_NONE;
Jerry Yud9d91da2022-02-17 14:57:06 +08009474}
9475
9476#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
9477
Jerry Yudc7bd172022-02-17 13:44:15 +08009478#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
9479
XiaokangQian75d40ef2022-04-20 11:05:24 +00009480int mbedtls_ssl_validate_ciphersuite(
9481 const mbedtls_ssl_context *ssl,
9482 const mbedtls_ssl_ciphersuite_t *suite_info,
9483 mbedtls_ssl_protocol_version min_tls_version,
Gilles Peskine449bd832023-01-11 14:50:10 +01009484 mbedtls_ssl_protocol_version max_tls_version)
XiaokangQian75d40ef2022-04-20 11:05:24 +00009485{
9486 (void) ssl;
9487
Gilles Peskine449bd832023-01-11 14:50:10 +01009488 if (suite_info == NULL) {
9489 return -1;
9490 }
XiaokangQian75d40ef2022-04-20 11:05:24 +00009491
Gilles Peskine449bd832023-01-11 14:50:10 +01009492 if ((suite_info->min_tls_version > max_tls_version) ||
9493 (suite_info->max_tls_version < min_tls_version)) {
9494 return -1;
XiaokangQian75d40ef2022-04-20 11:05:24 +00009495 }
9496
XiaokangQian060d8672022-04-21 09:24:56 +00009497#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_CLI_C)
XiaokangQian75d40ef2022-04-20 11:05:24 +00009498#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Neil Armstrongca7d5062022-05-31 14:43:23 +02009499#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01009500 if (suite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_ECJPAKE &&
9501 ssl->handshake->psa_pake_ctx_is_ok != 1)
Neil Armstrongca7d5062022-05-31 14:43:23 +02009502#else
Gilles Peskine449bd832023-01-11 14:50:10 +01009503 if (suite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_ECJPAKE &&
9504 mbedtls_ecjpake_check(&ssl->handshake->ecjpake_ctx) != 0)
Neil Armstrongca7d5062022-05-31 14:43:23 +02009505#endif /* MBEDTLS_USE_PSA_CRYPTO */
XiaokangQian75d40ef2022-04-20 11:05:24 +00009506 {
Gilles Peskine449bd832023-01-11 14:50:10 +01009507 return -1;
XiaokangQian75d40ef2022-04-20 11:05:24 +00009508 }
9509#endif
9510
9511 /* Don't suggest PSK-based ciphersuite if no PSK is available. */
9512#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01009513 if (mbedtls_ssl_ciphersuite_uses_psk(suite_info) &&
9514 mbedtls_ssl_conf_has_static_psk(ssl->conf) == 0) {
9515 return -1;
XiaokangQian75d40ef2022-04-20 11:05:24 +00009516 }
9517#endif /* MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
9518#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
9519
Gilles Peskine449bd832023-01-11 14:50:10 +01009520 return 0;
XiaokangQian75d40ef2022-04-20 11:05:24 +00009521}
9522
Ronald Crone68ab4f2022-10-05 12:46:29 +02009523#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
XiaokangQianeaf36512022-04-24 09:07:44 +00009524/*
9525 * Function for writing a signature algorithm extension.
9526 *
9527 * The `extension_data` field of signature algorithm contains a `SignatureSchemeList`
9528 * value (TLS 1.3 RFC8446):
9529 * enum {
9530 * ....
9531 * ecdsa_secp256r1_sha256( 0x0403 ),
9532 * ecdsa_secp384r1_sha384( 0x0503 ),
9533 * ecdsa_secp521r1_sha512( 0x0603 ),
9534 * ....
9535 * } SignatureScheme;
9536 *
9537 * struct {
9538 * SignatureScheme supported_signature_algorithms<2..2^16-2>;
9539 * } SignatureSchemeList;
9540 *
9541 * The `extension_data` field of signature algorithm contains a `SignatureAndHashAlgorithm`
9542 * value (TLS 1.2 RFC5246):
9543 * enum {
9544 * none(0), md5(1), sha1(2), sha224(3), sha256(4), sha384(5),
9545 * sha512(6), (255)
9546 * } HashAlgorithm;
9547 *
9548 * enum { anonymous(0), rsa(1), dsa(2), ecdsa(3), (255) }
9549 * SignatureAlgorithm;
9550 *
9551 * struct {
9552 * HashAlgorithm hash;
9553 * SignatureAlgorithm signature;
9554 * } SignatureAndHashAlgorithm;
9555 *
9556 * SignatureAndHashAlgorithm
9557 * supported_signature_algorithms<2..2^16-2>;
9558 *
9559 * The TLS 1.3 signature algorithm extension was defined to be a compatible
9560 * generalization of the TLS 1.2 signature algorithm extension.
9561 * `SignatureAndHashAlgorithm` field of TLS 1.2 can be represented by
9562 * `SignatureScheme` field of TLS 1.3
9563 *
9564 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009565int mbedtls_ssl_write_sig_alg_ext(mbedtls_ssl_context *ssl, unsigned char *buf,
9566 const unsigned char *end, size_t *out_len)
XiaokangQianeaf36512022-04-24 09:07:44 +00009567{
9568 unsigned char *p = buf;
9569 unsigned char *supported_sig_alg; /* Start of supported_signature_algorithms */
9570 size_t supported_sig_alg_len = 0; /* Length of supported_signature_algorithms */
9571
9572 *out_len = 0;
9573
Gilles Peskine449bd832023-01-11 14:50:10 +01009574 MBEDTLS_SSL_DEBUG_MSG(3, ("adding signature_algorithms extension"));
XiaokangQianeaf36512022-04-24 09:07:44 +00009575
9576 /* Check if we have space for header and length field:
9577 * - extension_type (2 bytes)
9578 * - extension_data_length (2 bytes)
9579 * - supported_signature_algorithms_length (2 bytes)
9580 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009581 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 6);
XiaokangQianeaf36512022-04-24 09:07:44 +00009582 p += 6;
9583
9584 /*
9585 * Write supported_signature_algorithms
9586 */
9587 supported_sig_alg = p;
Gilles Peskine449bd832023-01-11 14:50:10 +01009588 const uint16_t *sig_alg = mbedtls_ssl_get_sig_algs(ssl);
9589 if (sig_alg == NULL) {
9590 return MBEDTLS_ERR_SSL_BAD_CONFIG;
9591 }
XiaokangQianeaf36512022-04-24 09:07:44 +00009592
Gilles Peskine449bd832023-01-11 14:50:10 +01009593 for (; *sig_alg != MBEDTLS_TLS1_3_SIG_NONE; sig_alg++) {
9594 MBEDTLS_SSL_DEBUG_MSG(3, ("got signature scheme [%x] %s",
9595 *sig_alg,
9596 mbedtls_ssl_sig_alg_to_str(*sig_alg)));
9597 if (!mbedtls_ssl_sig_alg_is_supported(ssl, *sig_alg)) {
XiaokangQianeaf36512022-04-24 09:07:44 +00009598 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01009599 }
9600 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 2);
9601 MBEDTLS_PUT_UINT16_BE(*sig_alg, p, 0);
XiaokangQianeaf36512022-04-24 09:07:44 +00009602 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01009603 MBEDTLS_SSL_DEBUG_MSG(3, ("sent signature scheme [%x] %s",
9604 *sig_alg,
9605 mbedtls_ssl_sig_alg_to_str(*sig_alg)));
XiaokangQianeaf36512022-04-24 09:07:44 +00009606 }
9607
9608 /* Length of supported_signature_algorithms */
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00009609 supported_sig_alg_len = (size_t) (p - supported_sig_alg);
Gilles Peskine449bd832023-01-11 14:50:10 +01009610 if (supported_sig_alg_len == 0) {
9611 MBEDTLS_SSL_DEBUG_MSG(1, ("No signature algorithms defined."));
9612 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
XiaokangQianeaf36512022-04-24 09:07:44 +00009613 }
9614
Gilles Peskine449bd832023-01-11 14:50:10 +01009615 MBEDTLS_PUT_UINT16_BE(MBEDTLS_TLS_EXT_SIG_ALG, buf, 0);
9616 MBEDTLS_PUT_UINT16_BE(supported_sig_alg_len + 2, buf, 2);
9617 MBEDTLS_PUT_UINT16_BE(supported_sig_alg_len, buf, 4);
XiaokangQianeaf36512022-04-24 09:07:44 +00009618
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00009619 *out_len = (size_t) (p - buf);
XiaokangQianeaf36512022-04-24 09:07:44 +00009620
9621#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01009622 mbedtls_ssl_tls13_set_hs_sent_ext_mask(ssl, MBEDTLS_TLS_EXT_SIG_ALG);
XiaokangQianeaf36512022-04-24 09:07:44 +00009623#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yu0c354a22022-08-29 15:25:36 +08009624
Gilles Peskine449bd832023-01-11 14:50:10 +01009625 return 0;
XiaokangQianeaf36512022-04-24 09:07:44 +00009626}
Ronald Crone68ab4f2022-10-05 12:46:29 +02009627#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
XiaokangQianeaf36512022-04-24 09:07:44 +00009628
XiaokangQian40a35232022-05-07 09:02:40 +00009629#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
XiaokangQian9b2b7712022-05-17 02:57:00 +00009630/*
9631 * mbedtls_ssl_parse_server_name_ext
9632 *
9633 * Structure of server_name extension:
9634 *
9635 * enum {
9636 * host_name(0), (255)
9637 * } NameType;
9638 * opaque HostName<1..2^16-1>;
9639 *
9640 * struct {
9641 * NameType name_type;
9642 * select (name_type) {
9643 * case host_name: HostName;
9644 * } name;
9645 * } ServerName;
9646 * struct {
9647 * ServerName server_name_list<1..2^16-1>
9648 * } ServerNameList;
9649 */
Ronald Cronce7d76e2022-07-08 18:56:49 +02009650MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01009651int mbedtls_ssl_parse_server_name_ext(mbedtls_ssl_context *ssl,
9652 const unsigned char *buf,
9653 const unsigned char *end)
XiaokangQian40a35232022-05-07 09:02:40 +00009654{
9655 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
9656 const unsigned char *p = buf;
XiaokangQian9b2b7712022-05-17 02:57:00 +00009657 size_t server_name_list_len, hostname_len;
9658 const unsigned char *server_name_list_end;
XiaokangQian40a35232022-05-07 09:02:40 +00009659
Gilles Peskine449bd832023-01-11 14:50:10 +01009660 MBEDTLS_SSL_DEBUG_MSG(3, ("parse ServerName extension"));
XiaokangQian40a35232022-05-07 09:02:40 +00009661
Gilles Peskine449bd832023-01-11 14:50:10 +01009662 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
9663 server_name_list_len = MBEDTLS_GET_UINT16_BE(p, 0);
XiaokangQian40a35232022-05-07 09:02:40 +00009664 p += 2;
9665
Gilles Peskine449bd832023-01-11 14:50:10 +01009666 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, server_name_list_len);
XiaokangQian9b2b7712022-05-17 02:57:00 +00009667 server_name_list_end = p + server_name_list_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01009668 while (p < server_name_list_end) {
9669 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, server_name_list_end, 3);
9670 hostname_len = MBEDTLS_GET_UINT16_BE(p, 1);
9671 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, server_name_list_end,
9672 hostname_len + 3);
XiaokangQian40a35232022-05-07 09:02:40 +00009673
Gilles Peskine449bd832023-01-11 14:50:10 +01009674 if (p[0] == MBEDTLS_TLS_EXT_SERVERNAME_HOSTNAME) {
XiaokangQian75fe8c72022-06-15 09:42:45 +00009675 /* sni_name is intended to be used only during the parsing of the
9676 * ClientHello message (it is reset to NULL before the end of
9677 * the message parsing). Thus it is ok to just point to the
9678 * reception buffer and not make a copy of it.
9679 */
XiaokangQianf2a94202022-05-20 06:44:24 +00009680 ssl->handshake->sni_name = p + 3;
9681 ssl->handshake->sni_name_len = hostname_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01009682 if (ssl->conf->f_sni == NULL) {
9683 return 0;
XiaokangQian40a35232022-05-07 09:02:40 +00009684 }
Gilles Peskine449bd832023-01-11 14:50:10 +01009685 ret = ssl->conf->f_sni(ssl->conf->p_sni,
9686 ssl, p + 3, hostname_len);
9687 if (ret != 0) {
9688 MBEDTLS_SSL_DEBUG_RET(1, "ssl_sni_wrapper", ret);
9689 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_UNRECOGNIZED_NAME,
9690 MBEDTLS_ERR_SSL_UNRECOGNIZED_NAME);
9691 return MBEDTLS_ERR_SSL_UNRECOGNIZED_NAME;
9692 }
9693 return 0;
XiaokangQian40a35232022-05-07 09:02:40 +00009694 }
9695
9696 p += hostname_len + 3;
9697 }
9698
Gilles Peskine449bd832023-01-11 14:50:10 +01009699 return 0;
XiaokangQian40a35232022-05-07 09:02:40 +00009700}
9701#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
9702
XiaokangQianacb39922022-06-17 10:18:48 +00009703#if defined(MBEDTLS_SSL_ALPN)
Ronald Cronce7d76e2022-07-08 18:56:49 +02009704MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01009705int mbedtls_ssl_parse_alpn_ext(mbedtls_ssl_context *ssl,
9706 const unsigned char *buf,
9707 const unsigned char *end)
XiaokangQianacb39922022-06-17 10:18:48 +00009708{
9709 const unsigned char *p = buf;
XiaokangQianc7403452022-06-23 03:24:12 +00009710 size_t protocol_name_list_len;
XiaokangQian95d5f542022-06-24 02:29:26 +00009711 const unsigned char *protocol_name_list;
9712 const unsigned char *protocol_name_list_end;
XiaokangQianc7403452022-06-23 03:24:12 +00009713 size_t protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00009714
9715 /* If ALPN not configured, just ignore the extension */
Gilles Peskine449bd832023-01-11 14:50:10 +01009716 if (ssl->conf->alpn_list == NULL) {
9717 return 0;
9718 }
XiaokangQianacb39922022-06-17 10:18:48 +00009719
9720 /*
XiaokangQianc7403452022-06-23 03:24:12 +00009721 * RFC7301, section 3.1
9722 * opaque ProtocolName<1..2^8-1>;
XiaokangQianacb39922022-06-17 10:18:48 +00009723 *
XiaokangQianc7403452022-06-23 03:24:12 +00009724 * struct {
9725 * ProtocolName protocol_name_list<2..2^16-1>
9726 * } ProtocolNameList;
XiaokangQianacb39922022-06-17 10:18:48 +00009727 */
9728
XiaokangQianc7403452022-06-23 03:24:12 +00009729 /*
XiaokangQian0b776e22022-06-24 09:04:59 +00009730 * protocol_name_list_len 2 bytes
9731 * protocol_name_len 1 bytes
9732 * protocol_name >=1 byte
XiaokangQianc7403452022-06-23 03:24:12 +00009733 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009734 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 4);
XiaokangQianacb39922022-06-17 10:18:48 +00009735
Gilles Peskine449bd832023-01-11 14:50:10 +01009736 protocol_name_list_len = MBEDTLS_GET_UINT16_BE(p, 0);
XiaokangQianacb39922022-06-17 10:18:48 +00009737 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01009738 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, protocol_name_list_len);
XiaokangQian95d5f542022-06-24 02:29:26 +00009739 protocol_name_list = p;
9740 protocol_name_list_end = p + protocol_name_list_len;
XiaokangQianacb39922022-06-17 10:18:48 +00009741
9742 /* Validate peer's list (lengths) */
Gilles Peskine449bd832023-01-11 14:50:10 +01009743 while (p < protocol_name_list_end) {
XiaokangQian95d5f542022-06-24 02:29:26 +00009744 protocol_name_len = *p++;
Gilles Peskine449bd832023-01-11 14:50:10 +01009745 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, protocol_name_list_end,
9746 protocol_name_len);
9747 if (protocol_name_len == 0) {
XiaokangQian95d5f542022-06-24 02:29:26 +00009748 MBEDTLS_SSL_PEND_FATAL_ALERT(
9749 MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
Gilles Peskine449bd832023-01-11 14:50:10 +01009750 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
9751 return MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
XiaokangQian95d5f542022-06-24 02:29:26 +00009752 }
9753
9754 p += protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00009755 }
9756
9757 /* Use our order of preference */
Gilles Peskine449bd832023-01-11 14:50:10 +01009758 for (const char **alpn = ssl->conf->alpn_list; *alpn != NULL; alpn++) {
9759 size_t const alpn_len = strlen(*alpn);
XiaokangQian95d5f542022-06-24 02:29:26 +00009760 p = protocol_name_list;
Gilles Peskine449bd832023-01-11 14:50:10 +01009761 while (p < protocol_name_list_end) {
XiaokangQian95d5f542022-06-24 02:29:26 +00009762 protocol_name_len = *p++;
Gilles Peskine449bd832023-01-11 14:50:10 +01009763 if (protocol_name_len == alpn_len &&
9764 memcmp(p, *alpn, alpn_len) == 0) {
XiaokangQianacb39922022-06-17 10:18:48 +00009765 ssl->alpn_chosen = *alpn;
Gilles Peskine449bd832023-01-11 14:50:10 +01009766 return 0;
XiaokangQianacb39922022-06-17 10:18:48 +00009767 }
XiaokangQian95d5f542022-06-24 02:29:26 +00009768
9769 p += protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00009770 }
9771 }
9772
XiaokangQian95d5f542022-06-24 02:29:26 +00009773 /* If we get here, no match was found */
XiaokangQianacb39922022-06-17 10:18:48 +00009774 MBEDTLS_SSL_PEND_FATAL_ALERT(
Gilles Peskine449bd832023-01-11 14:50:10 +01009775 MBEDTLS_SSL_ALERT_MSG_NO_APPLICATION_PROTOCOL,
9776 MBEDTLS_ERR_SSL_NO_APPLICATION_PROTOCOL);
9777 return MBEDTLS_ERR_SSL_NO_APPLICATION_PROTOCOL;
XiaokangQianacb39922022-06-17 10:18:48 +00009778}
9779
Gilles Peskine449bd832023-01-11 14:50:10 +01009780int mbedtls_ssl_write_alpn_ext(mbedtls_ssl_context *ssl,
9781 unsigned char *buf,
9782 unsigned char *end,
9783 size_t *out_len)
XiaokangQianacb39922022-06-17 10:18:48 +00009784{
9785 unsigned char *p = buf;
XiaokangQian95d5f542022-06-24 02:29:26 +00009786 size_t protocol_name_len;
XiaokangQianc7403452022-06-23 03:24:12 +00009787 *out_len = 0;
XiaokangQianacb39922022-06-17 10:18:48 +00009788
Gilles Peskine449bd832023-01-11 14:50:10 +01009789 if (ssl->alpn_chosen == NULL) {
9790 return 0;
XiaokangQianacb39922022-06-17 10:18:48 +00009791 }
9792
Gilles Peskine449bd832023-01-11 14:50:10 +01009793 protocol_name_len = strlen(ssl->alpn_chosen);
9794 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 7 + protocol_name_len);
XiaokangQianacb39922022-06-17 10:18:48 +00009795
Gilles Peskine449bd832023-01-11 14:50:10 +01009796 MBEDTLS_SSL_DEBUG_MSG(3, ("server side, adding alpn extension"));
XiaokangQianacb39922022-06-17 10:18:48 +00009797 /*
9798 * 0 . 1 ext identifier
9799 * 2 . 3 ext length
9800 * 4 . 5 protocol list length
9801 * 6 . 6 protocol name length
9802 * 7 . 7+n protocol name
9803 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009804 MBEDTLS_PUT_UINT16_BE(MBEDTLS_TLS_EXT_ALPN, p, 0);
XiaokangQianacb39922022-06-17 10:18:48 +00009805
XiaokangQian95d5f542022-06-24 02:29:26 +00009806 *out_len = 7 + protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00009807
Gilles Peskine449bd832023-01-11 14:50:10 +01009808 MBEDTLS_PUT_UINT16_BE(protocol_name_len + 3, p, 2);
9809 MBEDTLS_PUT_UINT16_BE(protocol_name_len + 1, p, 4);
XiaokangQian0b776e22022-06-24 09:04:59 +00009810 /* Note: the length of the chosen protocol has been checked to be less
9811 * than 255 bytes in `mbedtls_ssl_conf_alpn_protocols`.
9812 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009813 p[6] = MBEDTLS_BYTE_0(protocol_name_len);
XiaokangQianacb39922022-06-17 10:18:48 +00009814
Gilles Peskine449bd832023-01-11 14:50:10 +01009815 memcpy(p + 7, ssl->alpn_chosen, protocol_name_len);
Jerry Yub95dd362022-11-08 21:19:34 +08009816
9817#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01009818 mbedtls_ssl_tls13_set_hs_sent_ext_mask(ssl, MBEDTLS_TLS_EXT_ALPN);
Jerry Yub95dd362022-11-08 21:19:34 +08009819#endif
9820
Gilles Peskine449bd832023-01-11 14:50:10 +01009821 return 0;
XiaokangQianacb39922022-06-17 10:18:48 +00009822}
9823#endif /* MBEDTLS_SSL_ALPN */
9824
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009825#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && \
Xiaokang Qian03409292022-10-12 02:49:52 +00009826 defined(MBEDTLS_SSL_SESSION_TICKETS) && \
Xiaokang Qianed0620c2022-10-12 06:58:13 +00009827 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION) && \
Xiaokang Qianed3afcd2022-10-12 08:31:11 +00009828 defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01009829int mbedtls_ssl_session_set_hostname(mbedtls_ssl_session *session,
9830 const char *hostname)
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009831{
9832 /* Initialize to suppress unnecessary compiler warning */
9833 size_t hostname_len = 0;
9834
9835 /* Check if new hostname is valid before
9836 * making any change to current one */
Gilles Peskine449bd832023-01-11 14:50:10 +01009837 if (hostname != NULL) {
9838 hostname_len = strlen(hostname);
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009839
Gilles Peskine449bd832023-01-11 14:50:10 +01009840 if (hostname_len > MBEDTLS_SSL_MAX_HOST_NAME_LEN) {
9841 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9842 }
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009843 }
9844
9845 /* Now it's clear that we will overwrite the old hostname,
9846 * so we can free it safely */
Gilles Peskine449bd832023-01-11 14:50:10 +01009847 if (session->hostname != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01009848 mbedtls_zeroize_and_free(session->hostname,
Gilles Peskine449bd832023-01-11 14:50:10 +01009849 strlen(session->hostname));
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009850 }
9851
9852 /* Passing NULL as hostname shall clear the old one */
Gilles Peskine449bd832023-01-11 14:50:10 +01009853 if (hostname == NULL) {
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009854 session->hostname = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01009855 } else {
9856 session->hostname = mbedtls_calloc(1, hostname_len + 1);
9857 if (session->hostname == NULL) {
9858 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
9859 }
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009860
Gilles Peskine449bd832023-01-11 14:50:10 +01009861 memcpy(session->hostname, hostname, hostname_len);
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009862 }
9863
Gilles Peskine449bd832023-01-11 14:50:10 +01009864 return 0;
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009865}
Xiaokang Qian03409292022-10-12 02:49:52 +00009866#endif /* MBEDTLS_SSL_PROTO_TLS1_3 &&
9867 MBEDTLS_SSL_SESSION_TICKETS &&
Xiaokang Qianed0620c2022-10-12 06:58:13 +00009868 MBEDTLS_SSL_SERVER_NAME_INDICATION &&
Xiaokang Qianed3afcd2022-10-12 08:31:11 +00009869 MBEDTLS_SSL_CLI_C */
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009870
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00009871#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_EARLY_DATA) && \
9872 defined(MBEDTLS_SSL_ALPN)
9873int mbedtls_ssl_session_set_alpn(mbedtls_ssl_session *session,
9874 const char *alpn)
9875{
9876 size_t alpn_len = 0;
9877
9878 if (alpn != NULL) {
9879 alpn_len = strlen(alpn);
9880
9881 if (alpn_len > MBEDTLS_SSL_MAX_ALPN_NAME_LEN) {
9882 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9883 }
9884 }
9885
9886 if (session->ticket_alpn != NULL) {
9887 mbedtls_zeroize_and_free(session->ticket_alpn,
9888 strlen(session->ticket_alpn));
9889 }
9890
9891 if (alpn == NULL) {
9892 session->ticket_alpn = NULL;
9893 } else {
9894 session->ticket_alpn = mbedtls_calloc(strlen(alpn) + 1, sizeof(char));
9895 if (session->ticket_alpn == NULL) {
9896 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
9897 }
9898 memcpy(session->ticket_alpn, alpn, strlen(alpn) + 1);
9899 }
9900
9901 return 0;
9902}
9903#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_EARLY_DATA && MBEDTLS_SSL_ALPN */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02009904#endif /* MBEDTLS_SSL_TLS_C */